mediawiki-gateway 0.2.1 → 0.2.2

data/doc/created.rid

@@ -1 +1 @@
-Fri, 26 Nov 2010 15:36:02 +1100
+Mon, 13 Dec 2010 14:34:22 +1100

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>Fri Nov 26 12:22:00 +1100 2010</td>
+      <td>Mon Dec 13 14:32:14 +1100 2010</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>Fri Nov 26 15:34:34 +1100 2010</td>
+      <td>Mon Dec 13 13:38:27 +1100 2010</td>
     </tr>
     </table>
   </div>

data/doc/fr_method_index.html

@@ -20,32 +20,36 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/MediaWiki/Config.html#M000026">abort (MediaWiki::Config)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000008">create (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000009">delete (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000015">download (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000017">export (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000019">extensions (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000006">get (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000024">get_response (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000021">get_token (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000022">get_undelete_token (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000014">image_info (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000016">import (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000011">list (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000005">login (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000023">make_api_request (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000018">namespaces_by_prefix (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Config.html#M000025">new (MediaWiki::Config)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000004">new (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000007">render (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000012">search (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000020">semantic_query (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000010">undelete (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000013">upload (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Config.html#M000030">abort (MediaWiki::Config)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000015">backlinks (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000010">create (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000012">delete (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000019">download (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000021">export (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000023">extensions (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000008">get (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki.html#M000001">get_path_to_subpage (MediaWiki)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000028">get_response (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki.html#M000002">get_subpage (MediaWiki)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000025">get_token (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000026">get_undelete_token (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000018">image_info (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000020">import (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000014">list (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000007">login (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000027">make_api_request (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000011">move (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000022">namespaces_by_prefix (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Config.html#M000029">new (MediaWiki::Config)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000006">new (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000009">render (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000016">search (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000024">semantic_query (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000013">undelete (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000017">upload (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki.html#M000003">uri_to_wiki (MediaWiki)</a><br />
-    <a href="classes/MediaWiki.html#M000001">version (MediaWiki)</a><br />
-    <a href="classes/MediaWiki.html#M000002">wiki_to_uri (MediaWiki)</a><br />
+    <a href="classes/MediaWiki.html#M000005">version (MediaWiki)</a><br />
+    <a href="classes/MediaWiki.html#M000004">wiki_to_uri (MediaWiki)</a><br />
   </div>
 </div>
 </body>

data/lib/media_wiki.rb

@@ -1,3 +1,7 @@
 require File.dirname(__FILE__) + '/media_wiki/config'
 require File.dirname(__FILE__) + '/media_wiki/utils'
 require File.dirname(__FILE__) + '/media_wiki/gateway'
+
+module MediaWiki
+  VERSION = "0.2.2"
+end

data/lib/media_wiki/gateway.rb

@@ -105,6 +105,23 @@ module MediaWiki
       make_api_request(form_data)
     end
     
+    # Move a page to a new title
+    #
+    # [from] Old page name
+    # [to] New page name
+    # [options] Hash of additional options
+    #
+    # Options:
+    # * [movesubpages] Move associated subpages
+    # * [movetalk] Move associated talkpages
+    def move(from, to, options={})
+      valid_options = %w(movesubpages movetalk)
+      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
@@ -129,9 +146,9 @@ module MediaWiki
       end
     end
 
-    # Get a list of matching page titles
+    # Get a list of matching page titles in a namespace
     #
-    # [key] Search key, matched as a prefix (^key.*).  May contain or equal a namespace.
+    # [key] Search key, matched as a prefix (^key.*).  May contain or equal a namespace, defaults to main (namespace 0) if none given.
     #
     # Returns array of page titles (empty if no matches)
     def list(key)
@@ -401,7 +418,7 @@ module MediaWiki
 
     private
 
-    # Fetch token (type 'delete', 'edit', 'import')
+    # Fetch token (type 'delete', 'edit', 'import', 'move')
     def get_token(type, page_titles)
       form_data = {'action' => 'query', 'prop' => 'info', 'intoken' => type, 'titles' => page_titles}
       res = make_api_request(form_data)

data/lib/media_wiki/utils.rb

@@ -1,10 +1,33 @@
 module MediaWiki
-
   class << self
 
-    # TODO sync this automatically with Gem version
-    def version
-      "0.2.1"
+    # Extract path leading up to subpage.  If title does not contain a subpage, returns nil.
+    #
+    # Examples:
+    # get_path_to_subpage("Namespace:Foo/Bar/Baz") -> "Namespace:Foo/Bar"
+    # get_path_to_subpage("Namespace:Foo") -> nil
+    #
+    # [title] Page name string in Wiki format 
+    def get_path_to_subpage(title)
+      return nil unless title and title.include? '/'
+      parts = title.split(/\/([^\/]*)$/).first
+    end
+
+    # Extract subpage name.  If there is no hierarchy above, return page name.
+    #
+    # Examples:
+    # get_subpage("Namespace:Foo/Bar/Baz") -> "Baz"
+    # get_subpage("Namespace:Foo") -> "Namespace:Foo"
+    #
+    # [title] Page name string in Wiki format 
+    def get_subpage(title)
+      title.split('/').last if title
+    end
+
+    # Convert URL-ized page name ("getting_there_%26_away") into Wiki display format page name ("getting there & away")
+    # [wiki] Page name string in URL
+    def uri_to_wiki(uri)
+      CGI.unescape(uri).tr('_', ' ') if uri
     end
     
     # Convert a Wiki page name ("getting there & away") to URI-safe format ("getting_there_%26_away"),
@@ -14,12 +37,10 @@ module MediaWiki
       wiki.to_s.split('/').map {|chunk| CGI.escape(chunk.tr(' ', '_')) }.join('/') if wiki
     end
 
-    # Convert URL-ized page name ("getting_there_%26_away") into Wiki display format page name ("getting there & away")
-    # [wiki] Page name string in URL
-    def uri_to_wiki(uri)
-      CGI.unescape(uri).tr('_', ' ') if uri
+    # Return current version of MediaWiki::Gateway
+    def version
+      MediaWiki::VERSION
     end
-
   end
   
 end

data/mediawiki-gateway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mediawiki-gateway}
-  s.version = "0.2.0"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jani Patokallio"]
-  s.date = %q{2010-11-29}
+  s.date = %q{2010-12-13}
   s.description = %q{}
   s.email = %q{jpatokal@iki.fi}
   s.extra_rdoc_files = [
@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
   s.files = [
     "README",
     "Rakefile",
-    "VERSION",
     "config/hosts.yml",
     "doc/classes/MediaWiki.html",
     "doc/classes/MediaWiki/Config.html",

data/spec/utils_spec.rb

@@ -2,6 +2,34 @@ require 'media_wiki'
 
 describe MediaWiki do
 
+  describe '.get_path_to_subpage' do
+    it "should return the everything before the subpage if there are subpages" do
+      MediaWiki.get_path_to_subpage('namespace:base/base/subpage').should == 'namespace:base/base'
+    end
+
+    it "should return nil if there is no subpage" do
+      MediaWiki.get_path_to_subpage('namespace:subpage').should be_nil
+    end
+    
+    it "should pass through nil" do
+      MediaWiki.get_path_to_subpage(nil).should be_nil
+    end    
+  end
+
+  describe '.get_subpage' do
+    it "should return subpage name if there are subpages" do
+      MediaWiki.get_subpage('namespace:base/base/subpage').should == 'subpage'
+    end
+
+    it "should return entire name if there are no subpages" do
+      MediaWiki.get_subpage('namespace:subpage').should == 'namespace:subpage'
+    end
+    
+    it "should pass through nil" do
+      MediaWiki.get_subpage(nil).should be_nil
+    end
+  end
+
   describe '.wiki_to_uri' do
 
     it "should underscore spaces" do
@@ -21,7 +49,7 @@ describe MediaWiki do
     end
 
     it "should pass through nil" do
-      MediaWiki.wiki_to_uri(nil).should == nil
+      MediaWiki.wiki_to_uri(nil).should be_nil
     end
     
   end
@@ -41,7 +69,7 @@ describe MediaWiki do
     end
 
     it "should pass through nil" do
-      MediaWiki.uri_to_wiki(nil).should == nil
+      MediaWiki.uri_to_wiki(nil).should be_nil
     end
     
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Jani Patokallio
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-29 00:00:00 +11:00
+date: 2010-12-13 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,7 +85,6 @@ extra_rdoc_files:
 files: 
 - README
 - Rakefile
-- VERSION
 - config/hosts.yml
 - doc/classes/MediaWiki.html
 - doc/classes/MediaWiki/Config.html

data/VERSION

@@ -1 +0,0 @@
-0.2.1