Skip to content

Commit

Permalink
🎂 Bump major version because of breaking API changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
elifoster committed Jul 30, 2016
1 parent 3d8380b commit c513232
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,27 @@
# Changelog
## Version 1
### Version 1.0.0
* Important: MediaWiki::Butt now depends on Ruby 2.3. If you aren't using that yet, use it. It's worth it.
* MediaWiki::Butt.new now takes two parameters, `url`, and an options hash. See the documentation for initialize for more details.
* Improvements to the way we handle query limits (#28, #31, and #37):
* `get_recent_revisions`, `get_prefix_search`, and `get_full_watchlist` now properly set their limits.
* Most query lists that took a limit parameter now use the attribute `:query_limit_default` instead of each having a set default of 500.
* New `:query_limit_default` attribute accessor. This means you can change your default limits whenever you want!
* Support using 'max' as the limit.
* Major cleanup of documentation. The YARD server at ftb-gamepedia.github.io/MediaWiki-Butt-Ruby is now the recommended place for documentation.
* Improve testing slightly.
* Remove the TIME_FORMAT constant and instead use DateTime's methods properly.
* Fix FileRepoInfo methods returning hashes with nil values instead of arrays of hashes (#34).
* Add support for the MediaWiki Watching/Unwatching APIs (#38)
* Remove the unused `:tokens` instance variable. This should silence some errors when logging in/out.
* Improve authentication methods by making them recursive. `login` and `create_account(_email)` now take an optional third parameter, token.
* Fix error in `get_categories_in_page` (APerson241)
* Error handling improvements (APerson241 and elifoster) (#32):
* New EditError that is thrown when there is an error when editing. It contains the error code.
* `edit` returns false when there is no change (error: nochange), rather than throwing an error.
* New BlockError that is thrown when there is an error when blocking/unblocking.
* Removed AuthenticationError subclasses, as well as `check_login` and `check_create`. All authentication errors now return a generic AuthenticationError with the provided error message from MediaWiki.

## Version 0
### Version 0.11.1
* Relicense under the MIT license.
Expand Down
2 changes: 1 addition & 1 deletion mediawiki-butt.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Gem::Specification.new do |s|
s.authors = ['Eli Foster', 'Eric Schneider (xbony2)']
s.name = 'mediawiki-butt'
s.summary = 'Interacting with the MediaWiki API'
s.version = '0.11.1'
s.version = '1.0.0'
s.license = 'MIT'
# Expand on this description eventually.
s.description = <<-EOF
Expand Down

0 comments on commit c513232

Please sign in to comment.