google-cloud-web_security_scanner-v1 0.3.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c6c9ea48a162fad1b46d501dadacebdfbe66104b03d1f0ef128865981c1e1cd
-  data.tar.gz: 7535b702021d618d00d40744e48cb292dcbffa39293db0c2048d7f0df3d48cda
+  metadata.gz: c9a24233cc850f8ffd6b725b57507e3bb09421ba7a94aec16e604cac82c4a42b
+  data.tar.gz: 2b263ff1c2915839b23f6ce19ba5fbbe5370c2da173c87a6c421432ad5680cb1
 SHA512:
-  metadata.gz: a75ed7a3f971c4dc089510c3144ac9028e7e27b7d06e7722acf03629de3c8a330fec76ea354f2dd1aae232c315b12f7c7bb6c5011b6701479e6cbe12cc8c5109
-  data.tar.gz: f8ca7136f0aa0ce2b444be0f98dd7d15795d56118623270ed39bd11cc30fc7418b41d6df293d547c49561ce9ad87f90cde68d0c31338db6bce335c7158606a12
+  metadata.gz: 6966d63070a5ea34f2e11f4d56ee049ad664de48dd198e70aa4d321887b95124cde583d7896c36902a90cbedaed553bf7fffbda27c1d1ced14beb5269363b190
+  data.tar.gz: 1b2303e966c373f2a3973d938ed04778cb57408e64b1d5215e6f38e376bc30e70b5b68c1b06ee62d63508e8d6ec864bb1ea3986e71da56ff352dce28e9f9381f

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Web Security Scanner V1 API
+--title="Web Security Scanner V1 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/README.md

@@ -37,7 +37,7 @@ request = ::Google::Cloud::WebSecurityScanner::V1::CreateScanConfigRequest.new #
 response = client.create_scan_config request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-web_security_scanner-v1/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-web_security_scanner-v1/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/)
@@ -69,16 +69,21 @@ module GRPC
 end
 ```
 
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 2.6+.
 
 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
-in security maintenance, and not end of life. Currently, this means Ruby 2.5
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
+in security maintenance, and not end of life. Older versions of Ruby _may_
+still work, but are unsupported and not recommended. See
+https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
+support schedule.
 
 ## Which client should I use?
 

data/lib/google/cloud/web_security_scanner/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module WebSecurityScanner
       module V1
-        VERSION = "0.3.4"
+        VERSION = "0.4.1"
       end
     end
   end

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

@@ -25,6 +25,8 @@ module Google
       ##
       # To load this package, including all its services, and instantiate a client:
       #
+      # @example
+      #
       #     require "google/cloud/web_security_scanner/v1"
       #     client = ::Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Client.new
       #

data/lib/google/cloud/websecurityscanner/v1/finding_pb.rb

@@ -1,10 +1,11 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/websecurityscanner/v1/finding.proto
 
+require 'google/protobuf'
+
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/websecurityscanner/v1/finding_addon_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/websecurityscanner/v1/finding.proto", :syntax => :proto3) do

data/lib/google/cloud/websecurityscanner/v1/scan_config_pb.rb

@@ -1,9 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/websecurityscanner/v1/scan_config.proto
 
+require 'google/protobuf'
+
 require 'google/api/field_behavior_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/websecurityscanner/v1/scan_config.proto", :syntax => :proto3) do

data/lib/google/cloud/websecurityscanner/v1/scan_run_error_trace_pb.rb

@@ -1,9 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/websecurityscanner/v1/scan_run_error_trace.proto
 
-require 'google/cloud/websecurityscanner/v1/scan_config_error_pb'
 require 'google/protobuf'
 
+require 'google/cloud/websecurityscanner/v1/scan_config_error_pb'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/websecurityscanner/v1/scan_run_error_trace.proto", :syntax => :proto3) do
     add_message "google.cloud.websecurityscanner.v1.ScanRunErrorTrace" do

data/lib/google/cloud/websecurityscanner/v1/scan_run_log_pb.rb

@@ -0,0 +1,32 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/websecurityscanner/v1/scan_run_log.proto
+
+require 'google/protobuf'
+
+require 'google/cloud/websecurityscanner/v1/scan_run_pb'
+require 'google/cloud/websecurityscanner/v1/scan_run_error_trace_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/websecurityscanner/v1/scan_run_log.proto", :syntax => :proto3) do
+    add_message "google.cloud.websecurityscanner.v1.ScanRunLog" do
+      optional :summary, :string, 1
+      optional :name, :string, 2
+      optional :execution_state, :enum, 3, "google.cloud.websecurityscanner.v1.ScanRun.ExecutionState"
+      optional :result_state, :enum, 4, "google.cloud.websecurityscanner.v1.ScanRun.ResultState"
+      optional :urls_crawled_count, :int64, 5
+      optional :urls_tested_count, :int64, 6
+      optional :has_findings, :bool, 7
+      optional :error_trace, :message, 8, "google.cloud.websecurityscanner.v1.ScanRunErrorTrace"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1
+        ScanRunLog = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1.ScanRunLog").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/websecurityscanner/v1/scan_run_pb.rb

@@ -1,10 +1,11 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/websecurityscanner/v1/scan_run.proto
 
+require 'google/protobuf'
+
 require 'google/cloud/websecurityscanner/v1/scan_run_error_trace_pb'
 require 'google/cloud/websecurityscanner/v1/scan_run_warning_trace_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/websecurityscanner/v1/scan_run.proto", :syntax => :proto3) do

data/lib/google/cloud/websecurityscanner/v1/web_security_scanner_pb.rb

@@ -1,6 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/websecurityscanner/v1/web_security_scanner.proto
 
+require 'google/protobuf'
+
 require 'google/api/annotations_pb'
 require 'google/cloud/websecurityscanner/v1/crawled_url_pb'
 require 'google/cloud/websecurityscanner/v1/finding_pb'
@@ -10,7 +12,6 @@ require 'google/cloud/websecurityscanner/v1/scan_run_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/api/client_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/websecurityscanner/v1/web_security_scanner.proto", :syntax => :proto3) do

data/proto_docs/google/api/resource.rb

@@ -33,11 +33,7 @@ module Google
     #       // For Kubernetes resources, the format is {api group}/{kind}.
     #       option (google.api.resource) = {
     #         type: "pubsub.googleapis.com/Topic"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
+    #         pattern: "projects/{project}/topics/{topic}"
     #       };
     #     }
     #
@@ -45,10 +41,7 @@ module Google
     #
     #     resources:
     #     - type: "pubsub.googleapis.com/Topic"
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
+    #       pattern: "projects/{project}/topics/{topic}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
     #     message LogEntry {
     #       option (google.api.resource) = {
     #         type: "logging.googleapis.com/LogEntry"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #         }
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
     #       };
     #     }
     #
@@ -85,48 +62,10 @@ module Google
     #
     #     resources:
     #     - type: 'logging.googleapis.com/LogEntry'
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         - pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         - pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #
-    # For flexible resources, the resource name doesn't contain parent names, but
-    # the resource itself has parents for policy evaluation.
-    #
-    # Example:
-    #
-    #     message Shelf {
-    #       option (google.api.resource) = {
-    #         type: "library.googleapis.com/Shelf"
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #         }
-    #       };
-    #     }
-    #
-    # The ResourceDescriptor Yaml config will look like:
-    #
-    #     resources:
-    #     - type: 'library.googleapis.com/Shelf'
-    #       name_descriptor:
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
     # @!attribute [rw] type
     #   @return [::String]
     #     The resource type. It must be in the format of

data/proto_docs/google/cloud/websecurityscanner/v1/scan_run_log.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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!
+
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1
+        # A ScanRunLog is an output-only proto used for Stackdriver customer logging.
+        # It is used for logs covering the start and end of scan pipelines.
+        # Other than an added summary, this is a subset of the ScanRun.
+        # Representation in logs is either a proto Struct, or converted to JSON.
+        # Next id: 9
+        # @!attribute [rw] summary
+        #   @return [::String]
+        #     Human friendly message about the event.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The resource name of the ScanRun being logged.
+        # @!attribute [rw] execution_state
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanRun::ExecutionState]
+        #     The execution state of the ScanRun.
+        # @!attribute [rw] result_state
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanRun::ResultState]
+        #     The result state of the ScanRun.
+        # @!attribute [rw] urls_crawled_count
+        #   @return [::Integer]
+        # @!attribute [rw] urls_tested_count
+        #   @return [::Integer]
+        # @!attribute [rw] has_findings
+        #   @return [::Boolean]
+        # @!attribute [rw] error_trace
+        #   @return [::Google::Cloud::WebSecurityScanner::V1::ScanRunErrorTrace]
+        class ScanRunLog
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/empty.rb

@@ -26,8 +26,6 @@ module Google
     #     service Foo {
     #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
     #     }
-    #
-    # The JSON representation for `Empty` is empty JSON object `{}`.
     class Empty
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-web_security_scanner-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -50,28 +50,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +182,7 @@ files:
 - lib/google/cloud/websecurityscanner/v1/scan_config_error_pb.rb
 - lib/google/cloud/websecurityscanner/v1/scan_config_pb.rb
 - lib/google/cloud/websecurityscanner/v1/scan_run_error_trace_pb.rb
+- lib/google/cloud/websecurityscanner/v1/scan_run_log_pb.rb
 - lib/google/cloud/websecurityscanner/v1/scan_run_pb.rb
 - lib/google/cloud/websecurityscanner/v1/scan_run_warning_trace_pb.rb
 - lib/google/cloud/websecurityscanner/v1/web_security_scanner_pb.rb
@@ -197,6 +198,7 @@ files:
 - proto_docs/google/cloud/websecurityscanner/v1/scan_config_error.rb
 - proto_docs/google/cloud/websecurityscanner/v1/scan_run.rb
 - proto_docs/google/cloud/websecurityscanner/v1/scan_run_error_trace.rb
+- proto_docs/google/cloud/websecurityscanner/v1/scan_run_log.rb
 - proto_docs/google/cloud/websecurityscanner/v1/scan_run_warning_trace.rb
 - proto_docs/google/cloud/websecurityscanner/v1/web_security_scanner.rb
 - proto_docs/google/protobuf/empty.rb
@@ -214,14 +216,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: API Client library for the Web Security Scanner V1 API