google-cloud-vision 0.32.2 → 1.1.3

data/MIGRATING.md

@@ -0,0 +1,343 @@
+## Migrating to google-cloud-vision 1.0
+
+The 1.0 release of the google-cloud-vision 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 multiple libraries. The new gems
+    `google-cloud-vision-v1` and `google-cloud-vision-v1p3beta1` contain the
+    actual client classes for versions V1 and V1p3beta1 of the Vision service,
+    and the gem `google-cloud-vision` 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, some client classes included class methods for constructing
+    resource paths. These paths are now instance methods on the client objects,
+    and are also available in a separate paths module. See
+    [Resource Path Helpers](#resource-path-helpers) for more info.
+ *  Previously, the client included a number of high-level convenience methods,
+    such as `face_detection`, for detecting particular types of features. These
+    methods are still present, but a few of the parameter types (relating to
+    call configuration) have changed. See
+    [High Level Detection Methods](#high-level-detection-methods) 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-vision` gem were all-in-one gems
+that included potentially multiple clients for multiple versions of the Vision
+service. Factory methods such as `Google::Cloud::Vision::ImageAnnotator.new`
+would return you instances of client classes such as
+`Google::Cloud::Vision::V1::ImageAnnotatorClient` or
+`Google::Cloud::Vision::V1p3beta1::ImageAnnotatorClient`, depending on which
+version of the API requested. These classes were all defined in the same gem.
+
+With the 1.0 release, the `google-cloud-vision` 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::Vision::V1::ImageAnnotator::Client` class, along with its
+helpers and data types, is now part of the `google-cloud-vision-v1` gem.
+Similarly, the `Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client`
+class is part of the `google-cloud-vision-v1p3beta1` gem.
+
+For normal usage, you can continue to install the `google-cloud-vision` 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
+use `V1` of the service, you can install `google-cloud-vision-v1` by
+itself, and construct instances of the
+`Google::Cloud::Vision::V1::ImageAnnotator::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 Vision V1 image annotator clients:
+
+```
+Google::Cloud::Vision::V1::ImageAnnotator::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 `batch_annotate_images` call:
+
+```
+Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
+  config.rpcs.batch_annotate_images.timeout = 20.0
+end
+```
+
+Defaults for certain configurations can be set for all Vision versions and
+services globally:
+
+```
+Google::Cloud::Vision.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 `new` method
+of modules under `Google::Cloud::Vision`. For example, you might call
+`Google::Cloud::Vision::ImageAnnotator.new`. Keyword arguments were available to
+select a service version and to configure parameters such as credentials and
+timeouts.
+
+With the 1.0 release, use named class methods of `Google::Cloud::Vision` to
+create a client object. For example, `Google::Cloud::Vision.image_annotator`.
+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::Vision::ImageAnnotator.new credentials: "/path/to/credentials.json"
+```
+
+New:
+```
+client = Google::Cloud::Vision.image_annotator 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::Vision::ImageAnnotator.new
+
+requests = my_create_requests
+
+# requests is a positional argument
+response = client.batch_annotate_images requests
+```
+
+New:
+```
+client = Google::Cloud::Vision.image_annotator
+
+requests = my_create_requests
+
+# requests is a keyword argument
+response = client.batch_annotate_images requests: requests
+```
+
+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::Vision.image_annotator
+
+request_object = Google::Cloud::Vision::V1::BatchAnnotateImagesRequest.new(
+  requests: my_create_requests
+)
+
+# Pass a request object as a positional argument:
+response = client.batch_annotate_images request_object
+```
+
+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::Vision::ImageAnnotator.new
+
+requests = my_create_requests
+
+options = Google::Gax::CallOptions.new timeout: 10.0
+
+response = client.batch_annotate_images requests, options: options
+```
+
+New:
+```
+client = Google::Cloud::Vision.image_annotator
+
+requests = my_create_requests
+
+# 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.batch_annotate_images({ requests: requests }, timeout: 10.0)
+```
+
+### Resource Path Helpers
+
+The client library includes helper methods for generating the resource path
+strings passed to many calls. These helpers have changed in two ways:
+
+* In older releases, they are _class_ methods on the client class. In the 1.0
+  release, they are _instance_ methods on the client. They are also available
+  on a separate paths module that you can include elsewhere for convenience.
+* In older releases, arguments to a resource path helper are passed as
+  _positional_ arguments. In the 1.0 release, they are passed as named _keyword_
+  arguments.
+
+Following is an example involving using a resource path helper.
+
+Old:
+```
+client = Google::Cloud::Vision::ProductSearch.new
+
+# Call the helper on the client class
+location = Google::Cloud::Vision::V1::ProductSearchClient.location_path(
+  "my-project", "my-location"
+)
+
+product = my_build_product
+response = client.create_product location, product
+```
+
+New:
+```
+client = Google::Cloud::Vision.product_search
+
+# Call the helper on the client instance, and use keyword arguments
+location = client.location_path project: "my-project", location: "my-location"
+
+product = my_build_product
+response = client.create_product parent: location, product: product
+```
+
+In the 1.0 client, you can also use the paths module as a convenience module.
+
+New:
+```
+# Bring the path helper methods into the current class
+include Google::Cloud::Vision::V1::ProductSearch::Paths
+
+def foo
+  client = Google::Cloud::Vision.product_search
+
+  # Call the included helper method
+  location = location_path project: "my-project", location: "my-location"
+
+  product = my_build_product
+  response = client.create_product parent: location, product: product
+
+  # Do something with response...
+end
+```
+
+### High Level Detection Methods
+
+The client library includes some high-level convenience methods, with names
+such as `face_detection`, for detecting certain types of features. These
+methods are still present, but a few of the argument types have changed.
+
+ *  The `options` keyword argument is used to pass call options such as timeout
+    and retry. Older versions of the library took an object of type
+    `Google::Gax::CallOptions`. Version 1.0 takes an object of type
+    `Gapic::CallOptions`, which is defined in the `gapic-common` gem. Note that
+    you can also pass a hash with the same keys that the older library accepted.
+ *  If `async` is set to `true`, older versions of the library returned an
+    object of type `Google::Gax::Operation`. Version 1.0 returns an object of
+    type `Gapic::Operation`, which is defined in the `gapic-common` gem. Most
+    methods on this object are the same as the older object.
+
+### 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::Vision::ImageAnnotator.new
+
+requests = my_create_requests
+
+begin
+  response = client.batch_annotate_images requests
+rescue Google::Gax::Error => e
+  # Handle exceptions that subclass Google::Gax::Error
+end
+```
+
+New:
+```
+client = Google::Cloud::Vision.image_annotator
+
+requests = my_create_requests
+
+begin
+  response = client.batch_annotate_images requests: requests
+rescue Google::Cloud::Error => e
+  # Handle exceptions that subclass Google::Cloud::Error
+end
+```
+
+### Class Namespaces
+
+In older releases, the client object was of classes with names like:
+`Google::Cloud::Vision::V1::ProductSearchClient`.
+In the 1.0 release, the client object is of a different class:
+`Google::Cloud::Vision::V1::ProductSearch::Client`.
+Note that most users will use the factory methods such as
+`Google::Cloud::Vision.product_search` 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::Vision::V1::Credentials`.
+In the 1.0 release, each service has its own credentials class, e.g.
+`Google::Cloud::Vision::V1::ProductSearch::Credentials`.
+Again, most users will not need to reference this class directly.
+See [Client Configuration](#client-configuration).

data/README.md

@@ -1,67 +1,54 @@
-# Ruby Client for Cloud Vision API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
+# Ruby Client for the Cloud Vision API
 
-[Cloud Vision API][Product Documentation]:
-Integrates Google Vision features, including image labeling, face, logo, and
-landmark detection, optical character recognition (OCR), and detection of
-explicit content, into applications.
-- [Client Library Documentation][]
-- [Product Documentation][]
+API Client library for the Cloud Vision API
 
-## Quick Start
-In order to use this library, you first need to go through the following
-steps:
+Cloud Vision API allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.
 
-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 Vision API.](https://console.cloud.google.com/apis/library/vision.googleapis.com)
-4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `google-cloud-vision-v*`.
+The gem `google-cloud-vision` 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://googleapis.dev/ruby/google-cloud-vision/latest)
+for this library, google-cloud-vision, 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-vision-v1](https://googleapis.dev/ruby/google-cloud-vision-v1/latest),
+[google-cloud-vision-v1p3beta1](https://googleapis.dev/ruby/google-cloud-vision-v1p3beta1/latest).
+
+See also the [Product Documentation](https://cloud.google.com/vision)
+for more usage information.
+
+## Quick Start
 
-### Installation
 ```
 $ gem install google-cloud-vision
 ```
 
-### Migration Guide
-
-The 0.32.0 release introduced breaking changes relative to the previous release,
-0.31.0. For more details and instructions to migrate your code, please visit the
-[migration
-guide](https://cloud.google.com/vision/docs/ruby-client-migration).
-
-### Preview
-#### ImageAnnotatorClient
-```rb
-require "google/cloud/vision"
-
-image_annotator_client = Google::Cloud::Vision::ImageAnnotator.new
-gcs_image_uri = "gs://gapic-toolkit/President_Barack_Obama.jpg"
-source = { gcs_image_uri: gcs_image_uri }
-image = { source: source }
-type = :FACE_DETECTION
-features_element = { type: type }
-features = [features_element]
-requests_element = { image: image, features: features }
-requests = [requests_element]
-response = image_annotator_client.batch_annotate_images(requests)
-```
+In order to use this library, you first need to go through the following steps:
 
-### Next Steps
-- Read the [Client Library Documentation][] for Cloud Vision API
-  to see other available methods on the client.
-- Read the [Cloud Vision 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.
+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/vision.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
 
-[Client Library Documentation]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-vision/latest/google/cloud/vision/v1
-[Product Documentation]: https://cloud.google.com/vision
+## Migrating from 0.x versions
+
+The 1.0 release of the google-cloud-vision 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,
-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)
+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 [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:
@@ -84,11 +71,69 @@ end
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.3+.
+This library is supported on Ruby 2.5+.
 
 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.3
+in security maintenance, and not end of life. Currently, this means Ruby 2.5
 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-vision`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-vision-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-vision`.
+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-vision-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/vision/{v1/doc/google/protobuf/empty.rb → version.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,18 +14,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
 
 module Google
-  module Protobuf
-    # A generic empty message that you can re-use to avoid defining duplicated
-    # empty messages in your APIs. A typical example is to use it as the request
-    # or the response type of an API method. For instance:
-    #
-    #     service Foo {
-    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
-    #     }
-    #
-    # The JSON representation for `Empty` is empty JSON object `{}`.
-    class Empty; end
+  module Cloud
+    module Vision
+      VERSION = "1.1.3"
+    end
   end
-end
+end