mediawiki_cli 0.0.0

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.4)
+    mediawiki-gateway (0.5.1)
+      activesupport
+      rest-client (>= 1.3.0)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    thor (0.15.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (~> 1.8.4)
+  mediawiki-gateway
+  nokogiri
+  rdoc (~> 3.12)
+  thor

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Matt Yeh
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# mediawiki_cli
+
+mediawiki_cli is a command line interface tool for MediaWiki. 
+
+All mediawiki_cli commands require configuration options to be passed at run-time.  
+
+		mw <action> <subcommand> <options> -W <wiki> 
+
+Options:
+* -W, --wiki 					=> (required) The URL to the MediaWiki API (eg, http://my.wiki/w/api.php) or the unique name of the wiki in the configuration file.
+* -U, --username 			=> (optional)  
+* -P, --password 			=> (optional)
+* -F, --file 					=> (optional) A hashable configuration file (eg, YAML) whose top-level keys are unique names of the wiki.  Each top-level key will contain a sub-hash that contain the keys "wiki", "username", and "password"
+
+Actions:
+* list
+* export
+* import
+* xml
+
+## Listing 
+To retrieve a list of MediaWiki resources:
+
+		mw list [resource_subcommand] [options] -W [wiki]
+
+Subcommands:
+* categories
+* properties
+* templates
+* all 								=> (default) List all categories, properties, and templates.
+* namespaces
+* members
+   * -c, --categories 	=> A list of category names (eg, `mw list members -n "Category:Foo" "Category:Bar"`)
+   * -n, --namespaces 	=> A list of namespace names (eg, `mw list members -n "Property:"`)
+   * -f, --file  				=> A hashable file (eg, YAML) that contains keys for "categories" and "namespaces"
+
+## Exporting 
+MediaWiki export files will conform to the MediaWiki XML Schema.  The 'export' subcommand accepts input from standard input, such as from piped command output.
+
+To export MediaWiki resources:
+
+		mw export [subcommand] [options] -W [wiki]
+
+Subcommands:
+* export 							=> (default) 
+   * -p, --pages 				=> A list of page names to export (eg, `mw export -p "Main Page" "My Other Page"`)
+* batch
+   * -c, --categories 	=> A list of category names whose members will be exported (eg, `mw export batch -c "Category:Foo" "Category:Bar" -W [wiki]`)
+   * -n, --namespaces 	=> A list of namespace names that will be exported (eg, `mw export batch -n "Property:" "Concept:" -W [wiki]`)
+   * -p, --pages 				=> A list of page names that will be exported (eg, `mw export batch -p "Main Page" "My Other Page" -W [wiki]`)
+   * -f, --file 				=> A hashable file (eg, YAML) that contains keys for "categories", "namespaces", and "pages"
+
+## Importing
+Import a MediaWiki XML export file to the specified wiki.
+
+		mw import [*files] -W [wiki]
+
+## Xml
+It may be necessary to perform XML manipulation for the MediaWiki XML files.  
+
+		mw xml [subcommand] [options] -W [wiki]
+
+Subcommands:
+* merge[*args]				=> Merge pages elements of MediaWiki XML dumps (eg, `mw xml merge "export1.xml" "export2.xml" -W [wiki]`)
+
+## Contributing to mediawiki_cli
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Matt Yeh. See LICENSE.txt for
+further details.
+

data/bin/mw

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+lib = Pathname.new(__FILE__).dirname.join('..', 'lib').expand_path
+$LOAD_PATH.unshift lib.to_s
+
+require 'mediawiki_cli/cli'
+
+Mw::Cli.start

data/lib/mediawiki_cli/cli.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'media_wiki'
+require 'mediawiki_cli/list'
+require 'mediawiki_cli/export'
+require 'mediawiki_cli/import'
+require 'mediawiki_cli/xml'
+require 'thor'
+
+module Mw
+	class Cli < Thor
+	include FileHandler
+		namespace :mw
+
+		class_option :wiki, :type=>:string, :aliases=>"-W", :required=>true
+		class_option :username, :type=>:string, :aliases=>"-U"
+		class_option :password, :type=>:string, :aliases=>"-P"
+		class_option :file, :type=>:string, :aliases=>"-F"
+
+		desc "setup", "setup"
+		def setup
+			config = symbolize_keys(to_hash(options.file)).fetch(options.wiki.to_sym) if options.file
+
+			config ||= options
+			$mw ||= MediaWiki::Gateway.new(config[:wiki])
+			if config[:username] and config[:password]
+				$mw.login(config[:username], config[:password]) 
+			end
+		end
+
+		desc "list", "list"
+		subcommand "list", List 
+
+		desc "export", "export"
+		subcommand "export", Export
+
+		desc "import", "import"
+		subcommand "import", Import
+
+		desc "xml", "xml"
+		subcommand "xml", Xml
+	end
+end
+

data/lib/mediawiki_cli/export.rb

@@ -0,0 +1,48 @@
+require 'mediawiki_cli/mwgateway'
+require 'mediawiki_cli/filehandler'
+require 'thor'
+
+class Export < Thor
+include MwGateway, FileHandler
+	namespace "mw:export"
+	default_task :export
+
+	desc "batch", "Export categories, pages, namespaces"
+	method_option :categories, :type=>:array, :aliases=>"-c"
+	method_option :pages, :type => :array, :aliases=>"-p"
+	method_option :namespaces, :type=>:array, :aliases=>"-n"
+	method_option :file, :type=>:string, :aliases=>"-f"
+	def batch
+		pages = []
+
+		# TODO combine options
+		export ||= to_hash(options.file) if options.file
+		export ||= options
+
+		export.each { |key, value|
+			case key
+				when "categories", "namespaces"
+					pages.push invoke "mw:list:members", [],	:categories => export["categories"],
+																				:namespaces => export["namespaces"],
+																				:wiki => parent_options.wiki,
+																				:username => parent_options.username,
+																				:password => parent_options.password,
+																				:file => parent_options.file
+				when "pages"
+					pages.push export["pages"]
+			end
+		}
+		return output $mw.export(pages.flatten)
+	end
+
+	desc "export", "Export a list of pages"
+	method_option :pages, :type=>:array, :aliases=>"-p", :required=>true
+	def export
+		invoke "mw:setup", [], :wiki => parent_options.wiki, 
+																:username => parent_options.username,
+																:password => parent_options.password,
+																:file => parent_options.file
+		opts = (STDIN.tty?) ? options.pages : $stdin.read.split("\n")
+		return output $mw.export(opts)
+	end
+end

data/lib/mediawiki_cli/filehandler.rb

@@ -0,0 +1,18 @@
+
+module FileHandler
+	private
+	# TODO when does thor create symbol keys vs string keys?
+	def to_hash(file)
+		case File.extname file
+			when '.yaml', '.yml'
+				require 'yaml'
+				return YAML::load_file(file)
+		end
+	end
+
+  def symbolize_keys(hash)
+		return hash if not hash.is_a?(Hash)
+		result = hash.inject({}){|h,(k,v)| h[k.to_sym] = symbolize_keys(v); h}
+		return result 
+	end
+end

data/lib/mediawiki_cli/import.rb

@@ -0,0 +1,17 @@
+require 'mediawiki_cli/mwgateway'
+require 'thor'
+
+class Import < Thor
+include MwGateway
+	namespace "mw:import"
+	default_task :import
+
+	desc "import", "Import pages from file."
+	def import(*file)
+		create_gateway(wiki)
+		file.each { |f|
+			$mw.import(file)
+		}
+	end
+end
+

data/lib/mediawiki_cli/list.rb

@@ -0,0 +1,64 @@
+require 'mediawiki_cli/mwgateway'
+require 'mediawiki_cli/filehandler'
+require 'thor'
+
+class List < Thor
+include MwGateway, FileHandler
+	namespace "mw:list"
+	default_task :all
+
+	desc "all", "List categories, properties, templates, and namespaces"
+	def all
+		create_gateway
+		invoke :categories
+		invoke :properties
+		invoke :templates
+	end
+
+	desc "members", "List members in given categories."
+	method_option :categories, :type=>:array, :aliases=>"-c"
+	method_option :namespaces, :type=>:array, :aliases=>"-n"
+	method_option :file, :type=>:string, :aliases=>"-f"
+	def members 
+		create_gateway	
+		members = []
+		options[:categories].each { |c| 
+			members += $mw.category_members(c) 
+			members << c
+		} if options[:categories]
+		options[:namespaces].each { |n|
+			members += list_by_namespace(n)
+		} if options[:namespaces]
+		return output members 
+	end
+
+	desc "namespaces", "List all namespaces"
+	def namespaces
+		create_gateway
+		return output $mw.namespaces_by_prefix.keys
+	end		
+
+## TODO metaprogramming on these methods
+	desc "categories", "List all categories"
+	def categories
+		list_by_namespace("Category:")
+	end
+
+	desc "properties", "List all properties"
+	def properties
+		list_by_namespace("Property:")
+	end
+
+	desc "templates", "List all templates"
+	def templates
+		list_by_namespace("Template:")
+	end
+##
+
+	no_tasks {
+		def list_by_namespace( namespace )
+			create_gateway
+			return output $mw.list( namespace )
+		end
+	}
+end

data/lib/mediawiki_cli/mwgateway.rb

@@ -0,0 +1,15 @@
+
+module MwGateway
+	private
+	def create_gateway 
+		opts = parent_options.merge options
+		invoke "mw:setup", [], 	:wiki => opts.wiki, 
+														:username => opts.username,
+														:password => opts.password,
+														:file => opts.file
+	end
+	def output(obj)
+		puts obj
+		obj
+	end
+end

data/lib/mediawiki_cli/xml.rb

@@ -0,0 +1,26 @@
+require 'nokogiri'
+require 'thor'
+
+class Xml < Thor
+	namespace "mw:xml"
+
+	desc "merge", "Merge MediaWiki XML dumps"
+	def merge(*xml)
+
+		mwns = "http://www.mediawiki.org/xml/export-0.5/"
+
+		first = xml.shift
+		f = File.open(first) if File.exists? first
+		master = Nokogiri::XML f
+
+		others = xml.each { |x|
+			x = File.open(x) if File.exists? x
+			doc = Nokogiri::XML x
+			doc.xpath("//mediawiki:page", "mediawiki"=>mwns).each {|n|
+				master.root.add_child n	
+			}
+		}
+	
+		puts master.root.to_xml
+	end
+end

data/lib/mediawiki_cli.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+#require 'media_wiki'
+require 'media_wiki'
+require 'thor'
+require 'mediawiki_cli/cli'
+require 'mediawiki_cli/list'
+require 'mediawiki_cli/export'
+require 'mediawiki_cli/import'
+require 'mediawiki_cli/xml'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: mediawiki_cli
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Matt Yeh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &2153095600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153095600
+- !ruby/object:Gem::Dependency
+  name: mediawiki-gateway
+  requirement: &2153093860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153093860
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2153092960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153092960
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2153091960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *2153091960
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2153090740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153090740
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2153089320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *2153089320
+description: A command line interface for MediaWiki that offers listing, exporting,
+  and importing features.
+email: mtyeh411@gmail.com
+executables:
+- mw
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- bin/mw
+- lib/mediawiki_cli.rb
+- lib/mediawiki_cli/cli.rb
+- lib/mediawiki_cli/export.rb
+- lib/mediawiki_cli/filehandler.rb
+- lib/mediawiki_cli/import.rb
+- lib/mediawiki_cli/list.rb
+- lib/mediawiki_cli/mwgateway.rb
+- lib/mediawiki_cli/xml.rb
+homepage: http://github.com/mtyeh411/mediawiki_cli
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2002296685323973285
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A command line interface for MediaWiki
+test_files: []