google-cloud-translate 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: baa4ef9d4e57fa267c4a87b3dc644a845f18f576
-  data.tar.gz: bbc46f7fe1a421d614cec10f86feed394e3de2b3
+SHA256:
+  metadata.gz: f57095104f31f5d2599e3e8581240c69e0ed606fd726cb382d2fda74f0547f85
+  data.tar.gz: 834d192ac8e50111bebbf6c020301abcc6ed5f9f0b707adda84de0661ad79426
 SHA512:
-  metadata.gz: b604d808b98dbf4c6dbbdb2a6b73ddeacfa288f04a19cb4d17ec7acd7822950a74906169329108f08f5c077a11461dd0fab381ce14e43c60c66ef72be68b044e
-  data.tar.gz: eae5a477536f242613f890a04eab7952792104b08932ee0758170d4a76bed6c2653fe12dd160e9de39f67edb334810eec76a1506e2b0469d88a41efd0eff58c0
+  metadata.gz: 3dacdd67988fc96e3560c492f3865af64ba0b9b47808031e50c94096619c55d5f0e4eff475ef95df7169ab99231b79e7be0bb7dd7af8ba2a8981ec029f01a194
+  data.tar.gz: 60dcdf8e53fef429e271048fd7e07d8c3e0bfba4a2e95f74621f665d067e774436bfa6f57099eee50a0798abbf3ed9be9c9cd05263353a0dfdb36318a5a25db8

data/README.md

@@ -48,8 +48,6 @@ This library is supported on Ruby 2.0+.
 
 This library follows [Semantic Versioning](http://semver.org/).
 
-It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.
-
 ## Contributing
 
 Contributions to this library are always welcome and highly encouraged.

data/lib/google-cloud-translate.rb

@@ -13,9 +13,9 @@
 # limitations under the License.
 
 ##
-# This file is here to be autorequired by bundler, so that the .bigquery and
-# #bigquery methods can be available, but the library and all dependencies won't
-# be loaded until required and used.
+# 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"
@@ -70,7 +70,7 @@ module Google
     #   translation.text #=> "Salve mundi!"
     #
     def translate key = nil, scope: nil, retries: nil, timeout: nil
-      Google::Cloud.translate key, project: @project, keyfile: @keyfile,
+      Google::Cloud.translate key, project_id: @project, credentials: @keyfile,
                                    scope: scope,
                                    retries: (retries || @retries),
                                    timeout: (timeout || @timeout)
@@ -88,10 +88,12 @@ module Google
     # [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-translate/guides/authentication).
     #
     # @param [String] key a public API access key (not an OAuth 2.0 token)
-    # @param [String] project Identifier for the Cloud Translation API project
-    #   to which you are connecting.
-    # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
-    #   file path the file must be readable.
+    # @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 {Translate::Credentials})
     # @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
@@ -103,6 +105,9 @@ module Google
     # @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] project Alias for the `project_id` argument. Deprecated.
+    # @param [String] keyfile Alias for the `credentials` argument.
+    #   Deprecated.
     #
     # @return [Google::Cloud::Translate::Api]
     #
@@ -124,12 +129,14 @@ module Google
     #   translation = translate.translate "Hello world!", to: "la"
     #   translation.text #=> "Salve mundi!"
     #
-    def self.translate key = nil, project: nil, keyfile: nil, scope: nil,
-                       retries: nil, timeout: nil
+    def self.translate key = nil, project_id: nil, credentials: nil, scope: nil,
+                       retries: nil, timeout: nil, project: nil, keyfile: nil
       require "google/cloud/translate"
-      Google::Cloud::Translate.new key: key, project: project, keyfile: keyfile,
+      Google::Cloud::Translate.new key: key, project_id: project_id,
+                                   credentials: credentials,
                                    scope: scope, retries: retries,
-                                   timeout: timeout
+                                   timeout: timeout,
+                                   project: project, keyfile: keyfile
     end
   end
 end

data/lib/google/cloud/translate.rb

@@ -218,10 +218,13 @@ module Google
       # covered in the [Authentication
       # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-translate/guides/authentication).
       #
-      # @param [String] project Identifier for the Cloud Translation API project
-      #   to which you are connecting.
-      # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
-      #   file path the file must be readable.
+      # @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 {Translate::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
@@ -230,10 +233,12 @@ module Google
       #   The default scope is:
       #
       #   * `https://www.googleapis.com/auth/cloud-platform`
-      # @param [String] key a public API access key (not an OAuth 2.0 token)
       # @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] project Alias for the `project_id` argument. Deprecated.
+      # @param [String] keyfile Alias for the `credentials` argument.
+      #   Deprecated.
       #
       # @return [Google::Cloud::Translate::Api]
       #
@@ -241,8 +246,8 @@ module Google
       #   require "google/cloud/translate"
       #
       #   translate = Google::Cloud::Translate.new(
-      #     project: "my-todo-project",
-      #     keyfile: "/path/to/keyfile.json"
+      #     project_id: "my-todo-project",
+      #     credentials: "/path/to/keyfile.json"
       #   )
       #
       #   translation = translate.translate "Hello world!", to: "la"
@@ -268,30 +273,30 @@ module Google
       #   translation = translate.translate "Hello world!", to: "la"
       #   translation.text #=> "Salve mundi!"
       #
-      def self.new project: nil, keyfile: nil, scope: nil, key: nil,
-                   retries: nil, timeout: nil
-        project ||= Google::Cloud::Translate::Api.default_project
-        project = project.to_s # Always cast to a string
+      def self.new project_id: nil, credentials: nil, key: nil, scope: nil,
+                   retries: nil, timeout: nil, project: nil, keyfile: nil
+        project_id ||= (project || Translate::Api.default_project_id)
+        project_id = project_id.to_s # Always cast to a string
 
         key ||= ENV["TRANSLATE_KEY"]
         key ||= ENV["GOOGLE_CLOUD_KEY"]
         if key
           return Google::Cloud::Translate::Api.new(
             Google::Cloud::Translate::Service.new(
-              project, nil, retries: retries, timeout: timeout, key: key))
+              project_id, nil, retries: retries, timeout: timeout, key: key))
         end
 
-        if keyfile.nil?
-          credentials = Google::Cloud::Translate::Credentials.default(
-            scope: scope)
-        else
-          credentials = Google::Cloud::Translate::Credentials.new(
-            keyfile, scope: scope)
+        fail ArgumentError, "project_id is missing" if project_id.empty?
+
+        credentials ||= keyfile
+        credentials ||= Translate::Credentials.default(scope: scope)
+        unless credentials.is_a? Google::Auth::Credentials
+          credentials = Translate::Credentials.new credentials, scope: scope
         end
 
-        Google::Cloud::Translate::Api.new(
-          Google::Cloud::Translate::Service.new(
-            project, credentials, retries: retries, timeout: timeout))
+        Translate::Api.new(
+          Translate::Service.new(
+            project_id, credentials, retries: retries, timeout: timeout))
       end
     end
   end

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

@@ -69,19 +69,20 @@ module Google
         #   require "google/cloud/translate"
         #
         #   translate = Google::Cloud::Translate.new(
-        #     project: "my-todo-project",
-        #     keyfile: "/path/to/keyfile.json"
+        #     project_id: "my-todo-project",
+        #     credentials: "/path/to/keyfile.json"
         #   )
         #
-        #   translate.project #=> "my-todo-project"
+        #   translate.project_id #=> "my-todo-project"
         #
-        def project
+        def project_id
           service.project
         end
+        alias_method :project, :project_id
 
         ##
         # @private Default project.
-        def self.default_project
+        def self.default_project_id
           ENV["TRANSLATE_PROJECT"] ||
             ENV["GOOGLE_CLOUD_PROJECT"] ||
             ENV["GCLOUD_PROJECT"] ||

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

@@ -13,29 +13,44 @@
 # limitations under the License.
 
 
-require "google/cloud/credentials"
+require "googleauth"
 
 module Google
   module Cloud
     module Translate
       ##
-      # @private Represents the OAuth 2.0 signing logic for Translation API.
-      class Credentials < Google::Cloud::Credentials
+      # # 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::Credentials.new keyfile
+      #
+      #   translate = Google::Cloud::Translate.new(
+      #     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"]
-        PATH_ENV_VARS = %w(TRANSLATE_KEYFILE GOOGLE_CLOUD_KEYFILE
+        PATH_ENV_VARS = %w(TRANSLATE_CREDENTIALS
+                           TRANSLATE_KEYFILE
+                           GOOGLE_CLOUD_CREDENTIALS
+                           GOOGLE_CLOUD_KEYFILE
                            GCLOUD_KEYFILE)
-        JSON_ENV_VARS = %w(TRANSLATE_KEYFILE_JSON GOOGLE_CLOUD_KEYFILE_JSON
+        JSON_ENV_VARS = %w(TRANSLATE_CREDENTIALS_JSON
+                           TRANSLATE_KEYFILE_JSON
+                           GOOGLE_CLOUD_CREDENTIALS_JSON
+                           GOOGLE_CLOUD_KEYFILE_JSON
                            GCLOUD_KEYFILE_JSON)
-
-        ##
-        # @private Sign Oauth2 API calls.
-        def sign_http_request request #:nodoc:
-          if @client
-            @client.fetch_access_token! if @client.expires_within? 30
-            @client.generate_authenticated_request request: request
-          end
-          request
-        end
+        DEFAULT_PATHS = \
+          ["~/.config/gcloud/application_default_credentials.json"]
       end
     end
   end

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

@@ -16,7 +16,7 @@
 require "google/cloud/errors"
 require "google/cloud/translate/credentials"
 require "google/cloud/translate/version"
-require "faraday" # comes from googleauth, comes from google-cloud-core
+require "faraday"
 
 module Google
   module Cloud
@@ -85,7 +85,7 @@ module Google
               if @key
                 req.params = { key: @key }
               else
-                @credentials.sign_http_request req
+                sign_http_request! req
               end
             end
           end
@@ -129,6 +129,17 @@ module Google
           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

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Translate
-      VERSION = "1.0.1"
+      VERSION = "1.1.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-translate
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -17,28 +17,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Translation API