google-cloud-web_risk-v1 0.5.0 → 0.7.0

data/lib/google/cloud/web_risk/v1/web_risk_service/rest/service_stub.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/webrisk/v1/webrisk_pb"
+
+module Google
+  module Cloud
+    module WebRisk
+      module V1
+        module WebRiskService
+          module Rest
+            ##
+            # REST service stub for the WebRiskService service.
+            # Service stub contains baseline method implementations
+            # including transcoding, making the REST call, and deserialing the response.
+            #
+            class ServiceStub
+              def initialize endpoint:, credentials:
+                # These require statements are intentionally placed here to initialize
+                # the REST modules only when it's required.
+                require "gapic/rest"
+
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                                                             numeric_enums: true,
+                                                             raise_faraday_errors: false
+              end
+
+              ##
+              # Baseline implementation for the compute_threat_list_diff REST call
+              #
+              # @param request_pb [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse]
+              #   A result object deserialized from the server's reply
+              def compute_threat_list_diff request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_compute_threat_list_diff_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the search_uris REST call
+              #
+              # @param request_pb [::Google::Cloud::WebRisk::V1::SearchUrisRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::WebRisk::V1::SearchUrisResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::WebRisk::V1::SearchUrisResponse]
+              #   A result object deserialized from the server's reply
+              def search_uris request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_search_uris_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::WebRisk::V1::SearchUrisResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the search_hashes REST call
+              #
+              # @param request_pb [::Google::Cloud::WebRisk::V1::SearchHashesRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::WebRisk::V1::SearchHashesResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::WebRisk::V1::SearchHashesResponse]
+              #   A result object deserialized from the server's reply
+              def search_hashes request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_search_hashes_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::WebRisk::V1::SearchHashesResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the create_submission REST call
+              #
+              # @param request_pb [::Google::Cloud::WebRisk::V1::CreateSubmissionRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::WebRisk::V1::Submission]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::WebRisk::V1::Submission]
+              #   A result object deserialized from the server's reply
+              def create_submission request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_create_submission_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::WebRisk::V1::Submission.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the compute_threat_list_diff REST call
+              #
+              # @param request_pb [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_compute_threat_list_diff_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/threatLists:computeDiff",
+                                                          matches: []
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the search_uris REST call
+              #
+              # @param request_pb [::Google::Cloud::WebRisk::V1::SearchUrisRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_search_uris_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/uris:search",
+                                                          matches: []
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the search_hashes REST call
+              #
+              # @param request_pb [::Google::Cloud::WebRisk::V1::SearchHashesRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_search_hashes_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/hashes:search",
+                                                          matches: []
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the create_submission REST call
+              #
+              # @param request_pb [::Google::Cloud::WebRisk::V1::CreateSubmissionRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_create_submission_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{parent}/submissions",
+                                                          body: "submission",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/web_risk/v1/web_risk_service/rest.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/web_risk/v1/version"
+
+require "google/cloud/web_risk/v1/web_risk_service/credentials"
+require "google/cloud/web_risk/v1/web_risk_service/paths"
+require "google/cloud/web_risk/v1/web_risk_service/rest/client"
+
+module Google
+  module Cloud
+    module WebRisk
+      module V1
+        ##
+        # Web Risk API defines an interface to detect malicious URLs on your
+        # website and in client applications.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/web_risk/v1/web_risk_service/rest"
+        #     client = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.new
+        #
+        module WebRiskService
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/web_risk/v1/web_risk_service/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/web_risk/v1/web_risk_service.rb

@@ -25,6 +25,7 @@ require "google/cloud/web_risk/v1/version"
 require "google/cloud/web_risk/v1/web_risk_service/credentials"
 require "google/cloud/web_risk/v1/web_risk_service/paths"
 require "google/cloud/web_risk/v1/web_risk_service/client"
+require "google/cloud/web_risk/v1/web_risk_service/rest"
 
 module Google
   module Cloud
@@ -34,11 +35,16 @@ module Google
         # Web Risk API defines an interface to detect malicious URLs on your
         # website and in client applications.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/web_risk/v1/web_risk_service"
         #     client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new
         #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/web_risk/v1/web_risk_service/rest"
+        #     client = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.new
+        #
         module WebRiskService
         end
       end

data/lib/google/cloud/web_risk/v1.rb

@@ -23,13 +23,18 @@ module Google
   module Cloud
     module WebRisk
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/web_risk/v1"
       #     client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new
       #
+      # @example Load this package, including all its services, and instantiate a REST client
+      #
+      #     require "google/cloud/web_risk/v1"
+      #     client = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.new
+      #
       module V1
       end
     end

data/lib/google/cloud/webrisk/v1/webrisk_pb.rb

@@ -94,6 +94,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :MALWARE, 1
       value :SOCIAL_ENGINEERING, 2
       value :UNWANTED_SOFTWARE, 3
+      value :SOCIAL_ENGINEERING_EXTENDED_COVERAGE, 4
     end
     add_enum "google.cloud.webrisk.v1.CompressionType" do
       value :COMPRESSION_TYPE_UNSPECIFIED, 0

data/lib/google/cloud/webrisk/v1/webrisk_services_pb.rb

@@ -58,7 +58,8 @@ module Google
             # content, the site will be added to the [Google's Social Engineering
             # lists](https://support.google.com/webmasters/answer/6350487/) in order to
             # protect users that could get exposed to this threat in the future. Only
-            # projects with CREATE_SUBMISSION_USERS visibility can use this method.
+            # allowlisted projects can use this method during Early Access. Please reach
+            # out to Sales or your customer engineer to obtain access.
             rpc :CreateSubmission, ::Google::Cloud::WebRisk::V1::CreateSubmissionRequest, ::Google::Cloud::WebRisk::V1::Submission
           end