jsl-osprey 0.0.6 → 0.0.8

data/README.rdoc

@@ -27,7 +27,13 @@ In more basic cases, you can use Osprey as follows:
 
 Osprey starts to work its magic when you call fetch more than once, either in the current session or after re-
 instantiating the program.  Osprey will remember the tweets that it last retrieved and show you a list of new_feeds
-in the response object.
+in the response object.  In order to be efficient with network traffic and to reduce client logic, it automatically 
+populates the last seen tweet id in the query string to the API, resulting in fewer records needing to be transeferred
+between client and server.
+
+Note that because this is done, in most cases "results" will be the same as "new_results".  Since Twitter doesn't 
+guarantee that results arrive in order, however, Osprey does checking to make sure that new_results really aren't 
+ones that we've seen before.
 
 = Processing Details
 
@@ -54,12 +60,16 @@ of previous tweet ids to store so that we can discern new tweets from ones that
 
 == Backend module configuration
 
-Osprey stores information about previously fetched terms in the backends.  You can choose which backend to use through an optional
-options hash after the search term given to the Osprey::Search initializer.  By passing options[:backend][:klass], you can specify
-which backend to choose.  Currently supported options are Osprey::Backend::Filesystem, Osprey::Backend::Memcache (also works with Tokyo Tyrant)
-Osprey::Backend::Memory (uses a no-configuration Ruby Hash) and Osprey::Backend::DevNull, which doesn't save any information about previously
-fetched tweets.
+Osprey stores information about previously fetched terms in the backends.  Since the backends are implemented by Moneta, which is a unified 
+to key-value storage systems, you can store data about feeds in any of the backends supported by Moneta.  Just initialize the Search object
+with options pointing to the backend:
+
+  require 'osprey'
+  o = Osprey::Search.new('Swine Flu', { :backend => { :moneta_klass => 'Moneta::Memcache', :server => 'localhost:1978' } })
 
+When you fetch the results, important information about the last tweets received are stored in an efficient structure using the
+backend.  In the case above, storage will be in Tokyo Tyrant running on the local machine.
+  
 == Tweet id pool configuration
 
 Osprey saves ids of previously fetched tweets in the pool so that it can differentiate between new tweets and previously seen tweets, even

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsl-osprey
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors: 
 - Justin Leitgeb
@@ -53,7 +53,7 @@ dependencies:
         version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: memcache
+  name: memcache-client
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -77,6 +77,12 @@ homepage: http://github.com/jsl/osprey
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
+- --title
+- Osprey
+- --main
+- README.rdoc
+- --line-numbers
+- --inline-source
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement