google-cloud-automl 0.7.1 → 1.0.0

data/README.md

@@ -1,42 +1,53 @@
-# Ruby Client for Cloud AutoML API
+# Ruby Client for the Cloud AutoML API
 
-[Cloud AutoML API][Product Documentation]:
-Train high-quality custom machine learning models with minimum effort and
-machine learning expertise.
-- [Client Library Documentation][]
-- [Product Documentation][]
+API Client library for the Cloud AutoML API
 
-## Quick Start
-In order to use this library, you first need to go through the following
-steps:
+AutoML makes the power of machine learning available to you even if you have limited knowledge of machine learning. You can use AutoML to build on Google's machine learning capabilities to create your own custom machine learning models that are tailored to your business needs, and then integrate those models into your applications and web sites.
 
-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 AutoML API.](https://console.cloud.google.com/apis/library/automl.googleapis.com)
-4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-automl/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-automl-v*`.
+The gem `google-cloud-automl` 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-automl/latest)
+for this library, google-cloud-automl, 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-automl-v1](https://googleapis.dev/ruby/google-cloud-automl-v1/latest),
+[google-cloud-automl-v1beta1](https://googleapis.dev/ruby/google-cloud-automl-v1beta1/latest).
+
+See also the [Product Documentation](https://cloud.google.com/automl)
+for more usage information.
+
+## Quick Start
 
-### Installation
 ```
 $ gem install google-cloud-automl
 ```
 
-### Next Steps
-- Read the [Client Library Documentation][] for Cloud AutoML API
-  to see other available methods on the client.
-- Read the [Cloud AutoML 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:
+
+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/automl.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Migrating from 0.x versions
 
-[Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-automl/latest
-[Product Documentation]: https://cloud.google.com/automl
+The 1.0 release of the google-cloud-automl 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-automl.rb

@@ -1,4 +1,6 @@
-# Copyright 2019 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,4 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "google/cloud/automl"
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/automl" unless defined? Google::Cloud::AutoML::VERSION

data/lib/google/cloud/automl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,208 +14,148 @@
 # 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/automl/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! :automl do |config|
+  config.add_field! :endpoint,      "automl.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 AutoML API
-    #
-    # [Cloud AutoML API][Product Documentation]:
-    # Train high-quality custom machine learning models with minimum effort and
-    # machine learning expertise.
-    # - [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 AutoML API.](https://console.cloud.google.com/apis/library/automl.googleapis.com)
-    # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-automl/latest/file.AUTHENTICATION.html)
-    #
-    # ### Installation
-    # ```
-    # $ gem install google-cloud-automl
-    # ```
-    #
-    # ### Next Steps
-    # - Read the [Cloud AutoML 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/automl
-    #
-    # ## 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 AutoML
-      # rubocop:enable LineLength
-
-      FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("automl"))
+      ##
+      # Create a new client object for PredictionService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::AutoML::V1::PredictionService::Client](https://googleapis.dev/ruby/google-cloud-automl-v1/latest/Google/Cloud/AutoML/V1/PredictionService/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 PredictionService service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      #
+      # ## About PredictionService
+      #
+      # AutoML Prediction API.
+      #
+      # On any input that is documented to expect a string parameter in
+      # snake_case or kebab-case, either of those cases is accepted.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @return [PredictionService::Client] A client object for the specified version.
+      #
+      def self.prediction_service version: :v1, &block
+        require "google/cloud/automl/#{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::AutoML
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        package_module = Google::Cloud::AutoML.const_get package_name
+        package_module.const_get(:PredictionService).const_get(:Client).new(&block)
+      end
 
-      module AutoML
-        ##
-        # AutoML Server API.
-        #
-        # The resource names are assigned by the server.
-        # The server never reuses names that it has created after the resources with
-        # those names are deleted.
-        #
-        # An ID of a resource is the last element of the item's resource name. For
-        # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`, then
-        # the id for the item is `{dataset_id}`.
-        #
-        # Currently the only supported `location_id` is "us-central1".
-        #
-        # On any input that is documented to expect a string parameter in
-        # snake_case or kebab-case, either of those cases is accepted.
-        #
-        # @param version [Symbol, String]
-        #   The major version of the service to be used. By default :v1beta1
-        #   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: :v1beta1, **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 AutoML.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::AutoML::V1::AutoML::Client](https://googleapis.dev/ruby/google-cloud-automl-v1/latest/Google/Cloud/AutoML/V1/AutoML/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 AutoML service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      #
+      # ## About AutoML
+      #
+      # AutoML Server API.
+      #
+      # The resource names are assigned by the server.
+      # The server never reuses names that it has created after the resources with
+      # those names are deleted.
+      #
+      # An ID of a resource is the last element of the item's resource name. For
+      # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`, then
+      # the id for the item is `{dataset_id}`.
+      #
+      # Currently the only supported `location_id` is "us-central1".
+      #
+      # On any input that is documented to expect a string parameter in
+      # snake_case or kebab-case, either of those cases is accepted.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @return [AutoML::Client] A client object for the specified version.
+      #
+      def self.auto_ml version: :v1, &block
+        require "google/cloud/automl/#{version.to_s.downcase}"
 
-          require "#{FILE_DIR}/#{version.to_s.downcase}"
-          version_module = Google::Cloud::AutoML
-            .constants
-            .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-            .first
-          Google::Cloud::AutoML.const_get(version_module)::AutoML.new(*args, **kwargs)
-        end
+        package_name = Google::Cloud::AutoML
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        package_module = Google::Cloud::AutoML.const_get package_name
+        package_module.const_get(:AutoML).const_get(:Client).new(&block)
       end
 
-      module Prediction
-        ##
-        # AutoML Prediction API.
-        #
-        # On any input that is documented to expect a string parameter in
-        # snake_case or kebab-case, either of those cases is accepted.
-        #
-        # @param version [Symbol, String]
-        #   The major version of the service to be used. By default :v1beta1
-        #   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: :v1beta1, **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-automl 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.automl if block_given?
 
-          require "#{FILE_DIR}/#{version.to_s.downcase}"
-          version_module = Google::Cloud::AutoML
-            .constants
-            .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-            .first
-          Google::Cloud::AutoML.const_get(version_module)::Prediction.new(*args, **kwargs)
-        end
+        ::Google::Cloud.configure.automl
       end
     end
   end
 end
+
+helper_path = ::File.join __dir__, "automl", "helpers.rb"
+require "google/cloud/automl/helpers" if ::File.file? helper_path

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

@@ -1,4 +1,6 @@
-# Copyright 2019 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,11 +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 Cloud
     module AutoML
-      VERSION = "0.7.1".freeze
+      VERSION = "1.0.0"
     end
   end
 end