google-cloud-web_security_scanner 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ba367920ab0b2ec2df03c18ccdb127c4aa046861b4e14b2f1f1df85dbde5a95
-  data.tar.gz: 9beb3f652123fca3e09df922f9588615c40c7d0aca9507a91d0d26c563ba5b3e
+  metadata.gz: a826006cbc9b22e4147613f6f18583121134f95b31d7e2e03496f02a74a89149
+  data.tar.gz: 842a4f142fe50a4ea0099d3188d017b99dc4cc1ee098a9ecc83c8f2eba2da518
 SHA512:
-  metadata.gz: 16584761fdcfc2f258a72cb942970b3899c3b349938a5bb70cfb4f5adcad828b3895d4a3ebb387a7720d56681a79e1583ae466dafde17a35f9cbda331105cec9
-  data.tar.gz: b150a746c72949b219ce7fc54ea1232139e2114b6292f4b1f74982b0a4f400625e950c496239aaba8cdd183b3f16a8ad021f390968552d9e1b2efdb0cd438d71
+  metadata.gz: b75e88bb1987ebbbbc793301f94de5420f9bc577a90fb075523c6ce36c18d4585c2fda08baf810a8aa7322805e9d6d6896b9713f98ced82314768484a42b30d2
+  data.tar.gz: fa550b73da4b00783f1c035449cd6b2442a4e5840252ab4e56e306da94689eff8fd0e7e39aa514ab6627b15f6c06c739031263703a4c617838e7965c74cd5817

data/README.md

@@ -35,9 +35,40 @@ 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/websecurityscanner.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-web_security_scanner-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-web_security_scanner-v1/latest),
+[google-cloud-web_security_scanner-v1beta](https://cloud.google.com/ruby/docs/reference/google-cloud-web_security_scanner-v1beta/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/web_security_scanner/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module WebSecurityScanner
-      VERSION = "1.4.1"
+      VERSION = "1.5.0"
     end
   end
 end

data/lib/google/cloud/web_security_scanner.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 WebSecurityScanner service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::WebSecurityScanner.web_security_scanner_available?}.
+      #
       # ## About WebSecurityScanner
       #
       # Web Security Scanner Service identifies security vulnerabilities in web
@@ -81,6 +86,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the WebSecurityScanner service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::WebSecurityScanner.web_security_scanner}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the WebSecurityScanner service,
+      # or if the versioned client gem needs an update to support the WebSecurityScanner 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.web_security_scanner_available? version: :v1, transport: :grpc
+        require "google/cloud/web_security_scanner/#{version.to_s.downcase}"
+        package_name = Google::Cloud::WebSecurityScanner
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::WebSecurityScanner.const_get package_name
+        return false unless service_module.const_defined? :WebSecurityScanner
+        service_module = service_module.const_get :WebSecurityScanner
+        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-web_security_scanner library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-web_security_scanner
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.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
@@ -82,7 +81,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -90,15 +88,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 Web Security Scanner API
 test_files: []