mediawiki-butt 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d0b018bfc1617afe7610706ea9347c71ad79a57
-  data.tar.gz: 5c356aeacdbcd8697eed165665335c48afb38fdd
+  metadata.gz: fc7e6ec26beb5a87466af0dd75da94fecac69de3
+  data.tar.gz: 61a5969d08c863a80bf8d76f1a3d61c0a0da4d75
 SHA512:
-  metadata.gz: abff053b2c91f898e7d97996c2c866b1269b1461e9d8bf50c7670aaeabd60994d8248fc79b494d6600b9da947722d31a50d0f282223cb468ab16a0a4dffd9dbf
-  data.tar.gz: 3357c256bbfe5b77270e014011a36e45a3ae74bac3f432c5585a555c1e0a1f6ad6d267d202ba63161bcf986a946cacb2f372012e23bd9351bb103b81b7fed43b
+  metadata.gz: 8096b955d2b02aa44a4fe267cca4ad1a280ab3374a8c0074acee9d102e7b2eef766704c5b3c5463f6b461d2f661ee7166645607f90dcc47d55f721eb739b8d04
+  data.tar.gz: c28a5db8c069352687b896934aa072bfe13dd31d6795ddc21b38d3e24f596bfe7ac8c157d9629521e2afff415b521e9018778a02aa4f06ecd557de45e768939b

data/CHANGELOG.md

@@ -1,4 +1,23 @@
 # Changelog
+## Version 2
+### Version 2.0.0
+**Breaking changes!**
+* Logical reversal of the redirect param for move (#58)
+* Switch around type and limit params in `get_category_members` (#57)
+* Remove post-install message
+* Strip leading and trailing whitespace from username in get_userlists, affecting the following methods (#55):
+  * `get_userrights`
+  * `get_contrib_count`
+  * `get_registration_time`
+  * `get_user_gender`
+* Change return values of `#upload` to be more useful (#54)
+  * `true`/`false` return value denote success/failure
+  * `UploadInvalidFileExtError` is raised when the file extension is not valid
+  * `EditError` is raised for any errors that occurred during the upload
+* New siteinfo methods `get_server`, `get_base_article_path`, and `get_article_path` (#20).
+* Modify the `edit`, `create_page`, and `move` methods to take options hashes instead of a bunch of unnamed arguments. (#53, #52)
+* Documentation is now stored in master branch
+
 ## Version 1
 ### Version 1.3.0
 **Security update!**

data/lib/mediawiki/edit.rb

@@ -5,10 +5,10 @@ module MediaWiki
     # Performs a standard non-creation edit.
     # @param title [String] The page title.
     # @param text [String] The new content.
-    # @param minor [Boolean] Will mark the edit as minor if true.
-    # @param bot [Boolean] Will mark the edit as bot edit if true. Defaults to true, for your convenience, bot
-    #   developers.
-    # @param summary [String] The edit summary. Optional.
+    # @param opts [Hash<Symbol, Any>] The options hash for optional values in the request.
+    # @option opts [Boolean] :minor Will mark the edit as minor if true.
+    # @option opts [Boolean] :bot Will mark the edit as bot edit if true. Defaults to true.
+    # @option opts [String] :summary The edit summary. Optional.
     # @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing wiki content on the MediaWiki API
     #   documentation
     # @see https://www.mediawiki.org/wiki/API:Edit MediaWiki Edit API Docs
@@ -16,21 +16,20 @@ module MediaWiki
     # @raise [EditError] if the edit failed somehow
     # @return [String] The new revision ID
     # @return [Boolean] False if there was no change in the edit.
-    def edit(title, text, minor = false, bot = true, summary = nil)
+    def edit(title, text, opts = {})
+      opts[:bot] = opts.key?(:bot) ? opts[:bot] : true
       params = {
         action: 'edit',
         title: title,
         text: text,
         nocreate: 1,
-        format: 'json'
+        format: 'json',
+        token: get_token('edit', title)
       }
 
-      token = get_token('edit', title)
-
-      params[:summary] = summary unless summary.nil?
-      params[:minor] = '1' if minor
-      params[:bot] = '1' if bot
-      params[:token] = token
+      params[:summary] ||= opts[:summary]
+      params[:minor] = '1' if opts[:minor]
+      params[:bot] = '1' if opts[:bot]
 
       response = post(params)
 
@@ -45,29 +44,29 @@ module MediaWiki
     # Creates a new page.
     # @param title [String] The new page's title.
     # @param text [String] The new page's content.
-    # @param summary [String] The edit summary.
-    # @param bot [Boolean] Will mark the edit as a bot edit if true. Defaults to true, for your convenience, bot
-    #   developers.
+    # @param opts [Hash<Symbol, Any>] The options hash for optional values in the request.
+    # @option opts [String] :summary The edit summary. Defaults to "New page".
+    # @option opts [Boolean] :bot Will mark the edit as a bot edit if true. Defaults to true.
     # @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing wiki content on the MediaWiki API
     #   documentation
     # @see https://www.mediawiki.org/wiki/API:Edit MediaWiki Edit API Docs
     # @since 0.3.0
     # @raise [EditError] If there was some error when creating the page.
     # @return [String] The new page ID
-    def create_page(title, text, summary = 'New page', bot = true)
+    def create_page(title, text, opts = {})
+      opts[:bot] = opts.key?(:bot) ? opts[:bot] : true
+      opts[:summary] ||= 'New page'
       params = {
         action: 'edit',
         title: title,
-        summary: summary,
         text: text,
+        summary: opts[:summary],
         createonly: 1,
-        format: 'json'
+        format: 'json',
+        token: get_token('edit', title)
       }
 
-      token = get_token('edit', title)
-
-      params[:bot] = '1' if bot
-      params[:token] = token
+      params[:bot] = '1' if opts[:bot]
 
       response = post(params)
 
@@ -79,13 +78,14 @@ module MediaWiki
     # @param url [String] The URL to the file.
     # @param filename [String] The preferred filename. This can include File: at the beginning, but it will be
     #   removed through regex. Optional. If omitted, it will be everything after the last slash in the URL.
-    # @return [Boolean] True if the upload was successful, false if the file extension is not valid.
+    # @return [Boolean] Whether the upload was successful. It is likely that if it returns false, it also raised a
+    #   warning.
+    # @raise [UploadInvalidFileExtError] When the file extension provided is not valid for the wiki.
+    # @raise [EditError]
     # @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing wiki content on the MediaWiki API
     #   documentation
     # @see https://www.mediawiki.org/wiki/API:Upload MediaWiki Upload API Docs
     # @since 0.3.0
-    # @return [Boolean] Whether the upload was successful. It is likely that if it returns false, it also raised a
-    #   warning.
     def upload(url, filename = nil)
       params = {
         action: 'upload',
@@ -97,7 +97,7 @@ module MediaWiki
 
       ext = filename.split('.')[-1]
       allowed_extensions = get_allowed_file_extensions
-      return false unless allowed_extensions.include?(ext)
+      raise MediaWiki::Butt::UploadInvalidFileExtError.new unless allowed_extensions.include?(ext)
 
       token = get_token('edit', filename)
       params[:filename] = filename
@@ -109,33 +109,36 @@ module MediaWiki
         warn warning
       end
 
-      response.dig('upload', 'result') == 'Success'
+      return true if response.dig('upload', 'result') == 'Success'
+      raise MediaWiki::Butt::EditError.new(response.dig('error', 'code') || 'Unknown error code')
     end
 
     # Performs a move on a page.
     # @param from [String] The page to be moved.
     # @param to [String] The destination of the move.
-    # @param reason [String] The reason for the move, which shows up in the log. Optional.
-    # @param talk [Boolean] Whether to move the associated talk page.
-    # @param redirect [Boolean] Whether to create a redirect.
+    # @param opts [Hash<Symbol, Any>] The options hash for optional values in the request.
+    # @option opts [String] :reason The reason for the move, which shows up in the log.
+    # @option opts [Boolean] :talk Whether to move the associated talk page. Defaults to true.
+    # @option opts [Boolean] :suppress_redirect Set to a truthy value in order to prevent the API from making a redirect
+    #   page.
     # @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing wiki content on the MediaWiki API
     #   documentation
     # @see https://www.mediawiki.org/wiki/API:Move MediaWiki Move API Docs
     # @since 0.5.0
     # @raise [EditError]
     # @return [Boolean] True if it was successful.
-    def move(from, to, reason = nil, talk = true, redirect = false)
+    def move(from, to, opts = {})
+      opts[:talk] = opts.key?(:talk) ? opts[:talk] : true
       params = {
         action: 'move',
         from: from,
-        to: to
+        to: to,
+        token: get_token('move', from)
       }
 
-      token = get_token('move', from)
-      params[:reason] = reason unless reason.nil?
-      params[:movetalk] = '1' if talk
-      params[:noredirect] = '1' if redirect
-      params[:token] = token
+      params[:reason] ||= opts[:reason]
+      params[:movetalk] = '1' if opts[:talk]
+      params[:noredirect] = '1' if opts[:suppress_redirect]
 
       response = post(params)
 

data/lib/mediawiki/exceptions.rb

@@ -5,5 +5,6 @@ module MediaWiki
     class BlockError < StandardError; end
     class NotLoggedInError < StandardError; end
     class NotBotError < StandardError; end
+    class UploadInvalidFileExtError < StandardError; end
   end
 end

data/lib/mediawiki/query/lists/categories.rb

@@ -11,7 +11,7 @@ module MediaWiki
         # @see https://www.mediawiki.org/wiki/API:Categorymembers MediaWiki Category Members API Docs
         # @since 0.1.0
         # @return [Array<String>] All category members until the limit
-        def get_category_members(category, limit = @query_limit_default, type = 'page')
+        def get_category_members(category, type = 'page', limit = @query_limit_default)
           params = {
             list: 'categorymembers',
             cmprop: 'title',
@@ -33,7 +33,7 @@ module MediaWiki
         # @since 0.9.0
         # @return [Array<String>] All subcategories.
         def get_subcategories(category, limit = @query_limit_default)
-          get_category_members(category, limit, 'subcat')
+          get_category_members(category, 'subcat', limit)
         end
 
         # Gets all of the files in a given category.
@@ -42,7 +42,7 @@ module MediaWiki
         # @since 0.9.0
         # @return [Array<String>] All files in the category.
         def get_files_in_category(category, limit = @query_limit_default)
-          get_category_members(category, limit, 'file')
+          get_category_members(category, 'file', limit)
         end
       end
     end

data/lib/mediawiki/query/lists/users.rb

@@ -16,6 +16,7 @@ module MediaWiki
             return unless @logged_in
             response = get_current_user_meta(prop)
           else
+            username.strip!
             params = {
               action: 'query',
               list: 'users',

data/lib/mediawiki/query/meta/siteinfo.rb

@@ -177,6 +177,24 @@ module MediaWiki
         def get_variables
           get_siteinfo('variables')['query']['variables']
         end
+
+        # Gets the protocol-relative server URL for the wiki.
+        # @return [String] The server URL for the wiki. For example: //en.wikipedia.org for Wikipedia.
+        def get_server
+          get_general['server']
+        end
+
+        # @return [String] The article path for the wiki. It includes "$1", which should be replaced with the actual
+        #   name of the article. Does not include the URL for the wiki. For example: /wiki/$1 for Wikpedia.
+        def get_base_article_path
+          get_general['articlepath']
+        end
+
+        # @param article_name [String] The name of the article.
+        # @return [String] The full article path for the provided article. This is protocol-relative.
+        def get_article_path(article_name)
+          get_server + get_base_article_path.sub('$1', article_name)
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Eli Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2017-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -79,7 +79,7 @@ licenses:
 - MIT
 metadata:
   issue_tracker: https://github.com/ftb-gamepedia/mediawiki-butt-ruby/issues
-post_install_message: ONE OF US! ONE OF US!
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -95,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Interacting with the MediaWiki API
 test_files: []
-has_rdoc: