google-cloud-service_health 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0ce0203b8a32bfb623f2063036bdaca8b11f2cc9ab91243416d0939b0fb8217
-  data.tar.gz: d1d8579215b6df40c80d2255f80a1277df519596cb9bc02ab1d7939d809083a9
+  metadata.gz: 53be3fdbe9e967228c11d752193e7dd035c53cd3e79e9be083d69575c8563691
+  data.tar.gz: 541696c7f28eb6bee92a18116b41b4bb1663cf42aa6be8398d6b5b629c72c08c
 SHA512:
-  metadata.gz: b20b9cafda464b9cff20c59bb164e98e68a336e4a3e3aad3338ce477cdd10ed6f649f3da286d68fe63682f1a0f75e84314158b38f1701b76fd37ee80e416360c
-  data.tar.gz: bcba552117f33cdc0c544f8de994be4e77438aac8d0d878e30f57eb2e57a7c1d375509520dc7d9387ee02a19812d83982e5c773fa623e8933146a80700cee0db
+  metadata.gz: 9f57821e57b269e196ed1b7d67184cde8acde15d667314e5560804646a4b2732d102db635cc48f7f2d72919fa798c19486159593d54fef369ebbb6c2e6024d94
+  data.tar.gz: c773a6a5ef34036f772fb311d8d897f24eaeef430a663d5658c8ffd72d49d6de7766caa5864565666251913aab002b0da45e1827ddfc420d72a67c6cddd50b5b

data/README.md

@@ -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/servicehealth.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-service_health-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-service_health-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/service_health/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module ServiceHealth
-      VERSION = "1.0.1"
+      VERSION = "2.0.0"
     end
   end
 end

data/lib/google/cloud/service_health.rb

@@ -58,6 +58,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 ServiceHealth service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::ServiceHealth.service_health_available?}.
+      #
       # ## About ServiceHealth
       #
       # Request service health events relevant to your Google Cloud project.
@@ -79,6 +84,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the ServiceHealth service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::ServiceHealth.service_health}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the ServiceHealth service,
+      # or if the versioned client gem needs an update to support the ServiceHealth 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.service_health_available? version: :v1, transport: :grpc
+        require "google/cloud/service_health/#{version.to_s.downcase}"
+        package_name = Google::Cloud::ServiceHealth
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::ServiceHealth.const_get package_name
+        return false unless service_module.const_defined? :ServiceHealth
+        service_module = service_module.const_get :ServiceHealth
+        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-service_health library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-service_health
 version: !ruby/object:Gem::Version
-  version: 1.0.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,22 +27,16 @@ dependencies:
   name: google-cloud-service_health-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '2.0'
 description: Personalized Service Health helps you gain visibility into disruptive
   events impacting Google Cloud products.
 email: googleapis-packages@google.com
@@ -62,7 +55,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,15 +62,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: Personalized Service Health helps you gain visibility into disruptive events
   impacting Google Cloud products.