google-cloud-vision 0.38.0 → 1.0.0

data/README.md

@@ -1,67 +1,53 @@
-# Ruby Client for Cloud Vision API
+# 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.dev/ruby/google-cloud-vision/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-vision-v*`.
+The gem `google-cloud-vision` 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-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://cloud-samples-data/vision/face_detection/celebrity_recognition/sergey.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:
+
+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.}
 
-### 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.
+## Migrating from 0.x versions
 
-[Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-vision/latest
-[Product Documentation]: https://cloud.google.com/vision
+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,
+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:

data/lib/{google/cloud/vision/v1/doc/google/protobuf/wrappers.rb → google-cloud-vision.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,15 +14,6 @@
 # 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
-    # Wrapper message for `float`.
-    #
-    # The JSON representation for `FloatValue` is JSON number.
-    # @!attribute [rw] value
-    #   @return [Float]
-    #     The float value.
-    class FloatValue; end
-  end
-end
+require "google/cloud/vision" unless defined? Google::Cloud::Vision::VERSION

data/lib/google/cloud/vision.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,232 +14,147 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# 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/vision/version"
 
-require "google/gax"
-require "pathname"
+require "googleauth"
+gem "google-cloud-core"
+require "google/cloud" unless defined? ::Google::Cloud.new
+require "google/cloud/config"
+
+# Set the default configuration
+::Google::Cloud.configure.add_config! :vision do |config|
+  config.add_field! :endpoint,      "vision.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
   module Cloud
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for 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.
-    # - [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 Vision API.](https://console.cloud.google.com/apis/library/vision.googleapis.com)
-    # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-vision/latest/file.AUTHENTICATION.html)
-    #
-    # ### 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://cloud-samples-data/vision/face_detection/celebrity_recognition/sergey.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)
-    # ```
-    #
-    # ### Next Steps
-    # - 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.
-    #
-    # [Product Documentation]: https://cloud.google.com/vision
-    #
-    # ## 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 Vision
-      # rubocop:enable LineLength
-
-      FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("vision"))
+      ##
+      # Create a new client object for ProductSearch.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Vision::V1::ProductSearch::Client](https://googleapis.dev/ruby/google-cloud-vision-v1/latest/Google/Cloud/Vision/V1/ProductSearch/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 ProductSearch service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      #
+      # ## About ProductSearch
+      #
+      # Manages Products and ProductSets of reference images for use in product
+      # search. It uses the following resource model:
+      #
+      # - The API has a collection of ProductSet resources, named
+      # `projects/*/locations/*/productSets/*`, which acts as a way to put different
+      # products into groups to limit identification.
+      #
+      # In parallel,
+      #
+      # - The API has a collection of Product resources, named
+      #   `projects/*/locations/*/products/*`
+      #
+      # - Each Product has a collection of ReferenceImage resources, named
+      #   `projects/*/locations/*/products/*/referenceImages/*`
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @return [ProductSearch::Client] A client object for the specified version.
+      #
+      def self.product_search version: :v1, &block
+        require "google/cloud/vision/#{version.to_s.downcase}"
 
-      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) }
+        package_name = Google::Cloud::Vision
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        package_module = Google::Cloud::Vision.const_get package_name
+        package_module.const_get(:ProductSearch).const_get(:Client).new(&block)
+      end
 
-      module ImageAnnotator
-        ##
-        # Service that performs Google Cloud Vision API detection tasks over client
-        # images, such as face, landmark, logo, label, and text detection. The
-        # ImageAnnotator service returns detected entities from the images.
-        #
-        # @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
+      ##
+      # Create a new client object for ImageAnnotator.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Vision::V1::ImageAnnotator::Client](https://googleapis.dev/ruby/google-cloud-vision-v1/latest/Google/Cloud/Vision/V1/ImageAnnotator/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 ImageAnnotator service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      #
+      # ## About ImageAnnotator
+      #
+      # Service that performs Google Cloud Vision API detection tasks over client
+      # images, such as face, landmark, logo, label, and text detection. The
+      # ImageAnnotator service returns detected entities from the images.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @return [ImageAnnotator::Client] A client object for the specified version.
+      #
+      def self.image_annotator version: :v1, &block
+        require "google/cloud/vision/#{version.to_s.downcase}"
 
-          require "#{FILE_DIR}/#{version.to_s.downcase}"
-          version_module = Google::Cloud::Vision
-            .constants
-            .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-            .first
-          Google::Cloud::Vision.const_get(version_module)::ImageAnnotator.new(*args, **kwargs)
-        end
+        package_name = Google::Cloud::Vision
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        package_module = Google::Cloud::Vision.const_get package_name
+        package_module.const_get(:ImageAnnotator).const_get(:Client).new(&block)
       end
 
-      module ProductSearch
-        ##
-        # Manages Products and ProductSets of reference images for use in product
-        # search. It uses the following resource model:
-        #
-        # * The API has a collection of {Google::Cloud::Vision::V1::ProductSet ProductSet} resources, named
-        #   `projects/*/locations/*/productSets/*`, which acts as a way to put different
-        #   products into groups to limit identification.
-        #
-        # In parallel,
-        #
-        # * The API has a collection of {Google::Cloud::Vision::V1::Product Product} resources, named
-        #   `projects/*/locations/*/products/*`
-        #
-        # * Each {Google::Cloud::Vision::V1::Product Product} has a collection of {Google::Cloud::Vision::V1::ReferenceImage ReferenceImage} resources, named
-        #   `projects/*/locations/*/products/*/referenceImages/*`
-        #
-        # @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
+      ##
+      # Configure the google-cloud-vision 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.vision if block_given?
 
-          require "#{FILE_DIR}/#{version.to_s.downcase}"
-          version_module = Google::Cloud::Vision
-            .constants
-            .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-            .first
-          Google::Cloud::Vision.const_get(version_module)::ProductSearch.new(*args, **kwargs)
-        end
+        ::Google::Cloud.configure.vision
       end
     end
   end
 end
+
+helper_path = ::File.join __dir__, "vision", "helpers.rb"
+require "google/cloud/vision/helpers" if ::File.file? helper_path