rickerbh-feedzirra 0.0.4

data/README.textile

@@ -0,0 +1,176 @@
+h1. Feedzirra
+
+"http://github.com/pauldix/feedzirra/tree/master":http://github.com/pauldix/feedzirra/tree/master 
+
+I'd like feedback on the api and any bugs encountered on feeds in the wild. I've set up a "google group here":http://groups.google.com/group/feedzirra.
+
+h2. Summary
+
+A feed fetching and parsing library that treats the internet like Godzilla treats Japan: it dominates and eats all.
+
+h2. Description
+
+Feedzirra is a feed library that is designed to get and update many feeds as quickly as possible. This includes using libcurl-multi through the "taf2-curb":http://github.com/taf2/curb/tree/master gem for faster http gets, and libxml through "nokogiri":http://github.com/tenderlove/nokogiri/tree/master and "sax-machine":http://github.com/pauldix/sax-machine/tree/master for faster parsing.
+
+Once you have fetched feeds using Feedzirra, they can be updated using the feed objects. Feedzirra automatically inserts etag and last-modified information from the http response headers to lower bandwidth usage, eliminate unnecessary parsing, and make things speedier in general.
+
+Another feature present in Feedzirra is the ability to create callback functions that get called "on success" and "on failure" when getting a feed. This makes it easy to do things like log errors or update data stores.
+
+The fetching and parsing logic have been decoupled so that either of them can be used in isolation if you'd prefer not to use everything that Feedzirra offers. However, the code examples below use helper methods in the Feed class that put everything together to make things as simple as possible.
+
+The final feature of Feedzirra is the ability to define custom parsing classes. In truth, Feedzirra could be used to parse much more than feeds. Microformats, page scraping, and almost anything else are fair game.
+
+h2. Installation
+
+For now Feedzirra exists only on github. It also has a few gem requirements that are only on github. Before you start you need to have "libcurl":http://curl.haxx.se/ and "libxml":http://xmlsoft.org/ installed. If you're on Leopard you have both. Otherwise, you'll need to grab them. Once you've got those libraries, these are the gems that get used: nokogiri, pauldix-sax-machine, taf2-curb (note that this is a fork that lives on github and not the Ruby Forge version of curb), and pauldix-feedzirra. The feedzirra gemspec has all the dependencies so you should be able to get up and running with the standard github gem install routine:
+<pre>
+gem sources -a http://gems.github.com # if you haven't already
+gem install pauldix-feedzirra
+</pre>
+<b>NOTE:</b>Some people have been reporting a few issues related to installation. First, the Ruby Forge version of curb is not what you want. It will not work. Nor will the curl-multi gem that lives on Ruby Forge. You have to get the "taf2-curb":http://github.com/taf2/curb/tree/master fork installed.
+
+If you see this error when doing a require: 
+<pre>
+/Library/Ruby/Site/1.8/rubygems/custom_require.rb:31:in `gem_original_require': no such file to load -- curb_core (LoadError)
+</pre>
+It means that the taf2-curb gem didn't build correctly. To resolve this you can do a git clone git://github.com/taf2/curb.git then run rake gem in the curb directory, then sudo gem install pkg/curb-0.2.4.0.gem. After that you should be good.
+
+If you see something like this when trying to run it:
+<pre>
+NoMethodError: undefined method `on_success' for #<Curl::Easy:0x1182724>
+	from ./lib/feedzirra/feed.rb:88:in `add_url_to_multi'
+</pre>
+This means that you are requiring curl-multi or the Ruby Forge version of Curb somewhere. You can't use those and need to get the taf2 version up and running.
+
+If you're on Debian or Ubuntu and getting errors while trying to install the taf2-curb gem, it could be because you don't have the latest version of libcurl installed. Do this to fix:
+<pre>
+sudo apt-get install libcurl4-gnutls-dev
+</pre>
+
+Another problem could be if you are running Mac Ports and you have libcurl installed through there. You need to uninstall it for curb to work! The version in Mac Ports is old and doesn't play nice with curb. If you're running Leopard, you can just uninstall and you should be golden. If you're on an older version of OS X, you'll then need to "download curl":http://curl.haxx.se/download.html and build from source. Then you'll have to install the taf2-curb gem again. You might have to perform the step above.
+
+If you're still having issues, please let me know on the mailing list. Also, "Todd Fisher (taf2)":http://github.com/taf2 is working on fixing the gem install. Please send him a full error report.
+
+h2. Usage
+
+"A gist of the following code":http://gist.github.com/57285
+<pre>
+require 'feedzirra'
+
+# fetching a single feed
+feed = Feedzirra::Feed.fetch_and_parse("http://feeds.feedburner.com/PaulDixExplainsNothing")
+
+# feed and entries accessors
+feed.title          # => "Paul Dix Explains Nothing"
+feed.url            # => "http://www.pauldix.net"
+feed.feed_url       # => "http://feeds.feedburner.com/PaulDixExplainsNothing"
+feed.etag           # => "GunxqnEP4NeYhrqq9TyVKTuDnh0"
+feed.last_modified  # => Sat Jan 31 17:58:16 -0500 2009 # it's a Time object
+
+entry = feed.entries.first
+entry.title      # => "Ruby Http Client Library Performance"
+entry.url        # => "http://www.pauldix.net/2009/01/ruby-http-client-library-performance.html"
+entry.author     # => "Paul Dix"
+entry.summary    # => "..."
+entry.content    # => "..."
+entry.published  # => Thu Jan 29 17:00:19 UTC 2009 # it's a Time object
+entry.categories # => ["...", "..."]
+
+# sanitizing an entry's content
+entry.title.sanitize   # => returns the title with harmful stuff escaped
+entry.author.sanitize  # => returns the author with harmful stuff escaped
+entry.content.sanitize # => returns the content with harmful stuff escaped
+entry.content.sanitize! # => returns content with harmful stuff escaped and replaces original (also exists for author and title)
+entry.sanitize!         # => sanitizes the entry's title, author, and content in place (as in, it changes the value to clean versions)
+feed.sanitize_entries!  # => sanitizes all entries in place
+
+# updating a single feed
+updated_feed = Feedzirra::Feed.update(feed)
+
+# an updated feed has the following extra accessors
+updated_feed.updated?     # returns true if any of the feed attributes have been modified. will return false if only new entries
+updated_feed.new_entries  # a collection of the entry objects that are newer than the latest in the feed before update
+
+# fetching multiple feeds
+feed_urls = ["http://feeds.feedburner.com/PaulDixExplainsNothing", "http://feeds.feedburner.com/trottercashion"]
+feeds = Feedzirra::Feed.fetch_and_parse(feeds_urls)
+
+# feeds is now a hash with the feed_urls as keys and the parsed feed objects as values. If an error was thrown
+# there will be a Fixnum of the http response code instead of a feed object
+
+# updating multiple feeds. it expects a collection of feed objects
+updated_feeds = Feedzirra::Feed.udpate(feeds.values)
+
+# defining custom behavior on failure or success. note that a return status of 304 (not updated) will call the on_success handler
+feed = Feedzirra::Feed.fetch_and_parse("http://feeds.feedburner.com/PaulDixExplainsNothing",
+	:on_success => lambda {|feed| puts feed.title },
+	:on_failure => lambda {|url, response_code, response_header, response_body| puts response_body })
+# if a collection was passed into fetch_and_parse, the handlers will be called for each one
+
+# the behavior for the handlers when using Feedzirra::Feed.update is slightly different. The feed passed into on_success will be
+# the updated feed with the standard updated accessors. on failure it will be the original feed object passed into update
+
+# Defining custom parsers
+# TODO: the functionality is here, just write some good examples that show how to do this
+</pre>
+
+h2. Benchmarks
+
+One of the goals of Feedzirra is speed. This includes not only parsing, but fetching multiple feeds as quickly as possible. I ran a benchmark getting 20 feeds 10 times using Feedzirra, rFeedParser, and FeedNormalizer. For more details the "benchmark code can be found in the project in spec/benchmarks/feedzirra_benchmarks.rb":http://github.com/pauldix/feedzirra/blob/7fb5634c5c16e9c6ec971767b462c6518cd55f5d/spec/benchmarks/feedzirra_benchmarks.rb
+<pre>
+feedzirra          5.170000   1.290000   6.460000 ( 18.917796)
+rfeedparser      104.260000  12.220000 116.480000 (244.799063)
+feed-normalizer   66.250000   4.010000  70.260000 (191.589862)
+</pre>
+The result of that benchmark is a bit sketchy because of the network variability. Running 10 times against the same 20 feeds was meant to smooth some of that out. However, there is also a "benchmark comparing parsing speed in spec/benchmarks/parsing_benchmark.rb":http://github.com/pauldix/feedzirra/blob/7fb5634c5c16e9c6ec971767b462c6518cd55f5d/spec/benchmarks/parsing_benchmark.rb on an atom feed.
+<pre>
+feedzirra        0.500000   0.030000   0.530000 (  0.658744)
+rfeedparser      8.400000   1.110000   9.510000 ( 11.839827)
+feed-normalizer  5.980000   0.160000   6.140000 (  7.576140)
+</pre>
+There's also a "benchmark that shows the results of using Feedzirra to perform updates on feeds":http://github.com/pauldix/feedzirra/blob/45d64319544c61a4c9eb9f7f825c73b9f9030cb3/spec/benchmarks/updating_benchmarks.rb you've already pulled in. I tested against 179 feeds. The first is the initial pull and the second is an update 65 seconds later. I'm not sure how many of them support etag and last-modified, so performance may be better or worse depending on what feeds you're requesting.
+<pre>
+feedzirra fetch and parse  4.010000   0.710000   4.720000 ( 15.110101)
+feedzirra update           0.660000   0.280000   0.940000 (  5.152709)
+</pre>
+
+h2. Next Steps
+
+This thing needs to hammer on many different feeds in the wild. I'm sure there will be bugs. I want to find them and crush them. I didn't bother using the test suite for feedparser. i wanted to start fresh.
+
+Here are some more specific TODOs.
+* Make a feedzirra-rails gem to integrate feedzirra seamlessly with Rails and ActiveRecord.
+* Add support for authenticated feeds.
+* Create a super sweet DSL for defining new parsers.
+* Test against Ruby 1.9.1 and fix any bugs.
+* I'm not keeping track of modified on entries. Should I add this?
+* Clean up the fetching code inside feed.rb so it doesn't suck so hard.
+* Make the feed_spec actually mock stuff out so it doesn't hit the net.
+* Readdress how feeds determine if they can parse a document. Maybe I should use namespaces instead?
+
+h2. LICENSE
+
+(The MIT License)
+ 
+Copyright (c) 2009:
+ 
+"Paul Dix":http://pauldix.net
+ 
+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/Rakefile

@@ -0,0 +1,14 @@
+require "spec"
+require "spec/rake/spectask"
+require 'lib/feedzirra.rb'
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :install do
+  rm_rf "*.gem"
+  puts `gem build feedzirra.gemspec`
+  puts `sudo gem install feedzirra-#{Feedzirra::VERSION}.gem`
+end

data/lib/core_ext/date.rb

@@ -0,0 +1,21 @@
+# Date code pulled from:
+# Ruby Cookbook by Lucas Carlson and Leonard Richardson
+# Published by O'Reilly
+# ISBN: 0-596-52369-6
+class Date
+  def feed_utils_to_gm_time
+    feed_utils_to_time(new_offset, :gm)
+  end
+
+  def feed_utils_to_local_time
+    feed_utils_to_time(new_offset(DateTime.now.offset-offset), :local)
+  end
+
+  private
+  def feed_utils_to_time(dest, method)
+    #Convert a fraction of a day to a number of microseconds
+    usec = (dest.sec_fraction * 60 * 60 * 24 * (10**6)).to_i
+    Time.send(method, dest.year, dest.month, dest.day, dest.hour, dest.min,
+              dest.sec, usec)
+  end
+end

data/lib/feedzirra/atom.rb

@@ -0,0 +1,14 @@
+module Feedzirra
+  class Atom
+    include SAXMachine
+    include FeedUtilities
+    element :title
+    element :link, :as => :url, :value => :href, :with => {:type => "text/html"}
+    element :link, :as => :feed_url, :value => :href, :with => {:type => "application/atom+xml"}
+    elements :entry, :as => :entries, :class => AtomEntry
+    
+    def self.able_to_parse?(xml)
+      xml =~ /(Atom)|(#{Regexp.escape("http://purl.org/atom")})/
+    end
+  end
+end

data/lib/feedzirra/atom_entry.rb

@@ -0,0 +1,14 @@
+module Feedzirra
+  class AtomEntry
+    include SAXMachine
+    include FeedEntryUtilities
+    element :title
+    element :link, :as => :url, :value => :href, :with => {:type => "text/html", :rel => "alternate"}
+    element :name, :as => :author
+    element :content
+    element :summary
+    element :published
+    element :created, :as => :published
+    elements :category, :as => :categories, :value => :term
+  end
+end

data/lib/feedzirra/atom_feed_burner.rb

@@ -0,0 +1,14 @@
+module Feedzirra
+  class AtomFeedBurner
+    include SAXMachine
+    include FeedUtilities
+    element :title
+    element :link, :as => :url, :value => :href, :with => {:type => "text/html"}
+    element :link, :as => :feed_url, :value => :href, :with => {:type => "application/atom+xml"}
+    elements :entry, :as => :entries, :class => AtomFeedBurnerEntry
+
+    def self.able_to_parse?(xml)
+      (xml =~ /Atom/ && xml =~ /feedburner/) || false
+    end
+  end
+end

data/lib/feedzirra/atom_feed_burner_entry.rb

@@ -0,0 +1,14 @@
+module Feedzirra
+  class AtomFeedBurnerEntry
+    include SAXMachine
+    include FeedEntryUtilities
+    element :title
+    element :name, :as => :author
+    element :link, :as => :url, :value => :href, :with => {:type => "text/html", :rel => "alternate"}
+    element :"feedburner:origLink", :as => :url
+    element :summary
+    element :content
+    element :published
+    elements :category, :as => :categories, :value => :term
+  end
+end

data/lib/feedzirra/feed.rb

@@ -0,0 +1,173 @@
+module Feedzirra
+  class NoParserAvailable < StandardError; end
+  
+  class Feed
+    USER_AGENT = "feedzirra http://github.com/pauldix/feedzirra/tree/master"
+    
+    def self.parse(xml)
+      if parser = determine_feed_parser_for_xml(xml)
+        parser.parse(xml)
+      else
+        raise NoParserAvailable.new("no valid parser for content.")
+      end
+    end
+
+    def self.determine_feed_parser_for_xml(xml)
+      start_of_doc = xml.slice(0, 1000)
+      feed_classes.detect {|klass| klass.able_to_parse?(start_of_doc)}
+    end
+
+    def self.add_feed_class(klass)
+      feed_classes.unshift klass
+    end
+    
+    def self.feed_classes
+      @feed_classes ||= [ITunesRSS, RSS, AtomFeedBurner, Atom]
+    end
+
+    # can take a single url or an array of urls
+    # when passed a single url it returns the body of the response
+    # when passed an array of urls it returns a hash with the urls as keys and body of responses as values
+    def self.fetch_raw(urls, options = {})
+      url_queue = [*urls]
+      multi = Curl::Multi.new
+      responses = {}
+      url_queue.each do |url|
+        easy = Curl::Easy.new(url) do |curl|
+          curl.headers["User-Agent"]        = (options[:user_agent] || USER_AGENT)
+          curl.headers["If-Modified-Since"] = options[:if_modified_since].httpdate if options.has_key?(:if_modified_since)
+          curl.headers["If-None-Match"]     = options[:if_none_match] if options.has_key?(:if_none_match)
+          curl.headers["Accept-encoding"]   = 'gzip, deflate'
+          curl.follow_location = true
+          curl.on_success do |c|
+            responses[url] = decode_content(c)
+          end
+          curl.on_failure do |c|
+            responses[url] = c.response_code
+          end
+        end
+        multi.add(easy)
+      end
+
+      multi.perform
+      return urls.is_a?(String) ? responses.values.first : responses
+    end
+    
+    def self.fetch_and_parse(urls, options = {})
+      url_queue = [*urls]
+      multi = Curl::Multi.new
+
+      # I broke these down so I would only try to do 30 simultaneously because 
+      # I was getting weird errors when doing a lot. As one finishes it pops another off the queue.
+      responses = {}
+      url_queue.slice!(0, 30).each do |url|
+        add_url_to_multi(multi, url, url_queue, responses, options)
+      end
+
+      multi.perform
+      return urls.is_a?(String) ? responses.values.first : responses
+    end
+    
+    def self.decode_content(c)
+      if c.header_str.match(/Content-Encoding: gzip/)
+        gz =  Zlib::GzipReader.new(StringIO.new(c.body_str))
+        xml = gz.read
+        gz.close
+      elsif c.header_str.match(/Content-Encoding: deflate/)
+        xml = Zlib::Deflate.inflate(c.body_str)
+      else
+        xml = c.body_str
+      end
+      
+      xml
+    end
+    
+    def self.update(feeds, options = {})
+      feed_queue = [*feeds]
+      multi = Curl::Multi.new
+      responses = {}
+      feed_queue.slice!(0, 30).each do |feed|
+        add_feed_to_multi(multi, feed, feed_queue, responses, options)
+      end
+    
+      multi.perform
+      return responses.size == 1 ? responses.values.first : responses.values
+    end
+    
+    def self.add_url_to_multi(multi, url, url_queue, responses, options)
+      easy = Curl::Easy.new(url) do |curl|
+        curl.headers["User-Agent"]        = (options[:user_agent] || USER_AGENT)
+        curl.headers["If-Modified-Since"] = options[:if_modified_since].httpdate if options.has_key?(:if_modified_since)
+        curl.headers["If-None-Match"]     = options[:if_none_match] if options.has_key?(:if_none_match)
+        curl.headers["Accept-encoding"]   = 'gzip, deflate'
+        curl.follow_location = true
+        curl.on_success do |c|
+          add_url_to_multi(multi, url_queue.shift, url_queue, responses, options) unless url_queue.empty?
+          xml = decode_content(c)
+          klass = determine_feed_parser_for_xml(xml)
+          if klass
+            feed = klass.parse(xml)
+            feed.feed_url = c.last_effective_url
+            feed.etag = etag_from_header(c.header_str)
+            feed.last_modified = last_modified_from_header(c.header_str)
+            responses[url] = feed
+            options[:on_success].call(url, feed) if options.has_key?(:on_success)
+          else
+            puts "Error determining parser for #{url} - #{c.last_effective_url}"
+          end
+        end
+        curl.on_failure do |c|
+          add_url_to_multi(multi, url_queue.shift, url_queue, responses, options) unless url_queue.empty?
+          responses[url] = c.response_code
+          options[:on_failure].call(url, c.response_code, c.header_str, c.body_str) if options.has_key?(:on_failure)
+        end
+      end
+      multi.add(easy)
+    end
+    
+    def self.add_feed_to_multi(multi, feed, feed_queue, responses, options)
+      # on_success = options[:on_success]
+      # on_failure = options[:on_failure]
+      # options[:on_success] = lambda do ||
+      
+      easy = Curl::Easy.new(feed.feed_url) do |curl|
+        curl.headers["User-Agent"]        = (options[:user_agent] || USER_AGENT)
+        curl.headers["If-Modified-Since"] = feed.last_modified.httpdate if feed.last_modified
+        curl.headers["If-None-Match"]     = feed.etag if feed.etag
+        curl.follow_location = true
+        curl.on_success do |c|
+          add_feed_to_multi(multi, feed_queue.shift, feed_queue, responses, options) unless feed_queue.empty?
+          updated_feed = Feed.parse(c.body_str)
+          updated_feed.feed_url = c.last_effective_url
+          updated_feed.etag = etag_from_header(c.header_str)
+          updated_feed.last_modified = last_modified_from_header(c.header_str)
+          feed.update_from_feed(updated_feed)
+          responses[feed.feed_url] = feed
+          options[:on_success].call(feed) if options.has_key?(:on_success)
+        end
+        curl.on_failure do |c|
+          add_feed_to_multi(multi, feed_queue.shift, feed_queue, responses, options) unless feed_queue.empty?
+          response_code = c.response_code
+          if response_code == 304 # it's not modified. this isn't an error condition
+            responses[feed.feed_url] = feed
+            options[:on_success].call(feed) if options.has_key?(:on_success)
+          else
+            responses[feed.url] = c.response_code
+            options[:on_failure].call(feed, c.response_code, c.header_str, c.body_str) if options.has_key?(:on_failure)
+          end
+        end
+      end
+      multi.add(easy)
+    end
+    
+    def self.etag_from_header(header)
+      header =~ /.*ETag:\s(.*)\r/
+      $1
+    end
+    
+    def self.last_modified_from_header(header)
+      header =~ /.*Last-Modified:\s(.*)\r/
+      Time.parse($1) if $1
+    end
+  end
+end