google-iam-credentials 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49e7bd4d91cd9584271ea5e4baa256216d00be74791c4af9f1524838c1a1a19a
-  data.tar.gz: 7f5110a17e914de42e7e151c8329e61d3295a6c3a1dcf12bef5c12e522e730ca
+  metadata.gz: af76790edf0558d8ec7bbad76ec9e66e70a1e49c7228639f2574957684a5c1cb
+  data.tar.gz: f1d3984a0d817cba1922dde2c47bb92ccea2fa1ccbf834db434b65132be44c51
 SHA512:
-  metadata.gz: fc45a5257e66fa96cb1e74ebc48fb45ccbf06aa074c82960f4e659c6962235b04cd9926bcd40f452ee7b62a41d01b229da3a2d8b30306fafd81d3295392f7765
-  data.tar.gz: 19042b40a8e44a8ab2850eaac8ec466c614478c5a2bb5ab4e833862e64d0850bf32f4b0b5b5bc208d4bb42bfcdd37a53c2a02e6ff72efea4919818d0c71fabdd
+  metadata.gz: c087ef8d4d28b4575f94a1ed53ab70370abab14522e63ea3dc2a203c90e570375cf74658b9ab43491f4f7e70282b8c966fe3035107ed9cb8f05cedc883443358
+  data.tar.gz: e5715bef42da857f7e1a70f7a9cb9a5661dbc72d82d88d5debba0aee8b6604628a50e09d0bfbeca0e84a186a9b631175e22f01cb1c7bdc202547842184b3e336

data/README.md

@@ -7,7 +7,7 @@ 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 the main client library that brings the
-verisoned gems in as dependencies, and provides high-level methods for
+versioned gems in as dependencies, and provides high-level methods for
 constructing clients. More information on versioned clients can be found below
 in the section titled *Which client should I use?*.
 
@@ -34,9 +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/iamcredentials.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+## 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-iam-credentials-v1](https://cloud.google.com/ruby/docs/reference/google-iam-credentials-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/iam/credentials/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Iam
     module Credentials
-      VERSION = "1.4.1"
+      VERSION = "1.5.1"
     end
   end
 end

data/lib/google/iam/credentials.rb

@@ -40,6 +40,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 IAMCredentials service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Iam::Credentials.iam_credentials_available?}.
+      #
       # ## About IAMCredentials
       #
       # A service account is a special type of Google account that belongs to your
@@ -68,6 +73,37 @@ module Google
         service_module = service_module.const_get(:Rest) if transport == :rest
         service_module.const_get(:Client).new(&block)
       end
+
+      ##
+      # Determines whether the IAMCredentials service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Iam::Credentials.iam_credentials}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the IAMCredentials service,
+      # or if the versioned client gem needs an update to support the IAMCredentials 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.iam_credentials_available? version: :v1, transport: :grpc
+        require "google/iam/credentials/#{version.to_s.downcase}"
+        package_name = Google::Iam::Credentials
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Iam::Credentials.const_get package_name
+        return false unless service_module.const_defined? :IAMCredentials
+        service_module = service_module.const_get :IAMCredentials
+        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
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-iam-credentials
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.1
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -64,7 +63,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -72,15 +70,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.8
 specification_version: 4
 summary: API Client library for the IAM Service Account Credentials API
 test_files: []