cdamian-feedlib 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Damian Caruso
+
+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.markdown

@@ -0,0 +1,19 @@
+## feedlib
+
+Usage:
+
+    feedlib = Feedlib.instance
+    feed = feedlib.fetch("http://domain")
+    puts feed.title
+    puts feed.description
+    feed.entries.each do |entry|
+        puts entry.link
+        puts entry.author
+        puts entry.title
+        puts entry.content
+        puts entry.published_at
+    end
+
+## Copyright
+
+Copyright (c) 2009 Damian Caruso. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "feedlib"
+    gem.summary = %Q{Feed library for building and parsing Atom and RSS feeds}
+    gem.email = "damian.caruso@gmail.com"
+    gem.homepage = "http://github.com/cdamian/feedlib"
+    gem.authors = ["Damian Caruso"]
+    gem.description = %Q{Feed library for building and parsing Atom and RSS feeds}
+    gem.files = FileList['lib/**/*.rb', '[A-Z]*', 'test/**/*'].to_a
+    gem.add_dependency("hpricot", ">= 0.8.1")
+    gem.add_dependency("chardet", ">= 0.9.0")
+    gem.add_dependency("htmlentities", ">= 4.0.0")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "feedlib #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/feedlib/errors.rb

@@ -0,0 +1,5 @@
+class FeedLibError < StandardError;end
+
+class UnavailableFeedSourceError < FeedLibError;end
+
+class UnknownFeedTypeError < FeedLibError;end

data/lib/feedlib/feed/atom.rb

@@ -0,0 +1,4 @@
+require 'feedlib/feed'
+
+class FeedAtom < Feed
+end

data/lib/feedlib/feed/entry/atom.rb

@@ -0,0 +1,4 @@
+require 'feedlib/feed/entry'
+
+class FeedEntryAtom < FeedEntry
+end

data/lib/feedlib/feed/entry/rss.rb

@@ -0,0 +1,4 @@
+require 'feedlib/feed/entry'
+
+class FeedEntryRss < FeedEntry
+end

data/lib/feedlib/feed/entry.rb

@@ -0,0 +1,11 @@
+class FeedEntry
+  attr_accessor :link, :author, :title, :content, :published_at
+	
+  def initialize
+  	@link = nil
+  	@author = nil
+  	@title = nil
+  	@content = nil
+  	@published_at = nil
+  end
+end

data/lib/feedlib/feed/rss.rb

@@ -0,0 +1,4 @@
+require 'feedlib/feed'
+
+class FeedRss < Feed
+end

data/lib/feedlib/feed.rb

@@ -0,0 +1,14 @@
+class Feed
+  attr_accessor :title, :description, :url, :entries
+  
+  def initialize
+  	@title = nil
+  	@description = nil
+  	@url = nil
+  	@entries = []
+  end
+  
+  def add_entry(entry)
+  	entries << entry
+  end
+end

data/lib/feedlib/parser/atom.rb

@@ -0,0 +1,24 @@
+require 'feedlib/parser'
+require 'feedlib/feed/atom'
+require 'feedlib/feed/entry/atom'
+
+class FeedAtomParser < FeedParser
+  def parse_feed
+  	@feed = FeedAtom.new
+  	(@source_xml/:entry).each do |entry|
+  	  new_entry = parse_entry(entry)
+  	  @feed.add_entry(new_entry)
+ 	end
+  end
+	
+  protected
+  def parse_entry(entry)
+  	new_entry = FeedEntryAtom.new
+  	new_entry.link    = (entry/:link).attr('href')
+  	new_entry.author  = (entry/:author/:name).inner_html
+  	new_entry.title   = sanitize((entry/:title).inner_html)
+  	new_entry.content = (entry/:content).inner_html.blank? ? sanitize((entry/:content).inner_html) : sanitize((entry/:summary).inner_html)
+  	new_entry.published_at = (entry/:published).inner_html
+  	new_entry
+  end
+end

data/lib/feedlib/parser/rss.rb

@@ -0,0 +1,24 @@
+require 'feedlib/parser'
+require 'feedlib/feed/rss'
+require 'feedlib/feed/entry/rss'
+
+class FeedRssParser < FeedParser
+  def parse_feed
+  	@feed = FeedRss.new
+  	(@source_xml/:channel/:item).each do |entry|
+  	  new_entry = parse_entry(entry)
+  	  @feed.add_entry(new_entry)
+  	end
+  end
+  
+  protected
+  def parse_entry(entry)
+  	new_entry = FeedEntryRss.new
+    new_entry.link    = (item/:link).inner_html
+    new_entry.author  = (item/:author).inner_html
+  	new_entry.title   = sanitize((item/:title).inner_html)
+  	new_entry.content = sanitize((item/:description).inner_html)
+  	new_entry.published_at = (item/:pubDate).inner_html
+  	new_entry
+  end
+end

data/lib/feedlib/parser.rb

@@ -0,0 +1,50 @@
+class FeedParser
+  attr_reader :feed  
+
+  def initialize(source_xml)
+  	@source_xml = source_xml
+  	parse_feed
+  end
+  
+  protected
+  def sanitize(html)
+    whitelist = %w(em i strong u)
+    attrs = {}
+    blacklist = %w(script)
+    
+    whitelist += attrs.keys
+    
+    html.gsub!('&lt;', '<')
+    html.gsub!('&gt;', '>')
+    html.gsub!('&amp;', '&')
+    html.gsub!('&#39;', "'")
+    html.gsub!('&quot;', '"')
+    html.gsub!('<![CDATA[<![CDATA[', '')
+    html.gsub!('<![CDATA[', '')
+    html.gsub!(']]>', '')
+    html.gsub!(']>', '')
+    page = Hpricot(html)
+   
+    page.search("*").each do |e|  
+      if e.elem?  
+        tagname = e.name.downcase  
+        if blacklist.include?(tagname)  
+          e.swap("")
+        elsif !whitelist.include?(tagname)  
+          e.parent.replace_child(e, e.children)   
+        elsif attrs.has_key?(tagname)  
+          e.attributes.delete_if { |key,val| !attrs[tagname].include?(key.downcase)}  
+        else
+          e.attributes = {}
+        end
+      elsif e.comment?
+        # HTML comments can contain executable scripts, depending on the browser, so we'll  
+        # be paranoid and just get rid of all of them  
+        # e.g. <!--[if lt IE 7]><script type="text/javascript">h4x0r();</script><![endif]-->  
+        e.swap('')
+      end
+    end
+    coder = HTMLEntities.new
+    coder.decode(page.to_s)
+  end  
+end

data/lib/feedlib.rb

@@ -0,0 +1,36 @@
+require 'open-uri'
+require 'hpricot'
+require 'UniversalDetector'
+require 'feedlib/errors'
+require 'feedlib/parser/atom'
+require 'feedlib/parser/rss'
+
+class Feedlib
+  include Singleton
+
+  def fetch(url)
+    begin
+      f = open(url, 'r')
+      xml = f.read()
+      encoding = UniversalDetector::encoding(xml)
+      xml = Iconv.iconv("UTF-8", encoding, xml).join
+      f.close
+      parser = get_parser(xml)
+      parser.feed
+    rescue OpenURI::HTTPError => e
+      raise UnavailableFeedSourceError
+    end
+  end
+  
+  private
+  def get_parser(xml)
+  	doc = Hpricot.XML(xml)
+  	if doc.search(:rss).size > 0
+      FeedRssParser.new(doc)
+    elsif doc.search(:feed).size > 0
+      FeedAtomParser.new(doc)
+    else
+      raise UnknownFeedTypeError
+    end
+  end
+end

data/test/feedlib_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class FeedlibTest < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'feedlib'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: cdamian-feedlib
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Damian Caruso
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: chardet
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: htmlentities
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 4.0.0
+    version: 
+description: Feed library for building and parsing Atom and RSS feeds
+email: damian.caruso@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/feedlib.rb
+- lib/feedlib/errors.rb
+- lib/feedlib/feed.rb
+- lib/feedlib/feed/atom.rb
+- lib/feedlib/feed/entry.rb
+- lib/feedlib/feed/entry/atom.rb
+- lib/feedlib/feed/entry/rss.rb
+- lib/feedlib/feed/rss.rb
+- lib/feedlib/parser.rb
+- lib/feedlib/parser/atom.rb
+- lib/feedlib/parser/rss.rb
+- test/feedlib_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/cdamian/feedlib
+post_install_message: 
+rdoc_options: 
+- --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: 3
+summary: Feed library for building and parsing Atom and RSS feeds
+test_files: 
+- test/feedlib_test.rb
+- test/test_helper.rb