google-cloud-language 0.36.0 → 1.0.0

data/README.md

@@ -1,41 +1,51 @@
-# Ruby Client for Cloud Natural Language API
+# Ruby Client for the Cloud Natural Language API
 
-[Cloud Natural Language API][Product Documentation]:
-Provides natural language understanding technologies, such as sentiment
-analysis, entity recognition, entity sentiment analysis, and other text
-annotations, to developers.
-- [Client Library Documentation][]
-- [Product Documentation][]
+API Client library for the Cloud Natural Language API
 
-## Quick Start
-In order to use this library, you first need to go through the following
-steps:
+Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations.
 
-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 Natural Language API.](https://console.cloud.google.com/apis/library/language.googleapis.com)
-4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-language/latest/file.AUTHENTICATION.html)
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `google-cloud-language-v*`.
+The gem `google-cloud-language` is a convenience wrapper library that brings the
+verisoned gems in as dependencies, and provides high-level methods for
+constructing clients.
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-language/latest)
+for this library, google-cloud-language, to see the convenience methods for
+constructing client objects. Reference documentation for the client objects
+themselves can be found in the client library documentation for the versioned
+client gems:
+[google-cloud-language-v1](https://googleapis.dev/ruby/google-cloud-language-v1/latest),
+[google-cloud-language-v1beta2](https://googleapis.dev/ruby/google-cloud-language-v1beta2/latest).
+
+See also the [Product Documentation](https://cloud.google.com/natural-language)
+for more usage information.
+
+## Quick Start
 
-### Installation
 ```
 $ gem install google-cloud-language
 ```
 
-### Next Steps
-- Read the [Client Library Documentation][] for Cloud Natural Language API
-  to see other available methods on the client.
-- Read the [Cloud Natural Language 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.
+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)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/language.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Migrating from 0.x versions
 
-[Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-language/latest
-[Product Documentation]: https://cloud.google.com/natural-language
+The 1.0 release of the google-cloud-language client is a significant upgrade
+based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
+and includes substantial interface changes. Existing code written for earlier
+versions of this library will likely require updates to use this version.
+See the {file:MIGRATING.md MIGRATING.md} document for more information.
 
 ## 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,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 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.

data/lib/google-cloud-language.rb

@@ -0,0 +1,35 @@
+# 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!
+
+gem "google-cloud-core"
+require "google/cloud" unless defined? Google::Cloud.new
+require "google/cloud/config"
+require "googleauth"
+
+# Set the default configuration
+Google::Cloud.configure.add_config! :language do |config|
+  config.add_field! :credentials,  nil, match: [String, Hash, Google::Auth::Credentials]
+  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]
+end
+
+require "google/cloud/language/version"

data/lib/google/cloud/language.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,135 +14,76 @@
 # 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/gax"
-require "pathname"
+require "google-cloud-language"
 
 module Google
   module Cloud
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for Cloud Natural Language API
-    #
-    # [Cloud Natural Language API][Product Documentation]:
-    # Provides natural language understanding technologies, such as sentiment
-    # analysis, entity recognition, entity sentiment analysis, and other text
-    # annotations, to developers.
-    # - [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 Natural Language API.](https://console.cloud.google.com/apis/library/language.googleapis.com)
-    # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-language/latest/file.AUTHENTICATION.html)
-    #
-    # ### Installation
-    # ```
-    # $ gem install google-cloud-language
-    # ```
-    #
-    # ### Next Steps
-    # - Read the [Cloud Natural Language 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/natural-language
-    #
-    # ## 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.dev/ruby/google-cloud-logging/latest)
-    # 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 Language
-      # rubocop:enable LineLength
-
-      FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("language"))
-
-      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) }
-
       ##
+      # Create a new client object for LanguageService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Language::V1::LanguageService::Client](https://googleapis.dev/ruby/google-cloud-language-v1/latest/Google/Cloud/Language/V1/LanguageService/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 LanguageService service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      #
+      # ## About LanguageService
+      #
       # Provides text analysis operations such as sentiment analysis and entity
       # recognition.
       #
-      # @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 service_address [String]
-      #     Override for the service hostname, or `nil` to leave as the default.
-      #   @param service_port [Integer]
-      #     Override for the service port, or `nil` to leave as the default.
-      #   @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
+      # @param version [String, Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @return [LanguageService::Client] A client object for the specified version.
+      #
+      def self.language_service version: :v1, &block
+        require "google/cloud/language/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::Language
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        package_module = Google::Cloud::Language.const_get package_name
+        package_module.const_get(:LanguageService).const_get(:Client).new(&block)
+      end
+
+      ##
+      # Configure the google-cloud-language library.
+      #
+      # 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:* `Integer`) -
+      #   Default timeout in milliseconds.
+      # * `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.language if block_given?
 
-        require "#{FILE_DIR}/#{version.to_s.downcase}"
-        version_module = Google::Cloud::Language
-          .constants
-          .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-          .first
-        Google::Cloud::Language.const_get(version_module).new(*args, **kwargs)
+        Google::Cloud.configure.language
       end
     end
   end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Language
-      VERSION = "0.36.0".freeze
+      VERSION = "1.0.0".freeze
     end
   end
 end

metadata

@@ -1,69 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-language
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-03-24 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.8'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: googleapis-common-protos
+  name: google-cloud-language-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.9
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.9
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: googleapis-common-protos-types
+  name: google-cloud-language-v1beta2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: autotest-suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: google-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -79,33 +95,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.10'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: google-style
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !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
@@ -134,8 +178,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: google-cloud-language is the official library for Cloud Natural Language
-  API.
+description: Provides natural language understanding technologies, such as sentiment
+  analysis, entity recognition, entity sentiment analysis, and other text annotations.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -143,25 +187,13 @@ extra_rdoc_files: []
 files:
 - ".yardopts"
 - AUTHENTICATION.md
-- LICENSE
+- LICENSE.md
+- MIGRATING.md
 - README.md
+- lib/google-cloud-language.rb
 - lib/google/cloud/language.rb
-- lib/google/cloud/language/v1.rb
-- lib/google/cloud/language/v1/credentials.rb
-- lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb
-- lib/google/cloud/language/v1/language_service_client.rb
-- lib/google/cloud/language/v1/language_service_client_config.json
-- lib/google/cloud/language/v1/language_service_pb.rb
-- lib/google/cloud/language/v1/language_service_services_pb.rb
-- lib/google/cloud/language/v1beta2.rb
-- lib/google/cloud/language/v1beta2/credentials.rb
-- lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb
-- lib/google/cloud/language/v1beta2/language_service_client.rb
-- lib/google/cloud/language/v1beta2/language_service_client_config.json
-- lib/google/cloud/language/v1beta2/language_service_pb.rb
-- lib/google/cloud/language/v1beta2/language_service_services_pb.rb
 - lib/google/cloud/language/version.rb
-homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-language
+homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
@@ -183,5 +215,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: API Client library for Cloud Natural Language API
+summary: API Client library for the Cloud Natural Language API
 test_files: []