google-cloud-support 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfed79124d06f2ad466044e8434b936ebbd035d2c08a15d50290db1ed4f1b546
-  data.tar.gz: c3cb6384bd301df0250995f2d8901f470417fdd2ea2b1349d556f8b004a199ca
+  metadata.gz: 3ae4cd56eba418c1a710f700285bd24bdd9addc058284241446f9d67ef646e8b
+  data.tar.gz: c7f28ffbb9eaea17734b856a5a7e9f05a4d372cabe401fde111205fa436b4404
 SHA512:
-  metadata.gz: 8c9200a16056d6cfbefdaa50b81fa3d25df4b63b4edf0c6df39692f358f44c2586bb9da0e78634b5723e90657150b1b8e90e8368c82e2da8a1dea8b7bad6bcf0
-  data.tar.gz: aac88db690f32e22ceddded683acd4c357ee709e042e9a0ece06ba6a6c56593eb09a040507a450d00890a57445473107f37e595eb10c57d5da00614a3e571ca3
+  metadata.gz: 4a2232acbb2ae2a39ebe30d77efcc8de1e008ffc7b678e573bff953c53eab9c84b34a7a3f14b2508c9178710476bbef44bd9906efd8f00246edec9977a6ab045
+  data.tar.gz: 2fde4415f3784e29d8ad451dc285dc2cc13102cc3dda4f9b94e326bbd8d73f44c72ef352c962f4d3fc38ac2c2447289342c514a83f4636917a0df961b56de336

data/README.md

@@ -34,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/cloudsupport.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-support-v2](https://cloud.google.com/ruby/docs/reference/google-cloud-support-v2/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/support/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Support
-      VERSION = "1.0.1"
+      VERSION = "1.1.0"
     end
   end
 end

data/lib/google/cloud/support.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 CaseAttachmentService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Support.case_attachment_service_available?}.
+      #
       # ## About CaseAttachmentService
       #
       # A service to manage file attachment for Google Cloud support cases.
@@ -75,6 +80,32 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the CaseAttachmentService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Support.case_attachment_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 CaseAttachmentService service,
+      # or if the versioned client gem needs an update to support the CaseAttachmentService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.case_attachment_service_available? version: :v2
+        require "google/cloud/support/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Support
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Support.const_get package_name
+        return false unless service_module.const_defined? :CaseAttachmentService
+        service_module = service_module.const_get :CaseAttachmentService
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for CaseService.
       #
@@ -86,6 +117,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 CaseService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Support.case_service_available?}.
+      #
       # ## About CaseService
       #
       # A service to manage Google Cloud support cases.
@@ -105,6 +141,32 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the CaseService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Support.case_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 CaseService service,
+      # or if the versioned client gem needs an update to support the CaseService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.case_service_available? version: :v2
+        require "google/cloud/support/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Support
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Support.const_get package_name
+        return false unless service_module.const_defined? :CaseService
+        service_module = service_module.const_get :CaseService
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for CommentService.
       #
@@ -116,6 +178,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 CommentService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Support.comment_service_available?}.
+      #
       # ## About CommentService
       #
       # A service to manage comments on cases.
@@ -135,6 +202,32 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the CommentService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Support.comment_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 CommentService service,
+      # or if the versioned client gem needs an update to support the CommentService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.comment_service_available? version: :v2
+        require "google/cloud/support/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Support
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Support.const_get package_name
+        return false unless service_module.const_defined? :CommentService
+        service_module = service_module.const_get :CommentService
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-support library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-support
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2025-01-29 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.2
 specification_version: 4
 summary: Manages Google Cloud technical support cases for Customer Care support offerings.
 test_files: []