mediawiki-gateway 0.6.0 → 0.6.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWFlYzhhOWFmYmJiOWEwOTI5OTlhZGRhOGQ1NWM3MjgyYmE0YjJhMQ==
+    ZjkxNDFhNzdhOGU1ZjU2YjIwNjA5YmI5MDQzYTg3YjBjZjMwNWI1Mg==
   data.tar.gz: !binary |-
-    NzgzNDFiMTg2MzI4ZTM5MmQ4MzcxOTZjNzJlMGU5Zjg0ODFmMmI2Mw==
+    OWE3MjhiNjU1N2I2NzE4NWRmMGZmNmI0MGYyYmZhNTI5NjkyYmY5Ng==
 SHA512:
   metadata.gz: !binary |-
-    NWQ4NGIxOWU4NTcwYjJiZjJiOTM5OGMxNmIyMWFjMjU3YmQ1ZjMzYjViMjMz
-    ZmJkODYwYTBhYzI3NTU2NzNkYzQ0YzNjZTFkNzcwZGM0YjI3NWI5MGZkNzYx
-    YTAyNTU4MjEzYjBhMGM5YzM1YTVhZGM5NGM0ZWM1MjhkN2JjZjg=
+    ZDRhMGVkZGM3ODI4MDg4MTRhNDU0NDU1YzdmZDhkZTBmNjhhZjg4NTE2ZGMy
+    ZjE0MGE5NTQ5NTFmOTU0ODEyODE4MTUzMjE0ODM5ODcxZDkxZDQ0MGE0NTBh
+    NzM1N2UxOGRlNDJmMzkyYzk1ODg5ODlhNjQyYjUxYmQyMTdjY2M=
   data.tar.gz: !binary |-
-    OTM1MTM5YmZmZDI4YTM3YmVhZjlmZDc4OTkwZjk2MDE0M2Y5Yjk2YzYyNzdh
-    MTUxNDJjNzdiYTc0OTQwMDM0MTEzYmFkMTA4MDg3NDA1NzgwYmRhN2JlODgx
-    YjY1OGRjMTU3N2JiODdmZGQxMmJiNGUzY2JhZDI4MWNhODE1MTc=
+    MTI4N2Q2Y2Q2ZmYzNjdhMjBmNGQ5MzcwNzczMzRhYzdjMDNkNWIyYjNiYmU0
+    OTRiZjkzMzVkOWFkNzliOTI3OTdmYjg3MjMzMjRmOTY4ZWQxMjU0ZGYzZDEy
+    ZWY4NTQ3OTdlNWQxY2ViZjkyZWMyM2U0YmJiZDFlMTAzMTE1M2I=

data/Gemfile

@@ -10,6 +10,9 @@ group :development do
   gem 'rr'
   gem 'simplecov'
   gem 'rspec', '~> 1.3'
+  gem 'rspec-core'
+  gem 'rspec-expectations'
+  gem 'rspec-mocks'
   gem 'debugger'
   gem 'sinatra'
   gem 'activemodel'

data/Gemfile.lock

@@ -16,6 +16,7 @@ GEM
       debugger-ruby_core_source (~> 1.2.3)
     debugger-linecache (1.2.0)
     debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.5)
     git (1.2.5)
     i18n (0.6.0)
     jeweler (1.8.4)
@@ -36,6 +37,14 @@ GEM
       mime-types (>= 1.16)
     rr (1.0.4)
     rspec (1.3.2)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
     sham_rack (1.3.4)
       rack
     simplecov (0.6.4)
@@ -60,6 +69,9 @@ DEPENDENCIES
   rest-client (>= 1.3.0)
   rr
   rspec (~> 1.3)
+  rspec-core
+  rspec-expectations
+  rspec-mocks
   sham_rack
   simplecov
   sinatra

data/{README → README.md}

@@ -1,4 +1,4 @@
-= MediaWiki::Gateway
+# MediaWiki::Gateway
 
 A Ruby framework for MediaWiki API manipulation.  Features out of the box:
 
@@ -11,36 +11,40 @@ A Ruby framework for MediaWiki API manipulation.  Features out of the box:
 * Should work with both Ruby 1.8 and 1.9
 
 Gem:  http://rubygems.org/gems/mediawiki-gateway
+
 RDoc: http://rubydoc.info/gems/mediawiki-gateway
+
 Git:  https://github.com/jpatokal/mediawiki-gateway
 
-== Example
+## Example
 
 Simple page creation script:
 
- require 'media_wiki'
- mw = MediaWiki::Gateway.new('http://my-wiki.example/w/api.php')
- mw.login('RubyBot', 'pa$$w0rd')
- mw.create('PageTitle', 'Hello world!', :summary => 'My first page')
+    require 'media_wiki'
+    mw = MediaWiki::Gateway.new('http://my-wiki.example/w/api.php')
+    mw.login('RubyBot', 'pa$$w0rd')
+    mw.create('PageTitle', 'Hello world!', :summary => 'My first page')
 
-== Development environment
+## Development environment
 
 To compile and test MediaWiki::Gateway locally, Bundler and Ruby 1.9+ are expected.
 
- rvm install 1.9.3-p194
- bundle install
+    rvm install 1.9.3-p194
+    bundle install
 
 This will list the available options:
- bundle exec rake -T
+
+    bundle exec rake -T
 
 To build and install the gem use:
- bundle exec rake install
 
-== Status
+    bundle exec rake install
+
+## Status
 
-This gem is no longer in active development.  Bugs will be fixed if reported, and pull requests that add new features are more than welcome, but asking for new features is unlikely to make them materialize out of thin air.
+This gem is no longer in active development.  Pull requests that fix bugs or add new features are more than welcome, but asking for new features is unlikely to make them materialize out of thin air.
 
-== Credits
+## Credits
 
 Maintained by Jani Patokallio.
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'thread'
 require 'rake'
 require "rubygems/package_task"
 require 'rdoc/task'
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
 require_relative 'lib/media_wiki'
 
 task :default => ['spec']
@@ -19,9 +19,8 @@ RDoc::Task.new do |rd|
 end
 
 desc "Run all specs"
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_files = FileList['spec/**/*.rb']
-  t.spec_opts = ['--debugger']
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = FileList['spec/**/*.rb']
 end
 
 

data/lib/media_wiki.rb

@@ -5,5 +5,5 @@ require File.dirname(__FILE__) + '/media_wiki/utils'
 require File.dirname(__FILE__) + '/media_wiki/gateway'
 
 module MediaWiki
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/lib/media_wiki/gateway.rb

@@ -14,6 +14,7 @@ module MediaWiki
     #
     # [url] Path to API of target MediaWiki (eg. "http://en.wikipedia.org/w/api.php")
     # [options] Hash of options
+    # [http_options] Hash of options for RestClient::Request (via http_send)
     #
     # Options:
     # [:bot] When set to true, executes API queries with the bot parameter (see http://www.mediawiki.org/wiki/API:Edit#Parameters).  Defaults to false.
@@ -24,7 +25,7 @@ module MediaWiki
     # [:maxlag] Maximum allowed server lag (see http://www.mediawiki.org/wiki/Manual:Maxlag_parameter), defaults to 5 seconds.
     # [:retry_count] Number of times to try before giving up if MediaWiki returns 503 Service Unavailable, defaults to 3 (original request plus two retries).
     # [:retry_delay] Seconds to wait before retry if MediaWiki returns 503 Service Unavailable, defaults to 10 seconds.
-    def initialize(url, options={})
+    def initialize(url, options={}, http_options={})
       default_options = {
         :bot => false,
         :limit => 500,
@@ -36,6 +37,7 @@ module MediaWiki
         :max_results => 500
       }
       @options = default_options.merge(options)
+      @http_options = http_options
       @wiki_url = url
       @log = Logger.new(@options[:logdevice])
       @log.level = @options[:loglevel]
@@ -50,11 +52,17 @@ module MediaWiki
     # [username] Username
     # [password] Password
     # [domain] Domain for authentication plugin logins (eg. LDAP), optional -- defaults to 'local' if not given
+    # [options] Hash of additional options
     #
     # Throws MediaWiki::Unauthorized if login fails
-    def login(username, password, domain = 'local')
-      form_data = {'action' => 'login', 'lgname' => username, 'lgpassword' => password, 'lgdomain' => domain}
-      make_api_request(form_data)
+    def login(username, password, domain = 'local', options = {})
+      make_api_request(options.merge(
+        'action'     => 'login',
+        'lgname'     => username,
+        'lgpassword' => password,
+        'lgdomain'   => domain
+      ))
+
       @password = password
       @username = username
     end
@@ -62,27 +70,36 @@ module MediaWiki
     # Fetch MediaWiki page in MediaWiki format.  Does not follow redirects.
     #
     # [page_title] Page title to fetch
+    # [options] Hash of additional options
     #
     # Returns content of page as string, nil if the page does not exist.
-    def get(page_title)
-      form_data = {'action' => 'query', 'prop' => 'revisions', 'rvprop' => 'content', 'titles' => page_title}
-      page = make_api_request(form_data).first.elements["query/pages/page"]
-      if valid_page? page
-        page.elements["revisions/rev"].text || ""
-      end
+    def get(page_title, options = {})
+      page = make_api_request(options.merge(
+        'action' => 'query',
+        'prop'   => 'revisions',
+        'rvprop' => 'content',
+        'titles' => page_title
+      )).first.elements['query/pages/page']
+
+      page.elements['revisions/rev'].text || '' if valid_page?(page)
     end
 
     # Fetch latest revision ID of a MediaWiki page.  Does not follow redirects.
     #
     # [page_title] Page title to fetch
+    # [options] Hash of additional options
     #
     # Returns revision ID as a string, nil if the page does not exist.
-    def revision(page_title)
-      form_data = {'action' => 'query', 'prop' => 'revisions', 'rvprop' => 'ids', 'rvlimit' => 1, 'titles' => page_title}
-      page = make_api_request(form_data).first.elements["query/pages/page"]
-      if valid_page? page
-        page.elements["revisions/rev"].attributes["revid"]
-      end
+    def revision(page_title, options = {})
+      page = make_api_request(options.merge(
+        'action'  => 'query',
+        'prop'    => 'revisions',
+        'rvprop'  => 'ids',
+        'rvlimit' => 1,
+        'titles'  => page_title
+      )).first.elements['query/pages/page']
+
+      page.elements['revisions/rev'].attributes['revid'] if valid_page?(page)
     end
 
     # Render a MediaWiki page as HTML
@@ -110,7 +127,7 @@ module MediaWiki
         # OPTIMIZE: unifiy the keys in +options+ like symbolize_keys! but w/o
         if options["linkbase"] or options[:linkbase]
           linkbase = options["linkbase"] || options[:linkbase]
-          rendered = rendered.gsub(/\shref="\/wiki\/([\w\(\)_\-\.%\d:,]*)"/, ' href="' + linkbase + '/wiki/\1"')
+          rendered = rendered.gsub(/\shref="\/wiki\/([\w\(\)\-\.%:,]*)"/, ' href="' + linkbase + '/wiki/\1"')
         end
         if options["noeditsections"] or options[:noeditsections]
           rendered = rendered.gsub(/<span class="editsection">\[.+\]<\/span>/, '')
@@ -240,21 +257,28 @@ module MediaWiki
     # Delete one page. (MediaWiki API does not support deleting multiple pages at a time.)
     #
     # [title] Title of page to delete
-    def delete(title)
-      form_data = {'action' => 'delete', 'title' => title, 'token' => get_token('delete', title)}
-      make_api_request(form_data)
+    # [options] Hash of additional options
+    def delete(title, options = {})
+      make_api_request(options.merge(
+        'action' => 'delete',
+        'title'  => title,
+        'token'  => get_token('delete', title)
+      ))
     end
 
     # Undelete all revisions of one page.
     #
     # [title] Title of page to undelete
+    # [options] Hash of additional options
     #
     # Returns number of revisions undeleted, or zero if nothing to undelete
-    def undelete(title)
-      token = get_undelete_token(title)
-      if token
-        form_data = {'action' => 'undelete', 'title' => title, 'token' => token }
-        make_api_request(form_data).first.elements["undelete"].attributes["revisions"].to_i
+    def undelete(title, options = {})
+      if token = get_undelete_token(title)
+        make_api_request(options.merge(
+          'action' => 'undelete',
+          'title'  => title,
+          'token'  => token
+        )).first.elements['undelete'].attributes['revisions'].to_i
       else
         0 # No revisions to undelete
       end
@@ -267,22 +291,15 @@ module MediaWiki
     #
     # Returns array of page titles (empty if no matches)
     def list(key, options = {})
-      titles = []
-      apfrom = nil
-      key, namespace = key.split(":", 2).reverse
+      key, namespace = key.split(':', 2).reverse
       namespace = namespaces_by_prefix[namespace] || 0
-      begin
-        form_data = options.merge(
-          {'action' => 'query',
-          'list' => 'allpages',
-          'apfrom' => apfrom,
-          'apprefix' => key,
-          'aplimit' => @options[:limit],
-          'apnamespace' => namespace})
-        res, apfrom = make_api_request(form_data, '//query-continue/allpages/@apfrom')
-        titles += REXML::XPath.match(res, "//p").map { |x| x.attributes["title"] }
-      end while apfrom
-      titles
+
+      iterate_query('allpages', '//p', 'title', 'apfrom', options.merge(
+        'list'        => 'allpages',
+        'apprefix'    => key,
+        'apnamespace' => namespace,
+        'aplimit'     => @options[:limit]
+      ))
     end
 
     # Get a list of pages that are members of a category
@@ -292,42 +309,25 @@ module MediaWiki
     #
     # Returns array of page titles (empty if no matches)
     def category_members(category, options = {})
-      titles = []
-      apfrom = nil
-      begin
-        form_data = options.merge(
-          {'action' => 'query',
-          'list' => 'categorymembers',
-          'apfrom' => apfrom,
-          'cmtitle' => category,
-          'cmlimit' => @options[:limit]})
-        res, apfrom = make_api_request(form_data, '//query-continue/categorymembers/@apfrom')
-        titles += REXML::XPath.match(res, "//cm").map { |x| x.attributes["title"] }
-      end while apfrom
-      titles
+      iterate_query('categorymembers', '//cm', 'title', 'cmcontinue', options.merge(
+        'cmtitle' => category,
+        'cmlimit' => @options[:limit]
+      ))
     end
 
     # Get a list of pages that link to a target page
     #
     # [title] Link target page
     # [filter] "all" links (default), "redirects" only, or "nonredirects" (plain links only)
+    # [options] Hash of additional options
     #
     # Returns array of page titles (empty if no matches)
-    def backlinks(title, filter = "all")
-      titles = []
-      blcontinue = nil
-      begin
-        form_data =
-          {'action' => 'query',
-          'list' => 'backlinks',
-          'bltitle' => title,
-          'blfilterredir' => filter,
-          'bllimit' => @options[:limit] }
-        form_data['blcontinue'] = blcontinue if blcontinue
-        res, blcontinue = make_api_request(form_data, '//query-continue/backlinks/@blcontinue')
-        titles += REXML::XPath.match(res, "//bl").map { |x| x.attributes["title"] }
-      end while blcontinue
-      titles
+    def backlinks(title, filter = 'all', options = {})
+      iterate_query('backlinks', '//bl', 'title', 'blcontinue', options.merge(
+        'bltitle'       => title,
+        'blfilterredir' => filter,
+        'bllimit'       => @options[:limit]
+      ))
     end
 
     # Get a list of pages with matching content in given namespaces
@@ -336,29 +336,33 @@ module MediaWiki
     # [namespaces] Array of namespace names to search (defaults to main only)
     # [limit] Maximum number of hits to ask for (defaults to 500; note that Wikimedia Foundation wikis allow only 50 for normal users)
     # [max_results] Maximum total number of results to return
+    # [options] Hash of additional options
     #
     # Returns array of page titles (empty if no matches)
-    def search(key, namespaces=nil, limit=@options[:limit], max_results=@options[:max_results])
+    def search(key, namespaces = nil, limit = @options[:limit], max_results = @options[:max_results], options = {})
       titles = []
       offset = 0
-      in_progress = true
 
-      form_data = { 'action' => 'query',
-        'list' => 'search',
-        'srwhat' => 'text',
+      form_data = options.merge(
+        'action'   => 'query',
+        'list'     => 'search',
+        'srwhat'   => 'text',
         'srsearch' => key,
-        'srlimit' => limit
-      }
+        'srlimit'  => limit
+      )
+
       if namespaces
         namespaces = [ namespaces ] unless namespaces.kind_of? Array
         form_data['srnamespace'] = namespaces.map! do |ns| namespaces_by_prefix[ns] end.join('|')
       end
+
       begin
         form_data['sroffset'] = offset if offset
         form_data['srlimit'] = [limit, max_results - offset.to_i].min
         res, offset = make_api_request(form_data, '//query-continue/search/@sroffset')
         titles += REXML::XPath.match(res, "//p").map { |x| x.attributes["title"] }
       end while offset && offset.to_i < max_results.to_i
+
       titles
     end
 
@@ -368,18 +372,9 @@ module MediaWiki
     #
     # Returns array of user names (empty if no matches)
     def users(options = {})
-      names = []
-      aufrom = nil
-      begin
-        form_data = options.merge(
-          {'action' => 'query',
-          'list' => 'allusers',
-          'aufrom' => aufrom,
-          'aulimit' => @options[:limit]})
-        res, aufrom = make_api_request(form_data, '//query-continue/allusers/@aufrom')
-        names += REXML::XPath.match(res, "//u").map { |x| x.attributes["name"] }
-      end while aufrom
-      names
+      iterate_query('allusers', '//u', 'name', 'aufrom', options.merge(
+        'aulimit' => @options[:limit]
+      ))
     end
 
     # Get user contributions
@@ -391,20 +386,16 @@ module MediaWiki
     # Returns array of hashes containing the "item" attributes defined here: http://www.mediawiki.org/wiki/API:Usercontribs
     def contributions(user, count = nil, options = {})
       result = []
-      ucstart = options[:ucstart] or nil 
-      begin
-        limit = [count, @options[:limit]].compact.min
-        form_data = options.merge(
-          {'action' => 'query',
-          'list' => 'usercontribs',
-          'ucuser' => user,
-          'ucstart' => ucstart,
-          'uclimit' => limit})
-        res, ucstart = make_api_request(form_data, '//query-continue/usercontribs/@ucstart')
-        result += REXML::XPath.match(res, "//item").map { |x| x.attributes.inject({}) { |hash, data| hash[data.first] = data.last; hash } }
-        break if count and result.size >= count
-      end while ucstart
-      result
+
+      iterate_query('usercontribs', '//item', nil, 'uccontinue', options.merge(
+        'ucuser'  => user,
+        'uclimit' => @options[:limit]
+      )) { |element|
+        result << hash = {}
+        element.attributes.each { |key, value| hash[key] = value }
+      }
+
+      count ? result.take(count) : result
     end
 
     # Upload a file, or get the status of pending uploads. Several
@@ -490,27 +481,33 @@ module MediaWiki
     # 
     # _article_or_pageid_ is the title or pageid of a single article
     # _imlimit_ is the maximum number of images to return (defaults to 200)
+    # _options_ is the hash of additional options
     #
     # Example:
     #   images = mw.images('Gaborone')
     # _images_ would contain ['File:Gaborone at night.jpg', 'File:Gaborone2.png', ...]
+    def images(article_or_pageid, imlimit = 200, options = {})
+      form_data = options.merge(
+        'action'    => 'query',
+        'prop'      => 'images',
+        'imlimit'   => imlimit,
+        'redirects' => true
+      )
 
-    def images(article_or_pageid, imlimit = 200)
-      form_data = {'action' => 'query', 'prop' => 'images', 'imlimit' => imlimit, 'redirects' => true}
       case article_or_pageid
       when Fixnum
         form_data['pageids'] = article_or_pageid
       else
         form_data['titles'] = article_or_pageid
       end
-      xml, dummy = make_api_request(form_data)
+      xml, _ = make_api_request(form_data)
       page = xml.elements["query/pages/page"]
       if valid_page? page
         if xml.elements["query/redirects/r"]
           # We're dealing with redirect here.
           images(page.attributes["pageid"].to_i, imlimit)
         else
-          imgs = REXML::XPath.match(page, "images/im").map { |x| x.attributes["title"] }
+          REXML::XPath.match(page, "images/im").map { |x| x.attributes["title"] }
         end
       else
         nil
@@ -521,18 +518,25 @@ module MediaWiki
     # 
     # _article_or_pageid_ is the title or pageid of a single article
     # _lllimit_ is the maximum number of langlinks to return (defaults to 500, the maximum)
+    # _options_ is the hash of additional options
     #
     # Example:
     #   langlinks = mw.langlinks('Jerusalem')
-    def langlinks(article_or_pageid, lllimit = 500)
-      form_data = {'action' => 'query', 'prop' => 'langlinks', 'lllimit' => lllimit, 'redirects' => true}
+    def langlinks(article_or_pageid, lllimit = 500, options = {})
+      form_data = options.merge(
+        'action'    => 'query',
+        'prop'      => 'langlinks',
+        'lllimit'   => lllimit,
+        'redirects' => true
+      )
+
       case article_or_pageid
       when Fixnum
         form_data['pageids'] = article_or_pageid
       else
         form_data['titles'] = article_or_pageid
       end
-      xml, dummy = make_api_request(form_data)
+      xml, _ = make_api_request(form_data)
       page = xml.elements["query/pages/page"]
       if valid_page? page
         if xml.elements["query/redirects/r"]
@@ -604,7 +608,7 @@ module MediaWiki
         form_data['titles'] = "File:#{file_name_or_page_id}"
       end
 
-      xml, dummy = make_api_request(form_data)
+      xml, _ = make_api_request(form_data)
       page = xml.elements["query/pages/page"]
       if valid_page? page
         if xml.elements["query/redirects/r"]
@@ -635,34 +639,47 @@ module MediaWiki
     # Imports a MediaWiki XML dump
     #
     # [xml] String or array of page names to fetch
+    # [options] Hash of additional options
     #
     # Returns XML array <api><import><page/><page/>...
     # <page revisions="1"> (or more) means successfully imported
     # <page revisions="0"> means duplicate, not imported
-    def import(xmlfile)
-      form_data = { "action"  => "import",
-        "xml"     => File.new(xmlfile),
-        "token"   => get_token('import', 'Main Page'), # NB: dummy page name
-        "format"  => 'xml' }
-      make_api_request(form_data)
+    def import(xmlfile, options = {})
+      make_api_request(options.merge(
+        'action'  => 'import',
+        'xml'     => File.new(xmlfile),
+        'token'   => get_token('import', 'Main Page'), # NB: dummy page name
+        'format'  => 'xml'
+      ))
     end
 
     # Exports a page or set of pages
     #
     # [page_titles] String or array of page titles to fetch
+    # [options] Hash of additional options
     #
     # Returns MediaWiki XML dump
-    def export(page_titles)
-      form_data = {'action' => 'query', 'titles' => [page_titles].join('|'), 'export' => nil, 'exportnowrap' => nil}
-      make_api_request(form_data).first
+    def export(page_titles, options = {})
+      make_api_request(options.merge(
+        'action'       => 'query',
+        'titles'       => Array(page_titles).join('|'),
+        'export'       => nil,
+        'exportnowrap' => nil
+      )).first
     end
 
     # Get a list of all known namespaces
     #
+    # [options] Hash of additional options
+    #
     # Returns array of namespaces (name => id)
-    def namespaces_by_prefix
-      form_data = { 'action' => 'query', 'meta' => 'siteinfo', 'siprop' => 'namespaces' }
-      res = make_api_request(form_data)
+    def namespaces_by_prefix(options = {})
+      res = make_api_request(options.merge(
+        'action' => 'query',
+        'meta'   => 'siteinfo',
+        'siprop' => 'namespaces'
+      )).first
+
       REXML::XPath.match(res, "//ns").inject(Hash.new) do |namespaces, namespace|
         prefix = namespace.attributes["canonical"] || ""
         namespaces[prefix] = namespace.attributes["id"].to_i
@@ -672,10 +689,16 @@ module MediaWiki
 
     # Get a list of all installed (and registered) extensions
     #
+    # [options] Hash of additional options
+    #
     # Returns array of extensions (name => version)
-    def extensions
-      form_data = { 'action' => 'query', 'meta' => 'siteinfo', 'siprop' => 'extensions' }
-      res = make_api_request(form_data)
+    def extensions(options = {})
+      res = make_api_request(options.merge(
+        'action' => 'query',
+        'meta'   => 'siteinfo',
+        'siprop' => 'extensions'
+      )).first
+
       REXML::XPath.match(res, "//ext").inject(Hash.new) do |extensions, extension|
         name = extension.attributes["name"] || ""
         extensions[name] = extension.attributes["version"]
@@ -688,11 +711,18 @@ module MediaWiki
     # [user] Username to send mail to (name only: eg. 'Bob', not 'User:Bob')
     # [subject] Subject of message
     # [content] Content of message
+    # [options] Hash of additional options
     #
     # Will raise a 'noemail' APIError if the target user does not have a confirmed email address, see http://www.mediawiki.org/wiki/API:E-mail for details.
-    def email_user(user, subject, text)
-      form_data = { 'action' => 'emailuser', 'target' => user, 'subject' => subject, 'text' => text, 'token' => get_token('email', "User:" + user) }
-      res, dummy = make_api_request(form_data)
+    def email_user(user, subject, text, options = {})
+      res = make_api_request(options.merge(
+        'action'  => 'emailuser',
+        'target'  => user,
+        'subject' => subject,
+        'text'    => text,
+        'token'   => get_token('email', "User:#{user}")
+      )).first
+
       res.elements['emailuser'].attributes['result'] == 'Success'
     end
 
@@ -700,33 +730,33 @@ module MediaWiki
     #
     # [query] Semantic Mediawiki query
     # [params] Array of additional parameters or options, eg. mainlabel=Foo or ?Place (optional)
+    # [options] Hash of additional options
     #
     # Returns result as an HTML string
-    def semantic_query(query, params = [])
-			if extensions.include? 'Semantic MediaWiki'
-				smw_version = extensions['Semantic MediaWiki'].to_f
-				if smw_version >= 1.7
-					form_data = { 'action' => 'ask', 'query' => "#{query}|#{params.join('|')}"}
-					xml, dummy = make_api_request(form_data)
-					return xml
-				else
-					params << "format=list"
-					form_data = { 'action' => 'parse', 'prop' => 'text', 'text' => "{{#ask:#{query}|#{params.join('|')}}}" }
-					xml, dummy = make_api_request(form_data)
-					return xml.elements["parse/text"].text
-				end
-			else
-				raise MediaWiki::Exception.new "Semantic MediaWiki extension not installed."
-			end
+    def semantic_query(query, params = [], options = {})
+      unless smw_version = extensions['Semantic MediaWiki']
+        raise MediaWiki::Exception, 'Semantic MediaWiki extension not installed.'
+      end
+
+      if smw_version.to_f >= 1.7
+        make_api_request(options.merge(
+          'action' => 'ask',
+          'query'  => "#{query}|#{params.join('|')}"
+        )).first
+      else
+        make_api_request(options.merge(
+          'action' => 'parse',
+          'prop'   => 'text',
+          'text'   => "{{#ask:#{query}|#{params.push('format=list').join('|')}}}"
+        )).first.elements['parse/text'].text
+      end
     end
 
     # Create a new account
     #
     # [options] is +Hash+ passed as query arguments. See https://www.mediawiki.org/wiki/API:Account_creation#Parameters for more information.
     def create_account(options)
-      form_data = options.merge({ 'action' => 'createaccount' })
-      res, dummy = make_api_request(form_data)
-      res
+      make_api_request(options.merge('action' => 'createaccount')).first
     end
 
     # Sets options for currenlty logged in user
@@ -735,8 +765,12 @@ module MediaWiki
     # [optionname] a +String+ indicating which option to change (optional)
     # [optionvalue] the new value for optionname - allows pipe characters (optional)
     # [reset] a +Boolean+ indicating if all preferences should be reset to site defaults (optional)
-    def options(changes = {}, optionname = nil, optionvalue = nil, reset = false)
-      form_data = { 'action' => 'options', 'token' => get_options_token }
+    # [options] Hash of additional options
+    def options(changes = {}, optionname = nil, optionvalue = nil, reset = false, options = {})
+      form_data = options.merge(
+        'action' => 'options',
+        'token'  => get_options_token
+      )
 
       if changes.present?
         form_data['change'] = changes.map { |key, value| "#{key}=#{value}" }.join('|')
@@ -750,8 +784,7 @@ module MediaWiki
         form_data['reset'] = true
       end
 
-      res, dummy = make_api_request(form_data)
-      res
+      make_api_request(form_data).first
     end
 
     # Set groups for a user
@@ -759,9 +792,10 @@ module MediaWiki
     # [user] Username of user to modify
     # [groups_to_add] Groups to add user to, as an array or a string if a single group (optional)
     # [groups_to_remove] Groups to remove user from, as an array or a string if a single group (optional)
-    def set_groups(user, groups_to_add = [], groups_to_remove = [], comment = '')
+    # [options] Hash of additional options
+    def set_groups(user, groups_to_add = [], groups_to_remove = [], comment = '', options = {})
       token = get_userrights_token(user)
-      userrights(user, token, groups_to_add, groups_to_remove, comment)
+      userrights(user, token, groups_to_add, groups_to_remove, comment, options)
     end
 
     # Review current revision of an article (requires FlaggedRevisions extension, see http://www.mediawiki.org/wiki/Extension:FlaggedRevs)
@@ -769,12 +803,20 @@ module MediaWiki
     # [title] Title of article to review
     # [flags] Hash of flags and values to set, eg. { "accuracy" => "1", "depth" => "2" }
     # [comment] Comment to add to review (optional)
-    def review(title, flags, comment = "Reviewed by MediaWiki::Gateway")
+    # [options] Hash of additional options
+    def review(title, flags, comment = "Reviewed by MediaWiki::Gateway", options = {})
       raise APIError.new('missingtitle', "Article #{title} not found") unless revid = revision(title)
-      form_data = {'action' => 'review', 'revid' => revid, 'token' => get_token('edit', title), 'comment' => comment}
-      form_data.merge!( Hash[flags.map {|k,v| ["flag_#{k}", v]}] )
-      res, dummy = make_api_request(form_data)
-      res
+
+      form_data = options.merge(
+        'action'  => 'review',
+        'revid'   => revid,
+        'token'   => get_token('edit', title),
+        'comment' => comment
+      )
+
+      flags.each { |k, v| form_data["flag_#{k}"] = v }
+
+      make_api_request(form_data).first
     end
 
     private
@@ -782,7 +824,7 @@ module MediaWiki
     # Fetch token (type 'delete', 'edit', 'email', 'import', 'move', 'protect')
     def get_token(type, page_titles)
       form_data = {'action' => 'query', 'prop' => 'info', 'intoken' => type, 'titles' => page_titles}
-      res, dummy = make_api_request(form_data)
+      res, _ = make_api_request(form_data)
       token = res.elements["query/pages/page"].attributes[type + "token"]
       raise Unauthorized.new "User is not permitted to perform this operation: #{type}" if token.nil?
       token
@@ -790,7 +832,7 @@ module MediaWiki
 
     def get_undelete_token(page_titles)
       form_data = {'action' => 'query', 'list' => 'deletedrevs', 'prop' => 'info', 'drprop' => 'token', 'titles' => page_titles}
-      res, dummy = make_api_request(form_data)
+      res, _ = make_api_request(form_data)
       if res.elements["query/deletedrevs/page"]
         token = res.elements["query/deletedrevs/page"].attributes["token"]
         raise Unauthorized.new "User is not permitted to perform this operation: #{type}" if token.nil?
@@ -803,7 +845,7 @@ module MediaWiki
     # User rights management (aka group assignment)
     def get_userrights_token(user)
       form_data = {'action' => 'query', 'list' => 'users', 'ustoken' => 'userrights', 'ususers' => user}
-      res, dummy = make_api_request(form_data)
+      res, _ = make_api_request(form_data)
       token = res.elements["query/users/user"].attributes["userrightstoken"]
 
       @log.debug("RESPONSE: #{res.to_s}")
@@ -820,26 +862,28 @@ module MediaWiki
 
     def get_options_token
       form_data = { 'action' => 'tokens', 'type' => 'options' }
-      res, dummy = make_api_request(form_data)
+      res, _ = make_api_request(form_data)
       res.elements['tokens'].attributes['optionstoken']
     end
 
-    def userrights(user, token, groups_to_add, groups_to_remove, reason)
+    def userrights(user, token, groups_to_add, groups_to_remove, reason, options = {})
       # groups_to_add and groups_to_remove can be a string or an array. Turn them into MediaWiki's pipe-delimited list format.
       if groups_to_add.is_a? Array
         groups_to_add = groups_to_add.join('|')
       end
+
       if groups_to_remove.is_a? Array
         groups_to_remove = groups_to_remove.join('|')
       end
 
-      form_data = {'action' => 'userrights', 'user' => user, 'token' => token,
-        'add' => groups_to_add,
+      make_api_request(options.merge(
+        'action' => 'userrights',
+        'user'   => user,
+        'token'  => token,
+        'add'    => groups_to_add,
         'remove' => groups_to_remove,
         'reason' => reason
-      }
-      res, dummy = make_api_request(form_data)
-      res
+      )).first
     end
 
 
@@ -867,6 +911,39 @@ module MediaWiki
       make_api_request(form_data).first.elements['query']
     end
 
+    # Iterate over query results
+    #
+    # [list] list name to query
+    # [res_xpath] XPath selector for results
+    # [attr] attribute name to extract, if any
+    # [param] parameter name to continue query
+    # [options] additional query options
+    #
+    # Yields each attribute value, or, if +attr+ is nil, each REXML::Element.
+    def iterate_query(list, res_xpath, attr, param, options, &block)
+      items, block = [], lambda { |item| items << item } unless block
+
+      attribute_names = %w[from continue].map { |name|
+        "name()='#{param[0, 2]}#{name}'"
+      }
+
+      req_xpath = "//query-continue/#{list}/@*[#{attribute_names.join(' or ')}]"
+      res_xpath = "//query/#{list}/#{res_xpath}" unless res_xpath.start_with?('/')
+
+      options, continue = options.merge('action' => 'query', 'list' => list), nil
+
+      loop {
+        res, continue = make_api_request(options, req_xpath)
+
+        REXML::XPath.match(res, res_xpath).each { |element|
+          block[attr ? element.attributes[attr] : element]
+        }
+
+        continue ? options[param] = continue : break
+      }
+
+      items
+    end
 
     # Make generic request to API
     #
@@ -912,23 +989,24 @@ module MediaWiki
               elsif action == 'createaccount'
                 raise Unauthorized.new("Account creation failed: #{action_result}")
               end
-            end
+          end
         end
-
-        continue = (continue_xpath and doc.elements['query-continue']) ? REXML::XPath.first(doc, continue_xpath).value : nil
+        continue = (continue_xpath and doc.elements['query-continue']) ? REXML::XPath.first(doc, continue_xpath) : nil
         return [doc, continue]
       end
     end
 
     # Execute the HTTP request using either GET or POST as appropriate
     def http_send url, form_data, headers, &block
+      opts = @http_options.merge(:url => url, :headers => headers)
+
       if form_data['action'] == 'query'
         log.debug("GET: #{form_data.inspect}, #{@cookies.inspect}")
         headers[:params] = form_data
-        RestClient.get url, headers, &block
+        RestClient::Request.execute(opts.update(:method => :get), &block)
       else
         log.debug("POST: #{form_data.inspect}, #{@cookies.inspect}")
-        RestClient.post url, form_data, headers, &block
+        RestClient::Request.execute(opts.update(:method => :post, :payload => form_data), &block)
       end
     end
 
@@ -939,7 +1017,7 @@ module MediaWiki
       begin
         res = res.force_encoding("UTF-8") if res.respond_to?(:force_encoding)
         doc = REXML::Document.new(res).root
-      rescue REXML::ParseException => e
+      rescue REXML::ParseException
         raise MediaWiki::Exception.new "Response is not XML.  Are you sure you are pointing to api.php?"
       end
       log.debug("RES: #{doc}")

data/lib/media_wiki/utils.rb

@@ -21,7 +21,7 @@ module MediaWiki
     # [title] Page name string in Wiki format 
     def get_path_to_subpage(title)
       return nil unless title and title.include? '/'
-      parts = title.split(/\/([^\/]*)$/).first
+      title.split(/\/([^\/]*)$/).first
     end
 
     # Extract subpage name.  If there is no hierarchy above, return page name.

data/mediawiki-gateway.gemspec

@@ -2,21 +2,21 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: mediawiki-gateway 0.6.0 ruby lib
+# stub: mediawiki-gateway 0.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mediawiki-gateway"
-  s.version = "0.6.0"
+  s.version = "0.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Jani Patokallio"]
-  s.date = "2014-03-25"
+  s.date = "2014-07-28"
   s.description = ""
   s.email = "jpatokal@iki.fi"
   s.extra_rdoc_files = [
     "LICENSE",
-    "README"
+    "README.md"
   ]
   s.files = [
     ".ruby-version",
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
-    "README",
+    "README.md",
     "Rakefile",
     "config/hosts.yml",
     "lib/media_wiki.rb",
@@ -70,6 +70,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rr>, [">= 0"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 1.3"])
+      s.add_development_dependency(%q<rspec-core>, [">= 0"])
+      s.add_development_dependency(%q<rspec-expectations>, [">= 0"])
+      s.add_development_dependency(%q<rspec-mocks>, [">= 0"])
       s.add_development_dependency(%q<debugger>, [">= 0"])
       s.add_development_dependency(%q<sinatra>, [">= 0"])
       s.add_development_dependency(%q<activemodel>, [">= 0"])
@@ -82,6 +85,9 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rr>, [">= 0"])
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 1.3"])
+      s.add_dependency(%q<rspec-core>, [">= 0"])
+      s.add_dependency(%q<rspec-expectations>, [">= 0"])
+      s.add_dependency(%q<rspec-mocks>, [">= 0"])
       s.add_dependency(%q<debugger>, [">= 0"])
       s.add_dependency(%q<sinatra>, [">= 0"])
       s.add_dependency(%q<activemodel>, [">= 0"])
@@ -95,6 +101,9 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rr>, [">= 0"])
     s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 1.3"])
+    s.add_dependency(%q<rspec-core>, [">= 0"])
+    s.add_dependency(%q<rspec-expectations>, [">= 0"])
+    s.add_dependency(%q<rspec-mocks>, [">= 0"])
     s.add_dependency(%q<debugger>, [">= 0"])
     s.add_dependency(%q<sinatra>, [">= 0"])
     s.add_dependency(%q<activemodel>, [">= 0"])

data/spec/fake_media_wiki/api_pages.rb

@@ -64,9 +64,9 @@ module FakeMediaWiki
   end
 
   class ApiToken
-    ADMIN_TOKEN   = "admin_token+\\" 
-    REGULAR_TOKEN = "regular_token+\\"
-    BLANK_TOKEN   = "+\\"
+    ADMIN_TOKEN   = "admin_token+\\"   unless const_defined?(:ADMIN_TOKEN)
+    REGULAR_TOKEN = "regular_token+\\" unless const_defined?(:REGULAR_TOKEN)
+    BLANK_TOKEN   = "+\\"              unless const_defined?(:BLANK_TOKEN)
 
     def initialize(params)
       @token_str = params[:token]

data/spec/gateway_spec.rb

@@ -3,11 +3,8 @@ require 'spec_helper'
 # Kickstart fake media wiki app
 require 'sham_rack'
 require_relative 'fake_media_wiki/app'
-$fake_media_wiki = FakeMediaWiki::App.new
-unless $fake_media_wiki.instance_of? FakeMediaWiki::App
-  # This is a horrible workaround for some bizarre conflict with later versions of ShamRack/Rack/Sinatra/Builder/...
-  $fake_media_wiki = $fake_media_wiki.instance_eval('app').instance_eval('@app').instance_eval('@app').app.app.app.app.app
-end
+
+$fake_media_wiki = FakeMediaWiki::App.new!
 ShamRack.mount($fake_media_wiki, 'dummy-wiki.example')
 
 describe MediaWiki::Gateway do
@@ -190,22 +187,26 @@ describe MediaWiki::Gateway do
     describe "when wiki returns 503" do
 
       before do
-        @log = Object.new
-        stub(@log).debug { }
-        stub(@log).warn { }
+        @log = double(:debug => nil, :warn => nil)
         @fail_gateway = MediaWiki::Gateway.new('http://dummy-wiki.example/w/api.php', {:maxlag => -1, :retry_delay => 0})
-        stub(@fail_gateway).log { @log }
+        allow(@fail_gateway).to receive(:log) { @log }
       end
 
       it "should retry twice and fail" do
         lambda {
           @fail_gateway.get("")
         }.should raise_error
-        @log.should have_received.warn("503 Service Unavailable: Maxlag exceeded.  Retry in 0 seconds.").times(2)
+        @log.should have_received(:warn).with("503 Service Unavailable: Maxlag exceeded.  Retry in 0 seconds.").twice
       end
 
     end
 
+    it "should pass options to RestClient::Request" do
+      gateway = MediaWiki::Gateway.new('http://dummy-wiki.example/w/api.php', {}, :verify_ssl => false)
+      RestClient::Request.should receive(:execute).with(hash_including(:verify_ssl => false)).and_return([double(:elements => {})])
+      gateway.get("").should be_nil
+    end
+
   end
 
   describe "#redirect?" do
@@ -213,7 +214,7 @@ describe MediaWiki::Gateway do
     describe "for an existing redirect page" do
 
       it "returns true" do
-        @gateway.redirect?("Redirect").should be_true
+        @gateway.redirect?("Redirect").should == true
       end
 
     end
@@ -221,7 +222,7 @@ describe MediaWiki::Gateway do
     describe "for an existing non-redirect page" do
 
       it "returns false" do
-        @gateway.redirect?("Main Page").should be_false
+        @gateway.redirect?("Main Page").should == false
       end
 
     end
@@ -229,7 +230,7 @@ describe MediaWiki::Gateway do
     describe "for a missing wiki page" do
 
       it "returns false" do
-        @gateway.redirect?("page/missing").should be_false
+        @gateway.redirect?("page/missing").should == false
       end
 
     end
@@ -389,19 +390,20 @@ describe MediaWiki::Gateway do
     describe "when uploading a new file" do
 
       before do
-        stub(File).new(anything) { "SAMPLEIMAGEDATA" }
-        @page = @gateway.upload("some/path/sample_image.jpg")
+        @path = 'some/path/sample_image.jpg'
+        allow(File).to receive(:new).with(@path).and_return('SAMPLEIMAGEDATA')
+        @page = @gateway.upload(@path)
       end
 
       it "should open the file" do
-        File.should have_received.new("some/path/sample_image.jpg")
+        File.should have_received(:new).with(@path)
       end
 
       it "should upload the file" do
         expected = <<-XML
           <api>
             <upload result="Success" filename="sample_image.jpg"/>
-         </api>
+          </api>
         XML
         Hash.from_xml(@page.first.to_s).should == Hash.from_xml(expected)
       end
@@ -617,7 +619,7 @@ describe MediaWiki::Gateway do
       end
 
       it "should return at most the maximum number of results asked" do
-        @search.should have(1).string
+        @search.size.should == 1
       end
     end
 

data/spec/spec_helper.rb

@@ -1,12 +1,17 @@
-require 'simplecov'  
-SimpleCov.start
+begin
+  require 'simplecov'
+  SimpleCov.start
+rescue LoadError
+  warn 'SimpleCov not available. Install it with: gem install simplecov'
+end
 
 require 'media_wiki'
 
-require 'rr'
-Spec::Runner.configure do |config|
-  config.mock_with RR::Adapters::Rspec
-end
+RSpec.configure { |config|
+  %w[expect mock].each { |what|
+    config.send("#{what}_with", :rspec) { |c| c.syntax = [:should, :expect] }
+  }
+}
 
 # :nodoc: Rails 2.3.x: Hash#to_xml is defined in active_support
 # :nodoc: Rails 3: #to_xml is defined in ActiveModel::Serializers::Xml

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Jani Patokallio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -122,6 +122,48 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: debugger
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +212,14 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README
+- README.md
 files:
 - .ruby-version
 - .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README
+- README.md
 - Rakefile
 - config/hosts.yml
 - lib/media_wiki.rb
@@ -225,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Connect to the mediawiki API