google-spreadsheet-ruby 0.1.5 → 0.1.6

data/README.rdoc

@@ -3,7 +3,6 @@ This is a Ruby 1.8/1.9 library to read/write Google Spreadsheet.
 
 = How to install
 
-  $ gem sources -a http://gemcutter.org
   $ sudo gem install google-spreadsheet-ruby
 
 Note that gimite-google-spreadsheet-ruby at gems.github.com is no longer updated, because github stopped hosting it.
@@ -49,14 +48,14 @@ API document: http://gimite.net/gimite/rubymess/google-spreadsheet-ruby/
 
 = Source code
 
-http://github.com/gimite/google-spreadsheet-ruby/tree/master
+http://github.com/gimite/google-spreadsheet-ruby
 
 The license of this source is "New BSD Licence"
 
 
 = Supported environments
 
-Ruby 1.8.x and Ruby 1.9.x. Checked with Ruby 1.8.7 and Ruby 1.9.1.
+Ruby 1.8.x and Ruby 1.9.x. Checked with Ruby 1.8.7 and Ruby 1.9.3.
 
 
 = Author

data/lib/google_spreadsheet.rb

@@ -10,6 +10,7 @@ require "uri"
 require "rubygems"
 require "nokogiri"
 require "oauth"
+require "oauth2"
 Net::HTTP.version_1_2
 
 module GoogleSpreadsheet
@@ -26,9 +27,31 @@ module GoogleSpreadsheet
       return Session.login(mail, password, proxy)
     end
 
-    # Authenticates with given OAuth token.
+    # Authenticates with given OAuth1 or OAuth2 token.
     #
-    # For generating oauth_token, you can proceed as follow:
+    # OAuth2 code example:
+    #
+    #   client = OAuth2::Client.new(
+    #       your_client_id, your_client_secret,
+    #       :site => "https://accounts.google.com",
+    #       :token_url => "/o/oauth2/token",
+    #       :authorize_url => "/o/oauth2/auth")
+    #   auth_url = client.auth_code.authorize_url(
+    #       :redirect_uri => "http://example.com/",
+    #       "scope" => "https://spreadsheets.google.com/feeds https://docs.google.com/feeds/")
+    #   # Redirect the user to auth_url and get authorization code from redirect URL.
+    #   auth_token = client.auth_code.get_token(
+    #       authorization_code, :redirect_uri => "http://example.com/")
+    #   session = GoogleSpreadsheet.login_with_oauth(auth_token)
+    #
+    # Or, from existing refresh token:
+    #
+    #   access_token = OAuth2::AccessToken.from_hash(client,
+    #       {:refresh_token => refresh_token, :expires_at => expires_at})
+    #   access_token = access_token.refresh!
+    #   session = GoogleSpreadsheet.login_with_oauth(access_token)
+    #
+    # OAuth1 code example:
     #
     # 1) First generate OAuth consumer object with key and secret for your site by registering site with google
     #   @consumer = OAuth::Consumer.new( "key","secret", {:site=>"https://agree2"})
@@ -42,12 +65,21 @@ module GoogleSpreadsheet
     #
     # See these documents for details:
     #
+    # - https://github.com/intridea/oauth2
+    # - http://code.google.com/apis/accounts/docs/OAuth2.html
     # - http://oauth.rubyforge.org/
     # - http://code.google.com/apis/accounts/docs/OAuth.html
     def self.login_with_oauth(oauth_token)
       return Session.login_with_oauth(oauth_token)
     end
 
+    # Restores session using return value of auth_tokens method of previous session.
+    #
+    # See GoogleSpreadsheet.login for description of parameter +proxy+.
+    def self.restore_session(auth_tokens, proxy = nil)
+      return Session.restore_session(auth_tokens, proxy)
+    end
+    
     # Restores GoogleSpreadsheet::Session from +path+ and returns it.
     # If +path+ doesn't exist or authentication has failed, prompts mail and password on console,
     # authenticates with them, stores the session to +path+ and returns it.
@@ -100,6 +132,13 @@ module GoogleSpreadsheet
         def encode_query(params)
           return params.map(){ |k, v| CGI.escape(k) + "=" + CGI.escape(v) }.join("&")
         end
+        
+        def concat_url(url, piece)
+          (url_base, url_query) = url.split(/\?/, 2)
+          (piece_base, piece_query) = piece.split(/\?/, 2)
+          result_query = [url_query, piece_query].select(){ |s| s && !s.empty? }.join("&")
+          return url_base + piece_base + (result_query.empty? ? "" : "?#{result_query}")
+        end
 
         def h(str)
           return CGI.escapeHTML(str.to_s())
@@ -118,6 +157,89 @@ module GoogleSpreadsheet
     class AuthenticationError < GoogleSpreadsheet::Error
 
     end
+    
+    
+    class ClientLoginFetcher #:nodoc:
+        
+        def initialize(auth_tokens, proxy)
+          @auth_tokens = auth_tokens
+          if proxy
+            @proxy = proxy
+          elsif ENV["http_proxy"] && !ENV["http_proxy"].empty?
+            proxy_url = URI.parse(ENV["http_proxy"])
+            @proxy = Net::HTTP.Proxy(proxy_url.host, proxy_url.port)
+          else
+            @proxy = Net::HTTP
+          end
+        end
+        
+        attr_accessor(:auth_tokens)
+        
+        def request_raw(method, url, data, extra_header, auth)
+          uri = URI.parse(url)
+          http = @proxy.new(uri.host, uri.port)
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          http.start() do
+            path = uri.path + (uri.query ? "?#{uri.query}" : "")
+            header = auth_header(auth).merge(extra_header)
+            if method == :delete || method == :get
+              return http.__send__(method, path, header)
+            else
+              return http.__send__(method, path, data, header)
+            end
+          end
+        end
+        
+      private
+        
+        def auth_header(auth)
+          token = auth == :none ? nil : @auth_tokens[auth]
+          if token
+            return {"Authorization" => "GoogleLogin auth=#{token}"}
+          else
+            return {}
+          end
+        end
+
+    end
+    
+    
+    class OAuth1Fetcher #:nodoc:
+        
+        def initialize(oauth1_token)
+          @oauth1_token = oauth1_token
+        end
+        
+        def request_raw(method, url, data, extra_header, auth)
+          if method == :delete || method == :get
+            return @oauth1_token.__send__(method, url, extra_header)
+          else
+            return @oauth1_token.__send__(method, url, data, extra_header)
+          end
+        end
+        
+    end
+
+
+    class OAuth2Fetcher #:nodoc:
+        
+        Response = Struct.new(:code, :body)
+        
+        def initialize(oauth2_token)
+          @oauth2_token = oauth2_token
+        end
+        
+        def request_raw(method, url, data, extra_header, auth)
+          if method == :delete || method == :get
+            raw_res = @oauth2_token.request(method, url, {:header => extra_header})
+          else
+            raw_res = @oauth2_token.request(method, url, {:header => extra_header, :body => data})
+          end
+          return Response.new(raw_res.status.to_s(), raw_res.body)
+        end
+        
+    end
 
 
     # Use GoogleSpreadsheet.login or GoogleSpreadsheet.saved_session to get
@@ -129,29 +251,36 @@ module GoogleSpreadsheet
 
         # The same as GoogleSpreadsheet.login.
         def self.login(mail, password, proxy = nil)
-          session = Session.new(nil, nil, proxy)
+          session = Session.new(nil, ClientLoginFetcher.new({}, proxy))
           session.login(mail, password)
           return session
         end
 
         # The same as GoogleSpreadsheet.login_with_oauth.
         def self.login_with_oauth(oauth_token)
-          session = Session.new(nil, oauth_token)
+          case oauth_token
+            when OAuth::AccessToken
+              fetcher = OAuth1Fetcher.new(oauth_token)
+            when OAuth2::AccessToken
+              fetcher = OAuth2Fetcher.new(oauth_token)
+            else
+              raise(GoogleSpreadsheet::Error,
+                  "oauth_token is neither OAuth::Token nor OAuth2::Token: %p" % oauth_token)
+          end
+          return Session.new(nil, fetcher)
         end
 
-        # Restores session using return value of auth_tokens method of previous session.
-        #
-        # See GoogleSpreadsheet.login for description of parameter +proxy+.
-        def initialize(auth_tokens = nil, oauth_token = nil, proxy = nil)
-          @oauth_token = oauth_token
-          @auth_tokens = auth_tokens || {}
-          if proxy
-            @proxy = proxy
-          elsif ENV["http_proxy"] && !ENV["http_proxy"].empty?
-            proxy_url = URI.parse(ENV["http_proxy"])
-            @proxy = Net::HTTP.Proxy(proxy_url.host, proxy_url.port)
+        # The same as GoogleSpreadsheet.restore_session.
+        def self.restore_session(auth_tokens, proxy = nil)
+          return Session.new(auth_tokens, nil, proxy)
+        end
+
+        # DEPRECATED: Use GoogleSpreadsheet.restore_session instead.
+        def initialize(auth_tokens = nil, fetcher = nil, proxy = nil)
+          if fetcher
+            @fetcher = fetcher
           else
-            @proxy = Net::HTTP
+            @fetcher = ClientLoginFetcher.new(auth_tokens || {}, proxy)
           end
         end
 
@@ -159,10 +288,15 @@ module GoogleSpreadsheet
         # if succeeds. Raises GoogleSpreadsheet::AuthenticationError if fails.
         # Google Apps account is supported.
         def login(mail, password)
+          if !@fetcher.is_a?(ClientLoginFetcher)
+            raise(GoogleSpreadsheet::Error,
+                "Cannot call login for session created by login_with_oauth or login_with_oauth2.")
+          end
           begin
-            @auth_tokens = {}
-            authenticate(mail, password, :wise)
-            authenticate(mail, password, :writely)
+            @fetcher.auth_tokens = {
+              :wise => authenticate(mail, password, :wise),
+              :writely => authenticate(mail, password, :writely),
+            }
           rescue GoogleSpreadsheet::Error => ex
             return true if @on_auth_fail && @on_auth_fail.call()
             raise(AuthenticationError, "authentication failed for #{mail}: #{ex.message}")
@@ -170,26 +304,24 @@ module GoogleSpreadsheet
         end
 
         # Authentication tokens.
-        attr_reader(:auth_tokens)
+        def auth_tokens
+          if !@fetcher.is_a?(ClientLoginFetcher)
+            raise(GoogleSpreadsheet::Error,
+                "Cannot call auth_tokens for session created by " +
+                "login_with_oauth or login_with_oauth2.")
+          end
+          return @fetcher.auth_tokens
+        end
 
         # Authentication token.
         def auth_token(auth = :wise)
-          return @auth_tokens[auth]
+          return self.auth_tokens[auth]
         end
 
         # Proc or Method called when authentication has failed.
         # When this function returns +true+, it tries again.
         attr_accessor :on_auth_fail
 
-        def auth_header(auth) #:nodoc:
-          token = auth == :none ? nil : @auth_tokens[auth]
-          if token
-            return {"Authorization" => "GoogleLogin auth=#{token}"}
-          else
-            return {}
-          end
-        end
-
         # Returns list of spreadsheets for the user as array of GoogleSpreadsheet::Spreadsheet.
         # You can specify query parameters described at
         # http://code.google.com/apis/spreadsheets/docs/2.0/reference.html#Parameters
@@ -251,6 +383,17 @@ module GoogleSpreadsheet
           return Worksheet.new(self, nil, url)
         end
 
+        # Returns GoogleSpreadsheet::Collection with given +url+.
+        # You must specify URL of collection (folder) feed.
+        #
+        # e.g.
+        #   session.collection_by_url(
+        #     "http://docs.google.com/feeds/default/private/full/folder%3A" +
+        #     "0B9GfDpQ2pBVUODNmOGE0NjIzMWU3ZC00NmUyLTk5NzEtYaFkZjY1MjAyxjMc")
+        def collection_by_url(url)
+          return Collection.new(self, url)
+        end
+
         # Creates new spreadsheet and returns the new GoogleSpreadsheet::Spreadsheet.
         #
         # e.g.
@@ -287,7 +430,7 @@ module GoogleSpreadsheet
           response_type = params[:response_type] || :xml
 
           while true
-            response = request_raw(method, url, data, extra_header, auth)
+            response = @fetcher.request_raw(method, url, data, extra_header, auth)
             if response.code == "401" && @on_auth_fail && @on_auth_fail.call()
               next
             end
@@ -303,30 +446,6 @@ module GoogleSpreadsheet
 
       private
 
-        def request_raw(method, url, data, extra_header, auth)
-          if @oauth_token
-            if method == :delete || method == :get
-              return @oauth_token.__send__(method, url, extra_header)
-            else
-              return @oauth_token.__send__(method, url, data, extra_header)
-            end
-          else
-            uri = URI.parse(url)
-            http = @proxy.new(uri.host, uri.port)
-            http.use_ssl = true
-            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-            http.start() do
-              path = uri.path + (uri.query ? "?#{uri.query}" : "")
-              header = auth_header(auth).merge(extra_header)
-              if method == :delete || method == :get
-                return http.__send__(method, path, header)
-              else
-                return http.__send__(method, path, data, header)
-              end
-            end
-          end
-        end
-
         def convert_response(response, response_type)
           case response_type
             when :xml
@@ -350,7 +469,7 @@ module GoogleSpreadsheet
           response = request(:post,
             "https://www.google.com/accounts/ClientLogin",
             :data => encode_query(params), :auth => :none, :header => header, :response_type => :raw)
-          @auth_tokens[auth] = response.slice(/^Auth=(.*)$/, 1)
+          return response.slice(/^Auth=(.*)$/, 1)
         end
 
     end
@@ -459,7 +578,7 @@ module GoogleSpreadsheet
               "link[@rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed']").first["href"]
           return Spreadsheet.new(@session, ss_url, new_title)
         end
-        
+
         # If +permanent+ is +false+, moves the spreadsheet to the trash.
         # If +permanent+ is +true+, deletes the spreadsheet permanently.
         def delete(permanent = false)
@@ -562,7 +681,35 @@ module GoogleSpreadsheet
         end
 
     end
+    
+    # Use GoogleSpreadsheet::Session#collection_by_url to get GoogleSpreadsheet::Collection object.
+    class Collection
+
+        include(Util)
+        
+        def initialize(session, collection_feed_url) #:nodoc:
+          @session = session
+          @collection_feed_url = collection_feed_url
+        end
+        
+        # Adds the given GoogleSpreadsheet::Spreadsheet to the collection.
+        def add(spreadsheet)
+          contents_url = concat_url(@collection_feed_url, "/contents")
+          header = {"GData-Version" => "3.0", "Content-Type" => "application/atom+xml"}
+          xml = <<-"EOS"
+            <entry xmlns="http://www.w3.org/2005/Atom">
+              <id>#{h(spreadsheet.document_feed_url)}</id>
+            </entry>
+          EOS
+          @session.request(
+              :post, contents_url, :data => xml, :header => header, :auth => :writely)
+          return nil
+        end
+        
+        # TODO Add other operations.
 
+    end
+    
     # DEPRECATED: Table and Record feeds are deprecated and they will not be available after
     # March 2012.
     #
@@ -658,18 +805,18 @@ module GoogleSpreadsheet
           # Probably it would be cleaner to keep worksheet feed URL and get cells feed URL
           # from it.
           if !(@cells_feed_url =~
-              %r{^https?://spreadsheets.google.com/feeds/cells/(.*)/(.*)/private/full$})
+              %r{^https?://spreadsheets.google.com/feeds/cells/(.*)/(.*)/private/full((\?.*)?)$})
             raise(GoogleSpreadsheet::Error,
               "cells feed URL is in unknown format: #{@cells_feed_url}")
           end
-          return "https://spreadsheets.google.com/feeds/worksheets/#{$1}/private/full/#{$2}"
+          return "https://spreadsheets.google.com/feeds/worksheets/#{$1}/private/full/#{$2}#{$3}"
         end
 
         # GoogleSpreadsheet::Spreadsheet which this worksheet belongs to.
         def spreadsheet
           if !@spreadsheet
             if !(@cells_feed_url =~
-                %r{^https?://spreadsheets.google.com/feeds/cells/(.*)/(.*)/private/full$})
+                %r{^https?://spreadsheets.google.com/feeds/cells/(.*)/(.*)/private/full(\?.*)?$})
               raise(GoogleSpreadsheet::Error,
                 "cells feed URL is in unknown format: #{@cells_feed_url}")
             end
@@ -832,8 +979,9 @@ module GoogleSpreadsheet
             cell_entries = {}
             rows = @modified.map(){ |r, c| r }
             cols = @modified.map(){ |r, c| c }
-            url = "#{@cells_feed_url}?return-empty=true&min-row=#{rows.min}&max-row=#{rows.max}" +
-              "&min-col=#{cols.min}&max-col=#{cols.max}"
+            url = concat_url(@cells_feed_url,
+                "?return-empty=true&min-row=#{rows.min}&max-row=#{rows.max}" +
+                "&min-col=#{cols.min}&max-col=#{cols.max}")
             doc = @session.request(:get, url)
 
             doc.css('entry').each() do |entry|
@@ -872,7 +1020,8 @@ module GoogleSpreadsheet
                 </feed>
               EOS
 
-              result = @session.request(:post, "#{@cells_feed_url}/batch", :data => xml)
+              batch_url = concat_url(@cells_feed_url, "/batch")
+              result = @session.request(:post, batch_url, :data => xml)
               result.css('atom|entry').each() do |entry|
                 interrupted = entry.css('batch|interrupted').first
                 if interrupted

metadata

@@ -1,102 +1,83 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: google-spreadsheet-ruby
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 5
-  version: 0.1.5
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Hiroshi Ichikawa
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-14 00:00:00 +09:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &81815340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 113
-        segments: 
-        - 1
-        - 4
-        - 3
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.4.3.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: oauth
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *81815340
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &81815050 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 0
-        - 3
-        - 6
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.3.6
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *81815050
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: &81814770 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *81814770
 description: This is a library to read/write Google Spreadsheet.
-email: 
+email:
 - gimite+github@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - README.rdoc
 - lib/google_spreadsheet.rb
-has_rdoc: true
 homepage: https://github.com/gimite/google-spreadsheet-ruby
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.rdoc
-require_paths: 
+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.11
 signing_key: 
 specification_version: 3
 summary: This is a library to read/write Google Spreadsheet.
 test_files: []
-