google-cloud-secret_manager 1.4.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ff192e14b161bedef7a5930d7f6cbb2978f427bc91173af9966e919bb7fb9b3
-  data.tar.gz: a3bee0795f6cdf86205272d75436cff9789af25c93dec30c38b9440bb49d4e7a
+  metadata.gz: 9238dafb032a287c21de825221e926f403aea24ebe34ef32fa9b5e7cc7cdb960
+  data.tar.gz: 71bc04d1c6f52f33def1ce3b10ca31c0b54ff417116fa6893f137c03e83c9a50
 SHA512:
-  metadata.gz: 35d53e4490c62615cd1d4d1bb087e5743ff1b63a1bd79fc9d1c20e34d372f6436426f49e5527c7e58ec6e858c1bed571234534820eba8bb11c556072883b5bd3
-  data.tar.gz: 6aebb126f720fb1311957b5cf1d65f069f7481df0c162c6a229d75760e18a2fc62d99b76b42d651a94995b2216fccbef08b8e8871e3573e20f7b8b385bce35b1
+  metadata.gz: 70aa9e2045df32d409aae21ff6dcaa4c592fc7ee56a56e5c79f5ce90fe4760fd41985c0f079718ab2f9d0ed1da81d950997741ab194d856ca403362882286183
+  data.tar.gz: 4fc268ecf56553a7d4a384fe1cccd8454874e4e782d7146dfb1218fd434b7ed75e42ac6257069ca0e666d1db9be8d92fa16eee5b4dbe46ed6269faa00ef3542a

data/README.md

@@ -16,8 +16,7 @@ for this library, google-cloud-secret_manager, to see the convenience methods fo
 constructing client objects. Reference documentation for the client objects
 themselves can be found in the client library documentation for the versioned
 client gems:
-[google-cloud-secret_manager-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-secret_manager-v1/latest),
-[google-cloud-secret_manager-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-secret_manager-v1beta1/latest).
+[google-cloud-secret_manager-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-secret_manager-v1/latest).
 
 See also the [Product Documentation](https://cloud.google.com/secret-manager)
 for more usage information.
@@ -35,35 +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/secretmanager.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
-
-```ruby
-require "logger"
-
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
-end
-```
+## 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-secret_manager-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-secret_manager-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/secret_manager/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module SecretManager
-      VERSION = "1.4.1".freeze
+      VERSION = "2.0.0".freeze
     end
   end
 end

data/lib/google/cloud/secret_manager.rb

@@ -56,6 +56,11 @@ module Google
       # supported by that API version, and the corresponding gem is available, the
       # appropriate versioned client will be returned.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the SecretManagerService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::SecretManager.secret_manager_service_available?}.
+      #
       # ## About SecretManagerService
       #
       # Secret Manager Service
@@ -81,6 +86,32 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the SecretManagerService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::SecretManager.secret_manager_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 SecretManagerService service,
+      # or if the versioned client gem needs an update to support the SecretManagerService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.secret_manager_service_available? version: :v1
+        require "google/cloud/secret_manager/#{version.to_s.downcase}"
+        package_name = Google::Cloud::SecretManager
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::SecretManager.const_get package_name
+        return false unless service_module.const_defined? :SecretManagerService
+        service_module = service_module.const_get :SecretManagerService
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-secret_manager library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-secret_manager
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -28,42 +27,16 @@ dependencies:
   name: google-cloud-secret_manager-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.19'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.19'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-- !ruby/object:Gem::Dependency
-  name: google-cloud-secret_manager-v1beta1
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.3'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.3'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.2'
 description: Secret Manager is a secure and convenient storage system for API keys,
   passwords, certificates, and other sensitive data. Secret Manager provides a central
   place and single source of truth to manage, access, and audit secrets across Google
@@ -84,7 +57,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -92,15 +64,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.3
 specification_version: 4
 summary: API Client library for the Secret Manager API
 test_files: []