mediawiki-gateway 0.1.0 → 0.1.1

data/doc/index.html

@@ -19,6 +19,6 @@
         <frame src="fr_class_index.html"  name="Classes" />
         <frame src="fr_method_index.html" name="Methods" />
     </frameset>
-    <frame src="files/README_txt.html" name="docwin" />
+    <frame src="files/README.html" name="docwin" />
 </frameset>
 </html>

data/lib/media_wiki/gateway.rb

@@ -152,28 +152,141 @@ module MediaWiki
       titles += REXML::XPath.match(make_api_request(form_data), "//p").map { |x| x.attributes["title"] }
     end
 
-    # Upload file to MediaWiki
+    # 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 
+    #   "url" parameter
+    #
     # Requires Mediawiki 1.16+
     #
-    # [path] Path to file to upload
-    # [options] Hash of additional options
+    # 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 
+    # session as the query that originally returned the key (i.e. do not
+    # log out and then log back in).
     #
     # Options:
-    # * [description] Description of this file
-    # * [target] Target filename, defaults to local name if not given
-    # * [summary] Edit summary for history
+    # * 'filename'       - Target filename (defaults to local name if not given), options[:target] is alias for this.
+    # * 'comment'        - Upload comment. Also used as the initial page text for new files if "text" is not specified.
+    # * 'text'           - Initial page text for new files
+    # * 'watch'          - Watch the page
+    # * 'ignorewarnings' - Ignore any warnings
+    # * 'url'            - Url to fetch the file from. Set path to nil if you want to use this.
+    #
+    # Deprecated but still supported options:
+    # * :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')
+    #
     def upload(path, options={})
-      comment = (options[:summary] || "Uploaded by MediaWiki::Gateway")
-      file = File.new(path)
-      filename = (options[:target] || File.basename(path))
-      form_data = { 'action' => 'upload',
-        'filename' => filename,
-        'file' => file,
-        'token'   => get_token('edit', filename),
-        'text' => (options[:description] || options[:summary]),
-        'comment' => comment}
+      if options[:description]
+        options['text'] = options[:description]
+        options.delete(:description)
+      end
+
+      if options[:target]
+        options['filename'] = options[:target]
+        options.delete(:target)
+      end
+
+      if options[:summary]
+        options['text'] ||= options[:summary]
+        options['comment'] = options[:summary]
+        options.delete(:summary)
+      end
+
+      options['comment'] ||= "Uploaded by MediaWiki::Gateway"
+      options['file'] = File.new(path) if path
+      full_name = path || options['url']
+      options['filename'] ||= File.basename(full_name) if full_name
+
+      raise ArgumentError.new(
+        "One of the 'file', 'url' or 'sessionkey' options must be specified!"
+      ) unless options['file'] || options['url'] || options['sessionkey']
+
+      form_data = options.merge(
+        'action' => 'upload',
+        'token' => get_token('edit', options['filename'])
+      )
+
       make_api_request(form_data)
     end
+    
+    # Requests image info from MediaWiki. Follows redirects.
+    #
+    # _file_name_or_page_id_ should be either:
+    # * a file name (String) you want info about without File: prefix.
+    # * or a Fixnum page id you of the file.
+    #
+    # _options_ is +Hash+ passed as query arguments. See
+    # http://www.mediawiki.org/wiki/API:Query_-_Properties#imageinfo_.2F_ii
+    # for more information.
+    #
+    # options['iiprop'] should be either a string of properties joined by
+    # '|' or an +Array+ (or more precisely something that responds to #join).
+    #
+    # +Hash+ like object is returned where keys are image properties.
+    #
+    # Example:
+    #   mw.image_info(
+    #     "Trooper.jpg", 'iiprop' => ['timestamp', 'user']
+    #   ).each do |key, value|
+    #     puts "#{key.inspect} => #{value.inspect}"
+    #   end
+    #
+    # Output:
+    #   "timestamp" => "2009-10-31T12:59:11Z"
+    #   "user" => "Valdas"
+    #
+    def image_info(file_name_or_page_id, options={})
+      options['iiprop'] = options['iiprop'].join('|') \
+        if options['iiprop'].respond_to?(:join)
+      form_data = options.merge(
+        'action' => 'query',
+        'prop' => 'imageinfo',
+        'redirects' => true
+      )
+
+      case file_name_or_page_id
+      when Fixnum
+        form_data['pageids'] = file_name_or_page_id
+      else
+        form_data['titles'] = "File:#{file_name_or_page_id}"
+      end
+
+      xml = 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)
+      else
+        page.elements["imageinfo/ii"].attributes
+      end
+    end
+
+    # Download _file_name_. 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']
+      else
+        nil
+      end
+    end
 
     # Imports a MediaWiki XML dump
     #

data/mediawiki-gateway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mediawiki-gateway}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jani Patokallio"]
-  s.date = %q{2010-10-01}
+  s.date = %q{2010-10-15}
   s.description = %q{}
   s.email = %q{jpatokal@iki.fi}
   s.extra_rdoc_files = [
@@ -25,16 +25,16 @@ Gem::Specification.new do |s|
      "doc/classes/MediaWiki/Config.html",
      "doc/classes/MediaWiki/Gateway.html",
      "doc/created.rid",
-     "doc/files/README_txt.html",
-     "doc/files/media_wiki/config_rb.html",
-     "doc/files/media_wiki/gateway_rb.html",
-     "doc/files/media_wiki/utils_rb.html",
+     "doc/files/README.html",
+     "doc/files/lib/media_wiki/config_rb.html",
+     "doc/files/lib/media_wiki/gateway_rb.html",
+     "doc/files/lib/media_wiki/utils_rb.html",
      "doc/files/script/create_page_rb.html",
-     "doc/files/script/delete_book_rb.html",
+     "doc/files/script/delete_batch_rb.html",
      "doc/files/script/export_xml_rb.html",
      "doc/files/script/get_page_rb.html",
      "doc/files/script/import_xml_rb.html",
-     "doc/files/script/undelete_page_rb.html",
+     "doc/files/script/run_fake_media_wiki_rb.html",
      "doc/files/script/upload_commons_rb.html",
      "doc/files/script/upload_file_rb.html",
      "doc/fr_class_index.html",
@@ -48,12 +48,11 @@ Gem::Specification.new do |s|
      "lib/media_wiki/utils.rb",
      "mediawiki-gateway.gemspec",
      "script/create_page.rb",
-     "script/delete_book.rb",
+     "script/delete_batch.rb",
      "script/export_xml.rb",
      "script/get_page.rb",
      "script/import_xml.rb",
      "script/run_fake_media_wiki.rb",
-     "script/undelete_page.rb",
      "script/upload_commons.rb",
      "script/upload_file.rb",
      "spec/fake_media_wiki/api_pages.rb",
@@ -80,9 +79,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest_client>, [">= 0"])
     else
+      s.add_dependency(%q<rest_client>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rest_client>, [">= 0"])
   end
 end
 

data/script/create_page.rb

@@ -2,8 +2,7 @@
 #
 # Sample script for fetching a page's current contents in Wiki markup
 #
-require 'media_wiki/gateway'
-require 'media_wiki/config'
+require 'lib/media_wiki'
 
 config = MediaWiki::Config.new ARGV 
 config.abort("Name of article is mandatory.") unless config.article

data/script/{delete_book.rb → delete_batch.rb}

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require 'media_wiki/gateway'
+require 'lib/media_wiki'
 
 if ARGV.length <1
   raise "Syntax: delete_batch.rb <wiki-api-url> <startswith_pattern>"

data/script/export_xml.rb

@@ -2,7 +2,7 @@
 #
 # Export MediaWiki pages as XML
 #
-require 'media_wiki/gateway'
+require 'lib/media_wiki'
 
 if ARGV.length < 3
   raise "Syntax: export_xml.rb <host> <user> <password> [page page page...]"

data/script/get_page.rb

@@ -2,7 +2,7 @@
 #
 # Sample script for fetching a page's current contents in Wiki markup
 #
-require 'media_wiki/gateway'
+require 'lib/media_wiki'
 
 if ARGV.length < 2
   raise "Syntax: get_page.rb <host> <name>"

data/script/import_xml.rb

@@ -2,7 +2,7 @@
 #
 # Import a MediaWiki XML dump 
 #
-require 'media_wiki/gateway'
+require 'lib/media_wiki'
 
 if ARGV.length < 3
   raise "Syntax: import_xml.rb <host> <username> <password> <file>"

data/script/upload_commons.rb

@@ -1,5 +1,4 @@
-require 'lib/media_wiki/gateway'
-require 'lib/media_wiki/config'
+require 'lib/media_wiki'
 
 config = MediaWiki::Config.new(ARGV, "upload")
 file = ARGV[0]

data/script/upload_file.rb

@@ -2,8 +2,7 @@
 #
 # Sample script for fetching a page's current contents in Wiki markup
 #
-require 'media_wiki/gateway'
-require 'media_wiki/config'
+require 'lib/media_wiki'
 
 config = MediaWiki::Config.new(ARGV, "upload")
 config.abort("Name of file to upload is mandatory.") unless ARGV[0]

data/spec/gateway_spec.rb

@@ -2,7 +2,7 @@ require 'active_support'
 require 'rr'
 require 'sham_rack'
 
-require 'media_wiki/gateway'
+require 'media_wiki'
 require 'spec/fake_media_wiki/app'
 
 $fake_media_wiki = FakeMediaWiki::App.new

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jani Patokallio
@@ -15,10 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-01 00:00:00 +10:00
+date: 2010-10-15 00:00:00 +11:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest_client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: ""
 email: jpatokal@iki.fi
 executables: []
@@ -37,16 +50,16 @@ files:
 - doc/classes/MediaWiki/Config.html
 - doc/classes/MediaWiki/Gateway.html
 - doc/created.rid
-- doc/files/README_txt.html
-- doc/files/media_wiki/config_rb.html
-- doc/files/media_wiki/gateway_rb.html
-- doc/files/media_wiki/utils_rb.html
+- doc/files/README.html
+- doc/files/lib/media_wiki/config_rb.html
+- doc/files/lib/media_wiki/gateway_rb.html
+- doc/files/lib/media_wiki/utils_rb.html
 - doc/files/script/create_page_rb.html
-- doc/files/script/delete_book_rb.html
+- doc/files/script/delete_batch_rb.html
 - doc/files/script/export_xml_rb.html
 - doc/files/script/get_page_rb.html
 - doc/files/script/import_xml_rb.html
-- doc/files/script/undelete_page_rb.html
+- doc/files/script/run_fake_media_wiki_rb.html
 - doc/files/script/upload_commons_rb.html
 - doc/files/script/upload_file_rb.html
 - doc/fr_class_index.html
@@ -60,12 +73,11 @@ files:
 - lib/media_wiki/utils.rb
 - mediawiki-gateway.gemspec
 - script/create_page.rb
-- script/delete_book.rb
+- script/delete_batch.rb
 - script/export_xml.rb
 - script/get_page.rb
 - script/import_xml.rb
 - script/run_fake_media_wiki.rb
-- script/undelete_page.rb
 - script/upload_commons.rb
 - script/upload_file.rb
 - spec/fake_media_wiki/api_pages.rb

data/doc/files/script/undelete_page_rb.html

@@ -1,101 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>File: undelete_page.rb</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-  <div id="fileHeader">
-    <h1>undelete_page.rb</h1>
-    <table class="header-table">
-    <tr class="top-aligned-row">
-      <td><strong>Path:</strong></td>
-      <td>script/undelete_page.rb
-      </td>
-    </tr>
-    <tr class="top-aligned-row">
-      <td><strong>Last Update:</strong></td>
-      <td>Thu Aug 05 17:26:12 +1000 2010</td>
-    </tr>
-    </table>
-  </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-
-
-   </div>
-
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-
-
-
-
-      
-
-
-    <!-- if method_list -->
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>