google_reader 1.1.0 → 1.1.1

data/README.textile

@@ -37,6 +37,12 @@ p item.author
 p item.source
 p item.liking_users
 p item.summary
+
+# You may also get feed objects back, which then allow you to query "since" a time
+feed = client.read_feed
+cutoff_at = feed.updated_at
+sleep 30
+client.read_feed(:since => cutoff_at) # Only new items since that cutoff time
 </code></pre>
 
 h2. Ruby Library

data/lib/google_reader/client.rb

@@ -54,11 +54,27 @@ module GoogleReader
       tracking-item-link-used
       tracking-body-link-used).each do |suffix|
 
+      method_name = suffix.gsub("-", "_") + "_feed"
+      define_method(method_name) do |*args|
+        options = args.first || Hash.new
+        params = Hash.new
+        params[:n] = options[:count] || 20
+        if options.has_key?(:since) then
+          params[:r]  = "o"
+          params[:ot] = options[:since].to_i
+        end
+
+        str_params = params.map do |k, v|
+          CGI.escape(k.to_s) << "=" << CGI.escape(v.to_s)
+        end.join("&")
+
+        content = RestClient.get(STATE_URL + suffix + "?#{str_params}", headers)
+        Feed.new( Nokogiri::XML(content) )
+      end
+
       method_name = suffix.gsub("-", "_") + "_items"
       define_method(method_name) do |*args|
-        count = args.first || 20
-        content = RestClient.get(STATE_URL + suffix + "?n=#{CGI.escape(count.to_s)}", headers)
-        parse_atom_feed(content)
+        __send__(method_name.sub("_items", "_feed"), *args).entries
       end
     end
 
@@ -66,10 +82,5 @@ module GoogleReader
       content = RestClient.get(STATE_URL + suffix + "?n=#{CGI.escape(count.to_s)}&xt=#{CGI.escape("state/com.google/read")}", headers)
       parse_atom_feed(content)
     end
-
-    def parse_atom_feed(feed)
-      doc = Nokogiri::XML(feed)
-      doc.search("entry").map {|entry| Entry.new(entry)}
-    end
   end
 end

data/lib/google_reader/entry.rb

@@ -103,7 +103,5 @@ module GoogleReader
     def unhtml(text)
       text.gsub("&lt;", "<").gsub("&gt;", ">").gsub("&amp;", "&").gsub("&quot;", '"')
     end
-
-    GOOGLE_ATOM_NAMESPACE = "http://www.google.com/schemas/reader/atom/".freeze
   end
 end

data/lib/google_reader/feed.rb

@@ -0,0 +1,39 @@
+require "time"
+
+module GoogleReader
+  class Feed
+    attr_reader :feed
+
+    def initialize(feed)
+      @feed = feed
+    end
+
+    def entries
+      @entries ||= @feed.search("entry").map {|entry| Entry.new(entry)}
+    end
+
+    def id
+      @feed.search("id").first.text
+    end
+
+    def updated_at
+      Time.parse( @feed.search("updated").first.text )
+    end
+
+    def continuation
+      @feed.search("gr:continuation", "gr" => GoogleReader::GOOGLE_ATOM_NAMESPACE).first.text
+    end
+
+    def title
+      @feed.search("title").first.text
+    end
+
+    def href
+      @feed.search("link[rel=self]").first["href"]
+    end
+
+    def author
+      @feed.search("author name").first.text
+    end
+  end
+end

data/lib/google_reader/version.rb

@@ -1,3 +1,3 @@
 module GoogleReader
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/lib/google_reader.rb

@@ -1,5 +1,8 @@
 module GoogleReader
   autoload :Client, "google_reader/client"
   autoload :Source, "google_reader/source"
+  autoload :Feed,   "google_reader/feed"
   autoload :Entry,  "google_reader/entry"
+
+  GOOGLE_ATOM_NAMESPACE = "http://www.google.com/schemas/reader/atom/".freeze
 end

data/spec/client_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe GoogleReader::Client, "#authenticate" do
   it "should immediately authenticate using Google's client login" do
-    RestClient.should_receive(:post).and_return("Auth=abc")
+    RestClient.should_receive(:post).and_return("a=b\nAuth=my-fancy-token\nb=c")
     GoogleReader::Client.authenticate("abc", "123")
   end
 
@@ -12,8 +12,8 @@ describe GoogleReader::Client, "#authenticate" do
   end
 
   it "should instantiate a new GoogleReader::Client instance with the correct authentication header" do
-    RestClient.stub(:post).and_return("Auth=my-fancy-token")
-    GoogleReader::Client.should_receive(:new).with(hash_including("Authorization" => "GoogleLogin auth=my-fancy-token"))
+    RestClient.stub(:post).and_return("a=b\nAuth=my-fancy-token\nb=c")
+    GoogleReader::Client.should_receive(:new).with("my-fancy-token")
     GoogleReader::Client.authenticate("a", "b")
   end
 end
@@ -34,7 +34,7 @@ describe GoogleReader::Client do
 
   it "should fetch the requested number of items from #read_items" do
     RestClient.should_receive(:get).with("http://www.google.com/reader/atom/user/-/state/com.google/read?n=59", anything).and_return(xml_content)
-    subject.read_items(59)
+    subject.read_items(:count => 59)
   end
 
   it "should fetch the default 20 items from #broadcast_items" do
@@ -44,7 +44,7 @@ describe GoogleReader::Client do
 
   it "should fetch the requested number of items from #broadcast_items" do
     RestClient.should_receive(:get).with("http://www.google.com/reader/atom/user/-/state/com.google/broadcast?n=59", anything).and_return(xml_content)
-    subject.broadcast_items(59)
+    subject.broadcast_items(:count => 59)
   end
 
   it "should fetch the default 20 items from #starred_items" do
@@ -54,7 +54,7 @@ describe GoogleReader::Client do
 
   it "should fetch the requested number of items from #starred_items" do
     RestClient.should_receive(:get).with("http://www.google.com/reader/atom/user/-/state/com.google/starred?n=31", anything).and_return(xml_content)
-    subject.starred_items(31)
+    subject.starred_items(:count => 31)
   end
 
   it "should fetch the default 20 items from #subscriptions_items" do
@@ -64,7 +64,7 @@ describe GoogleReader::Client do
 
   it "should fetch the requested number of items from #subscriptions_items" do
     RestClient.should_receive(:get).with("http://www.google.com/reader/atom/user/-/state/com.google/subscriptions?n=19", anything).and_return(xml_content)
-    subject.subscriptions_items(19)
+    subject.subscriptions_items(:count => 19)
   end
 
   it "should fetch the default 20 items from #tracking_emailed_items" do
@@ -74,7 +74,7 @@ describe GoogleReader::Client do
 
   it "should fetch the requested number of items from #tracking_emailed_items" do
     RestClient.should_receive(:get).with("http://www.google.com/reader/atom/user/-/state/com.google/tracking-emailed?n=43", anything).and_return(xml_content)
-    subject.tracking_emailed_items(43)
+    subject.tracking_emailed_items(:count => 43)
   end
 
   it "should fetch the default 20 items from #tracking_item_link_used_items" do
@@ -84,7 +84,7 @@ describe GoogleReader::Client do
 
   it "should fetch the requested number of items from #tracking_item_link_used_items" do
     RestClient.should_receive(:get).with("http://www.google.com/reader/atom/user/-/state/com.google/tracking-item-link-used?n=43", anything).and_return(xml_content)
-    subject.tracking_item_link_used_items(43)
+    subject.tracking_item_link_used_items(:count => 43)
   end
 
   it "should fetch the default 20 items from #tracking_body_link_used_items" do
@@ -94,6 +94,23 @@ describe GoogleReader::Client do
 
   it "should fetch the requested number of items from #tracking_body_link_used_items" do
     RestClient.should_receive(:get).with("http://www.google.com/reader/atom/user/-/state/com.google/tracking-body-link-used?n=43", anything).and_return(xml_content)
-    subject.tracking_body_link_used_items(43)
+    subject.tracking_body_link_used_items(:count => 43)
+  end
+
+  it "should return a Feed instance on-demand" do
+    RestClient.stub(:get).and_return(xml_content)
+    subject.read_feed.should be_kind_of(GoogleReader::Feed)
+  end
+
+  it "should fetch items since a specific timestamp" do
+    cutoff_at = Time.now
+    RestClient.should_receive(:get).with do |*args|
+      url = args.first
+      uri = URI.parse(url)
+      pairs = Hash[ *uri.query.split("&").map {|pair| pair.split("=").map {|val| CGI.unescape(val)}}.flatten ]
+      url.split("?", 2).first == "http://www.google.com/reader/atom/user/-/state/com.google/read" && pairs["n"] == "240" && pairs["r"] == "o" && pairs["ot"] == cutoff_at.to_i.to_s
+    end.and_return(xml_content)
+
+    subject.read_items(:since => cutoff_at, :count => 240)
   end
 end

data/spec/feed_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe GoogleReader::Feed do
+  let :entry_xml do
+    File.read(File.dirname(__FILE__) + "/fixtures/entry.xml")
+  end
+
+  let :doc do
+    Nokogiri::XML(entry_xml)
+  end
+
+  subject do
+    GoogleReader::Feed.new(doc)
+  end
+
+  it "should have a title" do
+    subject.title.should == %("tracking-item-link-used" via francois.beausoleil in Google Reader)
+  end
+
+  it "should have an #udpated_at" do
+    subject.updated_at.should == Time.utc(2011, 5, 2, 17, 53, 46)
+  end
+end

data/spec/fixtures/entry.xml

@@ -1,5 +1,14 @@
 <?xml version="1.0"?>
 <feed xmlns:idx="urn:atom-extension:indexing" xmlns:media="http://search.yahoo.com/mrss/" xmlns:gr="http://www.google.com/schemas/reader/atom/" xmlns="http://www.w3.org/2005/Atom" idx:index="no" gr:dir="ltr">
+  <generator uri="http://www.google.com/reader">Google Reader</generator>
+  <id>tag:google.com,2005:reader/user/10212770223479967035/state/com.google/tracking-item-link-used</id>
+  <title>"tracking-item-link-used" via francois.beausoleil in Google Reader</title>
+  <gr:continuation>CPX6rZKan6gC</gr:continuation>
+  <link rel="self" href="http://www.google.com/reader/atom/user/-/state/com.google/tracking-item-link-used"/>
+  <author>
+    <name>francois.beausoleil</name>
+  </author>
+  <updated>2011-05-02T17:53:46Z</updated>
   <entry gr:crawl-timestamp-msec="1303995951053">
     <id gr:original-id="http://www.depesz.com/?p=2149">tag:google.com,2005:reader/item/d5dee0c34e012ddb</id>
     <category term="user/10212770223479967035/state/com.google/read" scheme="http://www.google.com/reader/" label="read"/>

metadata

@@ -2,7 +2,7 @@
 name: google_reader
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - "Fran\xC3\xA7ois Beausoleil"
@@ -65,10 +65,12 @@ files:
 - lib/google_reader.rb
 - lib/google_reader/client.rb
 - lib/google_reader/entry.rb
+- lib/google_reader/feed.rb
 - lib/google_reader/source.rb
 - lib/google_reader/version.rb
 - spec/client_spec.rb
 - spec/entry_spec.rb
+- spec/feed_spec.rb
 - spec/fixtures/entry-with-no-likes.xml
 - spec/fixtures/entry-with-no-original-id.xml
 - spec/fixtures/entry-with-unknown-author.xml
@@ -105,6 +107,7 @@ summary: An unofficial Ruby client for Google Reader
 test_files: 
 - spec/client_spec.rb
 - spec/entry_spec.rb
+- spec/feed_spec.rb
 - spec/fixtures/entry-with-no-likes.xml
 - spec/fixtures/entry-with-no-original-id.xml
 - spec/fixtures/entry-with-unknown-author.xml