atom-tools 0.9.0 → 2.0.5

data/spec/entry_spec.rb

@@ -0,0 +1,364 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'atom/entry'
+
+module TestsXML
+  def read_entry_xml xpath
+    REXML::XPath.first(@entry.to_xml, xpath, { 'atom' => Atom::NS, 'app' => Atom::PP_NS })
+  end
+end
+
+describe Atom::Entry do
+  describe 'when parsing' do
+    before(:each) do
+      @entry = Atom::Entry.parse(fixtures(:entry))
+      @empty_entry = '<entry xmlns="http://www.w3.org/2005/Atom" />'
+    end
+
+    it 'should read & parse input from an IO object' do
+      input = mock('IO')
+      input.should_receive(:read).and_return(@empty_entry)
+      Atom::Entry.parse(input).should be_an_instance_of(Atom::Entry)
+    end
+
+    it 'should read & parse input from a string' do
+      input = mock('string')
+      input.should_receive(:to_s).and_return(@empty_entry)
+      Atom::Entry.parse(input).should be_an_instance_of(Atom::Entry)
+    end
+
+    it 'should raise ParseError when invalid entry' do
+      lambda { Atom::Entry.parse('<entry/>') }.should raise_error(Atom::ParseError)
+    end
+
+    it 'should parse title element correctly' do
+      @entry.title.should be_is_a(Atom::Text)
+      @entry.title['type'].should == 'text'
+      @entry.title.to_s.should == 'Atom draft-07 snapshot'
+    end
+
+    it 'should parse id element correctly' do
+      @entry.id.should == 'tag:example.org,2003:3.2397'
+    end
+
+    it 'should parse updated element correctly' do
+      @entry.updated.should == Time.parse('2005-07-31T12:29:29Z')
+    end
+
+    it 'should parse published element correctly' do
+      @entry.published.should == Time.parse('2003-12-13T08:29:29-04:00')
+    end
+
+    it 'should parse app:edited element correctly' do
+      @entry.edited.should == Time.parse('2005-07-31T12:29:29Z')
+    end
+
+    it 'should parse app:control/draft element correctly' do
+      @entry.draft?.should be_true
+    end
+
+    it 'should parse rights element correctly' do
+      @entry.rights.should be_is_a(Atom::Text)
+      @entry.rights['type'].should == 'text'
+      @entry.rights.to_s.should == 'Copyright (c) 2003, Mark Pilgrim'
+    end
+
+    it 'should parse author element correctly' do
+      @entry.authors.length.should == 1
+      @entry.authors.first.name.should == 'Mark Pilgrim'
+      @entry.authors.first.email.should == 'f8dy@example.com'
+      @entry.authors.first.uri.should == 'http://example.org/'
+    end
+
+    it 'should parse contributor element correctly' do
+      @entry.contributors.length.should == 2
+      @entry.contributors.first.name.should == 'Sam Ruby'
+      @entry.contributors[1].name.should == 'Joe Gregorio'
+    end
+
+    it 'should parse content element correctly' do
+      @entry.content.should be_an_instance_of(Atom::Content)
+      @entry.content['type'].should == 'xhtml'
+      @entry.content.base.should == 'http://diveintomark.org/'
+      @entry.content.to_s.strip.should == '<p><i>[Update: The Atom draft is finished.]</i></p>'
+    end
+
+    it 'should parse summary element correctly' do
+      @entry.summary['type'].should == 'text'
+      @entry.summary.to_s.should == 'Some text.'
+    end
+
+    it 'should parse links element correctly' do
+      @entry.links.length.should == 2
+      alternates = @entry.links.select { |l| l['rel'] == 'alternate' }
+      alternates.length.should == 1
+      alternates.first['href'].should == 'http://example.org/2005/04/02/atom'
+      alternates.first['type'].should == 'text/html'
+      @entry.links.last['rel'].should == 'enclosure'
+      @entry.links.last['href'].should == 'http://example.org/audio/ph34r_my_podcast.mp3'
+      @entry.links.last['type'].should == 'audio/mpeg'
+    end
+
+    it 'should parse category element correctly' do
+      @entry.categories.first['term'].should == 'ann'
+      @entry.categories.first['scheme'].should == 'http://example.org/cats'
+    end
+
+    it 'should parse source element correctly' do
+      @entry.source.title.to_s.should == 'Atom Sample Feed'
+      @entry.source.id.should == 'tag:example.org,2003:/'
+
+      @entry.source.links.length.should == 1
+      @entry.source.links.first.rel == 'self'
+
+      @entry.source.authors.length.should == 0
+
+      @entry.source.contributors.length.should == 1
+      @entry.source.contributors.first.name == 'Mark Pilgrim'
+    end
+  end
+
+  describe 'title element' do
+    before(:each) do
+      @entry = Atom::Entry.new
+    end
+
+    it 'should be nil if not defined' do
+      @entry.title.should be_nil
+
+      @entry.title.to_s.should == ''
+    end
+
+    it 'should accept a simple string' do
+      @entry.title = '<clever thing here>'
+
+      @entry.title.type.should == 'text'
+
+      @entry.title.to_s.should == '<clever thing here>'
+      @entry.title.html.should =~ /^&lt;clever thing/
+      @entry.title.to_xml.to_s.should =~ /&lt;clever thing/
+    end
+
+    it 'should accept an HTML string' do
+      @entry.title = 'even <em>cleverer</em>'
+      @entry.title.type = 'html'
+
+      @entry.title.type.should == 'html'
+
+      @entry.title.to_s.should =~ /even <em>clever/
+      @entry.title.html.should =~ /even <em>clever/
+      @entry.title.to_xml.to_s.should =~ /even &lt;em/
+    end
+
+    it 'should accept an XHTML string' do
+      @entry.title = 'the <strong>cleverest</strong>'
+      @entry.title.type = 'xhtml'
+
+      @entry.title.to_xml.to_s.should =~ /w3.org\/1999\/xhtml.>the <strong>/
+      @entry.title.html.should =~ /the <strong>cleverest/
+    end
+
+    it 'should reject an ill-formed XHTML string' do
+      @entry.title = 'the <strong>cleverest'
+      lambda { @entry.title.type = 'xhtml' }.should raise_error(Atom::ParseError)
+    end
+
+    it 'should accept something like Atom::Text' do
+      title = Atom::Title.new '<3'
+
+      @entry.title = title
+      @entry.title.type.should == 'text'
+
+      @entry.title.to_xml.to_s.should =~ /&lt;3/
+    end
+  end
+
+  describe 'updated element' do
+    before(:each) do
+      @entry = Atom::Entry.new
+    end
+
+    it 'should be nil if not defined' do
+      @entry.updated.should be_nil
+    end
+
+    it 'should be definable' do
+      @entry.updated = '1990-04-07'
+      @entry.updated.should == Time.parse('1990-04-07')
+    end
+
+    it 'should be an xsd:DateTime' do
+      @entry.updated = '1990-04-07'
+      @entry.updated.to_s.should =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/
+    end
+
+    it 'should be declarable as updated using #updated!' do
+      @entry.updated!
+      @entry.updated.should > Time.parse('1990-04-07')
+    end
+  end
+
+  describe 'app:edited element' do
+    include TestsXML
+
+    before(:each) do
+      @entry = Atom::Entry.new
+    end
+
+    it 'should be nil if not defined' do
+      @entry.edited.should be_nil
+    end
+
+    it 'should be definable' do
+      @entry.edited = '1990-04-07'
+      @entry.edited.should == Time.parse('1990-04-07')
+    end
+
+    it 'should be an xsd:DateTime' do
+      @entry.edited = '1990-04-07'
+      @entry.edited.to_s.should =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/
+    end
+
+    it 'should have APP namespace' do
+      @entry.edited = '1990-04-07'
+      read_entry_xml('app:edited').namespace.should == Atom::PP_NS
+    end
+
+    it 'should be declarable as edited using #edited!' do
+      @entry.edited!
+      @entry.edited.should > Time.parse('1990-04-07')
+    end
+  end
+
+  describe 'category element' do
+    before(:each) do
+      @entry = Atom::Entry.new
+    end
+
+    it 'should have no category on intializing' do
+      @entry.categories.should be_empty
+    end
+
+    it 'should increase total count when adding a new category' do
+      @count = @entry.categories.length
+      @entry.categories.new['term'] = 'foo'
+      @entry.categories.length.should == @count + 1
+    end
+
+    it 'should find category' do
+      category = @entry.categories.new
+      category['scheme'] = 'http://example.org/categories'
+      category['term'] = 'bar'
+      @entry.categories.select { |c| c['scheme'] == 'http://example.org/categories' }.should == [category]
+    end
+
+    describe 'when using tags' do
+      before(:each) do
+        @tags = %w(chunky bacon ruby)
+      end
+
+      it 'should set categories from an array of tags' do
+        @entry.tag_with(@tags)
+        @entry.categories.length.should == 3
+        @tags.each { |tag| @entry.categories.any? { |c| c['term'] == tag }.should be_true }
+      end
+
+      it 'should set categories from a space-sperated string of tags' do
+        @entry.tag_with(@tags.join(' '))
+        @entry.categories.length.should == 3
+        @tags.each { |tag| @entry.categories.any? { |c| c['term'] == tag }.should be_true }
+      end
+
+      it 'should be possible to specify the delimiter when passing tags as a string' do
+        @entry.tag_with(@tags.join(','), ',')
+        @entry.categories.length.should == 3
+        @tags.each { |tag| @entry.categories.any? { |c| c['term'] == tag }.should be_true }
+      end
+
+      it 'should create a category only once' do
+        @entry.tag_with(@tags)
+        @entry.tag_with(@tags.first)
+        @entry.categories.length.should == 3
+      end
+    end
+  end
+
+  describe 'edit url' do
+    before(:each) do
+      @entry = Atom::Entry.new
+    end
+
+    it 'should be nil on initializing' do
+      @entry.edit_url.should be_nil
+    end
+
+    it 'should be easily definable' do
+      @entry.edit_url = 'http://example.org/entries/foo'
+      @entry.edit_url.should == 'http://example.org/entries/foo'
+    end
+
+    it 'should not erase other links' do
+      link = @entry.links.new :rel => 'related', :href => 'http://example.org'
+
+      @entry.edit_url = 'http://example.com/entries/foo'
+      @entry.links.length.should == 2
+      @entry.links.should include(link)
+    end
+
+    it 'should accept a URI object' do
+      @entry.edit_url = URI.parse('http://example.com/entries/foo')
+      @entry.to_s.should =~ /example.com\/entries/
+    end
+  end
+
+  describe 'draft element' do
+    include TestsXML
+
+    before(:each) do
+      @entry = Atom::Entry.new
+    end
+
+    it 'should not be a draft by default' do
+      @entry.should_not be_draft
+    end
+
+    it 'should be definable using draft=' do
+      @entry.draft = true
+      @entry.should be_draft
+      @entry.draft = false
+      @entry.should_not be_draft
+    end
+
+    it 'should be declarable as a draft using #draft!' do
+      @entry.draft!
+      @entry.should be_draft
+    end
+
+    it 'should have APP namespace' do
+      @entry.draft!
+      read_entry_xml('app:control/app:draft').namespace.should == Atom::PP_NS
+    end
+  end
+
+  describe 'extensions' do
+    before(:each) do
+      @entry = Atom::Entry.parse(fixtures('entry-w-ext'))
+    end
+
+    it 'should preserve namespaces' do
+      @entry.to_s.should =~ /purl/
+    end
+  end
+
+  describe "with XML in the content element" do
+    it "should expose the content XML" do
+      @entry = Atom::Entry.parse(fixtures('entry-w-xml'))
+      @entry.content.xml.should be_instance_of(REXML::Element)
+    end
+
+    it "should expose the content XML" do
+      @entry = Atom::Entry.parse(fixtures('entry-w-xml'))
+      @entry.content.xml.root.name.should_not == 'content'
+    end
+  end
+end

data/spec/ext_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'atom/entry'
+
+module Atom
+  THR_NS  = "http://purl.org/syndication/thread/1.0"
+  SLUG_NS = 'http://example.org/ns/slug'
+
+  class InReplyTo < Atom::Element
+    is_element THR_NS, :"in-reply-to"
+
+    atom_attrb :ref
+    atom_attrb :href
+    atom_attrb :type
+    atom_attrb :source
+  end
+
+  class Entry
+    attrb   ['sl', SLUG_NS], 'slug'
+    element ['thr', THR_NS], :"in-reply-to", InReplyTo
+  end
+end
+
+describe Atom::Entry do
+  it 'should correctly write extension attributes' do
+    entry = Atom::Entry.new
+    entry.slug = 'hallo'
+
+    entry.to_s.should =~ /sl:slug/
+    entry.to_s.should =~ /xmlns:sl='#{Atom::SLUG_NS}'/
+  end
+
+  describe 'in-reply-to' do
+    it 'should be written with the correct namespace' do
+      entry = Atom::Entry.new
+      entry.in_reply_to = { :ref => 'http://example.org/some-entry' }
+
+      entry.to_s.should =~ /ref='http:\/\/example.org/
+      entry.to_s.should =~ Regexp.new(Atom::THR_NS)
+    end
+  end
+end

data/spec/feed_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'atom/feed'
+
+describe Atom::Feed do
+  describe 'extensions' do
+    before(:each) do
+      @feed = Atom::Feed.parse(fixtures('feed-w-ext'))
+    end
+
+    it 'should preserve namespaces' do
+      @feed.to_s.should =~ /purl/
+
+      feed2 = Atom::Feed.new
+      feed2.merge! @feed
+
+      feed2.to_s.should =~ /purl/
+    end
+  end
+
+  before :each do
+    @feed = Atom::Feed.parse(fixtures('contacts-feed'))
+  end
+
+  describe "to_s" do
+    it "should only have one content element" do
+      result = @feed.to_s
+      result.scan("<content type=").size.should == 1
+    end
+  end
+
+  describe "to_xml" do
+    it "should only have one content element" do
+      result = @feed.to_xml
+      REXML::XPath.match(result, "//content").size.should == 1
+    end
+  end
+
+end

data/spec/fixtures/contacts-feed.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+  <id>http://api.constantcontact.com/ws/customers/foo/contacts</id>
+  <title type="text">Contacts for Customer: Foo</title>
+  <link href="contacts"></link>
+  <link href="contacts" rel="self"></link>
+  <author>
+    <name>Foo</name>
+  </author>
+  <updated>2010-05-18T13:45:29.352Z</updated>
+  <link href="/ws/customers/Foo/contacts" rel="first"></link>
+  <link href="/ws/customers/Foo/contacts?email=tropix50%40hotmail.com" rel="current"></link>
+  <entry>
+    <link href="/ws/customers/Foo/contacts/42" rel="edit"></link>
+    <id>http://api.constantcontact.com/ws/customers/foo/contacts/42</id>
+    <title type="text">Contact: foo@example.com</title>
+    <updated>2010-05-18T13:45:29.372Z</updated>
+    <author>
+      <name>Constant Contact</name>
+    </author>
+    <content type="application/vnd.ctct+xml">
+      <Contact xmlns="http://ws.constantcontact.com/ns/1.0/" id="http://api.constantcontact.com/ws/customers/foo/contacts/42">
+        <Status>Active</Status>
+        <EmailAddress>foo@example.com</EmailAddress>
+        <EmailType>HTML</EmailType>
+        <Name>Bar, Foo</Name>
+        <OptInTime>2008-09-22T15:03:18.894Z</OptInTime>
+        <OptInSource>ACTION_BY_CUSTOMER</OptInSource>
+        <Confirmed>false</Confirmed>
+        <InsertTime>2008-09-22T15:03:18.894Z</InsertTime>
+      </Contact>
+    </content>
+  </entry>
+</feed>

data/spec/fixtures/entry-w-ext.xml

@@ -0,0 +1,15 @@
+<entry xmlns="http://www.w3.org/2005/Atom"
+       xml:base='http://www.example.org/'
+       xmlns:thr='http://purl.org/syndication/thread/1.0'
+       xml:lang='en-us'>
+ <title>Extendy</title>
+ <link rel='replies' thr:count='2' type='application/xhtml+xml' href='Extendy#comments' />
+ <id>http://www.example.org/Extendy.atom</id>
+ <published>2008-03-15T02:00:00-07:00</published>
+ <updated>2008-03-15T18:10:25-07:00</updated>
+  <content type='xhtml'>
+    <div xmlns='http://www.w3.org/1999/xhtml'>
+    <p>Extensions ahoy!</p>
+    </div>
+  </content>
+</entry>

data/spec/fixtures/entry-w-xml.xml

@@ -0,0 +1,24 @@
+<entry xmlns="http://www.w3.org/2005/Atom">
+  <link href="/ws/customers/joesflowers/lists/1" rel="edit" />
+  <id>http://api.constantcontact.com/ws/customers/joesflowers/lists/1</id>
+  <title type="text">General Interest</title>  
+  <updated>2008-04-16T18:39:35.710Z</updated>
+  <content type="application/vnd.ctct+xml">
+    <ContactList xmlns="http://ws.constantcontact.com/ns/1.0/" id="http://api.constantcontact.com/ws/customers/joesflowers/lists/1">
+      <OptInDefault>false</OptInDefault>
+      <Name>General Interest</Name>
+      <ShortName>General Interest</ShortName>
+      <SortOrder>1</SortOrder>
+    </ContactList>
+  </content>
+  <source>
+    <id>http://api.constantcontact.com/ws/customers/joesflowers/lists</id>
+    <title type="text">Contact Lists</title>
+    <link href="" />
+    <link href="" rel="self" />
+    <author>
+      <name>Constant Contact Web Services</name>
+    </author>
+    <updated>2008-04-16T18:39:35.717Z</updated>
+  </source>
+</entry>

data/spec/fixtures/entry.xml

@@ -0,0 +1,42 @@
+<entry xmlns="http://www.w3.org/2005/Atom"
+  xmlns:app="http://www.w3.org/2007/app">
+  <title>Atom draft-07 snapshot</title>
+  <link rel="alternate" type="text/html"
+    href="http://example.org/2005/04/02/atom"/>
+  <link rel="enclosure" type="audio/mpeg" length="1337"
+    href="http://example.org/audio/ph34r_my_podcast.mp3"/>
+  <source>
+    <title>Atom Sample Feed</title>
+    <id>tag:example.org,2003:/</id>
+    <link rel="self" href="http://example.org/feed"/>
+    <contributor>
+      <name>Mark Pilgrim</name>
+    </contributor>
+  </source>
+  <rights>Copyright (c) 2003, Mark Pilgrim</rights>
+  <id>tag:example.org,2003:3.2397</id>
+  <updated>2005-07-31T12:29:29Z</updated>
+  <published>2003-12-13T08:29:29-04:00</published>
+  <app:edited>2005-07-31T12:29:29Z</app:edited>
+  <app:control><app:draft>yes</app:draft></app:control>
+  <author>
+    <name>Mark Pilgrim</name>
+    <uri>http://example.org/</uri>
+    <email>f8dy@example.com</email>
+  </author>
+  <contributor>
+    <name>Sam Ruby</name>
+  </contributor>
+  <contributor>
+    <name>Joe Gregorio</name>
+  </contributor>
+  <summary>Some text.</summary>
+  <category scheme="http://example.org/cats" term="ann" />
+  <content type="xhtml" xml:lang="en"
+    xml:base="http://diveintomark.org/">
+    <div xmlns="http://www.w3.org/1999/xhtml">
+      <p><i>[Update: The Atom draft is finished.]</i></p>
+    </div>
+  </content>
+</entry>
+

data/spec/fixtures/feed-w-ext.xml

@@ -0,0 +1,33 @@
+<feed xmlns='http://www.w3.org/2005/Atom'
+      xmlns:thr='http://purl.org/syndication/thread/1.0'
+      xml:base='http://www.tbray.org/ongoing/ongoing.atom'
+      xml:lang='en-us'>
+ <title>ongoing</title>
+ <id>http://www.tbray.org/ongoing/</id>
+ <link href='./' />
+ <link rel='self' href='' />
+ <link rel='replies'       thr:count='101'       href='/home/tbray.org/www/html/ongoing/comments.atom' />
+ <logo>rsslogo.jpg</logo>
+ <icon>/favicon.ico</icon>
+ <updated>2008-03-17T02:04:49-07:00</updated>
+ <author><name>Tim Bray</name></author>
+ <subtitle>ongoing fragmented essay by Tim Bray</subtitle>
+ <rights>All content written by Tim Bray and photos by Tim Bray Copyright Tim Bray, some rights reserved, see /ongoing/misc/Copyright</rights>
+ <generator uri='/misc/Colophon'>Generated from XML source code using Perl, Expat, Emacs, Mysql, Ruby, Java, and ImageMagick.  Industrial-strength technology, baby.</generator>
+<entry xml:base='When/200x/2008/03/13/'>
+ <title>Maui Bound</title>
+ <link href='Maui' />
+ <link rel='replies'        thr:count='1'        type='application/xhtml+xml'        href='Maui#comments' />
+ <id>http://www.tbray.org/ongoing/When/200x/2008/03/13/Maui</id>
+ <published>2008-03-13T02:00:00-07:00</published>
+ <updated>2008-03-13T17:23:47-07:00</updated>
+ <category scheme='http://www.tbray.org/ongoing/What/' term='The World/Places/Hawaii' />
+ <category scheme='http://www.tbray.org/ongoing/What/' term='The World' />
+ <category scheme='http://www.tbray.org/ongoing/What/' term='Places' />
+ <category scheme='http://www.tbray.org/ongoing/What/' term='Hawaii' />
+<content type='xhtml'><div xmlns='http://www.w3.org/1999/xhtml'>
+<p>I’m off with the family tomorrow for ten days in Maui, 15th through the
+24th.  We’ll be meeting an Aussie friend.  Anyone else I know who’ll be there,
+drop me a line and we’ll get together for a Mai Tai.</p>
+</div></content></entry>
+</feed>

data/spec/fixtures/service-w-xhtml-ns.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<service xmlns="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:xhtml="http://www.w3.org/1999/xhtml">
+  <workspace title="Yulup Demo">
+    <atom:title type="text">Yulup Demo</atom:title>
+
+    <collection title="Releases" href="../entries/?yanel.resource.viewid=atom">
+      <atom:title type="html">Early Yulup &lt;i>Releases&lt;/i></atom:title>
+    </collection>
+  </workspace>
+
+  <workspace title="Yulup Website">
+    <atom:title type="text">Yulup Website</atom:title>
+
+    <collection title="Releases" href="http://www.yulup.org/download/release-atom-entries/?yanel.resource.viewid=atom">
+      <atom:title type="xhtml"><xhtml:div>Yulup <xhtml:b>Releases</xhtml:b>
+</xhtml:div>
+</atom:title>
+
+    </collection>
+  </workspace>
+</service>

data/spec/fixtures/service.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding='utf-8'?>
+<service xmlns="http://www.w3.org/2007/app"
+         xmlns:atom="http://www.w3.org/2005/Atom">
+  <workspace>
+    <atom:title>Main Site</atom:title>
+    <collection
+        href="http://example.org/blog/main" >
+      <atom:title>My Blog Entries</atom:title>
+      <categories
+         href="http://example.com/cats/forMain.cats" />
+    </collection>
+    <collection
+        href="http://example.org/blog/pic" >
+      <atom:title>Pictures</atom:title>
+      <accept>image/png</accept>
+      <accept>image/jpeg</accept>
+      <accept>image/gif</accept>
+    </collection>
+  </workspace>
+  <workspace>
+    <atom:title>Sidebar Blog</atom:title>
+    <collection
+        href="http://example.org/sidebar/list" >
+      <atom:title>Remaindered Links</atom:title>
+      <accept>application/atom+xml;type=entry</accept>
+      <categories fixed="yes">
+        <atom:category
+          scheme="http://example.org/extra-cats/"
+          term="joke" />
+        <atom:category
+          scheme="http://example.org/extra-cats/"
+          term="serious" />
+      </categories>
+    </collection>
+  </workspace>
+</service>