google-api-client 0.8.3 → 0.9

data/generated/google/apis/youtubereporting_v1/service.rb

@@ -0,0 +1,364 @@
+# Copyright 2015 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/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module YoutubereportingV1
+      # YouTube Reporting API
+      #
+      # An API to schedule reporting jobs and download the resulting bulk data reports
+      #  about YouTube channels, videos etc. in the form of CSV files.
+      #
+      # @example
+      #    require 'google/apis/youtubereporting_v1'
+      #
+      #    Youtubereporting = Google::Apis::YoutubereportingV1 # Alias the module
+      #    service = Youtubereporting::YouTubeReportingService.new
+      #
+      # @see https://developers.google.com/youtube/reporting/v1/reports/
+      class YouTubeReportingService < Google::Apis::Core::BaseService
+        # @return [String]
+        #  API key. Your API key identifies your project and provides you with API access,
+        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
+        attr_accessor :key
+
+        # @return [String]
+        #  Available to use for quota purposes for server-side applications. Can be any
+        #  arbitrary string assigned to a user, but should not exceed 40 characters.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://youtubereporting.googleapis.com/', '')
+        end
+        
+        # Method for media download. Download is supported on the URI `/v1/media/`+name`?
+        # alt=media`.
+        # @param [String] resource_name
+        #   Name of the media that is being downloaded. See [][ByteStream.ReadRequest.
+        #   resource_name].
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [IO, String] download_dest
+        #   IO stream or filename to receive content download
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::YoutubereportingV1::Media] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::YoutubereportingV1::Media]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
+          if download_dest.nil?
+            command =  make_simple_command(:get, 'v1/media/{+resourceName}', options)
+          else
+            command = make_download_command(:get, 'v1/media/{+resourceName}', options)
+            command.download_dest = download_dest
+          end
+          command.response_representation = Google::Apis::YoutubereportingV1::Media::Representation
+          command.response_class = Google::Apis::YoutubereportingV1::Media
+          command.params['resourceName'] = resource_name unless resource_name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists report types.
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If not
+        #   set, the user is acting for himself (his own channel).
+        # @param [Fixnum] page_size
+        #   Requested page size. Server may return fewer report types than requested. If
+        #   unspecified, server will pick an appropriate default.
+        # @param [String] page_token
+        #   A token identifying a page of results the server should return. Typically,
+        #   this is the value of ListReportTypesResponse.next_page_token returned in
+        #   response to the previous call to the `ListReportTypes` method.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::YoutubereportingV1::ListReportTypesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::YoutubereportingV1::ListReportTypesResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_report_types(on_behalf_of_content_owner: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1/reportTypes', options)
+          command.response_representation = Google::Apis::YoutubereportingV1::ListReportTypesResponse::Representation
+          command.response_class = Google::Apis::YoutubereportingV1::ListReportTypesResponse
+          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Creates a job and returns it.
+        # @param [Google::Apis::YoutubereportingV1::Job] job_object
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If not
+        #   set, the user is acting for himself (his own channel).
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::YoutubereportingV1::Job] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::YoutubereportingV1::Job]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def create_job(job_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:post, 'v1/jobs', options)
+          command.request_representation = Google::Apis::YoutubereportingV1::Job::Representation
+          command.request_object = job_object
+          command.response_representation = Google::Apis::YoutubereportingV1::Job::Representation
+          command.response_class = Google::Apis::YoutubereportingV1::Job
+          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists jobs.
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If not
+        #   set, the user is acting for himself (his own channel).
+        # @param [Fixnum] page_size
+        #   Requested page size. Server may return fewer jobs than requested. If
+        #   unspecified, server will pick an appropriate default.
+        # @param [String] page_token
+        #   A token identifying a page of results the server should return. Typically,
+        #   this is the value of ListReportTypesResponse.next_page_token returned in
+        #   response to the previous call to the `ListJobs` method.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::YoutubereportingV1::ListJobsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::YoutubereportingV1::ListJobsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_jobs(on_behalf_of_content_owner: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1/jobs', options)
+          command.response_representation = Google::Apis::YoutubereportingV1::ListJobsResponse::Representation
+          command.response_class = Google::Apis::YoutubereportingV1::ListJobsResponse
+          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Gets a job.
+        # @param [String] job_id
+        #   The ID of the job to retrieve.
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If not
+        #   set, the user is acting for himself (his own channel).
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::YoutubereportingV1::Job] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::YoutubereportingV1::Job]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_job(job_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1/jobs/{jobId}', options)
+          command.response_representation = Google::Apis::YoutubereportingV1::Job::Representation
+          command.response_class = Google::Apis::YoutubereportingV1::Job
+          command.params['jobId'] = job_id unless job_id.nil?
+          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Deletes a job.
+        # @param [String] job_id
+        #   The ID of the job to delete.
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If not
+        #   set, the user is acting for himself (his own channel).
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::YoutubereportingV1::Empty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::YoutubereportingV1::Empty]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def delete_job(job_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:delete, 'v1/jobs/{jobId}', options)
+          command.response_representation = Google::Apis::YoutubereportingV1::Empty::Representation
+          command.response_class = Google::Apis::YoutubereportingV1::Empty
+          command.params['jobId'] = job_id unless job_id.nil?
+          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists reports created by a specific job. Returns NOT_FOUND if the job does not
+        # exist.
+        # @param [String] job_id
+        #   The ID of the job.
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If not
+        #   set, the user is acting for himself (his own channel).
+        # @param [Fixnum] page_size
+        #   Requested page size. Server may return fewer report types than requested. If
+        #   unspecified, server will pick an appropriate default.
+        # @param [String] page_token
+        #   A token identifying a page of results the server should return. Typically,
+        #   this is the value of ListReportsResponse.next_page_token returned in response
+        #   to the previous call to the `ListReports` method.
+        # @param [String] created_after
+        #   If set, only reports created after the specified date/time are returned.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::YoutubereportingV1::ListReportsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::YoutubereportingV1::ListReportsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_job_reports(job_id, on_behalf_of_content_owner: nil, page_size: nil, page_token: nil, created_after: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1/jobs/{jobId}/reports', options)
+          command.response_representation = Google::Apis::YoutubereportingV1::ListReportsResponse::Representation
+          command.response_class = Google::Apis::YoutubereportingV1::ListReportsResponse
+          command.params['jobId'] = job_id unless job_id.nil?
+          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['createdAfter'] = created_after unless created_after.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Gets the metadata of a specific report.
+        # @param [String] job_id
+        #   The ID of the job.
+        # @param [String] report_id
+        #   The ID of the report to retrieve.
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If not
+        #   set, the user is acting for himself (his own channel).
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::YoutubereportingV1::Report] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::YoutubereportingV1::Report]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_job_report(job_id, report_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1/jobs/{jobId}/reports/{reportId}', options)
+          command.response_representation = Google::Apis::YoutubereportingV1::Report::Representation
+          command.response_class = Google::Apis::YoutubereportingV1::Report
+          command.params['jobId'] = job_id unless job_id.nil?
+          command.params['reportId'] = report_id unless report_id.nil?
+          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+
+        protected
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/youtubereporting_v1.rb

@@ -0,0 +1,38 @@
+# Copyright 2015 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/youtubereporting_v1/service.rb'
+require 'google/apis/youtubereporting_v1/classes.rb'
+require 'google/apis/youtubereporting_v1/representations.rb'
+
+module Google
+  module Apis
+    # YouTube Reporting API
+    #
+    # An API to schedule reporting jobs and download the resulting bulk data reports
+    # about YouTube channels, videos etc. in the form of CSV files.
+    #
+    # @see https://developers.google.com/youtube/reporting/v1/reports/
+    module YoutubereportingV1
+      VERSION = 'V1'
+      REVISION = '20151026'
+
+      # View monetary and non-monetary YouTube Analytics reports for your YouTube content
+      AUTH_YT_ANALYTICS_MONETARY_READONLY = 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly'
+
+      # View YouTube Analytics reports for your YouTube content
+      AUTH_YT_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/yt-analytics.readonly'
+    end
+  end
+end

data/google-api-client.gemspec

@@ -1,43 +1,31 @@
-# -*- encoding: utf-8 -*-
-require File.join(File.dirname(__FILE__), 'lib/google/api_client', 'version')
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google/apis/version'
 
-Gem::Specification.new do |s|
-  s.name = "google-api-client"
-  s.version = Google::APIClient::VERSION::STRING
+Gem::Specification.new do |spec|
+  spec.name          = 'google-api-client'
+  spec.version       = Google::Apis::VERSION
+  spec.authors       = ['Steven Bazyl', 'Tim Emiola', 'Sergio Gomes', 'Bob Aman']
+  spec.email         = ['sbazyl@google.com']
+  spec.summary       = %q{Client for accessing Google APIs}
+  spec.homepage      = 'https://github.com/google/google-api-ruby-client'
+  spec.license       = 'Apache 2.0'
 
-  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("lib/cacerts.pem")
-  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."
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib', 'generated', 'third_party']
 
-  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 'googleauth', '~> 0.3'
-  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.2'
-  s.add_development_dependency 'coveralls', '~> 0.7.11'
+  spec.add_runtime_dependency 'representable', '~> 2.3.0'
+  spec.add_runtime_dependency 'multi_json', '~> 1.11'
+  spec.add_runtime_dependency 'retriable', '~> 2.0'
+  spec.add_runtime_dependency 'activesupport', '>= 3.2'
+  spec.add_runtime_dependency 'addressable', '~> 2.3'
+  spec.add_runtime_dependency 'mime-types', '>= 1.6'
+  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/api_client/auth/installed_app.rb

@@ -23,14 +23,17 @@ module Google
     #
     # @example
     #
-    #    client = Google::APIClient.new
     #    flow = Google::APIClient::InstalledAppFlow.new(
     #      :client_id => '691380668085.apps.googleusercontent.com',
     #      :client_secret => '...',
     #      :scope => 'https://www.googleapis.com/auth/drive'
     #    )
-    #    client.authorization = flow.authorize
+    #    authorization = flow.authorize
+    #    Drive = Google::Apis::DriveV2
+    #    drive = Drive::DriveService.new
+    #    drive.authorization = authorization
     #
+    # @deprecated Use google-auth-library-ruby instead
     class InstalledAppFlow
 
       RESPONSE_BODY = <<-HTML
@@ -83,7 +86,7 @@ module Google
       #
       # @return [Signet::OAuth2::Client]
       #  Authorization instance, nil if user cancelled.
-      def authorize(storage=nil)
+      def authorize(storage=nil, options={})
         auth = @authorization
 
         server = WEBrick::HTTPServer.new(
@@ -105,7 +108,7 @@ module Google
             server.stop
           end
 
-          Launchy.open(auth.authorization_uri.to_s)
+          Launchy.open(auth.authorization_uri(options).to_s)
           server.start
         ensure
           server.shutdown
@@ -123,4 +126,3 @@ module Google
 
   end
 end
-

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

@@ -18,6 +18,7 @@ module Google
     # Helper for loading keys from the PKCS12 files downloaded when
     # setting up service accounts at the APIs Console.
     #
+    # @deprecated Use google-auth-library-ruby instead
     module KeyUtils
       ##
       # Loads a key from PKCS12 file, assuming a single private key
@@ -25,44 +26,44 @@ module Google
       #
       # @param [String] keyfile
       #    Path of the PKCS12 file to load. If not a path to an actual file,
-      #    assumes the string is the content of the file itself. 
+      #    assumes the string is the content of the file itself.
       # @param [String] passphrase
       #   Passphrase for unlocking the private key
       #
       # @return [OpenSSL::PKey] The private key for signing assertions.
       def self.load_from_pkcs12(keyfile, passphrase)
-        load_key(keyfile, passphrase) do |content, passphrase| 
-          OpenSSL::PKCS12.new(content, passphrase).key
+        load_key(keyfile, passphrase) do |content, pass_phrase|
+          OpenSSL::PKCS12.new(content, pass_phrase).key
         end
       end
-      
+
 
       ##
       # Loads a key from a PEM file.
       #
       # @param [String] keyfile
       #    Path of the PEM file to load. If not a path to an actual file,
-      #    assumes the string is the content of the file itself. 
+      #    assumes the string is the content of the file itself.
       # @param [String] passphrase
       #   Passphrase for unlocking the private key
       #
       # @return [OpenSSL::PKey] The private key for signing assertions.
       #
       def self.load_from_pem(keyfile, passphrase)
-        load_key(keyfile, passphrase) do | content, passphrase|
-          OpenSSL::PKey::RSA.new(content, passphrase)
+        load_key(keyfile, passphrase) do | content, pass_phrase|
+          OpenSSL::PKey::RSA.new(content, pass_phrase)
         end
       end
 
       private
-      
+
       ##
       # Helper for loading keys from file or memory. Accepts a block
       # to handle the specific file format.
       #
       # @param [String] keyfile
       #    Path of thefile to load. If not a path to an actual file,
-      #    assumes the string is the content of the file itself. 
+      #    assumes the string is the content of the file itself.
       # @param [String] passphrase
       #   Passphrase for unlocking the private key
       #
@@ -86,8 +87,8 @@ module Google
           block.call(content, passphrase)
         rescue OpenSSL::OpenSSLError
           raise ArgumentError.new("Invalid keyfile or passphrase")
-        end        
-      end  
+        end
+      end
     end
   end
 end

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

@@ -21,6 +21,7 @@ module Google
     # 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-auth-library-ruby instead
     class Storage
 
       AUTHORIZATION_URI = 'https://accounts.google.com/o/oauth2/auth'
@@ -35,15 +36,17 @@ module Google
       ##
       # Initializes the Storage object.
       #
-      # @params [Object] Storage object
+      # @param [Object] store
+      #  Storage object
       def initialize(store)
         @store= store
+        @authorization = nil
       end
 
       ##
       # Write the credentials to the specified store.
       #
-      # @params [Signet::OAuth2::Client] authorization
+      # @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)

data/lib/google/api_client/auth/storages/file_store.rb

@@ -21,6 +21,7 @@ module Google
     # 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-auth-library-ruby instead
     class FileStore
 
       attr_accessor :path
@@ -45,9 +46,7 @@ module Google
       ##
       # Write the credentials to the specified file.
       #
-      # @param [Signet::OAuth2::Client] authorization
-      #    Optional authorization instance. If not provided, the authorization
-      #    already associated with this instance will be written.
+      # @param [Hash] credentials_hash
       def write_credentials(credentials_hash)
         open(self.path, 'w+') do |f|
           f.write(credentials_hash.to_json)