google-api-client 0.32.1 → 0.40.0

data/Gemfile

@@ -22,6 +22,7 @@ group :development do
   gem 'redis', '~> 3.2'
   gem 'logging', '~> 2.2'
   gem 'opencensus', '~> 0.4'
+  gem 'httparty'
 end
 
 platforms :jruby do

data/OVERVIEW.md

@@ -0,0 +1,36 @@
+# Google API Client Library for Ruby Docs
+
+The Google API Client Library for Ruby is designed for Ruby
+client-application developers. It offers simple, flexible
+access to many Google APIs.
+
+## Features
+
+- Call Google APIs simply
+- Handle Auth with fewer lines of code
+- Use standard tooling for installation
+
+## Documentation
+
+Learn how to use the Google API Client Library for Ruby with these guides:
+
+### Usage Guides
+
+- {file:docs/getting-started.md Getting Started}
+- {file:docs/installation.md Installation}
+- {file:docs/auth.md Auth}
+  - {file:docs/api-keys.md API Keys}
+  - {file:docs/oauth.md OAuth 2.0}
+  - {file:docs/oauth-web.md OAuth 2.0 for Web Server Applications}
+  - {file:docs/oauth-installed.md OAuth 2.0 for Installed Applications}
+  - {file:docs/oauth-server.md OAuth 2.0 for Server to Server Applications}
+  - {file:docs/client-secrets.md Client Secrets}
+- How to...
+  - {file:docs/logging.md Use Logging}
+  - {file:docs/media-upload.md Upload Media}
+  - {file:docs/pagination.md Use Pagination}
+  - {file:docs/performance.md Improve Performance}
+
+### Reference Documentation
+
+- Reference documentation for [google-api-client](https://googleapis.dev/ruby/google-api-client/latest/index.html).

data/README.md

@@ -1,4 +1,4 @@
-# Google API Client [![RubyDoc](https://img.shields.io/badge/RubyDoc-Google%3A%3AApis-red.svg)](https://www.rubydoc.info/github/googleapis/google-api-ruby-client/Google/Apis) [![Gem Version](https://badge.fury.io/rb/google-api-client.svg)](https://badge.fury.io/rb/google-api-client)
+# Google API Client [![Documentation](https://img.shields.io/badge/docs-Google%3A%3AApis-red.svg)](https://googleapis.dev/ruby/google-api-client/latest/Google/Apis.html) [![Gem Version](https://badge.fury.io/rb/google-api-client.svg)](https://badge.fury.io/rb/google-api-client)
 
 These client libraries are officially supported by Google.  However, the libraries are considered complete and are in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.
 
@@ -10,12 +10,37 @@ For Google Cloud Platform APIs such as Datastore, Cloud Storage or Pub/Sub, we r
 
 See [MIGRATING](MIGRATING.md) for additional details on how to migrate to the latest version.
 
+## Documentation
+
+Learn how to use the Google API Client Library for Ruby with these guides:
+
+### Usage Guides
+
+- [Getting Started](docs/getting-started.md)
+- [Installation](docs/installation.md)
+- [Auth](docs/auth.md)
+  - [API Keys](docs/api-keys.md)
+  - [OAuth 2.0](docs/oauth.md)
+  - [OAuth 2.0 for Web Server Applications](docs/oauth-web.md)
+  - [OAuth 2.0 for Installed Applications](docs/oauth-installed.md)
+  - [OAuth 2.0 for Server to Server Applications](docs/oauth-server.md)
+  - [Client Secrets](docs/client-secrets.md)
+- How to...
+  - [Use Logging](docs/logging.md)
+  - [Upload Media](docs/media-upload.md)
+  - [Use Pagination](docs/pagination.md)
+  - [Improve Performance](docs/performance.md)
+
+### Reference Documentation
+
+- Reference documentation for [google-api-client](https://googleapis.dev/ruby/google-api-client/latest/index.html).
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'google-api-client', '~> 0.11'
+gem 'google-api-client', '~> 0.34'
 
 ```
 
@@ -53,6 +78,29 @@ metadata = drive.insert_file(metadata, upload_source: 'test.txt', content_type:
 # Download a file
 drive.get_file(metadata.id, download_dest: '/tmp/myfile.txt')
 ```
+
+An example to use the Content API (Google Merchant Center)
+
+```ruby
+require 'google/apis/content_v2'
+require 'googleauth' # https://github.com/googleapis/google-auth-library-ruby
+
+Content = Google::Apis::ContentV2 # Alias the module
+content = Content::ShoppingContentService.new
+
+scope = 'https://www.googleapis.com/auth/content'
+merchant_id = # Merchant ID found on dashboard
+
+content.authorization = Google::Auth::ServiceAccountCredentials.make_creds(
+  json_key_io: File.open('./content-api-key.json'),
+  scope: scope)
+
+content.authorization.fetch_access_token!
+# Service methods: https://googleapis.dev/ruby/google-api-client/latest/Google/Apis/ContentV2/ShoppingContentService.html
+content.list_datafeeds(merchant_id) # Returns Google::Apis::ContentV2::ListDatafeedsResponse
+
+```
+
 ### Naming conventions vs JSON representation
 
 Object properties in the ruby client use the standard ruby convention for naming -- snake_case. This differs from the underlying JSON representation which typically uses camelCase for properties. There are a few notable exceptions to this rule:

data/Rakefile

@@ -1,4 +1,51 @@
 require "bundler/gem_tasks"
+require "json"
+
+task :release_gem, :tag do |_t, args|
+  tag = args[:tag]
+  raise "You must provide a tag to release." if tag.nil?
+
+  # Verify the tag format "vVERSION"
+  m = tag.match(/v(?<version>\S*)/)
+  raise "Tag #{tag} does not match the expected format." if m.nil?
+
+  version = m[:version]
+  raise "You must provide a version." if version.nil?
+
+  api_token = ENV["RUBYGEMS_API_TOKEN"]
+
+  require "gems"
+  if api_token
+    ::Gems.configure do |config|
+      config.key = api_token
+    end
+  end
+
+  Bundler.with_clean_env do
+    sh "rm -rf pkg"
+    sh "bundle update"
+    sh "bundle exec rake build"
+  end
+
+  path_to_be_pushed = "pkg/google-api-client-#{version}.gem"
+  gem_was_published = nil
+  if File.file? path_to_be_pushed
+    begin
+      response = ::Gems.push File.new(path_to_be_pushed)
+      puts response
+      raise unless response.include? "Successfully registered gem:"
+      gem_was_published = true
+      puts "Successfully built and pushed google-api-client for version #{version}"
+    rescue StandardError => e
+      gem_was_published = false
+      puts "Error while releasing google-api-client version #{version}: #{e.message}"
+    end
+  else
+    raise "Cannot build google-api-client for version #{version}"
+  end
+
+  Rake::Task["kokoro:publish_docs"].invoke if gem_was_published
+end
 
 task default: :spec
 
@@ -22,13 +69,35 @@ namespace :kokoro do
   task :nightly do
     Rake::Task["spec"].invoke
   end
+
+  task :post do
+    require_relative "rakelib/devsite/link_checker.rb"
+
+    link_checker = LinkChecker.new
+    link_checker.run
+    exit link_checker.exit_status
+  end
+
+  task :release do
+    # Until code generation process is updated and release-please is set up, just publish docs
+    require_relative "rakelib/devsite/devsite_builder.rb"
+
+    DevsiteBuilder.new.publish_if_missing ENV["DOCS_BUILD_TAG"]
+  end
+
+  desc "Publish docs for the latest git tag"
+  task :publish_docs do
+    require_relative "rakelib/devsite/devsite_builder.rb"
+
+    DevsiteBuilder.new.publish ENV["DOCS_BUILD_TAG"]
+  end
 end
 
 def header str, token = "#"
   line_length = str.length + 8
-  puts ""
+  puts
   puts token * line_length
   puts "#{token * 3} #{str} #{token * 3}"
   puts token * line_length
-  puts ""
+  puts
 end

data/api_list_config.yaml

@@ -0,0 +1 @@
+exclude: []

data/api_names.yaml

@@ -965,6 +965,8 @@
 "/sheets:v4/sheets.spreadsheets.sheets.copyTo": copy_spreadsheet
 "/sheets:v4/sheets.spreadsheets.values.batchGet": batch_get_spreadsheet_values
 "/sheets:v4/sheets.spreadsheets.values.get": get_spreadsheet_values
+"/spanner:v1/spanner.projects.instances.backupOperations.list": list_project_instance_backupoperations
+"/spanner:v1/spanner.projects.instances.databaseOperations.list": list_project_instance_databaseoperations
 "/sqladmin:v1beta4/BackupRunsListResponse": list_backup_runs_response
 "/sqladmin:v1beta4/DatabasesListResponse": list_databases_response
 "/sqladmin:v1beta4/FlagsListResponse": list_flags_response

data/bin/generate-api

@@ -10,6 +10,7 @@ end
 require 'open-uri'
 require 'google/apis/discovery_v1'
 require 'logger'
+require 'psych'
 
 module Google
   class ApiGenerator < Thor
@@ -58,7 +59,7 @@ module Google
         Array(urls).each do |url|
           begin
             json = discovery.http(:get, url)
-          rescue Google::Apis::ClientError
+          rescue Google::Apis::Error
             warn sprintf('Failed request, skipping %s', url)
             next
           end
@@ -77,8 +78,11 @@ module Google
       def generate_from_discovery(preferred_only: false)
         say 'Fetching API list'
         apis = discovery.list_apis
+        exclude_apis = api_list_config["exclude"] || []
         apis.items.each do |api|
-          if (preferred_only && !api.preferred?)
+          if exclude_apis.include? "#{api.name}.#{api.version}"
+            say "Ignoring excluded API #{api.name} #{api.version}"
+          elsif (preferred_only && !api.preferred?)
             say sprintf('Ignoring disoverable API %s', api.id)
           else
 	    # The Discovery service may returned cached versions of a Discovery document that are
@@ -109,6 +113,10 @@ module Google
         @generator ||= Google::Apis::Generator.new(api_names: options[:names], api_names_out: options[:names_out])
       end
 
+      def api_list_config
+        @api_list_config ||= Psych.load_file(__dir__ + "/../api_list_config.yaml")
+      end
+
       def ensure_active_support
         begin
           require 'active_support/inflector'

data/docs/api-keys.md

@@ -0,0 +1,20 @@
+# API Keys
+
+When calling APIs that do not access private user data, you can use simple API keys. These keys are used to authenticate your application for accounting purposes. The Google Developers Console documentation also describes [API keys](https://developers.google.com/console/help/using-keys).
+
+> Note: If you do need to access private user data, you must use OAuth 2.0. See [Using OAuth 2.0 for Installed Applications](oauth-installed.md), [Using OAuth 2.0 for Server to Server Applications](oauth-server.md), and [Using OAuth 2.0 for Web Server Applications](oauth-web.md) for more information.
+
+## Using API Keys
+
+To use API keys, set the `key` attribute on service objects. For example:
+
+```ruby
+require 'google/apis/translate_v2'
+
+translate = Google::Apis::TranslateV2::TranslateService.new
+translate.key = 'YOUR_API_KEY_HERE'
+result = translate.list_translations('Hello world!', 'es', source: 'en')
+puts result.translations.first.translated_text
+```
+
+All calls made using that service object will include your API key.

data/docs/auth.md

@@ -0,0 +1,53 @@
+# Authentication Overview
+
+This document is an overview of how authentication, authorization, and accounting are accomplished. For all API calls, your application needs to be authenticated. When an API accesses a user's private data, your application must also be authorized by the user to access the data. For example, accessing a public Google+ post would not require user authorization, but accessing a user's private calendar would. Also, for quota and billing purposes, all API calls involve accounting. This document summarizes the protocols used by Google APIs and provides links to more information.
+
+## Access types
+
+It is important to understand the basics of how API authentication and authorization are handled. All API calls must use either simple or authorized access (defined below). Many API methods require authorized access, but some can use either. Some API methods that can use either behave differently, depending on whether you use simple or authorized access. See the API's method documentation to determine the appropriate access type.
+
+### 1. Simple API access (API keys)
+
+These API calls do not access any private user data. Your application must authenticate itself as an application belonging to your Google API Console project. This is needed to measure project usage for accounting purposes.
+
+**API key:** To authenticate your application, use an [API key](api-keys.md) for your API Console project. Every simple access call your application makes must include this key.
+
+> **Warning:** Keep your API key private. If someone obtains your key, they could use it to consume your quota or incur charges against your API Console project.
+
+### 2. Authorized API access (OAuth 2.0)
+
+These API calls access private user data. Before you can call them, the user that has access to the private data must grant your application access. Therefore, your application must be authenticated, the user must grant access for your application, and the user must be authenticated in order to grant that access. All of this is accomplished with OAuth 2.0 and libraries written for it.
+
+**Scope:** Each API defines one or more scopes that declare a set of operations permitted. For example, an API might have read-only and read-write scopes. When your application requests access to user data, the request must include one or more scopes. The user needs to approve the scope of access your application is requesting.
+
+**Refresh and access tokens:** When a user grants your application access, the OAuth 2.0 authorization server provides your application with refresh and access tokens. These tokens are only valid for the scope requested. Your application uses access tokens to authorize API calls. Access tokens expire, but refresh tokens do not. Your application can use a refresh token to acquire a new access token.
+
+> **Warning:** Keep refresh and access tokens private. If someone obtains your tokens, they could use them to access private user data.
+
+**Client ID and client secret:** These strings uniquely identify your application and are used to acquire tokens. They are created for your project on the [API Console](https://console.developers.google.com/). There are three types of client IDs, so be sure to get the correct type for your application:
+
+- [Web application](https://developers.google.com/accounts/docs/OAuth2WebServer) client IDs
+- [Installed application](https://developers.google.com/accounts/docs/OAuth2InstalledApp) client IDs
+- [Service Account](https://developers.google.com/accounts/docs/OAuth2ServiceAccount) client IDs
+
+> **Warning:** Keep your client secret private. If someone obtains your client secret, they could use it to consume your quota, incur charges against your Console project, and request access to user data.
+
+## Using API keys
+
+More information and examples for API keys are provided on the [API Keys](api-keys.md) page.
+
+## Using OAuth 2.0
+
+More information and examples for OAuth 2.0 are provided on the [OAuth 2.0](oauth.md) page.
+
+## Using environment variables
+
+The [GoogleAuth Library for Ruby](https://github.com/google/google-auth-library-ruby) also supports authorization via
+environment variables if you do not want to check in developer credentials
+or private keys. Simply set the following variables for your application:
+
+```sh
+GOOGLE_ACCOUNT_TYPE="YOUR ACCOUNT TYPE" # ie. 'service'
+GOOGLE_CLIENT_EMAIL="YOUR GOOGLE DEVELOPER EMAIL"
+GOOGLE_PRIVATE_KEY="YOUR GOOGLE DEVELOPER API KEY"
+```

data/docs/client-secrets.md

@@ -0,0 +1,69 @@
+# Client Secrets
+
+The Google APIs Client Library for Ruby uses the `client_secrets.json` file format for storing the `client_id`, `client_secret`, and other OAuth 2.0 parameters.
+
+See [Creating authorization credentials](https://developers.google.com/identity/protocols/OAuth2WebServer#creatingcred) for how to obtain a `client_secrets.json` file.
+
+The `client_secrets.json` file format is a [JSON](http://www.json.org/) formatted file containing the client ID, client secret, and other OAuth 2.0 parameters. Here is an example client_secrets.json file for a web application:
+
+```json
+{
+  "web": {
+    "client_id": "asdfjasdljfasdkjf",
+    "client_secret": "1912308409123890",
+    "redirect_uris": ["https://www.example.com/oauth2callback"],
+    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+    "token_uri": "https://accounts.google.com/o/oauth2/token"
+  }
+}
+```
+
+Here is an example client_secrets.json file for an installed application:
+
+```json
+{
+  "installed": {
+    "client_id": "837647042410-75ifg...usercontent.com",
+    "client_secret":"asdlkfjaskd",
+    "redirect_uris": ["http://localhost", "urn:ietf:wg:oauth:2.0:oob"],
+    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+    "token_uri": "https://accounts.google.com/o/oauth2/token"
+  }
+}
+```
+
+The format defines one of two client ID types:
+
+- `web`: Web application.
+- `installed`: Installed application.
+
+The `web` and `installed` sub-objects have the following mandatory members:
+
+- `client_id` (string): The client ID.
+- `client_secret` (string): The client secret.
+- `redirect_uris` (list of strings): A list of valid redirection endpoint URIs. This list should match the list entered for the client ID on the [API Access pane](https://code.google.com/apis/console#:access) of the Google APIs Console.
+- `auth_uri` (string): The authorization server endpoint URI.
+- `token_uri` (string): The token server endpoint URI.
+
+All of the above members are mandatory. The following optional parameters may appear:
+
+- `client_email` (string) The service account email associated with the client.
+- `auth_provider_x509_cert_url` (string) The URL of the public x509 certificate, used to verify the signature on JWTs, such as ID tokens, signed by the authentication provider.
+- `client_x509_cert_url` (string) The URL of the public x509 certificate, used to verify JWTs signed by the client.
+
+The following shows how you can use a client_secrets.json file and the Google::APIClient::ClientSecrets class to create a new authorization object:
+
+```rb
+require 'google/api_client/client_secrets'
+
+CLIENT_SECRETS = Google::APIClient::ClientSecrets.load
+authorization = CLIENT_SECRETS.to_authorization
+
+# You can then use this with an API client, e.g.:
+client.authorization = authorization
+```
+
+## Motivation
+
+Traditionally providers of OAuth endpoints have relied upon cut-and-paste as the way users of their service move the client id and secret from a registration page into working code. That can be error prone, along with it being an incomplete picture of all the information that is needed to get OAuth 2.0 working, which requires knowing all the endpoints and configuring a Redirect Endpoint. If service providers start providing a downloadable client_secrets.json file for client information and client libraries start consuming client_secrets.json then a large amount of friction in implementing OAuth 2.0 can be reduced.
+