google-cloud-translate 2.3.0 → 3.1.0

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.5+.
+
+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.5
+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

data/lib/google/cloud/translate.rb

@@ -1,4 +1,6 @@
-# Copyright 2019 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,203 +14,102 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# Require this file early so that the version constant gets defined before
+# requiring "google/cloud". This is because google-cloud-core will load the
+# entrypoint (gem name) file, which in turn re-requires this file (hence
+# causing a require cycle) unless the version constant is already defined.
+require "google/cloud/translate/version"
 
-require "google-cloud-translate"
+require "googleauth"
+gem "google-cloud-core"
+require "google/cloud" unless defined? ::Google::Cloud.new
 require "google/cloud/config"
-require "google/gax"
-require "pathname"
+
+# Set the default configuration
+::Google::Cloud.configure.add_config! :translate do |config|
+  config.add_field! :endpoint,      "translate.googleapis.com", match: ::String
+  config.add_field! :credentials,   nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
+  config.add_field! :scope,         nil, match: [::Array, ::String]
+  config.add_field! :lib_name,      nil, match: ::String
+  config.add_field! :lib_version,   nil, match: ::String
+  config.add_field! :interceptors,  nil, match: ::Array
+  config.add_field! :timeout,       nil, match: ::Numeric
+  config.add_field! :metadata,      nil, match: ::Hash
+  config.add_field! :retry_policy,  nil, match: [::Hash, ::Proc]
+  config.add_field! :quota_project, nil, match: ::String
+end
 
 module Google
   module Cloud
-    ##
-    # # Google Cloud Translation API
-    #
-    # [Google Cloud Translation API](https://cloud.google.com/translation/)
-    # provides a simple, programmatic interface for translating an arbitrary
-    # string into any supported language. It is highly responsive, so websites
-    # and applications can integrate with Translation API for fast, dynamic
-    # translation of source text. Language detection is also available in cases
-    # where the source language is unknown.
-    #
-    # Translation API supports more than one hundred different languages, from
-    # Afrikaans to Zulu. Used in combination, this enables translation between
-    # thousands of language pairs. Also, you can send in HTML and receive HTML
-    # with translated text back. You don't need to extract your source text or
-    # reassemble the translated content.
-    #
-    # The google-cloud-translate 2.0 gem contains a generated v3 client and a legacy hand-written v2 client.
-    # To use the legacy v2 client, call {Google::Cloud::Translate.new} and specify `version: :v2`.
-    # See [Migrating to Translation v3](https://cloud.google.com/translate/docs/migrate-to-v3) for details regarding
-    # differences between v2 and v3.
-    #
-    # See {file:OVERVIEW.md Translation Overview}.
-    #
     module Translate
-      FILE_DIR = File.realdirpath Pathname.new(__FILE__).join("..").join("translate")
-
-      AVAILABLE_VERSIONS = Dir["#{FILE_DIR}/*"]
-                           .select { |file| File.directory? file }
-                           .select { |dir| Google::Gax::VERSION_MATCHER.match File.basename(dir) }
-                           .select { |dir| File.exist? dir + ".rb" }
-                           .map { |dir| File.basename dir }
-
       ##
-      # Provides natural language translation operations.
-      #
-      # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
-      #   @param version [Symbol, String]
-      #     The major version of the service to be used. By default `:v3` is used.
-      #   @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel,
-      #     GRPC::Core::ChannelCredentials, Proc]
-      #     Provides the means for authenticating requests made by the client. This parameter can be many types.
-      #     A `Google::Auth::Credentials` uses a the properties of its represented keyfile for authenticating requests
-      #     made by this client.
-      #     A `String` will be treated as the path to the keyfile to be used for the construction of credentials for
-      #     this client.
-      #     A `Hash` will be treated as the contents of a keyfile to be used for the construction of credentials for
-      #     this client.
-      #     A `GRPC::Core::Channel` will be used to make calls through.
-      #     A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials should already
-      #     be composed with a `GRPC::Core::CallCredentials` object.
-      #     A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for
-      #     requests, generally, to give OAuth credentials.
-      #   @param scopes [Array<String>]
-      #     The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.
-      #   @param client_config [Hash]
-      #     A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data.
-      #     Falls back to the default config if not specified or the specified config is missing data points.
-      #   @param timeout [Numeric]
-      #     The default timeout, in seconds, for calls made through this client.
-      #   @param metadata [Hash]
-      #     Default metadata to be sent with each request. This can be overridden on a per call basis.
-      #   @param service_address [String]
-      #     Override for the service hostname, or `nil` to leave as the default.
-      #   @param service_port [Integer]
-      #     Override for the service port, or `nil` to leave as the default.
-      #   @param exception_transformer [Proc]
-      #     An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.
-      # @overload new(version:, project_id:, credentials:, key:, scope:, retries:, timeout:, endpoint:)
-      #   @param version [Symbol, String]
-      #     The major version of the service to be used. Specifying `:v2` will return the legacy client.
-      #   @param [String] project_id Project identifier for the Cloud Translation service you are connecting to. If not
-      #     present, the default project for the credentials is used.
-      #   @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::V2::Credentials})
-      #   @param [String] key a public API access key (not an OAuth 2.0 token)
-      #   @param [String, Array<String>] scope 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 scope is:
-      #
-      #     * `https://www.googleapis.com/auth/cloud-platform`
-      #   @param [Integer] retries Number of times to retry requests on server error. The default value is `3`.
-      #     Optional.
-      #   @param [Integer] timeout Default timeout to use in requests. Optional.
-      #   @param [String] endpoint Override of the endpoint host name. Optional. If the param is nil, uses the default
-      #     endpoint.
-      #
-      # @example Using the v3 client.
-      #   require "google/cloud/translate"
-      #
-      #   client = Google::Cloud::Translate.new
-      #
-      #   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
+      # Create a new client object for TranslationService.
       #
-      #   response = client.translate_text contents, target_language, parent,
-      #     source_language_code: source_language, model: model, mime_type: mime_type
+      # By default, this returns an instance of
+      # [Google::Cloud::Translate::V3::TranslationService::Client](https://googleapis.dev/ruby/google-cloud-translate-v3/latest/Google/Cloud/Translate/V3/TranslationService/Client.html)
+      # for version V3 of the API.
+      # However, you can specify specify a different API version by passing it in the
+      # `version` parameter. If the TranslationService service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
       #
-      #   # Display the translation for each input text provided
-      #   response.translations.each do |translation|
-      #     puts "Translated text: #{translation.translated_text}"
-      #   end
+      # ## About TranslationService
       #
-      # @example Using the legacy v2 client.
-      #   require "google/cloud/translate"
-      #
-      #   translate = Google::Cloud::Translate.new(
-      #     version: :v2,
-      #     project_id: "my-todo-project",
-      #     credentials: "/path/to/keyfile.json"
-      #   )
-      #
-      #   translation = translate.translate "Hello world!", to: "la"
-      #   translation.text #=> "Salve mundi!"
-      #
-      # @example Using the legacy v2 client with an API Key.
-      #   require "google/cloud/translate"
-      #
-      #   translate = Google::Cloud::Translate.new(
-      #     version: :v2,
-      #     key: "api-key-abc123XYZ789"
-      #   )
-      #
-      #   translation = translate.translate "Hello world!", to: "la"
-      #   translation.text #=> "Salve mundi!"
-      #
-      # @example Using API Key from the environment variable.
-      #   require "google/cloud/translate"
-      #
-      #   ENV["TRANSLATE_KEY"] = "api-key-abc123XYZ789"
-      #
-      #   translate = Google::Cloud::Translate.new version: :v2
+      # Provides natural language translation operations.
       #
-      #   translation = translate.translate "Hello world!", to: "la"
-      #   translation.text #=> "Salve mundi!"
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v3`.
+      # @return [TranslationService::Client] A client object for the specified version.
       #
-      def self.new *args, version: :v3, **kwargs
-        unless AVAILABLE_VERSIONS.include? version.to_s.downcase
-          raise "The version: #{version} is not available. The available versions " \
-            "are: [#{AVAILABLE_VERSIONS.join ', '}]"
-        end
+      def self.translation_service version: :v3, &block
+        require "google/cloud/translate/#{version.to_s.downcase}"
 
-        require "#{FILE_DIR}/#{version.to_s.downcase}"
-        version_module = Google::Cloud::Translate
-                         .constants
-                         .select { |sym| sym.to_s.casecmp(version.to_s).zero? }
-                         .first
-        Google::Cloud::Translate.const_get(version_module).new(*args, **kwargs)
+        package_name = Google::Cloud::Translate
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        package_module = Google::Cloud::Translate.const_get package_name
+        package_module.const_get(:TranslationService).const_get(:Client).new(&block)
       end
 
       ##
-      # Configure the Google Cloud Translate library.
-      #
-      # The following Translate configuration parameters are supported:
-      #
-      # * `project_id` - (String) Identifier for a Translate project.
-      # * `credentials` - (String, Hash, Google::Auth::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::V2::Credentials})
-      # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling the set of resources and operations that
-      #   the connection can access.
-      # * `retries` - (Integer) Number of times to retry requests on server error.
-      # * `timeout` - (Integer) Default timeout to use in requests.
-      # * `endpoint` - (String) Override of the endpoint host name, or `nil` to use the default endpoint.
-      #
-      # @note These values are only used by the legacy v2 client.
-      #
-      # @return [Google::Cloud::Config] The configuration object the Google::Cloud::Translate library uses.
+      # Configure the google-cloud-translate library.
+      #
+      # The following configuration parameters are supported:
+      #
+      # * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
+      #   The path to the keyfile as a String, the contents of the keyfile as a
+      #   Hash, or a Google::Auth::Credentials object.
+      # * `lib_name` (*type:* `String`) -
+      #   The library name as recorded in instrumentation and logging.
+      # * `lib_version` (*type:* `String`) -
+      #   The library version as recorded in instrumentation and logging.
+      # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
+      #   An array of interceptors that are run before calls are executed.
+      # * `timeout` (*type:* `Numeric`) -
+      #   Default timeout in seconds.
+      # * `metadata` (*type:* `Hash{Symbol=>String}`) -
+      #   Additional gRPC headers to be sent with the call.
+      # * `retry_policy` (*type:* `Hash`) -
+      #   The retry policy. The value is a hash with the following keys:
+      #     * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+      #     * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+      #     * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+      #     * `:retry_codes` (*type:* `Array<String>`) -
+      #       The error codes that should trigger a retry.
+      #
+      # @return [::Google::Cloud::Config] The default configuration used by this library
       #
       def self.configure
-        yield Google::Cloud.configure.translate if block_given?
+        yield ::Google::Cloud.configure.translate if block_given?
 
-        Google::Cloud.configure.translate
+        ::Google::Cloud.configure.translate
       end
     end
   end
 end
+
+helper_path = ::File.join __dir__, "translate", "helpers.rb"
+require "google/cloud/translate/helpers" if ::File.file? helper_path