google-cloud-translate 2.3.0 → 3.1.0

data/lib/google/cloud/translate/v2/credentials.rb

@@ -1,58 +0,0 @@
-# Copyright 2016 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.
-
-
-require "googleauth"
-
-module Google
-  module Cloud
-    module Translate
-      module V2
-        ##
-        # # Credentials
-        #
-        # Represents the authentication and authorization used to connect to the Cloud Translation API.
-        #
-        # @example
-        #   require "google/cloud/translate"
-        #
-        #   keyfile = "/path/to/keyfile.json"
-        #   creds = Google::Cloud::Translate::V2::Credentials.new keyfile
-        #
-        #   translate = Google::Cloud::Translate.new(
-        #     version: :v2,
-        #     project_id: "my-todo-project",
-        #     credentials: creds
-        #   )
-        #
-        #   translate.project_id #=> "my-todo-project"
-        #
-        class Credentials < Google::Auth::Credentials
-          SCOPE = ["https://www.googleapis.com/auth/cloud-platform"].freeze
-          PATH_ENV_VARS = ["TRANSLATE_CREDENTIALS",
-                           "TRANSLATE_KEYFILE",
-                           "GOOGLE_CLOUD_CREDENTIALS",
-                           "GOOGLE_CLOUD_KEYFILE",
-                           "GCLOUD_KEYFILE"].freeze
-          JSON_ENV_VARS = ["TRANSLATE_CREDENTIALS_JSON",
-                           "TRANSLATE_KEYFILE_JSON",
-                           "GOOGLE_CLOUD_CREDENTIALS_JSON",
-                           "GOOGLE_CLOUD_KEYFILE_JSON",
-                           "GCLOUD_KEYFILE_JSON"].freeze
-          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"].freeze
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/translate/v2/detection.rb

@@ -1,132 +0,0 @@
-# Copyright 2016 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
-      module V2
-        ##
-        # # Detection
-        #
-        # Represents a detect language query result. Returned by {Google::Cloud::Translate::V2::Api#detect}.
-        #
-        # @see https://cloud.google.com/translation/docs/detecting-language Detecting Language
-        #
-        # @example
-        #   require "google/cloud/translate"
-        #
-        #   translate = Google::Cloud::Translate.new version: :v2
-        #
-        #   detections = translate.detect "chien", "chat"
-        #
-        #   detections.size #=> 2
-        #   detections[0].text #=> "chien"
-        #   detections[0].language #=> "fr"
-        #   detections[0].confidence #=> 0.7109375
-        #   detections[1].text #=> "chat"
-        #   detections[1].language #=> "en"
-        #   detections[1].confidence #=> 0.59922177
-        #
-        class Detection
-          ##
-          # The text upon which the language detection was performed.
-          #
-          # @return [String]
-          attr_reader :text
-
-          ##
-          # The list of detection results for the given text. The most likely language is listed first, and its
-          # attributes can be accessed through {#language} and {#confidence}.
-          #
-          # @return [Array<Detection::Result>]
-          attr_reader :results
-
-          ##
-          # @private Create a new object.
-          def initialize text, results
-            @text = text
-            @results = results
-          end
-
-          ##
-          # The confidence that the language detection result is correct. The closer this value is to 1, the higher the
-          # confidence in language detection.
-          #
-          # @return [Float] a value between 0 and 1
-          def confidence
-            return nil if results.empty?
-            results.first.confidence
-          end
-
-          ##
-          # The most likely language that was detected. This is an [ISO
-          # 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
-          #
-          # @return [String] the language code
-          def language
-            return nil if results.empty?
-            results.first.language
-          end
-
-          ##
-          # @private New Detection from a ListDetectionsResponse object as defined by the Google API Client object.
-          def self.from_gapi gapi, text
-            res = text.zip(Array(gapi["detections"])).map do |txt, detections|
-              results = detections.map { |g| Result.from_gapi g }
-              new txt, results
-            end
-            return res.first if res.size == 1
-            res
-          end
-
-          ##
-          # # Result
-          #
-          # Represents an individual result in a {Google::Cloud::Translate::V2::Detection} result.
-          #
-          class Result
-            ##
-            # The confidence that the language detection result is correct. The closer this value is to 1, the higher
-            # the confidence in language detection.
-            #
-            # @return [Float] a value between 0 and 1
-            attr_reader :confidence
-
-            ##
-            # The language detected. This is an [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
-            # language code.
-            #
-            # @return [String] the language code
-            attr_reader :language
-
-            ##
-            # @private Create a new object.
-            def initialize confidence, language
-              @confidence = confidence
-              @language = language
-            end
-
-            ##
-            # @private New Detection::Result from a DetectionsResource object as defined by the Google API Client
-            # object.
-            def self.from_gapi gapi
-              new gapi["confidence"], gapi["language"]
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/translate/v2/language.rb

@@ -1,68 +0,0 @@
-# Copyright 2016 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
-      module V2
-        ##
-        # # Language
-        #
-        # Represents a supported languages query result. Returned by {Google::Cloud::Translate::V2::Api#languages}.
-        #
-        # @see https://cloud.google.com/translation/docs/discovering-supported-languages Discovering Supported Languages
-        #
-        # @example
-        #   require "google/cloud/translate"
-        #
-        #   translate = Google::Cloud::Translate.new version: :v2
-        #
-        #   languages = translate.languages "en"
-        #
-        #   languages.size #=> 104
-        #   languages[0].code #=> "af"
-        #   languages[0].name #=> "Afrikaans"
-        #
-        class Language
-          ##
-          # The language code. This is an [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language
-          # code.
-          #
-          # @return [String]
-          attr_reader :code
-
-          ##
-          # The localized name of the language, if available.
-          #
-          # @return [String]
-          attr_reader :name
-
-          ##
-          # @private Create a new object.
-          def initialize code, name
-            @code = code
-            @name = name
-          end
-
-          ##
-          # @private New Language from a LanguagesResource object as defined by the Google API Client object.
-          def self.from_gapi gapi
-            new gapi["language"], gapi["name"]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/translate/v2/service.rb

@@ -1,209 +0,0 @@
-# Copyright 2016 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.
-
-
-require "google/cloud/errors"
-require "google/cloud/translate/v2/credentials"
-require "google/cloud/translate/version"
-require "faraday"
-require "uri"
-
-module Google
-  module Cloud
-    module Translate
-      module V2
-        ##
-        # @private
-        # Represents the Translation API REST service, exposing the API calls.
-        class Service #:nodoc:
-          API_VERSION = "v2".freeze
-          API_URL = "https://translation.googleapis.com".freeze
-
-          # @private
-          attr_accessor :project_id, :credentials, :retries, :timeout, :key
-
-          ##
-          # Creates a new Service instance.
-          def initialize project_id, credentials, retries: nil, timeout: nil, key: nil, host: nil
-            @project_id = project_id
-            @credentials = credentials
-            @retries = retries
-            @timeout = timeout
-            @key = key
-            @host = host || API_URL
-          end
-
-          ##
-          # Returns Hash of ListTranslationsResponse JSON
-          def translate text, to: nil, from: nil, format: nil, model: nil, cid: nil
-            body = {
-              q: Array(text), target: to, source: from, format: format,
-              model: model, cid: cid
-            }.delete_if { |_k, v| v.nil? }.to_json
-
-            post "/language/translate/v2", body
-          end
-
-          ##
-          # Returns API::ListDetectionsResponse
-          def detect text
-            body = { q: Array(text) }.to_json
-
-            post "language/translate/v2/detect", body
-          end
-
-          ##
-          # Returns API::ListLanguagesResponse
-          def languages language = nil
-            body = { target: language }.to_json
-
-            post "language/translate/v2/languages", body
-          end
-
-          def inspect
-            self.class.to_s
-          end
-
-          protected
-
-          def post path, body = nil
-            response = execute do
-              http.post path do |req|
-                req.headers.merge! default_http_headers
-                req.body = body unless body.nil?
-
-                if @key
-                  req.params = { key: @key }
-                else
-                  sign_http_request! req
-                end
-              end
-            end
-
-            return JSON.parse(response.body)["data"] if response.success?
-
-            raise Google::Cloud::Error.gapi_error_class_for(response.status)
-          rescue Faraday::ConnectionFailed
-            raise Google::Cloud::ResourceExhaustedError
-          end
-
-          ##
-          # The HTTP object that makes calls to API.
-          # This must be a Faraday object.
-          def http
-            @http ||= Faraday.new url: @host, request: {
-              open_timeout: @timeout, timeout: @timeout
-            }.delete_if { |_k, v| v.nil? }
-          end
-
-          ##
-          # The default HTTP headers to be sent on all API calls.
-          def default_http_headers
-            @default_http_headers ||= begin
-              headers = {
-                "User-Agent"                   => "gcloud-ruby/#{Google::Cloud::Translate::VERSION}",
-                "google-cloud-resource-prefix" => "projects/#{@project}",
-                "Content-Type"                 => "application/json",
-                "x-goog-api-client"            => "gl-ruby/#{RUBY_VERSION} gccl/#{Google::Cloud::Translate::VERSION}"
-              }
-              headers["x-goog-user-project"] = credentials.quota_project_id if credentials.respond_to? :quota_project_id
-              headers
-            end
-          end
-
-          ##
-          # Make a request and apply incremental backoff
-          def execute
-            backoff = Backoff.new retries: retries
-            backoff.execute do
-              yield
-            end
-          rescue Faraday::ConnectionFailed
-            raise Google::Cloud::ResourceExhaustedError
-          end
-
-          ##
-          # Sign Oauth2 API calls.
-          def sign_http_request! request
-            client = credentials.client
-            return if client.nil?
-
-            client.fetch_access_token! if client.expires_within? 30
-            client.generate_authenticated_request request: request
-            request
-          end
-
-          ##
-          # @private Backoff
-          class Backoff
-            class << self
-              attr_accessor :retries
-              attr_accessor :http_codes
-              attr_accessor :reasons
-              attr_accessor :backoff # :nodoc:
-            end
-
-            # Set the default values
-            self.retries = 3
-            self.http_codes = [500, 503]
-            self.reasons = ["rateLimitExceeded", "userRateLimitExceeded"]
-            self.backoff = ->(retries) { sleep retries.to_i }
-
-            def initialize options = {} #:nodoc:
-              @max_retries  = (options[:retries]    || Backoff.retries).to_i
-              @http_codes   = (options[:http_codes] || Backoff.http_codes).to_a
-              @reasons      = (options[:reasons]    || Backoff.reasons).to_a
-              @backoff      =  options[:backoff]    || Backoff.backoff
-            end
-
-            def execute #:nodoc:
-              current_retries = 0
-              loop do
-                response = yield # Expecting Faraday::Response
-                return response if response.success?
-                break response unless retry? response, current_retries
-                current_retries += 1
-                @backoff.call current_retries
-              end
-            end
-
-            protected
-
-            def retry? result, current_retries #:nodoc:
-              if current_retries < @max_retries
-                return true if retry_http_code? result
-                return true if retry_error_reason? result
-              end
-              false
-            end
-
-            def retry_http_code? response #:nodoc:
-              @http_codes.include? response.status
-            end
-
-            def retry_error_reason? response #:nodoc:
-              result = JSON.parse response.body
-              if result && result["error"] && result["error"]["errors"]
-                Array(result["error"]["errors"]).each do |error|
-                  return true if error["reason"] && @reasons.include?(error["reason"])
-                end
-              end
-              false
-            end
-          end
-        end
-      end
-    end
-  end
-end