google-cloud-recaptcha_enterprise 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9c252d2a8e4ab80cd095fd8c85c93c831d53bf4e1331aa79a90cd6eb9fc2156
-  data.tar.gz: a3e6a6d35de8ecf40aed3b57f07d43561303979f85d6bdc9afc3c52aa8a46627
+  metadata.gz: f29e5d62c83ec3bbd005f4b8e830bac1d89964d6b299d2e090964c362d19f67c
+  data.tar.gz: 6824daf6b768372b79363e1a51d7b54f260b5d90da65fdd1881613f84af37cf7
 SHA512:
-  metadata.gz: 9b7e2a4516143ac2456af9d664010aededff7e97ce4f174362b0f00c0cbe3517f16d718438565cdc50776f83c65b6fa5521e99f7e4236749d263f1d109319336
-  data.tar.gz: 821248ec9188c05719ce6d14c949330e716008dbea4ec949a57ade6386e5930881b0130f87c8e9c047bddc424fff1d86b6fd22c58c1294e43ffdef5102bc04b1
+  metadata.gz: 3a5507e996ec9a9d1172d5cb16f9c97630b5905bcd367fca2e71c6bcb3f2bd1f396315e7d6d18c5102d283ad1589fe3e0eaecf12b98b5c7258fa0024d97a1063
+  data.tar.gz: 1f554ea582ef577a797b35e922eb2740a2ba8a212da66d89a47e9c793a70ffc201d990a2724bf92aa810f0405c342c91d2d77278c753a7e402b1f09055a1e99c

data/lib/google/cloud/recaptcha_enterprise/v1beta1/doc/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb

@@ -99,12 +99,24 @@ module Google
 
         # @!attribute [rw] token
         #   @return [String]
-        #     Required. The user response token provided by the reCAPTCHA client-side integration
+        #     Optional. The user response token provided by the reCAPTCHA client-side integration
         #     on your site.
         # @!attribute [rw] site_key
         #   @return [String]
-        #     Required. The site key that was used to invoke reCAPTCHA on your site and generate
+        #     Optional. The site key that was used to invoke reCAPTCHA on your site and generate
         #     the token.
+        # @!attribute [rw] user_agent
+        #   @return [String]
+        #     Optional. The user agent present in the request from the user's device related to
+        #     this event.
+        # @!attribute [rw] user_ip_address
+        #   @return [String]
+        #     Optional. The IP address in the request from the user's device related to this event.
+        # @!attribute [rw] expected_action
+        #   @return [String]
+        #     Optional. The expected action for this type of event. This should be the same action
+        #     provided at token generation time on client-side platforms already
+        #     integrated with recaptcha enterprise.
         class Event; end
 
         # @!attribute [rw] valid
@@ -151,6 +163,158 @@ module Google
             MISSING = 6
           end
         end
+
+        # The create key request message.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required. The name of the project in which the key will be created, in the
+        #     format "projects/\\{project_number}".
+        # @!attribute [rw] key
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::Key]
+        #     Required. Information to create a reCAPTCHA Enterprise key.
+        class CreateKeyRequest; end
+
+        # The list keys request message.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required. The name of the project that contains the keys that will be
+        #     listed, in the format "projects/\\{project_number}".
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     Optional. The maximum number of keys to return. Default is 10. Max limit is
+        #     1000.
+        # @!attribute [rw] page_token
+        #   @return [String]
+        #     Optional. The next_page_token value returned from a previous.
+        #     ListKeysRequest, if any.
+        class ListKeysRequest; end
+
+        # Response to request to list keys in a project.
+        # @!attribute [rw] keys
+        #   @return [Array<Google::Cloud::Recaptchaenterprise::V1beta1::Key>]
+        #     Key details.
+        # @!attribute [rw] next_page_token
+        #   @return [String]
+        #     Token to retrieve the next page of results. It is set to empty if no keys
+        #     remain in results.
+        class ListKeysResponse; end
+
+        # The get key request message.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The name of the requested key, in the format
+        #     "projects/\\{project_number}/keys/\\{key_id}".
+        class GetKeyRequest; end
+
+        # The update key request message.
+        # @!attribute [rw] key
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::Key]
+        #     Required. The key to update.
+        # @!attribute [rw] update_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Optional. The mask to control which field of the key get updated. If the mask is not
+        #     present, all fields will be updated.
+        class UpdateKeyRequest; end
+
+        # The delete key request message.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The name of the key to be deleted, in the format
+        #     "projects/\\{project_number}/keys/\\{key_id}".
+        class DeleteKeyRequest; end
+
+        # A key used to identify and configure applications (web and/or mobile) that
+        # use reCAPTCHA Enterprise.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The resource name for the Key in the format
+        #     "projects/\\{project_number}/keys/\\{key_id}".
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     Human-readable display name of this key. Modifiable by user.
+        # @!attribute [rw] web_settings
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::WebKeySettings]
+        #     Settings for keys that can be used by websites.
+        # @!attribute [rw] android_settings
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::AndroidKeySettings]
+        #     Settings for keys that can be used by Android apps.
+        # @!attribute [rw] ios_settings
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::IOSKeySettings]
+        #     Settings for keys that can be used by iOS apps.
+        class Key; end
+
+        # Settings specific to keys that can be used by websites.
+        # @!attribute [rw] enforce_allowed_domains
+        #   @return [true, false]
+        #     Whether allowed_domains is enforced or not.
+        # @!attribute [rw] allowed_domains
+        #   @return [Array<String>]
+        #     Domains or subdomains of websites allowed to use the key. All subdomains
+        #     of an allowed domain are automatically allowed. A valid domain requires a
+        #     host and must not include any path, port, query or fragment.
+        #     Examples: 'example.com' or 'subdomain.example.com'
+        # @!attribute [rw] allow_amp_traffic
+        #   @return [true, false]
+        #     Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
+        # @!attribute [rw] integration_type
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::WebKeySettings::IntegrationType]
+        #     Required. Describes how this key is integrated with the website.
+        # @!attribute [rw] challenge_security_preference
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::WebKeySettings::ChallengeSecurityPreference]
+        #     Settings for the frequency and difficulty at which this key triggers
+        #     captcha challenges. This should only be specified for IntegrationTypes
+        #     CHECKBOX_CHALLENGE and INVISIBLE_CHALLENGE.
+        class WebKeySettings
+          # Enum that represents the possible challenge frequency and difficulty
+          # configurations for a web key.
+          module ChallengeSecurityPreference
+            # Default type that indicates this enum hasn't been specified.
+            CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0
+
+            # Key tends to show fewer and easier challenges.
+            USABILITY = 1
+
+            # Key tends to show balanced (in amount and difficulty) challenges.
+            BALANCED = 2
+
+            # Key tends to show more and harder challenges.
+            SECURITY = 3
+          end
+
+          # Enum that represents the integration types for web keys.
+          module IntegrationType
+            # Default type that indicates this enum hasn't been specified. This is not
+            # a valid IntegrationType, one of the other types must be specified
+            # instead.
+            INTEGRATION_TYPE_UNSPECIFIED = 0
+
+            # Only used to produce scores. It doesn't display the "I'm not a robot"
+            # checkbox and never shows captcha challenges.
+            SCORE_ONLY = 1
+
+            # Displays the "I'm not a robot" checkbox and may show captcha challenges
+            # after it is checked.
+            CHECKBOX_CHALLENGE = 2
+
+            # Doesn't display the "I'm not a robot" checkbox, but may show captcha
+            # challenges after risk analysis.
+            INVISIBLE_CHALLENGE = 3
+          end
+        end
+
+        # Settings specific to keys that can be used by Android apps.
+        # @!attribute [rw] allowed_package_names
+        #   @return [Array<String>]
+        #     Android package names of apps allowed to use the key.
+        #     Example: 'com.companyname.appname'
+        class AndroidKeySettings; end
+
+        # Settings specific to keys that can be used by iOS apps.
+        # @!attribute [rw] allowed_bundle_ids
+        #   @return [Array<String>]
+        #     iOS bundle ids of apps allowed to use the key.
+        #     Example: 'com.companyname.productname.appname'
+        class IOSKeySettings; end
       end
     end
   end

data/lib/google/cloud/recaptcha_enterprise/v1beta1/doc/google/protobuf/empty.rb

@@ -0,0 +1,29 @@
+# Copyright 2019 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.
+
+
+module Google
+  module Protobuf
+    # A generic empty message that you can re-use to avoid defining duplicated
+    # empty messages in your APIs. A typical example is to use it as the request
+    # or the response type of an API method. For instance:
+    #
+    #     service Foo {
+    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+    #     }
+    #
+    # The JSON representation for `Empty` is empty JSON object `{}`.
+    class Empty; end
+  end
+end

data/lib/google/cloud/recaptcha_enterprise/v1beta1/doc/google/protobuf/field_mask.rb

@@ -0,0 +1,222 @@
+# Copyright 2019 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.
+
+
+module Google
+  module Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # = Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # = Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # == Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # = JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # = Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # == Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is duplicated or unmappable.
+    # @!attribute [rw] paths
+    #   @return [Array<String>]
+    #     The set of field mask paths.
+    class FieldMask; end
+  end
+end

data/lib/google/cloud/recaptcha_enterprise/v1beta1/helpers.rb

@@ -26,6 +26,14 @@ module Google
             self.class.assessment_path project, assessment
           end
           
+          # Alias for Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseClient.key_path.
+          # @param project [String]
+          # @param key [String]
+          # @return [String]
+          def key_path project, key
+            self.class.key_path project, key
+          end
+          
           # Alias for Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseClient.project_path.
           # @param project [String]
           # @return [String]

data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_client.rb

@@ -52,6 +52,15 @@ module Google
 
           DEFAULT_TIMEOUT = 30
 
+          PAGE_DESCRIPTORS = {
+            "list_keys" => Google::Gax::PageDescriptor.new(
+              "page_token",
+              "next_page_token",
+              "keys")
+          }.freeze
+
+          private_constant :PAGE_DESCRIPTORS
+
           # The scopes needed to make gRPC calls to all of the methods defined in
           # this service.
           ALL_SCOPES = [
@@ -65,6 +74,12 @@ module Google
 
           private_constant :ASSESSMENT_PATH_TEMPLATE
 
+          KEY_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/keys/{key}"
+          )
+
+          private_constant :KEY_PATH_TEMPLATE
+
           PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}"
           )
@@ -82,6 +97,17 @@ module Google
             )
           end
 
+          # Returns a fully-qualified key resource name string.
+          # @param project [String]
+          # @param key [String]
+          # @return [String]
+          def self.key_path project, key
+            KEY_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"key" => key
+            )
+          end
+
           # Returns a fully-qualified project resource name string.
           # @param project [String]
           # @return [String]
@@ -179,6 +205,7 @@ module Google
                 client_config,
                 Google::Gax::Grpc::STATUS_CODE_NAMES,
                 timeout,
+                page_descriptors: PAGE_DESCRIPTORS,
                 errors: Google::Gax::Grpc::API_ERRORS,
                 metadata: headers
               )
@@ -215,6 +242,46 @@ module Google
                 {'name' => request.name}
               end
             )
+            @create_key = Google::Gax.create_api_call(
+              @recaptcha_enterprise_stub.method(:create_key),
+              defaults["create_key"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
+            )
+            @list_keys = Google::Gax.create_api_call(
+              @recaptcha_enterprise_stub.method(:list_keys),
+              defaults["list_keys"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
+            )
+            @get_key = Google::Gax.create_api_call(
+              @recaptcha_enterprise_stub.method(:get_key),
+              defaults["get_key"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
+            )
+            @update_key = Google::Gax.create_api_call(
+              @recaptcha_enterprise_stub.method(:update_key),
+              defaults["update_key"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'key.name' => request.key.name}
+              end
+            )
+            @delete_key = Google::Gax.create_api_call(
+              @recaptcha_enterprise_stub.method(:delete_key),
+              defaults["delete_key"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
+            )
           end
 
           # Service calls
@@ -297,6 +364,204 @@ module Google
             req = Google::Gax::to_proto(req, Google::Cloud::Recaptchaenterprise::V1beta1::AnnotateAssessmentRequest)
             @annotate_assessment.call(req, options, &block)
           end
+
+          # Creates a new reCAPTCHA Enterprise key.
+          #
+          # @param parent [String]
+          #   Required. The name of the project in which the key will be created, in the
+          #   format "projects/\\{project_number}".
+          # @param key [Google::Cloud::Recaptchaenterprise::V1beta1::Key | Hash]
+          #   Required. Information to create a reCAPTCHA Enterprise key.
+          #   A hash of the same form as `Google::Cloud::Recaptchaenterprise::V1beta1::Key`
+          #   can also be provided.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Cloud::Recaptchaenterprise::V1beta1::Key]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @return [Google::Cloud::Recaptchaenterprise::V1beta1::Key]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/recaptcha_enterprise"
+          #
+          #   recaptcha_enterprise_client = Google::Cloud::RecaptchaEnterprise.new(version: :v1beta1)
+          #   formatted_parent = Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseClient.project_path("[PROJECT]")
+          #
+          #   # TODO: Initialize `key`:
+          #   key = {}
+          #   response = recaptcha_enterprise_client.create_key(formatted_parent, key)
+
+          def create_key \
+              parent,
+              key,
+              options: nil,
+              &block
+            req = {
+              parent: parent,
+              key: key
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Recaptchaenterprise::V1beta1::CreateKeyRequest)
+            @create_key.call(req, options, &block)
+          end
+
+          # Returns the list of all keys that belong to a project.
+          #
+          # @param parent [String]
+          #   Required. The name of the project that contains the keys that will be
+          #   listed, in the format "projects/\\{project_number}".
+          # @param page_size [Integer]
+          #   The maximum number of resources contained in the underlying API
+          #   response. If page streaming is performed per-resource, this
+          #   parameter does not affect the return value. If page streaming is
+          #   performed per-page, this determines the maximum number of
+          #   resources in a page.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Gax::PagedEnumerable<Google::Cloud::Recaptchaenterprise::V1beta1::Key>]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @return [Google::Gax::PagedEnumerable<Google::Cloud::Recaptchaenterprise::V1beta1::Key>]
+          #   An enumerable of Google::Cloud::Recaptchaenterprise::V1beta1::Key instances.
+          #   See Google::Gax::PagedEnumerable documentation for other
+          #   operations such as per-page iteration or access to the response
+          #   object.
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/recaptcha_enterprise"
+          #
+          #   recaptcha_enterprise_client = Google::Cloud::RecaptchaEnterprise.new(version: :v1beta1)
+          #   formatted_parent = Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseClient.project_path("[PROJECT]")
+          #
+          #   # Iterate over all results.
+          #   recaptcha_enterprise_client.list_keys(formatted_parent).each do |element|
+          #     # Process element.
+          #   end
+          #
+          #   # Or iterate over results one page at a time.
+          #   recaptcha_enterprise_client.list_keys(formatted_parent).each_page do |page|
+          #     # Process each page at a time.
+          #     page.each do |element|
+          #       # Process element.
+          #     end
+          #   end
+
+          def list_keys \
+              parent,
+              page_size: nil,
+              options: nil,
+              &block
+            req = {
+              parent: parent,
+              page_size: page_size
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Recaptchaenterprise::V1beta1::ListKeysRequest)
+            @list_keys.call(req, options, &block)
+          end
+
+          # Returns the specified key.
+          #
+          # @param name [String]
+          #   Required. The name of the requested key, in the format
+          #   "projects/\\{project_number}/keys/\\{key_id}".
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Cloud::Recaptchaenterprise::V1beta1::Key]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @return [Google::Cloud::Recaptchaenterprise::V1beta1::Key]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/recaptcha_enterprise"
+          #
+          #   recaptcha_enterprise_client = Google::Cloud::RecaptchaEnterprise.new(version: :v1beta1)
+          #   formatted_name = Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseClient.key_path("[PROJECT]", "[KEY]")
+          #   response = recaptcha_enterprise_client.get_key(formatted_name)
+
+          def get_key \
+              name,
+              options: nil,
+              &block
+            req = {
+              name: name
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Recaptchaenterprise::V1beta1::GetKeyRequest)
+            @get_key.call(req, options, &block)
+          end
+
+          # Updates the specified key.
+          #
+          # @param key [Google::Cloud::Recaptchaenterprise::V1beta1::Key | Hash]
+          #   Required. The key to update.
+          #   A hash of the same form as `Google::Cloud::Recaptchaenterprise::V1beta1::Key`
+          #   can also be provided.
+          # @param update_mask [Google::Protobuf::FieldMask | Hash]
+          #   Optional. The mask to control which field of the key get updated. If the mask is not
+          #   present, all fields will be updated.
+          #   A hash of the same form as `Google::Protobuf::FieldMask`
+          #   can also be provided.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Cloud::Recaptchaenterprise::V1beta1::Key]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @return [Google::Cloud::Recaptchaenterprise::V1beta1::Key]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/recaptcha_enterprise"
+          #
+          #   recaptcha_enterprise_client = Google::Cloud::RecaptchaEnterprise.new(version: :v1beta1)
+          #
+          #   # TODO: Initialize `key`:
+          #   key = {}
+          #   response = recaptcha_enterprise_client.update_key(key)
+
+          def update_key \
+              key,
+              update_mask: nil,
+              options: nil,
+              &block
+            req = {
+              key: key,
+              update_mask: update_mask
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Recaptchaenterprise::V1beta1::UpdateKeyRequest)
+            @update_key.call(req, options, &block)
+          end
+
+          # Deletes the specified key.
+          #
+          # @param name [String]
+          #   Required. The name of the key to be deleted, in the format
+          #   "projects/\\{project_number}/keys/\\{key_id}".
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result []
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/recaptcha_enterprise"
+          #
+          #   recaptcha_enterprise_client = Google::Cloud::RecaptchaEnterprise.new(version: :v1beta1)
+          #   formatted_name = Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseClient.key_path("[PROJECT]", "[KEY]")
+          #   recaptcha_enterprise_client.delete_key(formatted_name)
+
+          def delete_key \
+              name,
+              options: nil,
+              &block
+            req = {
+              name: name
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Recaptchaenterprise::V1beta1::DeleteKeyRequest)
+            @delete_key.call(req, options, &block)
+            nil
+          end
         end
       end
     end

data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_client_config.json

@@ -29,6 +29,31 @@
           "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
+        },
+        "CreateKey": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "ListKeys": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "GetKey": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "UpdateKey": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "DeleteKey": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
         }
       }
     }

data/lib/google/cloud/recaptcha_enterprise/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module RecaptchaEnterprise
-      VERSION = "0.3.1".freeze
+      VERSION = "0.4.0".freeze
     end
   end
 end

data/lib/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_pb.rb

@@ -8,6 +8,8 @@ require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.cloud.recaptchaenterprise.v1beta1.CreateAssessmentRequest" do
@@ -43,6 +45,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.cloud.recaptchaenterprise.v1beta1.Event" do
     optional :token, :string, 1
     optional :site_key, :string, 2
+    optional :user_agent, :string, 3
+    optional :user_ip_address, :string, 4
+    optional :expected_action, :string, 5
   end
   add_message "google.cloud.recaptchaenterprise.v1beta1.TokenProperties" do
     optional :valid, :bool, 1
@@ -60,6 +65,63 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     value :SITE_MISMATCH, 5
     value :MISSING, 6
   end
+  add_message "google.cloud.recaptchaenterprise.v1beta1.CreateKeyRequest" do
+    optional :parent, :string, 1
+    optional :key, :message, 2, "google.cloud.recaptchaenterprise.v1beta1.Key"
+  end
+  add_message "google.cloud.recaptchaenterprise.v1beta1.ListKeysRequest" do
+    optional :parent, :string, 1
+    optional :page_size, :int32, 2
+    optional :page_token, :string, 3
+  end
+  add_message "google.cloud.recaptchaenterprise.v1beta1.ListKeysResponse" do
+    repeated :keys, :message, 1, "google.cloud.recaptchaenterprise.v1beta1.Key"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.cloud.recaptchaenterprise.v1beta1.GetKeyRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest" do
+    optional :key, :message, 1, "google.cloud.recaptchaenterprise.v1beta1.Key"
+    optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+  end
+  add_message "google.cloud.recaptchaenterprise.v1beta1.DeleteKeyRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.recaptchaenterprise.v1beta1.Key" do
+    optional :name, :string, 1
+    optional :display_name, :string, 2
+    oneof :platform_settings do
+      optional :web_settings, :message, 3, "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings"
+      optional :android_settings, :message, 4, "google.cloud.recaptchaenterprise.v1beta1.AndroidKeySettings"
+      optional :ios_settings, :message, 5, "google.cloud.recaptchaenterprise.v1beta1.IOSKeySettings"
+    end
+  end
+  add_message "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings" do
+    optional :enforce_allowed_domains, :bool, 3
+    repeated :allowed_domains, :string, 1
+    optional :allow_amp_traffic, :bool, 2
+    optional :integration_type, :enum, 4, "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.IntegrationType"
+    optional :challenge_security_preference, :enum, 5, "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference"
+  end
+  add_enum "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.IntegrationType" do
+    value :INTEGRATION_TYPE_UNSPECIFIED, 0
+    value :SCORE_ONLY, 1
+    value :CHECKBOX_CHALLENGE, 2
+    value :INVISIBLE_CHALLENGE, 3
+  end
+  add_enum "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference" do
+    value :CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, 0
+    value :USABILITY, 1
+    value :BALANCED, 2
+    value :SECURITY, 3
+  end
+  add_message "google.cloud.recaptchaenterprise.v1beta1.AndroidKeySettings" do
+    repeated :allowed_package_names, :string, 1
+  end
+  add_message "google.cloud.recaptchaenterprise.v1beta1.IOSKeySettings" do
+    repeated :allowed_bundle_ids, :string, 1
+  end
 end
 
 module Google
@@ -75,6 +137,18 @@ module Google
         Event = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.Event").msgclass
         TokenProperties = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TokenProperties").msgclass
         TokenProperties::InvalidReason = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TokenProperties.InvalidReason").enummodule
+        CreateKeyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.CreateKeyRequest").msgclass
+        ListKeysRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.ListKeysRequest").msgclass
+        ListKeysResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.ListKeysResponse").msgclass
+        GetKeyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.GetKeyRequest").msgclass
+        UpdateKeyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest").msgclass
+        DeleteKeyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.DeleteKeyRequest").msgclass
+        Key = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.Key").msgclass
+        WebKeySettings = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.WebKeySettings").msgclass
+        WebKeySettings::IntegrationType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.IntegrationType").enummodule
+        WebKeySettings::ChallengeSecurityPreference = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference").enummodule
+        AndroidKeySettings = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AndroidKeySettings").msgclass
+        IOSKeySettings = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.IOSKeySettings").msgclass
       end
     end
   end

data/lib/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_services_pb.rb

@@ -40,6 +40,16 @@ module Google
             # Annotates a previously created Assessment to provide additional information
             # on whether the event turned out to be authentic or fradulent.
             rpc :AnnotateAssessment, AnnotateAssessmentRequest, AnnotateAssessmentResponse
+            # Creates a new reCAPTCHA Enterprise key.
+            rpc :CreateKey, CreateKeyRequest, Key
+            # Returns the list of all keys that belong to a project.
+            rpc :ListKeys, ListKeysRequest, ListKeysResponse
+            # Returns the specified key.
+            rpc :GetKey, GetKeyRequest, Key
+            # Updates the specified key.
+            rpc :UpdateKey, UpdateKeyRequest, Key
+            # Deletes the specified key.
+            rpc :DeleteKey, DeleteKeyRequest, Google::Protobuf::Empty
           end
 
           Stub = Service.rpc_stub_class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recaptcha_enterprise
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-gax
@@ -163,6 +163,8 @@ files:
 - lib/google/cloud/recaptcha_enterprise/v1beta1.rb
 - lib/google/cloud/recaptcha_enterprise/v1beta1/credentials.rb
 - lib/google/cloud/recaptcha_enterprise/v1beta1/doc/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb
+- lib/google/cloud/recaptcha_enterprise/v1beta1/doc/google/protobuf/empty.rb
+- lib/google/cloud/recaptcha_enterprise/v1beta1/doc/google/protobuf/field_mask.rb
 - lib/google/cloud/recaptcha_enterprise/v1beta1/doc/google/protobuf/timestamp.rb
 - lib/google/cloud/recaptcha_enterprise/v1beta1/helpers.rb
 - lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_client.rb