mediawiki-butt 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f656d4e90befce4bfef592c187829a7d713f882
-  data.tar.gz: 53d0bdd862b94dd38e9f37c977e0da4b0df728ca
+  metadata.gz: 7716798bbc8877e9a116dfde230ca4a4db7a9914
+  data.tar.gz: 75fa4f657ee01443634762697672f8142d0c9387
 SHA512:
-  metadata.gz: f0bfa18ec1ab7865eb3100ff54e73a729805cf6f06e2cd51c7c04775bea35283ee3501960ea7b848727a7f4e39f95637e1a91096b64c12e92052e374406a5d79
-  data.tar.gz: 42615b44eb28fcca27d8b4ee274af367a5bf7a263a92ab3690b9d4838c8b8885522e1bd4eb0939eda12bb3393efda12f4203c026953ae2e3f8b64c7d942dc9df
+  metadata.gz: af78a66c15e2ba113cbb140037d1ca1294aa740d93e5a089dc2881228a3c087cb293aaa61fa574441217afe295affe93a6aa35055ebd7f31921a1032b9bd270e
+  data.tar.gz: 45e1c4885a3cf8e7ba01523573d60899b246b03ec49471efd98e8911275ab84496190adba89037e80216d2dc39a10de2e43716d856e6d6d5a13bcc4883ba730f

data/CHANGELOG.md

@@ -1,4 +1,18 @@
 # Changelog
+## Version 3
+### Version 3.0.0
+**Breaking changes!**
+* Update token system for MediaWiki 1.27+ (#45, #46, #65, #67).
+  * `login` no longer takes a third `token` parameter.
+  * `create_account` no longer takes a fifth `token` parameter.
+  * `create_account_email` no longer takes a fifth `token` parameter.
+  * `MediaWiki::Query::Properties#get_token` has been replaced by `MediaWiki::Query::Meta#get_token`. This only takes one parameter, as opposed to the old method's two parameters, which is the type of token to receive. Valid types are verified in the `MediaWiki::Query::Meta::TOKEN_TYPES` array.
+* Remove unnecessary `autoparse`, `header`, and `override_assertion` parameters from `post` (#68).
+  * The returned value is now always a parsed hash, never an HTTPMessage directly.
+* Initialization parameter defaults are more likely what is to be used now (#62, #66).
+  * `:query_limit_default` is now defaulted to `'max'`.
+  * `:use_continuation` is now defaulted to `true`.
+
 ## Version 2
 ### Version 2.0.1
 * Fix NoMethodError in `get_templates_in_page` when called for pages with no templates (#61)

data/lib/mediawiki/administration.rb

@@ -17,7 +17,7 @@ module MediaWiki
         expiry: expiry
       }
 
-      token = get_token('block')
+      token = get_token
       params[:reason] = reason if reason
       params[:nocreate] = '1' if nocreate
       params[:token] = token
@@ -43,7 +43,7 @@ module MediaWiki
         action: 'unblock',
         user: user
       }
-      token = get_token('unblock')
+      token = get_token
       params[:reason] = reason if reason
       params[:token] = token
 

data/lib/mediawiki/auth.rb

@@ -5,34 +5,30 @@ module MediaWiki
     # Logs the user into the wiki. This is generally required for editing and getting restricted data.
     # @param username [String] The username
     # @param password [String] The password
-    # @param token [String] The login token to use. Only set this if you know what you are doing. You probably want
-    # to just let the function get the token and set it on its own.
-    # @see #check_login
     # @see https://www.mediawiki.org/wiki/API:Login MediaWiki Login API Docs
     # @since 0.1.0
     # @raise [AuthenticationError]
     # @return [Boolean] True if the login was successful.
-    def login(username, password, token = nil)
+    def login(username, password)
+      # Save the assertion value while trying to log in, because otherwise the assertion will prevent us from logging in
+      assertion_value = @assertion.clone
+      @assertion = nil
+
       params = {
         action: 'login',
         lgname: username,
-        lgpassword: password
+        lgpassword: password,
+        lgtoken: get_token('login')
       }
-      params[:lgtoken] = token if token
-      header = {}
-      header['Set-Cookie'] = @cookie if @cookie
 
-      response = post(params, true, header, true)
-      result = response['login']['result']
+      response = post(params)
 
-      if result == 'NeedToken'
-        token = response['login']['token']
-        return login(username, password, token)
-      end
+      @assertion = assertion_value
+
+      result = response['login']['result']
 
       if result == 'Success'
-        @cookie = "#{response['login']['cookieprefix']}Session=#{response['login']['sessionid']}"
-        @name = username
+        @name = response['login']['lgusername']
         @logged_in = true
         return true
       end
@@ -50,7 +46,7 @@ module MediaWiki
           action: 'logout'
         }
 
-        post(params, true, nil, true)
+        post(params)
         @logged_in = false
 
         true
@@ -65,18 +61,16 @@ module MediaWiki
     # @param language [String] The language code to be set as default for the account. Defaults to 'en', or English.
     # Use the language code, not the name.
     # @param reason [String] The reason for creating the account, as shown in the account creation log. Optional.
-    # @param token [String] The account creation token to use. Only set this if you know what you are doing. You
-    # probably want to just let the function get the token and set it on its own.
     # @see #check_create
     # @see https://www.mediawiki.org/wiki/API:Account_creation MediaWiki Account Creation Docs
     # @since 0.1.0
     # @return [Boolean] True if successful, false if not.
-    def create_account(username, password, language = 'en', reason = nil, token = '')
+    def create_account(username, password, language = 'en', reason = nil)
       params = {
         name: username,
         password: password,
         language: language,
-        token: token
+        token: get_token('createaccount')
       }
       params[:reason] = reason unless reason.nil?
 
@@ -85,15 +79,7 @@ module MediaWiki
         raise MediaWiki::Butt::AuthenticationError.new(result['error']['code'])
       end
 
-      if result['createaccount']['result'] == 'Success'
-        @tokens.clear
-
-        return true
-      elsif result['createaccount']['result'] == 'NeedToken'
-        return create_account(username, password, language, reason, result['createaccount']['token'])
-      end
-
-      false
+      result['createaccount']['result'] == 'Success'
     end
 
     # Creates an account using the random password sent by email procedure.
@@ -103,13 +89,13 @@ module MediaWiki
     # @see https://www.mediawiki.org/wiki/API:Account_creation MediaWiki Account Creation Docs
     # @since 0.1.0
     # @return [Boolean] True if successful, false if not.
-    def create_account_email(username, email, language = 'en', reason = nil, token = '')
+    def create_account_email(username, email, language = 'en', reason = nil)
       params = {
         name: username,
         email: email,
         mailpassword: 'value',
         language: language,
-        token: token
+        token: get_token('createaccount')
       }
       params[:reason] = reason unless reason.nil?
 
@@ -118,15 +104,7 @@ module MediaWiki
         raise MediaWiki::Butt::AuthenticationError.new(result['error']['code'])
       end
 
-      if result['createaccount']['result'] == 'Success'
-        @tokens.clear
-
-        return true
-      elsif result['createaccount']['result'] == 'NeedToken'
-        return create_account_email(username, email, language, reason, result['createaccount']['token'])
-      end
-
-      false
+      result['createaccount']['result'] == 'Success'
     end
   end
 end

data/lib/mediawiki/butt.rb

@@ -34,56 +34,53 @@ module MediaWiki
     # @option opts [String] :custom_agent A custom User-Agent to use. Optional.
     # @option opts [Fixnum] :query_limit_default The query limit to use if no limit parameter is explicitly given to
     #   the various query methods. In other words, if you pass a limit parameter to the valid query methods, it will
-    #   use that, otherwise, it will use this. Defaults to 500. It can be set to 'max' to use MW's default max for
-    #   each API.
-    # @option opts [Boolean] :use_continuation Whether to use the continuation API on queries.
+    #   use that, otherwise, it will use this. Defaults to 'max' to use MW's default max for each API.
+    # @option opts [Boolean] :use_continuation Whether to use the continuation API on queries. Defaults to true.
     # @option opts [Symbol] :assertion If set to :user or :bot, will use the assert parameter in all requests.
     #   Setting this will open up the possibility for NotLoggedInErrors and NotBotErrors. It is important to keep in
     #   mind that methods that check if the user is logged in do not use the API, but check if the user has *ever*
     #   logged in as this Butt instance. In other words, it is a safety check for performance and not a valid API check.
     def initialize(url, opts = {})
       @url = url =~ /api.php$/ ? url : "#{url}/api.php"
-      @query_limit_default = opts[:query_limit_default] || 500
+      @query_limit_default = opts[:query_limit_default] || 'max'
       @client = HTTPClient.new
       @uri = URI.parse(@url)
       @logged_in = false
       @custom_agent = opts[:custom_agent]
-      @use_continuation = opts[:use_continuation]
+      @use_continuation = opts[:use_continuation] || true
 
       assertion = opts[:assertion]
       @assertion = assertion == :user || assertion == :bot ? assertion : nil
     end
 
-    # Performs a generic HTTP POST request and provides the response. This method generally should not be used by the
+    # Performs an HTTP POST request and provides the response. This method generally should not be used by the
     # user, unless there is not a helper method provided by Butt for a particular action.
-    # @param params [Hash] A basic hash containing MediaWiki API parameters. Please see the MediaWiki API for more
-    #   information.
-    # @param autoparse [Boolean] Whether or not to provide a parsed version of the response's JSON.
-    # @param header [Hash] The header hash. Optional.
-    # @param override_assertion [Boolean] Whether to override the @assertion check. This is used in #login because
-    #   that can never be done while already logged in.
+    # @param params [Hash] A hash containing MediaWiki API parameters. Please see the MediaWiki API for more
+    #   information. The method automatically sets the format and assert values, unless they are specified in this
+    #   hash argument.
     # @since 0.1.0
-    # @return [Hash] Parsed JSON if autoparse is true.
-    # @return [HTTPMessage] Raw HTTP response if autoparse is not true.
-    def post(params, autoparse = true, header = nil, override_assertion = false)
-      params[:format] = 'json'
-      params[:assert] = @assertion.to_s if @assertion && !override_assertion && !params.key?(:assert)
-      header = {} if header.nil?
-
-      header['User-Agent'] = @logged_in ? "#{@name}/MediaWiki::Butt" : 'NotLoggedIn/MediaWiki::Butt'
-      header['User-Agent'] = @custom_agent if defined? @custom_agent
-
-      res = @client.post(@uri, params, header)
+    # @return [Hash] Parsed JSON returned by the MediaWiki API
+    def post(params)
+      base_params = {
+        format: 'json'
+      }
+      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'
+      end
 
-      return res unless autoparse
-      parsed = JSON.parse(res.body)
+      response = JSON.parse(@client.post(@uri, params, header).body)
 
-      if !override_assertion || @assertion
-        code = parsed.dig('error', 'code')
-        fail MediaWiki::Butt::NotLoggedInError.new(parsed['error']['info']) if code == 'assertuserfailed'
-        fail MediaWiki::Butt::NotBotError.new(parsed['error']['info']) if code == 'assertbotfailed'
+      if @assertion
+        code = response.dig('error', 'code')
+        fail MediaWiki::Butt::NotLoggedInError.new(response['error']['info']) if code == 'assertuserfailed'
+        fail MediaWiki::Butt::NotBotError.new(response['error']['info']) if code == 'assertbotfailed'
       end
-      parsed
+      response
     end
 
     # Performs a Mediawiki API query and provides the response, dealing with continuation as necessary.

data/lib/mediawiki/edit.rb

@@ -24,7 +24,7 @@ module MediaWiki
         text: text,
         nocreate: 1,
         format: 'json',
-        token: get_token('edit', title)
+        token: get_token
       }
 
       params[:summary] ||= opts[:summary]
@@ -63,7 +63,7 @@ module MediaWiki
         summary: opts[:summary],
         createonly: 1,
         format: 'json',
-        token: get_token('edit', title)
+        token: get_token
       }
 
       params[:bot] = '1' if opts[:bot]
@@ -90,7 +90,7 @@ module MediaWiki
       params = {
         action: 'upload',
         url: url,
-        format: 'json'
+        token: get_token
       }
 
       filename = filename.nil? ? url.split('/')[-1] : filename.sub(/^File:/, '')
@@ -99,9 +99,7 @@ module MediaWiki
       allowed_extensions = get_allowed_file_extensions
       raise MediaWiki::Butt::UploadInvalidFileExtError.new unless allowed_extensions.include?(ext)
 
-      token = get_token('edit', filename)
       params[:filename] = filename
-      params[:token] = token
 
       response = post(params)
 
@@ -133,7 +131,7 @@ module MediaWiki
         action: 'move',
         from: from,
         to: to,
-        token: get_token('move', from)
+        token: get_token
       }
 
       params[:reason] ||= opts[:reason]
@@ -158,12 +156,11 @@ module MediaWiki
     def delete(title, reason = nil)
       params = {
         action: 'delete',
-        title: title
+        title: title,
+        token: get_token
       }
 
-      token = get_token('delete', title)
       params[:reason] = reason unless reason.nil?
-      params[:token] = token
 
       response = post(params)
       return true if response['delete']

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

@@ -8,6 +8,33 @@ module MediaWiki
       include MediaWiki::Query::Meta::UserInfo
       include MediaWiki::Query::Meta::FileRepoInfo
       include MediaWiki::Query::Meta::UserInfo
+
+      # All valid types of tokens. Taken from API:Tokens on MediaWiki.
+      TOKEN_TYPES = %w(csrf watch patrol rollback userrights login createaccount)
+
+      # 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).
+      def get_token(type = 'csrf')
+        params = {
+          action: 'query',
+          meta: 'tokens'
+        }
+
+        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"]
+      end
     end
   end
 end

data/lib/mediawiki/query/properties/properties.rb

@@ -8,35 +8,6 @@ module MediaWiki
       include MediaWiki::Query::Properties::Contributors
       include MediaWiki::Query::Properties::Pages
       include MediaWiki::Query::Properties::Files
-
-      # Gets the token for the given type. This method should rarely be used by normal users.
-      # @param type [String] The type of token.
-      # @param title [String] The page title for the token. Optional.
-      # @see https://www.mediawiki.org/wiki/API:Info MediaWiki Info API Docs
-      # @since 0.5.0
-      # @return [String] The token. If the butt isn't logged in, it returns  with '+\\'.
-      def get_token(type, title = nil)
-        return '+\\' unless @logged_in
-
-        # There is some weird thing with MediaWiki where you must pass a valid inprop parameter in order to get any
-        # response at all. This is why there is a displaytitle inprop as well as gibberish in the titles parameter.
-        # And to avoid normalization, it's capitalized.
-        params = {
-          action: 'query',
-          prop: 'info',
-          inprop: 'displaytitle',
-          intoken: type
-        }
-
-        title = 'Somegibberish' if title.nil?
-        params[:titles] = title
-        response = post(params)
-        revid = nil
-        response['query']['pages'].each { |r, _| revid = r }
-
-        # URL encoding is not needed for some reason.
-        response['query']['pages'][revid]["#{type}token"]
-      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Eli Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient