mediawiki-gateway 0.3.3 → 0.3.4

data/doc/created.rid

@@ -1 +1 @@
-Thu, 27 Jan 2011 16:07:00 +1100
+Mon, 07 Feb 2011 12:14:29 +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>Thu Jan 27 16:03:42 +1100 2011</td>
+      <td>Mon Feb 07 12:13:27 +1100 2011</td>
     </tr>
     </table>
   </div>

data/doc/fr_method_index.html

@@ -20,7 +20,7 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/MediaWiki/Config.html#M000032">abort (MediaWiki::Config)</a><br />
+    <a href="classes/MediaWiki/Config.html#M000034">abort (MediaWiki::Config)</a><br />
     <a href="classes/MediaWiki/Gateway.html#M000016">backlinks (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki/Gateway.html#M000011">create (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki/Gateway.html#M000013">delete (MediaWiki::Gateway)</a><br />
@@ -41,8 +41,8 @@
     <a href="classes/MediaWiki/Gateway.html#M000029">make_api_request (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki/Gateway.html#M000012">move (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki/Gateway.html#M000024">namespaces_by_prefix (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Config.html#M000033">new (MediaWiki::Config)</a><br />
     <a href="classes/MediaWiki/Gateway.html#M000007">new (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Config.html#M000031">new (MediaWiki::Config)</a><br />
     <a href="classes/MediaWiki/Gateway.html#M000019">redirect? (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki/Gateway.html#M000010">render (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki/Gateway.html#M000017">search (MediaWiki::Gateway)</a><br />
@@ -50,7 +50,9 @@
     <a href="classes/MediaWiki/Gateway.html#M000014">undelete (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki/Gateway.html#M000018">upload (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki.html#M000004">uri_to_wiki (MediaWiki)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000031">valid_page? (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki.html#M000006">version (MediaWiki)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000032">warning (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki.html#M000005">wiki_to_uri (MediaWiki)</a><br />
   </div>
 </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.3.3"
+  VERSION = "0.3.4"
 end

data/lib/media_wiki/gateway.rb

@@ -15,6 +15,7 @@ module MediaWiki
     # [options] Hash of options
     #
     # Options:
+    # [:ignorewarnings] Log API warnings and invalid page titles, instead of aborting with an error.
     # [: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.
@@ -60,9 +61,7 @@ module MediaWiki
     def get(page_title)
       form_data = {'action' => 'query', 'prop' => 'revisions', 'rvprop' => 'content', 'titles' => page_title}
       page = make_api_request(form_data).first.elements["query/pages/page"]
-      if ! page or page.attributes["missing"]
-        nil
-      else
+      if valid_page? page
         page.elements["revisions/rev"].text || ""
       end
     end
@@ -119,7 +118,14 @@ module MediaWiki
       form_data['createonly'] = "" unless options[:overwrite]
       make_api_request(form_data)
     end
-    
+
+    # Edit page
+    #
+    # Same options as create, but always overwrites existing pages (and creates them if they don't exist already).
+    def edit(title, content, options)
+      create(title, content, {:overwrite => true}.merge(options))
+    end
+
     # Move a page to a new title
     #
     # [from] Old page name
@@ -317,7 +323,7 @@ module MediaWiki
     def redirect?(page_title)
       form_data = {'action' => 'query', 'prop' => 'info', 'titles' => page_title}
       page = make_api_request(form_data).first.elements["query/pages/page"]
-      !!(page and page.attributes["redirect"])
+      !!(valid_page?(page) and page.attributes["redirect"])
     end
     
     # Requests image info from MediaWiki. Follows redirects.
@@ -364,13 +370,15 @@ module MediaWiki
 
       xml, dummy = make_api_request(form_data)
       page = xml.elements["query/pages/page"]
-      if ! page or page.attributes["missing"]
-        nil
-      elsif xml.elements["query/redirects/r"]
-        # We're dealing with redirect here.
-        image_info(page.attributes["pageid"].to_i, options)
+      if valid_page? page
+        if xml.elements["query/redirects/r"]
+          # We're dealing with redirect here.
+          image_info(page.attributes["pageid"].to_i, options)
+        else
+          page.elements["imageinfo/ii"].attributes
+        end
       else
-        page.elements["imageinfo/ii"].attributes
+        nil
       end
     end
 
@@ -527,10 +535,29 @@ module MediaWiki
         info = doc.elements["error"].attributes["info"]
         raise "API error: code '#{code}', info '#{info}'"
       end
-      if doc.elements["warnings"] and !@options[:ignorewarnings]
-        raise "API warning: #{doc.elements["warnings"].children.map {|e| e.text}.join(", ")}"
+      if doc.elements["warnings"]
+        warning("API warning: #{doc.elements["warnings"].children.map {|e| e.text}.join(", ")}")
       end
       doc
     end
+    
+    def valid_page?(page)
+      return false unless page
+      return false if page.attributes["missing"]
+      if page.attributes["invalid"]
+        warning("Invalid title '#{page.attributes["title"]}'")
+      else
+        true
+      end
+    end
+    
+    def warning(msg)
+      if @options[:ignorewarnings]
+        log.warn(msg)
+        return false
+      else
+        raise msg
+      end
+    end
   end
 end

data/mediawiki-gateway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mediawiki-gateway}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jani Patokallio"]
-  s.date = %q{2011-01-27}
+  s.date = %q{2011-02-07}
   s.description = %q{}
   s.email = %q{jpatokal@iki.fi}
   s.extra_rdoc_files = [
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     "doc/files/script/get_page_rb.html",
     "doc/files/script/import_xml_rb.html",
     "doc/files/script/run_fake_media_wiki_rb.html",
+    "doc/files/script/search_content_rb.html",
     "doc/files/script/upload_commons_rb.html",
     "doc/files/script/upload_file_rb.html",
     "doc/fr_class_index.html",

data/spec/gateway_spec.rb

@@ -359,6 +359,23 @@ describe MediaWiki::Gateway do
   
   end
 
+  describe "#edit" do
+    before do
+      $fake_media_wiki.reset
+      @edit_page = @gateway.edit("Main Page", "Some new content", :summary => "The summary")
+    end
+        
+    it "should overwrite the existing page" do
+      expected = <<-XML
+      <api>
+        <edit result='Success' pageid='8' title='Main Page' oldrevid='1' newrevid='8'/>
+      </api>
+      XML
+      Hash.from_xml(@edit_page.to_s).should == Hash.from_xml(expected)
+    end
+      
+  end
+
   describe "#upload" do
   
     before do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Jani Patokallio
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-27 00:00:00 +11:00
+date: 2011-02-07 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency