mediawiki-butt 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39a298105810a6c06ffbc2ffe93a7f2583e47454
-  data.tar.gz: ac4291f2d83dfdf74bdfd7f2364057d558ea6400
+  metadata.gz: bbd268a2d756469fbc632169feaeaa48b2eaabea
+  data.tar.gz: dad624c4add5afefe4a0dd5bcbcd9b09dbc203d5
 SHA512:
-  metadata.gz: b1afc8b4b77984f2b97fd0284f7e01cbc99d437debbd80f7f2fb1ee5dbd9a90e69e679151bac741318efb19a3afa10066b79a36ac86d0399d5ad2e9865adcf10
-  data.tar.gz: 80e4cd4d90dd99006ec742a7fa4cb0aa3c90590c16715893ab18dabd16b5f74f49ba908fece363190ee0416fd92b052541b40aaf59acdde926e5c6bfb54260dc
+  metadata.gz: dc460415bd8589e103c3956c5c24cb4754aef9c0a0395a6b9f5e534a878d68606395797e75f0cb0aa0460eb51fdd72e5fd950209708b316144d478fb2b9afd59
+  data.tar.gz: b7cfec3633270b2374c7e219166e6ce917a8632b7605df9d1af34cb7a7233d00601c398a2e08719ce002e54753f07a43016e09808f0f0d501e5575b80367ab68

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 ## Version 0
+### Version 0.4.0
+* New get_userrights method for getting an array of all user rights that user has.
+* New get_user_gender method for getting the gender of the provided user.
+* New get_current_user_meta for getting userlists about the currently logged in user. Essentially the equivalent of get_userlists for logged in users.
+* Fix all userlist methods to work without supplying a username.
+* New get_registration_time method to get when the user registered.
+* Update to work with latest version of string-utility.
+* Namespaces are now in a hash instead of just a bunch of variables.
+* Namespace parameters are now actually limited to the valid namespaces constant. It will default to the main namespace (0) if the integer provided is not in the namespaces hash.
+* get_random_pages no longer wrongly sets the rnlimit to the namespaces argument rather than the namespace argument.
+
 ### Version 0.3.1
 * Fix edit and create_page NoMethodErrors.
 * Remove dependency for JSON as the version we use is included in the Ruby standard library.

data/lib/mediawiki/constants.rb

@@ -2,217 +2,218 @@ module MediaWiki
   module Constants
     # Constants Namespace IDs. Taken from https://www.mediawiki.org/wiki/Extension_default_namespaces
     module Namespaces
-      # Core
-      $NS_MAIN = 0
-      $NS_TALK = 1
-      $NS_USER = 2
-      $NS_USER_TALK = 3
-      $NS_PROJECT = 4
-      $NS_PROJECT_TALK = 5
-      $NS_FILE = 6
-      $NS_FILE_TALK = 7
-      $NS_MEDIAWIKI = 8
-      $NS_MEDIAWIKI_TALK = 9
-      $NS_TEMPLATE = 10
-      $NS_TEMPLATE_TALK = 11
-      $NS_HELP = 12
-      $NS_HELP_TALK = 13
-      $NS_CATEGORY = 14
-      $NS_CATEGORY_TALK = 15
-      $NS_SPECIAL = -1
-      $NS_MEDIA = -2
-
-      # Extension:LiquidThreads
-      $NS_LQT_THREAD = 90
-      $NS_LQT_THREAD_TALK = 91
-      $NS_LQT_SUMMARY = 92
-      $NS_LQT_SUMMARY_TALK = 93
-
-      # Extension:Semantic MediaWiki / Extension:Semantic Forms
-      $NS_SMW_RELATION = 100
-      $NS_SMW_RELATION_TALK = 101
-      $NS_SMW_PROPERTY = 102
-      $NS_SMW_PROPERTY_TALK = 103
-      $NS_SMW_TYPE = 104
-      $NS_SMW_TYPE_TALK = 105
-      $NS_SMW_FORM = 106
-      $NS_SMW_FORM_TALK = 107
-      $NS_SF_CONCEPT = 108
-      $NS_SF_CONCEPT_TALK = 109
-
-      # Extension:DPLforum
-      $NS_DPLF_FORUM = 110
-      $NS_DPLF_FORUM_TAlK = 111
-
-      # Extension:RefHelper
-      $NS_RFH_CITE = 120
-      $NS_RFH_CITE_TALK = 121
-
-      # Extension:SemanticAccessControl
-      $NS_ACL_USERGROUP = 160
-      $NS_ACL_ACL = 162
-
-      # Extension:Semantic Drilldown
-      $NS_SED_FILTER = 170
-      $NS_SED_FILTER_TALK = 171
-
-      # Extension:SocialProfile
-      $NS_SCP_USERWIKI = 200
-      $NS_SCP_USERWIKI_TALK = 201
-      $NS_SCP_USERPROFILE = 202
-      $NS_SCP_USERPROFILE_TALK = 203
-
-      # Extension:Proofread Page
-      $NS_PRP_PAGE = 250
-      $NS_PRP_PAGE_TALK = 251
-      $NS_PRP_INDEX = 252
-      $NS_PRP_INDEX_TALK = 253
-
-      # Extension:TrustedMath
-      $NS_TRM_MATH = 262
-      $NS_TRM_MATH_TALK = 263
-
-      # Extension:Widgets
-      $NS_WID_WIDGET = 274
-      $NS_WID_WIDGET_TALK = 275
-
-      # Extension:EmbedScript
-      $NS_EMS_JSAPPLET = 280
-      $NS_EMS_JSAPPLET_TALK = 281
-
-      # Extension:PollNY
-      $NS_PLN_POLL = 300
-      $NS_PLN_POLL_TALK = 301
-
-      # Extension:Semantic Image Annotator
-      $NS_SIA_IMAGE_ANNOTATOR = 380
-
-      # Extension:Wiki2LaTeX
-      $NS_WTL_WIKI2LATEX = 400
-      $NS_WTL_WIKI2LATEX_TALK = 401
-
-      # Extension:Workflow
-      $NS_WRF_WORKFLOW = 410
-      $NS_WRF_WORKFLOW_TALK = 411
-
-      # Extension:Maps
-      $NS_MAP_LAYER = 420
-      $NS_MAP_LAYER_TALK = 421
-
-      # Extension:QuizTabulate
-      $NS_QTB_QUIZ = 430
-      $NS_QTB_QUIZ_TALK = 431
-
-      # Extension:Education Program
-      $NS_EDP_EDUCATION_PROGRAM = 446
-      $NS_EDP_EDUCATION_PROGRAM_TALK = 447
-
-      # Extension:BoilerRoom
-      $NS_BLR_BOILERPLATE = 450
-      $NS_BLR_BOILERPLATE_TALK = 451
-
-      # Extension:UploadWizard
-      $NS_UPW_CAMPAIGN = 460
-      $NS_UPW_CAMPAIGN_TALK = 461
-
-      # Extension:EventLogging
-      $NS_ELG_SCHEMA = 470
-      $NS_ELG_SCHEMA_TALK = 471
-
-      # Extension:ZeroBanner
-      $NS_ZRB_ZERO = 480
-      $NS_ZRB_ZERO_TALK = 481
-
-      # Extension:JsonConfig
-      $NS_JSC_CONFIG = 482
-      $NS_JSC_CONFIG_TALK = 483
-      $NS_JSC_DATA = 486
-      $NS_JSC_DATA_TALK = 487
-
-      # Extension:Graph
-      $NS_GRP_GRAPH = 484
-      $NS_GRP_GRAPH_TALK = 485
-
-      # Extension:OpenStackManager
-      $NS_OSM_NOVA_RESOURCE = 488
-      $NS_OSM_NOVA_RESOURCE_TALK = 489
-
-      # Extension:GWToolset
-      $NS_GWT_GWTOOLSET = 490
-      $NS_GWT_GWTOOLSET_TALK = 491
-
-      # Extension:BlogPage
-      $NS_BLP_BLOG = 500
-      $NS_BLP_BLOG_TALK = 501
-
-      # Extension:XMLContentExtension
-      $NS_XCE_XML = 580
-      $NS_XCE_XML_TALK = 581
-      $NS_XCE_SCHEMA = 582
-      $NS_XCE_SCHEMA_TALK = 583
-
-      # Extension:FanBoxes
-      $NS_FNB_USERBOX = 600
-      $NS_FNB_USERBOX_TALK = 601
-
-      # Extension:LinkFilter
-      $NS_LFT_LINK = 700
-      $NS_LFT_LINK_TALK = 701
-
-      # Extension:TimedMediaHandler
-      $NS_TMH_TIMEDTEXT = 710
-      $NS_TMH_TIMEDTEXT_TALK = 711
-
-      # Extension:QPoll
-      $NS_QPL_INTERPRETATION = 800
-      $NS_QPL_INTERPRETATION_TALK = 801
-
-      # Extension:SemanticMustacheFormat :3
-      $NS_SMF_MUSTACHE = 806
-      $NS_SMF_MUSTACHE_TALK = 807
-
-      # Extension:R
-      $NS_R_R = 814
-      $NS_R_R_TALK = 815
-
-      # Extension:Scribunto
-      $NS_SCR_MODULE = 828
-      $NS_SCR_MODULE_TALK = 829
-
-      # Extension:SecurePoll
-      $NS_SEP_SECUREPOLL = 830
-      $NS_SEP_SECUREPOLL_TALK = 831
-
-      # Extension:CentralNotice
-      $NS_CNT_CNBANNER = 866
-      $NS_CNT_CNBANNER_TALK = 867
-
-      # Extension:Translate
-      $NS_TRN_TRANSLATIONS = 1198
-      $NS_TRN_TRANSLATIONS_TALK = 1199
-
-      # Extension:PackageForce
-      $NS_PKF_PACKAGEFORCE = 1300
-      $NS_PKF_PACKAGEFORCE_TALK = 1301
-
-      # Extension:BlueSpice
-      $NS_BLS_BLOG = 1502
-      $NS_BLS_BLOG_TALK = 1503
-      $NS_BLS_BOOK = 1504
-      $NS_BLS_BOOK_TALK = 1505
-
-      # Extension:Gadgets
-      $NS_GDG_GADGET = 2300
-      $NS_GDG_GADGET_TALK = 2301
-      $NS_GDG_GADGET_DEFININTION = 2302
-      $NS_GDG_GADGET_DEFININTION_TALK = 2303
-
-      # Extension:VisualEditor
-      $NS_VSE_VISUALEDITOR = 2500
-      $NS_VSE_VISUALEDITOR_TALK = 2501
-
-      # Extension:Flow
-      $NS_FLW_TOPIC = 2600
+      $namespaces = {
+        "MAIN": 0,
+        "TALK": 1,
+        "USER": 2,
+        "USER_TALK": 3,
+        "PROJECT": 4,
+        "PROJECT_TALK": 5,
+        "FILE": 6,
+        "FILE_TALK": 7,
+        "MEDIAWIKI": 8,
+        "MEDIAWIKI_TALK": 9,
+        "TEMPLATE": 10,
+        "TEMPLATE_TALK": 11,
+        "HELP": 12,
+        "HELP_TALK": 13,
+        "CATEGORY": 14,
+        "CATEGORY_TALK": 15,
+        "SPECIAL": -1,
+        "MEDIA": -2,
+
+        # Extension:LiquidThreads
+        "LQT_THREAD": 90,
+        "LQT_THREAD_TALK": 91,
+        "LQT_SUMMARY": 92,
+        "LQT_SUMMARY_TALK": 93,
+
+        # Extension:Semantic MediaWiki / Extension:Semantic Forms
+        "SMW_RELATION": 100,
+        "SMW_RELATION_TALK": 101,
+        "SMW_PROPERTY": 102,
+        "SMW_PROPERTY_TALK": 103,
+        "SMW_TYPE": 104,
+        "SMW_TYPE_TALK": 105,
+        "SMW_FORM": 106,
+        "SMW_FORM_TALK": 107,
+        "SF_CONCEPT": 108,
+        "SF_CONCEPT_TALK": 109,
+
+        # Extension:DPLforum
+        "DPLF_FORUM": 110,
+        "DPLF_FORUM_TAlK": 111,
+
+        # Extension:RefHelper
+        "RFH_CITE": 120,
+        "RFH_CITE_TALK": 121,
+
+        # Extension:SemanticAccessControl
+        "ACL_USERGROUP": 160,
+        "ACL_ACL": 162,
+
+        # Extension:Semantic Drilldown
+        "SED_FILTER": 170,
+        "SED_FILTER_TALK": 171,
+
+        # Extension:SocialProfile
+        "SCP_USERWIKI": 200,
+        "SCP_USERWIKI_TALK": 201,
+        "SCP_USERPROFILE": 202,
+        "SCP_USERPROFILE_TALK": 203,
+
+        # Extension:Proofread Page
+        "PRP_PAGE": 250,
+        "PRP_PAGE_TALK": 251,
+        "PRP_INDEX": 252,
+        "PRP_INDEX_TALK": 253,
+
+        # Extension:TrustedMath
+        "TRM_MATH": 262,
+        "TRM_MATH_TALK": 263,
+
+        # Extension:Widgets
+        "WID_WIDGET": 274,
+        "WID_WIDGET_TALK": 275,
+
+        # Extension:EmbedScript
+        "EMS_JSAPPLET": 280,
+        "EMS_JSAPPLET_TALK": 281,
+
+        # Extension:PollNY
+        "PLN_POLL": 300,
+        "PLN_POLL_TALK": 301,
+
+        # Extension:Semantic Image Annotator
+        "SIA_IMAGE_ANNOTATOR": 380,
+
+        # Extension:Wiki2LaTeX
+        "WTL_WIKI2LATEX": 400,
+        "WTL_WIKI2LATEX_TALK": 401,
+
+        # Extension:Workflow
+        "WRF_WORKFLOW": 410,
+        "WRF_WORKFLOW_TALK": 411,
+
+        # Extension:Maps
+        "MAP_LAYER": 420,
+        "MAP_LAYER_TALK": 421,
+
+        # Extension:QuizTabulate
+        "QTB_QUIZ": 430,
+        "QTB_QUIZ_TALK": 431,
+
+        # Extension:Education Program
+        "EDP_EDUCATION_PROGRAM": 446,
+        "EDP_EDUCATION_PROGRAM_TALK": 447,
+
+        # Extension:BoilerRoom
+        "BLR_BOILERPLATE": 450,
+        "BLR_BOILERPLATE_TALK": 451,
+
+        # Extension:UploadWizard
+        "UPW_CAMPAIGN": 460,
+        "UPW_CAMPAIGN_TALK": 461,
+
+        # Extension:EventLogging
+        "ELG_SCHEMA": 470,
+        "ELG_SCHEMA_TALK": 471,
+
+        # Extension:ZeroBanner
+        "ZRB_ZERO": 480,
+        "ZRB_ZERO_TALK": 481,
+
+        # Extension:JsonConfig
+        "JSC_CONFIG": 482,
+        "JSC_CONFIG_TALK": 483,
+        "JSC_DATA": 486,
+        "JSC_DATA_TALK": 487,
+
+        # Extension:Graph
+        "GRP_GRAPH": 484,
+        "GRP_GRAPH_TALK": 485,
+
+        # Extension:OpenStackManager
+        "OSM_NOVA_RESOURCE": 488,
+        "OSM_NOVA_RESOURCE_TALK": 489,
+
+        # Extension:GWToolset
+        "GWT_GWTOOLSET": 490,
+        "GWT_GWTOOLSET_TALK": 491,
+
+        # Extension:BlogPage
+        "BLP_BLOG": 500,
+        "BLP_BLOG_TALK": 501,
+
+        # Extension:XMLContentExtension
+        "XCE_XML": 580,
+        "XCE_XML_TALK": 581,
+        "XCE_SCHEMA": 582,
+        "XCE_SCHEMA_TALK": 583,
+
+        # Extension:FanBoxes
+        "FNB_USERBOX": 600,
+        "FNB_USERBOX_TALK": 601,
+
+        # Extension:LinkFilter
+        "LFT_LINK": 700,
+        "LFT_LINK_TALK": 701,
+
+        # Extension:TimedMediaHandler
+        "TMH_TIMEDTEXT": 710,
+        "TMH_TIMEDTEXT_TALK": 711,
+
+        # Extension:QPoll
+        "QPL_INTERPRETATION": 800,
+        "QPL_INTERPRETATION_TALK": 801,
+
+        # Extension:SemanticMustacheFormat :3,
+        "SMF_MUSTACHE": 806,
+        "SMF_MUSTACHE_TALK": 807,
+
+        # Extension:R
+        "R_R": 814,
+        "R_R_TALK": 815,
+
+        # Extension:Scribunto
+        "SCR_MODULE": 828,
+        "SCR_MODULE_TALK": 829,
+
+        # Extension:SecurePoll
+        "SEP_SECUREPOLL": 830,
+        "SEP_SECUREPOLL_TALK": 831,
+
+        # Extension:CentralNotice
+        "CNT_CNBANNER": 866,
+        "CNT_CNBANNER_TALK": 867,
+
+        # Extension:Translate
+        "TRN_TRANSLATIONS": 1198,
+        "TRN_TRANSLATIOTALK": 1199,
+
+        # Extension:PackageForce
+        "PKF_PACKAGEFORCE": 1300,
+        "PKF_PACKAGEFORCE_TALK": 1301,
+
+        # Extension:BlueSpice
+        "BLS_BLOG": 1502,
+        "BLS_BLOG_TALK": 1503,
+        "BLS_BOOK": 1504,
+        "BLS_BOOK_TALK": 1505,
+
+        # Extension:Gadgets
+        "GDG_GADGET": 2300,
+        "GDG_GADGET_TALK": 2301,
+        "GDG_GADGET_DEFININTION": 2302,
+        "GDG_GADGET_DEFININTION_TALK": 2303,
+
+        # Extension:VisualEditor
+        "VSE_VISUALEDITOR": 2500,
+        "VSE_VISUALEDITOR_TALK": 2501,
+
+        # Extension:Flow
+        "FLW_TOPIC": 2600
+      }
     end
   end
 end

data/lib/mediawiki/query.rb

@@ -1,9 +1,11 @@
 require 'string-utility'
+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.
@@ -23,6 +25,25 @@ module MediaWiki
         end
         return ret
       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 == true
+          params = {
+            action: 'query',
+            meta: 'userinfo',
+            uiprop: prop,
+            format: 'json'
+          }
+
+          response = post(params)
+          return response
+        else
+          return false
+        end
+      end
     end
 
     module Properties
@@ -100,6 +121,7 @@ module MediaWiki
     end
 
     module Lists
+      using StringUtility
 
       # Gets an array of backlinks to a given title.
       # @param title [String] The page to get the backlinks of.
@@ -185,9 +207,13 @@ module MediaWiki
           format: 'json'
         }
 
-        params[:rnnamespace] = namespace if namespace != nil
+        if $namespaces.has_value?(namespace)
+          params[:rnnamespace] = namespace
+        else
+          params[:rnnamespace] = 0
+        end
 
-        if namespace > 10
+        if number_of_pages > 10
           if is_user_bot? == true
             if limit > 20
               params[:rnlimit] = 20
@@ -198,7 +224,7 @@ module MediaWiki
             params[:rnlimit] = 10
           end
         else
-          params[:rnlimit] = namespace
+          params[:rnlimit] = number_of_pages
         end
 
         ret = Array.new
@@ -214,47 +240,76 @@ module MediaWiki
       # @param username [String] The username to get info for. Optional. Defaults to the currently logged in user if ommitted.
       # @return [String/Nil] Parsed full response if successful, nil if the username is nil and the Butt is not logged in.
       def get_userlists(prop, username = nil)
-        params = {
-          action: 'query',
-          list: 'users',
-          usprop: prop,
-          format: 'json'
-        }
-
         if username.nil?
           if @logged_in == true
-            response = post(params)
+            response = get_current_user_meta(prop)
           else
-            return nil
+            return false
           end
         else
-          params[:ususers] = username
+          params = {
+            action: 'query',
+            list: 'users',
+            usprop: prop,
+            ususers: username,
+            format: 'json'
+          }
+
           response = post(params)
         end
 
         return response
       end
 
-      # Gets an array of all the currently logged in user's groups.
+      # Gets an array of all the user's groups.
       # @param username [String] The username to get groups of. Optional. Defaults to the currently logged in user.
       # @return [Array/Boolean] All of the user's groups, or false if username is nil and Butt is not logged in.
       def get_usergroups(username = nil)
+        ret = Array.new
         if username.nil?
           if @logged_in == true
             info = get_userlists('groups')
+            info["query"]["userinfo"]["groups"].each do |i|
+              ret.push(i)
+            end
           else
             return false
           end
         else
           info = get_userlists('groups', username)
+          info["query"]["users"].each do |i|
+            i["groups"].each do |g|
+              ret.push(g)
+            end
+          end
         end
 
+        return ret
+      end
+
+      # Gets the user rights for the user.
+      # @param username [String] The user to get the rights for. Optional. Defaults to the currently logged in user.
+      # @return [Array/Boolean] All of the user's groups, or false if username is nil and Butt is not logged in.
+      def get_userrights(username = nil)
         ret = Array.new
-        info["query"]["users"].each do |i|
-          i["groups"].each do |g|
-            ret.push(g)
+        if username.nil?
+          if @logged_in == true
+            info = get_userlists('rights')
+            info["query"]["userinfo"]["rights"].each do |i|
+              ret.push(i)
+            end
+          else
+            return false
+          end
+        else
+          info = get_userlists('rights', username)
+          info["query"]["users"].each do |i|
+            i["rights"].each do |g|
+              ret.push(g)
+            end
           end
         end
+
         return ret
       end
 
@@ -263,27 +318,116 @@ module MediaWiki
       # @param autoparse [Boolean] Whether to automatically format the string with commas. Defaults to true.
       # @return [Boolean/Int/String] False if username is nil and Butt is not logged in. An integer value of the contribution count if autoparse is false. A formatted string version of the contribution count if autoparse is true.
       def get_contrib_count(username = nil, autoparse = true)
+        count = nil
         if username.nil?
           if @logged_in == true
             info = get_userlists('editcount')
+            count = info["query"]["userinfo"]["editcount"]
           else
             return false
           end
         else
           info = get_userlists('editcount', username)
-        end
-
-        count = nil
-        info["query"]["users"].each do |i|
-          count = i["editcount"]
+          info["query"]["users"].each do |i|
+            count = i["editcount"]
+          end
         end
 
         if autoparse == true
-          countstring = StringUtility.separate_with(count.to_s)
+          countstring = count.to_s.separate
           return countstring
         end
         return count
       end
+
+      # Gets when the user registered.
+      # @param username [String] The username to get the registration date and time of. Optional. Defaults to the currently logged in user.
+      # @return [DateTime] The registration date and time as a DateTime object.
+      def get_registration_time(username = nil)
+        time = nil
+        # Do note that in Userinfo, registration is called registrationdate.
+        if username.nil?
+          if @logged_in == true
+            info = get_userlists('registrationdate')
+            time = info["query"]["userinfo"]["registrationdate"]
+          else
+            return false
+          end
+        else
+          info = get_userlists('registration', username)
+          info["query"]["users"].each do |i|
+            time = i["registration"]
+          end
+        end
+
+        # %Y: Year including century, %m: Month num, %d day of month, %T Time as H:M:S
+        timeformat = "%Y-%m-%dT%T"
+        time = DateTime.strptime(time, timeformat)
+        return time
+      end
+
+      # Gets the gender for the provded user.
+      # @param username [String] The user.
+      # @return [String] The gender. "male", "female", or "unknown".
+      def get_user_gender(username)
+        gender = nil
+        info = get_userlists('gender', username)
+        info["query"]["users"].each do |i|
+          gender = i["gender"]
+        end
+
+        return gender
+      end
+
+      # Gets the amount of results for the search value.
+      # @param search_value [String] The thing to search for.
+      # @param namespace [Int] The namespace to search in. Defaults to the main namespace.
+      # @return [Int] The number of pages that matched the search.
+      def get_search_result_amount(search_value, namespace = 0)
+        params = {
+          action: 'query',
+          list: 'search',
+          srsearch: search_value,
+          format: 'json'
+        }
+
+        if $namespaces.has_value?(namespace)
+          params[:srnamespace] = namespace
+        else
+          params[:srnamespace] = 0
+        end
+
+        response = post(params)
+
+        return response["query"]["searchinfo"]["totalhits"]
+      end
+
+      # Gets an array containing page titles that matched the search.
+      # @param search_value [String] The thing to search for.
+      # @param namespace [Int] The namespace to search in. Defaults to the main namespace.
+      # @return [Array] The page titles that matched the search.
+      def get_search_results(search_value, namespace = 0)
+        params = {
+          action: 'query',
+          list: 'search',
+          srsearch: search_value,
+          format: 'json'
+        }
+
+        if $namespaces.has_value?(namespace)
+          params[:srnamespace] = namespace
+        else
+          params[:srnamespace] = 0
+        end
+
+        response = post(params)
+
+        ret = Array.new
+        response["query"]["search"].each do |search|
+          ret.push(search["title"])
+        end
+        return ret
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Eli Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-02 00:00:00.000000000 Z
+date: 2015-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-utility
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement