google-cloud-kms 2.8.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1e551be096777f2ecb02162c4b9d795878f5efe670b678690da9a752a203b91
-  data.tar.gz: 14442fcf7a283893bdee930df36a51ee2944d3b9311e5d75ee3cd41ee5f7dd4e
+  metadata.gz: 24073816531885649865cc94d1e0d4eeb4c30b73eb7d9e647e98a7c10c1718dc
+  data.tar.gz: 20fd872302eac220b61fb961e51a04bb1264c491ea0f8f108e2e2292539dfd7e
 SHA512:
-  metadata.gz: 21cba4044019856a2573aea076d5e3506d56aa125c37fcccac4c1a3cecd2657a2b544eeec352927175f2576024b0fba33a01c30b504b125f54b0aeba13b44e48
-  data.tar.gz: 2e17db9eb842587733599cf2aac876b813bf64c06759faab7431ce742c88b2a1444cd8243fbee976b7ef26ecbb9dc6e61d2474f94721ebca6e11e0f0643c742e
+  metadata.gz: 299d5e2d0cd02f5d711b01976110db62872a949010a5e9d054f3faed5b84df7e8f2d3479a4318933ef6b4ff535ee0a49f7d2a9392b3490a866e3877b7eaa6618
+  data.tar.gz: 5a26492613cbdbf49952649fc002c1a350c791003d8c5a0f8d932c168f50bf3befac256c48c86816f79b27b8dfbce9d264259da6cacbf9dc5afce125aae4f7dd

data/README.md

@@ -42,9 +42,39 @@ 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.
 
+## 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-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-kms-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/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Kms
-      VERSION = "2.8.1"
+      VERSION = "2.9.0"
     end
   end
 end

data/lib/google/cloud/kms.rb

@@ -58,9 +58,15 @@ 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 Autokey service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Kms.autokey_available?}.
+      #
       # ## About Autokey
       #
-      # Provides interfaces for using Cloud KMS Autokey to provision new
+      # Provides interfaces for using [Cloud KMS
+      # Autokey](https://cloud.google.com/kms/help/autokey) to provision new
       # CryptoKeys, ready for Customer Managed
       # Encryption Key (CMEK) use, on-demand. To support certain client tooling, this
       # feature is modeled around a KeyHandle
@@ -95,6 +101,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Autokey service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Kms.autokey}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Autokey service,
+      # or if the versioned client gem needs an update to support the Autokey 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.autokey_available? version: :v1, transport: :grpc
+        require "google/cloud/kms/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Kms
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Kms.const_get package_name
+        return false unless service_module.const_defined? :Autokey
+        service_module = service_module.const_get :Autokey
+        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 AutokeyAdmin.
       #
@@ -108,9 +145,15 @@ 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 AutokeyAdmin service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Kms.autokey_admin_available?}.
+      #
       # ## About AutokeyAdmin
       #
-      # Provides interfaces for managing Cloud KMS Autokey folder-level
+      # Provides interfaces for managing [Cloud KMS
+      # Autokey](https://cloud.google.com/kms/help/autokey) folder-level
       # configurations. A configuration is inherited by all descendent projects. A
       # configuration at one folder overrides any other configurations in its
       # ancestry. Setting a configuration on a folder is a prerequisite for Cloud KMS
@@ -135,6 +178,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the AutokeyAdmin service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Kms.autokey_admin}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the AutokeyAdmin service,
+      # or if the versioned client gem needs an update to support the AutokeyAdmin 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.autokey_admin_available? version: :v1, transport: :grpc
+        require "google/cloud/kms/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Kms
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Kms.const_get package_name
+        return false unless service_module.const_defined? :AutokeyAdmin
+        service_module = service_module.const_get :AutokeyAdmin
+        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 EkmService.
       #
@@ -148,6 +222,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 EkmService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Kms.ekm_service_available?}.
+      #
       # ## About EkmService
       #
       # Google Cloud Key Management EKM Service
@@ -173,6 +252,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the EkmService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Kms.ekm_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 EkmService service,
+      # or if the versioned client gem needs an update to support the EkmService 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.ekm_service_available? version: :v1, transport: :grpc
+        require "google/cloud/kms/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Kms
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Kms.const_get package_name
+        return false unless service_module.const_defined? :EkmService
+        service_module = service_module.const_get :EkmService
+        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 KeyManagementService.
       #
@@ -186,6 +296,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 KeyManagementService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Kms.key_management_service_available?}.
+      #
       # ## About KeyManagementService
       #
       # Google Cloud Key Management Service
@@ -218,6 +333,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the KeyManagementService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Kms.key_management_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 KeyManagementService service,
+      # or if the versioned client gem needs an update to support the KeyManagementService 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_management_service_available? version: :v1, transport: :grpc
+        require "google/cloud/kms/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Kms
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Kms.const_get package_name
+        return false unless service_module.const_defined? :KeyManagementService
+        service_module = service_module.const_get :KeyManagementService
+        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 library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-kms
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.9.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2025-01-29 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.2
 specification_version: 4
 summary: API Client library for the Cloud Key Management Service (KMS) API
 test_files: []