googlereader 0.0.1 → 0.0.3

data/History.txt

@@ -1,2 +1,8 @@
+* 0.0.3
+	- updated manifest to include all files, 0.0.2 release was not up to date
+* 0.0.2
+	- added wrapper for subscriptions
+	- added wrapper for preferences
+	- added Base#get_token for retrieving tokens from google
 * 0.0.1
 	- labels and counts are working

data/Manifest.txt

@@ -5,12 +5,19 @@ README.txt
 Rakefile
 config/hoe.rb
 config/requirements.rb
+examples/base.rb
 examples/counts.rb
 examples/labels.rb
+examples/preferences.rb
+examples/search.rb
+examples/subscriptions.rb
 lib/google/reader.rb
 lib/google/reader/base.rb
 lib/google/reader/count.rb
 lib/google/reader/label.rb
+lib/google/reader/preference.rb
+lib/google/reader/search.rb
+lib/google/reader/subscription.rb
 lib/google/reader/version.rb
 log/debug.log
 script/destroy

data/README.txt

@@ -1,12 +1,37 @@
-Do not use this yet unless you are dying to help out. 
-I'm going to gem this up and such when I finish the full api.
+= Installation
 
-Also, I'm going to separate Google::Connection into it's own 
-gem and add that as a dependency for the reader gem. This will 
-allow easy reuse of the google authentication.
+sudo gem install googlereader
 
-I'm using the following links below as documentation 
-(and also a bit of reverse engineering with Firebug):
+= Usage
+
+  require 'google/reader'
+  Google::Reader::Base.establish_connection('username', 'password')
+
+  # => all feeds and labels unread counts
+  pp Google::Reader::Count.all
+
+  # => all unread counts for labels
+  pp Google::Reader::Count.labels
+
+  # => all unread counts for feeds
+  pp Google::Reader::Count.feeds
+
+  # => all items for a label
+  pp Google::Reader::Label.all
+  
+  puts 'Links'
+  # 5 latest unread items
+  unread = Google::Reader::Label.new('links').entries(:unread, :n => 5) 
+  unread.each { |p| puts p.title }
+  
+  puts 'Using Continuation'
+  # next 5 latest items after the unread above
+  more_unread = Google::Reader::Label.new('links').entries(:unread, :n => 5, :c => unread.continuation) 
+  more_unread.each { |p| puts p.title }
+	
+= Notes
+
+I'm using the following links below as documentation (and also a bit of reverse engineering with Firebug) until google releases an official and documented api:
 
 * http://code.google.com/p/pyrfeed/wiki/GoogleReaderAPI
 * http://blog.gpowered.net/2007/08/google-reader-api-functions.html

data/config/hoe.rb

@@ -59,7 +59,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   
   # == Optional
   p.changes        = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  #p.extra_deps    = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.extra_deps    = [['googlebase', '>= 0.1.1'], ['atom', '>= 0.3'], ['json', '>= 1.1.1']]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
   
   #p.spec_extras   = {}    # A hash of extra values to set in the gemspec.
   

data/examples/base.rb

@@ -0,0 +1,10 @@
+$:.unshift File.join(File.dirname(__FILE__), '/../lib')
+require 'google/reader'
+require 'pp'
+require 'yaml'
+
+config = YAML::load(open("#{ENV['HOME']}/.google"))
+Google::Base.establish_connection(config[:email], config[:password])
+
+pp Google::Reader::Base.get_token
+pp Google::Reader::Base.user_info

data/examples/labels.rb

@@ -14,7 +14,7 @@ pp labels
 
 # puts '', '==Links=='
 # unread = Google::Reader::Label.new('links').entries(:unread, :n => 5)
-# unread.each { |p| puts p.title }
+# pp unread.first
 # 
 # puts '', '===Using Continuation==='
 # more_unread = Google::Reader::Label.new('links').entries(:unread, :n => 5, :c => unread.continuation)

data/examples/preferences.rb

@@ -0,0 +1,14 @@
+$:.unshift File.join(File.dirname(__FILE__), '/../lib')
+require 'google/reader'
+require 'pp'
+require 'yaml'
+
+config = YAML::load(open("#{ENV['HOME']}/.google"))
+Google::Base.establish_connection(config[:email], config[:password])
+
+pp Google::Reader::Preference.available
+pp Google::Reader::Preference[:design]
+pp Google::Reader::Preference[:mobile_use_transcoder]
+pp Google::Reader::Preference[:mobile_num_entries]
+
+pp Google::Reader::Preference.stream

data/examples/search.rb

@@ -0,0 +1,11 @@
+$:.unshift File.join(File.dirname(__FILE__), '/../lib')
+require 'google/reader'
+require 'pp'
+require 'yaml'
+
+config = YAML::load(open("#{ENV['HOME']}/.google"))
+Google::Base.establish_connection(config[:email], config[:password])
+
+search = Google::Reader::Search.new('test')
+search.execute
+pp search.results

data/examples/subscriptions.rb

@@ -0,0 +1,9 @@
+$:.unshift File.join(File.dirname(__FILE__), '/../lib')
+require 'google/reader'
+require 'pp'
+require 'yaml'
+
+config = YAML::load(open("#{ENV['HOME']}/.google"))
+Google::Base.establish_connection(config[:email], config[:password])
+
+pp Google::Reader::Subscription.all.detect { |s| s.categories.size > 1 }

data/lib/google/reader.rb

@@ -5,7 +5,7 @@ require 'rubygems'
 
 gem 'atom', '>= 0.3'
 gem 'json', '>= 1.1.1'
-gem 'googlebase', '>= 0.1.0'
+gem 'googlebase', '>= 0.1.1'
 
 require 'atom'
 require 'json'
@@ -13,17 +13,25 @@ require 'google/base'
 require 'google/reader/base'
 require 'google/reader/count'
 require 'google/reader/label'
+require 'google/reader/preference'
+require 'google/reader/search'
+require 'google/reader/subscription'
 
 module Google
   module Reader
-    READER_URL            = Google::URL + "/reader"
+    READER_URL            = Google::URL + '/reader'
     TOKEN_URL             = READER_URL + "/api/0/token"
-    SUBSCRIPTION_LIST_URL = READER_URL + '/api/0/subscription/list'
+    SEARCH_IDS_URL        = READER_URL + "/api/0/search/items/ids"
+    SEARCH_CONTENTS_URL   = READER_URL + "/api/0/stream/items/contents"
+    SUBSCRIPTION_LIST_URL = READER_URL + '/api/0/subscription/list?output=json'
     SUBSCRIPTION_EDIT_URL = READER_URL + '/api/0/subscription/edit'
     FEED_URL              = READER_URL + '/atom/feed/%s'
     LABELS_URL            = READER_URL + '/api/0/tag/list?output=json'
     LABEL_URL             = READER_URL + '/atom/user/-/label/%s'
+    PREFERENCE_URL        = READER_URL + '/api/0/preference/list?output=json'
+    PREFERENCE_STREAM_URL = READER_URL + '/api/0/preference/stream/list?output=json'
     UNREAD_COUNT_URL      = READER_URL + '/api/0/unread-count?all=true&output=json'
+    USER_INFO_URL         = READER_URL + '/user-info'
     PACKAGE               = "user/-/state/com.google"
     
     module State

data/lib/google/reader/base.rb

@@ -1,7 +1,7 @@
 module Google
   module Reader    
     class Base < Base
-      class << self
+      class << self        
         def parse(atom_feed)
           Atom::Feed.new(atom_feed)
         end
@@ -23,6 +23,17 @@ module Google
           end
         end
         
+        # Gets a new token which can be used with all non-get requests.
+        def get_token
+          get(TOKEN_URL)
+        end
+        
+        # Last time I checked this returns a hash like:
+        #   {"isBloggerUser": true, "userId": "<user id number>", "userEmail": "nunemaker@gmail.com"}
+        def user_info
+          parse_json(get(USER_INFO_URL))
+        end
+        
         private
           # atom parser doesn't bring in google's custom atom fields
           # this method grabs the continuation so that i can instantly

data/lib/google/reader/preference.rb

@@ -0,0 +1,50 @@
+module Google
+  module Reader
+    class Preference < Base
+      @@greader_preferences = {}
+      
+      class << self
+        # Returns a sorted list of all the available preference keys
+        #
+        # Usage:
+        #   Google::Reader::Preference.available
+        def available
+          ensure_preferences_loaded
+          @@greader_preferences.keys.sort
+        end
+        
+        # Gives access to an individual preference. Replace any dash
+        # in preference key with an underscore. (ie: mobile-num-entries 
+        # is accessed using mobile_num_entries)
+        #
+        # Usage:
+        #   Google::Reader::Preference[:design]
+        #   Google::Reader::Preference[:mobile_use_transcoder]
+        def [](pref)
+          ensure_preferences_loaded
+          @@greader_preferences[pref.to_s.gsub('_', '-')]
+        end
+        
+        # Returns any preferences set for each feed and label. Not sure
+        # what this could be helpful for so I'm not sure how to make things
+        # easily accessible. Right now just returns straight up hash, not
+        # very useful.
+        def stream #:nodoc:
+          parse_json(get(PREFERENCE_STREAM_URL))['streamprefs'].reject { |k,v| v == [] }
+        end
+        
+        private
+          # Gets all the preferences from google
+          def load_all
+            parse_json(get(PREFERENCE_URL))['prefs'].each do |p|
+              @@greader_preferences[p['id']] = p['value']
+            end
+          end
+          
+          def ensure_preferences_loaded
+            load_all if @@greader_preferences.keys.size == 0
+          end
+      end
+    end
+  end
+end

data/lib/google/reader/search.rb

@@ -0,0 +1,45 @@
+# This is getting the ids fine but I haven't figured out how 
+# to post multiple elements of the same name yet in ruby so 
+# don't use it unless you want to fix it.
+module Google #:nodoc:
+  module Reader #:nodoc:
+    class Search < Base #:nodoc:
+      attr_accessor :q, :ids
+      
+      def initialize(q)
+        self.q = q
+        @executed = false
+      end
+      
+      def execute
+        response = self.class.get(SEARCH_IDS_URL, :query_hash => {
+          :num => 1000, 
+          :output => 'json', 
+          :q => q
+        })
+        self.ids = self.class.parse_json(response)['results'].collect { |r| r['id'] }
+        @executed = true
+      end
+      
+      def results(o={})
+        options = {
+          :token => nil,
+          :start => 0,
+          :num   => 20,
+        }.merge(o)
+        
+        options[:token] ||= self.class.get_token
+        
+        if ids.size > 0
+          i_str = ids[options[:start]] + '&'
+          i_str += ids[(options[:start]+1)..options[:num]].collect { |id| ["i=#{id}&"] unless id.nil? }.join('')
+          
+          self.class.post(SEARCH_CONTENTS_URL, :form_data => {
+            :T => options[:token],
+            :i => i_str,
+          })
+        end
+      end
+    end
+  end
+end

data/lib/google/reader/subscription.rb

@@ -0,0 +1,17 @@
+require 'ostruct'
+module Google
+  module Reader
+    class Subscription < Base      
+      class << self
+        def all
+          parse_json(get(SUBSCRIPTION_LIST_URL))['subscriptions'].inject([]) do |subs, s|
+            subs << OpenStruct.new( :firstitemmsec => s['firstitemmsec'], 
+                                    :title         => s['title'], 
+                                    :google_id     => s['id'],
+                                    :categories    => s['categories'].inject([]) { |cats, c| cats << OpenStruct.new(:google_id => c['id'], :name => c['label']) })
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/reader/version.rb

@@ -3,7 +3,7 @@ module Google #:nodoc:
     module VERSION #:nodoc:
       MAJOR = 0
       MINOR = 0
-      TINY  = 1
+      TINY  = 3
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

metadata

@@ -1,33 +1,55 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: googlereader
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2007-11-19 00:00:00 -05:00
-summary: Wrapper for the undocumented and potentially unstable Google Reader API
-require_paths: 
-- lib
-email: nunemaker@gmail.com
-homepage: http://googlereader.rubyforge.org
-rubyforge_project: googlereader
-description: Wrapper for the undocumented and potentially unstable Google Reader API
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
-platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
+  version: 0.0.3
+platform: ""
 authors: 
 - John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2007-11-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: googlebase
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: atom
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.3"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+description: Wrapper for the undocumented and potentially unstable Google Reader API
+email: nunemaker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
 files: 
 - History.txt
 - License.txt
@@ -36,12 +58,19 @@ files:
 - Rakefile
 - config/hoe.rb
 - config/requirements.rb
+- examples/base.rb
 - examples/counts.rb
 - examples/labels.rb
+- examples/preferences.rb
+- examples/search.rb
+- examples/subscriptions.rb
 - lib/google/reader.rb
 - lib/google/reader/base.rb
 - lib/google/reader/count.rb
 - lib/google/reader/label.rb
+- lib/google/reader/preference.rb
+- lib/google/reader/search.rb
+- lib/google/reader/subscription.rb
 - lib/google/reader/version.rb
 - log/debug.log
 - script/destroy
@@ -54,22 +83,33 @@ files:
 - test/test_helper.rb
 - website/css/common.css
 - website/index.html
-test_files: 
-- test/test_googlereader.rb
-- test/test_helper.rb
+has_rdoc: true
+homepage: http://googlereader.rubyforge.org
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- History.txt
-- License.txt
-- Manifest.txt
-- README.txt
-executables: []
-
-extensions: []
-
+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: []
 
-dependencies: []
-
+rubyforge_project: googlereader
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: Wrapper for the undocumented and potentially unstable Google Reader API
+test_files: 
+- test/test_googlereader.rb
+- test/test_helper.rb