google-cloud-kms-inventory 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1001fc7d1d52a362c29e27ce7ca9b7745664358247643dfe78c9825e87aa33d
-  data.tar.gz: b291471791f709a3d832893252b44d656707d02707e0e9064afdb6b5d3f0ded2
+  metadata.gz: a7b0a9d34e56ccf6b6c293e61d03e17b9875cda27bf37910c5477648b6ee653a
+  data.tar.gz: 221acfbe7d023bc10ffef8847a2596becf6b4c70a60f6cfeeba708ea39620cf7
 SHA512:
-  metadata.gz: 2c0b37662edfeb922afed54dd79100807bf5deba78c956eed8f7300e61567fca88fc490cb2d4aa67ba277425eaad4ab0a29f4ffdfb57d90d92edee8a167bb018
-  data.tar.gz: b3dc876bbb73ba83eaeec2e130206f28cd8911e9d8daf9f8f097dc9ee49454faf8210094f4086c20d9f9cd077260f8f52db50d407c4d02a28249044b73b3161a
+  metadata.gz: 458a787868848eefb7dcbe89a132af129f82e5b94b98f047e8287926a781db311bb2a524ad96a3e9246f86ad206a2a3b2693c5884b4d8ab9de00f272d55f0a5f
+  data.tar.gz: f0b416ed8b1e430bd53628caf1df9998cbf5a091bac84cd38475cbd775049752e488ef4f76e5c192c55bab04813441a7093f819842564c279f25792401b727f9

data/README.md

@@ -7,7 +7,7 @@ google-cloud-kms-inventory is the official client library for the KMS Inventory
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-kms-inventory-v*`.
 The gem `google-cloud-kms-inventory` 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/kmsinventory.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-cloud-kms-inventory-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-kms-inventory-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/cloud/kms/inventory/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Kms
       module Inventory
-        VERSION = "1.2.1"
+        VERSION = "1.3.1"
       end
     end
   end

data/lib/google/cloud/kms/inventory.rb

@@ -59,6 +59,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 KeyDashboardService service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Cloud::Kms::Inventory.key_dashboard_service_available?}.
+        #
         # ## About KeyDashboardService
         #
         # Provides a cross-region view of all Cloud KMS keys in a given Cloud project.
@@ -80,6 +85,37 @@ module Google
           service_module.const_get(:Client).new(&block)
         end
 
+        ##
+        # Determines whether the KeyDashboardService service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Cloud::Kms::Inventory.key_dashboard_service}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the KeyDashboardService service,
+        # or if the versioned client gem needs an update to support the KeyDashboardService 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.key_dashboard_service_available? version: :v1, transport: :grpc
+          require "google/cloud/kms/inventory/#{version.to_s.downcase}"
+          package_name = Google::Cloud::Kms::Inventory
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Cloud::Kms::Inventory.const_get package_name
+          return false unless service_module.const_defined? :KeyDashboardService
+          service_module = service_module.const_get :KeyDashboardService
+          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
+
         ##
         # Create a new client object for KeyTrackingService.
         #
@@ -93,6 +129,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 KeyTrackingService service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Cloud::Kms::Inventory.key_tracking_service_available?}.
+        #
         # ## About KeyTrackingService
         #
         # Returns information about the resources in an org that are protected by a
@@ -115,6 +156,37 @@ module Google
           service_module.const_get(:Client).new(&block)
         end
 
+        ##
+        # Determines whether the KeyTrackingService service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Cloud::Kms::Inventory.key_tracking_service}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the KeyTrackingService service,
+        # or if the versioned client gem needs an update to support the KeyTrackingService 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.key_tracking_service_available? version: :v1, transport: :grpc
+          require "google/cloud/kms/inventory/#{version.to_s.downcase}"
+          package_name = Google::Cloud::Kms::Inventory
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Cloud::Kms::Inventory.const_get package_name
+          return false unless service_module.const_defined? :KeyTrackingService
+          service_module = service_module.const_get :KeyTrackingService
+          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
+
         ##
         # Configure the google-cloud-kms-inventory library.
         #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-kms-inventory
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -62,7 +61,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,15 +68,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 KMS Inventory API
 test_files: []