mediawiki-butt 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ac2473bbed75da107401d8c5dceeca3e2ed6b3c
-  data.tar.gz: 36463ff0c4f70d87ce6d6f62994d7ff03cf4b47a
+  metadata.gz: 3d0b018bfc1617afe7610706ea9347c71ad79a57
+  data.tar.gz: 5c356aeacdbcd8697eed165665335c48afb38fdd
 SHA512:
-  metadata.gz: 208c930ffa7dc8913b4c2b51bc6a82a46f1f55319d2ba92bf33eb139579dfbb8dff5b17327636df5235e651f63381ae4c808f84263868ca931a0cf1c9232035e
-  data.tar.gz: ef133085ca55bd92f603d43430c4c100d17011c0d64427950463c4e18856da642c2f2270df33e722c1efda9b971484d5a6e416767ed2b487e719ee444001acfc
+  metadata.gz: abff053b2c91f898e7d97996c2c866b1269b1461e9d8bf50c7670aaeabd60994d8248fc79b494d6600b9da947722d31a50d0f282223cb468ab16a0a4dffd9dbf
+  data.tar.gz: 3357c256bbfe5b77270e014011a36e45a3ae74bac3f432c5585a555c1e0a1f6ad6d267d202ba63161bcf986a946cacb2f372012e23bd9351bb103b81b7fed43b

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 ## Version 1
+### Version 1.3.0
+**Security update!**
+* Add support for the Assert API (PR #51).
+  * New `:assertion` option in initialize opts. It takes either `:user` or `:bot`.
+  * New `override_assertion` parameter in `post` to prevent assertion errors being thrown.
+    * **Note**: Assertions will only happen if `post`'s `autoparse` parameter is true.
+  * New NotLoggedInError and NotBotError for the according assertions.
+  * `Butt#user_bot?` no longer has a parameter. It now queries with an assertion rather than checking the user's groups.
+  * New method `Butt#logged_in?` to check if the current instance is logged in.
+
 ### Version 1.2.0
 * Add support for the Purge API (#48)
 

data/lib/mediawiki/auth.rb

@@ -22,7 +22,7 @@ module MediaWiki
       header = {}
       header['Set-Cookie'] = @cookie if @cookie
 
-      response = post(params, true, header)
+      response = post(params, true, header, true)
       result = response['login']['result']
 
       if result == 'NeedToken'
@@ -50,7 +50,7 @@ module MediaWiki
           action: 'logout'
         }
 
-        post(params)
+        post(params, true, nil, true)
         @logged_in = false
 
         true

data/lib/mediawiki/butt.rb

@@ -25,6 +25,7 @@ module MediaWiki
 
     attr_accessor :query_limit_default
     attr_accessor :use_continuation
+    attr_accessor :assertion
 
     # Creates a new instance of MediaWiki::Butt.
     # @param url [String] The FULL wiki URL. api.php can be omitted, but it will make harsh assumptions about
@@ -36,6 +37,10 @@ module MediaWiki
     #   use that, otherwise, it will use this. Defaults to 500. It can be set to 'max' to use MW's default max for
     #   each API.
     # @option opts [Boolean] :use_continuation Whether to use the continuation API on queries.
+    # @option opts [Symbol] :assertion If set to :user or :bot, will use the assert parameter in all requests.
+    #   Setting this will open up the possibility for NotLoggedInErrors and NotBotErrors. It is important to keep in
+    #   mind that methods that check if the user is logged in do not use the API, but check if the user has *ever*
+    #   logged in as this Butt instance. In other words, it is a safety check for performance and not a valid API check.
     def initialize(url, opts = {})
       @url = url =~ /api.php$/ ? url : "#{url}/api.php"
       @query_limit_default = opts[:query_limit_default] || 500
@@ -44,6 +49,9 @@ module MediaWiki
       @logged_in = false
       @custom_agent = opts[:custom_agent]
       @use_continuation = opts[:use_continuation]
+
+      assertion = opts[:assertion]
+      @assertion = assertion == :user || assertion == :bot ? assertion : nil
     end
 
     # Performs a generic HTTP POST request and provides the response. This method generally should not be used by the
@@ -52,11 +60,14 @@ module MediaWiki
     #   information.
     # @param autoparse [Boolean] Whether or not to provide a parsed version of the response's JSON.
     # @param header [Hash] The header hash. Optional.
+    # @param override_assertion [Boolean] Whether to override the @assertion check. This is used in #login because
+    #   that can never be done while already logged in.
     # @since 0.1.0
     # @return [Hash] Parsed JSON if autoparse is true.
     # @return [HTTPMessage] Raw HTTP response if autoparse is not true.
-    def post(params, autoparse = true, header = nil)
+    def post(params, autoparse = true, header = nil, override_assertion = false)
       params[:format] = 'json'
+      params[:assert] = @assertion.to_s if @assertion && !override_assertion && !params.key?(:assert)
       header = {} if header.nil?
 
       header['User-Agent'] = @logged_in ? "#{@name}/MediaWiki::Butt" : 'NotLoggedIn/MediaWiki::Butt'
@@ -64,7 +75,15 @@ module MediaWiki
 
       res = @client.post(@uri, params, header)
 
-      autoparse ? JSON.parse(res.body) : res
+      return res unless autoparse
+      parsed = JSON.parse(res.body)
+
+      if !override_assertion || @assertion
+        code = parsed.dig('error', 'code')
+        fail MediaWiki::Butt::NotLoggedInError.new(parsed['error']['info']) if code == 'assertuserfailed'
+        fail MediaWiki::Butt::NotBotError.new(parsed['error']['info']) if code == 'assertbotfailed'
+      end
+      parsed
     end
 
     # Performs a Mediawiki API query and provides the response, dealing with continuation as necessary.
@@ -92,28 +111,49 @@ module MediaWiki
       base_return
     end
 
+    # Helper method for query methods that return a two-dimensional hashes in which the keys are not relevant to the
+    #   returning value. In most cases this key is a redundant page or revision ID that is also available in the object.
+    # @param (see #query_ary)
+    def query_ary_irrelevant_keys(params, base_response_key, property_key)
+      query(params) do |return_val, query|
+        return_val.concat(query[base_response_key].values.collect { |obj| obj[property_key] })
+      end
+    end
+
     # Helper method for query methods that return an array built from the query objects.
     # @param params [Hash] A hash containing MediaWiki API parameters.
-    # @param
+    # @param base_response_key [String] The key inside the "query" object to collect.
+    # @param property_key [String] The key inside the object (under the base_response_key) to collect.
     def query_ary(params, base_response_key, property_key)
       query(params) do |return_val, query|
-        query[base_response_key].each { |obj| return_val << obj[property_key] }
+        return_val.concat(query[base_response_key].collect { |obj| obj[property_key] })
       end
     end
 
     # Gets whether the currently logged in user is a bot.
-    # @param username [String] The username to check. Optional. Defaults to
-    #   the currently logged in user if nil.
     # @return [Boolean] true if logged in as a bot, false if not logged in or
     #   logged in as a non-bot
     # @since 0.1.0 as is_current_user_bot
     # @since 0.3.0 as is_user_bot?
     # @since 0.4.1 as user_bot?
-    def user_bot?(username = nil)
-      groups = false
-      name = username || @name
-      groups = get_usergroups(name) if name
-      groups && groups.include?('bot')
+    def user_bot?
+      begin
+        post({ action: 'query', assert: 'bot' })
+        true
+      rescue MediaWiki::Butt::NotBotError
+        false
+      end
+    end
+
+    # Checks whether this instance is logged in.
+    # @return [Boolean] true if logged in, false if not.
+    def logged_in?
+      begin
+        post({ action: 'query', assert: 'user' })
+        true
+      rescue MediaWiki::Butt::NotLoggedInError
+        false
+      end
     end
 
     protected

data/lib/mediawiki/constants.rb

@@ -219,5 +219,9 @@ module MediaWiki
       # Extension:Flow
       'FLW_TOPIC'.freeze => 2600
     }.freeze
+
+    # @return [Proc] A proc that returns the missing page ID, -1. This is useful for using methods like Enumerable#find
+    #   and not creating a new Proc object for every call.
+    MISSING_PAGEID_PROC = Proc.new { '-1' }
   end
 end

data/lib/mediawiki/exceptions.rb

@@ -3,5 +3,7 @@ module MediaWiki
     class AuthenticationError < StandardError; end
     class EditError < StandardError; end
     class BlockError < StandardError; end
+    class NotLoggedInError < StandardError; end
+    class NotBotError < StandardError; end
   end
 end

data/lib/mediawiki/purge.rb

@@ -41,17 +41,12 @@ module MediaWiki
       params[:action] = 'purge'
       params[:titles] = titles.join('|')
 
-      response = post(params)
-
-      ret = {}
-
-      response['purge'].each do |hash|
+      post(params)['purge'].inject({}) do |result, hash|
         title = hash['title']
-        ret[title] = hash.key?('purged') && !hash.key?('missing')
+        result[title] = hash.key?('purged') && !hash.key?('missing')
         warn "Invalid purge (#{title}) #{hash['invalidreason']}" if hash.key?('invalid')
+        result
       end
-
-      ret
     end
   end
 end

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

@@ -184,7 +184,7 @@ module MediaWiki
           }
 
           query(params) do |return_val, query|
-            query['querypage']['results'].each { |result| return_val << result['title'] }
+            return_val.concat(query['querypage']['results'].collect { |result| result['title'] })
           end
         end
       end

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

@@ -34,9 +34,7 @@ module MediaWiki
           params[:rcstart] = start.xmlschema unless start.nil?
           params[:rcend] = stop.xmlschema unless stop.nil?
 
-          response = post(params)
-          ret = []
-          response['query']['recentchanges'].each do |change|
+          post(params)['query']['recentchanges'].collect do |change|
             old_length = change['oldlen']
             new_length = change['newlen']
             diff_length = new_length - old_length
@@ -68,10 +66,8 @@ module MediaWiki
               hash[:logid] = change['logid']
             end
 
-            ret << hash
+            hash
           end
-
-          ret
         end
 
         # Gets the recent deleted revisions.
@@ -90,9 +86,7 @@ module MediaWiki
           params[:drstart] = start.xmlschema unless start.nil?
           params[:drend] = stop.xmlschema unless stop.nil?
 
-          response = post(params)
-          ret = []
-          response['query']['deletedrevs'].each do |rev|
+          post(params)['query']['deletedrevs'].collect do |rev|
             r = rev['revisions'][0]
             hash = {
               timestamp: DateTime.xmlschema(r['timestamp']),
@@ -100,10 +94,9 @@ module MediaWiki
               comment: r['comment'],
               title: rev['title']
             }
-            ret << hash
-          end
 
-          ret
+            hash
+          end
         end
       end
     end

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

@@ -36,19 +36,13 @@ module MediaWiki
         # @return [Array<String>] All of the user's groups.
         # @return [Boolean] False if username is nil and not logged in.
         def get_usergroups(username = nil)
-          ret = []
           if username.nil?
             return false unless @logged_in
-            info = get_userlists('groups')
-            info['query']['userinfo']['groups'].each { |i| ret << i }
+            get_userlists('groups')['query']['userinfo']['groups']
           else
             info = get_userlists('groups', username)
-            info['query']['users'].each do |i|
-              i['groups'].each { |g| ret << g }
-            end
+            info['query']['users'].collect { |i| i['groups'] }.flatten
           end
-
-          ret
         end
 
         # Gets the user rights for the user.
@@ -58,21 +52,14 @@ module MediaWiki
         # @return [Array<String>] All of the user's groups.
         # @return [Boolean] False if username is nil and not logged in.
         def get_userrights(username = nil)
-          ret = []
           if username.nil?
             return false unless @logged_in
             info = get_userlists('rights')
-            info['query']['userinfo']['rights'].each { |i| ret << i }
+            info['query']['userinfo']['rights']
           else
             info = get_userlists('rights', username)
-            info['query']['users'].each do |i|
-              i['rights'].each do |g|
-                ret << g
-              end
-            end
+            info['query']['users'].find { |hash| hash['name'] == username }['rights']
           end
-
-          ret
         end
 
         # Gets contribution count for the user.
@@ -83,17 +70,14 @@ module MediaWiki
         # @return [Boolean] False if username is nil and not logged in.
         # @return [Fixnum] The number of contributions the user has made.
         def get_contrib_count(username = nil)
-          count = nil
           if username.nil?
             return false unless @logged_in
             info = get_userlists('editcount')
-            count = info['query']['userinfo']['editcount']
+            info['query']['userinfo']['editcount']
           else
             info = get_userlists('editcount', username)
-            info['query']['users'].each { |i| count = i['editcount'] }
+            info['query']['users'].find { |hash| hash['name'] == username }['editcount']
           end
-
-          count
         end
 
         # Gets when the user registered.
@@ -104,7 +88,6 @@ module MediaWiki
         # @return [DateTime] The registration date and time as a DateTime object.
         # @return [Boolean] False when no username is provided and not logged in, or the user doesn't exist.
         def get_registration_time(username = nil)
-          time = nil
           # Do note that in Userinfo, registration is called registrationdate.
           if username.nil?
             return false unless @logged_in
@@ -112,7 +95,7 @@ module MediaWiki
             time = info['query']['userinfo']['registrationdate']
           else
             info = get_userlists('registration', username)
-            info['query']['users'].each { |i| time = i['registration'] }
+            time = info['query']['users'].find { |hash| hash['name'] == username }['registration']
           end
 
           return false if time.nil?
@@ -126,11 +109,8 @@ module MediaWiki
         # @since 0.4.0
         # @return [String] The gender. 'male', 'female', or 'unknown'.
         def get_user_gender(username)
-          gender = nil
           info = get_userlists('gender', username)
-          info['query']['users'].each { |i| gender = i['gender'] }
-
-          gender
+          info['query']['users'].find { |hash| hash['name'] == username }['gender']
         end
 
         # Gets the latest contributions by the user until the limit.

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

@@ -41,26 +41,14 @@ module MediaWiki
         # @since 0.7.0
         # @return [Array<String>] All repository names that are marked as local.
         def get_local_filerepos
-          response = get_filerepoinfo('name|local')
-          ret = []
-          response['query']['repos'].each do |h|
-            ret << h['name'] if h.key?('local')
-          end
-
-          ret
+          get_filerepoinfo('name|local')['query']['repos'].select { |h| h.key?('local') }.collect { |h| h['name'] }
         end
 
         # Gets an array containing all repositories that aren't local.
         # @since 0.7.0
         # @return [Array<String>] All repositories that are not marked as local.
         def get_nonlocal_filerepos
-          response = get_filerepoinfo('name|local')
-          ret = []
-          response['query']['repos'].each do |h|
-            ret << h['name'] unless h.key?('local')
-          end
-
-          ret
+          get_filerepoinfo('name|local')['query']['repos'].reject { |h| h.key?('local') }.collect { |h| h['name'] }
         end
 
         # Gets the repository names and their according URLs.

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

@@ -41,10 +41,7 @@ module MediaWiki
         # @since 0.6.0
         # @return [Array<String>] All extension names.
         def get_extensions
-          response = get_siteinfo('extensions')
-          ret = []
-          response['query']['extensions'].each { |e| ret << e['name'] }
-          ret
+           get_siteinfo('extensions')['query']['extensions'].collect { |e| e['name'] }
         end
 
         # Gets all languages and their codes.
@@ -123,12 +120,7 @@ module MediaWiki
         # @since 0.6.0
         # @return [Array<String>] All file extensions.
         def get_allowed_file_extensions
-          response = get_siteinfo('fileextensions')
-          ret = []
-          response['query']['fileextensions'].each do |e|
-            ret << e['ext']
-          end
-          ret
+          get_siteinfo('fileextensions')['query']['fileextensions'].collect { |e| e['ext'] }
         end
 
         # Gets the response for the restrictions siteinfo API. Not really for use by users, mostly for the other two
@@ -136,28 +128,21 @@ module MediaWiki
         # @since 0.6.0
         # @return [Hash<String, Array<String>>] All restriction data. See the other restriction methods.
         def get_restrictions_data
-          response = get_siteinfo('restrictions')
-          response['query']['restrictions']
+          get_siteinfo('restrictions')['query']['restrictions']
         end
 
         # Gets all restriction/protection types.
         # @since 0.6.0
         # @return [Array<String>] All protection types.
         def get_restriction_types
-          restrictions = get_restrictions_data
-          ret = []
-          restrictions['types'].each { |t| ret << t }
-          ret
+          get_restrictions_data['types']
         end
 
         # Gets all restriction/protection levels.
         # @since 0.6.0
         # @return [Array<String>] All protection levels.
         def get_restriction_levels
-          restrictions = get_restrictions_data
-          ret = []
-          restrictions['levels'].each { |l| ret << l }
-          ret
+          get_restrictions_data['levels']
         end
 
         # Gets all skins and their codes.
@@ -176,36 +161,21 @@ module MediaWiki
         # @since 0.6.0
         # @return [Array<String>] All extension tags.
         def get_extension_tags
-          response = get_siteinfo('extensiontags')
-          ret = []
-          response['query']['extensiontags'].each do |t|
-            ret << t
-          end
-          ret
+          get_siteinfo('extensiontags')['query']['extensiontags']
         end
 
         # Gets all function hooks.
         # @since 0.6.0
         # @return [Array<String>] All function hooks.
         def get_function_hooks
-          response = get_siteinfo('functionhooks')
-          ret = []
-          response['query']['functionhooks'].each do |h|
-            ret << h
-          end
-          ret
+          get_siteinfo('functionhooks')['query']['functionhooks']
         end
 
         # Gets all variables that are usable on the wiki, such as NUMBEROFPAGES.
         # @since 0.6.0
         # @return [Array<String>] All variable string values.
         def get_variables
-          response = get_siteinfo('variables')
-          ret = []
-          response['query']['variables'].each do |v|
-            ret << v
-          end
-          ret
+          get_siteinfo('variables')['query']['variables']
         end
       end
     end

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

@@ -45,27 +45,19 @@ module MediaWiki
         # Gets a hash-of-arrays containing all the groups the user can add and remove people from.
         # @since 0.7.0
         # @return [Boolean] False if get_current_user_meta is false
-        # @return [Hash<String, Array<String>>] All the groups that the user can add, remove, add-self, and remove-self.
+        # @return [Hash<String, Array<String>>] All the groups that the user can :add, :remove, :addself, and
+        #   :remove-self.
         def get_changeable_groups
           response = get_current_user_meta('changeablegroups')
           return false unless response
 
-          ret = {}
-          add = []
-          remove = []
-          addself = []
-          removeself = []
           changeablegroups = response['query']['userinfo']['changeablegroups']
-          changeablegroups['add'].each { |g| add.push(g) }
-          changeablegroups['remove'].each { |g| remove.push(g) }
-          changeablegroups['add-self'].each { |g| addself.push(g) }
-          changeablegroups['remove-self'].each { |g| removeself.push(g) }
-          ret['add'] = add
-          ret['remove'] = remove
-          ret['addself'] = addself
-          ret['removeself'] = removeself
-
-          ret
+          {
+            :add => changeablegroups['add'],
+            :remove => changeablegroups['remove'],
+            :addself => changeablegroups['add-self'],
+            :removeself => changeablegroups['add-self']
+          }
         end
 
         # Gets the currently logged in user's real name.

data/lib/mediawiki/query/properties/contributors.rb

@@ -1,4 +1,5 @@
 require_relative '../query'
+require_relative '../../constants'
 
 module MediaWiki
   module Query
@@ -28,8 +29,7 @@ module MediaWiki
         # @return [Array<String>] All usernames for the contributors.
         def get_logged_in_contributors(title, limit = @query_limit_default)
           get_contributors_response(title, limit) do |return_val, query|
-            pageid = nil
-            query['pages'].each { |r, _| pageid = r }
+            pageid = query['pages'].keys.find(MediaWiki::Constants::MISSING_PAGEID_PROC) { |id| id != '-1' }
             return if query['pages'][pageid].key?('missing')
             query['pages'][pageid]['contributors'].each { |c| return_val << c['name'] }
           end
@@ -62,8 +62,7 @@ module MediaWiki
           ret = 0
 
           get_contributors_response(title, limit) do |_, query|
-            pageid = nil
-            query['pages'].each { |r, __| pageid = r }
+            pageid = query['pages'].keys.find(MediaWiki::Constants::MISSING_PAGEID_PROC) { |id| id != '-1' }
             return if query['pages'][pageid].key?('missing')
             ret += query['pages'][pageid]['anoncontributors'].to_i
           end

data/lib/mediawiki/query/properties/files.rb

@@ -1,4 +1,5 @@
 require_relative '../query'
+require_relative '../../constants'
 
 module MediaWiki
   module Query
@@ -37,7 +38,7 @@ module MediaWiki
             dflimit: get_limited(limit)
           }
 
-          query_ary(params, 'pages', 'title')
+          query_ary_irrelevant_keys(params, 'pages', 'title')
         end
 
         # Gets the size of an image in bytes.
@@ -82,14 +83,9 @@ module MediaWiki
           }
 
           response = post(params)
-          pageid = nil
-          response['query']['pages'].each { |r, _| pageid = r }
+          pageid = response['query']['pages'].keys.find(MediaWiki::Constants::MISSING_PAGEID_PROC) { |id| id != '-1'}
           return nil if pageid == '-1'
-          ret = {}
-          response['query']['pages'][pageid]['imageinfo'].each do |i|
-            i.each { |k, v| ret[k] = v }
-          end
-          ret
+          response['query']['pages'][pageid]['imageinfo'].reduce({}, :merge)
         end
       end
     end

data/lib/mediawiki/query/properties/pages.rb

@@ -1,4 +1,5 @@
 require_relative '../query'
+require_relative '../../constants'
 
 module MediaWiki
   module Query
@@ -17,14 +18,9 @@ module MediaWiki
           }
 
           query(params) do |return_val, query|
-            pageid = nil
-            query['pages'].each do |r, _|
-              pageid = r
-              break
-            end
-
+            pageid = query['pages'].keys.find(MediaWiki::Constants::MISSING_PAGEID_PROC) { |id| id != '-1' }
             return if query['pages'][pageid].key?('missing')
-            query['pages'][pageid].fetch('categories', []).each { |c| return_val << c['title'] }
+            return_val.concat(query['pages'][pageid].fetch('categories', []).collect { |c| c['title'] })
           end
         end
 
@@ -44,11 +40,8 @@ module MediaWiki
           }
 
           response = post(params)
-          revid = nil
-          response['query']['pages'].each { |r, _| revid = r }
-
+          revid = response['query']['pages'].keys.find(MediaWiki::Constants::MISSING_PAGEID_PROC) { |id| id != '-1' }
           revision = response['query']['pages'][revid]
-
           revision['missing'] == '' ? nil : revision['revisions'][0]['*']
         end
 
@@ -66,10 +59,7 @@ module MediaWiki
             titles: title
           }
 
-          response = post(params)
-          response['query']['pages'].each do |revid, _|
-            return revid == '-1' ? nil : revid.to_i
-          end
+          post(params)['query']['pages'].keys.find { |id| id != '-1' }&.to_i
         end
 
         # Gets all the external links on a given page.
@@ -88,10 +78,9 @@ module MediaWiki
           }
 
           query(params) do |return_val, query|
-            query['pages'].each do |revid, _|
-              return if revid == '-1'
-              query['pages'][revid]['extlinks'].each { |l| return_val << l['*'] }
-            end
+            pageid = query['pages'].keys.find { |id| id != '-1' }
+            return unless pageid
+            return_val.concat(query['pages'][pageid]['extlinks'].collect { |l| l['*'] })
           end
         end
 
@@ -104,17 +93,7 @@ module MediaWiki
         # @return [Nil] If the page does not exist.
         def do_i_watch?(title)
           return false unless @logged_in
-          params = {
-            action: 'query',
-            titles: title,
-            prop: 'info',
-            inprop: 'watched'
-          }
-
-          response = post(params)
-          response['query']['pages'].each do |revid, _|
-            return revid == '-1' ? nil : response['query']['pages'][revid].key?('watched')
-          end
+          page_info_contains_key(title, 'watched', 'watched')
         end
 
         # Gets whether the current user (can be anonymous) can read the page.
@@ -124,17 +103,7 @@ module MediaWiki
         # @return [Boolean] Whether the user can read the page.
         # @return [Nil] If the page does not exist.
         def can_i_read?(title)
-          params = {
-            action: 'query',
-            titles: title,
-            prop: 'info',
-            inprop: 'readable'
-          }
-
-          response = post(params)
-          response['query']['pages'].each do |revid, _|
-            return revid == '-1' ? nil : response['query']['pages'][revid].key?('readable')
-          end
+          page_info_contains_key(title, 'readable', 'readable')
         end
 
         # Gets whether the given page is a redirect.
@@ -144,16 +113,7 @@ module MediaWiki
         # @return [Boolean] Whether the page is a redirect.
         # @return [Nil] If the page does not exist.
         def page_redirect?(title)
-          params = {
-            action: 'query',
-            titles: title,
-            prop: 'info'
-          }
-
-          response = post(params)
-          response['query']['pages'].each do |revid, _|
-            return revid == '-1' ? nil : response['query']['pages'][revid].key?('redirect')
-          end
+          page_info_contains_key(title, 'redirect')
         end
 
         # Gets whether the given page only has one edit.
@@ -163,16 +123,7 @@ module MediaWiki
         # @return [Boolean] Whether the page only has one edit.
         # @return [Nil] If the page does not exist.
         def page_new?(title)
-          params = {
-            action: 'query',
-            titles: title,
-            prop: 'info'
-          }
-
-          response = post(params)
-          response['query']['pages'].each do |revid, _|
-            return revid == '-1' ? nil : response['query']['pages'][revid].key?('new')
-          end
+          page_info_contains_key(title, 'new')
         end
 
         # Gets the number of users that watch the given page.
@@ -182,17 +133,7 @@ module MediaWiki
         # @return [Fixnum] The number of watchers.
         # @return [Nil] If the page does not exist.
         def get_number_of_watchers(title)
-          params = {
-            action: 'query',
-            titles: title,
-            prop: 'info',
-            inprop: 'watchers'
-          }
-
-          response = post(params)
-          response['query']['pages'].each do |revid, _|
-            return revid == '-1' ? nil : response['query']['pages'][revid]['watchers']
-          end
+          page_info_get_val(title, 'watchers', 'watchers')
         end
 
         # Gets the way the title is actually displayed, after any in-page changes to its display, e.g., using a
@@ -203,17 +144,7 @@ module MediaWiki
         # @return [String] The page's display title.
         # @return [Nil] If the page does not exist.
         def get_display_title(title)
-          params = {
-            action: 'query',
-            titles: title,
-            prop: 'info',
-            inprop: 'displaytitle'
-          }
-
-          response = post(params)
-          response['query']['pages'].each do |revid, _|
-            return revid == '-1' ? nil : response['query']['pages'][revid]['displaytitle']
-          end
+          page_info_get_val(title, 'displaytitle', 'displaytitle')
         end
 
         # Gets the levels of protection on the page.
@@ -234,14 +165,15 @@ module MediaWiki
           }
 
           response = post(params)
-          response['query']['pages'].each do |revid, _|
-            return if revid == '-1'
-            protection = response['query']['pages'][revid]['protection']
-            protection.each do |p|
-              p.keys.each { |k| p[k.to_sym] = p.delete(k) }
-            end
-            return protection
+
+          pageid = response['query']['pages'].keys.find { |id| id != '-1' }
+          return unless pageid
+          protection = response['query']['pages'][pageid]['protection']
+          protection.each do |p|
+            p.keys.each { |k| p[k.to_sym] = p.delete(k) }
           end
+
+          protection
         end
 
         # Gets the size, in bytes, of the page.
@@ -251,16 +183,7 @@ module MediaWiki
         # @return [Fixnum] The number of bytes.
         # @return [Nil] If the page does not exist.
         def get_page_size(title)
-          params = {
-            action: 'query',
-            titles: title,
-            prop: 'info'
-          }
-
-          response = post(params)
-          response['query']['pages'].each do |revid, _|
-            return revid == '-1' ? nil : response['query']['pages'][revid]['length']
-          end
+          page_info_get_val(title, 'length')
         end
 
         # Gets all of the images in the given page.
@@ -277,10 +200,9 @@ module MediaWiki
           }
 
           query(params) do |return_val, query|
-            query['pages'].each do |revid, _|
-              return if revid == '-1'
-              query['pages'][revid]['images'].each { |img| return_val << img['title'] }
-            end
+            pageid = query['pages'].keys.find { |id| id != '-1' }
+            return unless pageid
+            return_val.concat(query['pages'][pageid]['images'].collect { |img| img['title'] })
           end
         end
 
@@ -298,10 +220,9 @@ module MediaWiki
           }
 
           query(params) do |return_val, query|
-            query['pages'].each do |revid, _|
-              return if revid == '-1'
-              query['pages'][revid]['templates'].each { |template| return_val << template['title'] }
-            end
+            pageid = query['pages'].keys.find { |id| id != '-1' }
+            return unless pageid
+            return_val.concat(query['pages'][pageid]['templates'].collect { |template| template['title'] })
           end
         end
 
@@ -319,12 +240,10 @@ module MediaWiki
           }
 
           query(params) do |return_val, query|
-            query['pages'].each do |revid, _|
-              return if revid == '-1'
-              query['pages'][revid].fetch('iwlinks', []).each do |l|
-                return_val << { prefix: l['prefix'], title: l['*'] }
-              end
-            end
+            pageid = query['pages'].keys.find { |id| id != '-1' }
+            return unless pageid
+            iwlinks = query['pages'][pageid].fetch('iwlinks', [])
+            return_val.concat(iwlinks.collect { |l| { prefix: l['prefix'], title: l['*']} })
           end
         end
 
@@ -344,16 +263,15 @@ module MediaWiki
           }
 
           query(params) do |return_val, query|
-            query['pages'].each do |revid, _|
-              return if revid == '-1'
-              query['pages'][revid]['langlinks'].each do |l|
-                return_val[l['lang'].to_sym] = {
-                  url: l['url'],
-                  langname: l['langname'],
-                  autonym: l['autonym'],
-                  title: l['*']
-                }
-              end
+            pageid = query['pages'].keys.find { |id| id != '-1' }
+            return unless pageid
+            query['pages'][pageid]['langlinks'].each do |l|
+              return_val[l['lang'].to_sym] = {
+                url: l['url'],
+                langname: l['langname'],
+                autonym: l['autonym'],
+                title: l['*']
+              }
             end
           end
         end
@@ -372,12 +290,54 @@ module MediaWiki
           }
 
           query(params) do |return_val, query|
-            query['pages'].each do |revid, _|
-              return if revid == '-1'
-              query['pages'][revid]['links'].each { |l| return_val << l['title'] }
-            end
+            pageid = query['pages'].keys.find { |id| id != '-1' }
+            return unless pageid
+            return_val.concat(query['pages'][pageid]['links'].collect { |l| l['title'] })
           end
         end
+
+        private
+
+        # Performs a query for the page info with the provided property.
+        # @param title [String] The page name
+        # @param inprop [String] The inprop to use. See the MediaWiki API documentation.
+        # @return (see #post)
+        def get_basic_page_info(title, inprop = nil)
+          params = {
+            action: 'query',
+            titles: title,
+            prop: 'info'
+          }
+          params[:inprop] = inprop if inprop
+
+          post(params)
+        end
+
+        # Performs a query for the page info with the provided property. Checks if the first non-missing page returned
+        #   contains the provided key.
+        # @param title [String] The page name
+        # @param key [String] The key to check for
+        # @param inprop [String] The inprop to use. See the MediaWiki API documentation.
+        # @return [Nil] If the page is not found.
+        # @return [Boolean] If the page object contains the provided key.
+        def page_info_contains_key(title, key, inprop = nil)
+          response = get_basic_page_info(title, inprop)
+          pageid = response['query']['pages'].keys.find { |id| id != '-1' }
+          return unless pageid
+          response['query']['pages'][pageid].key?(key)
+        end
+
+        # Performs a query for the page info with the provided property, and returns a value by the provided key in
+        #   the page's returned object.
+        # @param (see #page_info_contains_key)
+        # @return [Nil] If the page is not found.
+        # @return [Any] The returned value for the key.
+        def page_info_get_val(title, key, inprop = nil)
+          response = get_basic_page_info(title, inprop)
+          pageid = response['query']['pages'].keys.find { |id| id != '-1' }
+          return unless pageid
+          response['query']['pages'][pageid][key]
+        end
       end
     end
   end

data/lib/mediawiki/watch.rb

@@ -36,17 +36,16 @@ module MediaWiki
         success_key = 'unwatched'
       end
 
-      response = post(params)
-      ret = {}
-      response['watch'].each do |entry|
+      post(params)['watch'].inject({}) do |result, entry|
         title = entry['title']
         if entry.key?(success_key)
-          ret[title] = entry.key?('missing') ? nil : true
+          result[title] = entry.key?('missing') ? nil : true
         else
-          ret[title] = false
+          result[title] = false
         end
+
+        result
       end
-      ret
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Eli Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-10 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient