google-cloud-speech 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ea8bfc2549536e0da9030f8dfc3cc3abbbdf6f2f611ad761901720e67d84b8f
-  data.tar.gz: 83808483ace60d98c0166416867ee40122f3158e92e6757d46684264b3c6ac45
+  metadata.gz: 1c8413795f1ff1fc9d4cf12d6d60c49fe0239788fc150a7e2717fb0553659c53
+  data.tar.gz: 316185b6b5db45d5e7bdcf4ed800bbf06d39b049938d7e5b47502576a261a41f
 SHA512:
-  metadata.gz: 89d38a6c84418d91afac2858a919d94e5486bee9c0b461dac6ace854eb2b1a940f9210c576c65d2f091a25fc40d23e0e5008e63152b46ceaf6bf1ccc374dc2be
-  data.tar.gz: c070e9db594451f1567e01a0f7739dc95692c99cfd129ae0a5a668ccd35897de05c6410a83c82925837f0c725308005499ccdf8b9303f87bcb2c49a7fd546900
+  metadata.gz: 435c456d09e05127f99dceba69eca467cdef99101064668a1a888824d8b24eff2ccab37474c5ba801b5d797138fa9ceb9d9dbf5cc541384be0b178505e26e9bd
+  data.tar.gz: a766e0c9faf23aaa982cb0d5a1c9c5678d7b6227f09faf9de330c09bce559527d32e2a22e0bc1cac98b018e8d9aeb162ce534637161a3499bfcf25f876591155

data/lib/google-cloud-speech.rb

@@ -20,6 +20,8 @@
 
 gem "google-cloud-core"
 require "google/cloud"
+require "google/cloud/config"
+require "googleauth"
 
 module Google
   module Cloud
@@ -115,3 +117,26 @@ module Google
     end
   end
 end
+
+# Set the default speech configuration
+Google::Cloud.configure.add_config! :speech do |config|
+  default_project = Google::Cloud::Config.deferred do
+    ENV["SPEECH_PROJECT"]
+  end
+  default_creds = Google::Cloud::Config.deferred do
+    Google::Cloud::Config.credentials_from_env(
+      "SPEECH_CREDENTIALS", "SPEECH_CREDENTIALS_JSON",
+      "SPEECH_KEYFILE", "SPEECH_KEYFILE_JSON"
+    )
+  end
+
+  config.add_field! :project_id, default_project, match: String, allow_nil: true
+  config.add_alias! :project, :project_id
+  config.add_field! :credentials, default_creds,
+                    match: [String, Hash, Google::Auth::Credentials],
+                    allow_nil: true
+  config.add_alias! :keyfile, :credentials
+  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :timeout, nil, match: Integer
+  config.add_field! :client_config, nil, match: Hash
+end

data/lib/google/cloud/speech.rb

@@ -15,6 +15,8 @@
 
 require "google-cloud-speech"
 require "google/cloud/speech/project"
+require "google/cloud/config"
+require "google/cloud/env"
 
 module Google
   module Cloud
@@ -34,11 +36,12 @@ module Google
     # Speech API Documentation](https://cloud.google.com/speech/docs/).
     #
     # The goal of google-cloud is to provide an API that is comfortable to
-    # Rubyists. Authentication is handled by {Google::Cloud#speech}. You can
-    # provide the project and credential information to connect to the Cloud
-    # Speech service, or if you are running on Google Compute Engine this
-    # configuration is taken care of for you. You can read more about the
-    # options for connecting in the [Authentication
+    # Rubyists. Your authentication credentials are detected automatically in
+    # Google Cloud Platform environments such as Google Compute Engine, Google
+    # App Engine and Google Kubernetes Engine. In other environments you can
+    # configure authentication easily, either directly in your code or via
+    # environment variables. Read more about the options for connecting in the
+    # [Authentication
     # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
     #
     # ## Creating audio sources
@@ -224,11 +227,14 @@ module Google
       #
       def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
                    client_config: nil, project: nil, keyfile: nil
-        project_id ||= (project || Speech::Project.default_project_id)
+        project_id ||= (project || default_project_id)
         project_id = project_id.to_s # Always cast to a string
-        fail ArgumentError, "project_id is missing" if project_id.empty?
+        raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        credentials ||= (keyfile || Speech::Credentials.default(scope: scope))
+        scope ||= configure.scope
+        timeout ||= configure.timeout
+        client_config ||= configure.client_config
+        credentials ||= (keyfile || default_credentials(scope: scope))
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Speech::Credentials.new credentials, scope: scope
         end
@@ -236,7 +242,51 @@ module Google
         Speech::Project.new(
           Speech::Service.new(
             project_id, credentials, timeout: timeout,
-                                     client_config: client_config))
+                                     client_config: client_config
+          )
+        )
+      end
+
+      ##
+      # Configure the Google Cloud Speech library.
+      #
+      # The following Speech configuration parameters are supported:
+      #
+      # * `project_id` - (String) Identifier for a Speech project. (The
+      #   parameter `project` is considered deprecated, but may also be used.)
+      # * `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 {Speech::Credentials}) (The
+      #   parameter `keyfile` is considered deprecated, but may also be used.)
+      # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
+      #   the set of resources and operations that the connection can access.
+      # * `timeout` - (Integer) Default timeout to use in requests.
+      # * `client_config` - (Hash) A hash of values to override the default
+      #   behavior of the API client.
+      #
+      # @return [Google::Cloud::Config] The configuration object the
+      #   Google::Cloud::Speech library uses.
+      #
+      def self.configure
+        yield Google::Cloud.configure.speech if block_given?
+
+        Google::Cloud.configure.speech
+      end
+
+      ##
+      # @private Default project.
+      def self.default_project_id
+        Google::Cloud.configure.speech.project_id ||
+          Google::Cloud.configure.project_id ||
+          Google::Cloud.env.project_id
+      end
+
+      ##
+      # @private Default credentials.
+      def self.default_credentials scope: nil
+        Google::Cloud.configure.speech.credentials ||
+          Google::Cloud.configure.credentials ||
+          Speech::Credentials.default(scope: scope)
       end
     end
   end

data/lib/google/cloud/speech/audio.rb

@@ -279,8 +279,8 @@ module Google
                                profanity_filter: profanity_filter,
                                phrases: phrases, words: words
         end
-        alias_method :long_running_recognize, :process
-        alias_method :recognize_job, :process
+        alias long_running_recognize process
+        alias recognize_job process
 
         ##
         # @private The Google API Client object for the Audio.
@@ -309,12 +309,12 @@ module Google
           end
           # Create an audio from a file on the filesystem
           if File.file? source
-            fail ArgumentError, "Cannot read #{source}" unless \
+            raise ArgumentError, "Cannot read #{source}" unless \
               File.readable? source
             audio.grpc.content = File.read source, mode: "rb"
             return audio
           end
-          fail ArgumentError, "Unable to convert #{source} to an Audio"
+          raise ArgumentError, "Unable to convert #{source} to an Audio"
         end
 
         protected
@@ -322,7 +322,7 @@ module Google
         ##
         # Raise an error unless an active Speech Project object is available.
         def ensure_speech!
-          fail "Must have active connection" unless @speech
+          raise "Must have active connection" unless @speech
         end
       end
     end

data/lib/google/cloud/speech/convert.rb

@@ -33,7 +33,7 @@ module Google
           def duration_to_number duration
             return nil if duration.nil?
 
-            return duration.seconds if duration.nanos == 0
+            return duration.seconds if duration.nanos.zero?
 
             duration.seconds + (duration.nanos / 1000000000.0)
           end

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

@@ -38,19 +38,19 @@ module Google
       #   speech.project_id #=> "my-project"
       #
       class Credentials < Google::Auth::Credentials
-        SCOPE = ["https://www.googleapis.com/auth/cloud-platform"]
-        PATH_ENV_VARS = %w(SPEECH_CREDENTIALS
+        SCOPE = ["https://www.googleapis.com/auth/cloud-platform"].freeze
+        PATH_ENV_VARS = %w[SPEECH_CREDENTIALS
                            SPEECH_KEYFILE
                            GOOGLE_CLOUD_CREDENTIALS
                            GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE)
-        JSON_ENV_VARS = %w(SPEECH_CREDENTIALS_JSON
+                           GCLOUD_KEYFILE].freeze
+        JSON_ENV_VARS = %w[SPEECH_CREDENTIALS_JSON
                            SPEECH_KEYFILE_JSON
                            GOOGLE_CLOUD_CREDENTIALS_JSON
                            GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON)
+                           GCLOUD_KEYFILE_JSON].freeze
         DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"]
+          ["~/.config/gcloud/application_default_credentials.json"].freeze
       end
     end
   end

data/lib/google/cloud/speech/operation.rb

@@ -224,7 +224,7 @@ module Google
           @grpc.reload!
           self
         end
-        alias_method :refresh!, :reload!
+        alias refresh! reload!
 
         ##
         # Reloads the op until the operation is complete. The delay between

data/lib/google/cloud/speech/project.rb

@@ -14,7 +14,6 @@
 
 
 require "google/cloud/errors"
-require "google/cloud/env"
 require "google/cloud/speech/service"
 require "google/cloud/speech/audio"
 require "google/cloud/speech/result"
@@ -79,16 +78,7 @@ module Google
         def project_id
           service.project
         end
-        alias_method :project, :project_id
-
-        ##
-        # @private Default project.
-        def self.default_project_id
-          ENV["SPEECH_PROJECT"] ||
-            ENV["GOOGLE_CLOUD_PROJECT"] ||
-            ENV["GCLOUD_PROJECT"] ||
-            Google::Cloud.env.project_id
-        end
+        alias project project_id
 
         ##
         # Returns a new Audio instance from the given source. No API call is
@@ -185,11 +175,11 @@ module Google
         #                        sample_rate: 16000
         #
         def audio source, encoding: nil, language: nil, sample_rate: nil
-          if source.is_a? Audio
-            audio = source.dup
-          else
-            audio = Audio.from_source source, self
-          end
+          audio = if source.is_a? Audio
+                    source.dup
+                  else
+                    Audio.from_source source, self
+                  end
           audio.encoding = encoding unless encoding.nil?
           audio.language = language unless language.nil?
           audio.sample_rate = sample_rate unless sample_rate.nil?
@@ -324,7 +314,8 @@ module Google
             encoding: audio_obj.encoding, sample_rate: audio_obj.sample_rate,
             language: audio_obj.language, max_alternatives: max_alternatives,
             profanity_filter: profanity_filter, phrases: phrases,
-            words: words)
+            words: words
+          )
 
           grpc = service.recognize_sync audio_obj.to_grpc, config
           grpc.results.map do |result_grpc|
@@ -462,13 +453,14 @@ module Google
             encoding: audio_obj.encoding, sample_rate: audio_obj.sample_rate,
             language: audio_obj.language, max_alternatives: max_alternatives,
             profanity_filter: profanity_filter, phrases: phrases,
-            words: words)
+            words: words
+          )
 
           grpc = service.recognize_async audio_obj.to_grpc, config
           Operation.from_grpc grpc
         end
-        alias_method :long_running_recognize, :process
-        alias_method :recognize_job, :process
+        alias long_running_recognize process
+        alias recognize_job process
 
         ##
         # Creates a Stream object to perform bidirectional streaming
@@ -587,7 +579,7 @@ module Google
 
           Stream.new service, grpc_req
         end
-        alias_method :stream_recognize, :stream
+        alias stream_recognize stream
 
         ##
         # Performs asynchronous speech recognition. Requests are processed
@@ -651,7 +643,7 @@ module Google
         # @private Raise an error unless an active connection to the service is
         # available.
         def ensure_service!
-          fail "Must have active connection to service" unless service
+          raise "Must have active connection to service" unless service
         end
       end
     end

data/lib/google/cloud/speech/result.rb

@@ -104,7 +104,7 @@ module Google
         #   experimental feature and the accuracy of the time offset can vary.
         class Word
           attr_reader :word, :start_time, :end_time
-          alias_method :to_str, :word
+          alias to_str word
 
           ##
           # @private Creates a new Result::Word instance.
@@ -218,7 +218,7 @@ module Google
         ##
         # @private Creates a new InterimResult instance.
         def initialize transcript, confidence, stability, alternatives = []
-          @transcript  = transcript
+          @transcript = transcript
           @confidence = confidence
           @stability = stability
           @alternatives = alternatives

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

@@ -50,7 +50,8 @@ module Google
               timeout: timeout,
               client_config: client_config,
               lib_name: "gccl",
-              lib_version: Google::Cloud::Speech::VERSION)
+              lib_version: Google::Cloud::Speech::VERSION
+            )
         end
         attr_accessor :mocked_service
 
@@ -62,7 +63,8 @@ module Google
               timeout: timeout,
               client_config: client_config,
               lib_name: "gccl",
-              lib_version: Google::Cloud::Speech::VERSION)
+              lib_version: Google::Cloud::Speech::VERSION
+            )
         end
         attr_accessor :mocked_ops
 

data/lib/google/cloud/speech/stream.rb

@@ -119,7 +119,8 @@ module Google
           # TODO: do not send if stopped?
           synchronize do
             req = V1::StreamingRecognizeRequest.new(
-              audio_content: bytes.encode("ASCII-8BIT"))
+              audio_content: bytes.encode("ASCII-8BIT")
+            )
             @request_queue.push req
           end
         end
@@ -489,11 +490,11 @@ module Google
               background_results response
               background_event_type response.speech_event_type
               background_error response.error
-            rescue => e
+            rescue StandardError => e
               error! Google::Cloud::Error.from_error(e)
             end
           end
-        rescue => e
+        rescue StandardError => e
           error! Google::Cloud::Error.from_error(e)
         ensure
           pass_complete!
@@ -532,7 +533,7 @@ module Google
           return if error.nil?
 
           require "grpc/errors"
-          fail GRPC::BadStatus.new(error.code, error.message)
+          raise GRPC::BadStatus.new(error.code, error.message)
         end
 
         # @private
@@ -552,7 +553,7 @@ module Google
             loop do
               r = @q.pop
               break if r.equal? @sentinel
-              fail r if r.is_a? Exception
+              raise r if r.is_a? Exception
               yield r
             end
           end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Speech
-      VERSION = "0.28.0"
+      VERSION = "0.29.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-speech
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: google-gax
   requirement: !ruby/object:Gem::Requirement
@@ -113,16 +113,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Speech API