public
Rubygem
Fork of jmhodges/rfeedparser
Description: rFeedParser is a translation of the Universal Feed Parser from Python into Ruby. It has nearly the exact same behavior.
Homepage: http://rfeedparser.rubyforge.org
Clone URL: git://github.com/technomancy/rfeedparser.git
rfeedparser / README
100644 59 lines (41 sloc) 1.6 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
= Universal Feed Parser
  http://rfeedparser.rubyforge.org
  Original Python code Copyright (c) 2002-5 by Mark Pilgrim
  Ruby port by Jeff Hodges.
 
== Description
 
Parse nearly any RSS and Atom feeds in Ruby. 3000 unit tests. Open source.
 
== Installation
 
For Debian-based systems:
 
  $ sudo apt-get install libxml-ruby1.8 # or libxml-parser-ruby1.8
 
And then:
 
  $ sudo gem install rfeedparser
 
Or for the latest development version:
 
  $ git clone git://github.com/jmhodges/rfeedparser.git
  $ cd rfeedparser
  $ sudo rake setup
  $ rake gem
  $ sudo gem install pkg/rfeedparser-$VERSION.gem
 
Dependencies on other gems are handled by rubygems, but rfeedparser
works better if it has bindings to a native XML parsing library. The
recommended choice is libxml, which is installable with the
libxml-ruby1.8 package in Debian-based systems. But it can also use
expat (the libxml-parser-ruby1.8 Debian package). In general libxml is
more robust and up-to-date, so you should use it unless you have a
specific reason to use expat.
 
== Usage
 
   require 'rubygems' # may omit if installed manually
   require 'rfeedparser'
 
   feed = FeedParser.parse("some-feed-stream-filepath-or-url")
 
   feed.entries.each do |e|
     puts e.title
     puts e.content
     puts e.published
     puts '----'
   end
 
== Contributing
 
Clone the git repository at git://github.com/jmhodges/rfeedparser.git and
which has a webpage at http://github.com/jmhodges/rfeedparser/tree/master.
 
== Todo
 
- Dependency installation instructions for other platforms.
- Use hoe.
- Publish RDoc; unify README and rubyforge home page.