google-cloud-text_to_speech-v1 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 132cc7121d909330b244eca9c63675e7b806965b875992d91e0e2ceef024b4d9
-  data.tar.gz: 80214e9c9f61924a010f7af91ae0c3a006fb462f1ebc14aa3b08693794c96511
+  metadata.gz: e01f3eb8d02c43950e328a35d41a27a2c720cac2065514148c555656fe8273b6
+  data.tar.gz: 7580a916720c64a4c0c516fd8af4d22dd5ec364765eb0c3488235e6acbb348fe
 SHA512:
-  metadata.gz: ba74b45b67c0df18ad8cac42e0c906e26895a76215115799c0c1ab11aca4276776d0d2ad039ded71f41c9f829fcf1dc2d0e997d188d4544307c25e1f48088a5d
-  data.tar.gz: ba0db213f75befc14423a5f9631310d2078de604de0cf2478d6594776d2930346c3f69150f2a22825dea6ebb08f659ddef7dda9a0d66d2b7646f72e43c5ffa82
+  metadata.gz: 8086e26ada49d2a16fb3dc903be21c05ca8fb6c2d4d0569c46e62b981d86f3c06fae70976527c095eccd0ed82c922e8991d6b43011fce2c6bb210cd5606d79df
+  data.tar.gz: f0fcc86a5fb60fc128b23ffc1f2bca89251eb0766d11856911a95ee183299f57e1965cfca8adc517f403ac0608983c4e3058ad233d19b782171787245e00a841

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-text_to_speech-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::TextToSpeech::V1::TextToSpeech::Credentials}):
 
-1. `TEXTTOSPEECH_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `TEXTTOSPEECH_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `TEXTTOSPEECH_CREDENTIALS` - Path to JSON file, or JSON contents
+* `TEXTTOSPEECH_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/text_to_speech/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/text_to_speech/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/text_to_speech/v1"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/text_to_speech/v1"
 
 client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new
-request = my_create_request
+request = ::Google::Cloud::TextToSpeech::V1::ListVoicesRequest.new # (request fields as keyword arguments...)
 response = client.list_voices request
 ```
 

data/lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb

@@ -39,13 +39,12 @@ module Google
             # See {::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all TextToSpeech clients:
-            #
-            #     ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all TextToSpeech clients
+            #   ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -63,20 +62,9 @@ module Google
                                 end
                 default_config = Client::Configuration.new parent_config
 
-                default_config.rpcs.list_voices.timeout = 600.0
-                default_config.rpcs.list_voices.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
-                }
-
-                default_config.rpcs.synthesize_speech.timeout = 600.0
-                default_config.rpcs.synthesize_speech.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                default_config.timeout = 300.0
+                default_config.retry_policy = {
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config
@@ -108,19 +96,15 @@ module Google
             ##
             # Create a new TextToSpeech client object.
             #
-            # ## Examples
+            # @example
             #
-            # To create a new TextToSpeech client with the default
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new
             #
-            #     client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new
-            #
-            # To create a new TextToSpeech client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the TextToSpeech client.
             # @yieldparam config [Client::Configuration]
@@ -140,14 +124,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -186,11 +169,11 @@ module Google
             #     Optional. Recommended.
             #     [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
             #     specified, the ListVoices call will only return voices that can be used to
-            #     synthesize this language_code. E.g. when specifying "en-NZ", you will get
-            #     supported "en-\*" voices; when specifying "no", you will get supported
-            #     "no-\*" (Norwegian) and "nb-\*" (Norwegian Bokmal) voices; specifying "zh"
-            #     will also get supported "cmn-\*" voices; specifying "zh-hk" will also get
-            #     supported "yue-\*" voices.
+            #     synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
+            #     supported `"en-\*"` voices; when specifying `"no"`, you will get supported
+            #     `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices; specifying
+            #     `"zh"` will also get supported `"cmn-\*"` voices; specifying `"zh-hk"` will
+            #     also get supported `"yue-\*"` voices.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::TextToSpeech::V1::ListVoicesResponse]
@@ -200,6 +183,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/text_to_speech/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::TextToSpeech::V1::ListVoicesRequest.new
+            #
+            #   # Call the list_voices method.
+            #   result = client.list_voices request
+            #
+            #   # The returned object is of type Google::Cloud::TextToSpeech::V1::ListVoicesResponse.
+            #   p result
+            #
             def list_voices request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -220,7 +218,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_voices.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_voices.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @text_to_speech_stub.call_rpc :list_voices, request, options: options do |response, operation|
@@ -265,6 +265,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/text_to_speech/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::TextToSpeech::V1::SynthesizeSpeechRequest.new
+            #
+            #   # Call the synthesize_speech method.
+            #   result = client.synthesize_speech request
+            #
+            #   # The returned object is of type Google::Cloud::TextToSpeech::V1::SynthesizeSpeechResponse.
+            #   p result
+            #
             def synthesize_speech request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -285,7 +300,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.synthesize_speech.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.synthesize_speech.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @text_to_speech_stub.call_rpc :synthesize_speech, request, options: options do |response, operation|
@@ -309,22 +326,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for list_voices
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_voices.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_voices.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_voices to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_voices.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_voices.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/text_to_speech/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module TextToSpeech
       module V1
-        VERSION = "0.4.1"
+        VERSION = "0.5.0"
       end
     end
   end

data/lib/google/cloud/texttospeech/v1/cloud_tts_pb.rb

@@ -1,11 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/texttospeech/v1/cloud_tts.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/texttospeech/v1/cloud_tts.proto", :syntax => :proto3) do
     add_message "google.cloud.texttospeech.v1.ListVoicesRequest" do
@@ -58,6 +59,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :LINEAR16, 1
       value :MP3, 2
       value :OGG_OPUS, 3
+      value :MULAW, 5
+      value :ALAW, 6
     end
   end
 end

data/lib/google/cloud/texttospeech/v1/cloud_tts_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/cloud/texttospeech/v1/cloud_tts.proto for package 'Google.Cloud.TextToSpeech.V1'
 # Original file comments:
-# Copyright 2019 Google LLC.
+# Copyright 2021 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-#
 
 require 'grpc'
 require 'google/cloud/texttospeech/v1/cloud_tts_pb'

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

data/proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb

@@ -27,11 +27,11 @@ module Google
         #     Optional. Recommended.
         #     [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
         #     specified, the ListVoices call will only return voices that can be used to
-        #     synthesize this language_code. E.g. when specifying "en-NZ", you will get
-        #     supported "en-\*" voices; when specifying "no", you will get supported
-        #     "no-\*" (Norwegian) and "nb-\*" (Norwegian Bokmal) voices; specifying "zh"
-        #     will also get supported "cmn-\*" voices; specifying "zh-hk" will also get
-        #     supported "yue-\*" voices.
+        #     synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
+        #     supported `"en-\*"` voices; when specifying `"no"`, you will get supported
+        #     `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices; specifying
+        #     `"zh"` will also get supported `"cmn-\*"` voices; specifying `"zh-hk"` will
+        #     also get supported `"yue-\*"` voices.
         class ListVoicesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -205,7 +205,7 @@ module Google
           # A female voice.
           FEMALE = 2
 
-          # A gender-neutral voice.
+          # A gender-neutral voice. This voice is not yet supported.
           NEUTRAL = 3
         end
 
@@ -227,6 +227,14 @@ module Google
           # Chrome and Firefox). The quality of the encoding is considerably higher
           # than MP3 while using approximately the same bitrate.
           OGG_OPUS = 3
+
+          # 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
+          # Audio content returned as MULAW also contains a WAV header.
+          MULAW = 5
+
+          # 8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law.
+          # Audio content returned as ALAW also contains a WAV header.
+          ALAW = 6
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-text_to_speech-v1
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a