mediawiki-butt 3.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7716798bbc8877e9a116dfde230ca4a4db7a9914
-  data.tar.gz: 75fa4f657ee01443634762697672f8142d0c9387
+SHA256:
+  metadata.gz: 175a073830204042dc379d9052239791398ff93a793d7546db1c92da3d30ced8
+  data.tar.gz: c08d9cb85b4e7492c9cf74882ccc38236bedf248f6e41bb24c14d461624d8e89
 SHA512:
-  metadata.gz: af78a66c15e2ba113cbb140037d1ca1294aa740d93e5a089dc2881228a3c087cb293aaa61fa574441217afe295affe93a6aa35055ebd7f31921a1032b9bd270e
-  data.tar.gz: 45e1c4885a3cf8e7ba01523573d60899b246b03ec49471efd98e8911275ab84496190adba89037e80216d2dc39a10de2e43716d856e6d6d5a13bcc4883ba730f
+  metadata.gz: 29377d587605d49389ff50bb14c5a762126ef3e83700cc3ebf39ae8885da286aa66222c5b7adc943ffa33ac56c65bdbef9c2dd0990dd91d78110c1983fe894cc
+  data.tar.gz: 5b7888432084599c4c7de6a0bf6ce1427d8a2d5f17cc45f63c9f01a0feebab53c1f8e0025a36385fba6247c04890a7a512426cf1a63629874eb46293ac496d76

data/CHANGELOG.md

@@ -1,4 +1,49 @@
 # Changelog
+## Version 4
+### Version 4.0.1
+* Yank 4.0.0, fix gem build.
+
+### Version 4.0.0
+**Breaking changes!**
+* Add support for searching text (NCC-Gnisha) (#69, #77).
+* Replace HTTPClient with Patron (#71).
+* Fix limiting on `get_tags`.
+* Implement token caching (#75).
+* Change log hash formatting methods from `get_[type]` to `loghash_[type]` to fix `NoMethodError`s in log queries (#35).
+  * Fixes overlapping methods, such as `get_general` from siteinfo and `get_general` from log.
+  * Is more accurate as a descriptor, because no new data is being "gotten" from these methods, they only format data.
+  * Affected methods:
+    * `get_block` -> `loghash_block`
+    * `get_unblock` -> `loghash_unblock`
+    * `get_importinterwiki` -> `loghash_importinterwiki`
+    * `get_general` -> `loghash_general`
+    * `get_merge` -> `loghash_merge`
+    * `get_move` -> `loghash_move`
+    * `get_user` -> `loghash_user`
+    * `get_patrol` -> `loghash_patrol`
+    * `get_protect` -> `loghash_protect`
+    * `get_protectmoveprot` -> `loghash_protectmoveprot`
+    * `get_unprotect` -> `loghash_unprotect`
+    * `get_rightsautopromote` -> `loghash_rightsautopromote`
+    * `get_rightsrights` -> `loghash_rightsrights`
+    * `get_upload` -> `loghash_upload`
+* Fix broken log hash keys causing `NoMethodError`s (#35):
+  * `loghash_block`: `flags`, `duration`, and `expiry`
+  * `loghash_move`: `new_title`, and `suppressredirect`
+  * `loghash_patrol`: `current_revision`, and `previous_revision`; remove `automatic`
+  * `loghash_protect`: `details` (`type`, `expiry`, `level`) is not present in older protection logs; getting protection logs will no longer error on older entries without `details`
+  * `loghash_rightsautopromote`: `new_rights`, `old_rights`
+  * `loghash_rightsrights`: `new_rights`, `old_rights`
+* Fix missing log hash methods causing `NoMethodError`s (#35):
+  * `get_reblock_log`
+  * `get_unblock_log`
+  * `get_overall_log`
+  * `get_merge_log`
+* Returned log hash in move logs no longer has `title` key, it is now called `old_title`.
+* Rights log hashes no longer have `title` key because they were not useful.
+* Update minitest
+* Implement patrol API support. Patrol edits with the `patrol` method, which if errors will raise a `PatrolError` (#76).
+
 ## Version 3
 ### Version 3.0.0
 **Breaking changes!**

data/lib/mediawiki/butt.rb

@@ -5,7 +5,7 @@ require_relative 'edit'
 require_relative 'administration'
 require_relative 'watch'
 require_relative 'purge'
-require 'httpclient'
+require 'patron'
 require 'json'
 
 module MediaWiki
@@ -43,11 +43,20 @@ module MediaWiki
     def initialize(url, opts = {})
       @url = url =~ /api.php$/ ? url : "#{url}/api.php"
       @query_limit_default = opts[:query_limit_default] || 'max'
-      @client = HTTPClient.new
-      @uri = URI.parse(@url)
-      @logged_in = false
       @custom_agent = opts[:custom_agent]
+      @session = Patron::Session.new
+      @session.timeout = 60
+      @session.handle_cookies
+      @session.headers['User-Agent'] = @custom_agent if @custom_agent
+      @logged_in = false
       @use_continuation = opts[:use_continuation] || true
+      # Token cache, populated in #get_token and depopulated in #post. Type => Token
+      @tokens = {}
+      # The most recent kind of token acquired. Used in #post, set/reset in #get_token.
+      @prev_token_type = ''
+      # Set to prevent token cache handling from producing an infinite call loop. Defaults to true, set to false when
+      # token recache is being handled.
+      @first_token_try = true
 
       assertion = opts[:assertion]
       @assertion = assertion == :user || assertion == :bot ? assertion : nil
@@ -66,14 +75,24 @@ module MediaWiki
       }
       base_params[:assert] = @assertion.to_s if @assertion
       params = base_params.merge(params)
-      header = {}
-      if defined? @custom_agent
-        header['User-Agent'] = @custom_agent
-      else
-        header['User-Agent'] = @logged_in ? "#{@name}/MediaWiki::Butt" : 'NotLoggedIn/MediaWiki::Butt'
+
+      unless @custom_agent
+        @session.headers['User-Agent'] = @logged_in ? "#{@name}/MediaWiki::Butt" : 'NotLoggedIn/MediaWiki::Butt'
       end
 
-      response = JSON.parse(@client.post(@uri, params, header).body)
+      response = JSON.parse(@session.post(@url, params).body)
+
+      # If our tokens have expired, clear them, re-set the relevant token argument, and re-call this #post method
+      if response.dig('error', 'code') == 'badtoken' && @first_token_try
+        @tokens.clear
+        token_param = params.keys.select { |i| i.to_s.end_with?('token') }[0]
+        params[token_param] = get_token(@prev_token_type)
+        # Prevent token retry attempt in next #post call
+        @first_token_try = false
+        return post(params)
+      end
+      # Reset token retry value if no badtoken error has occurred.
+      @first_token_try = true
 
       if @assertion
         code = response.dig('error', 'code')
@@ -134,23 +153,19 @@ module MediaWiki
     # @since 0.3.0 as is_user_bot?
     # @since 0.4.1 as user_bot?
     def user_bot?
-      begin
-        post({ action: 'query', assert: 'bot' })
-        true
-      rescue MediaWiki::Butt::NotBotError
-        false
-      end
+      post({ action: 'query', assert: 'bot' })
+      true
+    rescue MediaWiki::Butt::NotBotError
+      false
     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
+      post({ action: 'query', assert: 'user' })
+      true
+    rescue MediaWiki::Butt::NotLoggedInError
+      false
     end
 
     protected

data/lib/mediawiki/edit.rb

@@ -166,5 +166,33 @@ module MediaWiki
       return true if response['delete']
       raise MediaWiki::Butt::EditError.new(response.dig('error', 'code') || 'Unknown error code')
     end
+
+    # Patrol an edit by its recentchanges or revision ID.
+    # @param opts [Hash<Symbol, String>] Options param.
+    # @option :rcid [String, Integer] Recentchanges ID to patrol.
+    # @option :revid [String, Integer] Revision ID to patrol.
+    # @option :tags [String, Array<String>] Change tags to apply to the entry in the patrol log, either as a string of
+    #   tags separated by | or as an array of tag strings.
+    # @see https://www.mediawiki.org/wiki/API:Patrol Patrol API documentation
+    # @raise [PatrolError]
+    # @return [String] The title of the page that was patrolled, if it was patrolled.
+    def patrol(opts = {})
+      params = {
+        action: 'patrol',
+        token: get_token('patrol')
+      }
+
+      params[:rcid] = opts[:rcid] if opts[:rcid]
+      params[:revid] = opts[:revid] if opts[:revid]
+      params[:tags] = opts[:tags] if opts[:tags]
+
+      if opts[:tags]
+        params[:tags] = opts[:tags].is_a?(Array) ? opts[:tags].join('|') : opts[:tags]
+      end
+
+      response = post(params)
+      return response['patrol']['title'] if response['patrol']
+      raise MediaWiki::Butt::PatrolError.new(response.dig('error', 'code') || 'Unknown error code')
+    end
   end
 end

data/lib/mediawiki/exceptions.rb

@@ -6,5 +6,6 @@ module MediaWiki
     class NotLoggedInError < StandardError; end
     class NotBotError < StandardError; end
     class UploadInvalidFileExtError < StandardError; end
+    class PatrolError < StandardError; end
   end
 end

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

@@ -21,7 +21,7 @@ module MediaWiki
 
             ret = []
             response['query']['logevents'].each do |log|
-              ret << get_block(log)
+              ret << loghash_block(log)
             end
 
             ret
@@ -38,7 +38,7 @@ module MediaWiki
 
             ret = []
             response['query']['logevents'].each do |log|
-              ret << get_blockreblock(log)
+              ret << loghash_block(log)
             end
 
             ret
@@ -55,7 +55,7 @@ module MediaWiki
 
             ret = []
             response['query']['logevents'].each do |log|
-              ret << get_blockunblock(log)
+              ret << loghash_unblock(log)
             end
 
             ret

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

@@ -15,7 +15,7 @@ module MediaWiki
 
             ret = []
             response['query']['logevents'].each do |log|
-              ret << get_general(log)
+              ret << loghash_general(log)
             end
 
             ret
@@ -31,7 +31,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_general(log)
+              ret << loghash_general(log)
             end
 
             ret

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

@@ -14,7 +14,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_importinterwiki(log)
+              ret << loghash_importinterwiki(log)
             end
 
             ret
@@ -30,7 +30,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_importupload(log)
+              ret << loghash_importupload(log)
             end
 
             ret

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

@@ -1,3 +1,4 @@
+require 'date'
 require_relative '../../../constants'
 require_relative 'block'
 require_relative 'delete'
@@ -53,65 +54,63 @@ module MediaWiki
             case log['type']
             when 'block'
               case log['action']
-              when 'block'
-                hash = get_blockblock(log)
+              when 'block', 'reblock'
+                hash = loghash_block(log)
               when 'unblock'
-                hash = get_blockunblock(log)
-              when 'reblock'
-                hash = get_blockreblock(log)
+                hash = loghash_unblock(log)
               end
             when 'delete'
               case log['action']
               when 'delete', 'restore'
-                hash = get_deletedelete(log)
+                hash = loghash_general(log)
               end
             when 'import'
               case log['action']
               when 'interwiki'
-                hash = get_importinterwiki(log)
+                hash = loghash_importinterwiki(log)
               when 'upload'
-                hash = get_importupload(log)
+                hash = loghash_importupload(log)
               end
             when 'merge'
               case log['action']
               when 'merge'
-                hash = get_mergemerge(log)
+                hash = loghash_merge(log)
               end
             when 'move'
               case log['action']
               when 'move', 'move_redir'
-                hash = get_move(log)
+                hash = loghash_move(log)
               end
             when 'newusers'
               case log['action']
               when 'autocreate', 'create', 'create2'
-                hash = get_user(log)
+                hash = loghash_user(log)
               end
             when 'patrol'
               case log['action']
               when 'patrol'
-                hash = get_patrol(log)
+                hash = loghash_patrol(log)
               end
             when 'protect'
               case log['action']
               when 'modify', 'protect'
-                hash = get_protect(log)
+                hash = loghash_protect(log)
               when 'move_prot'
-                hash = get_protectmoveprot(log)
+                hash = loghash_protectmoveprot(log)
               when 'unprotect'
-                hash = get_protectunprotect(log)
+                hash = loghash_protectunprotect(log)
               end
             when 'rights'
               case log['action']
               when 'autopromote'
-                hash = get_rightsautopromote(log)
+                hash = loghash_rightsautopromote(log)
               when 'rights'
-                hash = get_rightsrights(log)
+                hash = loghash_rightsrights(log)
               end
             when 'upload'
               case log['action']
               when 'overwrite', 'upload'
-                hash = get_upload(log)
+                hash = loghash_upload(log)
               end
             end
 
@@ -150,20 +149,22 @@ module MediaWiki
           post(params)
         end
 
-        def get_block(log)
-          {
+        def loghash_block(log)
+          hash = {
             id: log['logid'],
             blocked: log['title'],
-            flags: log['block']['flags'],
-            duration: log['block']['duration'],
-            expiry: DateTime.xmlschema(log['block']['expiry']),
+            flags: log['params']['flags'],
+            duration: log['params']['duration'],
             blocker: log['user'],
             comment: log['comment'],
             timestamp: DateTime.xmlschema(log['timestamp'])
           }
+          hash[:expiry] = DateTime.xmlschema(log['params']['expiry']) if log['params'].key?('expiry')
+
+          hash
         end
 
-        def get_unblock(log)
+        def loghash_unblock(log)
           {
             id: log['logid'],
             blocked: log['title'],
@@ -173,7 +174,7 @@ module MediaWiki
           }
         end
 
-        def get_importinterwiki(log)
+        def loghash_importinterwiki(log)
           {
             id: log['logid'],
             title: log['title'],
@@ -185,7 +186,18 @@ module MediaWiki
           }
         end
 
-        def get_general(log)
+        def loghash_importupload(log)
+          {
+            id: log['logid'],
+            title: log['title'],
+            user: log['user'],
+            comment: log['comment'],
+            timestamp: DateTime.xmlschema(log['timestamp']),
+            count: log['params']['count']
+          }
+        end
+
+        def loghash_general(log)
           {
             id: log['logid'],
             title: log['title'],
@@ -195,7 +207,7 @@ module MediaWiki
           }
         end
 
-        def get_merge(log)
+        def loghash_merge(log)
           {
             id: log['logid'],
             title: log['title'],
@@ -207,7 +219,7 @@ module MediaWiki
           }
         end
 
-        def get_move(log)
+        def loghash_move(log)
           hash = {
             id: log['logid'],
             timestamp: DateTime.xmlschema(log['timestamp'])
@@ -215,22 +227,22 @@ module MediaWiki
 
           if log.key?('actionhidden')
             hash[:hidden] = true
-            hash[:title] = nil
+            hash[:old_title] = nil
             hash[:comment] = nil
             hash[:suppressedredirect] = log.key('suppressed')
           else
-            hash[:title] = log['title']
-            hash[:new_title] = log['move']['new_title']
+            hash[:old_title] = log['title']
+            hash[:new_title] = log['params']['target_title']
             hash[:user] = log['user']
             hash[:comment] = log['comment']
 
-            hash[:suppressedredirect] = log['move'].key?('suppressedredirect')
+            hash[:suppressedredirect] = log['params'].key?('suppressedredirect')
           end
 
           hash
         end
 
-        def get_user(log)
+        def loghash_user(log)
           {
             id: log['logid'],
             new_user: log['title'],
@@ -240,23 +252,19 @@ module MediaWiki
           }
         end
 
-        def get_patrol(log)
-          hash = {
+        def loghash_patrol(log)
+          {
             id: log['logid'],
             title: log['title'],
             user: log['user'],
             comment: log['comment'],
-            current_revision: log['patrol']['cur'],
-            previous_revision: log['patrol']['prev'],
+            current_revision: log['params']['curid'],
+            previous_revision: log['params']['previd'],
             timestamp: DateTime.xmlschema(log['timestamp'])
           }
-          auto = log['patrol']['auto']
-          hash[:automatic] = auto == 1
-
-          hash
         end
 
-        def get_protect(log)
+        def loghash_protect(log)
           hash = {
             id: log['logid'],
             title: log['title'],
@@ -268,22 +276,25 @@ module MediaWiki
 
           hash[:details] = []
 
-          log['params']['detail'].each do |detail|
-            details_hash = {
-              type: detail['type'],
-              level: detail['level']
-            }
-            expire = detail['expiry']
-            if expire != 'infinite'
-              details_hash[:expiry] = DateTime.xmlschema(expire)
+          # It appears that older protection logs did not have a details key.
+          if log['params'].key?('details')
+            log['params']['details'].each do |detail|
+              details_hash = {
+                type: detail['type'],
+                level: detail['level']
+              }
+              expire = detail['expiry']
+              if expire != 'infinite'
+                details_hash[:expiry] = DateTime.xmlschema(expire)
+              end
+              hash[:details] << details_hash
             end
-            hash[:details] << details_hash
           end
 
           hash
         end
 
-        def get_protectmoveprot(log)
+        def loghash_protectmoveprot(log)
           {
             id: log['logid'],
             title: log['title'],
@@ -294,7 +305,7 @@ module MediaWiki
           }
         end
 
-        def get_protectunprotect(log)
+        def loghash_protectunprotect(log)
           {
             id: log['logid'],
             title: log['title'],
@@ -304,32 +315,30 @@ module MediaWiki
           }
         end
 
-        def get_rightsautopromote(log)
+        def loghash_rightsautopromote(log)
           {
             id: log['logid'],
-            title: log['title'],
             user: log['user'],
-            new_rights: log['rights']['new'].split(', '),
-            old_rights: log['rights']['old'].split(', '),
+            new_rights: log['params']['newgroups'],
+            old_rights: log['params']['oldgroups'],
             comment: log['comment'],
             timestamp: DateTime.xmlschema(log['timestamp'])
           }
         end
 
-        def get_rightsrights(log)
+        def loghash_rightsrights(log)
           {
             id: log['logid'],
-            title: log['title'],
             to: log['title'],
             from: log['user'],
-            new_rights: log['rights']['new'].split(', '),
-            old_rights: log['rights']['old'].split(', '),
+            new_rights: log['params']['newgroups'],
+            old_rights: log['params']['oldgroups'],
             comment: log['comment'],
             timestamp: DateTime.xmlschema(log['timestamp'])
           }
         end
 
-        def get_upload(log)
+        def loghash_upload(log)
           {
             id: log['logid'],
             title: log['title'],

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

@@ -14,7 +14,7 @@ module MediaWiki
 
             ret = []
             response['query']['logevents'].each do |log|
-              ret << get_mergemerge(log)
+              ret << loghash_merge(log)
             end
 
             ret

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

@@ -14,7 +14,7 @@ module MediaWiki
 
             ret = []
             response['query']['logevents'].each do |log|
-              ret << get_move(log)
+              ret << loghash_move(log)
             end
 
             ret
@@ -31,7 +31,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_move(log)
+              ret << loghash_move(log)
             end
 
             ret

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

@@ -14,7 +14,7 @@ module MediaWiki
 
             ret = []
             response['query']['logevents'].each do |log|
-              ret << get_user(log)
+              ret << loghash_user(log)
             end
 
             ret
@@ -31,7 +31,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_user(log)
+              ret << loghash_user(log)
             end
 
             ret
@@ -47,7 +47,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_user(log)
+              ret << loghash_user(log)
             end
 
             ret

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

@@ -14,7 +14,7 @@ module MediaWiki
 
             ret = []
             response['query']['logevents'].each do |log|
-              ret << get_patrol(log)
+              ret << loghash_patrol(log)
             end
 
             ret

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

@@ -15,7 +15,7 @@ module MediaWiki
 
             ret = []
             response['query']['logevents'].each do |log|
-              ret << get_protect(log)
+              ret << loghash_protect(log)
             end
 
             ret
@@ -32,7 +32,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_protectmoveprot(log)
+              ret << loghash_protectmoveprot(log)
             end
 
             ret
@@ -49,7 +49,7 @@ module MediaWiki
 
             ret = []
             response['query']['logevents'].each do |log|
-              ret << get_protect(log)
+              ret << loghash_protect(log)
             end
 
             ret
@@ -65,7 +65,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_protectunprotect(log)
+              ret << loghash_protectunprotect(log)
             end
 
             ret

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

@@ -16,7 +16,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_rightsautopromote(log)
+              ret << loghash_rightsautopromote(log)
             end
 
             ret
@@ -33,7 +33,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_rightsrights(log)
+              ret << loghash_rightsrights(log)
             end
 
             ret

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

@@ -15,7 +15,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_upload(log)
+              ret << loghash_upload(log)
             end
 
             ret
@@ -32,7 +32,7 @@ module MediaWiki
 
             ret = []
             resp['query']['logevents'].each do |log|
-              ret << get_upload(log)
+              ret << loghash_upload(log)
             end
 
             ret

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

@@ -32,7 +32,7 @@ module MediaWiki
         def get_tags(limit = @query_limit_default)
           params = {
             list: 'tags',
-            limit: get_limited(limit)
+            tglimit: get_limited(limit)
           }
 
           query_ary(params, 'tags', 'name')

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

@@ -4,11 +4,11 @@ module MediaWiki
       module Search
         # Gets the amount of results for the search value.
         # @param search_value [String] The thing to search for.
-        # @param namespace [Fixnum] The namespace to search in. Defaults to 0 (the main namespace).
+        # @param namespace [Integer] 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 [Fixnum] The number of pages that matched the search.
-        def get_search_result_amount(search_value, namespace = 0)
+        def get_search_result_amount(search_value, namespace = MediaWiki::Constants::NAMESPACES['MAIN'])
           params = {
             action: 'query',
             list: 'search',
@@ -22,11 +22,11 @@ module MediaWiki
 
         # Gets an array containing page titles that matched the search.
         # @param search_value [String] The thing to search for.
-        # @param namespace [Fixnum] The namespace to search in. Defaults to 0 (the main namespace).
+        # @param namespace [Integer] 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<String>] The page titles that matched the search.
-        def get_search_results(search_value, namespace = 0)
+        def get_search_results(search_value, namespace = MediaWiki::Constants::NAMESPACES['MAIN'])
           params = {
             list: 'search',
             srsearch: search_value,
@@ -36,9 +36,26 @@ module MediaWiki
           query_ary(params, 'search', 'title')
         end
 
+        # Gets an array containing page titles that matched the search.
+        # @param search_value [String] The thing to search for.
+        # @param namespace [Integer] The namespace to search in. Defaults to 0 (the main namespace).
+        # @see https://www.mediawiki.org/wiki/API:Search MediaWiki Search API Docs
+        # @return [Array<String>] The page titles that matched the search.
+        def get_search_text_results(search_value, namespace = MediaWiki::Constants::NAMESPACES['MAIN'], limit = @query_limit_default)
+          params = {
+            list: 'search',
+            srsearch: search_value,
+            srwhat: 'text',
+            srlimit: get_limited(limit),
+            srnamespace: validate_namespace(namespace)
+          }
+
+          query_ary(params, 'search', 'title')
+        end
+
         # Searches the wiki by a prefix.
         # @param prefix [String] The prefix.
-        # @param limit [Fixnum] The maximum number of results to get, maximum of 100 for users and 200 for bots. This is
+        # @param limit [Integer] 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

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

@@ -14,26 +14,25 @@ module MediaWiki
 
       # Obtains a token for the current user (or lack thereof) for specific actions. This uses the functionality
       # introduced in MediaWiki 1.27
-      # @param type [String, Array<String>] The type of token to get. See #TOKEN_TYPES to see the valid types. If it
-      #   is invalid, it will default to 'csrf'. If it is an array, it will join by a pipe for the API.
-      # @return [String, Hash<String => String>] Either a token or a set of tokens organized by type. If multiple
-      #   valid types are provided in the parameter, it returns a hash identical to the API response (see API docs).
+      # @param type [String] The type of token to get. See #TOKEN_TYPES to see the valid types. If it is invalid, it
+      #   will default to 'csrf'.
+      # @return [String] A token for the provided type.
       def get_token(type = 'csrf')
+        type = 'csrf' unless TOKEN_TYPES.include?(type)
+
+        return @tokens[type] if @tokens.key?(type)
+
         params = {
           action: 'query',
-          meta: 'tokens'
+          meta: 'tokens',
+          type: type
         }
 
-        if type.is_a?(Array)
-          type = (type - TOKEN_TYPES).empty? ? type.join('|') : 'csrf'
-        else
-          type = TOKEN_TYPES.include?(type) ? type : 'csrf'
-        end
-        params[:type] = type
-
         resp = post(params)
         tokens = resp['query']['tokens']
-        tokens.size > 1 ? tokens : tokens["#{type}token"]
+        token = tokens["#{type}token"]
+        @tokens[type] = token
+        token
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Eli Foster
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2020-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: patron
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '0.13'
 description: "    MediaWiki::Butt provides a fully-featured interface to the MediaWiki
   API.     It includes methods for changing wiki content, authentication,     and
   queries.\n\n"
@@ -94,8 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Interacting with the MediaWiki API