exempla-atomic 0.0.2

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 2
+:major: 0
+:minor: 0

data/lib/atomic/entry.rb

@@ -0,0 +1,88 @@
+require 'rubygems'
+require 'nokogiri'
+require 'time'
+
+module Atomic
+
+  class Entry
+
+    class << self
+
+      def parse(xml)
+
+        namespaces = { "xmlns:atom" => "http://www.w3.org/2005/Atom",
+                       "xmlns:app" => "http://www.w3.org/2007/app",
+                       "xmlns:cirrus" => "http://www.glam.ac.uk/2009/cirrus" }
+
+        doc = Nokogiri.XML(xml)
+
+#        puts("================================================================")
+#        puts("XML Document")
+#        puts("================================================================")
+#        puts(doc)
+#        puts("================================================================")
+
+        entry_xml = doc.xpath('//atom:entry', namespaces).first
+
+        attributes = {}
+        attributes[:id] = entry_xml.xpath('atom:id', namespaces).first.text
+        attributes[:title] = entry_xml.xpath('atom:title', namespaces).first.text
+        attributes[:created_at] = entry_xml.xpath('atom:published', namespaces).first.text
+        attributes[:updated_at] = entry_xml.xpath('atom:updated', namespaces).first.text
+
+        content_xml = entry_xml.xpath('atom:content', namespaces).first
+
+        if (content_xml['type'] == 'application/xml')
+          attributes[:content] = {}
+
+          announcement_xml = content_xml.xpath('cirrus:announcement', namespaces).first
+          unless announcement_xml.nil?
+            attributes[:content][:message] = announcement_xml.xpath('cirrus:message', namespaces).first.text
+            attributes[:content][:starts_at] = announcement_xml.xpath('cirrus:starts-at', namespaces).first.text
+            attributes[:content][:ends_at] = announcement_xml.xpath('cirrus:ends-at', namespaces).first.text
+          end
+        else
+          attributes[:content] = content_xml.inner_html
+        end
+        attributes[:categories] = []
+        entry_xml.xpath('atom:category', namespaces).each do |category_node|
+          attributes[:categories] << {:term => category_node['term'], :scheme => category_node['scheme']}
+        end
+
+        new(attributes)
+      end
+
+    end
+
+    attr_accessor :id, :title, :categories, :content, :created_at, :updated_at
+
+    def initialize(params = {})
+
+#      puts("================================================================")
+#      puts(" Params")
+#      puts("================================================================")
+#      puts(params.inspect)
+#      puts("================================================================")
+
+      @title = params[:title]
+      @id = params[:id]
+      @categories = params[:categories]
+      @content = params[:content]
+      @created_at = params[:created_at].nil? ? Time.now : Time.parse(params[:created_at])
+      @updated_at = params[:updated_at].nil? ? @created_at : Time.parse(params[:updated_at])
+    end
+
+    def to_hash
+      {
+        :id => @id,
+        :title => @title,
+        :categories => @categories,
+        :content => @content,
+        :created_at => @created_at,
+        :updated_at => @updated_at
+      }
+    end
+
+  end
+
+end

data/lib/atomic.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/atomic/entry'

data/spec/atomic/entry_spec.rb

@@ -0,0 +1,129 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+#require 'time'
+
+describe Atomic::Entry do
+
+  def valid_attributes
+    {
+      :id => "123abc",
+      :title => "Atom Entry Title",
+      :categories => [
+        {:term => 'treforest', :scheme => 'http://cirrusstage.glam.ac.uk/schemes/locations'},
+        {:term => 'hesas', :scheme => 'http://cirrusstage.glam.ac.uk/schemes/categories'}
+      ],
+      :content => {
+        :message=>"Test Announcement Message",
+        :starts_at=>"2009-02-10T08:00:00Z",
+        :ends_at=>"2009-02-10T17:00:00Z"
+      }
+    }
+  end
+
+  before :each do
+    @xml = File.read(File.join(File.dirname(__FILE__), '..', 'fixtures', 'valid_atom_entry.xml'))
+  end
+
+  describe "Class Methods" do
+
+    describe "#parse" do
+
+      before :each do
+        @entry = Atomic::Entry.parse(@xml)
+      end
+      
+      it "should return a new Atomic::Entry" do
+        @entry.should be_an(Atomic::Entry)
+      end
+
+      it "should decode a valid Atom Entry xml document" do
+        @entry.title.should == 'Test Announcement'
+        @entry.id.should == 'tag:example.org,2003:3.2397'
+        @entry.categories.size.should == 2
+        @entry.content.should_not be_nil
+      end
+
+    end
+    
+    describe "#new" do
+      
+      it "should return a new Atomic::Entry" do
+        entry = Atomic::Entry.new(valid_attributes)
+        entry.should be_an(Atomic::Entry)
+      end
+
+      it "should set created_at and updated_at to current time if not supplied" do
+        now = Time.now
+        Time.stub!(:now).and_return(now)
+        entry = Atomic::Entry.new(valid_attributes)
+        entry.created_at.should be_a(Time)
+        entry.created_at.should == now
+        entry.updated_at.should be_a(Time)
+        entry.updated_at.should == now
+      end
+
+      it "should set created_at to supplied time" do
+        now = Time.now
+        Time.stub!(:now).and_return(now)
+        entry = Atomic::Entry.new(valid_attributes.merge(:created_at => '2009-02-10T08:00:00Z'))
+        entry.created_at.should == Time.parse('2009-02-10T08:00:00Z')
+        entry.created_at.should be_a(Time)
+      end
+      
+      it "should set updated_at to supplied time" do
+        now = Time.now
+        Time.stub!(:now).and_return(now)
+        entry = Atomic::Entry.new(valid_attributes.merge(:updated_at => '2009-02-10T08:00:00Z'))
+        entry.updated_at.should == Time.parse('2009-02-10T08:00:00Z')
+        entry.updated_at.should be_a(Time)
+      end
+
+    end
+
+  end
+
+  describe "#to_hash" do
+
+    before :each do
+      @now = Time.now
+      Time.stub!(:now).and_return(@now)
+      @entry = Atomic::Entry.new(valid_attributes)
+    end
+
+    it "should return a hash" do
+      @entry.to_hash.should be_a(Hash)
+    end
+
+    it "should include the id" do
+      @entry.to_hash.should have_key(:id)
+      @entry.to_hash[:id].should == valid_attributes[:id]
+    end
+
+    it "should include the title" do
+      @entry.to_hash.should have_key(:title)
+      @entry.to_hash[:title].should == valid_attributes[:title]
+    end
+
+    it "should include the categories" do
+      @entry.to_hash.should have_key(:categories)
+      @entry.to_hash[:categories].should == valid_attributes[:categories]
+    end
+
+    it "should include the content" do
+      @entry.to_hash.should have_key(:content)
+      @entry.to_hash[:content].should == valid_attributes[:content]
+    end
+
+    it "should include the created_at time" do
+      @entry.to_hash.should have_key(:created_at)
+      @entry.to_hash[:created_at].should == @now
+    end
+
+    it "should include the updated_at time" do
+      @entry.to_hash.should have_key(:updated_at)
+      @entry.to_hash[:updated_at].should == @now
+    end
+
+  end
+  
+end
+

data/spec/fixtures/valid_atom_entry.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns="http://www.w3.org/2005/Atom" xmlns:cirrus="http://www.glam.ac.uk/2009/cirrus">
+    <title>Test Announcement</title>
+    <id>tag:example.org,2003:3.2397</id>
+    <updated>2009-02-10T08:00:00Z</updated>
+    <published>2009-02-10T08:00:00Z</published>
+    <author>
+      <name>Peter Portal</name>
+      <uri>http://www.glam.ac.uk/</uri>
+      <email>peterportal@glam.ac.uk</email>
+    </author>
+    <category term="trefforest" scheme="http://cirrusstage.glam.ac.uk/schemes/locations"/>
+    <category term="gbs" scheme="http://cirrusstage.glam.ac.uk/schemes/faculties"/>
+    <content type="application/xml">
+         <cirrus:announcement>
+             <cirrus:message>Test Announcement Message</cirrus:message>
+             <cirrus:starts-at type="datetime">2009-02-10T08:00:00Z</cirrus:starts-at>
+             <cirrus:ends-at type="datetime">2009-02-10T17:00:00Z</cirrus:ends-at>
+         </cirrus:announcement>
+    </content>
+  </entry>

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--format specdoc
+--loadby mtime

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'atomic'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: exempla-atomic
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Darrin Wortlehock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: darrin@exempla.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/atomic.rb
+- lib/atomic
+- lib/atomic/entry.rb
+- spec/spec.opts
+- spec/fixtures
+- spec/fixtures/valid_atom_entry.xml
+- spec/spec_helper.rb
+- spec/atomic
+- spec/atomic/entry_spec.rb
+has_rdoc: true
+homepage: http://github.com/exempla/atomic
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simple Atom and AtomPub parsing library
+test_files: []
+