mediawiki-butt 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc43e07782836b5480c6da51986099f1109c1a7d
-  data.tar.gz: 5e8e4ac85f0d95c6e11a522b8a00546b3dbb429a
+  metadata.gz: e97e8c9e254cb0248cb26d98b459c20358559351
+  data.tar.gz: 37596137417cd8e6ddadf842a867ee3034f3c898
 SHA512:
-  metadata.gz: 0b770ca63c32c5476df31441d6c8571f20abe7c2234daf003609c3efc1ffb287cfdb659eb2448eea18f24791986e2c12b901a24dcf612a9aeacbf9fd87906f44
-  data.tar.gz: 1778b3fc82b77b5decba13a5fedc779829d50a70800126571646932af0ce2f0954309178cca71d0a3a1a69eb9b0c9714d132a1387531141fe8684b9b2808ee75
+  metadata.gz: 9478f34c90244e78b979521da4f3867a92f9c77cdbe7f326aa92323f1739467d9ed87adb5c722a3e64f6d583eb975365de02fd9de501be6ebca4896deae5e264
+  data.tar.gz: 5056fa282df5d7581c4a82bd77572abb2d69d49c016960f94dc551cecd1f8d0d18abae5ccacdcaa5529f83ede9880b13a1b107404692352092f611807bc62dc1

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 ## Version 0
+### Version 0.6.0
+* Slightly expanded Gem description.
+* Finished all Meta modules and their methods, except for the allmessages meta query. [#6](https://github.com/ftb-gamepedia/mediawiki-butt-ruby/issues/6)
+  * New get_variables method.
+  * New get_function_hooks method.
+  * New get_extension_tags method.
+  * New get_skins method.
+  * New get_restriction_levels method.
+  * New get_restriction_types method.
+  * New get_restrictions_data method for the above methods.
+  * New get_allowed_file_extensions method, and refactored #upload to only allow files with those extensions.
+  * New get_all_usergroups method.
+  * New get_magic_words method.
+  * New get_special_page_aliases method.
+  * New get_namespace_aliases method.
+  * New get_namespaces method.
+  * New get_filerepo_favicons method.
+  * New get_filerepo_thumburls method.
+  * New get_nonlocal_filerepos method.
+  * New get_local_filerepos method.
+  * New get_filerepo_urls method.
+  * New get_filerepo_rooturls method.
+  * Refactor get_filerepo_names to use new get_filerepoinfo method.
+  * New get_filerepoinfo method, in a similar style to get_userlists.
+  * New get_current_user_options for getting a hash containing all of the currently logged in user's preferences.
+  * New get_email_address method for getting the currently logged in user's email address.
+  * New get_realname method for getting the currently logged in user's real name.
+  * New get_changeable_groups method for getting the currently logged in user's groups that they can change (add/remove people from)
+  * New current_user_hasmsg? method for checking if the user has any unread messages.
+  * check_login no longer returns false, ever, because any code after a fail is unreachable.
+  * prop parameter in get_current_user_meta is now optional, for get_current_user_name.
+  * New get_current_user_name method, for something fairly obvious.
+  * New get_siteinfo method, in a similar style to get_userlists.
+  * New get_statistics method, for getting a hash of the wiki's statistics.
+  * New get_general method, for getting hash of the 'general' wiki information.
+  * New get_extensions method, for getting an array of all extension names installed.
+  * New get_languages method, for getting a hash of all the languages, formatted as code => name.
+* User-Agent header is now set for each post. It defaults to 'NotLoggedIn/MediaWiki::Butt', or "#{name}/MediaWiki::Butt" if logged in. This might cause some slight performance issues ([#5](https://github.com/FTB-Gamepedia/MediaWiki-Butt-Ruby/issues/5))
+
+
 ### Version 0.5.0
 * New Administration module for administrative methods.
 * New block and unblock methods, for (un)blocking users.

data/lib/mediawiki/auth.rb

@@ -7,44 +7,32 @@ module MediaWiki
     # @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.
-    # @return [Boolean] true if successful, else false.
+    # @return [Boolean] true if successful. Does not return anything if not.
     def check_login(result, secondtry)
       case result
       when 'Success'
         @logged_in = true
         return true
       when 'NeedToken'
-        if secondtry == true
-          fail MediaWiki::Butt::NeedTokenMoreThanOnceError
-          return false
-        end
+        fail MediaWiki::Butt::NeedTokenMoreThanOnceError if secondtry == true
       when 'NoName'
         fail MediaWiki::Butt::NoNameError
-        return false
       when 'Illegal'
         fail MediaWiki::Butt::IllegalUsernameError
-        return false
       when 'NotExists'
         fail MediaWiki::Butt::UsernameNotExistsError
-        return false
       when 'EmptyPass'
         fail MediaWiki::Butt::EmptyPassError
-        return false
       when 'WrongPass'
         fail MediaWiki::Butt::WrongPassError
-        return false
       when 'WrongPluginPass'
         fail MediaWiki::Butt::WrongPluginPassError
-        return false
       when 'CreateBlocked'
         fail MediaWiki::Butt::CreateBlockedError
-        return false
       when 'Throttled'
         fail MediaWiki::Butt::ThrottledError
-        return false
       when 'Blocked'
         fail MediaWiki::Butt::BlockedError
-        return false
       end
     end
 
@@ -113,7 +101,7 @@ module MediaWiki
         @cookie = "#{result['login']['cookieprefix']}" \
                   "Session=#{result['login']['sessionid']}"
         result = post(token_params, true, 'Set-Cookie' => @cookie)
-        check_login(result['login']['result'], true)
+        @name = username if check_login(result['login']['result'], true)
       end
     end
 

data/lib/mediawiki/butt.rb

@@ -9,7 +9,9 @@ require 'json'
 module MediaWiki
   class Butt
     include MediaWiki::Auth
-    include MediaWiki::Query::Meta
+    include MediaWiki::Query::Meta::SiteInfo
+    include MediaWiki::Query::Meta::FileRepoInfo
+    include MediaWiki::Query::Meta::UserInfo
     include MediaWiki::Query::Properties
     include MediaWiki::Query::Lists
     include MediaWiki::Constants::Namespaces
@@ -52,13 +54,16 @@ module MediaWiki
       #   until there is a fix in the gem.
 
       params[:format] = 'json'
+      header = {} if header.nil?
 
-      if header.nil?
-        res = @client.post(@uri, params)
+      if @logged_in == false
+        header['User-Agent'] = 'NotLoggedIn/MediaWiki::Butt'
       else
-        res = @client.post(@uri, params, header)
+        header['User-Agent'] = "#{@name}/MediaWiki::Butt"
       end
 
+      res = @client.post(@uri, params, header)
+
       if autoparse
         return JSON.parse(res.body)
       else

data/lib/mediawiki/edit.rb

@@ -73,7 +73,7 @@ module MediaWiki
     #   through regex. Optional. If ommitted, it will be everything after
     #   the last slash in the URL.
     # @return [Boolean/String] true if the upload was successful, else the
-    #   warning's key.
+    #   warning's key. Returns false if the file extension is not valid.
     def upload(url, *filename)
       params = {
         action: 'upload',
@@ -87,15 +87,22 @@ module MediaWiki
         filename = url.split('/')[-1]
       end
 
-      token = get_token('edit', filename)
-      params[:filename] = filename
-      params[:token] = token
+      ext = filename.split('.')[-1]
+      allowed_extensions = get_allowed_file_extensions
+      if allowed_extensions.include? ext
 
-      response = post(params)
-      if response['upload']['result'] == 'Success'
-        return true
-      elsif response['upload']['result'] == 'Warning'
-        return response['upload']['warnings'].keys[0]
+        token = get_token('edit', filename)
+        params[:filename] = filename
+        params[:token] = token
+
+        response = post(params)
+        if response['upload']['result'] == 'Success'
+          return true
+        elsif response['upload']['result'] == 'Warning'
+          return response['upload']['warnings'].keys[0]
+        end
+      else
+        return false
       end
     end
 

data/lib/mediawiki/query.rb

@@ -3,41 +3,389 @@ require_relative 'constants'
 
 module MediaWiki
   module Query
-    # TODO: Actually decide on a good way to deal with meta information queries.
-    #   The metainformation could probably be handled in a much less verbose
-    #   way. Perhaps we should get hashes instead?
     module Meta
-      # Returns an array of all the wiki's file repository names.
-      # @return [Array] All wiki's file repository names.
-      def get_filerepo_names
-        params = {
-          action: 'query',
-          meta: 'filerepoinfo',
-          friprop: 'name'
-        }
+      module SiteInfo
+        # Gets wiki information. This method should rarely be used by
+        #   normal users.
+        # @param prop [String] The siprop parameter.
+        # @return [Response] Parsed full response.
+        def get_siteinfo(prop)
+          params = {
+            action: 'query',
+            meta: 'siteinfo',
+            siprop: prop
+          }
 
-        result = post(params)
-        ret = []
-        result['query']['repos'].each { |repo| ret.push(repo['name']) }
+          post(params)
+        end
 
-        ret
+        # Gets the statistics for the wiki.
+        # @return [Hash] The statistics and their according values.
+        def get_statistics
+          response = get_siteinfo('statistics')
+          ret = {}
+          response['query']['statistics'].each { |k, v| ret[k] = v }
+          ret
+        end
+
+        # Gets the general information for the wiki.
+        # @return [Hash] The general info and their according values.
+        def get_general
+          response = get_siteinfo('general')
+          ret = {}
+          response['query']['general'].each { |k, v| ret[k] = v }
+          ret
+        end
+
+        # Gets all extensions installed on the wiki.
+        # @return [Array] All extension names.
+        def get_extensions
+          response = get_siteinfo('extensions')
+          ret = []
+          response['query']['extensions'].each { |e| ret.push(e['name']) }
+          ret
+        end
+
+        # Gets all languages and their codes.
+        # @return [Hash] All languages. Hash key value pair formatted as
+        #   code => name.
+        def get_languages
+          response = get_siteinfo('languages')
+          ret = {}
+          response['query']['languages'].each { |l| ret[l['code']] = l['*'] }
+          ret
+        end
+
+        # Gets all namespaces on the wiki and their IDs. Different from the
+        #   Namespaces module.
+        # @return [Hash] All namespaces, formatted as ID => Name.
+        def get_namespaces
+          response = get_siteinfo('namespaces')
+          ret = {}
+          response['query']['namespaces'].each do |id, hash|
+            idid = response['query']['namespaces'][id]['id']
+            name = response['query']['namespaces'][id]['*']
+            ret[idid] = name
+          end
+          ret
+        end
+
+        # Gets all namespace aliases and their IDs.
+        # @return [Hash] All aliases, formatted as ID => Alias.
+        def get_namespace_aliases
+          response = get_siteinfo('namespacealiases')
+          ret = {}
+          response['query']['namespacealiases'].each do |a|
+            ret[i['id']] = i['*']
+          end
+          ret
+        end
+
+        # Gets all special page aliases.
+        # @return [Hash] All aliases, formatted as RealName => Alias.
+        def get_special_page_aliases
+          response = get_siteinfo('specialpagealiases')
+          ret = {}
+          response['query']['specialpagealiases'].each do |a|
+            ret[i['realname']] = i['aliases']
+          end
+          ret
+        end
+
+        # Gets all magic words and their aliases.
+        # @return [Hash] All magic words, formatted as Name => Alias.
+        def get_magic_words
+          response = get_siteinfo('magicwords')
+          ret = {}
+          response['query']['magicwords'].each do |w|
+            ret[w['name']] = w['aliases']
+          end
+          ret
+        end
+
+        # Gets all user groups total.
+        # @return [Hash] All groups, formatted as Name => [Rights].
+        def get_all_usergroups
+          response = get_siteinfo('usergroups')
+          ret = {}
+          response['query']['usergroups'].each do |g|
+            ret[g['name']] = g['rights']
+          end
+          ret
+        end
+
+        # Gets all file extensions that are allowed to be uploaded.
+        # @return [Array] All file extensions.
+        def get_allowed_file_extensions
+          response = get_siteinfo('fileextensions')
+          ret = []
+          response['query']['fileextensions'].each do |e|
+            ret.push(e['ext'])
+          end
+          ret
+        end
+
+        # Gets the response for the restrictions siteinfo API. Not really for
+        #   use by users, mostly for the other two restriction methods.
+        def get_restrictions_data
+          response = get_siteinfo('restrictions')
+          return response['query']['restrictions']
+        end
+
+        # Gets all restriction/protection types.
+        # @return [Array] All protection types.
+        def get_restriction_types
+          restrictions = get_restrictions_data
+          ret = []
+          restrictions['types'].each { |t| ret.push(t) }
+          ret
+        end
+
+        # Gets all restriction/protection levels.
+        # @return [Array] All protection levels.
+        def get_restriction_levels
+          restrictions = get_restrictions_data
+          ret = []
+          restrictions['levels'].each { |l| ret.push(l) }
+          ret
+        end
+
+        # Gets all skins and their codes.
+        # @return [Hash] All skins, formatted as Code => Name
+        def get_skins
+          response = get_siteinfo('skins')
+          ret = {}
+          response['query']['skins'].each do |s|
+            ret[s['code']] = s['*']
+          end
+          ret
+        end
+
+        # Gets all HTML tags added by installed extensions.
+        # @return [Array] All extension tags.
+        def get_extension_tags
+          response = get_siteinfo('extensiontags')
+          ret = []
+          response['query']['extensiontags'].each do |t|
+            ret.push(t)
+          end
+          ret
+        end
+
+        # Gets all function hooks.
+        # @return [Array] All function hooks.
+        def get_function_hooks
+          response = get_siteinfo('functionhooks')
+          ret = []
+          response['query']['functionhooks'].each do |h|
+            ret.push(h)
+          end
+          ret
+        end
+
+        # Gets all variables that are usable on the wiki, such as NUMBEROFPAGES.
+        # @return [Array] All variable string values.
+        def get_variables
+          response = get_siteinfo('variables')
+          ret = []
+          response['query']['variables'].each do |v|
+            ret.push(v)
+          end
+          ret
+        end
       end
 
-      # Gets meta information for the currently logged in user.
-      # @param prop [String] The uiprop to get.
-      # @return [Response/Boolean] Either a full, parsed response, or false if
-      #   not logged in.
-      def get_current_user_meta(prop)
-        if @logged_in
+      module FileRepoInfo
+        # Gets FileRepoInfo for the property.
+        # @param prop [String] The friprop to get.
+        # @return [Response] The full parsed response.
+        def get_filerepoinfo(prop)
           params = {
             action: 'query',
-            meta: 'userinfo',
-            uiprop: prop
+            meta: 'filerepoinfo',
+            friprop: prop
           }
 
-          return post(params)
-        else
-          return false
+          post(params)
+        end
+
+        # Returns an array of all the wiki's file repository names.
+        # @return [Array] All wiki's file repository names.
+        def get_filerepo_names
+          response = get_filerepoinfo('name|displayname')
+          ret = {}
+          response['query']['repos'].each { |n, dn| ret[n] = dn }
+          ret
+        end
+
+        # Gets the root URLs for the file repositories.
+        # @return [Hash] A hash containing keys of the names, and values of the
+        #   root URLs.
+        def get_filerepo_rooturls
+          response = get_filerepoinfo('name|rootUrl')
+          ret = {}
+          response['query']['repos'].each { |n, r| ret[n] = r }
+          ret
+        end
+
+        # Gets an array containing all local repositories.
+        # @return [Array] All repositories that are marked as local.
+        def get_local_filerepos
+          response = get_filerepoinfo('name|local')
+          ret = []
+          response['query']['repos'].each do |n, l|
+            ret.push(n) if l == 'true'
+          end
+
+          ret
+        end
+
+        # Gets an array containing all repositories that aren't local.
+        # @return [Array] All repositories that are not marked as local.
+        def get_nonlocal_filerepos
+          response = get_filerepoinfo('name|local')
+          ret = []
+          response['query']['repos'].each do |n, l|
+            ret.push(n) if l == 'false'
+          end
+
+          ret
+        end
+
+        # Gets the repository names and their according URLs.
+        # @return [Hash] Names as the keys, with their URLs as the values.
+        def get_filerepo_urls
+          response = get_filerepoinfo('name|url')
+          ret = {}
+          response['query']['repos'].each { |n, u| ret[n] = u }
+          ret
+        end
+
+        # Gets the repository names and their accoring thumbnail URLs.
+        # @return [Hash] Names as the keys, with their URLs as the values.
+        def get_filerepo_thumburls
+          response = get_filerepoinfo('name|thumbUrl')
+          ret = {}
+          response['query']['repos'].each { |n, u| ret[n] = u }
+          ret
+        end
+
+        # Gets the repository names and their according favicon URLs.
+        # @return [Hash] Names as the keys, with their favicons as the values.
+        def get_filerepo_favicons
+          response = get_filerepoinfo('name|favicon')
+          ret = {}
+          response['query']['repos'].each { |n, f| ret[n] = f }
+          ret
+        end
+      end
+
+      module UserInfo
+        # Gets meta information for the currently logged in user.
+        # @param prop [String] The uiprop to get. Optional.
+        # @return [Response/Boolean] Either a full, parsed response, or false if
+        #   not logged in.
+        def get_current_user_meta(prop = nil)
+          if @logged_in
+            params = {
+              action: 'query',
+              meta: 'userinfo',
+              uiprop: prop
+            }
+
+            post(params)
+          else
+            return false
+          end
+        end
+
+        # Gets the current user's username.
+        # @return [String/Boolean] Returns the username, or false.
+        def get_current_user_name
+          if !@name.nil?
+            return @name
+          else
+            name = get_current_user_meta
+            if name != false
+              name = name['query']['userinfo']['name']
+            end
+
+            name
+          end
+        end
+
+        # Returns whether or not the currently logged in user has any unread
+        #   messages on their talk page.
+        # @return [Boolean] True if they have unreads, else false.
+        def current_user_hasmsg?
+          response = get_current_user_meta('hasmsg')
+          if response != false
+            if !response['query']['userinfo']['messages'] == ''
+              return false
+            else
+              return true
+            end
+          else
+            return false
+          end
+        end
+
+        # Gets a hash-of-arrays containing all the groups the user can add and
+        #   remove people from.
+        # @return [Boolean/Hash] False if get_current_user_meta is false, else
+        #   a hash containing arrays of all the groups the user can add/remove
+        #   people from.
+        def get_changeable_groups
+          response = get_current_user_meta('changeablegroups')
+          if response != false
+            ret = {}
+            add = []
+            remove = []
+            addself = []
+            removeself = []
+            changeablegroups = response['query']['userinfo']['changeablegroups']
+            puts changeablegroups
+            changeablegroups['add'].each { |g| puts g; add.push(g) }
+            changeablegroups['remove'].each { |g| puts g; remove.push(g) }
+            changeablegroups['add-self'].each { |g| puts g; addself.push(g) }
+            changeablegroups['remove-self'].each { |g| puts g; removeself.push(g) }
+            ret['add'] = add
+            ret['remove'] = remove
+            ret['addself'] = addself
+            ret['removeself'] = removeself
+            return ret
+          else
+            return false
+          end
+        end
+
+        # Gets the currently logged in user's real name.
+        # @return [String/Nil] Nil if they don't have a real name set, or their
+        #   real name.
+        def get_realname
+          response = get_current_user_meta('realname')
+          if response['query']['userinfo']['realname'] == ''
+            return nil
+          else
+            return response['query']['userinfo']['realname']
+          end
+        end
+
+        # Gets the currently logged in user's email address.
+        # @return [String/Nil] Nil if their email is not set, or their email.
+        def get_email_address
+          response = get_current_user_meta('email')
+          if response['query']['userinfo']['email'] == ''
+            return nil
+          else
+            return response['query']['userinfo']['email']
+          end
+        end
+
+        def get_current_user_options
+          response = get_current_user_meta('options')
+          ret = {}
+          response['query']['userinfo']['options'].each { |k, v| ret[k] = v }
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Eli Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2015-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-utility
@@ -40,7 +40,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: "    MediaWiki::Butt is a Ruby Gem that provides a fully-featured MediaWiki
-  API     interface.\n"
+  API     interface. It includes methods for changing wiki content, authentication,
+  \    and queries.\n\n"
 email: elifosterwy@gmail.com
 executables: []
 extensions: []