google-api-client 0.9.pre4 → 0.9.pre5

data/google-api-client.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'hurley', '~> 0.1'
   spec.add_runtime_dependency 'googleauth', '~> 0.5'
   spec.add_runtime_dependency 'thor', '~> 0.19'
+  spec.add_runtime_dependency 'httpclient', '~> 2.7'
   spec.add_runtime_dependency 'memoist', '~> 0.11'
 end

data/lib/google/apis/core/api_command.rb

@@ -94,11 +94,11 @@ module Google
           when 400, 402...500
             error = parse_error(body)
             if error
-              message = error['reason'] if error.has_key?('reason')
+              message = sprintf('%s: %s', error['reason'], error['message'])
               raise Google::Apis::RateLimitError.new(message,
                                                      status_code: status,
                                                      header: header,
-                                                     body: body) if RATE_LIMIT_ERRORS.include?(message)
+                                                     body: body) if RATE_LIMIT_ERRORS.include?(error['reason'])
             end
             super(status, header, body, message)
           else

data/lib/google/apis/core/base_service.rb

@@ -19,6 +19,7 @@ require 'google/apis/core/api_command'
 require 'google/apis/core/batch'
 require 'google/apis/core/upload'
 require 'google/apis/core/download'
+require 'google/apis/core/http_client_adapter'
 require 'google/apis/options'
 require 'googleauth'
 require 'hurley'
@@ -291,6 +292,7 @@ module Google
         # @return [Hurley::Client]
         def new_client
           client = Hurley::Client.new
+          client.connection = Google::Apis::Core::HttpClientAdapter.new unless client_options.use_net_http
           client.request_options.timeout = request_options.timeout_sec
           client.request_options.open_timeout = request_options.open_timeout_sec
           client.request_options.proxy = client_options.proxy_url

data/lib/google/apis/core/http_client_adapter.rb

@@ -0,0 +1,82 @@
+require 'httpclient'
+require 'hurley'
+require 'hurley/client'
+
+module Google
+  module Apis
+    module Core
+      # HTTPClient adapter for Hurley.
+      class HttpClientAdapter
+
+        def call(request)
+          client = ::HTTPClient.new
+          configure_client(client, request)
+
+          begin
+            ::Hurley::Response.new(request) do |res|
+              http_res = client.request(request.verb.to_s.upcase, request.url.to_s, nil, request.body_io, request.header.to_hash, false) do |http_res, chunk|
+                copy_response(http_res, res)
+                res.receive_body(chunk)
+              end
+              copy_response(http_res, res)
+            end
+          rescue ::HTTPClient::TimeoutError, Errno::ETIMEDOUT
+            raise ::Hurley::Timeout, $!
+          rescue ::HTTPClient::BadResponseError => err
+            if err.message.include?('status 407')
+              raise ::Hurley::ConnectionFailed, %{407 "Proxy Authentication Required "}
+            else
+              raise Hurley::ClientError, $!
+            end
+          rescue Errno::ECONNREFUSED, EOFError
+            raise ::Hurley::ConnectionFailed, $!
+          rescue => err
+            if defined?(OpenSSL) && OpenSSL::SSL::SSLError === err
+              raise Hurley::SSLError, err
+            else
+              raise
+            end
+          end
+        end
+
+        def copy_response(http_res, res)
+          unless res.status_code
+            res.status_code = http_res.status.to_i
+            http_res.header.all.each do |(k,v)|
+              res.header[k] = v
+            end
+          end
+        end
+
+        def configure_client(client, request)
+          client.transparent_gzip_decompression = true
+          if request.options.proxy
+            proxy = request.options.proxy
+            client.proxy = sprintf('%s:%d', proxy.host, proxy.port)
+            if proxy.user && proxy.password
+              client.set_proxy_auth proxy.user, proxy.password
+            end
+          end
+          if request.options.timeout
+            client.connect_timeout = request.options.timeout
+            client.receive_timeout = request.options.timeout
+            client.send_timeout = request.options.timeout
+          end
+          if request.options.open_timeout
+            client.connect_timeout = request.options.open_timeout
+            client.send_timeout = request.options.open_timeout
+          end
+          ssl_config = client.ssl_config
+          ssl_opts = request.ssl_options
+          ssl_config.verify_mode = ssl_opts.openssl_verify_mode
+          ssl_config.cert_store = ssl_opts.openssl_cert_store
+          ssl_config.add_trust_ca ssl_opts.ca_file if ssl_opts.ca_file
+          ssl_config.add_trust_ca ssl_opts.ca_path if ssl_opts.ca_path
+          ssl_config.client_cert = ssl_opts.openssl_client_cert if ssl_opts.openssl_client_cert
+          ssl_config.client_key = ssl_opts.openssl_client_key if ssl_opts.openssl_client_key
+          ssl_config.verify_depth = ssl_opts.verify_depth if ssl_opts.verify_depth
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/core/http_command.rb

@@ -264,7 +264,9 @@ module Google
               # Temporary workaround for Hurley bug where the connection preference
               # is ignored and it uses nested anyway
               req.url.query_class = Hurley::Query::Flat
-              query.each { | k, v| req.url.query[k] = v }
+              query.each do | k, v|
+                req.url.query[k] = normalize_query_value(v)
+              end
               # End workaround
               apply_request_options(req)
             end
@@ -291,6 +293,19 @@ module Google
           req.header.update(header)
           req.options.timeout = options.timeout_sec
         end
+
+        private
+
+        def normalize_query_value(v)
+          case v
+          when Array
+            v.map { |v2| normalize_query_value(v2) }
+          when nil
+            nil
+          else
+            v.to_s
+          end
+        end
       end
     end
   end

data/lib/google/apis/core/json_representation.rb

@@ -76,7 +76,7 @@ module Google
               options[:render_filter] = ->(value, _doc, *_args) { value.is_a?(DateTime) ? value.rfc3339(3) : value.to_s }
               options[:parse_filter] = ->(fragment, _doc, *_args) { DateTime.parse(fragment) }
             end
-            
+
             options[:render_nil] = true
             options[:getter] = getter_fn(name)
             options[:if] = if_fn(name)
@@ -107,7 +107,8 @@ module Google
           # @param [String] name
           #  Property name
           # @param [Hash] options
-          def hash(name, options)
+          def hash(name = nil, options = nil)
+            return super() unless name # Allow Object.hash
             set_default_options(name, options)
             super(name, options)
           end

data/lib/google/apis/core/upload.rb

@@ -82,7 +82,7 @@ module Google
         # @raise [Google::Apis::ClientError] if upload source is invalid
         def prepare!
           super
-          if upload_source.is_a?(IO) || upload_source.is_a?(StringIO)
+          if streamable?(upload_source)
             self.upload_io = UploadIO.from_io(upload_source, content_type: upload_content_type)
             @close_io_on_finish = false
           elsif upload_source.is_a?(String)
@@ -97,6 +97,12 @@ module Google
         def release!
           upload_io.close if @close_io_on_finish
         end
+
+        private
+
+        def streamable?(upload_source)
+          upload_source.is_a?(IO) || upload_source.is_a?(StringIO) || upload_source.is_a?(Tempfile)
+        end
       end
 
       # Implementation of the raw upload protocol

data/lib/google/apis/options.rb

@@ -18,7 +18,8 @@ module Google
     ClientOptions =  Struct.new(
       :application_name,
       :application_version,
-      :proxy_url)
+      :proxy_url,
+      :use_net_http)
 
     RequestOptions = Struct.new(
       :authorization,
@@ -73,7 +74,8 @@ module Google
         new_options
       end
     end
-
+    
+    ClientOptions.default.use_net_http = false
     ClientOptions.default.application_name = 'unknown'
     ClientOptions.default.application_version = '0.0.0'
 

data/lib/google/apis/version.rb

@@ -15,7 +15,7 @@
 module Google
   module Apis
     # Client library version
-    VERSION = '0.9.pre4'
+    VERSION = '0.9.pre5'
 
     # Current operating system
     # @private

data/samples/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'google-api-client', '~> 0.9.pre4'
+gem 'thor', '~> 0.19'
+gem 'os', '~> 0.9'
+gem 'rmail', '~> 1.1'
+gem 'dotenv'

data/samples/README.md

@@ -0,0 +1,51 @@
+# API Samples
+
+This directory contains a small but growing collection of samples for various
+APIs. Each sample can be run on the command line from the `google-api-samples`
+script.
+
+Contributions of new samples are welcome.
+
+# Setup
+
+Depending on which particular samples you want to run, different
+steps may be required. Some samples, like Pub/Sub, require a service account,
+others like Drive, Calendar, and YouTube require an OAuth Client ID. And in
+some cases like Translate, only an API key is needed.
+
+* Create a project at https://console.developers.google.com
+* Go to the `API Manager` and enable the APIs you'd like to try
+* Go to `Credentials` and create the appropriate type of credential for the sample
+    * For keys, use 'Server key' as the type
+    * For OAuth Client IDs, use 'Other' as the type
+    * For service accounts, use the 'JSON' key type
+
+Additional details on how to enable APIs and create credentials can be
+found in the help guide in the console.
+
+
+## Example Environment Settings
+
+For convenience, application credentials can be read from the shell environment
+or placed in a .env file.
+
+After setup, your .env file might look something like:
+
+```
+GOOGLE_API_KEY=AIzaSyC6GvjvPlEzJpTW2bW2t0MPHXXXXXXXXXX
+GOOGLE_CLIENT_ID=479164972499-i7j6av7bp2s4on5ltb7pjXXXXXXXXXX.apps.googleusercontent.com
+GOOGLE_CLIENT_SECRET=JBotCTG5biFWGzXXXXXXXXXX
+GOOGLE_APPLICATION_CREDENTIALS=~/ruby-samples-cred.json
+```
+
+# Running the samples
+
+To list the available sample modules, run the script:
+```
+google-api-samples
+```
+
+To get help on a specific set of samples, run:
+```
+google-api-samples help <module>
+```

data/samples/google-api-samples

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path("../lib", __FILE__))
+
+require 'thor'
+require 'dotenv'
+
+
+# Small script to allow executing samples from the command line.
+# Each sample is loaded as a subcommand.
+#
+# Example usage:
+#
+#     google-api-samples drive upload myfile.txt
+#
+#
+class App < Thor
+
+  # Load all the samples and register them as subcommands
+  Dir.glob('./lib/samples/*.rb').each do |file|
+    require file
+  end
+
+  Samples.constants.each do |const|
+    desc const.downcase, "#{const} samples"
+    subcommand const.downcase, Samples.const_get(const)
+  end
+
+end
+
+Dotenv.load
+App.start(ARGV)

data/samples/lib/base_cli.rb

@@ -0,0 +1,94 @@
+# Copyright 2016 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'fileutils'
+require 'thor'
+require 'os'
+
+# Base command line module for samples. Provides authorization support,
+# either using application default credentials or user authorization
+# depending on the use case.
+class BaseCli < Thor
+  include Thor::Actions
+
+  OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
+
+  class_option :user, :type => :string
+  class_option :api_key, :type => :string
+
+  no_commands do
+
+    # Returns the path to the client_secrets.json file.
+    def client_secrets_path
+      return ENV['GOOGLE_CLIENT_SECRETS'] if ENV.has_key?('GOOGLE_CLIENT_SECRETS')
+      return well_known_path_for('client_secrets.json')
+    end
+
+    # Returns the path to the token store.
+    def token_store_path
+      return ENV['GOOGLE_CREDENTIAL_STORE'] if ENV.has_key?('GOOGLE_CREDENTIAL_STORE')
+      return well_known_path_for('credentials.yaml')
+    end
+
+    # Builds a path to a file in $HOME/.config/google (or %APPDATA%/google,
+    # on Windows)
+    def well_known_path_for(file)
+      if OS.windows?
+        File.join(ENV['APPDATA'], 'google', file)
+      else
+        File.join(ENV['HOME'], '.config', 'google', file)
+      end
+    end
+
+    # Returns application credentials for the given scope.
+    def application_credentials_for(scope)
+      Google::Auth.get_application_default(scope)
+    end
+
+    # Returns user credentials for the given scope. Requests authorization
+    # if requrired.
+    def user_credentials_for(scope)
+      FileUtils.mkdir_p(File.dirname(token_store_path))
+
+      if ENV['GOOGLE_CLIENT_ID']
+        client_id = Google::Auth::ClientId.new(ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET'])
+      else
+        client_id = Google::Auth::ClientId.from_file(client_secrets_path)
+      end
+      token_store = Google::Auth::Stores::FileTokenStore.new(:file => token_store_path)
+      authorizer = Google::Auth::UserAuthorizer.new(client_id, scope, token_store)
+
+      user_id = options[:user] || 'default'
+
+      credentials = authorizer.get_credentials(user_id)
+      if credentials.nil?
+        url = authorizer.get_authorization_url(base_url: OOB_URI)
+        say "Open the following URL in your browser and authorize the application."
+        say url
+        code = ask "Enter the authorization code:"
+        credentials = authorizer.get_and_store_credentials_from_code(
+          user_id: user_id, code: code, base_url: OOB_URI)
+      end
+      credentials
+    end
+
+    # Gets the API key of the client
+    def api_key
+      ENV['GOOGLE_API_KEY'] || options[:api_key]
+    end
+
+  end
+end

data/samples/lib/samples/analytics.rb

@@ -0,0 +1,62 @@
+# Copyright 2016 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/analytics_v3'
+require 'base_cli'
+
+module Samples
+  # Examples for the Google Analytics APIs
+  #
+  # Sample usage session:
+  #
+  #     $ ./google-api-samples analytics show_visits 55622900 --start='2015-12-01' --end='2015-12-08'
+  #     ga:date   ga:sessions  ga:users  ga:newUsers  ga:percentNewSessions  ga:sessionDuration  ga:avgSessionDuration
+  #     20151201  0            0         0            0.0                    0.0                 0.0
+  #     20151202  0            0         0            0.0                    0.0                 0.0
+  #     20151203  1            1         1            100.0                  0.0                 0.0
+  #     20151204  2            2         1            50.0                   616.0               308.0
+  #     20151205  0            0         0            0.0                    0.0                 0.0
+  #     20151206  1            1         1            100.0                  0.0                 0.0
+  #     20151207  0            0         0            0.0                    0.0                 0.0
+  #     20151208  2            2         1            50.0                   0.0                 0.0
+  #
+  class Analytics < BaseCli
+    Analytics = Google::Apis::AnalyticsV3
+
+    desc 'show_visits PROFILE_ID', 'Show visists for the given analytics profile ID'
+    method_option :start, type: :string, required: true
+    method_option :end, type: :string, required: true
+    def show_visits(profile_id)
+      analytics = Analytics::AnalyticsService.new
+      analytics.authorization = user_credentials_for(Analytics::AUTH_ANALYTICS)
+
+      dimensions = %w(ga:date)
+      metrics = %w(ga:sessions ga:users ga:newUsers ga:percentNewSessions
+                   ga:sessionDuration ga:avgSessionDuration)
+      sort = %w(ga:date)
+      result = analytics.get_ga_data("ga:#{profile_id}",
+                                     options[:start],
+                                     options[:end],
+                                     metrics.join(','),
+                                     dimensions: dimensions.join(','),
+                                     sort: sort.join(','))
+
+      data = []
+      data.push(result.column_headers.map { |h| h.name })
+      data.push(*result.rows)
+      print_table(data)
+    end
+
+  end
+end