README.rdoc in jsl-feedzirra-0.0.12.9 vs README.rdoc in jsl-feedzirra-0.0.12.10
- old
+ new
@@ -1,23 +1,23 @@
= Feedzirra
== 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[link:http://github.com/taf2/curb/tree/master] gem for faster http gets, and libxml through
-nokogiri[link:http://github.com/tenderlove/nokogiri/tree/master] and sax-machine[link:http://github.com/pauldix/sax-machine/tree/master] for
+{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.
It allows for easy customization of feed parsing options through the definition of custom parsing classes, and allows you to take as little or as
much control as you want in updating feeds. Feedzirra makes it easy to figure out which content in feeds is new by storing the previous retrieval
of a feed in a key-value store. Feedzirra uses the the "moneta" gem, which is a unified interface to key-value storage systems, in order to provide
access to many different types of stores depending on your requirements.
== 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[link:http://curl.haxx.se/] and libxml[link:http://xmlsoft.org/] installed. If you're on Leopard you have both. Otherwise, you'll need to
+{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, you should be able to get up and running with the standard github gem install routine:
gem sources -a http://gems.github.com # if you haven't already
gem install jsl-feedzirra
@@ -34,12 +34,11 @@
The Reader object can take a single URL or a list of URLs followed by a Hash of options. The options hash
allows configuration of the backend store, as well as fetching options for the list of urls. Following is
an example of configuration with the Memcache store connected to Tokyo Tyrant (the front-end for Tokyo Cabinet):
- reader = Feedzirra::Reader.new('http://www.pauldix.net/atom.xml', :backend =>
- { :moneta_klass => Moneta::Memcache, :port => 1978, :server => 'localhost' })
+ reader = Feedzirra::Reader.new('http://www.pauldix.net/atom.xml', :backend => { :moneta_klass => 'Moneta::Memcache', :server => 'localhost:1978' })
Other options that may be put in the options hash follow the original API described below.
Running reader.fetch will first check the back-end store to see if this feed was fetched previously. If it was previously fetched,
Feedzirra uses this information to avoid fetching the whole body if it has already been downloaded based on etag. If the feed
@@ -103,11 +102,11 @@
{google group here}[http://groups.google.com/group/feedzirra].
== Troubleshooting Installation
*NOTE:*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[link:http://github.com/taf2/curb/tree/master] fork installed.
+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:
/Library/Ruby/Site/1.8/rubygems/custom_require.rb:31:in `gem_original_require': no such file to load -- curb_core (LoadError)
@@ -125,11 +124,11 @@
sudo apt-get install libcurl4-gnutls-dev
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)}[link:http://github.com/taf2] is working on fixing the gem install. Please send him a full error report.
+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.
== TODO
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.
@@ -139,12 +138,10 @@
* 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?
== LICENSE
-This library is provided under the MIT License. See {the complete LICENSE}[link:files/LICENSE_rdoc.html] for details.
+This library is provided under the MIT License. See the complete LICENSE in LICENSE.rdoc for details.