grafeas 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59a357d6fabe73010d485eb77a50947f09e26d7eb6844de6dc09c4ad646e834e
-  data.tar.gz: 36150ec7fc51e4931c00af9528ecd0181957ed06b857abeed429088c80694862
+  metadata.gz: 913695ac0f735da37dba6b2e011a88220cb1b0f65f5e9d363e58ce5596fe3ffc
+  data.tar.gz: ad36aef7e2630fa749e07401ebd29d4175badca05395052932539e7868a28c06
 SHA512:
-  metadata.gz: 8d6f658f0d8c88a01e882f7641bb29060a0a80eb39ec7e3146ca429249e68e606a35077699408917f6724cf42468202d5e79cdc39abd5df1a31c96266efcbffc
-  data.tar.gz: 65ac518f4b933128e26216dd66b719c91063d1189755834b02bd1f7f3daad1008443eed7948ce56628acfe4afc6b9d5e130ff48f93a46235158b3cbdd6f48ffe
+  metadata.gz: 82fe604a6d66e62d97355a1c90224a332266c4f2c494e8b2fe30eb0e51bc975a7711324d0493e99aa9be05a57f870b05e7c7f479398562594685e6aa06048e10
+  data.tar.gz: 1c7876254f9b153542806a177cac8736e9bc6ade3d73edad87e162d65d9b884a7381dc8f5123feb8c426c7c5aa6e81a33e780944f3e2857cfd21e45c5e8b6ab0

data/README.md

@@ -35,35 +35,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.
 
-## 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:
+[grafeas-v1](https://cloud.google.com/ruby/docs/reference/grafeas-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/grafeas/version.rb

@@ -18,5 +18,5 @@
 
 
 module Grafeas
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/grafeas.rb

@@ -36,6 +36,11 @@ module Grafeas
   # 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 Grafeas service.
+  # You can determine whether the method will succeed by calling
+  # {Grafeas.grafeas_available?}.
+  #
   # ## About Grafeas
   #
   # [Grafeas](https://grafeas.io) API.
@@ -67,6 +72,32 @@ module Grafeas
     service_module = Grafeas.const_get(package_name).const_get(:Grafeas)
     service_module.const_get(:Client).new(&block)
   end
+
+  ##
+  # Determines whether the Grafeas service is supported by the current client.
+  # If true, you can retrieve a client object by calling {Grafeas.grafeas}.
+  # If false, that method will raise an exception. This could happen if the given
+  # API version does not exist or does not support the Grafeas service,
+  # or if the versioned client gem needs an update to support the Grafeas service.
+  #
+  # @param version [::String, ::Symbol] The API version to connect to. Optional.
+  #   Defaults to `:v1`.
+  # @return [boolean] Whether the service is available.
+  #
+  def self.grafeas_available? version: :v1
+    require "grafeas/#{version.to_s.downcase}"
+    package_name = Grafeas
+                   .constants
+                   .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                   .first
+    return false unless package_name
+    service_module = Grafeas.const_get package_name
+    return false unless service_module.const_defined? :Grafeas
+    service_module = service_module.const_get :Grafeas
+    service_module.const_defined? :Client
+  rescue ::LoadError
+    false
+  end
 end
 
 helper_path = ::File.join __dir__, "grafeas", "helpers.rb"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: grafeas
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -61,7 +60,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,15 +67,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 Grafeas API
 test_files: []