mediawiki-gateway 0.4.5 → 0.5.0

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.4.5"
+  VERSION = "0.5.0"
 end

data/lib/media_wiki/gateway.rb

@@ -6,10 +6,10 @@ require 'uri'
 require 'active_support'
 
 module MediaWiki
-  
+
   class Gateway
     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")
@@ -19,29 +19,31 @@ module MediaWiki
     # [:bot] When set to true, executes API queries with the bot parameter (see http://www.mediawiki.org/wiki/API:Edit#Parameters).  Defaults to false.
     # [:ignorewarnings] Log API warnings and invalid page titles, instead throwing MediaWiki::APIError
     # [: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.
+    # [:logdevice] Log device to use.  Defaults to STDERR
     # [: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 = {
+        :bot => false,
         :limit => 500,
+        :logdevice => STDERR,
         :loglevel => Logger::WARN,
         :maxlag => 5,
         :retry_count => 3,
         :retry_delay => 10,
-        :bot => false
       }
       @options = default_options.merge(options)
       @wiki_url = url
-      @log = Logger.new(STDERR)
+      @log = Logger.new(@options[:logdevice])
       @log.level = @options[:loglevel]
       @headers = { "User-Agent" => "MediaWiki::Gateway/#{MediaWiki::VERSION}" }
       @cookies = {}
     end
-    
+
     attr_reader :base_url, :cookies
-    
+
     # Login to MediaWiki
     #
     # [username] Username
@@ -55,7 +57,7 @@ module MediaWiki
       @password = password
       @username = username
     end
-    
+
     # Fetch MediaWiki page in MediaWiki format.  Does not follow redirects.
     #
     # [page_title] Page title to fetch
@@ -91,7 +93,7 @@ module MediaWiki
     # * [: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 = {})
       form_data = {'action' => 'parse', 'page' => page_title}
@@ -118,7 +120,7 @@ module MediaWiki
       end
       rendered
     end
-        
+
     # Create a new page, or overwrite an existing one
     #
     # [title] Page title to create or overwrite, string
@@ -220,11 +222,11 @@ module MediaWiki
     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)}
-      
+
       form_data = options.merge({'action' => 'move', 'from' => from, 'to' => to, 'token' => get_token('move', from)})
       make_api_request(form_data)
     end
-    
+
     # Delete one page. (MediaWiki API does not support deleting multiple pages at a time.)
     #
     # [title] Title of page to delete
@@ -273,6 +275,28 @@ module MediaWiki
       titles
     end
 
+    # Get a list of pages that are members of a category
+    #
+    # [category] Name of the category
+    # [options] Optional hash of additional options. See http://www.mediawiki.org/wiki/API:Categorymembers
+    #
+    # 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
+    end
+
     # Get a list of pages that link to a target page
     #
     # [title] Link target page
@@ -326,11 +350,11 @@ module MediaWiki
       titles
     end
 
-    # Upload a file, or get the status of pending uploads. Several 
+    # Upload a file, or get the status of pending uploads. Several
     # methods are available:
     #
     # * Upload file contents directly.
-    # * Have the MediaWiki server fetch a file from a URL, using the 
+    # * Have the MediaWiki server fetch a file from a URL, using the
     #   "url" parameter
     #
     # Requires Mediawiki 1.16+
@@ -338,8 +362,8 @@ module MediaWiki
     # Arguments:
     # * [path] Path to file to upload. Set to nil if uploading from URL.
     # * [options] Hash of additional options
-    # 
-    # Note that queries using session keys must be done in the same login 
+    #
+    # Note that queries using session keys must be done in the same login
     # session as the query that originally returned the key (i.e. do not
     # log out and then log back in).
     #
@@ -355,7 +379,7 @@ module MediaWiki
     # * :description     - Description of this file. Used as 'text'.
     # * :target          - Target filename, same as 'filename'.
     # * :summary         - Edit summary for history. Used as 'comment'. Also used as 'text' if neither it or :description is specified.
-    # 
+    #
     # Examples:
     #   mw.upload('/path/to/local/file.jpg', 'filename' => "RemoteFile.jpg")
     #   mw.upload(nil, 'filename' => "RemoteFile2.jpg", 'url' => 'http://remote.com/server/file.jpg')
@@ -404,7 +428,7 @@ module MediaWiki
       page = make_api_request(form_data).first.elements["query/pages/page"]
       !!(valid_page?(page) and page.attributes["redirect"])
     end
-    
+
     # Requests image info from MediaWiki. Follows redirects.
     #
     # _file_name_or_page_id_ should be either:
@@ -461,12 +485,12 @@ module MediaWiki
       end
     end
 
-    # Download _file_name_ (without "File:" or "Image:" prefix). Returns file contents. All options are passed to 
+    # Download _file_name_ (without "File:" or "Image:" prefix). Returns file contents. All options are passed to
     # #image_info however options['iiprop'] is forced to url. You can still
     # set other options to control what file you want to download.
     def download(file_name, options={})
       options['iiprop'] = 'url'
-  
+
       attributes = image_info(file_name, options)
       if attributes
         RestClient.get attributes['url']
@@ -479,7 +503,7 @@ module MediaWiki
     #
     # [xml] String or array of page names to fetch
     #
-    # Returns XML array <api><import><page/><page/>... 
+    # 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)
@@ -525,7 +549,7 @@ module MediaWiki
         extensions
       end
     end
-    
+
     # Execute Semantic Mediawiki query
     #
     # [query] Semantic Mediawiki query
@@ -538,7 +562,7 @@ module MediaWiki
       xml, dummy = make_api_request(form_data)
       return xml.elements["parse/text"].text
     end
-    
+
     # Set groups for a user
     #
     # [user] Username of user to modify
@@ -599,10 +623,10 @@ module MediaWiki
           raise Unauthorized.new "User '#{@username}' is not permitted to perform this operation: get_userrights_token"
         end
       end
-      
+
       token
     end
-    
+
     def userrights(user, token, groups_to_add, groups_to_remove, reason)
       # 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
@@ -620,7 +644,7 @@ module MediaWiki
       res, dummy = make_api_request(form_data)
       res
     end
-    
+
     # Make generic request to API
     #
     # [form_data] hash or string of attributes to post
@@ -634,15 +658,14 @@ module MediaWiki
         form_data['maxlag'] = @options[:maxlag]
         form_data['bot']="1" if @options[:bot]
       end
-      log.debug("REQ: #{form_data.inspect}, #{@cookies.inspect}")
-      RestClient.post(@wiki_url, form_data, @headers.merge({:cookies => @cookies})) do |response, &block|
+      http_send(@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, continue_xpath, retry_count + 1)
         end
         # Check response for errors and return XML
-        raise MediaWiki::Exception.new "Bad response: #{response}" unless response.code >= 200 and response.code < 300 
+        raise MediaWiki::Exception.new "Bad response: #{response}" unless response.code >= 200 and response.code < 300
         doc = get_response(response.dup)
         if(form_data['action'] == 'login')
           login_result = doc.elements["login"].attributes['result']
@@ -657,7 +680,19 @@ module MediaWiki
         return [doc, continue]
       end
     end
-    
+
+    # Execute the HTTP request using either GET or POST as appropriate
+    def http_send url, form_data, headers, &block
+      if form_data['action'] == 'query'
+        log.debug("GET: #{form_data.inspect}, #{@cookies.inspect}")
+        headers[:params] = form_data
+        RestClient.get url, headers, &block
+      else
+        log.debug("POST: #{form_data.inspect}, #{@cookies.inspect}")
+        RestClient.post url, form_data, headers, &block
+      end
+    end
+
     # Get API XML response
     # If there are errors or warnings, raise APIError
     # Otherwise return XML root
@@ -680,7 +715,7 @@ module MediaWiki
       end
       doc
     end
-    
+
     def valid_page?(page)
       return false unless page
       return false if page.attributes["missing"]
@@ -690,7 +725,7 @@ module MediaWiki
         true
       end
     end
-    
+
     def warning(msg)
       if @options[:ignorewarnings]
         log.warn(msg)

data/mediawiki-gateway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mediawiki-gateway"
-  s.version = "0.4.5"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jani Patokallio"]
-  s.date = "2012-04-18"
+  s.date = "2012-06-01"
   s.description = ""
   s.email = "jpatokal@iki.fi"
   s.extra_rdoc_files = [
@@ -46,7 +46,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/jpatokal/mediawiki-gateway"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.24"
   s.summary = "Connect to the mediawiki API"
 
   if s.respond_to? :specification_version then

data/spec/fake_media_wiki/app.rb

@@ -8,7 +8,7 @@ require 'spec/fake_media_wiki/query_handling'
 module FakeMediaWiki
 
   class App < Sinatra::Base
-  
+
     set :show_exceptions, false
     set :environment, :development
 
@@ -16,7 +16,7 @@ module FakeMediaWiki
       reset
       super
     end
-  
+
     def reset
       @sequence_id = 0
 
@@ -24,7 +24,7 @@ module FakeMediaWiki
       add_user('atlasmw', 'wombat', 'local', true)
       add_user('nonadmin', 'sekrit', 'local', false)
       add_user('ldapuser', 'ldappass', 'ldapdomain', false)
-      
+
       @pages = ApiPages.new
       @pages.add('Main Page', 'Content')
       @pages.add('Main 2', 'Content')
@@ -37,7 +37,7 @@ module FakeMediaWiki
       @pages.add('Redirect', '#REDIRECT', true)
 
       @extensions = { 'FooExtension' => 'r1', 'BarExtension' => 'r2' }
-      
+
       @logged_in_users = []
     end
 
@@ -54,14 +54,22 @@ module FakeMediaWiki
         :is_admin => is_admin
       }
     end
-    
+
     def logged_in(username)
       @logged_in_users.include?(username)
     end
 
+    get "/w/api.php" do
+      handle_request if params[:action] == 'query'
+    end
+
     post "/w/api.php" do
+      handle_request
+    end
+
+    def handle_request
       begin
-        halt(503, "Maxlag exceeded") if params[:maxlag].to_i < 0 
+        halt(503, "Maxlag exceeded") if params[:maxlag].to_i < 0
 
         @token = ApiToken.new(params)
         action = params[:action]
@@ -69,7 +77,7 @@ module FakeMediaWiki
           content_type "application/xml"
           return send(action)
         end
-  
+
         halt(404, "Page not found")
       rescue FakeMediaWiki::ApiError => e
         return api_error_response(e.code, e.message)
@@ -127,24 +135,24 @@ module FakeMediaWiki
 
     def undelete
       @token.validate_admin
-      
+
       title = params[:title]
       revisions = @pages.undelete(title)
       api_response do |_|
         _.undelete(nil, {:title => title, :revisions => revisions})
       end
     end
-  
+
     def upload
       @token.validate
-      
+
       filename = params[:filename]
       @pages.add(filename, params[:file])
       api_response do |_|
         _.upload(nil, {:filename => filename, :result => "Success"})
       end
     end
-  
+
     def parse
       page = @pages.get(params[:page])
       api_response do |_|
@@ -161,7 +169,7 @@ module FakeMediaWiki
         end
       end
     end
-    
+
     include QueryHandling
 
     def api_response
@@ -203,7 +211,7 @@ module FakeMediaWiki
         _.page(nil, attributes)
       end
     end
-    
+
     def get_revisions
       query_pages do |_, title, page|
         if page.nil?
@@ -224,11 +232,11 @@ module FakeMediaWiki
       username = request.cookies['login']
       @users[username] if logged_in(username)
     end
-    
+
     def requested_page_titles
       params[:titles].split("|")
     end
-    
+
     def get_token
       token_str = @token.request(user)
       query_pages do |_, title, page|
@@ -255,9 +263,9 @@ module FakeMediaWiki
     def get_userrights_token(username)
       @token.set_type 'userrights'
       token_str = @token.request(user)
-      
+
       user_to_manage = @users[username]
-      
+
       if user_to_manage
         api_response do |_|
           _.query do
@@ -271,7 +279,7 @@ module FakeMediaWiki
           _.error(nil, { :code => 'nosuchuser', :info => "The user '#{params[:ususer].to_s}' does not exist"} )
         end
       end
-    end    
+    end
 
     def login
       user = @users[params[:lgname]]
@@ -312,11 +320,11 @@ module FakeMediaWiki
   end
 
   class WikiPage
-    
+
     def initialize(options={})
       options.each { |k, v| send("#{k}=", v) }
     end
-    
+
     attr_accessor :content, :author
 
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
   - 5
-  version: 0.4.5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Jani Patokallio
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-19 00:00:00 Z
+date: 2012-06-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Connect to the mediawiki API