eric-feedzirra 0.0.8

data/lib/feedzirra/feed_entry_utilities.rb

@@ -0,0 +1,45 @@
+module Feedzirra
+  module FeedEntryUtilities    
+    def published
+      @published || @updated
+    end
+    
+    def parse_datetime(string)
+      begin
+        DateTime.parse(string).feed_utils_to_gm_time
+      rescue
+        puts "DATE CAN'T BE PARSED: #{string}"
+        nil
+      end
+    end
+    
+    ##
+    # Returns the id of the entry or its url if not id is present, as some formats don't support it
+    def id
+      @id || @url
+    end
+    
+    ##
+    # Writter for published. By default, we keep the "oldest" publish time found.
+    def published=(val)
+      parsed = parse_datetime(val)
+      @published = parsed if !@published || parsed < @published
+    end
+    
+    ##
+    # Writter for udapted. By default, we keep the most recenet update time found.
+    def updated=(val)
+      parsed = parse_datetime(val)
+      @updated = parsed if !@updated || parsed > @updated
+    end
+
+    def sanitize!
+      self.title.sanitize!   if self.title
+      self.author.sanitize!  if self.author
+      self.summary.sanitize! if self.summary
+      self.content.sanitize! if self.content
+    end
+    
+    alias_method :last_modified, :published
+  end
+end

data/lib/feedzirra/feed_utilities.rb

@@ -0,0 +1,71 @@
+module Feedzirra
+  module FeedUtilities
+    UPDATABLE_ATTRIBUTES = %w(title feed_url url last_modified)
+    
+    attr_writer   :new_entries, :updated, :last_modified
+    attr_accessor :etag
+
+    def last_modified
+      @last_modified ||= begin
+        entry = entries.reject {|e| e.published.nil? }.sort_by { |entry| entry.published if entry.published }.last
+        entry ? entry.published : nil
+      end
+    end
+    
+    def updated?
+      @updated
+    end
+    
+    def new_entries
+      @new_entries ||= []
+    end
+    
+    def has_new_entries?
+      new_entries.size > 0
+    end
+    
+    def update_from_feed(feed)
+      self.new_entries += find_new_entries_for(feed)
+      self.entries.unshift(*self.new_entries)
+      
+      updated! if UPDATABLE_ATTRIBUTES.any? { |name| update_attribute(feed, name) }
+    end
+    
+    def update_attribute(feed, name)
+      old_value, new_value = send(name), feed.send(name)
+      
+      if old_value != new_value
+        send("#{name}=", new_value)
+      end
+    end
+    
+    def sanitize_entries!
+      entries.each {|entry| entry.sanitize!}
+    end
+    
+    private
+    
+    def updated!
+      @updated = true
+    end
+    
+    def find_new_entries_for(feed)
+      # this implementation is a hack, which is why it's so ugly.
+      # it's to get around the fact that not all feeds have a published date.
+      # however, they're always ordered with the newest one first.
+      # So we go through the entries just parsed and insert each one as a new entry
+      # until we get to one that has the same url as the the newest for the feed
+      latest_entry = self.entries.first
+      found_new_entries = []
+      feed.entries.each do |entry|
+        break if entry.url == latest_entry.url
+        found_new_entries << entry
+      end
+      found_new_entries
+    end
+    
+    def existing_entry?(test_entry)
+      entries.any? { |entry| entry.url == test_entry.url }
+    end
+  end
+end

data/lib/feedzirra/itunes_rss.rb

@@ -0,0 +1,46 @@
+module Feedzirra
+  # iTunes is RSS 2.0 + some apple extensions
+  # Source: http://www.apple.com/itunes/whatson/podcasts/specs.html
+  class ITunesRSS
+    include SAXMachine
+    include FeedUtilities
+
+    attr_accessor :feed_url
+
+    # RSS 2.0 elements that need including
+    element :copyright
+    element :description
+    element :language
+    element :managingEditor
+    element :title
+    element :link, :as => :url
+
+    # If author is not present use managingEditor on the channel
+    element :"itunes:author", :as => :itunes_author
+    element :"itunes:block", :as => :itunes_block
+    element :"itunes:image", :value => :href, :as => :itunes_image
+    element :"itunes:explicit", :as => :itunes_explicit
+    element :"itunes:keywords", :as => :itunes_keywords
+    # New URL for the podcast feed
+    element :"itunes:new-feed-url", :as => :itunes_new_feed_url
+    element :"itunes:subtitle", :as => :itunes_subtitle
+    # If summary is not present, use the description tag
+    element :"itunes:summary", :as => :itunes_summary
+
+    # iTunes RSS feeds can have multiple main categories...
+    # ...and multiple sub-categories per category
+    # TODO subcategories not supported correctly - they are at the same level
+    #   as the main categories
+    elements :"itunes:category", :as => :itunes_categories, :value => :text
+
+    elements :"itunes:owner", :as => :itunes_owners, :class => ITunesRSSOwner
+
+    elements :item, :as => :entries, :class => ITunesRSSItem
+
+    def self.able_to_parse?(xml)
+      xml =~ /xmlns:itunes=\"http:\/\/www.itunes.com\/dtds\/podcast-1.0.dtd\"/
+    end
+
+  end
+
+end

data/lib/feedzirra/itunes_rss_item.rb

@@ -0,0 +1,28 @@
+module Feedzirra
+  # iTunes extensions to the standard RSS2.0 item
+  # Source: http://www.apple.com/itunes/whatson/podcasts/specs.html
+  class ITunesRSSItem
+    include SAXMachine
+    include FeedUtilities
+    element :author
+    element :guid
+    element :title
+    element :link, :as => :url
+    element :description, :as => :summary
+    element :pubDate, :as => :published
+
+    # If author is not present use author tag on the item
+    element :"itunes:author", :as => :itunes_author
+    element :"itunes:block", :as => :itunes_block
+    element :"itunes:duration", :as => :itunes_duration
+    element :"itunes:explicit", :as => :itunes_explicit
+    element :"itunes:keywords", :as => :itunes_keywords
+    element :"itunes:subtitle", :as => :itunes_subtitle
+    # If summary is not present, use the description tag
+    element :"itunes:summary", :as => :itunes_summary
+    element :enclosure, :value => :length, :as => :enclosure_length
+    element :enclosure, :value => :type, :as => :enclosure_type
+    element :enclosure, :value => :url, :as => :enclosure_url
+  end
+
+end

data/lib/feedzirra/itunes_rss_owner.rb

@@ -0,0 +1,8 @@
+module Feedzirra
+  class ITunesRSSOwner
+    include SAXMachine
+    include FeedUtilities
+    element :"itunes:name", :as => :name
+    element :"itunes:email", :as => :email
+  end
+end

data/lib/feedzirra/rss.rb

@@ -0,0 +1,23 @@
+module Feedzirra
+  # == Summary
+  # Parser for dealing with RSS feeds.
+  #
+  # == Attributes
+  # * title
+  # * feed_url
+  # * url
+  # * entries
+  class RSS
+    include SAXMachine
+    include FeedUtilities
+    element :title
+    element :link, :as => :url
+    elements :item, :as => :entries, :class => RSSEntry
+    
+    attr_accessor :feed_url
+    
+    def self.able_to_parse?(xml) #:nodoc:
+      xml =~ /\<rss|rdf/
+    end
+  end
+end

data/lib/feedzirra/rss_entry.rb

@@ -0,0 +1,35 @@
+module Feedzirra
+  # == Summary
+  # Parser for dealing with RDF feed entries.
+  #
+  # == Attributes
+  # * title
+  # * url
+  # * author
+  # * content
+  # * summary
+  # * published
+  # * categories
+  class RSSEntry
+    include SAXMachine
+    include FeedEntryUtilities
+    element :title
+    element :link, :as => :url
+
+    element :"dc:creator", :as => :author
+    element :"content:encoded", :as => :content
+    element :description, :as => :summary
+
+    element :pubDate, :as => :published
+    element :"dc:date", :as => :published
+    element :"dc:Date", :as => :published
+    element :"dcterms:created", :as => :published
+    
+    
+    element :"dcterms:modified", :as => :updated
+    element :issued, :as => :published
+    elements :category, :as => :categories
+    
+    element :guid, :as => :id
+  end
+end

data/spec/feedzirra/atom_entry_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Feedzirra::AtomEntry do
+  before(:each) do
+    # I don't really like doing it this way because these unit test should only rely on AtomEntry,
+    # but this is actually how it should work. You would never just pass entry xml straight to the AtomEnry
+    @entry = Feedzirra::Atom.parse(sample_atom_feed).entries.first
+  end
+  
+  it "should parse the title" do
+    @entry.title.should == "AWS Job: Architect & Designer Position in Turkey"
+  end
+  
+  it "should parse the url" do
+    @entry.url.should == "http://aws.typepad.com/aws/2009/01/aws-job-architect-designer-position-in-turkey.html"
+  end
+  
+  it "should parse the author" do
+    @entry.author.should == "AWS Editor"
+  end
+  
+  it "should parse the content" do
+    @entry.content.should == sample_atom_entry_content
+  end
+  
+  it "should provide a summary" do
+    @entry.summary.should == "Late last year an entrepreneur from Turkey visited me at Amazon HQ in Seattle. We talked about his plans to use AWS as part of his new social video portal startup. I won't spill any beans before he's ready to..."
+  end
+  
+  it "should parse the published date" do
+    @entry.published.to_s.should == "Fri Jan 16 18:21:00 UTC 2009"
+  end
+
+  it "should parse the categories" do
+    @entry.categories.should == ['Turkey', 'Seattle']
+  end
+  
+  it "should parse the updated date" do
+    @entry.updated.to_s.should == "Fri Jan 16 18:21:00 UTC 2009"
+  end
+  
+  it "should parse the id" do
+    @entry.id.should == "tag:typepad.com,2003:post-61484736"
+  end
+end

data/spec/feedzirra/atom_feed_burner_entry_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Feedzirra::AtomFeedBurnerEntry do
+  before(:each) do
+    # I don't really like doing it this way because these unit test should only rely on AtomEntry,
+    # but this is actually how it should work. You would never just pass entry xml straight to the AtomEnry
+    @entry = Feedzirra::AtomFeedBurner.parse(sample_feedburner_atom_feed).entries.first
+  end
+  
+  it "should parse the title" do
+    @entry.title.should == "Making a Ruby C library even faster"
+  end
+  
+  it "should be able to fetch a url via the 'alternate' rel if no origLink exists" do
+    entry = Feedzirra::AtomFeedBurner.parse(File.read("#{File.dirname(__FILE__)}/../sample_feeds/PaulDixExplainsNothingAlternate.xml")).entries.first
+    entry.url.should == 'http://feeds.feedburner.com/~r/PaulDixExplainsNothing/~3/519925023/making-a-ruby-c-library-even-faster.html'
+  end
+
+  it "should parse the url" do
+    @entry.url.should == "http://www.pauldix.net/2009/01/making-a-ruby-c-library-even-faster.html"
+  end
+  
+  it "should parse the author" do
+    @entry.author.should == "Paul Dix"
+  end
+  
+  it "should parse the content" do
+    @entry.content.should == sample_feedburner_atom_entry_content
+  end
+  
+  it "should provide a summary" do
+    @entry.summary.should == "Last week I released the first version of a SAX based XML parsing library called SAX-Machine. It uses Nokogiri, which uses libxml, so it's pretty fast. However, I felt that it could be even faster. The only question was how..."
+  end
+  
+  it "should parse the published date" do
+    @entry.published.to_s.should == "Thu Jan 22 15:50:22 UTC 2009"
+  end
+
+  it "should parse the categories" do
+    @entry.categories.should == ['Ruby', 'Another Category']
+  end
+end

data/spec/feedzirra/atom_feed_burner_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Feedzirra::AtomFeedBurner do
+  describe "#will_parse?" do
+    it "should return true for a feedburner atom feed" do
+      Feedzirra::AtomFeedBurner.should be_able_to_parse(sample_feedburner_atom_feed)
+    end
+    
+    it "should return false for an rdf feed" do
+      Feedzirra::AtomFeedBurner.should_not be_able_to_parse(sample_rdf_feed)
+    end
+    
+    it "should return false for a regular atom feed" do
+      Feedzirra::AtomFeedBurner.should_not be_able_to_parse(sample_atom_feed)
+    end
+  end
+
+  describe "parsing" do
+    before(:each) do
+      @feed = Feedzirra::AtomFeedBurner.parse(sample_feedburner_atom_feed)
+    end
+    
+    it "should parse the title" do
+      @feed.title.should == "Paul Dix Explains Nothing"
+    end
+    
+    it "should parse the url" do
+      @feed.url.should == "http://www.pauldix.net/"
+    end
+    
+    it "should parse the feed_url" do
+      @feed.feed_url.should == "http://feeds.feedburner.com/PaulDixExplainsNothing"
+    end
+    
+    it "should parse entries" do
+      @feed.entries.size.should == 5
+    end
+  end
+end

data/spec/feedzirra/atom_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Feedzirra::Atom do
+  describe "#will_parse?" do
+    it "should return true for an atom feed" do
+      Feedzirra::Atom.should be_able_to_parse(sample_atom_feed)
+    end
+    
+    it "should return false for an rdf feed" do
+      Feedzirra::Atom.should_not be_able_to_parse(sample_rdf_feed)
+    end
+  end
+  
+  describe "parsing" do
+    before(:each) do
+      @feed = Feedzirra::Atom.parse(sample_atom_feed)
+    end
+    
+    it "should parse the title" do
+      @feed.title.should == "Amazon Web Services Blog"
+    end
+    
+    it "should parse the url" do
+      @feed.url.should == "http://aws.typepad.com/aws/"
+    end
+    
+    it "should parse the feed_url" do
+      @feed.feed_url.should == "http://aws.typepad.com/aws/atom.xml"
+    end
+    
+    it "should parse entries" do
+      @feed.entries.size.should == 10
+    end
+  end
+end

data/spec/feedzirra/feed_entry_utilities_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Feedzirra::FeedUtilities do
+  before(:each) do
+    @klass = Class.new do
+      include Feedzirra::FeedEntryUtilities
+    end
+  end
+  
+  describe "handling dates" do
+    it "should parse an ISO 8601 formatted datetime into Time" do
+      time = @klass.new.parse_datetime("2008-02-20T8:05:00-010:00")
+      time.class.should == Time
+      time.to_s.should == "Wed Feb 20 18:05:00 UTC 2008"
+    end
+  end
+  
+  describe "sanitizing" do
+    before(:each) do
+      @feed = Feedzirra::Feed.parse(sample_atom_feed)
+      @entry = @feed.entries.first
+    end
+    
+    it "should provide a sanitized title" do
+      new_title = "<script>" + @entry.title
+      @entry.title = new_title
+      @entry.title.sanitize.should == Dryopteris.sanitize(new_title)
+    end
+    
+    it "should sanitize content in place" do
+      new_content = "<script>" + @entry.content
+      @entry.content = new_content.dup
+      @entry.content.sanitize!.should == Dryopteris.sanitize(new_content)
+      @entry.content.should == Dryopteris.sanitize(new_content)
+    end
+    
+    it "should sanitize things in place" do
+      @entry.title   += "<script>"
+      @entry.author  += "<script>"
+      @entry.content += "<script>"
+
+      cleaned_title   = Dryopteris.sanitize(@entry.title)
+      cleaned_author  = Dryopteris.sanitize(@entry.author)
+      cleaned_content = Dryopteris.sanitize(@entry.content)
+      
+      @entry.sanitize!
+      @entry.title.should   == cleaned_title
+      @entry.author.should  == cleaned_author
+      @entry.content.should == cleaned_content
+    end
+  end
+end