atom-tools 0.9.0 → 2.0.5

data/spec/service_spec.rb

@@ -0,0 +1,108 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'atom/service'
+
+describe Atom::Service do
+  describe 'when parsing' do
+    before(:each) do
+      @service = Atom::Service.parse(fixtures(:service))
+    end
+
+    it 'should parse workspace elements correctly' do
+      @service.workspaces.length.should == 2
+    end
+
+    it 'should absolutize relative hrefs' do
+      svc = Atom::Service.parse(
+        fixtures('service-w-xhtml-ns'),
+        'http://example.org/introspection/')
+
+      coll = svc.workspaces.first.collections.first
+      coll.href.should == "http://example.org/entries/?yanel.resource.viewid=atom"
+    end
+
+    it 'should parse XHTML outside the default namespace correctly' do
+      xhtml_svc = Atom::Service.parse(fixtures('service-w-xhtml-ns'))
+
+      xhtml_svc.workspaces.length.should == 2
+      xhtml_coll = xhtml_svc.workspaces.last.collections.first
+      xhtml_coll.title.html.strip.should == 'Yulup <b>Releases</b>'
+    end
+  end
+end
+
+describe Atom::Workspace do
+  describe 'when parsing' do
+    before(:each) do
+      svc = Atom::Service.parse(fixtures(:service))
+      @main = svc.workspaces.first
+      @sidebar = svc.workspaces.last
+    end
+
+    it 'should parse title element correctly' do
+      @main.title.to_s.should == 'Main Site'
+      @sidebar.title.to_s.should == 'Sidebar Blog'
+    end
+
+    it 'should parse collection elements correctly' do
+      @main.collections.length.should == 2
+      @sidebar.collections.length.should == 1
+    end
+  end
+end
+
+describe Atom::Collection do
+  describe 'when parsing' do
+    before(:each) do
+      svc = Atom::Service.parse(fixtures(:service))
+      @entries = svc.workspaces.first.collections.first
+      @pictures = svc.workspaces.first.collections.last
+      @links = svc.workspaces.last.collections.first
+    end
+
+    it 'should parse href correctly' do
+      @entries.href.should == 'http://example.org/blog/main'
+      @entries.feed.uri.to_s.should == 'http://example.org/blog/main'
+
+      @pictures.href.should == 'http://example.org/blog/pic'
+      @links.href.should == 'http://example.org/sidebar/list'
+    end
+
+    it 'should parse title element correctly' do
+      @entries.title.to_s.should == 'My Blog Entries'
+      @pictures.title.to_s.should == 'Pictures'
+      @links.title.to_s.should == 'Remaindered Links'
+    end
+
+    it 'should parse accept elements correctly' do
+      @entries.accepts.should == ['application/atom+xml;type=entry']
+      @pictures.accepts.should == ['image/png', 'image/jpeg', 'image/gif']
+      @links.accepts.should == ['application/atom+xml;type=entry']
+    end
+  end
+end
+
+describe Atom::Categories do
+  describe 'when parsing' do
+    before(:each) do
+      svc = Atom::Service.parse(fixtures(:service))
+      @ool = svc.workspaces.first.collections.first.categories.first
+      @il = svc.workspaces.last.collections.first.categories.first
+    end
+
+    it 'should parse out-of-line categories correctly' do
+      @ool.href.should == 'http://example.com/cats/forMain.cats'
+    end
+
+    it 'should parse inline categories correctly' do
+      @il.fixed.should be_true
+
+      @il.list.length.should == 2
+
+      @il.list.first.scheme.should == 'http://example.org/extra-cats/'
+      @il.list.first.term.should == 'joke'
+
+      @il.list.last.term.should == 'serious'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'spec'
+
+$:.unshift 'lib/', File.dirname(__FILE__) + '/../lib'
+
+def fixtures(name)
+  File.read(File.dirname(__FILE__) + "/fixtures/#{name}.xml")
+end
+

data/test/conformance/order.rb

@@ -9,23 +9,23 @@ FEED.update!
 class TestOrderConformance < Test::Unit::TestCase
   def test_0
     entry = FEED.entries[0]
-    
+
     assert_equal "tag:example.org,2006:atom/conformance/element_order/1", entry.id
     assert_equal "Simple order, nothing fancy", entry.title.to_s
     assert_equal "Simple ordering, nothing fancy", entry.summary.to_s
     assert_equal Time.parse("2006-01-26T09:20:01Z"), entry.updated
-    
+
     assert_alternate_href(entry, "http://www.snellspace.com/public/alternate")
   end
 
   def test_1
     entry = FEED.entries[1]
-    
+
     assert_equal "tag:example.org,2006:atom/conformance/element_order/2", entry.id
     assert_equal "Same as the first, only mixed up a bit", entry.title.to_s
     assert_equal "Same as the first, only mixed up a bit", entry.summary.to_s
     assert_equal Time.parse("2006-01-26T09:20:02Z"), entry.updated
-    
+
     assert_alternate_href(entry, "http://www.snellspace.com/public/alternate")
   end
 
@@ -34,8 +34,9 @@ class TestOrderConformance < Test::Unit::TestCase
     entry = FEED.entries[2]
 
     # both links should be available, but it's up to you to choose which one to use 
+
     assert_link_href(entry, "http://www.snellspace.com/public/alternate") { |l| l["rel"] == "alternate" and l["type"] == nil }
-    
+
     assert_link_href(entry, "http://www.snellspace.com/public/alternate2") { |l| l["rel"] == "alternate" and l["type"] == "text/plain" }
   end
 
@@ -65,7 +66,7 @@ class TestOrderConformance < Test::Unit::TestCase
   #  ^-- quoted summary is a typo, source is last
   def test_5
     entry = FEED.entries[5]
-    
+
     assert_equal "tag:example.org,2006:atom/conformance/element_order/6", entry.id
     assert_equal "Entry with a source last", entry.title.to_s
     assert_equal Time.parse("2006-01-26T09:20:06Z"), entry.updated
@@ -91,18 +92,18 @@ class TestOrderConformance < Test::Unit::TestCase
     assert_equal "tag:example.org,2006:atom/conformance/element_order/8", entry.id
     assert_equal "Atom elements in an extension element", entry.title.to_s
     assert_equal Time.parse("2006-01-26T09:20:08Z"), entry.updated
-    
+
     assert_alternate_href(entry, "http://www.snellspace.com/public/alternate")
   end
-  
+
   # Atom elements in an extension element
   def test_8
     entry = FEED.entries[8]
-    
+
     assert_equal "tag:example.org,2006:atom/conformance/element_order/9", entry.id
     assert_equal "Atom elements in an extension element", entry.title.to_s
     assert_equal Time.parse("2006-01-26T09:20:09Z"), entry.updated
-    
+
     assert_alternate_href(entry, "http://www.snellspace.com/public/alternate")
   end
 

data/test/conformance/title.rb

@@ -25,18 +25,18 @@ class TestTitleConformance < Test::Unit::TestCase
     feed.update!
 
     entry = feed.entries.first
-    assert_equal "html", entry.title["type"] 
+    assert_equal "html", entry.title["type"]
     assert_equal "&lt;title>", entry.title.html
   end
 
   def test_html_entity
     url = "http://atomtests.philringnalda.com/tests/item/title/html-entity.atom"
-    
+
     feed = Atom::Feed.new(url)
     feed.update!
 
     entry = feed.entries.first
-    assert_equal "html", entry.title["type"] 
+    assert_equal "html", entry.title["type"]
     assert_equal "&lt;title>", entry.title.html
   end
 
@@ -47,7 +47,7 @@ class TestTitleConformance < Test::Unit::TestCase
     feed.update!
 
     entry = feed.entries.first
-    assert_equal "html", entry.title["type"] 
+    assert_equal "html", entry.title["type"]
     assert_equal "&lt;title>", entry.title.html
   end
 
@@ -78,7 +78,7 @@ class TestTitleConformance < Test::Unit::TestCase
 
     feed = Atom::Feed.new(url)
     feed.update!
-    
+
     entry = feed.entries.first
     assert_equal "text", entry.title["type"]
     assert_equal "&lt;title&gt;", entry.title.html
@@ -86,10 +86,10 @@ class TestTitleConformance < Test::Unit::TestCase
 
   def test_xhtml_entity
     url = "http://atomtests.philringnalda.com/tests/item/title/xhtml-entity.atom"
-    
+
     feed = Atom::Feed.new(url)
     feed.update!
-    
+
     entry = feed.entries.first
     assert_equal "xhtml", entry.title["type"]
     assert_equal "&lt;title>", entry.title.html
@@ -97,10 +97,10 @@ class TestTitleConformance < Test::Unit::TestCase
 
   def test_xhtml_ncr
     url = "http://atomtests.philringnalda.com/tests/item/title/xhtml-ncr.atom"
-    
+
     feed = Atom::Feed.new(url)
     feed.update!
-    
+
     entry = feed.entries.first
     assert_equal "xhtml", entry.title["type"]
     assert_equal "&#60;title>", entry.title.html

data/test/conformance/updated.rb

@@ -16,7 +16,8 @@ class TestUpdatedConformance < Test::Unit::TestCase
   
     # this is an insignificant change, 
     # (ie. atom:updated_1 == atom:updated_2),
-    # but that's for you to handle
+    #
+    # the update is applied, your application can handle that however it wants.
     feed.update!
     assert_equal "12 of 13 miner<b>s</b> survive mine collapse", feed.entries.first.content.to_s.strip
    

data/test/test_constructs.rb

@@ -2,11 +2,54 @@ require "test/unit"
 require "atom/entry"
 
 class ConstructTest < Test::Unit::TestCase
+  def test_text_construct_html_to_xml
+    begin
+      require "hpricot"
+    rescue LoadError
+      # hpricot isn't installed, just skip this test
+      puts "skipping hpricot tests"
+      return
+    end
+
+    entry = Atom::Entry.new
+
+html = <<END
+<p>Paragraph 1 contains <a href=http://example.org/>a link
+<p>This really is a horrendous mess.
+END
+
+    entry.content = html
+    entry.content["type"] = "html"
+
+    xhtml = entry.content.xml
+
+    # Hpricot is imperfect; for now I'll just test that it's parseable
+    assert_instance_of REXML::Element, xhtml
+    assert_equal 'div', xhtml.name
+
+=begin
+    assert_equal 2, xhtml.length
+
+    first = xhtml.first
+    assert_equal "p", first.name
+    assert_equal 2, first.children.length
+
+    a = first.children.last
+    assert_equal "a", a.name
+    assert_equal "http://example.org/", a.attributes["href"]
+    assert_equal "a link", a.text
+
+    last = xhtml.last
+    assert_equal "p", last.name
+    assert_equal "This really is a horrendous mess.", last.text
+=end
+  end
+
   def test_text_construct_text
     entry = Atom::Entry.new
 
-    assert_nil(entry.title)
-    assert_equal("", entry.title.to_s)
+    assert_nil entry.title
+    assert_equal "", entry.title.to_s
 
     entry.title = "<3"
 
@@ -30,7 +73,7 @@ class ConstructTest < Test::Unit::TestCase
     assert_equal "html", entry.title["type"]
     assert_equal "<3", entry.title.to_s
     assert_equal "&lt;3", entry.title.html
-    
+
     title = entry.to_xml.root.children.first
     assert_equal "<3", title.text
 =end
@@ -46,9 +89,9 @@ class ConstructTest < Test::Unit::TestCase
     entry = Atom::Entry.new
 
     entry.title = "<3"
-    assert_raises(RuntimeError) { entry.title["type"] = "xhtml" }
-   
-    assert_raises(RuntimeError) do
+    assert_raises(Atom::ParseError) { entry.title["type"] = "xhtml" }
+
+    assert_raises(Atom::ParseError) do
       entry.title["type"] = "application/xhtml+xml"
     end
 
@@ -81,11 +124,38 @@ class ConstructTest < Test::Unit::TestCase
     assert_equal("", entry.content.to_s)
   end
 
+  def test_multiple
+    entry = Atom::Entry.new
+
+    link = Atom::Link.new
+    link["href"] = "http://example.org/"
+
+    assert_raises(ArgumentError) { entry.authors << "test" }
+    assert_raises(ArgumentError) { entry.authors << link }
+
+    entry.links << link
+
+    assert_equal 1, entry.links.length
+  end
+
+  def test_nice_multiple
+    entry = Atom::Entry.new
+
+    entry.authors.new :name => 'Brendan Taylor', :email => 'fake@fake.com', :uri => 'http://necronomicorp.com/bct'
+    entry.authors.new :name => 'some jerk'
+
+    assert_equal 2, entry.authors.length
+
+    assert_equal 'Brendan Taylor', entry.authors.first.name
+  end
+
   require "date"
   def test_date_construct
+    entry = Atom::Entry.new
+
     today = Date.today
-    time = Atom::Time.new today
+    entry.updated = today
 
-    assert_match(/^#{today}T00:00:00/, time.to_s)
+    assert_match(/^#{today}T00:00:00/, entry.updated.to_s)
   end
 end

data/test/test_feed.rb

@@ -60,6 +60,8 @@ END
 
   def test_update
     @s.mount_proc("/") do |req,res|
+      assert_equal "application/atom+xml", req["Accept"]
+
       res.content_type = "application/atom+xml"
       res.body = @test_feed
 
@@ -81,48 +83,52 @@ END
     assert_equal 1, feed.entries.length
   end
 
-  def test_conditional_get
-    @s.mount_proc("/") do |req,res|
-      assert_nil req["If-None-Match"]
-      assert_nil req["If-Modified-Since"]
-
-      res["Etag"] = '"xyzzy"'
-      res["Last-Modified"] = 'Wed, 15 Nov 1995 04:58:08 GMT'
-      res.content_type = "application/atom+xml"
-      res.body = @test_feed
-
-      @s.stop
+  def test_media_types
+    c = proc do |c_t|
+      @s.mount_proc("/") do |req,res|
+        res.content_type = c_t
+        res.body = @test_feed
+
+        @s.stop
+      end
+      # there's some kind of race condition here that will result in a
+      # timeout sometimes. this is a dirty fix.
+      sleep 0.5
+      one_shot
     end
-
+    
     feed = Atom::Feed.new "http://localhost:#{@port}/"
 
-    assert_equal 0, feed.entries.length
-    assert_equal nil, feed.etag
-    assert_equal nil, feed.last_modified
+    # even if it looks like a feed, the server's word is law
+    c.call("text/plain")
+    assert_raise(Atom::WrongMimetype) { feed.update! }
 
-    one_shot
+    # a parameter shouldn't change the type
+    c.call("application/atom+xml;type=feed")
+    assert_nothing_raised { feed.update! }
 
-    feed.update!
+    # type and subtype are case insensitive (param. attribute names too)
+    c.call("ApPliCatIon/ATOM+XML")
+    assert_nothing_raised { feed.update! }
 
-    assert_equal 1, feed.entries.length
-    assert_equal '"xyzzy"', feed.etag
-    assert_equal 'Wed, 15 Nov 1995 04:58:08 GMT', feed.last_modified
+    # text/xml isn't the preferred mimetype, but we'll accept it
+    c.call("text/xml")
+    assert_nothing_raised { feed.update! }
 
+    # same goes for application/xml
+    c.call("application/xml")
+    assert_nothing_raised { feed.update! }
+
+    # nil content type
     @s.mount_proc("/") do |req,res|
-      assert_equal '"xyzzy"', req["If-None-Match"]
-      assert_equal 'Wed, 15 Nov 1995 04:58:08 GMT', req["If-Modified-Since"]
+      res.body = @test_feed
 
-      res.status = 304
-      res.body = "this hasn't been modified"
-      
       @s.stop
     end
-
     one_shot
-    feed.update!
-
-    assert_equal 1, feed.entries.length
+    assert_raises(Atom::HTTPException) { feed.update! }
   end
 
+  # prepares the server for a single request
   def one_shot; Thread.new { @s.start }; end
 end

data/test/test_general.rb

@@ -2,9 +2,6 @@
 
 require "test/unit"
 
-require "atom/yaml"
-require "atom/xml"
-
 require "atom/feed"
 
 class AtomTest < Test::Unit::TestCase
@@ -46,30 +43,6 @@ class AtomTest < Test::Unit::TestCase
     assert_has_category(xml, "tags")
   end
 
-  def test_snarf_yaml
-    yaml = """title: testing YAML
-authors:
-- name: Mr. Safe
-  uri: http://example.com/
-links:
-- href: http://atomenabled.org/
-content: not much here\
-"""
-
-    entry = Atom::Entry.from_yaml(yaml)
-
-    assert_equal("testing YAML", entry.title.to_s)
-
-    assert_equal(1, entry.authors.length)
-    assert_equal("Mr. Safe", entry.authors.first.name)
-    assert_equal("http://example.com/", entry.authors.first.uri)
-    
-    assert_equal(1, entry.links.length)
-    assert_equal("http://atomenabled.org/", entry.links.first["href"])
-
-    assert_equal("not much here", entry.content.to_s)
-  end
- 
   def assert_has_category xml, term
     assert_not_nil(REXML::XPath.match(xml, "/entry/category[@term = #{term}]"))
   end
@@ -85,10 +58,10 @@ content: not much here\
   def get_elements entry
     xml = entry.to_xml
 
-    assert_equal(entry.to_s, Atom::Entry.parse(xml).to_s) 
-    
+    assert_equal(entry.to_s, Atom::Entry.parse(xml).to_s)
+
     base_check xml
-    
+
     xml
   end