mediawiki-gateway 0.5.0 → 0.5.1

data/README

@@ -7,7 +7,7 @@ A Ruby framework for MediaWiki API manipulation.  Features out of the box:
 * List, search operations work around API limits to fetch all results
 * Support for maxlag detection and automated retries on 503
 * Integrated logging
-* Tested up to MediaWiki 1.16
+* Tested up to MediaWiki 1.19
 
 Gem:  http://rubygems.org/gems/mediawiki-gateway
 RDoc: http://rubydoc.info/gems/mediawiki-gateway
@@ -28,5 +28,5 @@ Maintained by Jani Patokallio.
 
 Thanks to:
 * John Carney, Mike Williams, Daniel Heath and the rest of the Lonely Planet Atlas team.
-* Github users arturaz, carpodaster, muffinista and singlebrook for code contributions
+* Github users for code contributions, see https://github.com/jpatokal/mediawiki-gateway/pulls 
 

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.5.0"
+  VERSION = "0.5.1"
 end

data/lib/media_wiki/gateway.rb

@@ -38,7 +38,7 @@ module MediaWiki
       @wiki_url = url
       @log = Logger.new(@options[:logdevice])
       @log.level = @options[:loglevel]
-      @headers = { "User-Agent" => "MediaWiki::Gateway/#{MediaWiki::VERSION}" }
+      @headers = { "User-Agent" => "MediaWiki::Gateway/#{MediaWiki::VERSION}", "Accept-Encoding" => "gzip" }
       @cookies = {}
     end
 
@@ -350,6 +350,51 @@ module MediaWiki
       titles
     end
 
+    # Get a list of users
+    #
+    # [options] Optional hash of options, eg. { 'augroup' => 'sysop' }.  See http://www.mediawiki.org/wiki/API:Allusers
+    #
+    # 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
+    end
+
+    # Get user contributions
+    #
+    # user: The user name
+    # count: Maximum number of contributions to retreive, or nil for all
+    # [options] Optional hash of options, eg. { 'ucnamespace' => 4 }.  See http://www.mediawiki.org/wiki/API:Usercontribs
+    #
+    # 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 = 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
+    end
+
     # Upload a file, or get the status of pending uploads. Several
     # methods are available:
     #
@@ -550,6 +595,19 @@ module MediaWiki
       end
     end
 
+    # Sends e-mail to a user
+    #
+    # [user] Username to send mail to (name only: eg. 'Bob', not 'User:Bob')
+    # [subject] Subject of message
+    # [content] Content of message
+    #
+    # 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)
+      res.elements['emailuser'].attributes['result'] == 'Success'
+    end
+
     # Execute Semantic Mediawiki query
     #
     # [query] Semantic Mediawiki query
@@ -557,10 +615,21 @@ module MediaWiki
     #
     # Returns result as an HTML string
     def semantic_query(query, params = [])
-      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
+			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
     end
 
     # Set groups for a user
@@ -588,7 +657,7 @@ module MediaWiki
 
     private
 
-    # Fetch token (type 'delete', 'edit', 'import', 'move', 'protect')
+    # 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)
@@ -645,6 +714,32 @@ module MediaWiki
       res
     end
 
+
+    # Make a custom query
+    #
+    # [options] query options
+    #
+    # Returns the REXML::Element object as result
+    #
+    # Example:
+    #   def creation_time(pagename)
+    #     res = bot.custom_query(:prop => :revisions,
+    #                            :titles => pagename,
+    #                            :rvprop => :timestamp,
+    #                            :rvdir => :newer,
+    #                            :rvlimit => 1)
+    #     timestr = res.get_elements('*/*/*/rev')[0].attribute('timestamp').to_s
+    #     time.parse(timestr)
+    #   end
+    #
+    def custom_query(options)
+      form_data = {}
+      options.each {|k,v| form_data[k.to_s] = v.to_s }
+      form_data['action'] = 'query'
+      make_api_request(form_data).first.elements['query']
+    end
+
+
     # Make generic request to API
     #
     # [form_data] hash or string of attributes to post

data/script/email_user.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# Sample script for sending e-mail to a registered user
+#
+require './lib/media_wiki'
+
+config = MediaWiki::Config.new ARGV
+user, subject = ARGV
+config.abort("Syntax: email_user.rb [username] [subject] <content") unless user and subject
+
+mw = MediaWiki::Gateway.new(config.url, { :loglevel => Logger::DEBUG } )
+mw.login(config.user, config.pw)
+content = STDIN.read
+mw.email_user(user, subject, content)

data/script/semantic_query.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+#
+# Sample script for querying Semantic MediaWiki data
+#
+
+require './lib/media_wiki'
+
+mw = MediaWiki::Gateway.new(ARGV[0])
+
+params = []
+i = 2
+until i == ARGV.length
+	params << ARGV[i]
+	i += 1
+end
+
+puts mw.semantic_query(ARGV[1], params)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 5
-  - 0
-  version: 0.5.0
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Jani Patokallio
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-01 00:00:00 Z
+date: 2012-08-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -182,11 +182,13 @@ files:
 - script/create_page.rb
 - script/delete_batch.rb
 - script/download_batch.rb
+- script/email_user.rb
 - script/export_xml.rb
 - script/get_page.rb
 - script/import_xml.rb
 - script/run_fake_media_wiki.rb
 - script/search_content.rb
+- script/semantic_query.rb
 - script/upload_commons.rb
 - script/upload_file.rb
 - spec/fake_media_wiki/api_pages.rb
@@ -225,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Connect to the mediawiki API