google-cloud-phishing_protection-v1beta1 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7914dc2440551f82add5ea6331555a686151e338bd17b7795e5f0a39f3693f8
-  data.tar.gz: 4ed8fddfe4b29c6b81a6f6bf1d980b1d292927dde9b0674ca21a348edc608e8f
+  metadata.gz: dc63c5285fe041314f4e5730ac02c02d2d22a86be1310411671e9fa3aea42c19
+  data.tar.gz: 64048130b75a5525d10b5e886202435035a621a58bb7a0f05caf9c5fd88a8d2d
 SHA512:
-  metadata.gz: aeed9eb17e7374b75ea238777171c015759035d9fcc34c27c1a9f50dd6f57ae3326db783466347a22d24b399af4809a02fa73b50cf5bd9c5aff1b4f2493852fb
-  data.tar.gz: 5c145b518bbf76fa7367bf5714778aa8bafcd0141ed7d41a336fe2c5f2daabe32c5125acea056075f319700792b775f0ba272701e3df450ee0d9067c5997022f
+  metadata.gz: 2701234976a314873c0eb5034b7466cdb405bba90565325a68d4c24a625f684f948b35dc8e1f602ae96504921d279345dbfb6467927506aa25e7233a9fdc4136
+  data.tar.gz: 04fdd9d2510bbdcded82fe8bfccdd62ea1e4d3a028cc4ea95e9e77d7bce126ed944ffac042e477208b884eb3df916f394b3f1fc5ddd86d7cf368305ee2f09442

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-phishing_protection-v1beta1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Credentials}):
 
-1. `PHISHING_PROTECTION_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `PHISHING_PROTECTION_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `PHISHING_PROTECTION_CREDENTIALS` - Path to JSON file, or JSON contents
+* `PHISHING_PROTECTION_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/phishing_protection/v1beta1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/phishing_protection/v1beta1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/phishing_protection/v1beta1"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/phishing_protection/v1beta1"
 
 client = ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.new
-request = my_create_request
+request = ::Google::Cloud::PhishingProtection::V1beta1::ReportPhishingRequest.new # (request fields as keyword arguments...)
 response = client.report_phishing request
 ```
 

data/lib/google/cloud/phishing_protection/v1beta1/phishing_protection_service/client.rb

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all PhishingProtectionService clients:
-            #
-            #     ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all PhishingProtectionService clients
+            #   ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -96,19 +95,15 @@ module Google
             ##
             # Create a new PhishingProtectionService client object.
             #
-            # ## Examples
-            #
-            # To create a new PhishingProtectionService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.new
             #
-            # To create a new PhishingProtectionService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the PhishingProtectionService client.
             # @yieldparam config [Client::Configuration]
@@ -128,14 +123,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -190,6 +184,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/phishing_protection/v1beta1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PhishingProtection::V1beta1::ReportPhishingRequest.new
+            #
+            #   # Call the report_phishing method.
+            #   result = client.report_phishing request
+            #
+            #   # The returned object is of type Google::Cloud::PhishingProtection::V1beta1::ReportPhishingResponse.
+            #   p result
+            #
             def report_phishing request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -207,16 +216,20 @@ module Google
                 gapic_version: ::Google::Cloud::PhishingProtection::V1beta1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.report_phishing.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.report_phishing.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @phishing_protection_service_stub.call_rpc :report_phishing, request, options: options do |response, operation|
@@ -240,22 +253,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for report_phishing
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.report_phishing.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.report_phishing.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # report_phishing to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.report_phishing.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.report_phishing.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/phishing_protection/v1beta1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module PhishingProtection
       module V1beta1
-        VERSION = "0.3.0"
+        VERSION = "0.3.4"
       end
     end
   end

data/lib/google/cloud/phishingprotection/v1beta1/phishingprotection_pb.rb

@@ -1,12 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/phishingprotection/v1beta1/phishingprotection.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/phishingprotection/v1beta1/phishingprotection.proto", :syntax => :proto3) do
     add_message "google.cloud.phishingprotection.v1beta1.ReportPhishingRequest" do

data/lib/google/cloud/phishingprotection/v1beta1/phishingprotection_services_pb.rb

@@ -28,7 +28,7 @@ module Google
           # Service to report phishing URIs.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-phishing_protection-v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Phishing Protection V1beta1 API