reefer 0.1.1

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2010 Adam Mckaig
+
+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,44 @@
+Reefer is a tiny Ruby interface to a hosted Etherpad. Currently, there
+is very little functionality. In future, it may provide a more complete
+API. You may consider that an invitation for patches...
+
+
+Command-line Usage
+------------------
+
+Fetch the current contents of a pad:
+
+    $ reefer --url http://piratepad.net/anything
+    <b>alpha</b> <i>bravo</i> <u>charlie</u> <s>delta</s>
+
+Fetch a previous revision:
+
+    $ reefer --url http://piratepad.net/anything --revision 6
+    alpha bravo
+
+
+Module Usage
+------------
+
+Fetch the current contents of a pad:
+
+    >>> Reefer::Pad.new("http://piratepad.net/anything").to_html
+    "<b>alpha</b> <i>bravo</i> <u>charlie</u> <s>delta</s>"
+
+Fetch a previos version:
+
+    >>> Reefer::Pad.new("http://piratepad.net/anything").revision(6).to_html
+    "alpha bravo"
+
+
+Requirements
+------------
+* Ruby 1.9
+* Nokogiri
+* Trollop
+* RSpec
+
+
+License
+-------
+Reefer is free software, available under the MIT license.

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require "rake"
+require "spec/rake/spectask"
+
+desc "Run all RSpec tests"
+Spec::Rake::SpecTask.new("spec") do |t|
+  t.spec_files = FileList["spec/reefer/*.rb"]
+end

data/bin/reefer

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require "trollop"
+require "pathname"
+require "optparse"
+
+# find lib/reefer.rb relatively, to support symlinking
+here = File.dirname(Pathname.new(__FILE__).realpath)
+require File.join(here, "..", "lib", "reefer.rb")
+
+opts = Trollop::options do
+  opt :url,      "Etherpad URL",    :type => String, :required => true
+  opt :revision, "Revision number", :type => :int
+end
+
+opts[:revision] ||= :latest
+pad = Reefer::Pad.new(opts[:url])
+rev = pad.revision(opts[:revision])
+
+puts rev.contents.to_html

data/lib/reefer.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+module Reefer
+  Version = "0.1.1"
+end
+
+here = File.dirname(__FILE__)
+require here + "/reefer/errors.rb"
+require here + "/reefer/pad.rb"
+require here + "/reefer/fetch.rb"
+require here + "/reefer/revision.rb"

data/lib/reefer/errors.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+module Reefer
+  class InvalidPadName < Exception
+  end
+end

data/lib/reefer/fetch.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require "open-uri"
+
+module Reefer
+  class << self
+    def fetch(url)
+      open(url)
+    end
+  end
+end

data/lib/reefer/pad.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require "uri"
+
+module Reefer
+  class Pad
+    attr_reader :domain, :name
+
+    def initialize(url)
+      url = URI.parse(url)
+      @domain = url.host
+      @name = url.path
+
+      # remove the leading slash (which is always present), but explode
+      # if any more are present. pad names can't contain them.
+      @name.gsub!(/^\//, "")
+      raise InvalidPadName\
+        if @name.index("/")
+    end
+
+    def revision(version)
+      Revision.new(self, version)
+    end
+
+    def to_html
+      revision(:latest).to_html
+    end
+  end
+end

data/lib/reefer/revision.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require "nokogiri"
+
+module Reefer
+  class Revision
+    attr_reader :pad, :version
+
+    def initialize(pad, version)
+      @pad = pad
+      @version = version
+    end
+
+    def url(format=:html)
+      "http://#{@pad.domain}/ep/pad/export/#{@pad.name}/#{name}?format=#{format}"
+    end
+
+    def name
+      if @version.is_a?(Numeric)
+        "rev.#{@version}"
+      else
+        @version
+      end
+    end
+
+    def fetch
+      Reefer::fetch(url)
+    end
+
+    def contents
+      doc = Nokogiri::HTML(fetch)
+      nodes = doc.css("body").children
+
+      # remove trailing <br> from the body.
+      # (etherpad keeps adding them on save.)
+      while nodes[-1].name == "br"
+        nodes.pop
+      end
+
+      nodes
+    end
+
+    def to_html
+      contents.to_html.strip
+    end
+  end
+end

data/spec/examples/latest

@@ -0,0 +1,12 @@
+<!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" lang="en" xml:lang="en">
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+    <meta http-equiv="Content-Language" content="en-us" />
+    <title></title>
+  </head>
+  <body>
+    alpha, <b>bravo</b>, <i>charlie</i>, <u>delta</u>
+    <br/><br/>
+  </body>
+</html>

data/spec/examples/rev10

@@ -0,0 +1,12 @@
+<!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" lang="en" xml:lang="en">
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+    <meta http-equiv="Content-Language" content="en-us" />
+    <title></title>
+  </head>
+  <body>
+    alpha, bravo
+    <br/><br/>
+  </body>
+</html>

data/spec/examples/whitespace

@@ -0,0 +1,15 @@
+<!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" lang="en" xml:lang="en">
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+    <meta http-equiv="Content-Language" content="en-us" />
+    <title></title>
+  </head>
+  <body>
+
+
+
+    <br/><br/>
+    <br/><br/>
+  </body>
+</html>

data/spec/helper.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require "lib/reefer.rb"
+
+# stub out the url fetching.
+module Reefer
+  class << self
+    def fetch(url)
+      File.open("spec/examples/" + EXAMPLES[url]).read
+    end
+  end
+end
+
+EXAMPLES = {
+  "http://example.com/ep/pad/export/test/latest?format=html" => "latest",
+  "http://example.com/ep/pad/export/test/rev.10?format=html" => "rev10",
+  "http://example.com/ep/pad/export/whitespace/latest?format=html" => "whitespace"
+}

data/spec/reefer/pad.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require "spec/helper.rb"
+
+describe Reefer::Pad do
+  it "extracts the domain and pad name from an url" do
+    pad = Reefer::Pad.new("http://example.com/test")
+    pad.domain.should == "example.com"
+    pad.name.should == "test"
+  end
+
+  it "raises for invalid pad urls" do
+    lambda do
+      Reefer::Pad.new("http://example.com/this/is/not/valid")
+    end.should raise_error Reefer::InvalidPadName
+  end
+
+  it "returns a numeric Revision" do
+    pad = Reefer::Pad.new("http://example.com/test")
+    pad.revision(1).class.should == Reefer::Revision
+  end
+
+  it "returns the latest Revision" do
+    pad = Reefer::Pad.new("http://example.com/test")
+    pad.revision(:latest).version.should == :latest
+  end
+
+  it "ignores irrelevant url fragments" do
+    pad = Reefer::Pad.new("http://example.com/test#what?a=b&c=d;e=f")
+    pad.domain.should == "example.com"
+    pad.name.should == "test"
+  end
+
+  it "returns the HTML of the latest revision" do
+    pad = Reefer::Pad.new("http://example.com/test")
+    pad.to_html.should == "alpha, <b>bravo</b>, <i>charlie</i>, <u>delta</u>"
+  end
+
+  it "strips whitespace from HTML output" do
+    Reefer::Pad.new("http://example.com/whitespace").to_html.should == ""
+  end
+end

data/spec/reefer/revision.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require "spec/helper.rb"
+
+describe Reefer::Revision do
+  it "returns the URL"
+  it "retrieves the HTML source"
+  it "parses the HTML into a node array"
+  it "ignores trailing <br> elements"
+  it "renders the content back into HTML"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: reefer
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Adam Mckaig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-03 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: "Reefer is a tiny Ruby interface to a hosted Etherpad. "
+email: adam.mckaig@gmail.com
+executables: 
+- reefer
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- LICENSE
+- Rakefile
+- lib/reefer.rb
+- lib/reefer/pad.rb
+- lib/reefer/revision.rb
+- lib/reefer/fetch.rb
+- lib/reefer/errors.rb
+- bin/reefer
+- spec/examples/rev10
+- spec/examples/latest
+- spec/examples/whitespace
+- spec/helper.rb
+- spec/reefer/pad.rb
+- spec/reefer/revision.rb
+has_rdoc: true
+homepage: http://github.com/adammck/reefer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby interface to Etherpad
+test_files: []
+