google-api-client 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: f8c8eb2c42edad1bf6e5cfbee1d439954126190c
-  data.tar.gz: fb2452e06f097f61268bd5249dc8fef45463b21a
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzhlMTg0N2Y1ZjlhYzcxYzM4MzM2Y2ZmMGI4NzEyNzJjMjlmYTEzYg==
+  data.tar.gz: !binary |-
+    MzcxZjIyMjAzODdlMTYxMzBhZWUxYzZjZDhiNjI1NzE1MTFkMjk5NQ==
 SHA512:
-  metadata.gz: f93bdc644f5520cc99c072da4816b9af16d13a1694a103dbeeee39b6c16974f68c1780ff6232476bac434482adc6cdc09ff036b2a62c4eafd94977ab14855417
-  data.tar.gz: 0d73c87dd66332a6782dd60b1aaef11ebc5d5fc440d86fe34996f661acc714dcb631e6c131be6002f1b76ba5a867ad456c5df15dd80be0b0f22a1b8137ed1837
+  metadata.gz: !binary |-
+    YzFlYThlNjUzZGI4ZTI2ZWZmY2FmMzQ1NTlmMDNlOTZkYzcxZWIwMmEzZDI5
+    ZjBiZjAxOTNmYzQ4YWRiM2VlNDgxOWMxODg2NzRmZWM3NTQwMTI2N2JjMmMy
+    YWRhYjAxNDNlY2Y2NjhhM2E2ZjMwMTQ1Mzc0NzliY2VmODc4NTY=
+  data.tar.gz: !binary |-
+    YWM2YjUzY2YyNDI1MmEwZTcxOTBiYmVjOWU4ZDQ1ZDY0MzYzMjBlZmMzMTVi
+    Y2IwN2UyZGVkYzdhMTNiNTA0ZDI4OTIxMGNiODQwNWJmYjA1ZmJhYTgzZDA1
+    OTkxZGE4NTIxODk3ZWZhNGRhZTc1OWEwZTRmZjEyOThiMWM0MDU=

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 0.8.0
+* Refactored credential storage, added support for redis
+* Update gem depdendencies
+* Fixed retry logic to allow for auth retries independent of the overall number of retries
+* Added `:force_encoding` option to set body content encoding based on the Content-Type header
+* Batch requests with the service interface now inherit the service's connection
+* `register_discover_document` now returns the API instance
+* Added `:proxy` option to set Faraday's HTTP proxy setting
+* Drop 1.8.x support
+* Added `:faraday_options` option to allow passthrough settings to Faraday connection
+ 
+# 0.7.1
+* Minor fix to update gem dependencies
+
 # 0.7.0
 * Remove CLI
 * SUpport for automatic retires & backoff. Off by default, enable by setting `retries` on `APIClient`

data/Gemfile

@@ -2,40 +2,4 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'signet', '>= 0.5.0'
-gem 'addressable', '>= 2.3.2'
-gem 'uuidtools', '>= 2.1.0'
-gem 'autoparse', '>= 0.3.3'
-gem 'faraday', '>= 0.9.0'
-gem 'multi_json', '>= 1.0.0'
-gem 'extlib', '>= 0.9.15'
-gem 'jwt', '~> 0.1.5'
-gem 'retriable', '>= 1.4'
 gem 'jruby-openssl', :platforms => :jruby
-
-group :development do
-  gem 'launchy', '>= 2.1.1'
-  gem 'yard'
-  gem 'kramdown'
-end
-
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'psych'
-end
-
-
-group :examples do
-  gem 'sinatra'
-end
-
-group :test, :development do
-  gem 'json', '~> 1.7.7'
-  gem 'rake', '>= 0.9.0'
-  gem 'rspec', '>= 2.11.0'
-  gem 'rcov', '>= 0.9.9', :platform => :mri_18
-end
-
-
-gem 'idn', :platform => :mri_18

data/README.md

@@ -15,6 +15,10 @@
 The Google API Ruby Client makes it trivial to discover and access supported
 APIs.
 
+## Alpha
+
+This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible changes when necessary.
+
 ## Install
 
 Be sure `https://rubygems.org/` is in your gem sources.
@@ -83,8 +87,13 @@ drive = client.discovered_api('drive', 'v2')
 Locally cached discovery documents may be used as well. To load an API from a local file:
 
 ```ruby
+# Output discovery document to JSON
+File.open('my-api.json', 'w') do |f| f.puts MultiJson.dump(client.discovery_document('myapi', 'v1')) end
+
+# Read discovery document and load API
 doc = File.read('my-api.json')
-my_api = client.register_discovery_document('myapi', 'v1', doc)
+client.register_discovery_document('myapi', 'v1', doc)
+my_api = client.discovered_api('myapi', 'v1')
 ```
 
 ### Authorization
@@ -114,6 +123,8 @@ in the credentials. Detailed instructions on how to enable delegation for your d
 
 The API client can automatically retry requests for recoverable errors. To enable retries, set the `client.retries` property to
 the number of additional attempts. To avoid flooding servers, retries invovle a 1 second delay that increases on each subsequent retry.
+In the case of authentication token expiry, the API client will attempt to refresh the token and retry the failed operation - this
+is a specific exception to the retry rules.
 
 The default value for retries is 0, but will be enabled by default in future releases.
 

data/Rakefile

@@ -33,14 +33,7 @@ list = FileList[
 end
 PKG_FILES = list
 
-RCOV_ENABLED = !!(RUBY_PLATFORM != 'java' && RUBY_VERSION =~ /^1\.8/)
-if RCOV_ENABLED
-  task :default => 'spec:rcov'
-else
-  task :default => 'spec'
-end
+task :default => 'spec'
 
 WINDOWS = (RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/) rescue false
 SUDO = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }

data/google-api-client.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+require File.join(File.dirname(__FILE__), 'lib/google/api_client', 'version')
+
+Gem::Specification.new do |s|
+  s.name = "google-api-client"
+  s.version = Google::APIClient::VERSION::STRING
+
+  s.required_rubygems_version = ">= 1.3.5"
+  s.require_paths = ["lib"]
+  s.authors = ["Bob Aman", "Steven Bazyl"]
+  s.license = "Apache-2.0"
+  s.description = "The Google API Ruby Client makes it trivial to discover and access supported APIs."
+  s.email = "sbazyl@google.com"
+  s.extra_rdoc_files = ["README.md"]
+  s.files = %w(google-api-client.gemspec Rakefile LICENSE CHANGELOG.md README.md Gemfile)
+  s.files += Dir.glob("lib/**/*.rb")
+  s.files += Dir.glob("spec/**/*.{rb,opts}")
+  s.files += Dir.glob("vendor/**/*.rb")
+  s.files += Dir.glob("tasks/**/*")
+  s.files += Dir.glob("website/**/*")
+  s.homepage = "https://github.com/google/google-api-ruby-client/"
+  s.rdoc_options = ["--main", "README.md"]
+  s.summary = "The Google API Ruby Client makes it trivial to discover and access Google's REST APIs."
+
+  s.add_runtime_dependency 'addressable', '~> 2.3'
+  s.add_runtime_dependency 'signet', '~> 0.6'
+  s.add_runtime_dependency 'faraday', '~> 0.9'
+  s.add_runtime_dependency 'multi_json', '~> 1.10'
+  s.add_runtime_dependency 'autoparse', "~> 0.3"
+  s.add_runtime_dependency 'extlib', '~> 0.9'
+  s.add_runtime_dependency 'launchy', '~> 2.4'
+  s.add_runtime_dependency 'retriable', '~> 1.4'
+  s.add_runtime_dependency 'activesupport', '>= 3.2'
+  
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'yard', '~> 0.8'
+  s.add_development_dependency 'rspec', '~> 3.1'
+  s.add_development_dependency 'kramdown', '~> 1.5'
+  s.add_development_dependency 'simplecov', '~> 0.9'
+end

data/lib/google/api_client.rb

@@ -31,8 +31,9 @@ require 'google/api_client/media'
 require 'google/api_client/service_account'
 require 'google/api_client/batch'
 require 'google/api_client/gzip'
+require 'google/api_client/charset'
 require 'google/api_client/client_secrets'
-require 'google/api_client/railtie' if defined?(Rails::Railtie)
+require 'google/api_client/railtie' if defined?(Rails)
 
 module Google
 
@@ -75,6 +76,11 @@ module Google
     # @option options [String] :ca_file
     #   Optional set of root certificates to use when validating SSL connections.
     #   By default, a bundled set of trusted roots will be used.
+    # @options options[Hash] :force_encoding
+    #   Experimental option. True if response body should be force encoded into the charset
+    #   specified in the Content-Type header. Mostly intended for compressed content.
+    # @options options[Hash] :faraday_options
+    #   Pass through of options to set on the Faraday connection
     def initialize(options={})
       logger.debug { "#{self.class} - Initializing client with options #{options}" }
       
@@ -97,6 +103,9 @@ module Google
       else
         logger.warn { "#{self.class} - Please provide :application_name and :application_version when initializing the client" }
       end
+
+      proxy = options[:proxy] || Object::ENV["http_proxy"]
+
       self.user_agent = options[:user_agent] || (
         "#{application_string} " +
         "google-api-ruby-client/#{Google::APIClient::VERSION::STRING} #{ENV::OS_VERSION} (gzip)"
@@ -109,17 +118,25 @@ module Google
       self.key = options[:key]
       self.user_ip = options[:user_ip]
       self.retries = options.fetch(:retries) { 0 }
+      self.expired_auth_retry = options.fetch(:expired_auth_retry) { true }
       @discovery_uris = {}
       @discovery_documents = {}
       @discovered_apis = {}
       ca_file = options[:ca_file] || File.expand_path('../../cacerts.pem', __FILE__)
       self.connection = Faraday.new do |faraday|
+        faraday.response :charset if options[:force_encoding]
         faraday.response :gzip
         faraday.options.params_encoder = Faraday::FlatParamsEncoder
         faraday.ssl.ca_file = ca_file
         faraday.ssl.verify = true
+        faraday.proxy proxy
         faraday.adapter Faraday.default_adapter
-      end      
+        if options[:faraday_option].is_a?(Hash)
+          options[:faraday_option].each_pair do |option, value|
+            faraday.options.send("#{option}=", value)
+          end
+        end
+      end
       return self
     end
 
@@ -239,6 +256,13 @@ module Google
     #  Number of retries
     attr_accessor :retries
 
+    ##
+    # Whether or not an expired auth token should be re-acquired
+    # (and the operation retried) regardless of retries setting
+    # @return [Boolean]
+    #  Auto retry on auth expiry
+    attr_accessor :expired_auth_retry
+
     ##
     # Returns the URI for the directory document.
     #
@@ -254,10 +278,12 @@ module Google
     # @param [String, Symbol] api The API name.
     # @param [String] version The desired version of the API.
     # @param [Addressable::URI] uri The URI of the discovery document.
+    # @return [Google::APIClient::API] The service object.
     def register_discovery_uri(api, version, uri)
       api = api.to_s
       version = version || 'v1'
       @discovery_uris["#{api}:#{version}"] = uri
+      discovered_api(api, version)
     end
 
     ##
@@ -286,6 +312,7 @@ module Google
     # @param [String] version The desired version of the API.
     # @param [String, StringIO] discovery_document
     #   The contents of the discovery document.
+    # @return [Google::APIClient::API] The service object.
     def register_discovery_document(api, version, discovery_document)
       api = api.to_s
       version = version || 'v1'
@@ -300,6 +327,7 @@ module Google
       end
       @discovery_documents["#{api}:#{version}"] =
         MultiJson.load(discovery_document)
+      discovered_api(api, version)
     end
 
     ##
@@ -591,35 +619,42 @@ module Google
 
       connection = options[:connection] || self.connection
       request.authorization = options[:authorization] || self.authorization unless options[:authenticated] == false
+      
       tries = 1 + (options[:retries] || self.retries)
+      attempt = 0
+
       Retriable.retriable :tries => tries, 
-                          :on => [TransmissionError], 
+                          :on => [TransmissionError],
+                          :on_retry => client_error_handler,
                           :interval => lambda {|attempts| (2 ** attempts) + rand} do
-        result = request.send(connection, true)
-
-        case result.status
-          when 200...300
-            result
-          when 301, 302, 303, 307
-            request = generate_request(request.to_hash.merge({
-              :uri => result.headers['location'],
-              :api_method => nil
-            }))
-            raise RedirectError.new(result.headers['location'], result)
-          when 400...500
-            if result.status == 401 && request.authorization.respond_to?(:refresh_token) && auto_refresh_token
-              begin
-                logger.debug("Attempting refresh of access token & retry of request")
-                request.authorization.fetch_access_token!
-              rescue Signet::AuthorizationError
-                 # Ignore since we want the original error
-              end
-            end
-            raise ClientError.new(result.error_message || "A client error has occurred", result)
-          when 500...600
-            raise ServerError.new(result.error_message || "A server error has occurred", result)
-          else
-            raise TransmissionError.new(result.error_message || "A transmission error has occurred", result)
+        attempt += 1
+
+        # This 2nd level retriable only catches auth errors, and supports 1 retry, which allows
+        # auth to be re-attempted without having to retry all sorts of other failures like
+        # NotFound, etc
+        Retriable.retriable :tries => ((expired_auth_retry || tries > 1) && attempt == 1) ? 2 : 1, 
+                            :on => [AuthorizationError],
+                            :on_retry => authorization_error_handler(request.authorization) do
+          result = request.send(connection, true)
+
+          case result.status
+            when 200...300
+              result
+            when 301, 302, 303, 307
+              request = generate_request(request.to_hash.merge({
+                :uri => result.headers['location'],
+                :api_method => nil
+              }))
+              raise RedirectError.new(result.headers['location'], result)
+            when 401
+              raise AuthorizationError.new(result.error_message || 'Invalid/Expired Authentication', result)
+            when 400, 402...500
+              raise ClientError.new(result.error_message || "A client error has occurred", result)
+            when 500...600
+              raise ServerError.new(result.error_message || "A server error has occurred", result)
+            else
+              raise TransmissionError.new(result.error_message || "A transmission error has occurred", result)
+          end
         end
       end
     end
@@ -665,8 +700,41 @@ module Google
       return Addressable::Template.new(@base_uri + template).expand(mapping)
     end
     
+
+    ##
+    # Returns on proc for special processing of retries for authorization errors
+    # Only 401s should be retried and only if the credentials are refreshable
+    #
+    # @param [#fetch_access_token!] authorization
+    #   OAuth 2 credentials
+    # @return [Proc]
+    def authorization_error_handler(authorization)
+      can_refresh = authorization.respond_to?(:refresh_token) && auto_refresh_token 
+      Proc.new do |exception, tries|
+        next unless exception.kind_of?(AuthorizationError)
+        if can_refresh
+          begin
+            logger.debug("Attempting refresh of access token & retry of request")
+            authorization.fetch_access_token!
+            next
+          rescue Signet::AuthorizationError
+          end
+        end
+        raise exception
+      end
+    end
+
+    ##
+    # Returns on proc for special processing of retries as not all client errors
+    # are recoverable. Only 401s should be retried (via authorization_error_handler)
+    #
+    # @return [Proc]
+    def client_error_handler
+      Proc.new do |exception, tries|
+        raise exception if exception.kind_of?(ClientError)
+      end
+    end
+
   end
 
 end
-
-require 'google/api_client/version'

data/lib/google/api_client/auth/compute_service_account.rb

@@ -21,7 +21,7 @@ module Google
       def fetch_access_token(options={})
         connection = options[:connection] || Faraday.default_connection
         response = connection.get 'http://metadata/computeMetadata/v1beta1/instance/service-accounts/default/token'
-        Signet::OAuth2.parse_json_credentials(response.body)
+        Signet::OAuth2.parse_credentials(response.body, response.headers['content-type'])
       end
     end
   end

data/lib/google/api_client/auth/file_storage.rb

@@ -12,47 +12,39 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'json'
 require 'signet/oauth_2/client'
+require_relative 'storage'
+require_relative 'storages/file_store'
 
 module Google
   class APIClient
+
     ##
     # Represents cached OAuth 2 tokens stored on local disk in a
     # JSON serialized file. Meant to resemble the serialized format
     # http://google-api-python-client.googlecode.com/hg/docs/epy/oauth2client.file.Storage-class.html
     #
+    # @deprecated
+    #  Use {Google::APIClient::Storage} and {Google::APIClient::FileStore} instead
+    #
     class FileStorage
-      # @return [String] Path to the credentials file.
-      attr_accessor :path
 
-      # @return [Signet::OAuth2::Client] Path to the credentials file.
-      attr_reader :authorization
+      attr_accessor :storage,
+                    :path
 
-      ##
-      # Initializes the FileStorage object.
-      #
-      # @param [String] path
-      #    Path to the credentials file.
       def initialize(path)
         @path = path
-        self.load_credentials
+        store = Google::APIClient::FileStore.new(@path)
+        @storage = Google::APIClient::Storage.new(store)
+        @storage.authorize
       end
 
-      ##
-      # Attempt to read in credentials from the specified file.
       def load_credentials
-        if File.exist? self.path
-          File.open(self.path, 'r') do |file|
-            cached_credentials = JSON.load(file)
-            @authorization = Signet::OAuth2::Client.new(cached_credentials)
-            @authorization.issued_at = Time.at(cached_credentials['issued_at'])
-            if @authorization.expired?
-              @authorization.fetch_access_token!
-              self.write_credentials
-            end
-          end
-        end
+        storage.authorize
+      end
+
+      def authorization
+        storage.authorization
       end
 
       ##
@@ -61,26 +53,9 @@ module Google
       # @param [Signet::OAuth2::Client] authorization
       #    Optional authorization instance. If not provided, the authorization
       #    already associated with this instance will be written.
-      def write_credentials(authorization=nil)
-        @authorization = authorization unless authorization.nil?
-
-        unless @authorization.refresh_token.nil?
-          hash = {}
-          %w'access_token
-           authorization_uri
-           client_id
-           client_secret
-           expires_in
-           refresh_token
-           token_credential_uri'.each do |var|
-            hash[var] = @authorization.instance_variable_get("@#{var}")
-          end
-          hash['issued_at'] = @authorization.issued_at.to_i
-
-          File.open(self.path, 'w', 0600) do |file|
-            file.write(hash.to_json)
-          end
-        end
+      def write_credentials(auth=nil)
+        self.authorization = auth unless auth.nil?
+        storage.write_credentials(self.authorization)
       end
     end
   end