google-cloud-language 0.36.0 → 1.4.0

data/MIGRATING.md

@@ -0,0 +1,289 @@
+## Migrating to google-cloud-language 1.0
+
+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.
+This document describes the changes that have been made, and what you need to
+do to update your usage.
+
+To summarize:
+
+ *  The library has been broken out into three libraries. The new gems
+    `google-cloud-language-v1` and `google-cloud-language-v1beta2` contain the
+    actual client classes for versions V1 and V1beta2 of the Natural Language
+    service, and the gem `google-cloud-language` now simply provides a
+    convenience wrapper. See [Library Structure](#library-structure) for more
+    info.
+ *  The library uses a new configuration mechanism giving you closer control
+    over endpoint address, network timeouts, and retry. See
+    [Client Configuration](#client-configuration) for more info. Furthermore,
+    when creating a client object, you can customize its configuration in a
+    block rather than passing arguments to the constructor. See
+    [Creating Clients](#creating-clients) for more info.
+ *  Previously, positional arguments were used to indicate required arguments.
+    Now, all method arguments are keyword arguments, with documentation that
+    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.
+
+### Library Structure
+
+Older 0.x releases of the `google-cloud-language` gem were all-in-one gems that
+included potentially multiple clients for multiple versions of the Natural
+Language service. The `Google::Cloud::Language.new` factory method would
+return you an instance of a `Google::Cloud::Language::V1::LanguageServiceClient`
+object for the V1 version of the service, or a
+`Google::Cloud::Language::V1beta2::LanguageServiceClient` object for the
+V1beta2 version of the service. All these classes were defined in the same gem.
+
+With the 1.0 release, the `google-cloud-language` gem still provides factory
+methods for obtaining clients. (The method signatures will have changed. See
+[Creating Clients](#creating-clients) for details.) However, the actual client
+classes have been moved into separate gems, one per service version. The
+`Google::Cloud::Language::V1::LanguageService::Client` class, along with its
+helpers and data types, is now part of the `google-cloud-language-v1` gem.
+Similarly, the `Google::Cloud::Language::V1beta2::LanguageService::Client`
+class is part of the `google-cloud-language-v1beta2` gem. 
+
+For normal usage, you can continue to install the `google-cloud-language` gem
+(which will bring in the versioned client gems as dependencies) and continue to
+use factory methods to create clients. However, you may alternatively choose to
+install only one of the versioned gems. For example, if you know you will only
+`V1` of the service, you can install `google-cloud-language-v1` by itself, and
+construct instances of the
+`Google::Cloud::Language::V1::LanguageService::Client` client class directly.
+
+### Client Configuration
+
+In older releases, if you wanted to customize performance parameters or
+low-level behavior of the client (such as credentials, timeouts, or
+instrumentation), you would pass a variety of keyword arguments to the client
+constructor. It was also extremely difficult to customize the default settings.
+
+With the 1.0 release, a configuration interface provides control over these
+parameters, including defaults for all instances of a client, and settings for
+each specific client instance. For example, to set default credentials and
+timeout for all Language V1 clients:
+
+```
+Google::Cloud::Language::V1::LanguageService::Client.configure do |config|
+  config.credentials = "/path/to/credentials.json"
+  config.timeout = 10.0
+end
+```
+
+Individual RPCs can also be configured independently. For example, to set the
+timeout for the `analyze_sentiment` call:
+
+```
+Google::Cloud::Language::V1::LanguageService::Client.configure do |config|
+  config.rpcs.analyze_sentinment.timeout = 20.0
+end
+```
+
+Defaults for certain configurations can be set for all Language versions
+globally:
+
+```
+Google::Cloud::Language.configure do |config|
+  config.credentials = "/path/to/credentials.json"
+  config.timeout = 10.0
+end
+```
+
+Finally, you can override the configuration for each client instance. See the
+next section on [Creating Clients](#creating-clients) for details.
+
+### Creating Clients
+
+In older releases, to create a client object, you would use the
+`Google::Cloud::Language.new` class method. Keyword arguments were available to
+select a service version and to configure parameters such as credentials and
+timeouts.
+
+With the 1.0 release, use the `Google::Cloud::Language.language_service` class
+method to create a client object. You may select a service version using the
+`:version` keyword argument. However, other configuration parameters should be
+set in a configuration block when you create the client.
+
+Old:
+```
+client = Google::Cloud::Language.new credentials: "/path/to/credentials.json"
+```
+
+New:
+```
+client = Google::Cloud::Language.language_service do |config|
+  config.credentials = "/path/to/credentials.json"
+end
+```
+
+The configuration block is optional. If you do not provide it, or you do not
+set some configuration parameters, then the default configuration is used. See
+[Client Configuration](#client-configuration).
+
+### Passing Arguments
+
+In older releases, required arguments would be passed as positional method
+arguments, while most optional arguments would be passed as keyword arguments.
+
+With the 1.0 release, all RPC arguments are passed as keyword arguments,
+regardless of whether they are required or optional. For example:
+
+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
+
+# Document is a positional argument, while encoding_type is a keyword argument.
+response = client.analyze_sentiment document, encoding_type: encoding
+```
+
+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
+
+# Both document and encoding_type are keyword arguments.
+response = client.analyze_sentiment document: document, encoding_type: encoding
+```
+
+In the 1.0 release, it is also possible to pass a request object, either
+as a hash or as a protocol buffer.
+
+New:
+```
+client = Google::Cloud::Language.language_service
+
+request = Google::Cloud::Language::V1::AnalyzeSentimentRequest.new(
+  document: {
+    content: "I love API calls!",
+    type: Google::Cloud::Language::V1::Document::Type::PLAIN_TEXT
+  },
+  encoding_type: Google:Cloud::Language::V1::EncodingType::UTF8
+)
+
+# Pass a request object as a positional argument:
+response = client.analyze_sentiment request
+```
+
+Finally, in older releases, to provide call options, you would pass a
+`Google::Gax::CallOptions` object with the `:options` keyword argument. In the
+1.0 release, pass call options using a _second set_ of keyword arguments.
+
+Old:
+```
+client = Google::Cloud::Language.new
+
+document = {
+  content: "I love API calls!",
+  type: Google::Cloud::Language::V1::Document::Type::PLAIN_TEXT
+}
+
+options = Google::Gax::CallOptions.new timeout: 10.0
+
+response = client.analyze_sentiment document, options: options
+```
+
+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
+
+# Use a hash to wrap the normal call arguments (or pass a request object), and
+# then add further keyword arguments for the call options.
+response = client.analyze_sentiment(
+  { document: document, encoding_type: encoding },
+  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
+`Google::Cloud::Language::V1::LanguageServiceClient`.
+In the 1.0 release, the client object is of class
+`Google::Cloud::Language::V1::LanguageService::Client`.
+Note that most users will use the `Google::Cloud::Language.language_service`
+factory method to create instances of the client object, so you may not need to
+reference the actual class directly.
+See [Creating Clients](#creating-clients).
+
+In older releases, the credentials object was of class
+`Google::Cloud::Language::V1::Credentials`.
+In the 1.0 release, the credentials object is of class
+`Google::Cloud::Language::V1::LanguageService::Credentials`.
+Again, most users will not need to reference this class directly.
+See [Client Configuration](#client-configuration).

data/README.md

@@ -1,43 +1,54 @@
-# 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 the main client library that brings the
+verisoned gems in as dependencies, and provides high-level methods for
+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://cloud.google.com/ruby/docs/reference/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:
 
-[Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-language/latest
-[Product Documentation]: https://cloud.google.com/natural-language
+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
+
+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)
+that will write logs to [Cloud 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:
@@ -60,11 +71,69 @@ end
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.4+.
+This library is supported on Ruby 2.6+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-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.
+in security maintenance, and not end of life. 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/version.rb

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