mediawiki-butt 0.9.0 → 0.10.0

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

@@ -0,0 +1,124 @@
+require_relative 'users'
+
+module MediaWiki
+  module Query
+    module Lists
+      module RecentChanges
+        include MediaWiki::Query::Lists::Users
+
+        # 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
+        # @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'
+          rights = get_userrights
+          patrol = false
+          if rights != false && rights.include?('patrol')
+            prop << '|patrolled'
+            patrol = true
+          end
+          params = {
+            action: 'query',
+            list: 'recentchanges',
+            rcprop: prop,
+            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?
+
+          response = post(params)
+          ret = []
+          p response
+          response['query']['recentchanges'].each do |change|
+            old_length = change['oldlen']
+            new_length = change['newlen']
+            diff_length = new_length - old_length
+
+            hash = {
+              type: change['type'],
+              title: change['title'],
+              revid: change['revid'],
+              old_revid: change['old_revid'],
+              rcid: change['rcid'],
+              user: change['user'],
+              old_length: old_length,
+              new_length: new_length,
+              diff_length: diff_length,
+              timestamp: DateTime.strptime(change['timestamp'], time_format),
+              comment: change['comment'],
+              parsed_comment: change['parsedcomment'],
+              sha: change['sha1']
+            }
+            hash[:new] = change.key?('new')
+            hash[:minor] = change.key?('minor')
+            hash[:bot] = change.key?('bot')
+
+            hash[:patrolled] = change.key?('patrolled') if patrol
+
+            if change['type'] == 'log'
+              hash[:log_type] = change['logtype']
+              hash[:log_action] = change['logaction']
+              hash[:logid] = change['logid']
+            end
+
+            ret << hash
+          end
+
+          ret
+        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
+        # @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
+          prop = 'revid|parentid|user|comment|parsedcomment|minor|len|sh1|tags'
+          params = {
+            action: 'query',
+            list: 'deletedrevs',
+            drprop: prop,
+            limit: get_limited(limit)
+          }
+          params[:drstart] = start.strftime(time_format) unless start.nil?
+          params[:drend] = stop.strftime(time_format) 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),
+              user: r['user'],
+              comment: r['comment'],
+              title: rev['title']
+            }
+            ret << hash
+          end
+
+          ret
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+module MediaWiki
+  module Query
+    module Lists
+      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
+        # @since 0.4.0
+        # @return [Int] 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
+          }
+
+          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
+        # @since 0.4.0
+        # @return [Array] The page titles that matched the search.
+        def get_search_results(search_value, namespace = 0)
+          params = {
+            action: 'query',
+            list: 'search',
+            srsearch: search_value
+          }
+
+          if MediaWiki::Constants::NAMESPACES.value?(namespace)
+            params[:srnamespace] = namespace
+          else
+            params[:srnamespace] = 0
+          end
+
+          response = post(params)
+
+          ret = []
+          response['query']['search'].each { |search| ret << search['title'] }
+
+          ret
+        end
+
+        # 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
+        # @since 0.10.0
+        # @return [Array<String>] All of the page titles that match the search.
+        def get_prefix_search(prefix, limit = 100)
+          params = {
+            action: 'query',
+            list: 'prefixsearch',
+            pssearch: prefix,
+            limit: get_limited(limit, 100, 200)
+          }
+
+          response = post(params)
+          ret = []
+          response['query']['prefixsearch'].each do |result|
+            ret << result['title']
+          end
+
+          ret
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,210 @@
+module MediaWiki
+  module Query
+    module Lists
+      module Users
+        # 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
+        # @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
+          else
+            params = {
+              action: 'query',
+              list: 'users',
+              usprop: prop,
+              ususers: username
+            }
+
+            response = post(params)
+          end
+
+          response
+        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.
+        # @see get_userlists
+        # @since 0.3.0
+        # @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?
+            if @logged_in
+              info = get_userlists('groups')
+              info['query']['userinfo']['groups'].each { |i| ret << i }
+            else
+              return false
+            end
+          else
+            info = get_userlists('groups', username)
+            info['query']['users'].each do |i|
+              i['groups'].each { |g| ret.push(g) }
+            end
+          end
+
+          ret
+        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.
+        # @see get_userlists
+        # @since 0.3.0
+        # @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?
+            if @logged_in
+              info = get_userlists('rights')
+              info['query']['userinfo']['rights'].each { |i| ret << i }
+            else
+              return false
+            end
+          else
+            info = get_userlists('rights', username)
+            info['query']['users'].each do |i|
+              i['rights'].each do |g|
+                ret.push(g)
+              end
+            end
+          end
+
+          ret
+        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.
+        # @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.
+        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
+          else
+            info = get_userlists('editcount', username)
+            info['query']['users'].each { |i| count = i['editcount'] }
+          end
+
+          count
+        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.
+        # @see get_userlists
+        # @since 0.4.0
+        # @return [DateTime] The registration date and time as a DateTime object.
+        def get_registration_time(username = nil)
+          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
+          else
+            info = get_userlists('registration', username)
+            info['query']['users'].each { |i| time = i['registration'] }
+          end
+
+          DateTime.strptime(time, '%Y-%m-%dT%T')
+        end
+
+        # Gets the gender for the provded user.
+        # @param username [String] The user.
+        # @see get_userlists
+        # @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
+        end
+
+        # 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
+        # @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)
+          params = {
+            action: 'query',
+            list: 'usercontribs',
+            ucuser: user,
+            uclimit: 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.
+        # @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)
+          params = {
+            action: 'query',
+            list: 'watchlist',
+            wlprop: 'title'
+          }
+          params[:wluser] = user unless user.nil?
+
+          response = post(params)
+
+          ret = []
+          response['query']['watchlist'].each { |t| ret << t['title'] }
+
+          ret
+        end
+      end
+    end
+  end
+end

data/lib/mediawiki/query/query.rb

@@ -1,5 +1,5 @@
 require_relative 'meta/meta'
-require_relative 'lists'
+require_relative 'lists/lists'
 require_relative 'properties/properties'
 
 module MediaWiki

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Eli Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-19 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -33,6 +33,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - lib/mediawiki-butt.rb
 - lib/mediawiki/administration.rb
 - lib/mediawiki/auth.rb
@@ -40,7 +41,25 @@ files:
 - lib/mediawiki/constants.rb
 - lib/mediawiki/edit.rb
 - lib/mediawiki/exceptions.rb
-- lib/mediawiki/query/lists.rb
+- lib/mediawiki/query/lists/all.rb
+- lib/mediawiki/query/lists/backlinks.rb
+- lib/mediawiki/query/lists/categories.rb
+- lib/mediawiki/query/lists/lists.rb
+- lib/mediawiki/query/lists/log/block.rb
+- lib/mediawiki/query/lists/log/delete.rb
+- lib/mediawiki/query/lists/log/import.rb
+- lib/mediawiki/query/lists/log/log.rb
+- lib/mediawiki/query/lists/log/merge.rb
+- lib/mediawiki/query/lists/log/move.rb
+- lib/mediawiki/query/lists/log/newusers.rb
+- lib/mediawiki/query/lists/log/patrol.rb
+- lib/mediawiki/query/lists/log/rights.rb
+- lib/mediawiki/query/lists/log/upload.rb
+- lib/mediawiki/query/lists/miscellaneous.rb
+- lib/mediawiki/query/lists/querypage.rb
+- lib/mediawiki/query/lists/recent_changes.rb
+- lib/mediawiki/query/lists/search.rb
+- lib/mediawiki/query/lists/users.rb
 - lib/mediawiki/query/meta/filerepoinfo.rb
 - lib/mediawiki/query/meta/meta.rb
 - lib/mediawiki/query/meta/siteinfo.rb