mediawiki-butt 0.7.0 → 0.8.0

data/lib/mediawiki/edit.rb

@@ -72,8 +72,9 @@ module MediaWiki
     #   This can include File: at the beginning, but it will be removed
     #   through regex. Optional. If ommitted, it will be everything after
     #   the last slash in the URL.
-    # @return [Boolean/String] true if the upload was successful, else the
-    #   warning's key. Returns false if the file extension is not valid.
+    # @return [Boolean] True if the upload was successful, false if the
+    #   file extension is not valid.
+    # @return [String] The warning's key if it was unsuccessful.
     def upload(url, filename = nil)
       params = {
         action: 'upload',
@@ -114,7 +115,8 @@ module MediaWiki
     # @param talk [Boolean] Whether to move the associated talk page.
     #   Defaults to true.
     # @param redirect [Boolean] Whether to create a redirect. Defaults to false.
-    # @return [Boolean/String] true if successful, the error code if not.
+    # @return [Boolean] True if it was successful.
+    # @return [String] The error code if it was unsuccessful.
     def move(from, to, reason = nil, talk = true, redirect = false)
       params = {
         action: 'move',
@@ -139,7 +141,8 @@ module MediaWiki
     # Deletes a page.
     # @param title [String] The page to delete.
     # @param reason [String] The reason to be displayed in logs. Optional.
-    # @return [Boolean/String] true if successful, the error code if not.
+    # @return [Boolean] True if successful.
+    # @return [String] The error code if it was not successful.
     def delete(title, reason = nil)
       params = {
         action: 'delete',

data/lib/mediawiki/query/lists.rb

@@ -1,11 +1,8 @@
 require_relative '../constants'
-require 'string-utility'
 
 module MediaWiki
   module Query
     module Lists
-      using StringUtility
-
       # Gets an array of backlinks to a given title.
       # @param title [String] The page to get the backlinks of.
       # @param limit [Int] The maximum number of pages to get. Defaults to 500,
@@ -15,23 +12,11 @@ module MediaWiki
       def what_links_here(title, limit = 500)
         params = {
           action: 'query',
-          bltitle: title
+          list: 'backlinks',
+          bltitle: title,
+          bllimit: MediaWiki::Query.get_limited(limit)
         }
 
-        if limit > 500
-          if user_bot? == true
-            if limit > 5000
-              params[:bllimit] = 5000
-            else
-              params[:bllimit] = limit
-            end
-          else
-            params[:bllimit] = 500
-          end
-        else
-          params[:bllimit] = limit
-        end
-
         ret = []
         response = post(params)
         response['query']['backlinks'].each { |bl| ret.push(bl['title']) }
@@ -51,7 +36,8 @@ module MediaWiki
         params = {
           action: 'query',
           list: 'categorymembers',
-          cmprop: 'title'
+          cmprop: 'title',
+          cmlimit: MediaWiki::Query.get_limited(limit)
         }
 
         if category =~ /[Cc]ategory\:/
@@ -59,21 +45,6 @@ module MediaWiki
         else
           params[:cmtitle] = "Category:#{category}"
         end
-
-        if limit > 500
-          if user_bot?
-            if limit > 5000
-              params[:cmlimit] = 5000
-            else
-              params[:cmlimit] = limit
-            end
-          else
-            params[:cmlimit] = 500
-          end
-        else
-          params[:cmlimit] = limit
-        end
-
         ret = []
         response = post(params)
         response['query']['categorymembers'].each { |cm| ret.push(cm['title']) }
@@ -91,29 +62,16 @@ module MediaWiki
       def get_random_pages(number_of_pages = 1, namespace = 0)
         params = {
           action: 'query',
-          list: 'random'
+          list: 'random',
+          rnlimit: MediaWiki::Query.get_limited(number_of_pages, 10, 20)
         }
 
-        if $namespaces.value?(namespace)
+        if @namespaces.value?(namespace)
           params[:rnnamespace] = namespace
         else
           params[:rnnamespace] = 0
         end
 
-        if number_of_pages > 10
-          if user_bot?
-            if limit > 20
-              params[:rnlimit] = 20
-            else
-              params[:rnlimit] = limit
-            end
-          else
-            params[:rnlimit] = 10
-          end
-        else
-          params[:rnlimit] = number_of_pages
-        end
-
         ret = []
         responce = post(params)
         responce['query']['random'].each { |a| ret.push(a['title']) }
@@ -126,8 +84,8 @@ module MediaWiki
       # @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.
-      # @return [String/Nil] Parsed full response if successful, nil if
-      #   the username is nil and the Butt is not logged in.
+      # @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
@@ -152,8 +110,8 @@ module MediaWiki
       # 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.
-      # @return [Array/Boolean] All of the user's groups, or false if username
-      #   is nil and Butt is not logged in.
+      # @return [Array] 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?
@@ -176,8 +134,8 @@ module MediaWiki
       # 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.
-      # @return [Array/Boolean] All of the user's groups, or false if username
-      #   is nil and Butt is not logged in.
+      # @return [Array] 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?
@@ -202,13 +160,9 @@ module MediaWiki
       # 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 autoparse [Boolean] Whether to automatically format the string
-      #   with commas using string-utility. Defaults to true.
-      # @return [Boolean/Int/String] False if username is nil and Butt is not
-      #   logged in. An integer value of the contribution count if autoparse is
-      #   false. A formatted string version of the contribution count if
-      #   autoparse is true.
-      def get_contrib_count(username = nil, autoparse = true)
+      # @return [Boolean] False if username is nil and not logged in.
+      # @return [Int] The number of contributions the user has made.
+      def get_contrib_count(username = nil)
         count = nil
         if username.nil?
           if @logged_in
@@ -222,11 +176,6 @@ module MediaWiki
           info['query']['users'].each { |i| count = i['editcount'] }
         end
 
-        if autoparse
-          countstring = count.to_s.separate
-          return countstring
-        end
-
         count
       end
 
@@ -267,7 +216,6 @@ module MediaWiki
         info = get_userlists('gender', username)
         info['query']['users'].each { |i| gender = i['gender'] }
 
-
         gender
       end
 
@@ -283,14 +231,13 @@ module MediaWiki
           srsearch: search_value
         }
 
-        if $namespaces.value?(namespace)
+        if MediaWiki::Constants::NAMEPSACES.value?(namespace)
           params[:srnamespace] = namespace
         else
           params[:srnamespace] = 0
         end
 
         response = post(params)
-
         response['query']['searchinfo']['totalhits']
       end
 
@@ -306,7 +253,7 @@ module MediaWiki
           srsearch: search_value
         }
 
-        if $namespaces.value?(namespace)
+        if MediaWiki::Constants::NAMESPACES.value?(namespace)
           params[:srnamespace] = namespace
         else
           params[:srnamespace] = 0
@@ -327,23 +274,10 @@ module MediaWiki
       def get_all_categories(limit = 500)
         params = {
           action: 'query',
-          list: 'allcategories'
+          list: 'allcategories',
+          aclimit: MediaWiki::Query.get_limited(limit)
         }
 
-        if limit > 500
-          if user_bot?
-            if limit > 5000
-              params[:aclimit] = 5000
-            else
-              params[:aclimit] = limit
-            end
-          else
-            params[:aclimit] = 500
-          end
-        else
-          params[:aclimit] = limit
-        end
-
         response = post(params)
 
         ret = []
@@ -359,27 +293,184 @@ module MediaWiki
       def get_all_images(limit = 500)
         params = {
           action: 'query',
-          list: 'allimages'
+          list: 'allimages',
+          ailimit: MediaWiki::Query.get_limited(limit)
         }
 
-        if limit > 500
-          if user_bot?
-            if limit > 5000
-              params[:ailimit] = 5000
-            else
-              params[:ailimit] = limit
-            end
-          else
-            params[:ailimit] = 500
-          end
-        else
-          params[:ailimit] = limit
+        response = post(params)
+
+        ret = []
+        response['query']['allimages'].each { |i| ret.push(i['name']) }
+
+        ret
+      end
+
+      # Gets all pages within a namespace integer.
+      # @param namespace [Int] The namespace ID.
+      # @param limit [Int] See #get_all_images
+      # @return [Array] An array of all page titles.
+      def get_all_pages_in_namespace(namespace, limit = 500)
+        params = {
+          action: 'query',
+          list: 'allpages',
+          apnamespace: namespace,
+          aplimit: MediaWiki::Query.get_limited(limit)
+        }
+
+        response = post(params)
+
+        ret = []
+        response['query']['allpages'].each { |p| ret.push(p['title']) }
+
+        ret
+      end
+
+      # Gets all users, or all users in a group.
+      # @param group [String] The group to limit this query to.
+      # @param limit [Int] See #get_all_images.
+      # @return [Hash] A hash of all users, names are keys, IDs are values.
+      def get_all_users(group = nil, limit = 500)
+        params = {
+          action: 'query',
+          list: 'allusers',
+          aulimit: MediaWiki::Query.get_limited(limit)
+        }
+        params[:augroup] = group unless group.nil?
+
+        response = post(params)
+
+        ret = {}
+        response['query']['allusers'].each { |u| ret[u['name']] = u['userid'] }
+
+        ret
+      end
+
+      # Gets all block IDs on the wiki. It seems like this only gets non-IP
+      #   blocks, but the MediaWiki docs are a bit unclear.
+      # @param limit [Int] See #get_all_images.
+      # @return [Array] All block IDs as strings.
+      def get_all_blocks(limit = 500)
+        params = {
+          action: 'query',
+          list: 'blocks',
+          bklimit: MediaWiki::Query.get_limited(limit),
+          bkprop: 'id'
+        }
+
+        response = post(params)
+
+        ret = []
+        response['query']['blocks'].each { |b| ret.push(b['id']) }
+
+        ret
+      end
+
+      # Gets all page titles that transclude a given page.
+      # @param page [String] The page name.
+      # @param limit [Int] See #get_all_images.
+      # @return [Array] All transcluder page titles.
+      def get_all_transcluders(page, limit = 500)
+        params = {
+          action: 'query',
+          list: 'embeddedin',
+          eititle: page,
+          eilimit: MediaWiki::Query.get_limited(limit)
+        }
+
+        response = post(params)
+
+        ret = []
+        response['query']['embeddedin'].each { |e| ret.push(e['title']) }
+
+        ret
+      end
+
+      # Gets an array of all deleted or archived files on the wiki.
+      # @param limit [Int] See #get_all_images
+      # @return [Array] All deleted file names. These are not titles, so they do
+      #   not include "File:".
+      def get_all_deleted_files(limit = 500)
+        params = {
+          action: 'query',
+          list: 'filearchive',
+          falimit: MediaWiki::Query.get_limited(limit)
+        }
+
+        response = post(params)
+
+        ret = []
+        response['query']['filearchive'].each { |f| ret.push(f['name']) }
+
+        ret
+      end
+
+      # Gets a list of all protected pages, by protection level if provided.
+      # @param protection_level [String] The protection level, e.g., sysop
+      # @param limit [Int] See #get_all_images.
+      # @return [Array] All protected page titles.
+      def get_all_protected_titles(protection_level = nil, limit = 500)
+        params = {
+          action: 'query',
+          list: 'protectedtitles',
+          ptlimit: MediaWiki::Query.get_limited(limit)
+        }
+        params[:ptlevel] = protection_level unless protection_level.nil?
+
+        response = post(params)
+
+        ret = []
+        response['query']['protectedtitles'].each { |t| ret.push(t['title']) }
+
+        ret
+      end
+
+      # Gets the latest contributions by the user until the limit.
+      # @param user [String] The username.
+      # @param limit [Int] See #get_all_images.
+      # @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)
+        params = {
+          action: 'query',
+          list: 'usercontribs',
+          ucuser: user,
+          uclimit: MediaWiki::Query.get_limited(limit),
+          ucprop: 'ids|title|comment|size|sizediff|flags|patrolled'
+        }
+
+        response = post(params)
+
+        ret = {}
+        response['query']['usercontribs'].each do |item|
+          ret[item['revid']] = {
+            title: item['title'],
+            summary: item['comment'],
+            total_size: item['size'],
+            diff_size: item['sizediff']
+          }
         end
 
+        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.
+      # @param user [String] The username.
+      # @param limit [Int] See #get_all_images.
+      # @return [Array] All the watchlist page titles.
+      def get_full_watchlist(user = nil, limit = 500)
+        params = {
+          action: 'query',
+          list: 'watchlist',
+          wlprop: 'title'
+        }
+        params[:wluser] = user unless user.nil?
+
         response = post(params)
 
         ret = []
-        response['query']['allimages'].each { |i| ret.push(i['name']) }
+        response['query']['watchlist'].each { |t| ret.push(t['title']) }
 
         ret
       end

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

@@ -4,8 +4,8 @@ module MediaWiki
       module UserInfo
         # Gets meta information for the currently logged in user.
         # @param prop [String] The uiprop to get. Optional.
-        # @return [Response/Boolean] Either a full, parsed response, or false if
-        #   not logged in.
+        # @return [Response/Boolean] Either a full, parsed response.
+        # @return [Boolean] False if not logged in.
         def get_current_user_meta(prop = nil)
           if @logged_in
             params = {
@@ -21,7 +21,8 @@ module MediaWiki
         end
 
         # Gets the current user's username.
-        # @return [String/Boolean] Returns the username, or false.
+        # @return [String] Returns the username.
+        # @return [Boolean] False if...
         def get_current_user_name
           if !@name.nil?
             return @name
@@ -51,9 +52,9 @@ module MediaWiki
 
         # Gets a hash-of-arrays containing all the groups the user can add and
         #   remove people from.
-        # @return [Boolean/Hash] False if get_current_user_meta is false, else
-        #   a hash containing arrays of all the groups the user can add/remove
-        #   people from.
+        # @return [Boolean] False if get_current_user_meta is false
+        # @return [Hash] All the groups that the user can add, remove, add-self,
+        #   and remove-self.
         def get_changeable_groups
           response = get_current_user_meta('changeablegroups')
           if response != false
@@ -78,8 +79,8 @@ module MediaWiki
         end
 
         # Gets the currently logged in user's real name.
-        # @return [String/Nil] Nil if they don't have a real name set, or their
-        #   real name.
+        # @return [String] The user's real name.
+        # @return [Nil] If they don't have a real name set.
         def get_realname
           response = get_current_user_meta('realname')
           if response['query']['userinfo']['realname'] == ''
@@ -90,7 +91,8 @@ module MediaWiki
         end
 
         # Gets the currently logged in user's email address.
-        # @return [String/Nil] Nil if their email is not set, or their email.
+        # @return [String] The user's email address.
+        # @return [Nil] If their email address is not set.
         def get_email_address
           response = get_current_user_meta('email')
           if response['query']['userinfo']['email'] == ''
@@ -100,6 +102,8 @@ module MediaWiki
           end
         end
 
+        # Gets the user's options.
+        # @return [Hash] The user's options.
         def get_current_user_options
           response = get_current_user_meta('options')
           ret = {}