mediawiki-butt 0.9.0 → 0.10.0

data/lib/mediawiki/query/lists/log/merge.rb

@@ -0,0 +1,33 @@
+module MediaWiki
+  module Query
+    module Lists
+      module Log
+        module Merge
+          # Gets merge/merge logs.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   title, user, comment, destination_title, mergepoint, timestamp.
+          def get_merge_log(user = nil, title = nil, start = nil, stop = nil,
+                             limit = 500)
+            response = get_log('merge/merge', user, title, start, stop, limit)
+
+            ret = []
+            response['query']['logevents'].each do |log|
+              ret << get_mergemerge(log)
+            end
+
+            ret
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mediawiki/query/lists/log/move.rb

@@ -0,0 +1,57 @@
+module MediaWiki
+  module Query
+    module Lists
+      module Log
+        module Move
+          # Gets move/move logs.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   title, user, comment, timestamp.
+          def get_move_log(user = nil, title = nil, start = nil, stop = nil,
+                           limit = 500)
+            response = get_log('move/move', user, title, start, stop, limit)
+
+            ret = []
+            response['query']['logevents'].each do |log|
+              ret << get_move(log)
+            end
+
+            ret
+          end
+
+          # Gets move/move_redir logs for redirects.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   title, user, comment, timestamp.
+          def get_move_redirect_log(user = nil, title = nil, start = nil,
+                                    stop = nil, limit = 500)
+            resp = get_log('move/move_redir', user, title, start, stop, limit)
+
+            ret = []
+            resp['query']['logevents'].each do |log|
+              ret << get_move(log)
+            end
+
+            ret
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mediawiki/query/lists/log/newusers.rb

@@ -0,0 +1,82 @@
+module MediaWiki
+  module Query
+    module Lists
+      module Log
+        module NewUsers
+          # Gets newusers/autocreate logs.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   new_user, user, comment, timestamp.
+          def get_autocreate_users_log(user = nil, title = nil, start = nil,
+                                       stop = nil, limit = 500)
+            response = get_log('newusers/autocreate', user, title, start, stop,
+                               limit)
+
+            ret = []
+            response['query']['logevents'].each do |log|
+              ret << get_user(log)
+            end
+
+            ret
+          end
+
+          # Gets newusers/create2, when one user creates another user, logs.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   title, new_user, user, comment, timestamp.
+          def get_user_create2_log(user = nil, title = nil, start = nil,
+                                   stop = nil, limit = 500)
+            resp = get_log('newusers/create2', user, title, start, stop, limit)
+
+            ret = []
+            resp['query']['logevents'].each do |log|
+              ret << get_user(log)
+            end
+
+            ret
+          end
+
+          # Gets newusers/create, when one user creates their own account, logs.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   title, user, comment, timestamp.
+          def get_user_create_log(user = nil, title = nil, start = nil,
+                                  stop = nil, limit = 500)
+            resp = get_log('newusers/create', user, title, start, stop, limit)
+
+            ret = []
+            resp['query']['logevents'].each do |log|
+              ret << get_user(log)
+            end
+
+            ret
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mediawiki/query/lists/log/patrol.rb

@@ -0,0 +1,34 @@
+module MediaWiki
+  module Query
+    module Lists
+      module Log
+        module Patrol
+          # Gets patrol/patrol logs.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   title, user, comment, current_revision, previous_revision,
+          #   timestamp.
+          def get_patrol_log(user = nil, title = nil, start = nil, stop = nil,
+                             limit = 500)
+            response = get_log('patrol/patrol', user, title, start, stop, limit)
+
+            ret = []
+            response['query']['logevents'].each do |log|
+              ret << get_patrol(log)
+            end
+
+            ret
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mediawiki/query/lists/log/rights.rb

@@ -0,0 +1,59 @@
+module MediaWiki
+  module Query
+    module Lists
+      module Log
+        # @todo rights/erevoke
+        module Rights
+          # Gets rights/autopromote logs.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   title, user, new_rights, old_rights, comment, timestamp.
+          def get_autopromotion_log(user = nil, title = nil, start = nil,
+                                     stop = nil, limit = 500)
+            resp = get_log('rights/autopromote', user, title, start, stop,
+                           limit)
+
+            ret = []
+            resp['query']['logevents'].each do |log|
+              ret << get_rightsautopromote(log)
+            end
+
+            ret
+          end
+
+          # Gets rights/rights logs.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   title, to, from, new_rights, old_rights, comment, timestamp.
+          def get_rights_log(user = nil, title = nil, start = nil, stop = nil,
+                             limit = 500)
+            resp = get_log('rights/rights', user, title, start, stop, limit)
+
+            ret = []
+            resp['query']['logevents'].each do |log|
+              ret << get_rightsrights(log)
+            end
+
+            ret
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mediawiki/query/lists/log/upload.rb

@@ -0,0 +1,58 @@
+module MediaWiki
+  module Query
+    module Lists
+      module Log
+        # @todo upload/revert
+        module Upload
+          # Gets upload/overwrite logs.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   title, user, sha, comment, timestamp.
+          def get_upload_overwrite_log(user = nil, title = nil, start = nil,
+                                       stop = nil, limit = 500)
+            resp = get_log('upload/overwrite', user, title, start, stop, limit)
+
+            ret = []
+            resp['query']['logevents'].each do |log|
+              ret << get_upload(log)
+            end
+
+            ret
+          end
+
+          # Gets upload/upload logs.
+          # @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 {MediaWiki::Query::Lists::Log#get_log}
+          # @see https://www.mediawiki.org/wiki/API:Logevents MediaWiki
+          #   Logevents API Docs
+          # @since 0.10.0
+          # @return [Array<Hash>] The events, containing the following keys: id,
+          #   title, user, sha, comment, timestamp.
+          def get_upload_log(user = nil, title = nil, start = nil, stop = nil,
+                             limit = 500)
+            resp = get_log('upload/upload', user, title, start, stop, limit)
+
+            ret = []
+            resp['query']['logevents'].each do |log|
+              ret << get_upload(log)
+            end
+
+            ret
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module MediaWiki
+  module Query
+    module Lists
+      module Miscellaneous
+        # Returns an array of random pages titles.
+        # @param number_of_pages [Int] The number of articles to get.
+        #   Defaults to 1. Cannot be greater than 10 for normal users,
+        #   or 20 for bots.
+        # @param namespace [Int] The namespace ID. Defaults to
+        #   0 (the main namespace).
+        # @see https://www.mediawiki.org/wiki/API:Random MediaWiki Random API
+        #   Docs
+        # @since 0.2.0
+        # @return [Array] All members
+        def get_random_pages(number_of_pages = 1, namespace = 0)
+          params = {
+            action: 'query',
+            list: 'random',
+            rnlimit: get_limited(number_of_pages, 10, 20)
+          }
+
+          if MediaWiki::Constants::NAMESPACES.value?(namespace)
+            params[:rnnamespace] = namespace
+          else
+            params[:rnnamespace] = 0
+          end
+
+          ret = []
+          responce = post(params)
+          responce['query']['random'].each { |a| ret << a['title'] }
+
+          ret
+        end
+
+        # Gets the valid change tags on the wiki.
+        # @param limit [Int] The maximum number of results to get. Maximum 5000
+        #   for bots and 500 for users.
+        # @see https://www.mediawiki.org/wiki/API:Tags MediaWiki Tags API Docs
+        # @since 0.10.0
+        # @return [Array<String>] All tag names.
+        def get_tags(limit = 500)
+          params = {
+            action: 'query',
+            list: 'tags',
+            limit: get_limited(limit)
+          }
+          response = post(params)
+          ret = []
+          response['query']['tags'].each { |tag| ret << tag['name'] }
+          ret
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,203 @@
+require_relative 'users'
+
+module MediaWiki
+  module Query
+    module Lists
+      module QueryPage
+        include MediaWiki::Query::Lists::Users
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_mostrevisions_page(limit = 500)
+          get_querypage('Mostrevisions', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_mostlinked_page(limit = 500)
+          get_querypage('Mostlinked', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_mostlinkedtemplates_page(limit = 500)
+          get_querypage('Mostlinkedtemplates', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_mostlinkedcategories_page(limit = 500)
+          get_querypage('Mostlinkedcategories', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_mostinterwikis_page(limit = 500)
+          get_querypage('Mostinterwikis', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_mostimages_page(limit = 500)
+          get_querypage('Mostimages', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_mostcategories_page(limit = 500)
+          get_querypage('Mostcactegories', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_listduplicatedfiles_page(limit = 500)
+          get_querypage('ListDuplicatedFiles', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_listredirects_page(limit = 500)
+          get_querypage('Listredirects', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_wantedtemplates_page(limit = 500)
+          get_querypage('Wantedtemplates', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_wantedpages_page(limit = 500)
+          get_querypage('Wantedpages', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_wantedfiles_page(limit = 500)
+          get_querypage('Wantedfiles', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_wantedcategories_page(limit = 500)
+          get_querypage('Wantedcategories', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        # @return [Nil] If the user does not have the necessary rights.
+        def get_unwatchedpages_page(limit = 500)
+          rights = get_userrights
+          if rights != false && rights.include?('unwatchedpages')
+            get_querypage('Unwatchedpages', limit)
+          else
+            return nil
+          end
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_unusedtemplates_page(limit = 500)
+          get_querypage('Unusedtemplates', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_unusedcategories_page(limit = 500)
+          get_querypage('Unusedcategories', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_uncategorizedtemplates_page(limit = 500)
+          get_querypage('Uncategorizedtemplates', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_uncategorizedpages_page(limit = 500)
+          get_querypage('Uncategorizedpages', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_uncategorizedcategories_page(limit = 500)
+          get_querypage('Uncategorizedcategories', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_shortpages_page(limit = 500)
+          get_querypage('Shortpages', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_withoutinterwiki_page(limit = 500)
+          get_querypage('Withoutinterwiki', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_fewestrevisions_page(limit = 500)
+          get_querypage('Fewestrevisions', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_lonelypages_page(limit = 500)
+          get_querypage('Lonelypages', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_ancientpages_page(limit = 500)
+          get_querypage('Ancientpages', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_longpages_page(limit = 500)
+          get_querypage('Longpages', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_doubleredirects_page(limit = 500)
+          get_querypage('DoubleRedirects', limit)
+        end
+
+        # @since 0.10.0
+        # @see #get_querypage
+        def get_brokenredirects_page(limit = 500)
+          get_querypage('BrokenRedirects', limit)
+        end
+
+        # Performs a QueryPage request.
+        # @param page [String] The special page (not including Special:) to
+        #   query.
+        # @param limit [Int] The limit.
+        # @see https://www.mediawiki.org/wiki/API:Querypage MediaWiki QueryPage
+        #   API Docs
+        # @since 0.10.0
+        # @return [Hash] The response.
+        def get_querypage(page, limit = 500)
+          params = {
+            action: 'query',
+            list: 'querypage',
+            qppage: page,
+            qplimit: get_limited(limit)
+          }
+          response = post(params)
+          ret = []
+          response['query']['querypage']['results'].each do |result|
+            ret << result['title']
+          end
+
+          ret
+        end
+      end
+    end
+  end
+end