google-cloud-speech 0.29.0 → 0.30.0

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

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
 # limitations under the License.
 
 require "google/cloud/speech/v1/speech_client"
+require "google/cloud/speech/v1/helpers"
 
 module Google
   module Cloud
@@ -93,11 +94,18 @@ module Google
         #   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 exception_transformer [Proc]
+        #   An optional proc that intercepts any exceptions raised during an API call to inject
+        #   custom error handling.
         def self.new \
             credentials: nil,
             scopes: nil,
             client_config: nil,
             timeout: nil,
+            metadata: nil,
+            exception_transformer: nil,
             lib_name: nil,
             lib_version: nil
           kwargs = {
@@ -105,6 +113,8 @@ module Google
             scopes: scopes,
             client_config: client_config,
             timeout: timeout,
+            metadata: metadata,
+            exception_transformer: exception_transformer,
             lib_name: lib_name,
             lib_version: lib_version
           }.select { |_, v| v != nil }

data/lib/google/cloud/speech/v1/cloud_speech_services_pb.rb

@@ -7,7 +7,7 @@
 # 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
+#     http://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,

data/lib/google/cloud/speech/{version.rb → v1/credentials.rb}

@@ -1,4 +1,4 @@
-# Copyright 2016 Google LLC
+# Copyright 2018 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 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "googleauth"
 
 module Google
   module Cloud
     module Speech
-      VERSION = "0.29.0".freeze
+      module V1
+        class Credentials < Google::Auth::Credentials
+          SCOPE = [
+            "https://www.googleapis.com/auth/cloud-platform"
+          ].freeze
+          PATH_ENV_VARS = %w(SPEECH_KEYFILE GOOGLE_CLOUD_KEYFILE GCLOUD_KEYFILE)
+          JSON_ENV_VARS = %w(SPEECH_KEYFILE_JSON GOOGLE_CLOUD_KEYFILE_JSON GCLOUD_KEYFILE_JSON)
+          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
+        end
+      end
     end
   end
 end

data/lib/google/cloud/speech/v1/doc/google/cloud/speech/v1/cloud_speech.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@ module Google
       #
       # | Class | Description |
       # | ----- | ----------- |
-      # | [SpeechClient][] | Google Cloud Speech API. |
+      # | [SpeechClient][] | Service that implements Google Cloud Speech API. |
       # | [Data Types][] | Data types for Google::Cloud::Speech::V1 |
       #
       # [SpeechClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-speech/latest/google/cloud/speech/v1/speechclient

data/lib/google/cloud/speech/v1/doc/google/longrunning/operations.rb

@@ -0,0 +1,92 @@
+# Copyright 2018 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 Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     +name+ should have the format of +operations/some/unique/name+.
+    # @!attribute [rw] metadata
+    #   @return [Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [true, false]
+    #     If the value is +false+, it means the operation is still in progress.
+    #     If true, the operation is completed, and either +error+ or +response+ is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [Google::Protobuf::Any]
+    #     The normal response of the operation in case of success.  If the original
+    #     method returns no data on success, such as +Delete+, the response is
+    #     +google.protobuf.Empty+.  If the original method is standard
+    #     +Get+/+Create+/+Update+, the response should be the resource.  For other
+    #     methods, the response should have the type +XxxResponse+, where +Xxx+
+    #     is the original method name.  For example, if the original method name
+    #     is +TakeSnapshot()+, the inferred response type is
+    #     +TakeSnapshotResponse+.
+    class Operation; end
+
+    # The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource.
+    class GetOperationRequest; end
+
+    # The request message for {Google::Longrunning::Operations::ListOperations Operations::ListOperations}.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation collection.
+    # @!attribute [rw] filter
+    #   @return [String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [String]
+    #     The standard list page token.
+    class ListOperationsRequest; end
+
+    # The response message for {Google::Longrunning::Operations::ListOperations Operations::ListOperations}.
+    # @!attribute [rw] operations
+    #   @return [Array<Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [String]
+    #     The standard List next-page token.
+    class ListOperationsResponse; end
+
+    # The request message for {Google::Longrunning::Operations::CancelOperation Operations::CancelOperation}.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest; end
+
+    # The request message for {Google::Longrunning::Operations::DeleteOperation Operations::DeleteOperation}.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest; end
+  end
+end

data/lib/google/cloud/speech/v1/doc/google/protobuf/any.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/speech/v1/doc/google/protobuf/duration.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/speech/v1/doc/google/rpc/status.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/speech/v1/doc/overview.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/speech/v1/helpers.rb

@@ -0,0 +1,93 @@
+# Copyright 2018 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/speech/v1/speech_client"
+require "google/cloud/speech/v1/stream"
+
+module Google
+  module Cloud
+    module Speech
+      module V1
+        class SpeechClient
+          # Performs bidirectional streaming speech recognition: receive results
+          # while sending audio. This method is only available via the gRPC API
+          # (not REST).
+          #
+          # @param [Google::Cloud::Speech::V1::StreamingRecognitionConfig,
+          #     Hash] streaming_config
+          #   Provides information to the recognizer that specifies how to
+          #   process the request.
+          #   A hash of the same form as
+          #   +Google::Cloud::Speech::V1::StreamingRecognitionConfig+
+          #   can also be provided.
+          # @param [Google::Gax::CallOptions] options
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Cloud::Speech::V1::Stream]
+          #   An object that streams the requests and responses.
+          #
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          #
+          # @example
+          #   require "google/cloud/speech"
+          #
+          #   speech_client = Google::Cloud::Speech.new
+          #   streaming_config = {
+          #     config: {
+          #       encoding: :linear16,
+          #       language_code: "en-US",
+          #       sample_rate_hertz: 16000
+          #     }
+          #   }
+          #   stream = speech_client.streaming_recognize(streaming_config)
+          #
+          #   # Stream 5 seconds of audio from the microphone
+          #   # Actual implementation of microphone input varies by platform
+          #   5.times do
+          #     stream.send MicrophoneInput.read(32000)
+          #   end
+          #
+          #   stream.stop
+          #   stream.wait_until_complete!
+          #
+          #   results = stream.results
+          #   result = results.first.alternatives.first
+          #   result.transcript #=> "how old is the Brooklyn Bridge"
+          #   result.confidence #=> 0.9826789498329163
+          #
+          def streaming_recognize streaming_config, options: nil
+            if streaming_config.is_a?(::Hash) &&
+               streaming_config[:config] &&
+               streaming_config[:config][:encoding]
+              streaming_config[:config][:encoding] =
+                streaming_config[:config][:encoding].upcase
+            end
+            V1::Stream.new(
+              streaming_config,
+              proc do |reqs|
+                request_protos = reqs.lazy.map do |req|
+                  Google::Gax.to_proto(
+                    req,
+                    Google::Cloud::Speech::V1::StreamingRecognizeRequest
+                  )
+                end
+                @streaming_recognize.call(request_protos, options)
+              end
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/speech/v1/speech_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,9 +18,6 @@
 # and updates to that file get reflected here through a refresh process.
 # For the short term, the refresh process will only be runnable by Google
 # engineers.
-#
-# The only allowed edits are to method and file documentation. A 3-way
-# merge preserves those additions if the generated source changes.
 
 require "json"
 require "pathname"
@@ -30,7 +27,7 @@ require "google/gax/operation"
 require "google/longrunning/operations_client"
 
 require "google/cloud/speech/v1/cloud_speech_pb"
-require "google/cloud/speech/credentials"
+require "google/cloud/speech/v1/credentials"
 
 module Google
   module Cloud
@@ -58,7 +55,7 @@ module Google
           ].freeze
 
           class OperationsClient < Google::Longrunning::OperationsClient
-            SERVICE_ADDRESS = SERVICE_ADDRESS
+            self::SERVICE_ADDRESS = SpeechClient::SERVICE_ADDRESS
           end
 
           # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
@@ -85,11 +82,18 @@ module Google
           #   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 exception_transformer [Proc]
+          #   An optional proc that intercepts any exceptions raised during an API call to inject
+          #   custom error handling.
           def initialize \
               credentials: nil,
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
+              metadata: nil,
+              exception_transformer: nil,
               lib_name: nil,
               lib_version: ""
             # These require statements are intentionally placed here to initialize
@@ -98,7 +102,7 @@ module Google
             require "google/gax/grpc"
             require "google/cloud/speech/v1/cloud_speech_services_pb"
 
-            credentials ||= Google::Cloud::Speech::Credentials.default
+            credentials ||= Google::Cloud::Speech::V1::Credentials.default
 
             @operations_client = OperationsClient.new(
               credentials: credentials,
@@ -110,7 +114,7 @@ module Google
             )
 
             if credentials.is_a?(String) || credentials.is_a?(Hash)
-              updater_proc = Google::Cloud::Speech::Credentials.new(credentials).updater_proc
+              updater_proc = Google::Cloud::Speech::V1::Credentials.new(credentials).updater_proc
             end
             if credentials.is_a?(GRPC::Core::Channel)
               channel = credentials
@@ -134,6 +138,7 @@ module Google
             google_api_client.freeze
 
             headers = { :"x-goog-api-client" => google_api_client }
+            headers.merge!(metadata) unless metadata.nil?
             client_config_file = Pathname.new(__dir__).join(
               "speech_client_config.json"
             )
@@ -145,7 +150,7 @@ module Google
                 Google::Gax::Grpc::STATUS_CODE_NAMES,
                 timeout,
                 errors: Google::Gax::Grpc::API_ERRORS,
-                kwargs: headers
+                metadata: headers
               )
             end
 
@@ -164,15 +169,18 @@ module Google
 
             @recognize = Google::Gax.create_api_call(
               @speech_stub.method(:recognize),
-              defaults["recognize"]
+              defaults["recognize"],
+              exception_transformer: exception_transformer
             )
             @long_running_recognize = Google::Gax.create_api_call(
               @speech_stub.method(:long_running_recognize),
-              defaults["long_running_recognize"]
+              defaults["long_running_recognize"],
+              exception_transformer: exception_transformer
             )
             @streaming_recognize = Google::Gax.create_api_call(
               @speech_stub.method(:streaming_recognize),
-              defaults["streaming_recognize"]
+              defaults["streaming_recognize"],
+              exception_transformer: exception_transformer
             )
           end
 
@@ -193,6 +201,9 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Cloud::Speech::V1::RecognizeResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Cloud::Speech::V1::RecognizeResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
@@ -214,13 +225,14 @@ module Google
           def recognize \
               config,
               audio,
-              options: nil
+              options: nil,
+              &block
             req = {
               config: config,
               audio: audio
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Cloud::Speech::V1::RecognizeRequest)
-            @recognize.call(req, options)
+            @recognize.call(req, options, &block)
           end
 
           # Performs asynchronous speech recognition: receive results via the
@@ -303,41 +315,6 @@ module Google
             operation.on_done { |operation| yield(operation) } if block_given?
             operation
           end
-
-          # Performs bidirectional streaming speech recognition: receive results while
-          # sending audio. This method is only available via the gRPC API (not REST).
-          #
-          # @param reqs [Enumerable<Google::Cloud::Speech::V1::StreamingRecognizeRequest>]
-          #   The input requests.
-          # @param options [Google::Gax::CallOptions]
-          #   Overrides the default settings for this call, e.g, timeout,
-          #   retries, etc.
-          # @return [Enumerable<Google::Cloud::Speech::V1::StreamingRecognizeResponse>]
-          #   An enumerable of Google::Cloud::Speech::V1::StreamingRecognizeResponse instances.
-          #
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          #
-          # @note
-          #   EXPERIMENTAL:
-          #     Streaming requests are still undergoing review.
-          #     This method interface might change in the future.
-          #
-          # @example
-          #   require "google/cloud/speech/v1"
-          #
-          #   speech_client = Google::Cloud::Speech::V1.new
-          #   request = {}
-          #   requests = [request]
-          #   speech_client.streaming_recognize(requests).each do |element|
-          #     # Process element.
-          #   end
-
-          def streaming_recognize reqs, options: nil
-            request_protos = reqs.lazy.map do |req|
-              Google::Gax::to_proto(req, Google::Cloud::Speech::V1::StreamingRecognizeRequest)
-            end
-            @streaming_recognize.call(request_protos, options)
-          end
         end
       end
     end