google-cloud-speech 0.32.0 → 1.2.1

data/lib/google/cloud/speech.rb

@@ -1,4 +1,6 @@
-# Copyright 2018 Google LLC
+# frozen_string_literal: true
+
+# Copyright 2020 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,155 +14,102 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# Require this file early so that the version constant gets defined before
+# requiring "google/cloud". This is because google-cloud-core will load the
+# entrypoint (gem name) file, which in turn re-requires this file (hence
+# causing a require cycle) unless the version constant is already defined.
+require "google/cloud/speech/version"
 
-require "google/gax"
-require "pathname"
+require "googleauth"
+gem "google-cloud-core"
+require "google/cloud" unless defined? ::Google::Cloud.new
+require "google/cloud/config"
+
+# Set the default configuration
+::Google::Cloud.configure.add_config! :speech do |config|
+  config.add_field! :endpoint,      "speech.googleapis.com", match: ::String
+  config.add_field! :credentials,   nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
+  config.add_field! :scope,         nil, match: [::Array, ::String]
+  config.add_field! :lib_name,      nil, match: ::String
+  config.add_field! :lib_version,   nil, match: ::String
+  config.add_field! :interceptors,  nil, match: ::Array
+  config.add_field! :timeout,       nil, match: ::Numeric
+  config.add_field! :metadata,      nil, match: ::Hash
+  config.add_field! :retry_policy,  nil, match: [::Hash, ::Proc]
+  config.add_field! :quota_project, nil, match: ::String
+end
 
 module Google
   module Cloud
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for Cloud Speech API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
-    #
-    # [Cloud Speech API][Product Documentation]:
-    # Converts audio to text by applying powerful neural network models.
-    # - [Product Documentation][]
-    #
-    # ## Quick Start
-    # In order to use this library, you first need to go through the following
-    # steps:
-    #
-    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-    # 3. [Enable the Cloud Speech API.](https://console.cloud.google.com/apis/library/speech.googleapis.com)
-    # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
-    #
-    # ### Installation
-    # ```
-    # $ gem install google-cloud-speech
-    # ```
-    #
-    # ### Migration Guide
-    #
-    # The 0.30.0 release introduced breaking changes relative to the previous
-    # release, 0.29.0. For more details and instructions to migrate your code,
-    # please visit the [migration
-    # guide](https://cloud.google.com/speech-to-text/docs/ruby-client-migration).
-    #
-    # ### Preview
-    # #### SpeechClient
-    # ```rb
-    # require "google/cloud/speech"
-    #
-    # speech_client = Google::Cloud::Speech.new
-    # language_code = "en-US"
-    # sample_rate_hertz = 44100
-    # encoding = :FLAC
-    # config = {
-    #   language_code: language_code,
-    #   sample_rate_hertz: sample_rate_hertz,
-    #   encoding: encoding
-    # }
-    # uri = "gs://bucket-name/hello.flac"
-    # audio = { uri: uri }
-    # response = speech_client.recognize(config, audio)
-    # ```
-    #
-    # ### Next Steps
-    # - Read the [Cloud Speech API Product documentation][Product Documentation]
-    #   to learn more about the product and see How-to Guides.
-    # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
-    #   to see the full list of Cloud APIs that we cover.
-    #
-    # [Product Documentation]: https://cloud.google.com/speech
-    #
-    # ## Enabling Logging
-    #
-    # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-    # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
-    # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
-    # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-    # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-    #
-    # Configuring a Ruby stdlib logger:
-    #
-    # ```ruby
-    # require "logger"
-    #
-    # module MyLogger
-    #   LOGGER = Logger.new $stderr, level: Logger::WARN
-    #   def logger
-    #     LOGGER
-    #   end
-    # end
-    #
-    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-    # module GRPC
-    #   extend MyLogger
-    # end
-    # ```
-    #
     module Speech
-      # rubocop:enable LineLength
-
-      FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("speech"))
+      ##
+      # Create a new client object for Speech.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Speech::V1::Speech::Client](https://googleapis.dev/ruby/google-cloud-speech-v1/latest/Google/Cloud/Speech/V1/Speech/Client.html)
+      # for version V1 of the API.
+      # However, you can specify specify a different API version by passing it in the
+      # `version` parameter. If the Speech service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      #
+      # ## About Speech
+      #
+      # Service that implements Google Cloud Speech API.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @return [Speech::Client] A client object for the specified version.
+      #
+      def self.speech version: :v1, &block
+        require "google/cloud/speech/#{version.to_s.downcase}"
 
-      AVAILABLE_VERSIONS = Dir["#{FILE_DIR}/*"]
-        .select { |file| File.directory?(file) }
-        .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
-        .select { |dir| File.exist?(dir + ".rb") }
-        .map { |dir| File.basename(dir) }
+        package_name = Google::Cloud::Speech
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        package_module = Google::Cloud::Speech.const_get package_name
+        package_module.const_get(:Speech).const_get(:Client).new(&block)
+      end
 
       ##
-      # Service that implements Google Cloud Speech API.
+      # Configure the google-cloud-speech library.
       #
-      # @param version [Symbol, String]
-      #   The major version of the service to be used. By default :v1
-      #   is used.
-      # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
-      #   @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
-      #     Provides the means for authenticating requests made by the client. This parameter can
-      #     be many types.
-      #     A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
-      #     authenticating requests made by this client.
-      #     A `String` will be treated as the path to the keyfile to be used for the construction of
-      #     credentials for this client.
-      #     A `Hash` will be treated as the contents of a keyfile to be used for the construction of
-      #     credentials for this client.
-      #     A `GRPC::Core::Channel` will be used to make calls through.
-      #     A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
-      #     should already be composed with a `GRPC::Core::CallCredentials` object.
-      #     A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
-      #     metadata for requests, generally, to give OAuth credentials.
-      #   @param scopes [Array<String>]
-      #     The OAuth scopes for this service. This parameter is ignored if
-      #     an updater_proc is supplied.
-      #   @param client_config [Hash]
-      #     A Hash for call options for each method. See
-      #     Google::Gax#construct_settings for the structure of
-      #     this data. Falls back to the default config if not specified
-      #     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(*args, version: :v1, **kwargs)
-        unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
-          raise "The version: #{version} is not available. The available versions " \
-            "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
-        end
+      # The following configuration parameters are supported:
+      #
+      # * `credentials` (*type:* `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.
+      # * `lib_name` (*type:* `String`) -
+      #   The library name as recorded in instrumentation and logging.
+      # * `lib_version` (*type:* `String`) -
+      #   The library version as recorded in instrumentation and logging.
+      # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
+      #   An array of interceptors that are run before calls are executed.
+      # * `timeout` (*type:* `Numeric`) -
+      #   Default timeout in seconds.
+      # * `metadata` (*type:* `Hash{Symbol=>String}`) -
+      #   Additional gRPC headers to be sent with the call.
+      # * `retry_policy` (*type:* `Hash`) -
+      #   The retry policy. The value is a hash with the following keys:
+      #     * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+      #     * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+      #     * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+      #     * `:retry_codes` (*type:* `Array<String>`) -
+      #       The error codes that should trigger a retry.
+      #
+      # @return [::Google::Cloud::Config] The default configuration used by this library
+      #
+      def self.configure
+        yield ::Google::Cloud.configure.speech if block_given?
 
-        require "#{FILE_DIR}/#{version.to_s.downcase}"
-        version_module = Google::Cloud::Speech
-          .constants
-          .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-          .first
-        Google::Cloud::Speech.const_get(version_module).new(*args, **kwargs)
+        ::Google::Cloud.configure.speech
       end
     end
   end
 end
+
+helper_path = ::File.join __dir__, "speech", "helpers.rb"
+require "google/cloud/speech/helpers" if ::File.file? helper_path

data/lib/google-cloud-speech.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/speech" unless defined? Google::Cloud::Speech::VERSION

metadata

@@ -1,71 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-speech
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: google-gax
+  name: google-cloud-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-speech-v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+- !ruby/object:Gem::Dependency
+  name: google-cloud-speech-v1p1beta1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+- !ruby/object:Gem::Dependency
+  name: google-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -94,49 +176,30 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: google-cloud-speech is the official library for Cloud Speech API.
+description: Google Speech-to-Text enables developers to convert audio to text by
+  applying powerful neural network models in an easy-to-use API. The API recognizes
+  more than 120 languages and variants to support your global user base. You can enable
+  voice command-and-control, transcribe audio from call centers, and more. It can
+  process real-time streaming or prerecorded audio, using Google's machine learning
+  technology.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
-- LICENSE
+- AUTHENTICATION.md
+- LICENSE.md
+- MIGRATING.md
 - README.md
+- lib/google-cloud-speech.rb
 - lib/google/cloud/speech.rb
-- lib/google/cloud/speech/v1.rb
-- lib/google/cloud/speech/v1/cloud_speech_pb.rb
-- lib/google/cloud/speech/v1/cloud_speech_services_pb.rb
-- lib/google/cloud/speech/v1/credentials.rb
-- lib/google/cloud/speech/v1/doc/google/cloud/speech/v1/cloud_speech.rb
-- lib/google/cloud/speech/v1/doc/google/longrunning/operations.rb
-- lib/google/cloud/speech/v1/doc/google/protobuf/any.rb
-- lib/google/cloud/speech/v1/doc/google/protobuf/duration.rb
-- lib/google/cloud/speech/v1/doc/google/rpc/status.rb
-- lib/google/cloud/speech/v1/helpers.rb
-- lib/google/cloud/speech/v1/speech_client.rb
-- lib/google/cloud/speech/v1/speech_client_config.json
-- lib/google/cloud/speech/v1/stream.rb
-- lib/google/cloud/speech/v1p1beta1.rb
-- lib/google/cloud/speech/v1p1beta1/cloud_speech_pb.rb
-- lib/google/cloud/speech/v1p1beta1/cloud_speech_services_pb.rb
-- lib/google/cloud/speech/v1p1beta1/credentials.rb
-- lib/google/cloud/speech/v1p1beta1/doc/google/cloud/speech/v1p1beta1/cloud_speech.rb
-- lib/google/cloud/speech/v1p1beta1/doc/google/longrunning/operations.rb
-- lib/google/cloud/speech/v1p1beta1/doc/google/protobuf/any.rb
-- lib/google/cloud/speech/v1p1beta1/doc/google/protobuf/duration.rb
-- lib/google/cloud/speech/v1p1beta1/doc/google/rpc/status.rb
-- lib/google/cloud/speech/v1p1beta1/helpers.rb
-- lib/google/cloud/speech/v1p1beta1/speech_client.rb
-- lib/google/cloud/speech/v1p1beta1/speech_client_config.json
-- lib/google/cloud/speech/v1p1beta1/stream.rb
-homepage: https://github.com/googleapis/googleapis
+- lib/google/cloud/speech/version.rb
+homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 'The 0.30.0 release introduced breaking changes relative to
-  the previous release, 0.29.0. For more details and instructions to migrate your
-  code, please visit the migration guide: https://cloud.google.com/speech-to-text/docs/ruby-client-migration.'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -144,16 +207,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
-summary: API Client library for Cloud Speech API
+summary: API Client library for the Cloud Speech-to-Text API
 test_files: []