google-cloud-language 1.1.0 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1359ca7a1a84099d3e3f43f8422eee5e6a21b204b76f486890aef31ac5b4a5
-  data.tar.gz: 34d7749401d3c669e3283ac93267dea3f183b29085d0be905500dcae5b888b2c
+  metadata.gz: 2fe3ebc3b023dbdd9fbc86f64095b4f7d9ef317bd9012fd75fc92228e44e8c48
+  data.tar.gz: da788cf6f520d285170a82520dc327290805293dbb276b2d691e20a86b9f2c8d
 SHA512:
-  metadata.gz: 89d4f762c92a5850a59b422be11e9fb9e0c06be127c6ba43807af91af4b7d848752cdce53c53b27433c7f966965007fd651903c162b42724b9cd352e64933323
-  data.tar.gz: cd7c7c2e63c0f151f32d0360ca0cbb294d91887e5666744ca06f669212fa5af91fbc5db91edb97f736e33ac4ed5cf6bacad843148f881e102f531ac4144980c1
+  metadata.gz: 27cebf932ac2154cb38ae35c6d60c5d1ac9305dc03cb9a5e3c013f741df2c8d9e6a1cb8521d241d5b20900e9a321cafd03aa2df31b48106b0e0c3967b234dce2
+  data.tar.gz: fb904c91522d4500d94611a59ccb2e08cb462169d81664d50205efb0cb97f3ca8553979e95b53663d8f2c00d1a8f70c546f559608ba7b82dbfae72a25436b587

data/AUTHENTICATION.md

@@ -64,7 +64,7 @@ containers where writing files is difficult or not encouraged.
 
 The environment variables that google-cloud-language
 checks for credentials are configured on the service Credentials class (such as
-`Google::Cloud::Language::V1::LanguageService::Credentials`):
+`::Google::Cloud::Language::V1::LanguageService::Credentials`):
 
 1. `LANGUAGE_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `LANGUAGE_KEYFILE` - Path to JSON file, or JSON contents

data/MIGRATING.md

@@ -26,6 +26,10 @@ To summarize:
     specifies whether they are required or optional. Additionally, you can pass
     a proto request object instead of separate arguments. See
     [Passing Arguments](#passing-arguments) for more info.
+ *  Previously, clients reported RPC errors by raising instances of
+    `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
+    `Google::Cloud::Error` and its subclasses. See
+    [Handling Errors](#handling-errors) for more info.
  *  Some classes have moved into different namespaces. See
     [Class Namespaces](#class-namespaces) for more info.
 
@@ -71,7 +75,7 @@ timeout for all Language V1 clients:
 ```
 Google::Cloud::Language::V1::LanguageService::Client.configure do |config|
   config.credentials = "/path/to/credentials.json"
-  config.timeout = 10_000
+  config.timeout = 10.0
 end
 ```
 
@@ -80,7 +84,7 @@ timeout for the `analyze_sentiment` call:
 
 ```
 Google::Cloud::Language::V1::LanguageService::Client.configure do |config|
-  config.rpcs.analyze_sentinment.timeout = 20_000
+  config.rpcs.analyze_sentinment.timeout = 20.0
 end
 ```
 
@@ -90,7 +94,7 @@ globally:
 ```
 Google::Cloud::Language.configure do |config|
   config.credentials = "/path/to/credentials.json"
-  config.timeout = 10_000
+  config.timeout = 10.0
 end
 ```
 
@@ -193,7 +197,7 @@ document = {
   type: Google::Cloud::Language::V1::Document::Type::PLAIN_TEXT
 }
 
-options = Google::Gax::CallOptions.new timeout: 10_000
+options = Google::Gax::CallOptions.new timeout: 10.0
 
 response = client.analyze_sentiment document, options: options
 ```
@@ -212,10 +216,60 @@ encoding = Google:Cloud::Language::V1::EncodingType::UTF8
 # then add further keyword arguments for the call options.
 response = client.analyze_sentiment(
   { document: document, encoding_type: encoding },
-  timeout: 10_000
+  timeout: 10.0
 )
 ```
 
+### Handling Errors
+
+The client reports standard
+[gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
+by raising exceptions. In older releases, these exceptions were located in the
+`Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
+exception class, defined in the `google-gax` gem. However, these classes were
+different from the standard exceptions (subclasses of `Google::Cloud::Error`)
+thrown by other client libraries such as `google-cloud-storage`.
+
+The 1.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
+for consistency across all the Google Cloud client libraries. In general, these
+exceptions have the same name as their counterparts from older releases, but
+are located in the `Google::Cloud` namespace rather than the `Google::Gax`
+namespace.
+
+Old:
+```
+client = Google::Cloud::Language.new
+
+document = {
+  content: "I love API calls!",
+  type: Google::Cloud::Language::V1::Document::Type::PLAIN_TEXT
+}
+encoding = Google:Cloud::Language::V1::EncodingType::UTF8
+
+begin
+  response = client.analyze_sentiment document, encoding_type: encoding
+rescue Google::Gax::Error => e
+  # Handle exceptions that subclass Google::Gax::Error
+end
+```
+
+New:
+```
+client = Google::Cloud::Language.language_service
+
+document = {
+  content: "I love API calls!",
+  type: Google::Cloud::Language::V1::Document::Type::PLAIN_TEXT
+}
+encoding = Google:Cloud::Language::V1::EncodingType::UTF8
+
+begin
+  response = client.analyze_sentiment document: document, encoding_type: encoding
+rescue Google::Cloud::Error => e
+  # Handle exceptions that subclass Google::Cloud::Error
+end
+```
+
 ### Class Namespaces
 
 In older releases, the client object was of class

data/README.md

@@ -6,9 +6,10 @@ Provides natural language understanding technologies, such as sentiment analysis
 
 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
+The gem `google-cloud-language` is the main client library that brings the
 verisoned gems in as dependencies, and provides high-level methods for
-constructing clients.
+constructing clients. More information on versioned clients can be found below
+in the section titled *Which client should I use?*.
 
 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
@@ -78,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-language`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-language-v1`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-language`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-language-v1`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/google-cloud-language.rb

@@ -16,4 +16,4 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/language"
+require "google/cloud/language" unless defined? Google::Cloud::Language::VERSION

data/lib/google/cloud/language.rb

@@ -16,21 +16,29 @@
 
 # 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/language/version"
+
 require "googleauth"
 gem "google-cloud-core"
-require "google/cloud" unless defined? Google::Cloud.new
+require "google/cloud" unless defined? ::Google::Cloud.new
 require "google/cloud/config"
 
 # 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]
+::Google::Cloud.configure.add_config! :language do |config|
+  config.add_field! :endpoint,      "language.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
@@ -52,7 +60,7 @@ module Google
       # Provides text analysis operations such as sentiment analysis and entity
       # recognition.
       #
-      # @param version [String, Symbol] The API version to connect to. Optional.
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
       #   Defaults to `:v1`.
       # @return [LanguageService::Client] A client object for the specified version.
       #
@@ -81,8 +89,8 @@ module Google
       #   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.
+      # * `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`) -
@@ -93,13 +101,16 @@ module Google
       #     * `:retry_codes` (*type:* `Array<String>`) -
       #       The error codes that should trigger a retry.
       #
-      # @return [Google::Cloud::Config] The default configuration used by this library
+      # @return [::Google::Cloud::Config] The default configuration used by this library
       #
       def self.configure
-        yield Google::Cloud.configure.language if block_given?
+        yield ::Google::Cloud.configure.language if block_given?
 
-        Google::Cloud.configure.language
+        ::Google::Cloud.configure.language
       end
     end
   end
 end
+
+helper_path = ::File.join __dir__, "language", "helpers.rb"
+require "google/cloud/language/helpers" if ::File.file? helper_path

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-language
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: autotest-suffix
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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
@@ -86,56 +72,56 @@ dependencies:
     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: minitest-autotest
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: minitest-focus
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -212,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Natural Language API