feedbuilder 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/.rspec

@@ -0,0 +1 @@
+--color --format progress --require spec/spec_helper.rb

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    feedbuilder (0.0.2)
+      activesupport (~> 3.0)
+      ratom
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    diff-lcs (1.1.2)
+    libxml-ruby (1.1.4)
+    ratom (0.6.7)
+      libxml-ruby (>= 1.1.2)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0)
+  feedbuilder!
+  ratom
+  rspec (~> 2.0)

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2009 Brian Moseley
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,53 @@
+Feedbuilder is a tiny utility that simplifies the process of building and delivering Atom feeds.
+
+## Usage
+
+    require 'rubygems'
+    require 'bundler/setup'
+    require 'feedbuilder'
+    require 'spec/nug'
+
+    nugs = [1, 2, 3].map {|id| Nug.new(id, "Nug #{id}")}
+    url_builder = FeedBuilder::UrlBuilder.new('http://test.host/', 'http://test.host/nugs')
+    feed = Nug.build_feed(nugs, url_builder, :feed_title => "Bucket o' nugs") do |nug, entry|
+      entry.links << Atom::Link.new(:href => "/nugs/#{nug.id}", :rel => :alternate, :type => 'text/html')
+    end
+
+    # feed.to_xml outputs:
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <feed xmlns="http://www.w3.org/2005/Atom">
+      <id>tag:maz.org,2010-12-21:/nugs</id>
+      <title>Bucket o' nugs</title>
+      <updated>2010-12-21T16:57:21-05:00</updated>
+      <link rel="via" type="text/html" href="http://test.host/nugs"/>
+      <link rel="self" type="application/atom+xml" href="http://test.host/nugs.atom"/>
+      <entry>
+        <id>tag:maz.org,2010-12-21:/nugs/1</id>
+        <summary>A nug named Nug 1</summary>
+        <updated>2010-12-21T16:57:21-05:00</updated>
+        <published>2010-12-21T16:57:21-05:00</published>
+        <link rel="alternate" type="text/html" href="http://test.host/nugs/1"/>
+        <content type="html">&lt;p&gt;A nug named Nug 1&lt;/p&gt;</content>
+      </entry>
+      <entry>
+        <id>tag:maz.org,2010-12-21:/nugs/2</id>
+        <summary>A nug named Nug 2</summary>
+        <updated>2010-12-21T16:57:21-05:00</updated>
+        <published>2010-12-21T16:57:21-05:00</published>
+        <link rel="alternate" type="text/html" href="http://test.host/nugs/2"/>
+        <content type="html">&lt;p&gt;A nug named Nug 2&lt;/p&gt;</content
+      </entry>
+      <entry>
+        <id>tag:maz.org,2010-12-21:/nugs/3</id>
+        <summary>A nug named Nug 3</summary>
+        <updated>2010-12-21T16:57:21-05:00</updated>
+        <published>2010-12-21T16:57:21-05:00</published>
+        <link rel="alternate" type="text/html" href="http://test.host/nugs/3"/>
+        <content type="html">&lt;p&gt;A nug named Nug 3&lt;/p&gt;</content>
+      </entry>
+    </feed>
+
+## Copyright
+
+Copyright (c) 2010 Brian Moseley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/feedbuilder.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "feedbuilder/version"
+
+Gem::Specification.new do |s|
+  s.name        = "feedbuilder"
+  s.version     = FeedBuilder::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brian Moseley"]
+  s.email       = ["bcm@maz.org"]
+  s.homepage    = ""
+  s.summary     = %q{An easier way to build Atom feeds}
+  s.description =
+    %q{A utility that simplifies the process of building Atom feeds from collections of well-behaved objects}
+
+  s.rubyforge_project = "feedbuilder"
+
+  s.add_dependency 'activesupport', '~> 3.0'
+  s.add_dependency 'ratom'
+  s.add_development_dependency 'rspec', '~> 2.0'
+
+  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"]
+end

data/lib/feedbuilder/provider.rb

@@ -0,0 +1,65 @@
+module FeedBuilder
+  module Provider
+    mattr_accessor :feed_id_domain
+    mattr_accessor :feed_id_date
+    mattr_accessor :feed_id_path
+    mattr_accessor :feed_id
+
+    def build_feed(collection, url_builder, options = {}, &block)
+      feed_updated = nil
+      collection.each do |model|
+        if feed_updated.nil? || model.updated_at > feed_updated
+          feed_updated = model.updated_at
+        end
+      end
+      Atom::Feed.new do |feed|
+        feed.id = if options.include?(:feed_id)
+          options[:feed_id]
+        elsif options.include?(:feed_id_path)
+          feed_tag_uri(options[:feed_id_path])
+        elsif self.feed_id_path.present?
+          feed_tag_uri(self.feed_id_path)
+        else
+          self.feed_id
+        end
+        feed.title = options[:feed_title]
+        feed.updated = feed_updated
+        feed.links << Atom::Link.new(:href => url_builder.html_url, :rel => :via, :type => 'text/html')
+        feed.links << Atom::Link.new(:href => url_builder.self_url, :rel => :self, :type => 'application/atom+xml')
+        if collection.respond_to?(:total_pages) && collection.respond_to?(:current_page)
+          if collection.total_pages > 1
+            feed.links << Atom::Link.new(:href => url_builder.first_url, :rel => :first)
+            if collection.current_page > 1
+              feed.links << Atom::Link.new(:href => url_builder.prev_url(collection.current_page), :rel => :previous)
+            end
+            if collection.current_page < collection.total_pages
+              feed.links << Atom::Link.new(:href => url_builder.next_url(collection.current_page), :rel => :next)
+            end
+            feed.links << Atom::Link.new(:href => url_builder.last_url(collection.total_pages), :rel => :last)
+          end
+        end
+        collection.each {|model| feed.entries << build_entry(model, &block)}
+      end
+    end
+
+    def build_entry(model,  &block)
+      Atom::Entry.new do |entry|
+        entry.id = model.entry_id if model.respond_to?(:entry_id)
+        entry.title = model.entry_title if model.respond_to?(:entry_title)
+        entry.published = model.respond_to?(:entry_published) ? model.entry_published : model.created_at
+        entry.updated = model.respond_to?(:entry_updated) ? model.entry_updated : model.updated_at
+        entry.summary = model.entry_summary if model.respond_to?(:entry_summary)
+        entry.content = model.entry_content if model.respond_to?(:entry_content)
+        yield(model, entry) if block_given?
+      end
+    end
+
+    # as per http://diveintomark.org/archives/2004/05/28/howto-atom-id
+    def feed_tag_uri(path, options = {})
+      domain = options[:domain] || self.feed_id_domain || FeedBuilder.feed_id_domain
+      date = options[:date] || self.feed_id_date || Date.today
+      date_str = date.acts_like_date?? date.strftime("%Y-%m-%d") : date.to_s
+      "tag:#{domain},#{date_str}:#{path.gsub(/\#/, '/')}"
+    end
+  end
+end

data/lib/feedbuilder/url_builder.rb

@@ -0,0 +1,47 @@
+module FeedBuilder
+  class UrlBuilder
+    attr_reader :base_url, :html_url, :self_url
+
+    def initialize(base_url, html_url, self_url = nil, options = {})
+      @base_url = base_url
+      @html_url = html_url
+      if self_url.present?
+        @self_url = self_url
+      else
+        @self_url = html_url.dup
+        if @self_url =~ /\?/
+          @self_url.sub!(/\?/, '.atom?')
+        else
+          @self_url << '.atom'
+        end
+      end
+      @page_param = options[:page_param] || :page
+      @page_size_param = options[:page_size_param] || :page_size
+    end
+
+    def first_url(page_size)
+      add_params(self_url, @page_param => 1, @page_size_param => page_size)
+    end
+
+    def next_url(current_page, page_size)
+      add_params(self_url, @page_param => current_page + 1, @page_size_param => page_size)
+    end
+
+    def prev_url(current_page, page_size)
+      add_params(self_url, @page_param => current_page - 1, @page_size_param => page_size)
+    end
+
+    def last_url(total_pages, page_size)
+      add_params(self_url, @page_param => total_pages, @page_size_param => page_size)
+    end
+
+    def add_params(url, params = {})
+      unless params.empty?
+        qs = params.inject([]) {|m, kv| m << "#{kv[0]}=#{kv[1]}"}
+        sep = url =~ /\?/ ? '&' : '?'
+        url << "#{sep}#{URI.escape(qs.join('&'))}"
+      end
+      url
+    end
+  end
+end

data/lib/feedbuilder/version.rb

@@ -0,0 +1,3 @@
+module FeedBuilder
+  VERSION = '0.0.2'
+end

data/lib/feedbuilder.rb

@@ -0,0 +1,12 @@
+require 'atom'
+require 'active_support/core_ext/date/acts_like'
+require 'active_support/core_ext/date_time/acts_like'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/object/blank'
+
+require 'feedbuilder/provider'
+require 'feedbuilder/url_builder'
+
+module Feedbuilder
+  mattr_accessor :feed_id_domain
+end

data/spec/nug.rb

@@ -0,0 +1,40 @@
+class Nug
+  extend FeedBuilder::Provider
+
+  # set domain and path here rather than a static feed id so that we can use them to compute entry ids as well
+
+  self.feed_id_domain = 'maz.org'
+  self.feed_id_path = '/nugs'
+
+  attr_reader :id, :name
+
+  def initialize(id, name)
+    @id = id
+    @name = name
+    @created_at = DateTime.now
+    @updated_at = DateTime.now
+  end
+
+  # created_at and updated_at are used to set the entry's published and updated attributes since entry_published
+  # and entry_updated methods aren't defined
+
+  def created_at
+    @created_at
+  end
+
+  def updated_at
+    @updated_at
+  end
+
+  def entry_id
+    self.class.feed_tag_uri("#{self.class.feed_id_path}/#{self.id}", :date => self.created_at)
+  end
+
+  def entry_summary
+    Atom::Content::Text.new("A nug named #{self.name}")
+  end
+
+  def entry_content
+    Atom::Content::Html.new("<p>A nug named #{self.name}</p>")
+  end
+end

data/spec/provider_spec.rb

@@ -0,0 +1,115 @@
+describe FeedBuilder::Provider do
+  describe "#build_feed" do
+    it "builds a feed" do
+      feed.should_not be_nil
+    end
+
+    it "sets id to the global feed id" do
+      feed_id_path = Nug.feed_id_path
+      Nug.feed_id_path = nil
+      Nug.feed_id = 'foobar'
+      feed(:feed_id => nil).id.should == Nug.feed_id
+      Nug.feed_id = nil
+      Nug.feed_id_path = feed_id_path
+    end
+
+    it "sets id as provided" do
+      id = "foo.com,1999-12-31/nugs"
+      feed(:feed_id => id).id.should == id
+    end
+
+    it "sets id as per the provided path" do
+      path = '/path/to/nugs'
+      feed(:feed_id => nil, :feed_id_path => path).id.should == Nug.feed_tag_uri(path)
+    end
+
+    it "sets title as provided" do
+      feed.title.should == @title
+    end
+
+    it "sets updated as provided" do
+      feed.updated.should == @nugs.last.updated_at
+    end
+
+    it "adds the correct number of links" do
+      feed.links.should have_exactly(2).links
+    end
+
+    it "adds via link" do
+      via_link.should_not be_nil
+    end
+
+    it "sets via link to text/html" do
+      via_link.type.should == 'text/html'
+    end
+
+    it "sets self link" do
+      self_link.should_not be_nil
+    end
+
+    it "sets self link to application/atom+xml" do
+      self_link.type.should == 'application/atom+xml'
+    end
+
+    it "adds the correct number of entries" do
+      feed.should have_exactly(@nugs.size).entries
+    end
+  end
+
+  describe "#build_entry" do
+    it "builds an entry" do
+      entry.should_not be_nil
+    end
+
+    it "sets id to Nug#entry_id" do
+      entry.id.should == @nug.entry_id
+    end
+
+    it "sets title to Nug#name" do
+      entry.title.should == @nug.name
+    end
+
+    it "sets published to Nug#created_at" do
+      entry.published.should == @nug.created_at
+    end
+
+    it "sets updated to Nug#updated_at" do
+      entry.updated.should == @nug.updated_at
+    end
+
+    it "sets text summary" do
+      entry.summary.should be_a(Atom::Content::Text)
+    end
+
+    it "sets html content" do
+      entry.content.should be_a(Atom::Content::Html)
+    end
+  end
+end
+
+def feed(options = {})
+  @title = "Bucket o' nugs"
+  @nugs = [1, 2, 3].map {|id| Nug.new(id, "Nug #{id}")}
+  options = {:feed_title => @title}.merge(options)
+  if options.include?(:feed_id)
+    options.delete(:feed_id) if options[:feed_id].nil?
+  else
+    options[:feed_id] = Nug.feed_tag_uri(Nug.feed_id_path)
+  end
+  Nug.build_feed(@nugs, FeedBuilder::UrlBuilder.new('/', '/nugs'), options)
+end
+
+def entry
+  @nug = Nug.new(1, "Fug slug")
+  Nug.build_entry(@nug) do |nug, entry|
+    entry.title = nug.name
+  end
+end
+
+def via_link
+  feed.links.detect {|l| l.rel == :via}
+end
+
+def self_link
+  feed.links.detect {|l| l.rel == :self}
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'lib/feedbuilder'
+require 'nug'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: feedbuilder
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Brian Moseley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-21 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ratom
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id003
+description: A utility that simplifies the process of building Atom feeds from collections of well-behaved objects
+email: 
+- bcm@maz.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- feedbuilder.gemspec
+- lib/feedbuilder.rb
+- lib/feedbuilder/provider.rb
+- lib/feedbuilder/url_builder.rb
+- lib/feedbuilder/version.rb
+- spec/nug.rb
+- spec/provider_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: feedbuilder
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An easier way to build Atom feeds
+test_files: 
+- spec/nug.rb
+- spec/provider_spec.rb
+- spec/spec_helper.rb