atom-tools 0.9.0

data/COPYING

@@ -0,0 +1,18 @@
+copyright © 2006 Brendan Taylor
+
+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 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,103 @@
+= atom-tools README
+
+atom-tools is an all-in-one library for parsing, creating and manipulating Atom <http://www.w3.org/2005/Atom> feeds and entries.
+It handles all the nasty XML and HTTP details so that you don't have to.
+
+== Example
+
+  require "atom/feed"
+  require "open-uri"
+
+  feed = Atom::Feed.new "http://www.tbray.org/ongoing/ongoing.atom"
+    # => <http://www.tbray.org/ongoing/ongoing.atom entries: 0 title=''>
+  
+  feed.update!
+  feed.entries.length
+    # => 20
+
+  feed.title.to_s
+    # => "ongoing"
+
+  feed.authors.first.name
+    # => "Tim Bray"
+
+  entry = feed.entries.first
+    # => #<Atom::Entry id:'http://www.tbray.org/ongoing/When/200x/2006/11/07/Munich'>
+
+  entry.title.to_s
+    # => "M\303\274nchen"
+
+  entry.links.last
+    # => {"href"=>"http://www.tbray.org/ongoing/When/200x/2006/11/07/Munich#comments", "rel"=>"replies", "type" => "application/xhtml+xml"}
+  
+  entry.summary.to_s
+    # => "That local spelling is nicer than the ugly English [...]"
+
+Things are explained in more detail in the RDoc.
+
+== The Atom Publishing Protocol
+
+  require "atom/app"
+
+  app = Atom::App.new "http://necronomicorp.com/app.xml"
+  coll = app.collections.first
+    # => <http://necronomicorp.com/testatom?app entries: 0 title='testing: entry endpoint'>
+
+  coll.update!
+    # => <http://necronomicorp.com/testatom?app entries: 10 title='testing the APP'>
+
+  entry = coll.entries.first
+  entry.title
+    # => 'html entities'#text
+
+  # modify the title
+  entry.title = "HTML entities"
+
+  # store the modified entry
+  coll.put! entry
+    # => #<Net::HTTPOK 200 OK readbody=true>
+
+  coll.entries.first.title
+    # => 'HTML entities'#text
+
+For details on authentication, see the documentation for Atom::HTTP
+
+== Advanced Use
+
+=== Extension Elements
+
+  irt = REXML::Element.new("in-reply-to")
+  irt.add_namespace "http://purl.org/syndication/thread/1.0"
+
+  irt.attributes["ref"] = "tag:entries.com,2005:1"
+
+  entry.extensions << irt
+
+  entry.to_s
+    # => '<entry xmlns="http://www.w3.org/2005/Atom"><in-reply-to ref="tag:entries.com,2005:1" xmlns="http://purl.org/syndication/thread/1.0"/></entry>'
+
+== YAML
+
+if you feel like writing this stuff by hand, atom-tools can slurp an
+atom:entry from YAML:
+
+  require "atom/yaml"
+
+  yaml = <<END
+    title: Atom-Drunk Pirates Run Amok!
+    tags: tag1 tag2
+    authors:
+    -
+      name: Brendan Taylor
+      email: whateley@gmail.com
+    -
+      name: Harvey
+      uri: http://fake.com/
+
+    content: |
+      <p>blah blah blah blah</p>
+
+      <p>and so on.</p>
+  END
+
+  entry = Atom::Entry.from_yaml(yaml)

data/Rakefile

@@ -0,0 +1,77 @@
+require "rake"
+require "rake/testtask"
+require "rake/rdoctask"
+require "rake/gempackagetask"
+
+require "rake/clean"
+
+NAME = "atom-tools"
+VERS = "0.9.0"
+
+# the following from markaby-0.5's tools/rakehelp
+def setup_tests
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/test*.rb']
+    t.verbose = true
+  end
+end
+
+def setup_rdoc files
+  Rake::RDocTask.new do |rdoc|
+    rdoc.title = NAME + " documentation"
+    rdoc.rdoc_dir = 'doc'
+    rdoc.options << '--line-numbers'
+    rdoc.options << '--inline-source'
+    rdoc.rdoc_files.add(files)
+  end
+end
+
+def setup_gem(pkg_name, pkg_version, author, summary, dependencies, test_file)
+  pkg_version = pkg_version
+  pkg_name    = pkg_name
+  pkg_file_name = "#{pkg_name}-#{pkg_version}"
+
+  spec = Gem::Specification.new do |s|
+    s.name = pkg_name
+    s.version = pkg_version
+    s.platform = Gem::Platform::RUBY
+    s.author = author
+    s.summary = summary
+    s.test_file = test_file
+    s.has_rdoc = true
+    s.extra_rdoc_files = [ "README" ]
+    dependencies.each do |dep|
+        s.add_dependency(*dep)
+    end
+    s.files = %w(COPYING README Rakefile setup.rb) +
+    Dir.glob("{bin,doc,test,lib}/**/*") + 
+    Dir.glob("ext/**/*.{h,c,rb}") +
+    Dir.glob("examples/**/*.rb") +
+    Dir.glob("tools/*.rb")
+
+    s.require_path = "lib"
+    s.extensions = FileList["ext/**/extconf.rb"].to_a
+
+    s.bindir = "bin"
+  end
+
+  Rake::GemPackageTask.new(spec) do |p|
+    p.gem_spec = spec
+    p.need_tar = true
+  end
+
+  task :install do
+    sh %{rake package}
+    sh %{gem install pkg/#{pkg_name}-#{pkg_version}}
+  end
+end
+
+task :default => [:package]
+
+setup_tests
+setup_rdoc ['README', 'lib/**/*.rb']
+
+summary = "Tools for working with Atom Entries, Feeds and Collections"
+test_file = "test/runtests.rb"
+setup_gem(NAME, VERS, "Brendan Taylor", summary, [], test_file)

data/bin/atom-client.rb

@@ -0,0 +1,246 @@
+#!/usr/bin/ruby
+
+# syntax: ./atom-client.rb <introspection-url> [username] [password]
+#   a 
+
+require "tempfile"
+
+require "atom/yaml"
+require "atom/app"
+require "atom/http"
+
+require "rubygems"
+require "bluecloth"
+
+require "time"
+
+require 'yaml'
+
+class Tempfile
+  def edit_externally
+    self.close
+
+    system("#{EDITOR} #{self.path}")
+
+    self.open
+  end
+end
+
+class String
+  def edit_externally
+    tempfile = Tempfile.new("entry")
+    tempfile.puts self
+
+    tempfile.edit_externally
+
+    ret = tempfile.read
+    tempfile.delete
+
+    ret
+  end
+end
+
+class Atom::Entry
+  def prepare_for_output
+    filter_hook
+
+    update!
+  end
+
+  def filter_hook
+    # so much for actual text content...
+    if @content and @content["type"] == "text"
+      self.content = BlueCloth.new( @content.to_s ).to_html
+      @content["type"] = "xhtml"
+    end
+  end
+
+  def edit
+    yaml = YAML.load(self.to_yaml)
+    
+    # humans don't care about these things
+    yaml.delete "id"
+
+    if yaml["links"]
+      yaml["links"].delete(yaml["links"].find { |l| l["rel"] == "edit" })
+      yaml["links"].delete(yaml["links"].find { |l| l["rel"] == "alternate" })
+      yaml.delete("links") if yaml["links"].empty?
+    end
+
+    entry = write_entry(yaml.to_yaml)
+    # the id doesn't appear in YAML, it should remain the same
+    entry.id = self.id
+
+    entry
+  end
+end
+
+# maybe this should handle displaying the list too.
+def choose_from list
+  item = nil
+  itemno = nil
+
+  # oh wow this is pathetic
+  until item
+    if itemno
+      puts "try picking a number on the list."
+    end
+
+    print "? "
+    itemno = $stdin.gets.chomp
+
+    item = list[itemno.to_i]
+  end
+
+  item
+end
+
+def choose_collection server
+  puts "which collection?"
+
+  collections = []
+
+  # still lame
+  server.collections.each_with_index do |coll, index|
+    collections << coll
+
+    puts "#{index}: #{coll.title}"
+  end
+
+  choose_from collections
+end
+
+def choose_entry_url coll
+  puts "which entry?"
+
+  coll.entries.each_with_index do |entry, index|
+    puts "#{index}: #{entry.title}"
+  end
+
+  entry = choose_from coll.entries
+
+  edit_link = entry.links.find do |link|
+    link["rel"] = "edit"
+  end
+
+  edit_link["href"]
+end
+
+def write_entry(editstring = "")
+  begin
+    edited = editstring.edit_externally
+
+    if edited == editstring
+      puts "unchanged content, aborted"
+      exit
+    end
+
+    entry = Atom::Entry.from_yaml edited
+
+    entry.prepare_for_output
+
+    # XXX disabled until the APP WG can decide what a valid entry is
+=begin
+    valid, message = entry.valid?
+    unless valid
+      print "entry is invalid (#{message}). post anyway? (y/n)? "
+      (gets.chomp == "y") || (raise Atom::InvalidEntry.new)
+    end
+=end
+
+    # this has to be here ATM to we can detect malformed atom:content
+    puts entry.to_s
+  rescue ArgumentError,REXML::ParseException => e
+    puts e
+    
+    puts "press enter to edit again..."
+    $stdin.gets
+
+    editstring = edited
+
+    retry
+  rescue Atom::InvalidEntry
+    editstring = edited
+    retry
+  end
+
+  entry
+end
+
+module Atom
+  class InvalidEntry < RuntimeError
+  end
+end
+
+EDITOR = ENV["EDITOR"] || "env vim"
+
+# now that i'm supporting -07 the interface has been shittified. apologies.
+introspection_url = ARGV[0]
+
+http = Atom::HTTP.new
+http.user = ARGV[1]
+http.pass = ARGV[2]
+
+server = Atom::App.new(introspection_url, http)
+
+coll = choose_collection server
+
+# XXX the server should *probably* replace this, but who knows yet?
+CLIENT_ID = "http://necronomicorp.com/dev/null"
+
+new = lambda do
+  entry = Atom::Entry.new
+  
+  entry.title = ""
+  entry.content = ""
+
+  entry = entry.edit
+
+  entry.id = CLIENT_ID
+  entry.published = Time.now.iso8601
+
+  res = coll.post! entry
+
+  # XXX error recovery here, lost updates suck
+  puts res.body
+end
+
+edit = lambda do
+  coll.update!
+
+  coll.entries.each_with_index do |entry,idx|
+    puts "#{idx}: #{entry.title}"
+  end
+
+  entry = choose_from(coll.entries) { |entry| entry.title }
+
+  url = entry.edit_url
+
+  entry = http.get_atom_entry url
+
+  res = coll.put! entry.edit, url
+
+  # XXX error recovery here, lost updates suck
+  puts res.body
+end
+
+delete = lambda do
+  coll.update!
+  
+  coll.entries.each_with_index do |entry,idx|
+    puts "#{idx} #{entry.title}"
+  end
+
+  entry = choose_from(coll.entries)
+  res = coll.delete! entry
+
+  puts res.body
+end
+
+actions = [ new, edit, delete ]
+
+puts "0: new entry"
+puts "1: edit entry"
+puts "2: delete entry"
+
+choose_from(actions).call

data/bin/atom-server.rb~

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby
+
+require "atom/pub-server"
+require "webrick/httpserver"
+require "atom/feed"
+
+# syntax: ./atom-server <port> <path>
+
+module Atom
+  # @docs must implement [], []=, next_id! 
+  # including servlet must implement gen_id, url_to_key, key_to_url, do_GET
+  class MemoryCollection < WEBrick::HTTPServlet::AbstractServlet
+    include Atom::AtomPub
+
+    def initialize server, docs
+      super
+
+      @docs = docs
+    end
+
+    def gen_id key
+      key
+    end
+    
+    def key_to_url req, key
+      req.script_name + "/" + key
+    end
+
+    def url_to_key url
+      url.split("/").last
+    end
+
+    def add_edit entry, key
+      edit = entry.links.new
+      edit["rel"] = "edit"
+      edit
+    end
+
+    def do_GET req, res
+      res.body = if req.path_info.empty? or req.path_info == "/"
+        feed = Atom::Feed.new
+        
+        @docs.each do |key,doc|
+          entry = doc.to_atom_entry
+          add_edit(entry, key)["href"] = key_to_url(req, key)
+          feed << entry
+        end
+
+        feed.entries.first.to_s
+      else
+        key = url_to_key(req.request_uri.to_s)
+        entry = @docs[key].to_atom_entry
+        add_edit(entry, key)["href"] = key_to_url(req, key)
+        entry.to_s
+      end
+    end
+  end
+end
+
+h = WEBrick::HTTPServer.new(:Port => ARGV[0])
+
+docs = {}
+docs.instance_variable_set :@last_key, "0"
+
+def docs.next_key!
+  @last_key.next!
+end
+
+h.mount(ARGV[1], Atom::MemoryCollection, docs)
+
+h.start