mediawiki-gateway 0.2.6 → 0.3.0

data/doc/created.rid

@@ -1 +1 @@
-Mon, 13 Dec 2010 14:34:22 +1100
+Thu, 13 Jan 2011 14:03:28 +1100

data/doc/files/README.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Nov 26 10:40:15 +1100 2010</td>
+      <td>Thu Jan 13 14:03:08 +1100 2011</td>
     </tr>
     </table>
   </div>
@@ -70,16 +70,40 @@
 
     <div id="description">
       <h1><a href="../classes/MediaWiki/Gateway.html">MediaWiki::Gateway</a></h1>
-<pre>
- Ruby framework for MediaWiki API manipulation
+<p>
+A Ruby framework for <a href="../classes/MediaWiki.html">MediaWiki</a> API
+manipulation. Features out of the box:
+</p>
+<ul>
+<li>Simple, elegant syntax for common operations
 
- Gem:  http://rubygems.org/gems/mediawiki-gateway
- RDoc: http://rubydoc.info/gems/mediawiki-gateway
-</pre>
+</li>
+<li>Handles login, edit, move etc tokens for you
+
+</li>
+<li>Support for maxlag detection and automated retries on 503
+
+</li>
+<li>Integrated logging
+
+</li>
+<li>Tested up to <a href="../classes/MediaWiki.html">MediaWiki</a> 1.16
+
+</li>
+</ul>
+<p>
+Gem: <a
+href="http://rubygems.org/gems/mediawiki-gateway">rubygems.org/gems/mediawiki-gateway</a>
+RDoc: <a
+href="http://rubydoc.info/gems/mediawiki-gateway">rubydoc.info/gems/mediawiki-gateway</a>
+Git: <a
+href="https://github.com/jpatokal/mediawiki-gateway">github.com/jpatokal/mediawiki-gateway</a>
+</p>
 <h2>Example</h2>
+<p>
+Simple page creation script:
+</p>
 <pre>
- Simple page creation script:
-
  require 'media_wiki'
  mw = MediaWiki::Gateway.new('http://my-wiki.example/w/api.php')
  mw.login('RubyBot', 'pa$$w0rd')
@@ -87,8 +111,11 @@
 </pre>
 <h2>Credits</h2>
 <p>
-Thanks to John Carney, Mike Williams, Dan Heath and the rest of the Lonely
-Planet Atlas team.
+Maintained by Jani Patokallio.
+</p>
+<p>
+Thanks to John Carney, Mike Williams, Daniel Heath and the rest of the
+Lonely Planet Atlas team.
 </p>
 
     </div>

data/doc/files/lib/media_wiki/gateway_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Dec 13 14:32:14 +1100 2010</td>
+      <td>Thu Jan 13 13:54:09 +1100 2011</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/media_wiki/utils_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Dec 13 13:38:27 +1100 2010</td>
+      <td>Thu Jan 13 11:10:57 +1100 2011</td>
     </tr>
     </table>
   </div>

data/lib/media_wiki.rb

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

data/lib/media_wiki/gateway.rb

@@ -5,18 +5,33 @@ require 'rexml/document'
 require 'uri'
 
 module MediaWiki
-
+  
   class Gateway
-    API_MAX_LIMIT = 500
-
+    attr_reader :log
+    
     # Set up a MediaWiki::Gateway for a given MediaWiki installation
     #
     # [url] Path to API of target MediaWiki (eg. "http://en.wikipedia.org/w/api.php")
-    # [loglevel] Log level to use (optional, defaults to Logger::WARN)
-    def initialize(url, loglevel = Logger::WARN)
-      @log = Logger.new(STDERR)
-      @log.level = loglevel
+    # [options] Hash of options
+    #
+    # Options:
+    # [:limit] Maximum number of results returned per search (see http://www.mediawiki.org/wiki/API:Query_-_Lists#Limits), defaults to the MediaWiki default of 500.
+    # [:loglevel] Log level to use, defaults to Logger::WARN.  Set to Logger::DEBUG to dump every request and response to the log.
+    # [: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={})
+      default_options = {
+        :limit => 500,
+        :loglevel => Logger::WARN,
+        :maxlag => 5,
+        :retry_count => 3,
+        :retry_delay => 10
+      }
+      @options = default_options.merge(options)
       @wiki_url = url
+      @log = Logger.new(STDERR)
+      @log.level = @options[:loglevel]
       @headers = { "User-Agent" => "MediaWiki::Gateway/#{MediaWiki::VERSION}" }
       @cookies = {}
     end
@@ -58,9 +73,9 @@ module MediaWiki
     # [options] Hash of additional options
     #
     # Options:
-    # * [linkbase] supply a String to prefix all internal (relative) links with. '/wiki/' is assumed to be the base of a relative link
-    # * [noeditsections] strips all edit-links if set to +true+
-    # * [noimages] strips all +img+ tags from the rendered text if set to +true+
+    # * [:linkbase] supply a String to prefix all internal (relative) links with. '/wiki/' is assumed to be the base of a relative link
+    # * [:noeditsections] strips all edit-links if set to +true+
+    # * [:noimages] strips all +img+ tags from the rendered text if set to +true+
     # 
     # Returns rendered page as string, or nil if the page does not exist
     def render(page_title, options = {})
@@ -96,9 +111,9 @@ module MediaWiki
     # [options] Hash of additional options
     #
     # Options:
-    # * [overwrite] Allow overwriting existing pages
-    # * [summary] Edit summary for history, string
-    # * [token] Use this existing edit token instead requesting a new one (useful for bulk loads)
+    # * [:overwrite] Allow overwriting existing pages
+    # * [:summary] Edit summary for history, string
+    # * [:token] Use this existing edit token instead requesting a new one (useful for bulk loads)
     def create(title, content, options={})
       form_data = {'action' => 'edit', 'title' => title, 'text' => content, 'summary' => (options[:summary] || ""), 'token' => get_token('edit', title)}
       form_data['createonly'] = "" unless options[:overwrite]
@@ -112,12 +127,12 @@ module MediaWiki
     # [options] Hash of additional options
     #
     # Options:
-    # * [movesubpages] Move associated subpages
-    # * [movetalk] Move associated talkpages
-    # * [noredirect] Do not create a redirect page from old name.  Requires the 'suppressredirect' user right, otherwise MW will silently ignore the option and create the redirect anyway.
-    # * [reason] Reason for move
-    # * [watch] Add page and any redirect to watchlist
-    # * [unwatch] Remove page and any redirect from watchlist
+    # * [:movesubpages] Move associated subpages
+    # * [:movetalk] Move associated talkpages
+    # * [:noredirect] Do not create a redirect page from old name.  Requires the 'suppressredirect' user right, otherwise MW will silently ignore the option and create the redirect anyway.
+    # * [:reason] Reason for move
+    # * [:watch] Add page and any redirect to watchlist
+    # * [:unwatch] Remove page and any redirect from watchlist
     def move(from, to, options={})
       valid_options = %w(movesubpages movetalk noredirect reason watch unwatch)
       options.keys.each{|opt| raise ArgumentError.new("Unknown option '#{opt}'") unless valid_options.include?(opt.to_s)}
@@ -166,7 +181,7 @@ module MediaWiki
           'list' => 'allpages',
           'apfrom' => apfrom,
           'apprefix' => key,
-          'aplimit' => API_MAX_LIMIT,
+          'aplimit' => @options[:limit],
           'apnamespace' => namespace}
         res = make_api_request(form_data)
         apfrom = res.elements['query-continue'] ? res.elements['query-continue/allpages'].attributes['apfrom'] : nil
@@ -190,7 +205,7 @@ module MediaWiki
           'list' => 'backlinks',
           'bltitle' => title,
           'blfilterredir' => filter,
-          'bllimit' => API_MAX_LIMIT }
+          'bllimit' => @options[:limit] }
         form_data['blcontinue'] = blcontinue if blcontinue
         res = make_api_request(form_data)
         blcontinue = res.elements['query-continue'] ? res.elements['query-continue/backlinks'].attributes['blcontinue'] : nil
@@ -448,10 +463,18 @@ module MediaWiki
     # [form_data] hash or string of attributes to post
     #
     # Returns XML document
-    def make_api_request(form_data)
-      form_data['format'] = 'xml' if form_data.kind_of? Hash
-      @log.debug("REQ: #{form_data.inspect}, #{@cookies.inspect}")
-      RestClient.post(@wiki_url, form_data, @headers.merge({:cookies => @cookies})) do |response, &block| 
+    def make_api_request(form_data, retry_count=1)
+      if form_data.kind_of? Hash
+        form_data['format'] = 'xml'
+        form_data['maxlag'] = @options[:maxlag]
+      end
+      log.debug("REQ: #{form_data.inspect}, #{@cookies.inspect}")
+      RestClient.post(@wiki_url, form_data, @headers.merge({:cookies => @cookies})) do |response, &block|
+        if response.code == 503 and retry_count < @options[:retry_count]
+          log.warn("503 Service Unavailable: #{response.body}.  Retry in #{@options[:retry_delay]} seconds.")
+          sleep @options[:retry_delay]
+          make_api_request(form_data, retry_count + 1)
+        end
         # Check response for errors and return XML
         raise "API error, bad response: #{response}" unless response.code >= 200 and response.code < 300 
         doc = get_response(response.dup)
@@ -478,7 +501,7 @@ module MediaWiki
       rescue REXML::ParseException => e
         raise "Response is not XML.  Are you sure you are pointing to api.php?"
       end
-      @log.debug("RES: #{doc}")
+      log.debug("RES: #{doc}")
       raise "Response does not contain Mediawiki API XML: #{res}" unless [ "api", "mediawiki" ].include? doc.name
       if doc.elements["error"]
         code = doc.elements["error"].attributes["code"]

data/mediawiki-gateway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mediawiki-gateway}
-  s.version = "0.2.6"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jani Patokallio"]
-  s.date = %q{2010-12-30}
+  s.date = %q{2011-01-13}
   s.description = %q{}
   s.email = %q{jpatokal@iki.fi}
   s.extra_rdoc_files = [
@@ -58,6 +58,7 @@ Gem::Specification.new do |s|
     "spec/fake_media_wiki/query_handling.rb",
     "spec/gateway_spec.rb",
     "spec/import-test-data.xml",
+    "spec/spec_helper.rb",
     "spec/utils_spec.rb"
   ]
   s.homepage = %q{http://github.com/jpatokal/mediawiki-gateway}
@@ -69,6 +70,7 @@ Gem::Specification.new do |s|
     "spec/fake_media_wiki/app.rb",
     "spec/fake_media_wiki/query_handling.rb",
     "spec/gateway_spec.rb",
+    "spec/spec_helper.rb",
     "spec/utils_spec.rb"
   ]
 
@@ -78,20 +80,23 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rest-client>, [">= 0"])
-      s.add_development_dependency(%q<sham_rack>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<sham_rack>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
     else
       s.add_dependency(%q<rest-client>, [">= 0"])
-      s.add_dependency(%q<sham_rack>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<sham_rack>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
     end
   else
     s.add_dependency(%q<rest-client>, [">= 0"])
-    s.add_dependency(%q<sham_rack>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<sham_rack>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
   end
 end
 

data/spec/fake_media_wiki/app.rb

@@ -57,9 +57,11 @@ module FakeMediaWiki
     def logged_in(username)
       @logged_in_users.include?(username)
     end
-        
+
     post "/w/api.php" do
       begin
+        halt(503, "Maxlag exceeded") if params[:maxlag].to_i < 0 
+
         @token = ApiToken.new(params)
         action = params[:action]
         if respond_to?(action)

data/spec/gateway_spec.rb

@@ -1,17 +1,8 @@
-require 'active_support/version'
-if ActiveSupport::VERSION::MAJOR >= 3
-  # :nodoc: Rails 3: #to_xml is defined in ActiveModel::Serializers::Xml
-  require 'active_model'
-  Hash.send(:include, ActiveModel::Serializers::Xml)
-else
-  # :nodoc: Rails 2.3.x: Hash#to_xml is defined in active_support
-  require 'active_support'
-end
-require 'sham_rack'
+require 'spec_helper'
 
-require 'media_wiki'
+# Kickstart fake media wiki app
+require 'sham_rack'
 require 'spec/fake_media_wiki/app'
-
 $fake_media_wiki = FakeMediaWiki::App.new
 ShamRack.mount($fake_media_wiki, 'dummy-wiki.example')
 
@@ -192,6 +183,25 @@ describe MediaWiki::Gateway do
 
     end
 
+    describe "when wiki returns 503" do
+
+      before do
+        @log = Object.new
+        stub(@log).debug { }
+        stub(@log).warn { }
+        @fail_gateway = MediaWiki::Gateway.new('http://dummy-wiki.example/w/api.php', {:maxlag => -1, :retry_delay => 0})
+        stub(@fail_gateway).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)
+      end
+
+    end
+
   end
 
   describe "#render" do
@@ -330,7 +340,6 @@ describe MediaWiki::Gateway do
     describe "when uploading a new file" do
     
       before do
-        pending "stubbing broken in mysterious ways"
         stub(File).new(anything) { "SAMPLEIMAGEDATA" }
         @page = @gateway.upload("some/path/sample_image.jpg")
       end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'media_wiki'
+
+require 'rr'
+Spec::Runner.configure do |config|
+  config.mock_with RR::Adapters::Rspec
+end
+
+require 'active_support/version'
+if ActiveSupport::VERSION::MAJOR >= 3
+  # :nodoc: Rails 3: #to_xml is defined in ActiveModel::Serializers::Xml
+  require 'active_model'
+  Hash.send(:include, ActiveModel::Serializers::Xml)
+else
+  # :nodoc: Rails 2.3.x: Hash#to_xml is defined in active_support
+  require 'active_support'
+end

data/spec/utils_spec.rb

@@ -1,4 +1,4 @@
-require 'media_wiki'
+require 'spec_helper'
 
 describe MediaWiki do
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 6
-  version: 0.2.6
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jani Patokallio
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-30 00:00:00 +11:00
+date: 2011-01-13 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: sham_rack
+  name: activesupport
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -61,7 +61,7 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: sham_rack
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -74,6 +74,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: ""
 email: jpatokal@iki.fi
 executables: []
@@ -125,6 +139,7 @@ files:
 - spec/fake_media_wiki/query_handling.rb
 - spec/gateway_spec.rb
 - spec/import-test-data.xml
+- spec/spec_helper.rb
 - spec/utils_spec.rb
 has_rdoc: true
 homepage: http://github.com/jpatokal/mediawiki-gateway
@@ -165,4 +180,5 @@ test_files:
 - spec/fake_media_wiki/app.rb
 - spec/fake_media_wiki/query_handling.rb
 - spec/gateway_spec.rb
+- spec/spec_helper.rb
 - spec/utils_spec.rb