google-cloud-translate 2.3.0 → 3.1.0

data/lib/google/cloud/translate/helpers.rb

@@ -0,0 +1,107 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#     https://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.
+
+
+module Google
+  module Cloud
+    module Translate
+      ##
+      # Creates a new object for connecting to the legacy V2 version of the
+      # Cloud Translation API.
+      #
+      # Like other Cloud Platform services, Google Cloud Translation API supports authentication using a project ID
+      # and OAuth 2.0 credentials. In addition, it supports authentication using a public API access key. (If both the
+      # API key and the project and OAuth 2.0 credentials are provided, the API key will be used.) Instructions and
+      # configuration options are covered in the {file:AUTHENTICATION.md Authentication Guide}.
+      #
+      # @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.
+      # @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.
+      #
+      # @return [Google::Cloud::Translate::V2::Api]
+      #
+      # @example
+      #   require "google/cloud/translate/v2"
+      #
+      #   translate = Google::Cloud::Translate::V2.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 API Key.
+      #   require "google/cloud/translate/v2"
+      #
+      #   translate = Google::Cloud::Translate::V2.new(
+      #     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/v2"
+      #
+      #   ENV["TRANSLATE_KEY"] = "api-key-abc123XYZ789"
+      #
+      #   translate = Google::Cloud::Translate::V2.new
+      #
+      #   translation = translate.translate "Hello world!", to: "la"
+      #   translation.text #=> "Salve mundi!"
+      #
+      def self.translation_v2_service project_id: nil,
+                                      credentials: nil,
+                                      key: nil,
+                                      scope: nil,
+                                      retries: nil,
+                                      timeout: nil,
+                                      endpoint: nil
+        require "google/cloud/translate/v2"
+        Google::Cloud::Translate::V2.new project_id:  project_id,
+                                         credentials: credentials,
+                                         key:         key,
+                                         scope:       scope,
+                                         retries:     retries,
+                                         timeout:     timeout,
+                                         endpoint:    endpoint
+      end
+
+      # Additional config keys used by V2
+      configure do |config|
+        config.add_field! :project_id, nil, match: ::String
+        config.add_field! :key,        nil, match: ::String
+        config.add_field! :retries,    nil, match: ::Integer
+      end
+    end
+  end
+end

data/lib/google/cloud/translate/version.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,11 +14,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
 
 module Google
   module Cloud
     module Translate
-      VERSION = "2.3.0".freeze
+      VERSION = "3.1.0"
     end
   end
 end

metadata

@@ -1,187 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-translate
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2021-03-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.17.3
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.17.3
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: google-gax
+  name: google-cloud-translate-v2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: googleapis-common-protos
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: googleapis-common-protos-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: autotest-suffix
+  name: google-cloud-translate-v3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
+        version: '0.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
-  name: minitest-autotest
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: minitest-focus
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -224,22 +164,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard-doctest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
-description: google-cloud-translate is the official library for Cloud Translation
-  API.
+description: Cloud Translation can dynamically translate text between thousands of
+  language pairs. Translation lets websites and programs programmatically integrate
+  with the translation service.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -247,45 +174,18 @@ extra_rdoc_files: []
 files:
 - ".yardopts"
 - AUTHENTICATION.md
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- LICENSE
-- OVERVIEW.md
-- TROUBLESHOOTING.md
+- LICENSE.md
+- MIGRATING.md
+- README.md
 - lib/google-cloud-translate.rb
 - lib/google/cloud/translate.rb
-- lib/google/cloud/translate/v2.rb
-- lib/google/cloud/translate/v2/api.rb
-- lib/google/cloud/translate/v2/credentials.rb
-- lib/google/cloud/translate/v2/detection.rb
-- lib/google/cloud/translate/v2/language.rb
-- lib/google/cloud/translate/v2/service.rb
-- lib/google/cloud/translate/v2/translation.rb
-- lib/google/cloud/translate/v3.rb
-- lib/google/cloud/translate/v3/credentials.rb
-- lib/google/cloud/translate/v3/doc/google/cloud/translate/v3/translation_service.rb
-- lib/google/cloud/translate/v3/doc/google/longrunning/operations.rb
-- lib/google/cloud/translate/v3/doc/google/protobuf/any.rb
-- lib/google/cloud/translate/v3/doc/google/protobuf/timestamp.rb
-- lib/google/cloud/translate/v3/doc/google/rpc/status.rb
-- lib/google/cloud/translate/v3/translation_service_client.rb
-- lib/google/cloud/translate/v3/translation_service_client_config.json
-- lib/google/cloud/translate/v3/translation_service_pb.rb
-- lib/google/cloud/translate/v3/translation_service_services_pb.rb
+- lib/google/cloud/translate/helpers.rb
 - lib/google/cloud/translate/version.rb
-homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-translate
+homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: |
-  The 2.0 release introduces breaking changes by defaulting to a
-  new generated v3 API client. This gem continues to contain the
-  legacy hand-written v2 client for backward compatibility aside
-  from the default client constructor.
-
-  For more details please visit the 2.0.0 CHANGELOG:
-  https://googleapis.dev/ruby/google-cloud-translate/v2.0.0/file.CHANGELOG.html#2_0_0___2019-10-28
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -293,15 +193,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
-summary: API Client library for Cloud Translation API
+summary: API Client library for the Cloud Translation API
 test_files: []

data/CHANGELOG.md

@@ -1,164 +0,0 @@
-# Release History
-
-### 2.3.0 / 2020-03-28
-
-#### Features
-
-* send quota project header in the V2 client
-
-### 2.2.0 / 2020-03-11
-
-#### Features
-
-* Support separate project setting for quota/billing
-
-### 2.1.2 / 2020-03-02
-
-#### Bug Fixes
-
-* support faraday 1.x
-
-### 2.1.1 / 2020-01-23
-
-#### Documentation
-
-* Update copyright year
-* Update Status documentation
-
-### 2.1.0 / 2019-11-06
-
-#### Bug Fixes
-
-* Update minimum runtime dependencies
-  * Fixes an issue where required dependencies may not be used.
-
-### 2.0.0 / 2019-10-28
-
-#### ⚠ BREAKING CHANGES
-
-* Add Translate V3 client
-  * Update google-cloud-translate to contain a generated v3 client
-    as well as the legacy hand-written v2 client.
-  * The following methods now return an instance of
-    Google::Cloud::Translate::V3::TranslationServiceClient:
-    * Google::Cloud#translate
-    * Google::Cloud.translate
-    * Google::Cloud::Translate.new
-  * To use the legacy v2 client specify the version when creating:
-    * v2_client = Google::Cloud::Translate.new version: :v2
-
-#### Features
-
-* Add Translate V3 client
-  * The v3 client includes several new features and updates:
-  * Glossaries - Create a custom dictionary to correctly and
-    consistently translate terms that are customer-specific.
-  * Batch requests - Make an asynchronous request to translate
-    large amounts of text.
-  * AutoML models - Cloud Translation adds support for translating
-    text with custom models that you create using AutoML Translation.
-  * Labels - The Cloud Translation API supports adding user-defined
-    labels (key-value pairs) to requests.
-* Now requires Ruby 2.4 or later.
-
-#### Documentation
-
-* Update the list of GCP environments for automatic authentication
-
-### 1.4.0 / 2019-10-01
-
-#### Features
-
-* Support overriding of service endpoint
-
-### 1.3.1 / 2019-08-23
-
-#### Documentation
-
-* Update documentation
-
-### 1.3.0 / 2019-02-01
-
-* Make use of Credentials#project_id
-  * Use Credentials#project_id
-    If a project_id is not provided, use the value on the Credentials object.
-    This value was added in googleauth 0.7.0.
-  * Loosen googleauth dependency
-    Allow for new releases up to 0.10.
-    The googleauth devs have committed to maintaining the current API
-    and will not make backwards compatible changes before 0.10.
-
-### 1.2.4 / 2018-09-20
-
-* Update documentation.
-  * Change documentation URL to googleapis GitHub org.
-* Fix circular require warning.
-
-### 1.2.3 / 2018-09-12
-
-* Add missing documentation files to package.
-
-### 1.2.2 / 2018-09-10
-
-* Update documentation.
-
-### 1.2.1 / 2018-08-21
-
-* Update documentation.
-
-### 1.2.0 / 2018-02-27
-
-* Support Shared Configuration.
-
-### 1.1.0 / 2017-11-14
-
-* Add `Google::Cloud::Translate::Credentials` class.
-* Rename constructor arguments to `project_id` and `credentials`.
-  (The previous arguments `project` and `keyfile` are still supported.)
-* Document `Google::Auth::Credentials` as `credentials` value.
-* Updated `faraday`, `googleauth` dependencies.
-
-### 1.0.1 / 2017-07-11
-
-* Remove mention of discontinued Premium Edition billing from documentation.
-
-### 1.0.0 / 2017-06-28
-
-* Release 1.0
-
-### 0.23.1 / 2017-05-23
-
-* Fix error handling (adrian-gomez)
-
-### 0.23.0 / 2017-03-31
-
-* No changes
-
-### 0.22.2 / 2016-12-22
-
-* Change product name to Google Cloud Translation API in docs.
-
-### 0.22.1 / 2016-11-16
-
-* Add missing googleauth dependency (frankyn)
-
-### 0.22.0 / 2016-11-14
-
-* Support authentication with service accounts
-* Add `model` parameter to translate method
-* Add `model` attribute to Translation objects
-
-### 0.21.0 / 2016-10-20
-
-* New service constructor Google::Cloud::Translate.new
-
-### 0.20.1 / 2016-09-02
-
-* Fix for timeout on uploads.
-
-### 0.20.0 / 2016-08-26
-
-This gem contains the Google Cloud Translate service implementation for the `google-cloud` gem. The `google-cloud` gem replaces the old `gcloud` gem. Legacy code can continue to use the `gcloud` gem.
-
-* Namespace is now `Google::Cloud`
-* The `google-cloud` gem is now an umbrella package for individual gems