mediawiki-butt 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01b96931127f32d0a59b62876f5de8c80657cbc3
-  data.tar.gz: 3ef158346ca14fe0073eca30714e48c87b44684d
+  metadata.gz: 0e649c5d1963a0f3e300d04d7953735b9207c66c
+  data.tar.gz: 6284a9046b3f8575b6c28e84695e454beb70263a
 SHA512:
-  metadata.gz: 47a2a279b141b771ebef8a84702d7f42422ee0baa789e0ef2fd6f74e5b616c2861f9d2509df4fb5565145a1876334095965988fdaebdf3b59c0749c82f3bf862
-  data.tar.gz: 220e119d425714af14b50df518e02f6ff9bcacaccf799cb87c0d0ac52322fddf90fbd5a74bf580d44f97d5a7425307cb6bf6af3c600f47a10410e6f8ff25a5df
+  metadata.gz: a6b021df89173e0d44ed1217dc8ca0cbf4e5b08a55b9e45844c54013dcada4f7b7187588cb9a79c0f4329021879b3218e2dffab8b3c8fafae72c95b3c3f0dafa
+  data.tar.gz: c80b130f381f088cd43215d592a622f1c1617b868fe03d7e9f9af093045c716a4baeab574be519a6aab886a677022fb981a6a252ac0a8766c3fb073c87a5bae1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 ## Version 0
+### Version 0.2.0
+* New get_id method to get the pageid from the title.
+* New get_random_pages method to get an array of random articles.
+* New Namespace module full of constants.
+* is_current_user_bot is now called as is_current_user_bot?.
+* New get_edit_token method for obtaining an edit token based on the page title.
+* New edit method and module for editing pages.
+* Fix logout parsing error
+
 ### Version 0.1.1
 * Got rid of pointless array in is_current_user_bot
 * Potentially fixed docs

data/lib/mediawiki/auth.rb

@@ -119,7 +119,7 @@ module MediaWiki
 
         #Consider refactor the @cookie initialization.
         @cookie = "#{result["login"]["cookieprefix"]}Session=#{result["login"]["sessionid"]}"
-        result = post(token_params, true, true)
+        result = post(token_params, true, { 'Set-Cookie' => @cookie })
         return check_login(result["login"]["result"], true)
       end
     end
@@ -129,7 +129,8 @@ module MediaWiki
     def logout
       if @logged_in == true
         params = {
-          action: 'logout'
+          action: 'logout',
+          format: 'json'
         }
 
         post(params)

data/lib/mediawiki/butt.rb

@@ -1,5 +1,7 @@
 require_relative 'auth'
 require_relative 'query'
+require_relative 'constants'
+require_relative 'edit'
 require 'httpclient'
 require 'json'
 
@@ -9,6 +11,8 @@ module MediaWiki
     include MediaWiki::Query::Meta
     include MediaWiki::Query::Properties
     include MediaWiki::Query::Lists
+    include MediaWiki::Constants::Namespaces
+    include MediaWiki::Edit
 
     # Creates a new instance of MediaWiki::Butt. To work with any MediaWiki::Butt methods, you must first create an instance of it.
     #
@@ -33,14 +37,13 @@ module MediaWiki
     #
     # @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 setcookie [Boolean] Whether you want to set the auth cookie. Only used in authentication. Defaults to false.
-    # @return [JSON/Response] Parsed JSON if autoparse is true, or raw response if not.
-    def post(params, autoparse = true, setcookie = false)
-      if setcookie == true
-        header = { 'Set-Cookie' => @cookie }
-        response = @client.post(@uri, params, header)
-      else
+    # @param header [Hash] The header hash. Optional.
+    # @return [JSON/HTTPMessage] Parsed JSON if autoparse is true, or raw response if not.
+    def post(params, autoparse = true, header = nil)
+      if header == nil
         response = @client.post(@uri, params)
+      else
+        response = @client.post(@uri, params, header)
       end
 
       if autoparse == true
@@ -52,24 +55,14 @@ module MediaWiki
 
     # 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.
     # @return [Boolean] true if logged in as a bot, false if not logged in or logged in as a non-bot
-    def is_current_user_bot()
+    def is_current_user_bot?
       if @logged_in == true
-        params = {
-          action: 'query',
-          meta: 'userinfo',
-          uiprop: 'groups',
-          format: 'json'
-        }
-
-        response = post(params)
-        response["query"]["userinfo"]["groups"].each do |g|
-          if g == "bot"
-            return true
-          else
-            next
-          end
+        groups = get_usergroups
+        if groups.include? "bot"
+          return true
+        else
+          return false
         end
-        return false
       else
         return false
       end

data/lib/mediawiki/query.rb

@@ -6,7 +6,7 @@ module MediaWiki
 
       # Returns an array of all the wiki's file repository names.
       # @return [Array] All wiki's file repository names.
-      def get_filerepo_names()
+      def get_filerepo_names
         params = {
           action: 'query',
           meta: 'filerepoinfo',
@@ -15,11 +15,33 @@ module MediaWiki
         }
 
         result = post(params)
-        array = Array.new
+        ret = Array.new
         result["query"]["repos"].each do |repo|
-          array.push(repo["name"])
+          ret.push(repo["name"])
+        end
+        return ret
+      end
+
+      # Gets an array of all the currently logged in user's groups.
+      # @return [Array/Boolean] All of the user's groups, or false if not logged in.
+      def get_usergroups
+        if @logged_in == true
+          params = {
+            action: 'query',
+            meta: 'userinfo',
+            uiprop: 'groups',
+            format: 'json'
+          }
+
+          result = post(params)
+          ret = Array.new
+          result["query"]["userinfo"]["groups"].each do |g|
+            ret.push(g)
+          end
+          return ret
+        else
+          return false
         end
-        return array
       end
     end
 
@@ -48,6 +70,53 @@ module MediaWiki
           return response["query"]["pages"][$revid]["revisions"][0]["*"]
         end
       end
+
+      # Gets the revision ID for the given page.
+      # @param title [String] The page title
+      # @return [Int/nil] the ID or nil
+      def get_id(title)
+        params = {
+          action: 'query',
+          prop: 'revisions',
+          rvprop: 'content',
+          format: 'json',
+          titles: title
+        }
+
+        response = post(params)
+        response["query"]["pages"].each do |revid, data|
+          if revid != "-1"
+            return revid.to_i
+          else
+            return nil
+          end
+        end
+      end
+
+      # Gets the edit token for the given page. This method should rarely be used by normal users.
+      # @param page_name [String] The page title that you are going to be editing.
+      # @return [String] The edit token. If the butt isn't logged in, it returns with '+\\'.
+      def get_edit_token(page_name)
+        if @logged_in == true
+          params = {
+            action: 'query',
+            prop: 'info',
+            intoken: 'edit',
+            format: 'json',
+            titles: page_name
+          }
+
+          response = post(params)
+          response["query"]["pages"].each do |revid, data|
+            $revid = revid
+          end
+
+          # URL encoding is not needed for some reason.
+          return response["query"]["pages"][$revid]["edittoken"]
+        else
+          return "+\\"
+        end
+      end
     end
 
     module Lists
@@ -64,7 +133,7 @@ module MediaWiki
         }
 
         if limit > 500
-          if is_current_user_bot() == true
+          if is_current_user_bot? == true
             if limit > 5000
               params[:bllimit] = 5000
             else
@@ -85,7 +154,7 @@ module MediaWiki
         return ret
       end
 
-      # Returns an array of all pagee titles that belong to a given category.
+      # Returns an array of all page titles that belong to a given category.
       # @param category [String] The category title. It can include "Category:", or not, it doesn't really matter because we will add it if it is missing.
       # @param limit [Int] The maximum number of members to get. Defaults to 500, and cannot be greater than that unless the user is a bot. If the user is a bot, the limit cannot be greater than 5000.
       # @return [Array] All category members until the limit
@@ -104,7 +173,7 @@ module MediaWiki
         end
 
         if limit > 500
-          if is_current_user_bot() == true
+          if is_current_user_bot? == true
             if limit > 5000
               params[:cmlimit] = 5000
             else
@@ -124,6 +193,41 @@ module MediaWiki
         end
         return ret
       end
+
+      # 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). Set to nil for all namespaces.
+      # @return [Array] All members
+      def get_random_pages(number_of_pages = 1, namespace = 0)
+        params = {
+          action: 'query',
+          list: 'random',
+          format: 'json'
+        }
+
+        params[:rnnamespace] = namespace if namespace != nil
+
+        if namespace > 10
+          if is_current_user_bot? == true
+            if limit > 20
+              params[:rnlimit] = 20
+            else
+              params[:rnlimit] = limit
+            end
+          else
+            params[:rnlimit] = 10
+          end
+        else
+          params[:rnlimit] = namespace
+        end
+
+        ret = Array.new
+        responce = post(params)
+        responce["query"]["random"].each do |a|
+          ret.push(a["title"])
+        end
+        return ret
+      end
     end
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Eli Foster
+- Eric Schneider (xbony2)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -72,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Interacting with the MediaWiki API