google-cloud-vision 1.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d958fc6a23b30613efb43207e30dcb6e23c95d24c4903be7b30081c5395b78cd
-  data.tar.gz: d0aaeb843ffc9eae20af804fabb9074adee3e7cefdf627ebf4ee39320cc67189
+  metadata.gz: b1129130bd2c66d16a27b2b777d83077bdb67807b64d8ce719aea58b14f500e1
+  data.tar.gz: 950ff11ab47c8499e057508f0f173e24c41a027869f3fca7217b9a87c0c49715
 SHA512:
-  metadata.gz: d143ebbb960c2e14dea53fcf77916162dfc15429cd9aea03d5313a3bbacc552e40913d9d7b7a9f4dd2666b8965cc4a70864de3a47c1fbd2dbf5521cad0299da1
-  data.tar.gz: 15a41b5d9d61da023080a7ecf96d86110fe0d3c5d385a277f4539f6db08722ead7a56506afa8d1c917a25c8110d65a81db0cb03224d66b369396d4a3de61a47c
+  metadata.gz: b6ec715c05f0ca86057266483660a6ef5259110819daea1ba187a60a9e8b9f61a6de5dbd2f5b0a65c170fe4270c3729419ab110169b63c19d9007e1553075cb0
+  data.tar.gz: 5b90a4df63e34147243ccee14a1b9dac063bf8f4f7d62e93c3645c17a94dacb48ca94aa60214631af9bd3b763b778ff779335f6ba4f557f2758060999e669675

data/.yardopts

@@ -8,5 +8,4 @@
 -
 README.md
 AUTHENTICATION.md
-MIGRATING.md
 LICENSE.md

data/README.md

@@ -16,8 +16,7 @@ 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://cloud.google.com/ruby/docs/reference/google-cloud-vision-v1/latest),
-[google-cloud-vision-v1p3beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest).
+[google-cloud-vision-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-vision-v1/latest).
 
 See also the [Product Documentation](https://cloud.google.com/vision)
 for more usage information.
@@ -35,17 +34,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/vision.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
-## 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.
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-vision-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-vision-v1/latest).
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 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

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

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Vision
-      VERSION = "1.5.1"
+      VERSION = "2.0.0"
     end
   end
 end

data/lib/google/cloud/vision.rb

@@ -58,6 +58,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the ProductSearch service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Vision.product_search_available?}.
+      #
       # ## About ProductSearch
       #
       # Manages Products and ProductSets of reference images for use in product
@@ -94,6 +99,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the ProductSearch service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Vision.product_search}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the ProductSearch service,
+      # or if the versioned client gem needs an update to support the ProductSearch service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.product_search_available? version: :v1, transport: :grpc
+        require "google/cloud/vision/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Vision
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Vision.const_get package_name
+        return false unless service_module.const_defined? :ProductSearch
+        service_module = service_module.const_get :ProductSearch
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for ImageAnnotator.
       #
@@ -107,6 +143,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the ImageAnnotator service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Vision.image_annotator_available?}.
+      #
       # ## About ImageAnnotator
       #
       # Service that performs Google Cloud Vision API detection tasks over client
@@ -130,6 +171,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the ImageAnnotator service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Vision.image_annotator}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the ImageAnnotator service,
+      # or if the versioned client gem needs an update to support the ImageAnnotator service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.image_annotator_available? version: :v1, transport: :grpc
+        require "google/cloud/vision/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Vision
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Vision.const_get package_name
+        return false unless service_module.const_defined? :ImageAnnotator
+        service_module = service_module.const_get :ImageAnnotator
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-vision library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-vision
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -28,42 +27,16 @@ dependencies:
   name: google-cloud-vision-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.13'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.13'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-- !ruby/object:Gem::Dependency
-  name: google-cloud-vision-v1p3beta1
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.12'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.12'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.2'
 description: 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.
@@ -75,7 +48,6 @@ files:
 - ".yardopts"
 - AUTHENTICATION.md
 - LICENSE.md
-- MIGRATING.md
 - README.md
 - lib/google-cloud-vision.rb
 - lib/google/cloud/vision.rb
@@ -84,7 +56,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -92,15 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: API Client library for the Cloud Vision API
 test_files: []

data/MIGRATING.md

@@ -1,343 +0,0 @@
-## 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).