GoogleReaderApi 0.3.5 → 0.3.6

data/GoogleReaderApi.gemspec

@@ -1,44 +1,42 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{GoogleReaderApi}
-  s.version = "0.3.5"
+  s.version = "0.3.6"
 
   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.authors = [%q{Toon Willems}]
+  s.date = %q{2011-08-21}
   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"
+    "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/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 = %q{http://github.com/nudded/GoogleReaderAPI}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.8}
   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

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.3.6

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

@@ -1,41 +1,52 @@
 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)
+
+    # 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)
-      args[:T] = token
       req = Net::HTTP::Post.new(uri.path)
       req.set_form_data(args)
       request(uri,req)
@@ -45,24 +56,24 @@ module GoogleReaderApi
     # 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)
+      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" 
+        raise "something went wrong"
       end
       res.body
     end
@@ -71,37 +82,17 @@ module GoogleReaderApi
     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
+    def auth
+      @auth
     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]
+    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
+
+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/user.rb

@@ -5,9 +5,17 @@ module GoogleReaderApi
     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
+
+    # 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

data/lib/google_reader_api.rb

@@ -4,4 +4,5 @@ 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/user"
+require "google-reader-api/google_login"

metadata

@@ -1,34 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: GoogleReaderApi
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 5
-  version: 0.3.5
+version: !ruby/object:Gem::Version
+  version: 0.3.6
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Toon Willems
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-06-22 00:00:00 +02:00
-default_executable: 
+date: 2011-08-21 00:00:00.000000000Z
 dependencies: []
-
 description: a google reader api (unofficial) written in ruby
 email: willemstoon@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.mdown
-files: 
-- .gitignore
+files:
 - GoogleReaderApi.gemspec
 - License
 - README.mdown
@@ -38,43 +27,33 @@ files:
 - 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
-has_rdoc: true
 homepage: http://github.com/nudded/GoogleReaderAPI
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: a google reader api (unofficial) written in ruby
 test_files: []
-

data/.gitignore

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