wiki_lib 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jonathan Stott
+
+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

@@ -0,0 +1,25 @@
+wiki-lib
+========
+
+A simple library for easing interaction with wikis (currently just PMWiki) in ruby,
+in essence, a wrapper around the mechanize gem.
+
+require 'rubygems'
+gem 'namelessjon-wiki_lib'
+require 'wiki_lib'
+
+@pm_wiki = WikiLib::PMWiki.new('http://www.pmwiki.org/wiki', 'namelessjon', 'apassword')
+
+# get the page
+@page = @pm_wiki.get_page('PmWiki/FAQ')
+
+# get the current sandbox text
+@sandbox = @pm_wiki.get_edit_text('Main/WikiSandbox')
+
+# upload the reversed sandbox text back to the sandbox
+@pm_wiki.upload_page('Main/WikiSandbox', @sandbox.reverse, "You're in backwards land, today".reverse)
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 Jonathan Stott. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rcov/rcovtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "wiki_lib"
+    s.summary = "A simple library to wrap around some common wiki operations"
+    s.email = "jonathan.stott@gmail.com"
+    s.homepage = "http://github.com/namelessjon/wiki_lib"
+    s.description = "A simple library to wrap around some common wiki operations\nCurrently only PMWiki is supported, but more will be added as and when."
+    s.authors = ["Jonathan Stott"]
+    s.add_dependency 'mechanize', '~>0.9'
+    s.autorequire = 'wiki_lib'
+    s.files =  %w(LICENSE README Rakefile) + Dir.glob("{lib,spec}/**/*")
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install namelessjon-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'wiki-lib'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rcov::RcovTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :rcov

data/lib/wiki_lib/pm_wiki.rb

@@ -0,0 +1,118 @@
+module WikiLib
+  ##
+  # Class for interacting with the PMWiki
+  class PMWiki
+    ##
+    # Initializes a new PMWiki instance
+    #
+    # @param [String] base_page The base page of the wiki.  Probably it's address, but could be a subset of the namespace
+    #
+    # @param [String] username Username used to sign off the edits
+    #
+    # @param [String] password Password used to make edits
+    def initialize(base_page, username, password)
+      @base = base_page
+      @pass = password
+      @user = username
+      @agent = ::WWW::Mechanize.new
+    end
+
+    ##
+    # returns a PMWiki page url
+    #
+    # @param [String] page The name of the page, relative to the base page
+    #
+    # @return [String] The URL
+    def page_url(page)
+    "#{@base}/#{page}"
+    end
+
+    ##
+    # returns a PMWiki page edit url
+    #
+    # @param [String] page The name of the page, relative to the base page
+    #
+    # @return [String] The URL
+    def edit_url(page)
+    "#{page_url(page)}?action=edit"
+    end
+
+    ##
+    # Returns the edit text of a PMWiki page
+    #
+    # @param [String] page The page to get the edit text for
+    #
+    # @return [String] The edit text
+    def get_edit_text(page)
+      # get the form, logging in if nessessary
+      form = get_edit_form_with_login(edit_url(page))
+
+      # return the text
+      form['text']
+    end
+
+    ##
+    # Returns the full page, parsed by hpricot
+    #
+    # @param [String] page Page to retrieve the raw text for
+    #
+    # @return [Hpricot::Doc] The parsed page
+    def get_page(page)
+      @agent.get(page_url(page))
+    end
+
+    ##
+    # Uploads a page to the PM wiki, creating it if needed
+    #
+    # @param [String] page Page to create/update
+    #
+    # @param [String] text Text to place on the new page
+    #
+    # @param [String] summary Edit summary for the edit
+    #
+    # @param [TrueClass, FalseClass] minor tick the minor edit checkbox?
+    def upload_page(page, text, summary, minor=false)
+      # get the form, logging in if nessessary
+      form = get_edit_form_with_login(edit_url(page))
+
+      # fill out our form
+      form['text']    = text
+      form['csum']    = summary
+      form['author']  = @user
+
+      edit.checkboxes.first.check if minor
+
+      # upload
+      @agent.submit(form, form.buttons.first)
+    end
+
+    ##
+    # Deletes a PMWiki page (sets text to delete)
+    #
+    # @param [String] page The page to delete
+    #
+    # @param [String] summary The reason for deletion
+    def delete_page(page, summary)
+      upload_page(page, 'delete', summary)
+    end
+
+    protected
+    def get_edit_form_with_login(url)
+      # fetch the page
+      page = @agent.get(url)
+
+      # if we find an authform, we are not logged in.
+      if form = page.forms.find { |f| f.name == 'authform' }
+        # fill in the password and submit
+        form['authpw'] = @pass
+        page = @agent.submit(form, form.buttons.first)
+
+        # if we still have an auth form, we're in trouble
+        raise(StandardError, "Authentication Failed") if page.forms.find { |f| f.name == 'authform' }
+      end
+
+      # by now, this should be the right page, so find the last form on it!
+      page.forms.last
+    end
+  end
+end

data/lib/wiki_lib.rb

@@ -0,0 +1,5 @@
+module WikiLib
+end
+gem('mechanize', '~>0.8')
+require 'mechanize'
+require 'wiki_lib/pm_wiki'

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bacon'
+
+# get a summary of errors raised and such
+Bacon.summary_on_exit

data/spec/wiki_lib_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "WikiLib" do
+  it "fails" do
+    should.flunk "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: wiki_lib
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jonathan Stott
+autorequire: wiki_lib
+bindir: bin
+cert_chain: []
+
+date: 2009-11-24 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.9"
+    version: 
+description: |-
+  A simple library to wrap around some common wiki operations
+  Currently only PMWiki is supported, but more will be added as and when.
+email: jonathan.stott@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/wiki_lib.rb
+- lib/wiki_lib/pm_wiki.rb
+- spec/spec_helper.rb
+- spec/wiki_lib_spec.rb
+has_rdoc: true
+homepage: http://github.com/namelessjon/wiki_lib
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple library to wrap around some common wiki operations
+test_files: 
+- spec/spec_helper.rb
+- spec/wiki_lib_spec.rb