google-cloud-recommender 0.2.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a88816229a893ade1165a7e1bbdd99de343691939acfbd5287e27b150d562d4
-  data.tar.gz: 4e13c5d9af6471b05ecb2032759e84edc81c901874ede8bb168ca1a19897f96b
+  metadata.gz: 92934b2dbb2b5fc1cec4fbcab92b9755b1d93a6607c7ed7e4b09e6bc434c017a
+  data.tar.gz: 89b18b07e6a38d0ed0dd02be9e42497f0aa221bb88a6c8a9f4299c36e4855e09
 SHA512:
-  metadata.gz: 849aebdfa017c2960efd1fb1c123b88e1158cd65d7c69eca01b3c6124f7c1f9f38e3afeaa64d7d761b2ad7440e1b188d28355c1d4b153225c871744da51835ce
-  data.tar.gz: de9384859f900b31ad3cc97e7e0b6a743a780d16a88693a954bab6cb95c8403b2a2d7e071ebd60ca0139856f0463b4e0a3574d0073ba61d6e7e6e40c1402846c
+  metadata.gz: 26c8f744d7c7273deb5b43e634f14635f023f5edcfabd510b4c6cf2a8dc74c559b8d1949f1a3343696b0a2c72140e6025e57bfc679e5ddaf817dcc4250e7fd65
+  data.tar.gz: 2eb0d8b648d228de5e99c44ee505229422c9e8c267d61c0fd89fdc0ef00538acb8bc361ec9f7057feaf7bb81a97b31cb71b6180bf09dfefc800b6fdbc9ef4292

data/AUTHENTICATION.md

@@ -64,7 +64,7 @@ containers where writing files is difficult or not encouraged.
 
 The environment variables that google-cloud-recommender
 checks for credentials are configured on the service Credentials class (such as
-`Google::Cloud::Recommender::V1::Recommender::Credentials`):
+`::Google::Cloud::Recommender::V1::Recommender::Credentials`):
 
 1. `RECOMMENDER_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `RECOMMENDER_KEYFILE` - Path to JSON file, or JSON contents

data/README.md

@@ -6,9 +6,10 @@ Recommender is a service on Google Cloud that provides usage recommendations for
 
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-recommender-v*`.
-The gem `google-cloud-recommender` is a convenience wrapper library that brings the
+The gem `google-cloud-recommender` is the main client library that brings the
 verisoned gems in as dependencies, and provides high-level methods for
-constructing clients.
+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-recommender/latest)
 for this library, google-cloud-recommender, to see the convenience methods for
@@ -69,3 +70,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## 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-recommender`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-recommender-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-recommender`.
+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-recommender-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-recommender.rb

@@ -16,4 +16,4 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/recommender"
+require "google/cloud/recommender" unless defined? Google::Cloud::Recommender::VERSION

data/lib/google/cloud/recommender.rb

@@ -16,21 +16,29 @@
 
 # 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/recommender/version"
+
 require "googleauth"
 gem "google-cloud-core"
-require "google/cloud" unless defined? Google::Cloud.new
+require "google/cloud" unless defined? ::Google::Cloud.new
 require "google/cloud/config"
 
 # Set the default configuration
-Google::Cloud.configure.add_config! :recommender do |config|
-  config.add_field! :credentials,  nil, match: [String, Hash, Google::Auth::Credentials]
-  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]
+::Google::Cloud.configure.add_config! :recommender do |config|
+  config.add_field! :endpoint,      "recommender.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
@@ -49,12 +57,12 @@ module Google
       #
       # ## About Recommender
       #
-      # Provides recommendations for cloud customers for various categories like
-      # performance optimization, cost savings, reliability, feature discovery, etc.
-      # These recommendations are generated automatically based on analysis of user
-      # resources, configuration and monitoring metrics.
+      # Provides insights and recommendations for cloud customers for various
+      # categories like performance optimization, cost savings, reliability, feature
+      # discovery, etc. Insights and recommendations are generated automatically
+      # based on analysis of user resources, configuration and monitoring metrics.
       #
-      # @param version [String, Symbol] The API version to connect to. Optional.
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
       #   Defaults to `:v1`.
       # @return [Recommender::Client] A client object for the specified version.
       #
@@ -83,8 +91,8 @@ module Google
       #   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.
+      # * `timeout` (*type:* `Numeric`) -
+      #   Default timeout in seconds.
       # * `metadata` (*type:* `Hash{Symbol=>String}`) -
       #   Additional gRPC headers to be sent with the call.
       # * `retry_policy` (*type:* `Hash`) -
@@ -95,13 +103,16 @@ module Google
       #     * `:retry_codes` (*type:* `Array<String>`) -
       #       The error codes that should trigger a retry.
       #
-      # @return [Google::Cloud::Config] The default configuration used by this library
+      # @return [::Google::Cloud::Config] The default configuration used by this library
       #
       def self.configure
-        yield Google::Cloud.configure.recommender if block_given?
+        yield ::Google::Cloud.configure.recommender if block_given?
 
-        Google::Cloud.configure.recommender
+        ::Google::Cloud.configure.recommender
       end
     end
   end
 end
+
+helper_path = ::File.join __dir__, "recommender", "helpers.rb"
+require "google/cloud/recommender/helpers" if ::File.file? helper_path

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Recommender
-      VERSION = "0.2.0".freeze
+      VERSION = "1.0.2".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recommender
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: autotest-suffix
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -72,56 +58,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
-  name: minitest-autotest
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: minitest-focus
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -197,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Recommender API