mediawiki-gateway 0.1.6 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.2.1

data/lib/media_wiki/gateway.rb

@@ -7,6 +7,7 @@ require 'uri'
 module MediaWiki
 
   class Gateway
+    API_MAX_LIMIT = 500
 
     # Set up a MediaWiki::Gateway for a given MediaWiki installation
     #
@@ -40,7 +41,7 @@ module MediaWiki
     #
     # [page_title] Page title to fetch
     #
-    # Returns nil if the page does not exist
+    # 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).elements["query/pages/page"]
@@ -61,7 +62,7 @@ module MediaWiki
     # * [noeditsections] strips all edit-links if set to +true+
     # * [noimages] strips all +img+ tags from the rendered text if set to +true+
     # 
-    # Returns nil if the page does not exist
+    # 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}
 
@@ -116,7 +117,7 @@ module MediaWiki
     #
     # [title] Title of page to undelete
     #
-    # Returns number of revisions undeleted.
+    # Returns number of revisions undeleted, or zero if nothing to undelete
     def undelete(title)
       token = get_undelete_token(title)
       if token
@@ -144,7 +145,7 @@ module MediaWiki
           'list' => 'allpages',
           'apfrom' => apfrom,
           'apprefix' => key,
-          'aplimit' => 500, # max allowed by API
+          'aplimit' => API_MAX_LIMIT,
           'apnamespace' => namespace}
         res = make_api_request(form_data)
         apfrom = res.elements['query-continue'] ? res.elements['query-continue/allpages'].attributes['apfrom'] : nil
@@ -153,6 +154,30 @@ module MediaWiki
       titles
     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)
+    #
+    # 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' => API_MAX_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
+        titles += REXML::XPath.match(res, "//bl").map { |x| x.attributes["title"] }
+      end while blcontinue
+      titles
+    end
+
     # Get a list of pages with matching content in given namespaces
     #
     # [key] Search key
@@ -441,6 +466,5 @@ module MediaWiki
       end
       doc
     end
-
   end
 end

data/lib/media_wiki/utils.rb

@@ -4,7 +4,7 @@ module MediaWiki
 
     # TODO sync this automatically with Gem version
     def version
-      "0.1.6"
+      "0.2.1"
     end
     
     # Convert a Wiki page name ("getting there & away") to URI-safe format ("getting_there_%26_away"),

data/mediawiki-gateway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mediawiki-gateway}
-  s.version = "0.1.6"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jani Patokallio"]
-  s.date = %q{2010-11-26}
+  s.date = %q{2010-11-29}
   s.description = %q{}
   s.email = %q{jpatokal@iki.fi}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
+  - 2
   - 1
-  - 6
-  version: 0.1.6
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jani Patokallio
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-26 00:00:00 +11:00
+date: 2010-11-29 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency