GoogleReaderApi 0.3.5

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/GoogleReaderApi.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{GoogleReaderApi}
+  s.version = "0.3.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Toon Willems"]
+  s.date = %q{2010-06-22}
+  s.description = %q{a google reader api (unofficial) written in ruby}
+  s.email = %q{willemstoon@gmail.com}
+  s.extra_rdoc_files = [
+    "README.mdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "GoogleReaderApi.gemspec",
+     "License",
+     "README.mdown",
+     "Rakefile",
+     "VERSION",
+     "lib/google-reader-api/api.rb",
+     "lib/google-reader-api/cache.rb",
+     "lib/google-reader-api/entry.rb",
+     "lib/google-reader-api/feed.rb",
+     "lib/google-reader-api/rss_utils.rb",
+     "lib/google-reader-api/subscription_list.rb",
+     "lib/google-reader-api/user.rb",
+     "lib/google_reader_api.rb"
+  ]
+  s.homepage = %q{http://github.com/nudded/GoogleReaderAPI}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{a google reader api (unofficial) written in ruby}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/License

@@ -0,0 +1,21 @@
+the MIT License
+
+Copyright (c) 2010 Toon Willems
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.mdown

@@ -0,0 +1,62 @@
+GoogleReaderAPI
+===============
+
+A Google Reader api. Programmed in ruby. This is an unofficial api.
+Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
+
+Usage
+-----
+
+If you would like to implement your own methods, you can quite easily use
+the api class provided.
+    
+    api = GoogleReaderApi::Api.new email, pass
+
+and then you can perform requests using the `get_link` and `post_link` methods.
+
+    # this will give the user info.
+    api.get_link "api/0/user-info"
+    
+    # this will add a feed 
+    api.post_link 'api/0/subscription/edit', :s => "feed/#{url}" , :ac => :subscribe
+
+The following methods all use the `Api` class, so there is no magic 
+involved.
+
+    # password should be asked by the app using the api
+    # you probably don't want to type that in cleartext here
+    user = GoogleReaderApi::User.new 'willemstoon@gmail.com' , password
+
+you can access your feeds from there
+
+    user.feeds
+
+which will return an array of GoogleReader::Feed objects.
+then you can get the unread items, the read items, ...
+
+    hn = user.feeds.find {|feed| feed.title =~ /hacker news/i }
+    # return 3 unread items (ordered by date)
+    hn.unread_items(3)
+    # return all the read items
+    hn.read_items
+    # all the starred items
+    hn.starred_items
+    
+you get the idea.
+you can like items, star items, and mark them as read or unread.
+
+    hn.all_unread_items.each {|item| item.toggle_read}
+    
+subscribing to new feeds is also easy
+
+    user.subscriptions.add "any feed url here"
+
+unsubscribing is best done via `remove_if` method
+
+    user.subscriptions.remove_if {|feed| feed.title =~ /hacker news/i}
+    
+Todo
+----
+
+ * provide nicer convenience methods. (user.subscriptions.feeds is not a good way to access your feeds).
+ * labels should be part of the api.

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "GoogleReaderApi"
+    gemspec.summary = "a google reader api (unofficial) written in ruby"
+    gemspec.description = "a google reader api (unofficial) written in ruby"
+    gemspec.email = "willemstoon@gmail.com"
+    gemspec.homepage = "http://github.com/nudded/GoogleReaderAPI"
+    gemspec.authors = ["Toon Willems"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.5

data/lib/google-reader-api/api.rb

@@ -0,0 +1,107 @@
+module GoogleReaderApi
+  
+  class Api
+    
+    require "cgi"
+    require "net/https"
+    require "uri"
+    
+    BASE_URL = "http://www.google.com/reader/"
+    
+    def initialize(email,password)
+      request_sid(email,password)
+      @cache = GoogleReaderApi::Cache.new(2)
+    end
+    
+    # do a get request to the link
+    # args is a hash of values that should be used in the request
+    def get_link(link,args={})
+      link = BASE_URL + link
+      get_request(link,args)
+    end
+    
+    def post_link(link,args={})
+      link = BASE_URL + link
+      post_request(link,args)
+    end
+    
+    def cached_unread_count
+      @cache['unread-count'] ||= get_link 'api/0/unread-count', :output => :json
+    end
+    
+    private
+
+    # url as a string
+    # the post data as a hash
+    def post_request(url,args)
+      uri = URI.parse(url)
+      args[:T] = token
+      req = Net::HTTP::Post.new(uri.path)
+      req.set_form_data(args)
+      request(uri,req)
+    end
+
+    # the url as a string and the args as a hash
+    # e.g. :allcomments => true etc...
+    def get_request(url,args)
+      uri = URI.parse url
+      
+      # ck is the current unix timestamp
+      args[:ck] = Time.now.to_i unless args[:ck]
+      
+      req = Net::HTTP::Get.new("#{uri.path}?#{argument_string(args)}")
+      request(uri,req)
+    end
+
+    def request(uri,request)
+      # add the cookie to the http header
+      request.add_field('Cookie',user_cookie)
+      res = Net::HTTP.start(uri.host,uri.port) do |http|
+        http.request(request)
+      end
+      # TODO: use better exception
+      if res.code != '200'
+        p res.body
+        raise "something went wrong" 
+      end
+      res.body
+    end
+
+    # returns the argumentstring based on the hash it is given
+    def argument_string(args)
+      args.to_a.map { |v| v.join '=' }.join('&')
+    end
+   
+    def token
+      url = URI.parse "http://www.google.com/reader/api/0/token"
+      res = Net::HTTP.start(url.host,url.port) do |http|
+        http.get(url.path,"Cookie" => user_cookie)
+      end
+      res.body
+    end
+
+    def user_cookie
+      CGI::Cookie::new('name' => 'SID' , 'value' => sid , 
+                       'path' => '/' , 'domain'  => '.google.com').to_s
+    end
+
+    def sid
+      @sid 
+    end
+    
+    def request_sid(email,password)
+      password = CGI.escape(password)
+      email = CGI.escape(email)
+      url = URI.parse "https://www.google.com/accounts/ClientLogin?service=reader&Email=#{email}&Passwd=#{password}"
+      http = Net::HTTP.new(url.host,url.port)
+      http.use_ssl = true
+      res,data = http.get("#{url.path}?#{url.query}")
+
+      raise "could not authenticate" if res.code != "200"
+      
+      @sid = data.match(/SID=(.+?)\n/)[1]
+    end
+    
+  end
+  
+end

data/lib/google-reader-api/cache.rb

@@ -0,0 +1,30 @@
+module GoogleReaderApi
+  class Cache
+    
+    def initialize(time)
+      @time = time
+      @hash = {}
+    end
+    
+    def [](key)
+      if cached?(key)
+        @hash[key].first
+      else
+        @hash[key] = nil
+      end
+    end
+    
+    def []=(key,value)
+      @hash[key] = [value,Time.now.to_i]
+    end
+    
+    def cached?(key)
+      if @hash[key]
+        Time.now.to_i - @hash[key][1] < @time
+      else
+        false
+      end
+    end
+    
+  end
+end

data/lib/google-reader-api/entry.rb

@@ -0,0 +1,35 @@
+module GoogleReaderApi
+  class Entry
+  
+    attr_reader :entry
+  
+    def initialize(api,entry)
+      @api, @entry = api, entry
+    end
+  
+    def toggle_read
+      edit_tag 'user/-/state/com.google/read'
+    end
+  
+    def toggle_like
+      edit_tag 'user/-/state/com.google/like'
+    end
+  
+    def toggle_star
+      edit_tag 'user/-/state/com.google/starred'
+    end
+    
+    def to_s
+      "<<Entry: #{@entry.title.content} >>"
+    end
+    
+    private 
+  
+    def edit_tag(tag_identifier)
+      @api.post_link "api/0/edit-tag" , :a => tag_identifier ,
+                                        :s => entry.parent.id.content.to_s.scan(/feed\/.*/) ,
+                                        :i => entry.id.content.to_s
+    end
+  
+  end
+end

data/lib/google-reader-api/feed.rb

@@ -0,0 +1,76 @@
+module GoogleReaderApi
+  
+  class Feed
+  
+    include GoogleReaderApi::RssUtils
+    
+    attr_reader :url, :title
+    
+    def initialize(hash,api)
+      # strip the first 5 characters of the url (they are 'feed/')
+      @url = hash['id'][5..-1]
+      @title = hash['title']
+      # no idea what this is used for
+      @sortid = hash['sortid']
+      @categories = hash['categories']
+      @firstitemmsec = hash['firstitemmsec']
+      
+      @api = api
+    end
+    
+    def unsubscribe
+      @api.post_link 'api/0/subscription/edit' , :s => "feed/#{url}",
+                                                 :ac => :unsubscribe
+    end
+    
+    def unread_count
+      entry = JSON[@api.cached_unread_count]['unreadcounts'].find {|h| h['id'] == "feed/#{url}"}
+      entry ? entry['count'] : 0
+    end
+    
+    # return count read items
+    def read_items(count=20)
+      create_entries get_user_items('read',:n => count)
+    end
+    
+    def starred_items(count=20)
+      create_entries get_user_items('starred',:n => count)
+    end
+    
+    # return the number of specified items. (read or not)
+    def items(count = 20)
+      create_entries get_feed_items(:n => count)
+    end
+    
+    # return all the unread items in an array
+    def all_unread_items
+      unread_count > 0 ? unread_items(unread_count) : []
+    end
+    
+    # will return an array of GoogleReader::Feed::Entry objects.
+    # will try to return the amount of unread items you specify. unless there are no more.
+    # will return 20 unread items by default.
+    def unread_items(count = 20)
+      create_entries get_feed_items(:n => count,:xt => 'user/-/state/com.google/read')
+    end
+    
+    def inspect
+      to_s
+    end
+    
+    def to_s
+      "<<Feed: #{title} url:#{url}>>"
+    end
+    
+    private
+    
+    def get_user_items(state,args={})
+      @api.get_link "atom/user/-/state/com.google/#{state}" , args
+    end
+    
+    def get_feed_items(args={})
+      @api.get_link "atom/feed/#{url}" , args
+    end
+
+  end
+end

data/lib/google-reader-api/rss_utils.rb

@@ -0,0 +1,14 @@
+module GoogleReaderApi
+  module RssUtils
+    
+    require "rss/parser"
+    require "rss/atom"
+
+    private
+
+    def create_entries(atom_feed)
+      RSS::Parser.parse(atom_feed.force_encoding('utf-8')).entries.map {|e| GoogleReaderApi::Entry.new(@api,e) }
+    end
+    
+  end
+end

data/lib/google-reader-api/subscription_list.rb

@@ -0,0 +1,74 @@
+module GoogleReaderApi
+  
+  class SubscriptionList
+    
+    require "cgi"
+    
+    include GoogleReaderApi::RssUtils
+    include Enumerable
+    
+    def initialize(api)
+      @api = api
+      update
+    end
+    
+    # returns the total unread count
+    def total_unread
+      inject(0) {|i,j| i+j.unread_count}
+    end
+    
+    # returns a hash
+    # with following pattern:
+    # feed => unread_count
+    def unread_count
+      hash = {}
+      each { |feed| hash[feed] = feed.unread_count }
+      hash
+    end
+     
+    # yield each feed, if you return true
+    # the feed will be removed from your subscriptions
+    def remove_if
+      each { |feed| feed.unsubscribe if yield feed}
+      update
+    end
+    
+    # subscribe to the given url
+    # google will set the title for you
+    def add(url)
+      @api.post_link 'api/0/subscription/edit', :s => "feed/#{url}" , :ac => :subscribe 
+      update
+    end
+    
+    # return an array of unread items
+    def unread_items
+      feeds.map(&:all_unread_items)
+    end
+    
+    # will return an array of entries with label
+    def items_with_label(label)
+      create_entries(@api.get_link "atom/user/-/label/#{CGI::escape label}")
+    end
+
+    def feeds
+      @feeds
+    end
+
+    def each
+      @feeds.each {|feed| yield feed}
+    end
+    
+    def update
+      fetch_list
+    end
+
+    private
+    
+    def fetch_list
+      json = JSON[@api.get_link 'api/0/subscription/list', :output => :json]['subscriptions']
+      @feeds = json.map {|hash| GoogleReaderApi::Feed.new(hash,@api) }
+    end
+    
+  end
+  
+end

data/lib/google-reader-api/user.rb

@@ -0,0 +1,26 @@
+module GoogleReaderApi
+  
+  class User
+    
+    require "json"
+    # maybe someone would like to access the api for a user
+    attr_reader :api
+    
+    def initialize(email,password)
+      @api = GoogleReaderApi::Api::new email,password
+    end
+    
+    def info
+      JSON[api.get_link "api/0/user-info"]
+    end
+    
+    def subscriptions
+      @subscriptions ||= GoogleReaderApi::SubscriptionList.new @api
+    end
+    
+    def feeds
+      subscriptions.feeds
+    end
+    
+  end
+end

data/lib/google_reader_api.rb

@@ -0,0 +1,7 @@
+require "google-reader-api/rss_utils"
+require "google-reader-api/api"
+require "google-reader-api/cache"
+require "google-reader-api/entry"
+require "google-reader-api/feed"
+require "google-reader-api/subscription_list"
+require "google-reader-api/user"

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: GoogleReaderApi
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 5
+  version: 0.3.5
+platform: ruby
+authors: 
+- Toon Willems
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-22 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: a google reader api (unofficial) written in ruby
+email: willemstoon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.mdown
+files: 
+- .gitignore
+- GoogleReaderApi.gemspec
+- License
+- README.mdown
+- Rakefile
+- VERSION
+- lib/google-reader-api/api.rb
+- lib/google-reader-api/cache.rb
+- lib/google-reader-api/entry.rb
+- lib/google-reader-api/feed.rb
+- lib/google-reader-api/rss_utils.rb
+- lib/google-reader-api/subscription_list.rb
+- lib/google-reader-api/user.rb
+- lib/google_reader_api.rb
+has_rdoc: true
+homepage: http://github.com/nudded/GoogleReaderAPI
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: a google reader api (unofficial) written in ruby
+test_files: []
+