GoogleReaderApiUniq 0.3.7

data/GoogleReaderApiUniq.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "GoogleReaderApiUniq"
+  s.version = "0.3.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Toon Willems", "Ivan Kasatenko"]
+  s.date = "2012-06-05"
+  s.description = "a google reader api (unofficial) written in ruby"
+  s.email = "sky.31338@gmail.com"
+  s.extra_rdoc_files = [
+    "README.mdown"
+  ]
+  s.files = [
+    "GoogleReaderApiUniq.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/google_login.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 = "http://github.com/SkyWriter/GoogleReaderAPI"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "a google reader api (unofficial) written in ruby"
+
+  if s.respond_to? :specification_version then
+    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 = "GoogleReaderApiUniq"
+    gemspec.summary = "a google reader api (unofficial) written in ruby"
+    gemspec.description = "a google reader api (unofficial) written in ruby"
+    gemspec.email = "sky.31338@gmail.com"
+    gemspec.homepage = "http://github.com/SkyWriter/GoogleReaderAPI"
+    gemspec.authors = ["Toon Willems", "Ivan Kasatenko"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.7

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

@@ -0,0 +1,98 @@
+module GoogleReaderApi
+
+  class Api
+
+    require "cgi"
+    require "net/https"
+    require "uri"
+
+    BASE_URL = "http://www.google.com/reader/"
+
+    # specify either the :email and :password or the :auth token you got in the past
+    #
+    # [:email] the user's email address for login purposes
+    #
+    # [:password] the user's password for login purposes
+    #
+    # [:auth]  the auth token you got from a previous authentication request
+    #          if you provide this you do not need to provide the email and password
+    def initialize(options)
+      if options[:auth]
+        @auth = options[:auth]
+      else
+        request_auth(options[:email],options[:password])
+      end
+      @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)
+      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('Authorization',"GoogleLogin auth=#{auth}")
+      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 auth
+      @auth
+    end
+
+    def request_auth(email,password)
+      login = GoogleLogin::ClientLogin.new :service => 'reader', :source => 'nudded-greader-0.1'
+      login.authenticate email, password
+      @auth = login.auth
+    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,37 @@
+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)
+      token = @api.get_link("api/0/token")
+      @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,
+                                        :T => token
+    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/#{CGI.escape(url)}" , args
+    end
+
+  end
+end

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

@@ -0,0 +1,139 @@
+require "net/https"
+require "uri"
+
+module GoogleLogin  
+
+  # == ClientLogin
+  # 
+  # Use this Class to get an auth-token
+  class ClientLogin
+    
+    # Base Exception class 
+    LoginError = Class.new Exception    
+
+    # All the possible exceptions
+    [
+      "BadAuthentication", 
+      "NotVerified", 
+      "TermsNotAgreed", 
+      "CaptchaRequired", 
+      "Unknown", 
+      "AccountDeleted",
+      "AccountDisabled",   
+      "ServiceDisabled",
+      "ServiceUnavailable",
+    ].each do |const|
+      const_set const, Class.new(LoginError)
+    end
+   
+    DEFAULTS = { 
+      :accountType => 'HOSTED_OR_GOOGLE' ,
+      :source => 'companyName-applicationName-versionID',
+      :service => 'service-identifier'
+    }  
+    
+    attr_reader :auth, :sid, :lsid, :captcha_url
+    
+    # specify the :service, :source and optionally :accountType
+    # 
+    # [:service] the service identifier, check the google api documentation.
+    #
+    # [:source] the name of your application. String should be in the form
+    #           "companyName-applicationName-versionID".
+    #
+    # [:accountType]  one of the following values: 
+    #                 "GOOGLE", "HOSTED", "HOSTED_OR_GOOGLE" (default if none 
+    #                 given)
+    def initialize(arghash = {})
+      @options = DEFAULTS.merge arghash
+    end
+    
+    # authenticate a user, which sets the auth, sid and lsid instance_variables
+    # if you provide a block, it will be called with a captcha url if google 
+    # forces you to answer the captcha. Make sure you return the anwer in the block.
+    # 
+    # if no block is given, this will raise a CaptchaRequired error.
+    # you can rescue them and show the url via the captcha_url method.
+    # 
+    # you can then call authenticate and as 3rd parameter you provide the
+    # captcha answer.
+    # 
+    # all Exceptions this raises are subclasses of ClientLogin::LoginError.
+    # so make sure you handle them.
+    # 
+    # This is a list of all the possible errors and their meaning
+    # Error code::	Description
+    # BadAuthentication::   The login request used a username or password that is not recognized.
+    # NotVerified::         The account email address has not been verified. The user will need to access their Google account directly to resolve the issue before logging in using a non-Google application.
+    # TermsNotAgreed::      The user has not agreed to terms. The user will need to access their Google account directly to resolve the issue before logging in using a non-Google application.
+    # CaptchaRequired::     A CAPTCHA is required. (A response with this error code will also contain an image URL and a CAPTCHA token.)
+    # Unknown::             The error is unknown or unspecified; the request contained invalid input or was malformed.
+    # AccountDeleted::      The user account has been deleted.
+    # AccountDisabled::     The user account has been disabled.
+    # ServiceDisabled::     The user's access to the specified service has been disabled. (The user account may still be valid.)
+    # ServiceUnavailable::  The service is not available; try again later.
+    def authenticate(username, password, captcha_response = nil)
+      @options[:Email], @options[:Passwd] = username, password
+      # set logincaptcha, captchatoken will already be set
+      @options[:logincaptcha] = captcha_response if captcha_response
+
+      parse_response perform_request
+      
+    rescue CaptchaRequired
+      if block_given?
+        @options[:logincaptcha] = yield captcha_url
+        retry
+      else
+        raise CaptchaRequired
+      end
+    end
+    
+    private
+    
+    def perform_request
+      request = Net::HTTP::Post.new '/accounts/ClientLogin'
+      request.form_data = @options
+      
+      https = Net::HTTP.new 'www.google.com', 443 
+      https.use_ssl = true
+      
+      https.request request
+    end
+    
+    def parse_body(response_body)
+      response_body.scan(/(\w+)=(.+)\n/).each do |key, value|
+        instance_variable_set "@#{key.downcase}" , value
+      end
+    end
+    
+    def parse_response(response)
+      if response.code_type == Net::HTTPOK
+        parse_body response.body
+      else
+        handle_error response.body
+      end
+    end
+    
+    
+    def handle_error(response_body)
+      error_message = response_body.match(/Error=(\w+)\n/)[1].strip
+      
+      if error_message == "CaptchaRequired"
+        @options[:logintoken] = response_body.match(/CaptchaToken=(.+)\n/)[1]
+        self.captcha_url = response_body.match(/CaptchaUrl=(.+)\n/)[1]
+      end
+      
+      raise_error_class error_message
+    end
+    
+    def raise_error_class(error_message)
+      raise self.class.const_get error_message
+    end
+    
+    def captcha_url=(url)
+      @captcha_url = "http://www.google.com/accounts/" << url
+    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,34 @@
+module GoogleReaderApi
+  
+  class User
+    
+    require "json"
+    # maybe someone would like to access the api for a user
+    attr_reader :api
+
+    # specify either the :email and :password or the :auth token you got in the past
+    #
+    # [:email] the user's email address for login purposes
+    #
+    # [:password] the user's password for login purposes
+    #
+    # [:auth]  the auth token you got from a previous authentication request
+    #          if you provide this you do not need to provide the email and password
+    def initialize(options)
+      @api = GoogleReaderApi::Api::new options
+    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,8 @@
+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"
+require "google-reader-api/google_login"

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: GoogleReaderApiUniq
+version: !ruby/object:Gem::Version
+  version: 0.3.7
+  prerelease: 
+platform: ruby
+authors:
+- Toon Willems
+- Ivan Kasatenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-05 00:00:00.000000000 Z
+dependencies: []
+description: a google reader api (unofficial) written in ruby
+email: sky.31338@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.mdown
+files:
+- GoogleReaderApiUniq.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/google_login.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
+homepage: http://github.com/SkyWriter/GoogleReaderAPI
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: a google reader api (unofficial) written in ruby
+test_files: []