Closed blackwinter closed 9 years ago
This looks awesome, but since this is very much a breaking change, please call it 1.0.0.pre or similar instead.
While SemVer explicitly states that during 0.y.z
the public API should not be considered stable, I concede that we're also way past the initial development stage. So I'm fine with tacking the 1.0
label on this thing and call it a day ;)
To everyone watching this space,
there's a major release coming up that entails quite a few incompatibilities with previous releases. Hence, we try to document all the potentially user-facing changes here and have published a release candidate for others to test. Please leave a comment or open a new issue if you encounter any problems with this release candidate. Thanks!
The current documentation is available here.
Ruby version
Ruby 1.9.3 or higher is required. Support for Ruby 1.8.x has been dropped. (2d8f3da)
API changes
MediaWiki::Gateway
namespace. (bd987ab)MediaWiki::Utils
has been added as a proper module. (cadbf8d)MediaWiki::FakeWiki
has been added as a first-class citizen. (d34cade)MediaWiki::Config
has been removed. (26224fd)MediaWiki::Gateway#send_request
has been added, enabling you to send generic API requests not covered by the API. (3f59f01)MediaWiki::Gateway#custom_query
has been made public. (107e03d)MediaWiki::Gateway#initialize
learneduser_agent
option. (ddfbf84)MediaWiki::Gateway#headers
has been exposed. (ddfbf84)MediaWiki::Gateway#wiki_url
has been exposed, replacing the incorrectly exposed attributeMediaWiki::Gateway#base_url
. (12f9b71)Dependency changes
activesupport
dependency has been removed. Ifactivesupport
is installed, it will be used for better Unicode support, but only ifunicode
is not available. (57a64ba)Project layout changes
mediawiki-gateway
has been added as a command-line client replacing the previous sample scripts, changing some names and arguments along the way. (26224fd)require 'mediawiki-gateway'
, which is equivalent torequire 'media_wiki'
. (ce42249)