mediawiki-butt 0.11.1 → 1.0.0

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

@@ -8,21 +8,16 @@ module MediaWiki
 
         # Gets the RecentChanges log.
         # @param user [String] See {MediaWiki::Query::Lists::Log#get_log}
-        # @param title [String] See {MediaWiki::Query::Lists::Log#get_log}
         # @param start [DateTime] See {MediaWiki::Query::Lists::Log#get_log}
         # @param stop [DateTime] See {MediaWiki::Query::Lists::Log#get_log}
-        # @param limit [Int] See {MediaWiki::Query::Lists::Log#get_log}
-        # @see https://www.mediawiki.org/wiki/API:RecentChanges MediaWiki
-        #   RecentChanges API Docs
+        # @param limit [Fixnum] See {MediaWiki::Query::Lists::Log#get_log}
+        # @see https://www.mediawiki.org/wiki/API:RecentChanges MediaWiki RecentChanges API Docs
         # @since 0.10.0
-        # @return [Array<Hash>] All of the changes, with the following keys:
-        #   type, title, revid, old_revid, rcid, user, old_length, new_length,
-        #   diff_length, timestamp, comment, parsed_comment, sha, new, minor,
-        #   bot.
-        def get_recent_changes(user = nil, start = nil, stop = nil, limit = 500)
-          time_format = MediaWiki::Constants::TIME_FORMAT
-          prop = 'user|comment|parsedcomment|timestamp|title|ids|sha1|sizes' \
-                 '|redirect|flags|loginfo'
+        # @return [Array<Hash<Symbol, Any>>] All of the changes, with the following keys: type, title, revid,
+        #   old_revid, rcid, user, old_length, new_length, diff_length, timestamp, comment, parsed_comment, sha, new,
+        #   minor, bot.
+        def get_recent_changes(user = nil, start = nil, stop = nil, limit = @query_limit_default)
+          prop = 'user|comment|parsedcomment|timestamp|title|ids|sha1|sizes|redirect|flags|loginfo'
           rights = get_userrights
           patrol = false
           if rights != false && rights.include?('patrol')
@@ -36,8 +31,8 @@ module MediaWiki
             rclimit: get_limited(limit)
           }
           params[:rcuser] = user unless user.nil?
-          params[:rcstart] = start.strftime(time_format) unless start.nil?
-          params[:rcend] = stop.strftime(time_format) unless stop.nil?
+          params[:rcstart] = start.xmlschema unless start.nil?
+          params[:rcend] = stop.xmlschema unless stop.nil?
 
           response = post(params)
           ret = []
@@ -56,7 +51,7 @@ module MediaWiki
               old_length: old_length,
               new_length: new_length,
               diff_length: diff_length,
-              timestamp: DateTime.strptime(change['timestamp'], time_format),
+              timestamp: DateTime.xmlschema(change['timestamp']),
               comment: change['comment'],
               parsed_comment: change['parsedcomment'],
               sha: change['sha1']
@@ -80,34 +75,27 @@ module MediaWiki
         end
 
         # Gets the recent deleted revisions.
-        # @param user [String] See {#get_recent_changes}
-        # @param start [DateTime] See {#get_recent_changes}
-        # @param stop [DateTime] See {#get_recent_changes}
-        # @param limit [Int] See {#get_recent_changes}
-        # @see https://www.mediawiki.org/wiki/API:Deletedrevs MediaWiki
-        #   Deletedrevs API Docs
+        # @param (see #get_recent_changes)
+        # @see https://www.mediawiki.org/wiki/API:Deletedrevs MediaWiki Deletedrevs API Docs
         # @since 0.10.0
-        # @return [Array<Hash>] All of the changes, with the following keys:
-        #   timestamp, user, comment, title.
-        def get_recent_deleted_revisions(user = nil, start = nil, stop = nil,
-                                         limit = 500)
-          time_format = MediaWiki::Constants::TIME_FORMAT
+        # @return [Array<Hash>] All of the changes, with the following keys: timestamp, user, comment, title.
+        def get_recent_deleted_revisions(user = nil, start = nil, stop = nil, limit = @query_limit_default)
           prop = 'revid|parentid|user|comment|parsedcomment|minor|len|sh1|tags'
           params = {
             action: 'query',
             list: 'deletedrevs',
             drprop: prop,
-            limit: get_limited(limit)
+            drlimit: get_limited(limit)
           }
-          params[:drstart] = start.strftime(time_format) unless start.nil?
-          params[:drend] = stop.strftime(time_format) unless stop.nil?
+          params[:drstart] = start.xmlschema unless start.nil?
+          params[:drend] = stop.xmlschema unless stop.nil?
 
           response = post(params)
           ret = []
           response['query']['deletedrevs'].each do |rev|
             r = rev['revisions'][0]
             hash = {
-              timestamp: DateTime.strptime(r['timestamp'], time_format),
+              timestamp: DateTime.xmlschema(r['timestamp']),
               user: r['user'],
               comment: r['comment'],
               title: rev['title']

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

@@ -4,50 +4,36 @@ module MediaWiki
       module Search
         # Gets the amount of results for the search value.
         # @param search_value [String] The thing to search for.
-        # @param namespace [Int] The namespace to search in.
-        #   Defaults to 0 (the main namespace).
-        # @see https://www.mediawiki.org/wiki/API:Search MediaWiki Search API
-        #   Docs
+        # @param namespace [Fixnum] The namespace to search in. Defaults to 0 (the main namespace).
+        # @see https://www.mediawiki.org/wiki/API:Search MediaWiki Search API Docs
         # @since 0.4.0
-        # @return [Int] The number of pages that matched the search.
+        # @return [Fixnum] The number of pages that matched the search.
         def get_search_result_amount(search_value, namespace = 0)
           params = {
             action: 'query',
             list: 'search',
-            srsearch: search_value
+            srsearch: search_value,
+            srnamespace: validate_namespace(namespace)
           }
 
-          if MediaWiki::Constants::NAMEPSACES.value?(namespace)
-            params[:srnamespace] = namespace
-          else
-            params[:srnamespace] = 0
-          end
-
           response = post(params)
           response['query']['searchinfo']['totalhits']
         end
 
         # Gets an array containing page titles that matched the search.
         # @param search_value [String] The thing to search for.
-        # @param namespace [Int] The namespace to search in.
-        #   Defaults to 0 (the main namespace).
-        # @see https://www.mediawiki.org/wiki/API:Search MediaWiki Search API
-        #   Docs
+        # @param namespace [Fixnum] The namespace to search in. Defaults to 0 (the main namespace).
+        # @see https://www.mediawiki.org/wiki/API:Search MediaWiki Search API Docs
         # @since 0.4.0
-        # @return [Array] The page titles that matched the search.
+        # @return [Array<String>] The page titles that matched the search.
         def get_search_results(search_value, namespace = 0)
           params = {
             action: 'query',
             list: 'search',
-            srsearch: search_value
+            srsearch: search_value,
+            srnamespace: validate_namespace(namespace)
           }
 
-          if MediaWiki::Constants::NAMESPACES.value?(namespace)
-            params[:srnamespace] = namespace
-          else
-            params[:srnamespace] = 0
-          end
-
           response = post(params)
 
           ret = []
@@ -58,10 +44,9 @@ module MediaWiki
 
         # Searches the wiki by a prefix.
         # @param prefix [String] The prefix.
-        # @param limit [Int] The maximum number of results to get, maximum of
-        #   100 for users and 200 for bots.
-        # @see https://www.mediawiki.org/wiki/API:Prefixsearch MediaWiki
-        #   Prefixsearch API Docs
+        # @param limit [Fixnum] The maximum number of results to get, maximum of 100 for users and 200 for bots. This is
+        # one of the methods that does *not* use the query_limit_default attribute.
+        # @see https://www.mediawiki.org/wiki/API:Prefixsearch MediaWiki Prefixsearch API Docs
         # @since 0.10.0
         # @return [Array<String>] All of the page titles that match the search.
         def get_prefix_search(prefix, limit = 100)
@@ -69,7 +54,7 @@ module MediaWiki
             action: 'query',
             list: 'prefixsearch',
             pssearch: prefix,
-            limit: get_limited(limit, 100, 200)
+            pslimit: get_limited(limit, 100, 200)
           }
 
           response = post(params)

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

@@ -5,20 +5,16 @@ module MediaWiki
         # Gets user information. This method should rarely be used by
         # normal users, unless they want a huge amount of user data at once.
         # @param prop [String] The usprop parameter.
-        # @param username [String] The username to get info for. Optional.
-        #   Defaults to the currently logged in user if ommitted.
-        # @see https://www.mediawiki.org/wiki/API:Users MediaWiki User Lists API
-        #   Docs
+        # @param username [String] The username to get info for. Optional. Defaults to the currently logged in user
+        # if omitted.
+        # @see https://www.mediawiki.org/wiki/API:Users MediaWiki User Lists API Docs
         # @since 0.3.0
         # @return [String] Parsed full response if successful.
         # @return [Nil] If the username is nil and the Butt is not logged in.
         def get_userlists(prop, username = nil)
           if username.nil?
-            if @logged_in
-              response = get_current_user_meta(prop)
-            else
-              return false
-            end
+            return unless @logged_in
+            response = get_current_user_meta(prop)
           else
             params = {
               action: 'query',
@@ -34,25 +30,21 @@ module MediaWiki
         end
 
         # Gets an array of all the user's groups.
-        # @param username [String] The username to get groups of. Optional.
-        #   Defaults to the currently logged in user.
+        # @param username [String] The username to get groups of. Optional. Defaults to the currently logged in user.
         # @see get_userlists
         # @since 0.3.0
-        # @return [Array] All of the user's groups.
+        # @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?
-            if @logged_in
-              info = get_userlists('groups')
-              info['query']['userinfo']['groups'].each { |i| ret << i }
-            else
-              return false
-            end
+            return false unless @logged_in
+            info = get_userlists('groups')
+            info['query']['userinfo']['groups'].each { |i| ret << i }
           else
             info = get_userlists('groups', username)
             info['query']['users'].each do |i|
-              i['groups'].each { |g| ret.push(g) }
+              i['groups'].each { |g| ret << g }
             end
           end
 
@@ -60,26 +52,22 @@ module MediaWiki
         end
 
         # Gets the user rights for the user.
-        # @param username [String] The user to get the rights for. Optional.
-        #   Defaults to the currently logged in user.
+        # @param username [String] The user to get the rights for. Optional. Defaults to the currently logged in user.
         # @see get_userlists
         # @since 0.3.0
-        # @return [Array] All of the user's groups.
+        # @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?
-            if @logged_in
-              info = get_userlists('rights')
-              info['query']['userinfo']['rights'].each { |i| ret << i }
-            else
-              return false
-            end
+            return false unless @logged_in
+            info = get_userlists('rights')
+            info['query']['userinfo']['rights'].each { |i| ret << i }
           else
             info = get_userlists('rights', username)
             info['query']['users'].each do |i|
               i['rights'].each do |g|
-                ret.push(g)
+                ret << g
               end
             end
           end
@@ -88,21 +76,18 @@ module MediaWiki
         end
 
         # Gets contribution count for the user.
-        # @param username [String] The username to get the contribution count of.
-        #   Optional. Defaults to the currently logged in user.
+        # @param username [String] The username to get the contribution count of. Optional. Defaults to the currently
+        # logged in user.
         # @see get_userlists
         # @since 0.3.0
         # @return [Boolean] False if username is nil and not logged in.
-        # @return [Int] The number of contributions the user has made.
+        # @return [Fixnum] The number of contributions the user has made.
         def get_contrib_count(username = nil)
           count = nil
           if username.nil?
-            if @logged_in
-              info = get_userlists('editcount')
-              count = info['query']['userinfo']['editcount']
-            else
-              return false
-            end
+            return false unless @logged_in
+            info = get_userlists('editcount')
+            count = info['query']['userinfo']['editcount']
           else
             info = get_userlists('editcount', username)
             info['query']['users'].each { |i| count = i['editcount'] }
@@ -112,8 +97,8 @@ module MediaWiki
         end
 
         # Gets when the user registered.
-        # @param username [String] The username to get the registration date and
-        #   time of. Optional. Defaults to the currently logged in user.
+        # @param username [String] The username to get the registration date and time of. Optional. Defaults to the
+        # currently logged in user.
         # @see get_userlists
         # @since 0.4.0
         # @return [DateTime] The registration date and time as a DateTime object.
@@ -122,12 +107,9 @@ module MediaWiki
           time = nil
           # Do note that in Userinfo, registration is called registrationdate.
           if username.nil?
-            if @logged_in
-              info = get_userlists('registrationdate')
-              time = info['query']['userinfo']['registrationdate']
-            else
-              return false
-            end
+            return false unless @logged_in
+            info = get_userlists('registrationdate')
+            time = info['query']['userinfo']['registrationdate']
           else
             info = get_userlists('registration', username)
             info['query']['users'].each { |i| time = i['registration'] }
@@ -153,14 +135,14 @@ module MediaWiki
 
         # Gets the latest contributions by the user until the limit.
         # @param user [String] The username.
-        # @param limit [Int] See #get_all_images.
-        # @see https://www.mediawiki.org/wiki/API:Usercontribs MediaWiki
-        #   User Contributions API Docs
+        # @param limit [Fixnum] See #{get_all_images}.
+        # @see https://www.mediawiki.org/wiki/API:Usercontribs MediaWiki User Contributions API Docs
         # @since 0.8.0
-        # @return [Hash] Each contribution by its revid, containing the title,
-        #   summary, total contribution size, and the size change relative to the
-        #   previous edit.
-        def get_user_contributions(user, limit = 500)
+        # @return [Hash<Fixnum, Hash<Symbol, Any>>] Each contribution by its revid, containing the title, summary,
+        # total
+        # contribution size, and
+        # the size change relative to the previous edit.
+        def get_user_contributions(user, limit = @query_limit_default)
           params = {
             action: 'query',
             list: 'usercontribs',
@@ -184,19 +166,19 @@ module MediaWiki
           ret
         end
 
-        # Gets the user's full watchlist. If no user is provided, it will use the
-        #   currently logged in user, according to the MediaWiki API.
+        # Gets the user's full watchlist. If no user is provided, it will use the currently logged in user, according
+        # to the MediaWiki API.
         # @param user [String] The username.
-        # @param limit [Int] See #get_all_images.
-        # @see https://www.mediawiki.org/wiki/API:Watchlist MediaWiki Watchlist
-        #   API Docs
+        # @param limit [Fixnum] See #{get_all_images}.
+        # @see https://www.mediawiki.org/wiki/API:Watchlist MediaWiki Watchlist API Docs
         # @since 0.8.0
-        # @return [Array] All the watchlist page titles.
-        def get_full_watchlist(user = nil, limit = 500)
+        # @return [Array<String>] All the watchlist page titles.
+        def get_full_watchlist(user = nil, limit = @query_limit_default)
           params = {
             action: 'query',
             list: 'watchlist',
-            wlprop: 'title'
+            wlprop: 'title',
+            wllimit: get_limited(limit)
           }
           params[:wluser] = user unless user.nil?
 

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

@@ -1,13 +1,12 @@
 module MediaWiki
   module Query
     module Meta
-      # @see https://www.mediawiki.org/wiki/API:Filerepoinfo MediaWiki
-      #   Filerepoinfo API Docs
+      # @see https://www.mediawiki.org/wiki/API:Filerepoinfo MediaWiki Filerepoinfo API Docs
       module FileRepoInfo
         # Gets FileRepoInfo for the property.
         # @param prop [String] The friprop to get.
         # @since 0.7.0
-        # @return [Response] The full parsed response.
+        # @return [Hash] The full parsed response.
         def get_filerepoinfo(prop)
           params = {
             action: 'query',
@@ -20,33 +19,32 @@ module MediaWiki
 
         # Returns an array of all the wiki's file repository names.
         # @since 0.1.0
-        # @return [Array] All wiki's file repository names.
+        # @return [Hash<String, String>] All wiki's file repository names. Keys are names, values are display names.
         def get_filerepo_names
           response = get_filerepoinfo('name|displayname')
           ret = {}
-          response['query']['repos'].each { |n, dn| ret[n] = dn }
+          response['query']['repos'].each { |h| ret[h['name']] = h['displayname'] }
           ret
         end
 
         # Gets the root URLs for the file repositories.
         # @since 0.7.0
-        # @return [Hash] A hash containing keys of the names, and values of the
-        #   root URLs.
+        # @return [Hash<String, String>] A hash containing keys of the names, and values of the root URLs.
         def get_filerepo_rooturls
           response = get_filerepoinfo('name|rootUrl')
           ret = {}
-          response['query']['repos'].each { |n, r| ret[n] = r }
+          response['query']['repos'].each { |h| ret[h['name']] = h['rootUrl'] }
           ret
         end
 
         # Gets an array containing all local repositories.
         # @since 0.7.0
-        # @return [Array] All repositories that are marked as local.
+        # @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 |n, l|
-            ret.push(n) if l == 'true'
+          response['query']['repos'].each do |h|
+            ret << h['name'] if h.key?('local')
           end
 
           ret
@@ -54,12 +52,12 @@ module MediaWiki
 
         # Gets an array containing all repositories that aren't local.
         # @since 0.7.0
-        # @return [Array] All repositories that are not marked as local.
+        # @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 |n, l|
-            ret.push(n) if l == 'false'
+          response['query']['repos'].each do |h|
+            ret << h['name'] unless h.key?('local')
           end
 
           ret
@@ -67,31 +65,31 @@ module MediaWiki
 
         # Gets the repository names and their according URLs.
         # @since 0.7.0
-        # @return [Hash] Names as the keys, with their URLs as the values.
+        # @return [Hash<String, String>] Names as the keys, with their URLs as the values.
         def get_filerepo_urls
           response = get_filerepoinfo('name|url')
           ret = {}
-          response['query']['repos'].each { |n, u| ret[n] = u }
+          response['query']['repos'].each { |h| ret[h['name']] = h['url'] }
           ret
         end
 
         # Gets the repository names and their accoring thumbnail URLs.
         # @since 0.7.0
-        # @return [Hash] Names as the keys, with their URLs as the values.
+        # @return [Hash<String, String>] Names as the keys, with their URLs as the values.
         def get_filerepo_thumburls
           response = get_filerepoinfo('name|thumbUrl')
           ret = {}
-          response['query']['repos'].each { |n, u| ret[n] = u }
+          response['query']['repos'].each { |h| ret[h['name']] = h['thumbUrl'] }
           ret
         end
 
         # Gets the repository names and their according favicon URLs.
         # @since 0.7.0
-        # @return [Hash] Names as the keys, with their favicons as the values.
+        # @return [Hash<String, String>] Names as the keys, with their favicons as the values.
         def get_filerepo_favicons
           response = get_filerepoinfo('name|favicon')
           ret = {}
-          response['query']['repos'].each { |n, f| ret[n] = f }
+          response['query']['repos'].each { |h| ret[h['name']] = h['favicon'] }
           ret
         end
       end