google-iam-credentials 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c72168a698feb2fceec04ee47c839668255ac567aaf5539336c3d583309ae889
-  data.tar.gz: e3ca84b66cdbf098dfe73ba8289ac3236bd4981be116a9addb63030681ce72d8
+  metadata.gz: cd70ee9d513c282bd7ee06e3eedcaf9a75cf474e09b4a40e26918007e42eb17b
+  data.tar.gz: f83981e29f6a6c80f5f4608afbd320f85375aa90e0120cc61178530d285d35a4
 SHA512:
-  metadata.gz: 00acacc7ac8c27a79e052e483b81682fd3d1423a5a058b5dabd332077dafa07f8d93bc879280d586c28fc4624ac74742b900b84f06b39b151ad9c0f96bac64d1
-  data.tar.gz: 400967c97e6341071c344fe88b3ce9086f1e63f904f5063e2fcbd2867cee064d8362a3ed37afcc38c22ff62f50f6a717457874a856c5273be50e8e36ac79ad0e
+  metadata.gz: 4b1b71f6f24443093dd2d59153bff7df44f7a359889c7429cdae0f91e4740e7c41aeb53185ecc8b993d9f8f4671d4f6f39e62c7146727500112d8e88377e0090
+  data.tar.gz: fdc0679cbb00d55e67d2c09603a9330118e473207a07533f1346e571dca0aea9b5a31e7a03ecf95d72684e958288b5a2554f0259633f3bcb2210bacca110437c

data/README.md

@@ -6,9 +6,10 @@ The Service Account Credentials API creates short-lived credentials for Identity
 
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-iam-credentials-v*`.
-The gem `google-iam-credentials` is a convenience wrapper library that brings the
+The gem `google-iam-credentials` 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-iam-credentials/latest)
 for this library, google-iam-credentials, 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-iam-credentials`,
+and lower-level _versioned_ client libraries with names such as
+`google-iam-credentials-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-iam-credentials`.
+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-iam-credentials-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/iam/credentials/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Iam
     module Credentials
-      VERSION = "0.1.0"
+      VERSION = "0.1.1"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-iam-credentials
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the IAM Service Account Credentials API