mediawiki-butt 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f0cb702f0e050eec5aad59b978c319b3bdb4d88
-  data.tar.gz: c3d22dd52186fd7e1bfd837230a5984287835087
+  metadata.gz: bc43e07782836b5480c6da51986099f1109c1a7d
+  data.tar.gz: 5e8e4ac85f0d95c6e11a522b8a00546b3dbb429a
 SHA512:
-  metadata.gz: 5331fe0d0bb49e849ef1d68a50a461215dbb6008563d66d80105340420f86b6ae62e2fe1eab09ab5c19fb10e7a080f99dcf3c185a9b94e0d6b09735ef2afceef
-  data.tar.gz: 62bbf5cae65347c3040dda3271ac711e5ff8e5aac2e56bee3b04df02b55edc1f1d036c04739b6a39639a25166f9fc74838e2b96a2f78ad7f7a83cdfd69d12ee0
+  metadata.gz: 0b770ca63c32c5476df31441d6c8571f20abe7c2234daf003609c3efc1ffb287cfdb659eb2448eea18f24791986e2c12b901a24dcf612a9aeacbf9fd87906f44
+  data.tar.gz: 1778b3fc82b77b5decba13a5fedc779829d50a70800126571646932af0ce2f0954309178cca71d0a3a1a69eb9b0c9714d132a1387531141fe8684b9b2808ee75

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 ## Version 0
+### Version 0.5.0
+* New Administration module for administrative methods.
+* New block and unblock methods, for (un)blocking users.
+* Refactor token stuff. It still doesn't work exactly how I'd like yet, but it's better than it was before. Ideally I'd like to have it get the login-specific tokens on login and set them to some well-named instance variables. Then clear those on logout.
+* Single-line each `do end` loops have been converted into `{...}` style loops.
+* New delete method for deleting pages.
+* New move method for moving pages.
+
 ### Version 0.4.1
+* params[:format] is now automatically set to 'json', so it no longer needs to be defined in each method.
+* Fixed a lot of styling issues thanks to Rubocop.
 * check_login and check_create now use case/when statements instead of elsifs.
 * check_create no longer returns anything.
 * Update minimum Ruby version to 2.1, for refinements.

data/lib/mediawiki/administration.rb

@@ -0,0 +1,54 @@
+module MediaWiki
+  module Administration
+    # Blocks the user.
+    # @param user [String] The user to block.
+    # @param expiry [String] The expiry timestamp using a relative expiry time.
+    # @param reason [String] The reason to show in the block log.
+    # @param nocreate [Boolean] Whether to allow them to create an account.
+    # @return [String/Int] The error code, or the block ID.
+    def block(user, expiry = '2 weeks', reason = nil, nocreate = true)
+      params = {
+        action: 'block',
+        user: user,
+        expiry: expiry
+      }
+
+      token = get_token('block')
+      params[:reason] = reason unless reason.nil?
+      params[:nocreate] = '1' if nocreate == true
+      params[:token] = token
+
+      response = post(params)
+      puts response
+
+      if !response['error'].nil?
+        return response['error']['code']
+      else
+        return response['id'].to_i
+      end
+    end
+
+    # Unblocks the user.
+    # @param user [String] The user to unblock.
+    # @param reason [String] The reason to show in the block log.
+    # @return [String/Int] The error code, or the block ID.
+    def unblock(user, reason = nil)
+      params = {
+        action: 'unblock',
+        user: user
+      }
+      token = get_token('unblock')
+      params[:reason] = reason unless reason.nil?
+      params[:token] = token
+
+      response = post(params)
+      puts response
+
+      if !response['error'].nil?
+        return response['error']['code']
+      else
+        return response['id'].to_i
+      end
+    end
+  end
+end

data/lib/mediawiki/auth.rb

@@ -2,85 +2,88 @@ require_relative 'exceptions'
 
 module MediaWiki
   module Auth
-
-    # Checks the login result for errors. Returns true if it is successful, else false with an error raised.
+    # Checks the login result for errors. Returns true if it is successful,
+    #   else false with an error raised.
     # @param result [String] The parsed version of the result.
-    # @param secondtry [Boolean] Whether this login is the first or second try. False for first, true for second.
+    # @param secondtry [Boolean] Whether this login is the first or second try.
+    #   False for first, true for second.
     # @return [Boolean] true if successful, else false.
     def check_login(result, secondtry)
       case result
-      when "Success"
+      when 'Success'
         @logged_in = true
         return true
-      when "NeedToken"
+      when 'NeedToken'
         if secondtry == true
-          raise MediaWiki::Butt::NeedTokenMoreThanOnceError
+          fail MediaWiki::Butt::NeedTokenMoreThanOnceError
           return false
         end
-      when "NoName"
-        raise MediaWiki::Butt::NoNameError
+      when 'NoName'
+        fail MediaWiki::Butt::NoNameError
         return false
-      when "Illegal"
-        raise MediaWiki::Butt::IllegalUsernameError
+      when 'Illegal'
+        fail MediaWiki::Butt::IllegalUsernameError
         return false
-      when "NotExists"
-        raise MediaWiki::Butt::UsernameNotExistsError
+      when 'NotExists'
+        fail MediaWiki::Butt::UsernameNotExistsError
         return false
-      when "EmptyPass"
-        raise MediaWiki::Butt::EmptyPassError
+      when 'EmptyPass'
+        fail MediaWiki::Butt::EmptyPassError
         return false
-      when "WrongPass"
-        raise MediaWiki::Butt::WrongPassError
+      when 'WrongPass'
+        fail MediaWiki::Butt::WrongPassError
         return false
-      when "WrongPluginPass"
-        raise MediaWiki::Butt::WrongPluginPassError
+      when 'WrongPluginPass'
+        fail MediaWiki::Butt::WrongPluginPassError
         return false
-      when "CreateBlocked"
-        raise MediaWiki::Butt::CreateBlockedError
+      when 'CreateBlocked'
+        fail MediaWiki::Butt::CreateBlockedError
         return false
-      when "Throttled"
-        raise MediaWiki::Butt::ThrottledError
+      when 'Throttled'
+        fail MediaWiki::Butt::ThrottledError
         return false
-      when "Blocked"
-        raise MediaWiki::Butt::BlockedError
+      when 'Blocked'
+        fail MediaWiki::Butt::BlockedError
         return false
       end
     end
 
-    # Checks the account creation result's error and raises the corresponding error.
-    # @param error [String] The parsed error "code" string
+    # Checks the account creation result's error and raises the corresponding
+    #   exception.
+    # @param error [String] The parsed error code string
     def check_create(error)
       case error
-      when "noname"
-        raise MediaWiki::Butt::NoNameError
-      when "userexists"
-        raise MediaWiki::Butt::UserExistsError
-      when "password-name-match"
-        raise MediaWiki::Butt::UserPassMatchError
-      when "password-login-forbidden"
-        raise MediaWiki::Butt::PasswordLoginForbiddenError
-      when "noemailtitle"
-        raise MediaWiki::Butt::NoEmailTitleError
-      when "invalidemailaddress"
-        raise MediaWiki::Butt::InvalidEmailAddressError
-      when "passwordtooshort"
-        raise MediaWiki::Butt::PasswordTooShortError
-      when "noemail"
-        raise MediaWiki::Butt::NoEmailError
-      when "acct_creation_throttle_hit"
-        raise MediaWiki::Butt::ThrottledError
-      when "aborted"
-        raise MediaWiki::Butt::AbortedError
-      when "blocked"
-        raise MediaWiki::Butt::BlockedError
-      when "permdenied-createaccount"
-        raise MediaWiki::Butt::PermDeniedError
-      when "createaccount-hook-aborted"
-        raise MediaWiki::Butt::HookAbortedError
+      when 'noname'
+        fail MediaWiki::Butt::NoNameError
+      when 'userexists'
+        fail MediaWiki::Butt::UserExistsError
+      when 'password-name-match'
+        fail MediaWiki::Butt::UserPassMatchError
+      when 'password-login-forbidden'
+        fail MediaWiki::Butt::PasswordLoginForbiddenError
+      when 'noemailtitle'
+        fail MediaWiki::Butt::NoEmailTitleError
+      when 'invalidemailaddress'
+        fail MediaWiki::Butt::InvalidEmailAddressError
+      when 'passwordtooshort'
+        fail MediaWiki::Butt::PasswordTooShortError
+      when 'noemail'
+        fail MediaWiki::Butt::NoEmailError
+      when 'acct_creation_throttle_hit'
+        fail MediaWiki::Butt::ThrottledError
+      when 'aborted'
+        fail MediaWiki::Butt::AbortedError
+      when 'blocked'
+        fail MediaWiki::Butt::BlockedError
+      when 'permdenied-createaccount'
+        fail MediaWiki::Butt::PermDeniedError
+      when 'createaccount-hook-aborted'
+        fail MediaWiki::Butt::HookAbortedError
       end
     end
 
-    # Logs the user into the wiki. This is generally required for editing and getting restricted data. Will return the result of #check_login
+    # Logs the user into the wiki. This is generally required for editing and
+    #   getting restricted data. Will return the result of #check_login
     # @param username [String] The username
     # @param password [String] The password
     # @return [Boolean] True if the login was successful, false if not.
@@ -88,39 +91,39 @@ module MediaWiki
       params = {
         action: 'login',
         lgname: username,
-        lgpassword: password,
-        format: 'json'
+        lgpassword: password
       }
 
       result = post(params)
-      if check_login(result["login"]["result"], false)
+      if check_login(result['login']['result'], false)
         @logged_in = true
         @tokens.clear
         true
-      elsif result["login"]["result"] == "NeedToken" && result["login"]["token"] != nil
-        token = result["login"]["token"]
+      elsif result['login']['result'] == 'NeedToken' &&
+            !result['login']['token'].nil?
+        token = result['login']['token']
         token_params = {
           action: 'login',
           lgname: username,
           lgpassword: password,
-          format: 'json',
           lgtoken: token
         }
 
-        #Consider refactor the @cookie initialization.
-        @cookie = "#{result["login"]["cookieprefix"]}Session=#{result["login"]["sessionid"]}"
-        result = post(token_params, true, { 'Set-Cookie' => @cookie })
-        check_login(result["login"]["result"], true)
+        # Consider refactor the @cookie initialization.
+        @cookie = "#{result['login']['cookieprefix']}" \
+                  "Session=#{result['login']['sessionid']}"
+        result = post(token_params, true, 'Set-Cookie' => @cookie)
+        check_login(result['login']['result'], true)
       end
     end
 
     # Logs the current user out.
-    # @return [Boolean] True if it was able to log anyone out, false if not (basically, if someone was logged in, it returns true).
+    # @return [Boolean] True if it was able to log anyone out, false if not
+    #   (basically, if someone was logged in, it returns true).
     def logout
       if @logged_in
         params = {
-          action: 'logout',
-          format: 'json'
+          action: 'logout'
         }
 
         post(params)
@@ -135,8 +138,11 @@ module MediaWiki
     # Creates an account using the standard procedure.
     # @param username [String] The desired username.
     # @param password [String] The desired password.
-    # @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 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.
     # @return [Boolean] True if successful, false if not.
     def create_account(username, password, language = 'en', *reason)
       params = {
@@ -148,28 +154,28 @@ module MediaWiki
       }
 
       result = post(params)
-      if result["error"] != nil
-        check_create(result["error"]["code"])
+      unless result['error'].nil?
+        check_create(result['error']['code'])
         return false
       end
 
-      if result["createaccount"]["result"] == "Success"
+      if result['createaccount']['result'] == 'Success'
         @tokens.clear
         return true
-      elsif result["createaccount"]["result"] == "NeedToken"
+      elsif result['createaccount']['result'] == 'NeedToken'
         params = {
           name: username,
           password: password,
           reason: reason,
           language: language,
-          token: result["createaccount"]["token"]
+          token: result['createaccount']['token']
         }
 
         result = post(params, true, true)
-        if result["error"] != nil
-          check_create(result["error"]["code"])
+        if !result['error'].nil?
+          check_create(result['error']['code'])
           return false
-        elsif result["createaccount"]["result"] == "Success"
+        elsif result['createaccount']['result'] == 'Success'
           return true
         else
           return false
@@ -180,8 +186,11 @@ module MediaWiki
     # Creates an account using the random password sent by email procedure.
     # @param username [String] The desired username
     # @param email [String] The desired email address
-    # @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 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.
     # @return [Boolean] True if successful, false if not.
     def create_account_email(username, email, language = 'en', *reason)
       params = {
@@ -194,30 +203,29 @@ module MediaWiki
       }
 
       result = post(params)
-      result = post(params)
-      if result["error"] != nil
-        check_create(result["error"]["code"])
+      unless result['error'].nil?
+        check_create(result['error']['code'])
         return false
       end
 
-      if result["createaccount"]["result"] == "Success"
+      if result['createaccount']['result'] == 'Success'
         @tokens.clear
         return true
-      elsif result["createaccount"]["result"] == "NeedToken"
+      elsif result['createaccount']['result'] == 'NeedToken'
         params = {
           name: username,
           email: email,
           mailpassword: 'value',
           reason: reason,
           language: language,
-          token: result["createaccount"]["token"]
+          token: result['createaccount']['token']
         }
 
         result = post(params, true, true)
-        if result["error"] != nil
-          check_create(result["error"]["code"])
+        if !result['error'].nil?
+          check_create(result['error']['code'])
           return false
-        elsif result["createaccount"]["result"] == "Success"
+        elsif result['createaccount']['result'] == 'Success'
           return true
         else
           return false

data/lib/mediawiki/butt.rb

@@ -2,6 +2,7 @@ require_relative 'auth'
 require_relative 'query'
 require_relative 'constants'
 require_relative 'edit'
+require_relative 'administration'
 require 'httpclient'
 require 'json'
 
@@ -13,10 +14,12 @@ module MediaWiki
     include MediaWiki::Query::Lists
     include MediaWiki::Constants::Namespaces
     include MediaWiki::Edit
+    include MediaWiki::Administration
 
-    # Creates a new instance of MediaWiki::Butt. To work with any MediaWiki::Butt methods, you must first create an instance of it.
-    #
-    # @param url [String] The FULL wiki URL. api.php can be omitted, but it will make harsh assumptions about your wiki configuration.
+    # Creates a new instance of MediaWiki::Butt. To work with any
+    #   MediaWiki::Butt methods, you must first create an instance of it.
+    # @param url [String] The FULL wiki URL. api.php can be omitted, but it
+    #   will make harsh assumptions about your wiki configuration.
     # @param use_ssl [Boolean] Whether or not to use SSL. Will default to true.
     # @return [MediaWiki::Butt] new instance of MediaWiki::Butt
     def initialize(url, use_ssl = true)
@@ -29,18 +32,32 @@ module MediaWiki
       @tokens = {}
     end
 
-    # Performs a generic HTTP POST action and provides the response. This method generally should not be used by the user, unless there is not a method provided by the Butt developers 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. Will default to true.
+    # Performs a generic HTTP POST action and provides the response. This
+    #   method generally should not be used by the user, unless there is not a
+    #   method provided by the Butt developers 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. Will default to true.
     # @param header [Hash] The header hash. Optional.
-    # @return [JSON/HTTPMessage] Parsed JSON if autoparse is true, or raw response if not.
+    # @return [JSON/HTTPMessage] Parsed JSON if autoparse is true, or raw
+    #   response if not.
     def post(params, autoparse = true, header = nil)
-      # Note that defining the header argument as a splat argument (*header) causes errors in HTTPClient.
-      # We must use header.nil? rather than a splat argument and defined? header due to this error.
-      # For those interested, the error is: undefined method `downcase' for {"Set-Cookie"=>"cookie"}:Hash (NoMethodError)
-      # This is obvisouly an error in HTTPClient, but we must work around it until there is a fix in the gem.
-      res = header.nil? ? @client.post(@uri, params) : @client.post(@uri, params, header)
+      # Note that defining the header argument as a splat argument (*header)
+      #   causes errors in HTTPClient. We must use header.nil? rather than a
+      #   splat argument and defined? header due to this error. For those
+      #   interested, the error is:
+      #     undefined method `downcase' for {"Set-Cookie"=>"cookie"}:Hash
+      #   This is obvisouly an error in HTTPClient, but we must work around it
+      #   until there is a fix in the gem.
+
+      params[:format] = 'json'
+
+      if header.nil?
+        res = @client.post(@uri, params)
+      else
+        res = @client.post(@uri, params, header)
+      end
 
       if autoparse
         return JSON.parse(res.body)
@@ -49,14 +66,18 @@ module MediaWiki
       end
     end
 
-    # Returns true if the currently logged in user is in the "bot" group. This can be helpful to some developers, but it is mostly for use internally in MediaWiki::Butt.
-    # @param username [String] The username to check. Optional. Defaults to the currently logged in user if nil.
-    # @return [Boolean] true if logged in as a bot, false if not logged in or logged in as a non-bot
-    def is_user_bot?(*username)
+    # Returns true if the currently logged in user is in the "bot" group.
+    #   This can be helpful to some developers, but it is mostly for use
+    #   internally in MediaWiki::Butt.
+    # @param username [String] The username to check. Optional. Defaults to
+    #   the currently logged in user if nil.
+    # @return [Boolean] true if logged in as a bot, false if not logged in or
+    #   logged in as a non-bot
+    def user_bot?(*username)
       groups = defined? username ? get_usergroups(username) : get_usergroups
 
       if groups != false
-        return groups.include?("bot")
+        return groups.include?('bot')
       else
         return false
       end