google-cloud-translate 2.2.0 → 3.0.3

data/MIGRATING.md

@@ -0,0 +1,302 @@
+## Migrating to google-cloud-translate 3.0
+
+The 3.0 release of the google-cloud-translate client is a significant upgrade
+based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
+and includes substantial interface changes. Existing code written for earlier
+versions of this library will likely require updates to use this version.
+This document describes the changes that have been made, and what you need to
+do to update your usage.
+
+To summarize:
+
+ *  The library has been broken out into three libraries. The new gems
+    `google-cloud-translate-v2` and `google-cloud-translate-v3` contain the
+    actual client classes for versions V2 and V3 of the Translation
+    service, and the gem `google-cloud-translate` now simply provides a
+    convenience wrapper. See [Library Structure](#library-structure) for more
+    info.
+ *  When creating V3 client objects, you customize the configuration in a block
+    instead of passing arguments to the constructor. See
+    [Creating Clients](#creating-clients) for more info. When creating V2
+    clients, however, pass settings arguments as before.
+ *  Previously, positional arguments were used to indicate required arguments.
+    Now, in the V3 client, all method arguments are keyword arguments, with
+    documentation that specifies whether they are required or optional.
+    Additionally, you can pass a proto request object instead of separate
+    arguments. See [Passing Arguments](#passing-arguments) for more info. V2
+    client methods, however, remain unchanged.
+ *  Previously, some V3 client classes included class methods for constructing
+    resource paths. These paths are now instance methods on the client objects,
+    and are also available in a separate paths module. See
+    [Resource Path Helpers](#resource-path-helpers) for more info.
+ *  Previously, clients reported RPC errors by raising instances of
+    `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
+    `Google::Cloud::Error` and its subclasses. See
+    [Handling Errors](#handling-errors) for more info.
+ *  Some classes have moved into different namespaces. See
+    [Class Namespaces](#class-namespaces) for more info.
+
+### Library Structure
+
+Older releases of the `google-cloud-translate` gem were all-in-one gems that
+included potentially multiple clients for multiple versions of the Translation
+service. The `Google::Cloud::Translate.new` factory method would
+return you an instance of a `Google::Cloud::Translate::V2::Api`
+object for the V2 version of the service, or a
+`Google::Cloud::Translate::V3::TranslationServiceClient` object for the
+V3 version of the service. All these classes were defined in the same gem.
+
+With the 3.0 release, the `google-cloud-translate` gem still provides factory
+methods for obtaining clients. (The method signatures will have changed. See
+[Creating Clients](#creating-clients) for details.) However, the actual client
+classes have been moved into separate gems, one per service version. The
+`Google::Cloud::Translate::V2::Api` class, along with its
+helpers and data types, is now part of the `google-cloud-translate-v2` gem.
+Similarly, the `Google::Cloud::Translate::V3::TranslationService::Client`
+class is part of the `google-cloud-translate-v3` gem. 
+
+For normal usage, you can continue to install the `google-cloud-translate` gem
+(which will bring in the versioned client gems as dependencies) and continue to
+use factory methods to create clients. However, you may alternatively choose to
+install only one of the versioned gems. For example, if you know you will use only
+`V2` of the service, you can install `google-cloud-translate-v2` by itself, and
+call `Google::Cloud::Translate::V2.new` to create V2 clients directly.
+
+### Creating Clients
+
+In older releases, to create a client object, you would use the
+`Google::Cloud::Translate.new` class method. Keyword arguments were available to
+select a service version and to configure parameters such as credentials and
+timeouts. Furthermore, you could configure default parameters using the
+`Google::Cloud::Translate.configure` method.
+
+In the 3.0 release, there are separate class methods for creating clients of the
+modern (V3) and legacy (V2) Translation services. To create a V2 client, use the
+`translation_v2_service` class method, which takes the same keyword arguments
+you would have used previously. To create a V3 (or later) client, use the
+`translation_service` class method and set options in a configuration block.
+
+Old (V3):
+```
+client = Google::Cloud::Translate.new credentials: "/path/to/credentials.json"
+```
+
+Old (V2):
+```
+client = Google::Cloud::Translate.new version: :v2,
+                                      credentials: "/path/to/credentials.json"
+```
+
+New (V3):
+```
+# Call the translation_service method to create a V3 client,
+# and pass a block to configure the client.
+client = Google::Cloud::Translate.translation_service do |config|
+  config.credentials = "/path/to/credentials.json"
+end
+
+# You can omit the block if you're keeping the default configuration
+default_client = Google::Cloud::Translate.translation_service
+```
+
+New (V2):
+```
+# Call the separate translation_v2_service method to create a legacy V2 client,
+# and pass configuration as keyword arguments.
+client = Google::Cloud::Translate.translation_v2_service(
+  credentials: "/path/to/credentials.json")
+```
+
+### Passing Arguments
+
+In older releases, required arguments would be passed as positional method
+arguments, while most optional arguments would be passed as keyword arguments.
+
+With the 3.0 release, the V2 client interface remains the same, but in the V3
+client interface, all RPC arguments are passed as keyword arguments, regardless
+of whether they are required or optional. For example:
+
+Old (V3):
+```
+client = Google::Cloud::Translate.new
+
+# Contents, target language, and project are positional arguments, but
+# mime type is a keyword argument
+response = client.translate_text ["Hello, world!"], "es", "my-project",
+                                 mime_type: "text/plain"
+```
+
+New (V3):
+```
+client = Google::Cloud::Translate.translation_service
+
+# All arguments are keyword arguments
+response = client.translate_text content: ["Hello, world!"],
+                                 target_language_code: "es",
+                                 parent: "my-project",
+                                 mime_type: "text/plain"
+```
+
+In the 3.0 release, it is also possible to pass a request object, either
+as a hash or as a protocol buffer.
+
+New (V3):
+```
+client = Google::Cloud::Translate.translation_service
+
+request = Google::Cloud::Translate::V3::TranslateTextRequest.new(
+  content: ["Hello, world!"],
+  target_language_code: "es",
+  parent: "my-project",
+  mime_type: "text/plain"
+)
+
+# Pass a request object as a positional argument:
+response = client.translate_text request
+```
+
+Finally, in older releases, to provide call options, you would pass a
+`Google::Gax::CallOptions` object with the `:options` keyword argument. In the
+3.0 release, pass call options using a _second set_ of keyword arguments.
+
+Old (V3):
+```
+client = Google::Cloud::Translate.new
+
+options = Google::Gax::CallOptions.new timeout: 10.0
+
+response = client.translate_text ["Hello, world!"], "es", "my-project",
+                                 mime_type: "text/plain",
+                                 options: options
+```
+
+New (V3):
+```
+client = Google::Cloud::Translate.translation_service
+
+# Use a hash to wrap the normal call arguments (or pass a request object), and
+# then add further keyword arguments for the call options.
+response = client.translate_text(
+  { content: ["Hello, world!"], target_language_code: "es",
+    parent: "my-project", mime_type: "text/plain" },
+  timeout: 10.0
+)
+```
+
+### Resource Path Helpers
+
+The client library for the V3 service includes helper methods for generating
+the resource path strings passed to many calls. These helpers have changed in
+two ways:
+
+* In older releases, they are _class_ methods on the client class. In the 1.0
+  release, they are _instance_ methods on the client. They are also available
+  on a separate paths module that you can include elsewhere for convenience.
+* In older releases, arguments to a resource path helper are passed as
+  _positional_ arguments. In the 3.0 release, they are passed as named _keyword_
+  arguments.
+
+Following is an example involving using a resource path helper.
+
+Old (V3):
+```
+client = Google::Cloud::Translate.new
+
+# Call the helper on the client class
+name = Google::Cloud::Translate::V3::TranslationServiceClient.glossary_path(
+  "my-project", "my-location", "my-glossary"
+)
+
+response = client.get_glossary name
+```
+
+New (V3):
+```
+client = Google::Cloud::Translate.translation_service
+
+# Call the helper on the client instance, and use keyword arguments
+name = client.glossary_path project: "my-project", location: "my-location",
+                            glossary: "my-glossary"
+
+response = client.get_glossary name: name
+```
+
+In the 3.0 client, you can also use the paths module as a convenience module.
+
+New (V3):
+```
+# Bring the path methods into the current class
+include Google::Cloud::Translate::V3::TranslationService::Paths
+
+def foo
+  client = Google::Cloud::Translate.translation_service
+
+  # Call the included helper method
+  name = glossary_path project: "my-project", location: "my-location",
+                       glossary: "my-glossary"
+
+  response = client.get_glossary name: name
+
+  # Do something with response...
+end
+```
+
+### Handling Errors
+
+The client reports standard
+[gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
+by raising exceptions. In older releases, these exceptions were located in the
+`Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
+exception class, defined in the `google-gax` gem. However, these classes were
+different from the standard exceptions (subclasses of `Google::Cloud::Error`)
+thrown by other client libraries such as `google-cloud-storage`.
+
+The 3.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
+for consistency across all the Google Cloud client libraries. In general, these
+exceptions have the same name as their counterparts from older releases, but
+are located in the `Google::Cloud` namespace rather than the `Google::Gax`
+namespace.
+
+Old (V3):
+```
+client = Google::Cloud::Translate.new
+
+begin
+  response = client.translate_text ["Hello, world!"], "es", "my-project",
+                                   mime_type: "text/plain"
+rescue Google::Gax::Error => e
+  # Handle exceptions that subclass Google::Gax::Error
+end
+```
+
+New (V3):
+```
+client = Google::Cloud::Translate.translation_service
+
+begin
+  response = client.translate_text content: ["Hello, world!"],
+                                  target_language_code: "es",
+                                  parent: "my-project",
+                                  mime_type: "text/plain"
+rescue Google::Cloud::Error => e
+  # Handle exceptions that subclass Google::Cloud::Error
+end
+```
+
+### Class Namespaces
+
+In older releases, the client object for V3 was of class
+`Google::Cloud::Translate::V3::TranslationServiceClient`.
+In the 3.0 release, the client object is of class
+`Google::Cloud::Translate::V3::TranslationService::Client`.
+Note that most users will use the `Google::Cloud::Translate.translation_service`
+factory method to create instances of the client object, so you may not need to
+reference the actual class directly. See [Creating Clients](#creating-clients).
+
+In older releases, the V3 credentials object was of class
+`Google::Cloud::Translate::V3::Credentials`.
+In the 3.0 release, the credentials object is of class
+`Google::Cloud::Translate::V3::TranslationService::Credentials`.
+Again, most users will not need to reference this class directly.
+
+The V2 classes have not been renamed.

data/README.md

@@ -0,0 +1,139 @@
+# Ruby Client for the Cloud Translation API
+
+API Client library for the Cloud Translation API
+
+Cloud Translation can dynamically translate text between thousands of language pairs. Translation lets websites and programs programmatically integrate with the translation service.
+
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `google-cloud-translate-v*`.
+The gem `google-cloud-translate` is the main client library that brings the
+verisoned gems in as dependencies, and provides high-level methods for
+constructing clients. More information on versioned clients can be found below
+in the section titled *Which client should I use?*.
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-translate/latest)
+for this library, google-cloud-translate, to see the convenience methods for
+constructing client objects. Reference documentation for the client objects
+themselves can be found in the client library documentation for the versioned
+client gems:
+[google-cloud-translate-v2](https://googleapis.dev/ruby/google-cloud-translate-v2/latest),
+[google-cloud-translate-v3](https://googleapis.dev/ruby/google-cloud-translate-v3/latest).
+
+See also the [Product Documentation](https://cloud.google.com/translate)
+for more usage information.
+
+## Quick Start
+
+```
+$ gem install google-cloud-translate
+```
+
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/translate.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Migrating from 2.x versions
+
+The 3.0 release of the google-cloud-translate client is a significant upgrade
+based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
+and includes substantial interface changes. Existing code written for earlier
+versions of this library will likely require updates to use this version.
+See the {file:MIGRATING.md MIGRATING.md} document for more information.
+
+## Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
+## Supported Ruby Versions
+
+This library is supported on Ruby 2.4+.
+
+Google provides official support for Ruby versions that are actively supported
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or
+in security maintenance, and not end of life. Currently, this means Ruby 2.4
+and later. Older versions of Ruby _may_ still work, but are unsupported and not
+recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
+about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-translate`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-translate-v2`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-translate`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-translate-v2`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/google-cloud-translate.rb

@@ -1,4 +1,6 @@
-# Copyright 2016 Google LLC
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,149 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-##
-# This file is here to be autorequired by bundler, so that the
-# Google::Cloud.translate and Google::Cloud#translate methods can be available,
-# but the library and all dependencies won't be loaded until required and used.
-
-
-gem "google-cloud-core"
-require "google/cloud" unless defined? Google::Cloud.new
-require "google/cloud/config"
-require "googleauth"
-
-module Google
-  module Cloud
-    ##
-    # Creates a new object for connecting to the Cloud Translation API. Each call creates a new connection.
-    #
-    # For more information on connecting to Google Cloud see the {file:AUTHENTICATION.md Authentication Guide}.
-    #
-    # To use the legacy v2 client, call {Google::Cloud::Translate.new} and specify `version: :v2`.
-    #
-    # @param [String] key a public API access key (not an OAuth 2.0 token)
-    # @param [String, Array<String>] scopes The OAuth 2.0 scopes controlling the set of resources and operations that
-    #   the connection can access. See [Using OAuth 2.0 to Access Google
-    #   APIs](https://developers.google.com/identity/protocols/OAuth2).
-    #
-    #   The default scopes are:
-    #
-    #   * `https://www.googleapis.com/auth/cloud-platform`
-    #   * `https://www.googleapis.com/auth/cloud-translation`
-    # @param [Integer] timeout Default timeout to use in requests. Optional.
-    #
-    # @return [Google::Cloud::Translate::V3::TranslationServiceClient]
-    #
-    # @example
-    #   require "google/cloud"
-    #
-    #   gcloud = Google::Cloud.new
-    #   client = gcloud.translate
-    #
-    #   project_id = "my-project-id"
-    #   location_id = "us-central1"
-    #   model_id = "my-automl-model-id"
-    #
-    #   # The `model` type requested for this translation.
-    #   model = "projects/#{project_id}/locations/#{location_id}/models/#{model_id}"
-    #   # The content to translate in string format
-    #   contents = ["Hello, world!"]
-    #   # Required. The BCP-47 language code to use for translation.
-    #   target_language = "fr"
-    #   # Optional. The BCP-47 language code of the input text.
-    #   source_language = "en"
-    #   # Optional. Can be "text/plain" or "text/html".
-    #   mime_type = "text/plain"
-    #   parent = client.class.location_path project_id, location_id
-    #
-    #   response = client.translate_text contents, target_language, parent,
-    #     source_language_code: source_language, model: model, mime_type: mime_type
-    #
-    #   # Display the translation for each input text provided
-    #   response.translations.each do |translation|
-    #     puts "Translated text: #{translation.translated_text}"
-    #   end
-    #
-    def translate scopes: nil, timeout: nil
-      Google::Cloud.translate credentials: @keyfile, scopes: scopes, timeout: (timeout || @timeout)
-    end
-
-    ##
-    # Creates a new object for connecting to the Cloud Translation API. Each call creates a new connection.
-    #
-    # For more information on connecting to Google Cloud see the {file:AUTHENTICATION.md Authentication Guide}.
-    #
-    # To use the legacy v2 client, call {Google::Cloud::Translate.new} and specify `version: :v2`.
-    #
-    # @param [String, Hash, Google::Auth::Credentials] credentials The path to the keyfile as a String, the contents of
-    #   the keyfile as a Hash, or a Google::Auth::Credentials object. (See {Google::Cloud::Translate::V3::Credentials})
-    # @param [String, Array<String>] scopes The OAuth 2.0 scopes controlling the set of resources and operations that
-    #   the connection can access. See [Using OAuth 2.0 to Access Google
-    #   APIs](https://developers.google.com/identity/protocols/OAuth2).
-    #
-    #   The default scopes are:
-    #
-    #   * `https://www.googleapis.com/auth/cloud-platform`
-    #   * `https://www.googleapis.com/auth/cloud-translation`
-    # @param [Integer] timeout Default timeout to use in requests. Optional.
-    #
-    # @return [Google::Cloud::Translate::V3::TranslationServiceClient]
-    #
-    # @example
-    #   require "google/cloud"
-    #
-    #   client = Google::Cloud.translate
-    #
-    #   project_id = "my-project-id"
-    #   location_id = "us-central1"
-    #   model_id = "my-automl-model-id"
-    #
-    #   # The `model` type requested for this translation.
-    #   model = "projects/#{project_id}/locations/#{location_id}/models/#{model_id}"
-    #   # The content to translate in string format
-    #   contents = ["Hello, world!"]
-    #   # Required. The BCP-47 language code to use for translation.
-    #   target_language = "fr"
-    #   # Optional. The BCP-47 language code of the input text.
-    #   source_language = "en"
-    #   # Optional. Can be "text/plain" or "text/html".
-    #   mime_type = "text/plain"
-    #   parent = client.class.location_path project_id, location_id
-    #
-    #   response = client.translate_text contents, target_language, parent,
-    #     source_language_code: source_language, model: model, mime_type: mime_type
-    #
-    #   # Display the translation for each input text provided
-    #   response.translations.each do |translation|
-    #     puts "Translated text: #{translation.translated_text}"
-    #   end
-    #
-    def self.translate credentials: nil, scopes: nil, timeout: nil
-      require "google/cloud/translate/v3"
-      Google::Cloud::Translate::V3.new credentials: credentials, scopes: scopes, timeout: timeout
-    end
-  end
-end
-
-# Set the default translate configuration
-Google::Cloud.configure.add_config! :translate do |config|
-  default_project = Google::Cloud::Config.deferred do
-    ENV["TRANSLATE_PROJECT"]
-  end
-  default_creds = Google::Cloud::Config.deferred do
-    Google::Cloud::Config.credentials_from_env(
-      "TRANSLATE_CREDENTIALS", "TRANSLATE_CREDENTIALS_JSON", "TRANSLATE_KEYFILE", "TRANSLATE_KEYFILE_JSON"
-    )
-  end
-  default_key = Google::Cloud::Config.deferred do
-    ENV["TRANSLATE_KEY"] || ENV["GOOGLE_CLOUD_KEY"]
-  end
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-  config.add_field! :project_id, default_project, match: String, allow_nil: true
-  config.add_field! :credentials, default_creds, match: [String, Hash, Google::Auth::Credentials], allow_nil: true
-  config.add_field! :key, default_key, match: String, allow_nil: true
-  config.add_field! :scope, nil, match: [String, Array]
-  config.add_field! :retries, nil, match: Integer
-  config.add_field! :timeout, nil, match: Integer
-  config.add_field! :endpoint, nil, match: String
-end
+require "google/cloud/translate" unless defined? Google::Cloud::Translate::VERSION