mediawiki-butt 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3bb16cf6fe52c692e7ca6aea0db8761fa4a3af0
-  data.tar.gz: 6e5132d8fcc1972b89ccc3ad6ca666a0fd11446d
+  metadata.gz: 4f09a41fd00c3ff2e7f5bc1cafa03ed5d950b5cc
+  data.tar.gz: 60402f6721be863aeb428c13933cfdcc5e9214ed
 SHA512:
-  metadata.gz: 6f2b25dfd88316f079dd30055e4b16788a16bc2397a9fa743aac8b6194961dad881628c12c60733e179f53150ab0785c3492865748753fdb48cc232721a570a4
-  data.tar.gz: 0fd0998139a5687b931a74b125f9b60ed4aef78bac71544e87fd7c2e295ef155f1c900e349bf09c2011af2849257034f3933d4d74337c37f7af5ae41ce3d7a2e
+  metadata.gz: f4023e04f09486f94ad4b6af55d889e6b5aa39af713842c5b1574ddd2c0929d847c0d2581e2e6933676b9fb3877d3e0b577fa19ce11e4cbfa2d2b85b2b79252d
+  data.tar.gz: deea5c87cdf91d334f97e62f6c065ae6f71fed9ca9ac1ae56a512c17ebbfb207eaab7fd6f80ff032cc7bd5f900f90e832bab5534b23ca7822c9542239f79afd2

data/lib/mediawiki/administration.rb

@@ -5,7 +5,8 @@ module MediaWiki
     # @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.
+    # @return [String] The error code.
+    # @return [Int] The block ID.
     def block(user, expiry = '2 weeks', reason = nil, nocreate = true)
       params = {
         action: 'block',
@@ -30,7 +31,8 @@ module MediaWiki
     # 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.
+    # @return [String] The error code.
+    # @return [Int] The block ID.
     def unblock(user, reason = nil)
       params = {
         action: 'unblock',

data/lib/mediawiki/butt.rb

@@ -14,7 +14,7 @@ module MediaWiki
     include MediaWiki::Query::Meta::UserInfo
     include MediaWiki::Query::Properties
     include MediaWiki::Query::Lists
-    include MediaWiki::Constants::Namespaces
+    include MediaWiki::Constants
     include MediaWiki::Edit
     include MediaWiki::Administration
 
@@ -23,14 +23,14 @@ module MediaWiki
     # @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)
+    # @param custom_agent [String] A custom User-Agent to use. Optional.
+    def initialize(url, use_ssl = true, custom_agent = nil)
       @url = url =~ /api.php$/ ? url : "#{url}/api.php"
-
       @client = HTTPClient.new
       @uri = URI.parse(@url)
       @ssl = use_ssl
       @logged_in = false
+      @custom_agent = custom_agent unless custom_agent.nil?
       @tokens = {}
     end
 
@@ -42,8 +42,8 @@ module MediaWiki
     # @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.
+    # @return [HTTPMessage] Raw HTTP response.
     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
@@ -56,11 +56,8 @@ module MediaWiki
       params[:format] = 'json'
       header = {} if header.nil?
 
-      if @logged_in == false
-        header['User-Agent'] = 'NotLoggedIn/MediaWiki::Butt'
-      else
-        header['User-Agent'] = "#{@name}/MediaWiki::Butt"
-      end
+      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)
 

data/lib/mediawiki/constants.rb

@@ -1,219 +1,217 @@
 module MediaWiki
   module Constants
-    # Constants Namespace IDs. Taken from https://www.mediawiki.org/wiki/Extension_default_namespaces
-    module Namespaces
-      $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
+    # Taken from https://www.mediawiki.org/wiki/Extension_default_namespaces
+    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