atomizer 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem "rake"
+
+# Specify your gem's dependencies in atomizer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mutwin Kraus
+
+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 OR COPYRIGHT HOLDERS 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.md

@@ -0,0 +1,18 @@
+Atomizer
+--------
+
+Atomizer is a Ruby library for parsing and generating Atom feeds.
+
+
+Installation
+============
+
+        $ gem install atomizer
+
+
+Copyright
+=========
+
+Copyright (c) 2011 Mutwin Kraus
+
+Atomizer is licensed under the [MIT License](https://github.com/mutle/atomizer/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test"
+    t.pattern = 'test/unit/**/*_test.rb'
+  end
+end

data/atomizer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "atomizer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "atomizer"
+  s.version     = Atomizer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mutwin Kraus"]
+  s.email       = ["mutwin.kraus@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Utilities for atom feed parsing and generation}
+  s.description = %q{Utilities for atom feed parsing and generation}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "nokogiri"
+end

data/lib/atomizer.rb

@@ -0,0 +1,19 @@
+require 'nokogiri'
+
+module Atomizer
+  autoload :Author, 'atomizer/author'
+  autoload :Builder, 'atomizer/builder'
+  autoload :Buildable,'atomizer/buildable'
+  autoload :Collection,'atomizer/collection'
+  autoload :Content,'atomizer/content'
+  autoload :Contributor,'atomizer/contributor'
+  autoload :Entry,'atomizer/entry'
+  autoload :Feed,'atomizer/feed'
+  autoload :Generator,'atomizer/generator'
+  autoload :FeedItem, 'atomizer/feed_item'
+  autoload :Link,'atomizer/link'
+  autoload :Service,'atomizer/service'
+  autoload :Text,'atomizer/text'
+  autoload :Time,'atomizer/time'
+  autoload :Workspace,'atomizer/workspace'
+end

data/lib/atomizer/author.rb

@@ -0,0 +1,7 @@
+module Atomizer
+  class Author < FeedItem
+    feed_tag_name "author"
+    feed_attributes :name, :uri, :email
+    feed_no_collection_group_tag!
+  end
+end

data/lib/atomizer/buildable.rb

@@ -0,0 +1,9 @@
+module Atomizer
+  module Buildable
+    def to_atom
+      builder = Builder.new
+      builder.to_atom(self)
+    end
+  end
+end
+

data/lib/atomizer/builder.rb

@@ -0,0 +1,10 @@
+module Atomizer
+  class Builder
+    def to_atom(object)
+      builder = Nokogiri::XML::Builder.new do |xml|
+        object.to_xml(xml)
+      end
+      builder.to_xml
+    end
+  end
+end

data/lib/atomizer/collection.rb

@@ -0,0 +1,19 @@
+module Atomizer
+  class Collection < FeedItem
+    feed_attributes :href, :title, :accepts, :categories
+
+    def initialize
+      @accepts = []
+      @categories = []
+    end
+
+    def to_xml(xml)
+      xml.collection :href => href do
+        xml['atom'].title title if title
+        accepts.each do |accept|
+          xml.accept accept
+        end
+      end
+    end
+  end
+end

data/lib/atomizer/content.rb

@@ -0,0 +1,10 @@
+module Atomizer
+  class Content < FeedItem
+    feed_tag_name "content"
+    feed_attributes :body, :type, :xml_lang, :xml_base
+
+    def to_xml(xml)
+      xml.content(@body, :type => type, "xml:lang" => @xml_lang, "xml:base" => @xml_base)
+    end
+  end
+end

data/lib/atomizer/contributor.rb

@@ -0,0 +1,8 @@
+module Atomizer
+  class Contributor < Author
+    feed_tag_name "contributor"
+    feed_attributes :name, :uri, :email
+    feed_no_collection_group_tag!
+  end
+end
+

data/lib/atomizer/entry.rb

@@ -0,0 +1,13 @@
+module Atomizer
+  class Entry < FeedItem
+    feed_tag_name "entry"
+    feed_attributes :id, :title, :links, :updated, :published, :authors, :contributors, :content
+    feed_no_collection_group_tag!
+
+    def initialize(*attrs)
+      super(*attrs)
+      @content_type ||= "html"
+      @links ||= []
+    end
+  end
+end

data/lib/atomizer/feed.rb

@@ -0,0 +1,97 @@
+module Atomizer
+  class Feed < FeedItem
+
+    feed_attributes :id, :title, :subtitle, :updated, :published, :links, :rights, :generator, :generator_uri, :generator_version, :entries, :authors, :contributors
+
+    class << self
+      def parse(xml)
+        doc = Nokogiri::XML(xml)
+        feed = new
+        feed.id = text(doc, "feed>id")
+        feed.title = text(doc, "feed>title")
+        feed.subtitle = text(doc, "feed>subtitle")
+        feed.updated = parse_time text(doc, "feed>updated")
+        feed.rights = text(doc, "feed>rights")
+        generator = text(doc, "feed>generator")
+        if generator
+          feed.generator = Generator.new(:name => text(doc, "feed>generator"), :uri => attribute_text(doc, "feed>generator", "uri"), :version => attribute_text(doc, "feed>generator", "version"))
+        end
+        feed.links = parse_links(doc.css("feed>link"))
+
+        doc.css("entry").each do |e|
+          entry = Entry.new
+          entry.id = text(e, "id")
+          entry.title = text(e, "title")
+          entry.content = parse_content e.css("content")
+          entry.updated = parse_time(text(e, "updated"))
+          entry.published = parse_time(text(e, "published"))
+          entry.authors = parse_authors e.css("author"), Author
+          entry.contributors = parse_authors e.css("contributor"), Contributor
+          entry.links = parse_links(e.css("link"))
+          feed.entries << entry
+        end
+
+        feed
+      end
+
+      private
+
+      def text(element, selector)
+        Text.new(element.css(selector).first.text, element.css(selector).first.attributes)
+      end
+
+      def attribute_text(element, selector, attribute)
+        Text.new(element.css(selector).attr(attribute).text)
+      end
+
+      def parse_time(text)
+        Atomizer::Time.parse(text)
+      end
+
+      def parse_content(content)
+        Content.new(:body => content.inner_html, :type => content.attr("type").to_s, :xml_lang => content.attr("lang").to_s, :xml_base => content.attr("base").to_s) 
+      end
+
+      def parse_links(link)
+        links = []
+        if link
+          link.each do |l|
+            rel = l.attr("rel").to_s
+            type = l.attr("type").to_s
+            hreflang = l.attr("hreflang").to_s
+            href = l.attr("href").to_s
+            length = l.attr("length").to_s
+            links << Atomizer::Link.new(:rel => rel, :type => type, :hreflang => hreflang, :href => href, :length => length)
+          end
+        end
+        links
+      end
+
+      def parse_authors(author, author_class)
+        authors = []
+        if author
+          author.each do |a|
+            name = a.css("name").text
+            uri = a.css("uri").text
+            email = a.css("email").text
+            authors << author_class.new(:name => name, :uri => uri, :email => email)
+          end
+        end
+        authors
+      end
+    end
+
+    def initialize
+      @authors = []
+      @contributors = []
+      @entries = []
+      @links = []
+    end
+
+    def to_xml(xml, root_element=true)
+      xml.feed :xmlns => "http://www.w3.org/2005/Atom" do
+        super(xml, false)
+      end
+    end
+  end
+end

data/lib/atomizer/feed_item.rb

@@ -0,0 +1,84 @@
+module Atomizer
+  class FeedItem
+    include Buildable
+
+    class << self
+
+      def feed_tag_name(tag_name=nil)
+        @feed_tag_name = tag_name.to_s if tag_name
+        @feed_tag_name
+      end
+
+      def feed_attributes(*attrs)
+        @attributes ||= []
+        if attrs && attrs.size > 0
+          @attributes.push(*attrs)
+          attrs.each do |a|
+            attr_accessor a
+          end
+        end
+        @attributes
+      end
+
+      def feed_no_collection_group_tag!
+        @feed_no_collection_group_tag = true
+      end
+
+      def feed_no_collection_group_tag
+        @feed_no_collection_group_tag || false
+      end
+    end
+
+    def initialize(options={})
+      self.class.feed_attributes.each do |a|
+        if v = (options[a.to_sym] || options[a.to_s])
+          meth = "#{a}="
+          send(meth, v) if respond_to?(meth) && v && v != ""
+        end
+      end
+    end
+
+    def to_xml(xml, root_element=true)
+      if root_element
+        xml.send(self.class.feed_tag_name) do |child_xml|
+          feed_attributes_to_xml(child_xml)
+        end
+      else
+        feed_attributes_to_xml(xml)
+      end
+    end
+    
+    private
+
+    def feed_attributes_to_xml(xml)
+      self.class.feed_attributes.each do |a|
+        v = send(a) if respond_to?(a)
+        next if !v || v == ""
+        a = "#{a}_" if a.to_s == "id"
+        if v.is_a?(Array)
+          next if v.size == 0
+          if v.first.class.feed_no_collection_group_tag
+            v.each do |obj|
+              obj.to_xml xml
+            end
+          else
+            xml.send(a.to_s) do |child_xml|
+              v.each do |obj|
+                obj.to_xml child_xml
+              end
+            end
+          end
+        elsif v.respond_to?(:to_xml)
+          v.to_xml(xml)
+        elsif v.respond_to?(:attributes)
+          xml.send(a.to_s, v.attributes) do
+            xml.text v
+          end
+        else
+          xml.send(a.to_s, v.to_s)
+        end
+      end
+    end
+
+  end
+end

data/lib/atomizer/generator.rb

@@ -0,0 +1,10 @@
+module Atomizer
+  class Generator < FeedItem
+    feed_tag_name "generator"
+    feed_attributes :name, :uri, :version
+
+    def to_xml(xml)
+      xml.generator @name, :uri => @uri, :version => @version
+    end
+  end
+end

data/lib/atomizer/link.rb

@@ -0,0 +1,11 @@
+module Atomizer
+  class Link < FeedItem
+    feed_tag_name "link"
+    feed_attributes :rel, :type, :length, :href
+    feed_no_collection_group_tag!
+
+    def to_xml(xml)
+      xml.link :rel => @rel, :type => @type, :length => @length, :href => @href
+    end
+  end
+end

data/lib/atomizer/service.rb

@@ -0,0 +1,25 @@
+module Atomizer
+  class Service < FeedItem
+    feed_tag_name "service"
+    feed_attributes :workspaces
+
+    def initialize(*attrs)
+      super(*attrs)
+      @workspaces ||= []
+    end
+
+    def to_xml(xml)
+      xml.service :xmlns => "http://www.w3.org/2007/app", :"xmlns:atom" => "http://www.w3.org/2005/Atom" do
+        workspaces.each do |workspace|
+          workspace.to_xml xml
+        end
+      end
+    end
+
+    def setup_workspace(collection=nil)
+      workspace = Workspace.new
+      workspace.collections << collection if collection
+      self.workspaces << workspace
+    end
+  end
+end

data/lib/atomizer/text.rb

@@ -0,0 +1,14 @@
+module Atomizer
+  class Text < String
+    def attributes
+      @attributes ||= {}
+    end
+
+    def initialize(str, attrs={})
+      super(str.to_s)
+      attrs.each do |k,v|
+        attributes[k.to_s] = v.value
+      end
+    end
+  end
+end

data/lib/atomizer/time.rb

@@ -0,0 +1,7 @@
+module Atomizer
+  class Time < ::Time
+    def to_s
+      xmlschema
+    end
+  end
+end

data/lib/atomizer/version.rb

@@ -0,0 +1,3 @@
+module Atomizer
+  VERSION = "0.0.1"
+end

data/lib/atomizer/workspace.rb

@@ -0,0 +1,20 @@
+module Atomizer
+  class Workspace < FeedItem
+    feed_tag_name "workspace"
+    feed_attributes :collections, :title
+
+    def initialize(*attrs)
+      super(*attrs)
+      @collections ||= []
+    end
+
+    def to_xml(xml)
+      xml.workspace do
+        xml['atom'].title title if title
+        collections.each do |collection|
+          collection.to_xml xml
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler'
+require 'test/unit'

data/test/unit/atomizer_atompub_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+require 'atomizer'
+
+class AtomizerAtompubTest < Test::Unit::TestCase
+
+  def test_service_document
+    service = Atomizer::Service.new
+    workspace = Atomizer::Workspace.new
+    collection = Atomizer::Collection.new
+    workspace.collections << collection
+    service.workspaces << workspace
+    assert service.to_atom.include?("<service")
+    assert service.to_atom.include?("<workspace")
+    assert service.to_atom.include?("<collection")
+  end
+
+end

data/test/unit/atomizer_builder_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+require 'atomizer'
+
+class AtomizerBuilderTest < Test::Unit::TestCase
+
+  def setup
+    super
+    @feed = Atomizer::Feed.new
+    @builder = Atomizer::Builder.new
+  end
+
+  def test_create_empty_feed
+    assert @builder.to_atom(@feed).include?("<feed")
+    assert @feed.to_atom.include?("<feed")
+    assert !@feed.to_atom.include?("<entry")
+  end
+
+  def test_create_feed_entry
+    @feed.entries << Atomizer::Entry.new(:title => "Foo")
+    assert @builder.to_atom(@feed).include?("<title>Foo</title>")
+  end
+
+end
+

data/test/unit/atomizer_feed_test.rb

@@ -0,0 +1,140 @@
+require 'test_helper'
+require 'atomizer'
+
+class AtomizerFeedTest < Test::Unit::TestCase
+  # example from http://www.atomenabled.org/developers/syndication/atom-format-spec.php
+  EXAMPLE_ATOM = <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+  <title type="text">dive into mark</title>
+  <subtitle type="html">
+    A &lt;em&gt;lot&lt;/em&gt; of effort
+    went into making this effortless
+  </subtitle>
+  <updated>2005-07-31T12:29:29Z</updated>
+  <id>tag:example.org,2003:3</id>
+  <link rel="alternate" type="text/html"
+    hreflang="en" href="http://example.org/"/>
+  <link rel="self" type="application/atom+xml"
+    href="http://example.org/feed.atom"/>
+  <rights>Copyright (c) 2003, Mark Pilgrim</rights>
+  <generator uri="http://www.example.com/" version="1.0">
+    Example Toolkit
+  </generator>
+  <entry>
+    <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"/>
+    <id>tag:example.org,2003:3.2397</id>
+    <updated>2005-07-31T12:29:29Z</updated>
+    <published>2003-12-13T08:29:29-04:00</published>
+    <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>
+    <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>
+</feed>
+    XML
+
+  def setup
+    super
+    @feed = Atomizer::Feed.parse EXAMPLE_ATOM
+    @entry = @feed.entries.first
+  end
+
+  def test_parse_feed_id
+    assert_equal "tag:example.org,2003:3", @feed.id
+  end
+
+  def test_parse_feed_title
+    assert_equal "dive into mark", @feed.title
+  end
+  
+  def test_parse_feed_subtitle
+    assert @feed.subtitle.include? "effort"
+  end
+
+  def test_parse_feed_updated
+    assert_equal 2005, @feed.updated.year
+  end
+
+  def test_parse_feed_links
+    assert_equal 2, @feed.links.size
+    assert_equal "http://example.org/", @feed.links[0].href
+    assert_equal "alternate", @feed.links[0].rel
+    assert_equal "application/atom+xml", @feed.links[1].type
+  end
+
+  def test_parse_feed_rights
+    assert @feed.rights.include? "Copyright"
+  end
+
+  def test_parse_feed_generator
+    assert @feed.generator.name.include? "Example Toolkit"
+    assert_equal "http://www.example.com/", @feed.generator.uri
+    assert_equal "1.0", @feed.generator.version
+  end
+
+  def test_parse_feed_entries
+    assert_equal 1, @feed.entries.size
+  end
+
+  def test_parse_feed_entry_id
+    assert_equal "tag:example.org,2003:3.2397", @entry.id
+  end
+
+  def test_parse_feed_entry_title
+    assert_equal "Atom draft-07 snapshot", @entry.title
+  end
+
+  def test_parse_feed_entry_links
+    assert_equal 2, @entry.links.size
+    assert_equal "http://example.org/2005/04/02/atom", @entry.links[0].href
+    assert_equal "alternate", @entry.links[0].rel
+    assert_equal "audio/mpeg", @entry.links[1].type
+    assert_equal "1337", @entry.links[1].length
+  end
+
+  def test_parse_feed_entry_content
+    assert @entry.content.body.include? "Update: The Atom draft is finished."
+    assert_equal "xhtml", @entry.content.type
+  end
+
+  def test_parse_feed_dates
+    assert_equal 2005, @entry.updated.year
+    assert_equal 2003, @entry.published.year
+  end
+
+  def test_parse_feed_author
+    assert_equal "Mark Pilgrim", @entry.authors.first.name
+    assert_equal "http://example.org/", @entry.authors.first.uri
+    assert_equal "f8dy@example.com", @entry.authors.first.email
+  end
+
+  def test_parse_feed_contributor
+    assert_equal 2, @entry.contributors.size
+    assert_equal "Sam Ruby", @entry.contributors[0].name
+    assert_nil @entry.contributors[0].uri
+    assert_nil @entry.contributors[0].email
+    assert_equal "Joe Gregorio", @entry.contributors[1].name
+  end
+
+  def test_generate_feed
+    assert @feed.to_atom.include?("<entry")
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: atomizer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mutwin Kraus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Utilities for atom feed parsing and generation
+email: 
+- mutwin.kraus@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- atomizer.gemspec
+- lib/atomizer.rb
+- lib/atomizer/author.rb
+- lib/atomizer/buildable.rb
+- lib/atomizer/builder.rb
+- lib/atomizer/collection.rb
+- lib/atomizer/content.rb
+- lib/atomizer/contributor.rb
+- lib/atomizer/entry.rb
+- lib/atomizer/feed.rb
+- lib/atomizer/feed_item.rb
+- lib/atomizer/generator.rb
+- lib/atomizer/link.rb
+- lib/atomizer/service.rb
+- lib/atomizer/text.rb
+- lib/atomizer/time.rb
+- lib/atomizer/version.rb
+- lib/atomizer/workspace.rb
+- test/test_helper.rb
+- test/unit/atomizer_atompub_test.rb
+- test/unit/atomizer_builder_test.rb
+- test/unit/atomizer_feed_test.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Utilities for atom feed parsing and generation
+test_files: 
+- test/test_helper.rb
+- test/unit/atomizer_atompub_test.rb
+- test/unit/atomizer_builder_test.rb
+- test/unit/atomizer_feed_test.rb