google-cloud-web_risk 1.6.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80c6677d7125b0ca3dea4205eea3ca38a17f611d6836b6d2c32902369fd303e1
-  data.tar.gz: 93c898d4a33110641ef42154b73e3ce5753188e51d7a3a262ba079b60785a44f
+  metadata.gz: bc31a643d3ef535db094584b8bf3b5956b938cb25116c9b5b3fb62e164068c0c
+  data.tar.gz: 99c5e7881bfaba2616f0a85eeb404073a533bd21a7830684c46b6b34c7645818
 SHA512:
-  metadata.gz: de372ab4f5ea138656d6c250329b90abc631cdca4d232135822f4eb466ca6f110111680fb02b7745c03838c2597b76d3115221f293cc2c64d9eecc11a1e62cbb
-  data.tar.gz: d637018f99b965d3fc24c846be5f44d9b3444d3998798dec8309b87fc972eb35ba94348452801585c8b9eb449dc0f2cc2b3e2c1a7df9c6360b51db32bdc834a3
+  metadata.gz: b4c45046408acff9ef2ee5755dee68417425824c659b43b4afbc580399b7c01137bdc0f9120857342908faf3df48cc97e4bdfb04fbe18ff57bb6422def351909
+  data.tar.gz: ebe8c1ebae7f9f6defbe8e5f4de215806ae466680faef5e1185adab2a1e50392134e4eb9a3bc64bd8cfe08dfd48733f8572859e60d8cf3047bb5b4fb574804d5

data/.yardopts

@@ -8,5 +8,4 @@
 -
 README.md
 AUTHENTICATION.md
-MIGRATING.md
 LICENSE.md

data/README.md

@@ -16,8 +16,7 @@ for this library, google-cloud-web_risk, to see the convenience methods for
 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-web_risk-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-web_risk-v1/latest),
-[google-cloud-web_risk-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-web_risk-v1beta1/latest).
+[google-cloud-web_risk-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-web_risk-v1/latest).
 
 See also the [Product Documentation](https://cloud.google.com/web-risk)
 for more usage information.
@@ -35,17 +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/webrisk.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
-## Migrating from 0.x versions
-
-The 1.0 release of the google-cloud-web_risk client is a significant upgrade
-based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
-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.
+## 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_risk-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-web_risk-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/web_risk/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module WebRisk
-      VERSION = "1.6.1"
+      VERSION = "2.0.0"
     end
   end
 end

data/lib/google/cloud/web_risk.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 WebRiskService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::WebRisk.web_risk_service_available?}.
+      #
       # ## About WebRiskService
       #
       # Web Risk API defines an interface to detect malicious URLs on your
@@ -80,6 +85,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the WebRiskService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::WebRisk.web_risk_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 WebRiskService service,
+      # or if the versioned client gem needs an update to support the WebRiskService 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_risk_service_available? version: :v1, transport: :grpc
+        require "google/cloud/web_risk/#{version.to_s.downcase}"
+        package_name = Google::Cloud::WebRisk
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::WebRisk.const_get package_name
+        return false unless service_module.const_defined? :WebRiskService
+        service_module = service_module.const_get :WebRiskService
+        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_risk library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-web_risk
 version: !ruby/object:Gem::Version
-  version: 1.6.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-web_risk-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-- !ruby/object:Gem::Dependency
-  name: google-cloud-web_risk-v1beta1
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    - - "<"
+    - - "~>"
       - !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.9'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.2'
 description: Web Risk is an enterprise security product that lets your client applications
   check URLs against Google's constantly updated lists of unsafe web resources.
 email: googleapis-packages@google.com
@@ -74,7 +47,6 @@ files:
 - ".yardopts"
 - AUTHENTICATION.md
 - LICENSE.md
-- MIGRATING.md
 - README.md
 - lib/google-cloud-web_risk.rb
 - lib/google/cloud/web_risk.rb
@@ -83,7 +55,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -91,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: API Client library for the Web Risk API
 test_files: []

data/MIGRATING.md

@@ -1,277 +0,0 @@
-## Migrating to google-cloud-web_risk 1.0
-
-The `google-cloud-web_risk` gem is a significant upgrade over the older and now
-deprecated `google-cloud-webrisk` gem. It is based on a
-[next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
-and includes substantial interface changes. Existing code written for the older
-gem will likely require updates to use this version. This document describes
-the changes that have been made, and what you need to do to update your usage.
-
-To summarize:
-
- *  The new gem supports versions V1 and V1beta1 of the Web Risk service. The
-    older gem supported only V1beta1.
- *  The client has been broken out into multiple libraries. The new gems
-    `google-cloud-web_risk-v1` and `google-cloud-web_risk-v1beta1` contain the
-    actual client classes for versions V1 and V1beta1 of the Web Risk service,
-    and the gem `google-cloud-web_risk` provides a convenience wrapper.
-    See [Library Structure](#library-structure) for more info.
- *  Some classes have moved into different namespaces. In particular, the
-    `Google::Cloud::Webrisk` module has been renamed to `Google::Cloud::WebRisk`.
-    See [Class Namespaces](#class-namespaces) for more info.
- *  The library uses a new configuration mechanism giving you closer control
-    over endpoint address, network timeouts, and retry. See
-    [Client Configuration](#client-configuration) for more info. Furthermore,
-    when creating a client object, you can customize its configuration in a
-    block rather than passing arguments to the constructor. See
-    [Creating Clients](#creating-clients) for more info.
- *  Previously, positional arguments were used to indicate required arguments.
-    Now, all method arguments are keyword arguments, with documentation that
-    specifies whether they are required or optional. Additionally, you can pass
-    a proto request object instead of separate arguments. See
-    [Passing Arguments](#passing-arguments) for more info.
- *  Previously, clients reported RPC errors by raising instances of
-    `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
-    `Google::Cloud::Error` and its subclasses. See
-    [Handling Errors](#handling-errors) for more info.
-
-### Library Structure
-
-The older `google-cloud-webrisk` gem was an all-in-one gem
-that included potentially multiple clients for multiple versions of the
-Web Risk service. The `Google::Cloud::Webrisk.new` factory method would
-return you an instance of a `Google::Cloud::Webrisk::V1beta1::WebRiskServiceV1Beta1Client`
-object for the V1beta1 version of the service. (Version V1 of the service was
-not supported by the older gem.)
-
-The new `google-cloud-web_risk` gem still provides factory
-methods for obtaining clients. (The method signatures will have changed. See
-[Creating Clients](#creating-clients) for details.) However, the actual client
-classes have been moved into separate gems, one per service version. The
-`Google::Cloud::WebRisk::V1::WebRiskService::Client` class, along with its
-helpers and data types, is now part of the `google-cloud-web_risk-v1` gem.
-Similarly, the `Google::Cloud::WebRisk::V1beta1::WebRiskService::Client`
-class is part of the `google-cloud-web_risk-v1beta1` gem.
-
-For normal usage, you can install the `google-cloud-web_risk` gem
-(which will bring in the versioned client gems as dependencies) and continue to
-use factory methods to create clients. However, you may alternatively choose to
-install only one of the versioned gems. For example, if you know you will only
-use `V1` of the service, you can install `google-cloud-web_risk-v1` by
-itself, and construct instances of the
-`Google::Cloud::WebRisk::V1::WebRiskService::Client` client class directly.
-
-### Class Namespaces
-
-As part of the gem being renamed from `google-cloud-webrisk` to
-`google-cloud-web_risk`, the main namespace module has also been renamed
-accordingly, from `Google::Cloud::Webrisk` to `Google::Cloud::WebRisk`. (Note
-the "R" in "WebRisk" is now capitalized.) This affects the entire library,
-including clients, data types, and all other modules and classes.
-
-Additionally, some of the underlying classes have also been renamed.
-In the older gem, the client object was of classes with names like:
-`Google::Cloud::Webrisk::V1beta1::WebRiskServiceV1Beta1Client`.
-In the new gem, the corresponding client object is of a different class:
-`Google::Cloud::WebRisk::V1beta1::WebRiskService::Client`.
-Note that most users will use the factory methods such as
-`Google::Cloud::WebRisk.web_risk_service` to create instances of the client object,
-so you may not need to reference the actual class directly.
-See [Creating Clients](#creating-clients).
-
-In older releases, the credentials object was of class
-`Google::Cloud::Webrisk::V1beta1::Credentials`.
-In the 1.0 release, each service has its own credentials class, e.g.
-`Google::Cloud::WebRisk::V1beta1::WebRiskService::Credentials`.
-Again, most users will not need to reference this class directly.
-See [Client Configuration](#client-configuration).
-
-### Client Configuration
-
-In the older gem, if you wanted to customize performance parameters or
-low-level behavior of the client (such as credentials, timeouts, or
-instrumentation), you would pass a variety of keyword arguments to the client
-constructor. It was also extremely difficult to customize the default settings.
-
-In the new gem, a configuration interface provides control over these
-parameters, including defaults for all instances of a client, and settings for
-each specific client instance. For example, to set default credentials and
-timeout for all Web Risk V1 clients:
-
-```
-Google::Cloud::WebRisk::V1::WebRiskService::Client.configure do |config|
-  config.credentials = "/path/to/credentials.json"
-  config.timeout = 10.0
-end
-```
-
-Individual RPCs can also be configured independently. For example, to set the
-timeout for the `search_uris` call:
-
-```
-Google::Cloud::WebRisk::V1::WebRiskService::Client.configure do |config|
-  config.rpcs.search_uris.timeout = 20.0
-end
-```
-
-Defaults for certain configurations can be set for all Web Risk versions and
-services globally:
-
-```
-Google::Cloud::WebRisk.configure do |config|
-  config.credentials = "/path/to/credentials.json"
-  config.timeout = 10.0
-end
-```
-
-Finally, you can override the configuration for each client instance. See the
-next section on [Creating Clients](#creating-clients) for details.
-
-### Creating Clients
-
-In the older gem, to create a client object, you would use the
-`Google::Cloud::Webrisk.new` class method. Keyword arguments were available to
-select a service version and to configure parameters such as credentials and
-timeouts.
-
-In the new gem, use the `Google::Cloud::WebRisk.web_risk_service` class
-method to create a client object. You may select a service version using the
-`:version` keyword argument. However, other configuration parameters should be
-set in a configuration block when you create the client.
-
-Old:
-```
-client = Google::Cloud::Webrisk.new credentials: "/path/to/credentials.json"
-```
-
-New:
-```
-client = Google::Cloud::WebRisk.web_risk_service do |config|
-  config.credentials = "/path/to/credentials.json"
-end
-```
-
-The configuration block is optional. If you do not provide it, or you do not
-set some configuration parameters, then the default configuration is used. See
-[Client Configuration](#client-configuration).
-
-### Passing Arguments
-
-In the older gem, required arguments would be passed as positional method
-arguments, while most optional arguments would be passed as keyword arguments.
-
-In the new gem, all RPC arguments are passed as keyword arguments,
-regardless of whether they are required or optional. For example:
-
-Old:
-```
-client = Google::Cloud::Webrisk.new
-
-uri = "http://example.com"
-threat_types = [Google::Cloud::Webrisk::V1beta1::ThreatType::MALWARE]
-
-# Both uri and threat_types are positional arguments.
-response = client.search_uris uri, threat_types
-```
-
-New:
-```
-client = Google::Cloud::WebRisk.web_risk_service
-
-uri = "http://example.com"
-threat_types = [Google::Cloud::WebRisk::V1::ThreatType::MALWARE]
-
-# Both uri and threat_types are keyword arguments.
-response = client.search_uris uri: uri, threat_types: threat_types
-```
-
-In the new gem, it is also possible to pass a request object, either
-as a hash or as a protocol buffer.
-
-New:
-```
-client = Google::Cloud::WebRisk.web_risk_service
-
-request = Google::Cloud::WebRisk::V1::SearchUrisRequest.new(
-  uri: "http://example.com",
-  threat_types: [Google::Cloud::WebRisk::V1::ThreatType::MALWARE]
-)
-
-# Pass a request object as a positional argument:
-response = client.search_uris request
-```
-
-Finally, in older releases, to provide call options, you would pass a
-`Google::Gax::CallOptions` object with the `:options` keyword argument. In the
-1.0 release, pass call options using a _second set_ of keyword arguments.
-
-Old:
-```
-client = Google::Cloud::Webrisk.new
-
-uri = "http://example.com"
-threat_types = [Google::Cloud::Webrisk::V1beta1::ThreatType::MALWARE]
-
-options = Google::Gax::CallOptions.new timeout: 10.0
-
-response = client.search_uris uri, threat_types, options: options
-```
-
-New:
-```
-client = Google::Cloud::WebRisk.web_risk_service
-
-uri = "http://example.com"
-threat_types = [Google::Cloud::WebRisk::V1::ThreatType::MALWARE]
-
-# Use a hash to wrap the normal call arguments (or pass a request object), and
-# then add further keyword arguments for the call options.
-response = client.search_uris(
-  { uri: uri, threat_types: threat_types },
-  timeout: 10.0
-)
-```
-
-### Handling Errors
-
-The client reports standard
-[gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
-by raising exceptions. In the older gem, these exceptions were located in the
-`Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
-exception class, defined in the `google-gax` gem. However, these classes were
-different from the standard exceptions (subclasses of `Google::Cloud::Error`)
-thrown by other client libraries such as `google-cloud-storage`.
-
-The new client library now uses the `Google::Cloud::Error` exception hierarchy,
-for consistency across all the Google Cloud client libraries. In general, these
-exceptions have the same name as their counterparts from older releases, but
-are located in the `Google::Cloud` namespace rather than the `Google::Gax`
-namespace.
-
-Old:
-```
-client = Google::Cloud::Webrisk.new
-
-uri = "http://example.com"
-threat_types = [Google::Cloud::Webrisk::V1beta1::ThreatType::MALWARE]
-
-begin
-  response = client.search_uris uri, threat_types
-rescue Google::Gax::Error => e
-  # Handle exceptions that subclass Google::Gax::Error
-end
-```
-
-New:
-```
-client = Google::Cloud::WebRisk.web_risk_service
-
-uri = "http://example.com"
-threat_types = [Google::Cloud::WebRisk::V1::ThreatType::MALWARE]
-
-begin
-  response = client.search_uris uri: uri, threat_types: threat_types
-rescue Google::Cloud::Error => e
-  # Handle exceptions that subclass Google::Cloud::Error
-end
-```