mediawiki-gateway 0.1.0

data/lib/media_wiki/utils.rb

@@ -0,0 +1,18 @@
+module MediaWiki
+
+  class << self
+
+    def version
+      "0.0.1"
+    end
+    
+    # Convert a Wiki page name ("getting there & away") to URI-safe format ("getting_there_%26_away"),
+    # taking care not to mangle slashes
+    # [wiki] Page name string in Wiki format
+    def wiki_to_uri(wiki)
+      wiki.to_s.split('/').map {|chunk| CGI.escape(chunk.tr(' ', '_')) }.join('/') if wiki
+    end
+
+  end
+  
+end

data/mediawiki-gateway.gemspec

@@ -0,0 +1,88 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mediawiki-gateway}
+  s.version = "0.1.0"
+
+  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.description = %q{}
+  s.email = %q{jpatokal@iki.fi}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "config/hosts.yml",
+     "doc/classes/MediaWiki.html",
+     "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/script/create_page_rb.html",
+     "doc/files/script/delete_book_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/upload_commons_rb.html",
+     "doc/files/script/upload_file_rb.html",
+     "doc/fr_class_index.html",
+     "doc/fr_file_index.html",
+     "doc/fr_method_index.html",
+     "doc/index.html",
+     "doc/rdoc-style.css",
+     "lib/media_wiki.rb",
+     "lib/media_wiki/config.rb",
+     "lib/media_wiki/gateway.rb",
+     "lib/media_wiki/utils.rb",
+     "mediawiki-gateway.gemspec",
+     "script/create_page.rb",
+     "script/delete_book.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",
+     "spec/fake_media_wiki/app.rb",
+     "spec/fake_media_wiki/query_handling.rb",
+     "spec/gateway_spec.old",
+     "spec/gateway_spec.rb",
+     "spec/import-test-data.xml"
+  ]
+  s.homepage = %q{http://github.com/jpatokal/media_wiki_gateway}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Connect to the mediawiki API}
+  s.test_files = [
+    "spec/fake_media_wiki/api_pages.rb",
+     "spec/fake_media_wiki/app.rb",
+     "spec/fake_media_wiki/query_handling.rb",
+     "spec/gateway_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/script/create_page.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# Sample script for fetching a page's current contents in Wiki markup
+#
+require 'media_wiki/gateway'
+require 'media_wiki/config'
+
+config = MediaWiki::Config.new ARGV 
+config.abort("Name of article is mandatory.") unless config.article
+
+mw = MediaWiki::Gateway.new(config.url, Logger::DEBUG)
+mw.login(config.user, config.pw)
+content = ARGF.read.to_s
+puts mw.create(config.article, content, {:overwrite => true, :summary => config.summary})

data/script/delete_book.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'media_wiki/gateway'
+
+if ARGV.length <1
+  raise "Syntax: delete_batch.rb <wiki-api-url> <startswith_pattern>"
+end
+
+rw = MediaWiki::Gateway.new(ARGV[0])
+rw.list(ARGV[1]).each do |title|
+  print "Deleting #{title}..."
+  rw.delete(title)
+end
+print "Done."
+

data/script/export_xml.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# Export MediaWiki pages as XML
+#
+require 'media_wiki/gateway'
+
+if ARGV.length < 3
+  raise "Syntax: export_xml.rb <host> <user> <password> [page page page...]"
+end
+
+mw = MediaWiki::Gateway.new(ARGV[0])
+mw.login(ARGV[1], ARGV[2])
+print mw.export(ARGV[3..-1])
+

data/script/get_page.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+#
+# Sample script for fetching a page's current contents in Wiki markup
+#
+require 'media_wiki/gateway'
+
+if ARGV.length < 2
+  raise "Syntax: get_page.rb <host> <name>"
+end
+
+mw = MediaWiki::Gateway.new(ARGV[0])
+puts mw.get(ARGV[1])

data/script/import_xml.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# Import a MediaWiki XML dump 
+#
+require 'media_wiki/gateway'
+
+if ARGV.length < 3
+  raise "Syntax: import_xml.rb <host> <username> <password> <file>"
+end
+
+mw = MediaWiki::Gateway.new(ARGV[0], Logger::DEBUG)
+mw.login(ARGV[1], ARGV[2])
+mw.import(ARGV[3])
+

data/script/run_fake_media_wiki.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# Helper script for running a live FakeMediaWiki instance instead of just shamracking it.
+require 'rubygems'
+require 'sinatra/base'
+require 'spec/fake_media_wiki/app'
+
+FakeMediaWiki::App.run! :host => 'localhost', :port => 9090
+

data/script/undelete_page.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/environment'
+
+if ARGV.length <1
+  raise "Syntax: undelete.rb <initial-pattern> [environment]\n  Sample: undelete.rb 'Book:Shanghai 5' devint"
+end
+
+host = ARGV[1] ? "webvip.mediawiki.#{ARGV[1]}.lpo" : LonelyPlanet::OnRails.environment.services[:atlas_mediawiki]
+rw = MediaWiki::Gateway.new(host)
+rw.login('atlasmw', 'wombat')
+# Warning: List only works on existing pages (deleted & reimported), there's a separate unimplemented op for listing currently deleted pages
+rw.list(ARGV[0]).each do |title|
+  print "Undeleting #{title}... #{rw.undelete(title)} revisions restored.\n"
+end
+print "Done."

data/script/upload_commons.rb

@@ -0,0 +1,42 @@
+require 'lib/media_wiki/gateway'
+require 'lib/media_wiki/config'
+
+config = MediaWiki::Config.new(ARGV, "upload")
+file = ARGV[0]
+config.abort("Name of file to upload is mandatory.") unless file
+
+mw = MediaWiki::Gateway.new(config.url)
+mw.login(config.user, config.pw)
+
+puts "Login successful."
+puts "Description of file:"
+desc = STDIN.gets.chomp
+puts "Date of file:"
+date = STDIN.gets.chomp
+puts "Target filename: (leave blank to use existing name)"
+target = STDIN.gets.chomp
+target = config.target if target.empty? 
+puts "Categories, separated by commas:"
+cats = STDIN.gets.chomp.split(",")
+cats = "[[Category:" + cats.join("]]\n[[Category:") + "]]" unless cats.empty?
+
+template = <<-TEMPLATE
+== Summary ==
+{{Information
+|Description={{en|1=%DESC%}}
+|Source={{own}}
+|Author=[[User:%USER%|%USER%]]
+|Date=%DATE%
+|Permission=
+|other_versions=
+}}
+
+== Licensing ==
+{{self|cc-by-sa-3.0|GFDL}}
+
+%CATS%
+TEMPLATE
+desc = template.gsub('%USER%', config.user).gsub('%DESC%', desc).gsub('%DATE%', date).gsub('%CATS%', cats)
+puts "Uploading #{file} to #{target}..."
+mw.upload(file, {:target => target, :description => desc, :summary => "Uploaded by MediaWiki::Gateway"})
+puts "Done."

data/script/upload_file.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# Sample script for fetching a page's current contents in Wiki markup
+#
+require 'media_wiki/gateway'
+require 'media_wiki/config'
+
+config = MediaWiki::Config.new(ARGV, "upload")
+config.abort("Name of file to upload is mandatory.") unless ARGV[0]
+
+mw = MediaWiki::Gateway.new(config.url, Logger::DEBUG)
+mw.login(config.user, config.pw)
+mw.upload(ARGV[0], {:target => config.target, :description => config.desc, :summary => config.summary})
+

data/spec/fake_media_wiki/api_pages.rb

@@ -0,0 +1,131 @@
+module FakeMediaWiki
+
+  class ApiPages
+
+    def initialize
+      @page_id = 0
+      @pages = {}
+      @namespaces = { "" => 0 }
+    end
+    
+    def add_namespace(id, prefix)
+      @namespaces[prefix] = id
+    end
+
+    def namespaces_by_prefix
+      @namespaces
+    end
+
+    def namespaces_by_id
+      @namespaces.invert
+    end
+  
+    def add(title, content)
+      @page_id += 1
+      dummy, prefix = title.split(":", 2).reverse
+      @pages[title] = {
+        :pageid => @page_id,
+        :namespace => namespaces_by_prefix[prefix || ""],
+        :title => title,
+        :content => content
+      }
+    end
+    
+    def get(title)
+      @pages[title]
+    end
+
+    def list(prefix) 
+      @pages.select do |key, page|
+        key =~ /^#{prefix}/
+      end
+    end
+
+    def search(searchkey, namespaces)
+      raise FakeMediaWiki::ApiError.new("srparam-search", "empty search string is not allowed") if searchkey.empty?
+      @pages.select do |key, page|
+        page[:content] =~ /#{searchkey}/ and namespaces.include? page[:namespace].to_s
+      end
+    end
+    
+    def delete(title)
+      @pages.delete(title)
+    end
+
+    def undelete(title)
+      if @pages[title]
+        0
+      else
+        add(title, "Undeleted content")
+        1
+      end
+    end
+  end
+
+  class ApiToken
+    ADMIN_TOKEN   = "admin_token+\\" 
+    REGULAR_TOKEN = "regular_token+\\"
+    BLANK_TOKEN   = "+\\"
+
+    def initialize(params)
+      @token_str = params[:token]
+      @token_in = params[:intoken]
+    end
+    
+    def set_type(type)
+      @token_in = type
+    end
+    
+    def validate
+      unless @token_str
+        raise FakeMediaWiki::ApiError.new("notoken", "The token parameter must be set")
+      end
+    end
+
+    def validate_admin
+      validate
+      if @token_str != ADMIN_TOKEN
+        raise FakeMediaWiki::ApiError.new("badtoken", "Invalid token")
+      end
+    end
+    
+    def request(user)
+      @user = user
+      respond_to?(requested_token_type) ? send(requested_token_type) : nil
+    end
+       
+    def requested_token_type
+      "#{@token_in}token".to_sym
+    end
+
+    def importtoken
+      if @user && @user[:is_admin]
+        ADMIN_TOKEN
+      else
+        nil
+      end
+    end
+    alias_method :deletetoken, :importtoken
+    alias_method :undeletetoken, :importtoken
+    
+    def edittoken
+      if @user
+        REGULAR_TOKEN
+      else
+        BLANK_TOKEN
+      end
+    end
+  end
+
+  class ApiError < StandardError
+    
+    attr_reader :code, :message
+
+    def initialize(code, message)
+      @code = code
+      @message = message
+    end
+
+  end
+  
+end

data/spec/fake_media_wiki/app.rb

@@ -0,0 +1,262 @@
+require 'rubygems'
+require 'sinatra/base'
+require 'spec/fake_media_wiki/api_pages'
+require 'spec/fake_media_wiki/query_handling'
+
+# A simple Rack app that stubs out a web service, for testing.
+
+module FakeMediaWiki
+
+  class App < Sinatra::Base
+  
+    set :show_exceptions, false
+    set :environment, :development
+
+    def initialize
+      reset
+      super
+    end
+  
+    def reset
+      @sequence_id = 0
+
+      @users = {}
+      add_user('atlasmw', 'wombat', 'local', true)
+      add_user('nonadmin', 'sekrit', 'local', false)
+      add_user('ldapuser', 'ldappass', 'ldapdomain', false)
+      
+      @pages = ApiPages.new
+      @pages.add('Main Page', 'Content')
+      @pages.add('Main 2', 'Content')
+      @pages.add('Level/Level/Index', '{{#include:Foo}} {{#include:Bar}}')
+      @pages.add_namespace(100, "Book")
+      @pages.add('Book:Italy', 'Introduction')
+      @pages.add_namespace(200, "Sandbox")
+
+      @extensions = { 'FooExtension' => 'r1', 'BarExtension' => 'r2' }
+      
+      @logged_in_users = []
+    end
+
+    def next_id
+      @sequence_id += 1
+    end
+
+    def add_user(username, password, domain, is_admin)
+      @users[username] = {
+        :userid => next_id,
+        :username => username,
+        :password => password,
+        :domain => domain,
+        :is_admin => is_admin
+      }
+    end
+    
+    def logged_in(username)
+      @logged_in_users.include?(username)
+    end
+        
+    post "/w/api.php" do
+      begin
+        @token = ApiToken.new(params)
+        action = params[:action]
+        if respond_to?(action)
+          content_type "application/xml"
+          return send(action)
+        end
+  
+        halt(404, "Page not found")
+      rescue FakeMediaWiki::ApiError => e
+        return api_error_response(e.code, e.message)
+      end
+    end
+
+    def import
+      @token.validate_admin
+
+      api_response do |_|
+        _.import do
+          _.page(nil, :title => "Main Page", :ns => 0, :revisions => 0)
+          _.page(nil, :title => "Template:Header", :ns => 10, :revisions => 1)
+        end
+      end
+    end
+
+    def validate_page_overwrite(current_page)
+      if current_page && params[:createonly]
+        raise FakeMediaWiki::ApiError.new("articleexists", "The article you tried to create has been created already")
+      end
+    end
+
+    def edit
+      @token.validate
+
+      title = params[:title]
+      current_page = @pages.get(title)
+      validate_page_overwrite(current_page)
+
+      new_page = @pages.add(title, params[:text])
+      page_info = {:result => "Success", :pageid => new_page[:pageid], :title => new_page[:title], :newrevid => new_page[:pageid]}
+      if current_page
+        page_info.merge!(:oldrevid => current_page[:pageid])
+      else
+        page_info.merge!(:new => "", :oldrevid => 0)
+      end
+
+      api_response do |_|
+        _.edit(nil, page_info)
+      end
+    end
+
+    def delete
+      @token.validate_admin
+
+      title = params[:title]
+      raise FakeMediaWiki::ApiError.new("missingtitle", "The page you requested doesn't exist") unless @pages.get(title)
+      @pages.delete(title)
+
+      api_response do |_|
+        _.delete(nil, {:title => title, :reason => "Default reason"})
+      end
+    end
+
+    def undelete
+      @token.validate_admin
+      
+      title = params[:title]
+      revisions = @pages.undelete(title)
+      api_response do |_|
+        _.undelete(nil, {:title => title, :revisions => revisions})
+      end
+    end
+  
+    def upload
+      @token.validate
+      
+      filename = params[:filename]
+      @pages.add(filename, params[:file])
+      api_response do |_|
+        _.upload(nil, {:filename => filename, :result => "Success"})
+      end
+    end
+  
+    def parse
+      page = @pages.get(params[:page])
+      api_response do |_|
+        _.parse({ :revid => page ?  page[:pageid] : 0}) do
+          _.text("Sample <B>HTML</B> content")
+        end
+      end
+    end
+    
+    include QueryHandling
+
+    def api_response
+      builder do |_|
+        _.api do |_|
+          yield(_)
+        end
+      end
+    end
+
+    def api_error_response(code, info)
+      api_response do |_|
+        _.error(nil,
+                :code => code,
+                :info => info)
+      end
+    end
+
+    def query_pages
+      api_response do |_|
+        _.query do
+          _.pages do
+            requested_page_titles.each do |title|
+              yield(_, title, @pages.get(title))
+            end
+          end
+        end
+      end
+    end
+    
+    def get_revisions
+      query_pages do |_, title, page|
+        if page.nil?
+          _.page(nil, { :title => title, :ns => '0', :missing => "" })
+        else
+          page = page.dup
+          content = page.delete(:content)
+          _.page(page.merge({ :ns => 0 })) do
+            _.revisions do
+              _.rev(content)
+            end
+          end
+        end
+      end
+
+    end
+
+    def user
+      username = request.cookies['login']
+      @users[username] if logged_in(username)
+    end
+    
+    def requested_page_titles
+      params[:titles].split("|")
+    end
+    
+    def get_token
+      token_str = @token.request(user)
+      query_pages do |_, title, page|
+        page = page ? page.dup : {}
+        page[params[:intoken] + "token"] = token_str if token_str
+        _.page(nil, page.merge({ :ns => 0 }))
+      end
+    end
+
+    def get_undelete_token
+      @token.set_type 'undelete'
+      token_str = @token.request(user)
+      api_response do |_|
+        _.query do
+          _.deletedrevs do
+            requested_page_titles.select {|title| ! @pages.get(title) }.each do |title|
+              _.page(nil, { :title => title, :token => token_str })
+            end
+          end
+        end
+      end
+    end
+
+    def login
+      user = @users[params[:lgname]]
+      if user and user[:domain] == params[:lgdomain]
+        if params[:lgpassword] == user[:password]
+          @logged_in_users << user[:username]
+          response.set_cookie('login', user[:username])
+          result = { :result => "Success", :lguserid => "1", :lgusername => "Atlasmw"}
+        else
+          result = { :result => "WrongPass" }
+        end
+      else
+        result = { :result => "NotExists" }
+      end
+
+      api_response do |_|
+        _.login(nil, result)
+      end
+    end
+
+  end
+
+  class WikiPage
+    
+    def initialize(options={})
+      options.each { |k, v| send("#{k}=", v) }
+    end
+    
+    attr_accessor :content, :author
+
+  end
+
+end