atom-tools 0.9.0 → 0.9.1

data/test/test_protocol.rb

@@ -1,6 +1,6 @@
 require "test/unit"
 
-require "atom/app"
+require "atom/service"
 
 class FakeHTTP
   Response = Struct.new(:body, :code, :content_type)
@@ -20,8 +20,7 @@ end
 
 class AtomProtocolTest < Test::Unit::TestCase
   def test_introspection
-
-    service = <<END
+    doc = <<END
 <service xmlns="http://purl.org/atom/app#"
   xmlns:atom="http://www.w3.org/2005/Atom">
   <workspace>
@@ -37,24 +36,89 @@ class AtomProtocolTest < Test::Unit::TestCase
 </service>
 END
     
-    http = FakeHTTP.new({ "http://example.com/service.xml" => service }, "application/atomserv+xml")
+    #http = FakeHTTP.new({ "http://example.com/service.xml" => service }, "application/atomserv+xml")
+
+    service = Atom::Service.new
+    service.parse doc
+    #service = Atom::Service.new "http://example.com/service.xml", http
+
+    ws = service.workspaces.first
+    assert_equal "My Blog", ws.title.to_s 
 
+    coll = ws.collections.first
+    assert_equal URI.parse("http://example.org/myblog/entries"), coll.uri 
+    assert_equal "Entries", coll.title.to_s 
+    assert_equal "entry", coll.accepts 
 
-    server = Atom::App.new "http://example.com/service.xml", http
+    coll = ws.collections.last
+    assert_equal URI.parse("http://example.org/myblog/fotes"), coll.uri 
+    assert_equal "Photos", coll.title.to_s 
+    assert_equal "image/*", coll.accepts 
 
-    coll = server.collections.first
-    assert_equal(URI.parse("http://example.org/myblog/entries"), coll.uri)
-    assert_equal("Entries", coll.title.to_s)
-    assert_equal("entry", coll.accepts)
+    http = service.instance_variable_get(:@http)
+    assert_instance_of Atom::HTTP, http
 
-    coll = server.collections.last
-    assert_equal(URI.parse("http://example.org/myblog/fotes"), coll.uri)
-    assert_equal("Photos", coll.title.to_s)
-    assert_equal("image/*", coll.accepts)
+    # collections should inherit the service's HTTP object
+    assert_equal http, coll.instance_variable_get(:@http)
 
     # XXX write a test for relative hrefs
   end
 
+  def test_write_introspection
+    service = Atom::Service.new
+
+    ws = service.workspaces.new
+
+    ws.title = "Workspace 1"
+
+    coll = Atom::Collection.new "http://example.org/entries"
+    coll.title = "Entries"
+    ws.collections << coll
+
+    coll = Atom::Collection.new "http://example.org/audio"
+    coll.title = "Audio"
+    coll.accepts = "audio/*"
+    ws.collections << coll
+
+    nses = { "app" => Atom::PP_NS, "atom" => Atom::NS }
+
+    doc = REXML::Document.new(service.to_s)
+
+    assert_equal "http://purl.org/atom/app#", doc.root.namespace
+
+    ws = REXML::XPath.first( doc.root, 
+                              "/app:service/app:workspace", 
+                              nses )
+   
+    title = REXML::XPath.first( ws, "./atom:title", nses)
+
+    assert_equal "Workspace 1", title.text
+    assert_equal "http://www.w3.org/2005/Atom", title.namespace
+
+    colls = REXML::XPath.match( ws, "./app:collection", nses)
+    assert_equal(2, colls.length)
+
+    entries = colls.first
+
+    assert_equal "http://example.org/entries", entries.attributes["href"]
+
+    title = REXML::XPath.first(entries, "./atom:title", nses)
+    assert_equal "Entries", title.text
+
+    accepts = REXML::XPath.first(entries, "./app:accepts", nses)
+    assert_nil accepts
+
+    audio = colls.last
+
+    assert_equal "http://example.org/audio", audio.attributes["href"]
+
+    title = REXML::XPath.first(audio, "./atom:title", nses)
+    assert_equal "Audio", title.text
+
+    accepts = REXML::XPath.first(audio, "./app:accepts", nses)
+    assert_equal "audio/*", accepts.text
+  end
+
   def test_dont_specify_http_object
     collection = Atom::Collection.new("http://necronomicorp.com/testatom?atom")
 

data/test/test_xml.rb

@@ -1,7 +1,7 @@
 require "test/unit"
 
 # for entry.edit_url
-require "atom/app"
+require "atom/service"
 
 class AtomTest < Test::Unit::TestCase
   def test_text_type_text
@@ -287,6 +287,20 @@ END
     assert_equal "", entry.content.to_s
   end
 
+  def test_serialize_base
+    entry = Atom::Entry.new
+
+    entry.base = "http://necronomicorp.com/nil"
+  
+    base = get_elements(entry).root.attributes["xml:base"]
+    assert_equal "http://necronomicorp.com/nil", base
+
+    entry.base = URI.parse("http://necronomicorp.com/nil")
+
+    base = get_elements(entry).root.attributes["xml:base"]
+    assert_equal "http://necronomicorp.com/nil", base
+  end
+
   def test_relative_base
     base_url = "http://www.tbray.org/ongoing/ongoing.atom"
     doc = "<entry xmlns='http://www.w3.org/2005/Atom' xml:base='When/200x/2006/10/11/'/>"

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: atom-tools
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
-date: 2006-11-10 00:00:00 -07:00
+  version: 0.9.1
+date: 2006-11-26 00:00:00 -07:00
 summary: Tools for working with Atom Entries, Feeds and Collections
 require_paths: 
 - lib
@@ -32,42 +32,7 @@ files:
 - README
 - Rakefile
 - setup.rb
-- bin/atom-server.rb~
 - bin/atom-client.rb
-- doc/files
-- doc/index.html
-- doc/rdoc-style.css
-- doc/fr_method_index.html
-- doc/fr_class_index.html
-- doc/fr_file_index.html
-- doc/created.rid
-- doc/classes
-- doc/files/lib
-- doc/files/README.html
-- doc/files/lib/atom
-- doc/files/lib/atom/feed_rb.html
-- doc/files/lib/atom/text_rb.html
-- doc/files/lib/atom/xml_rb.html
-- doc/files/lib/atom/yaml_rb.html
-- doc/files/lib/atom/element_rb.html
-- doc/files/lib/atom/app_rb.html
-- doc/files/lib/atom/entry_rb.html
-- doc/files/lib/atom/http_rb.html
-- doc/files/lib/atom/collection_rb.html
-- doc/classes/Atom
-- doc/classes/XHTML.html
-- doc/classes/Atom/Author.html
-- doc/classes/Atom/Element.html
-- doc/classes/Atom/App.html
-- doc/classes/Atom/Feed.html
-- doc/classes/Atom/Text.html
-- doc/classes/Atom/Contributor.html
-- doc/classes/Atom/HTTP.html
-- doc/classes/Atom/Link.html
-- doc/classes/Atom/Collection.html
-- doc/classes/Atom/Content.html
-- doc/classes/Atom/Category.html
-- doc/classes/Atom/Entry.html
 - test/test_constructs.rb
 - test/runtests.rb
 - test/test_feed.rb
@@ -85,8 +50,8 @@ files:
 - lib/atom/yaml.rb
 - lib/atom/feed.rb
 - lib/atom/text.rb
-- lib/atom/app.rb
 - lib/atom/collection.rb
+- lib/atom/service.rb
 - lib/atom/entry.rb
 - lib/atom/xml.rb
 - lib/atom/element.rb

data/bin/atom-server.rb~

@@ -1,71 +0,0 @@
-#!/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

data/doc/classes/Atom/App.html

@@ -1,217 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!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" xml:lang="en" lang="en">
-<head>
-  <title>Class: Atom::App</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
-          <td class="class-name-in-header">Atom::App</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../files/lib/atom/app_rb.html">
-                lib/atom/app.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Object
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-<a href="App.html">Atom::App</a> represents an Atom Publishing Protocol
-introspection document.
-</p>
-
-    </div>
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000006">new</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-
-
-
-
-    <div id="attribute-list">
-      <h3 class="section-bar">Attributes</h3>
-
-      <div class="name-list">
-        <table>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">collections</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-          <td class="context-item-desc">
-collections referred to by the introspection document
-
-</td>
-        </tr>
-        </table>
-      </div>
-    </div>
-      
-
-
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Class methods</h3>
-
-      <div id="method-M000006" class="method-detail">
-        <a name="M000006"></a>
-
-        <div class="method-heading">
-          <a href="#M000006" class="method-signature">
-          <span class="method-name">new</span><span class="method-args">(introspection_url, http = Atom::HTTP.new)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-retrieves and parses an Atom introspection document.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000006-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/atom/app.rb, line 23</span>
-23:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">introspection_url</span>, <span class="ruby-identifier">http</span> = <span class="ruby-constant">Atom</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">new</span>)
-24:       <span class="ruby-identifier">i_url</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">introspection_url</span>)
-25: 
-26:       <span class="ruby-identifier">rxml</span> = <span class="ruby-keyword kw">nil</span>
-27: 
-28:       <span class="ruby-identifier">res</span> = <span class="ruby-identifier">http</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">i_url</span>)
-29: 
-30:       <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;200&quot;</span> <span class="ruby-comment cmt"># redirects, &amp;c.</span>
-31:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">WrongResponse</span>, <span class="ruby-node">&quot;introspection document responded with unexpected code #{res.code}&quot;</span>
-32:       <span class="ruby-keyword kw">end</span>
-33: 
-34:       <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">content_type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;application/atomserv+xml&quot;</span>
-35:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">WrongMimetype</span>, <span class="ruby-value str">&quot;this isn't an introspection document!&quot;</span>
-36:       <span class="ruby-keyword kw">end</span>
-37: 
-38:       <span class="ruby-identifier">rxml</span> = <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">res</span>.<span class="ruby-identifier">body</span>)
-39: 
-40:       <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">rxml</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">namespace</span> <span class="ruby-operator">==</span> <span class="ruby-constant">PP_NS</span>
-41:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">WrongNamespace</span>, <span class="ruby-value str">&quot;this isn't an introspection document!&quot;</span>
-42:       <span class="ruby-keyword kw">end</span>
-43: 
-44:       <span class="ruby-comment cmt"># TODO: expose workspaces</span>
-45:       <span class="ruby-identifier">colls</span> = <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">XPath</span>.<span class="ruby-identifier">match</span>( <span class="ruby-identifier">rxml</span>, 
-46:                                   <span class="ruby-value str">&quot;/app:service/app:workspace/app:collection&quot;</span>,
-47:                                   {<span class="ruby-value str">&quot;app&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Atom</span><span class="ruby-operator">::</span><span class="ruby-constant">PP_NS</span>} )
-48:       
-49:       <span class="ruby-ivar">@collections</span> = []
-50:       
-51:       <span class="ruby-identifier">colls</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">collection</span><span class="ruby-operator">|</span>
-52:         <span class="ruby-comment cmt"># absolutize relative URLs</span>
-53:         <span class="ruby-identifier">url</span> = <span class="ruby-identifier">i_url</span> <span class="ruby-operator">+</span> <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">collection</span>.<span class="ruby-identifier">attributes</span>[<span class="ruby-value str">&quot;href&quot;</span>])
-54:        
-55:         <span class="ruby-identifier">coll</span> = <span class="ruby-constant">Atom</span><span class="ruby-operator">::</span><span class="ruby-constant">Collection</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">http</span>)
-56: 
-57:         <span class="ruby-comment cmt"># XXX this is a Text Construct, and should be parsed as such</span>
-58:         <span class="ruby-identifier">coll</span>.<span class="ruby-identifier">title</span> = <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">XPath</span>.<span class="ruby-identifier">first</span>( <span class="ruby-identifier">collection</span>,
-59:                                     <span class="ruby-value str">&quot;./atom:title&quot;</span>,
-60:                                     {<span class="ruby-value str">&quot;app&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Atom</span><span class="ruby-operator">::</span><span class="ruby-constant">PP_NS</span>,
-61:                                      <span class="ruby-value str">&quot;atom&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Atom</span><span class="ruby-operator">::</span><span class="ruby-constant">NS</span>   } ).<span class="ruby-identifier">text</span>
-62: 
-63:         <span class="ruby-identifier">accepts</span> = <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">XPath</span>.<span class="ruby-identifier">first</span>( <span class="ruby-identifier">collection</span>,
-64:                                       <span class="ruby-value str">&quot;./app:accept&quot;</span>,
-65:                                       {<span class="ruby-value str">&quot;app&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Atom</span><span class="ruby-operator">::</span><span class="ruby-constant">PP_NS</span>} )
-66:         <span class="ruby-identifier">coll</span>.<span class="ruby-identifier">accepts</span> = (<span class="ruby-identifier">accepts</span> <span class="ruby-value">? </span><span class="ruby-identifier">accepts</span>.<span class="ruby-identifier">text</span> <span class="ruby-operator">:</span> <span class="ruby-value str">&quot;entry&quot;</span>)
-67:         
-68:         <span class="ruby-ivar">@collections</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">coll</span>
-69:       <span class="ruby-keyword kw">end</span>
-70:     <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-
-    </div>
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>