google-cloud-recaptcha_enterprise-v1 0.1.0

data/lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/credentials.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 "googleauth"
+
+module Google
+  module Cloud
+    module RecaptchaEnterprise
+      module V1
+        module RecaptchaEnterpriseService
+          # Credentials for the RecaptchaEnterpriseService API.
+          class Credentials < Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform"
+            ]
+            self.env_vars = [
+              "RECAPTCHA_ENTERPRISE_CREDENTIALS",
+              "RECAPTCHA_ENTERPRISE_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "RECAPTCHA_ENTERPRISE_CREDENTIALS_JSON",
+              "RECAPTCHA_ENTERPRISE_KEYFILE_JSON",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/paths.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 RecaptchaEnterprise
+      module V1
+        module RecaptchaEnterpriseService
+          # Path helper methods for the RecaptchaEnterpriseService API.
+          module Paths
+            ##
+            # Create a fully-qualified Assessment resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/assessments/{assessment}`
+            #
+            # @param project [String]
+            # @param assessment [String]
+            #
+            # @return [String]
+            def assessment_path project:, assessment:
+              raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/assessments/#{assessment}"
+            end
+
+            ##
+            # Create a fully-qualified Key resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/keys/{key}`
+            #
+            # @param project [String]
+            # @param key [String]
+            #
+            # @return [String]
+            def key_path project:, key:
+              raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/keys/#{key}"
+            end
+
+            ##
+            # Create a fully-qualified Project resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}`
+            #
+            # @param project [String]
+            #
+            # @return [String]
+            def project_path project:
+              "projects/#{project}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 RecaptchaEnterprise
+      module V1
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,163 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/recaptchaenterprise/v1/recaptchaenterprise.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/empty_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto", :syntax => :proto3) do
+    add_message "google.cloud.recaptchaenterprise.v1.CreateAssessmentRequest" do
+      optional :parent, :string, 1
+      optional :assessment, :message, 2, "google.cloud.recaptchaenterprise.v1.Assessment"
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest" do
+      optional :name, :string, 1
+      optional :annotation, :enum, 2, "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation"
+    end
+    add_enum "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation" do
+      value :ANNOTATION_UNSPECIFIED, 0
+      value :LEGITIMATE, 1
+      value :FRAUDULENT, 2
+      value :PASSWORD_CORRECT, 3
+      value :PASSWORD_INCORRECT, 4
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse" do
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.Assessment" do
+      optional :name, :string, 1
+      optional :event, :message, 2, "google.cloud.recaptchaenterprise.v1.Event"
+      optional :risk_analysis, :message, 3, "google.cloud.recaptchaenterprise.v1.RiskAnalysis"
+      optional :token_properties, :message, 4, "google.cloud.recaptchaenterprise.v1.TokenProperties"
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.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.v1.RiskAnalysis" do
+      optional :score, :float, 1
+      repeated :reasons, :enum, 2, "google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason"
+    end
+    add_enum "google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason" do
+      value :CLASSIFICATION_REASON_UNSPECIFIED, 0
+      value :AUTOMATION, 1
+      value :UNEXPECTED_ENVIRONMENT, 2
+      value :TOO_MUCH_TRAFFIC, 3
+      value :UNEXPECTED_USAGE_PATTERNS, 4
+      value :LOW_CONFIDENCE_SCORE, 5
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.TokenProperties" do
+      optional :valid, :bool, 1
+      optional :invalid_reason, :enum, 2, "google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason"
+      optional :create_time, :message, 3, "google.protobuf.Timestamp"
+      optional :hostname, :string, 4
+      optional :action, :string, 5
+    end
+    add_enum "google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason" do
+      value :INVALID_REASON_UNSPECIFIED, 0
+      value :UNKNOWN_INVALID_REASON, 1
+      value :MALFORMED, 2
+      value :EXPIRED, 3
+      value :DUPE, 4
+      value :MISSING, 5
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.CreateKeyRequest" do
+      optional :parent, :string, 1
+      optional :key, :message, 2, "google.cloud.recaptchaenterprise.v1.Key"
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.ListKeysRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.ListKeysResponse" do
+      repeated :keys, :message, 1, "google.cloud.recaptchaenterprise.v1.Key"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.GetKeyRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.UpdateKeyRequest" do
+      optional :key, :message, 1, "google.cloud.recaptchaenterprise.v1.Key"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.DeleteKeyRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.Key" do
+      optional :name, :string, 1
+      optional :display_name, :string, 2
+      map :labels, :string, :string, 6
+      optional :create_time, :message, 7, "google.protobuf.Timestamp"
+      oneof :platform_settings do
+        optional :web_settings, :message, 3, "google.cloud.recaptchaenterprise.v1.WebKeySettings"
+        optional :android_settings, :message, 4, "google.cloud.recaptchaenterprise.v1.AndroidKeySettings"
+        optional :ios_settings, :message, 5, "google.cloud.recaptchaenterprise.v1.IOSKeySettings"
+      end
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.WebKeySettings" do
+      optional :allow_all_domains, :bool, 3
+      repeated :allowed_domains, :string, 1
+      optional :allow_amp_traffic, :bool, 2
+      optional :integration_type, :enum, 4, "google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType"
+      optional :challenge_security_preference, :enum, 5, "google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference"
+    end
+    add_enum "google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType" do
+      value :INTEGRATION_TYPE_UNSPECIFIED, 0
+      value :SCORE, 1
+      value :CHECKBOX, 2
+      value :INVISIBLE, 3
+    end
+    add_enum "google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference" do
+      value :CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, 0
+      value :USABILITY, 1
+      value :BALANCE, 2
+      value :SECURITY, 3
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.AndroidKeySettings" do
+      repeated :allowed_package_names, :string, 1
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.IOSKeySettings" do
+      repeated :allowed_bundle_ids, :string, 1
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module RecaptchaEnterprise
+      module V1
+        CreateAssessmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.CreateAssessmentRequest").msgclass
+        AnnotateAssessmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest").msgclass
+        AnnotateAssessmentRequest::Annotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation").enummodule
+        AnnotateAssessmentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse").msgclass
+        Assessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Assessment").msgclass
+        Event = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Event").msgclass
+        RiskAnalysis = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RiskAnalysis").msgclass
+        RiskAnalysis::ClassificationReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason").enummodule
+        TokenProperties = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TokenProperties").msgclass
+        TokenProperties::InvalidReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason").enummodule
+        CreateKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.CreateKeyRequest").msgclass
+        ListKeysRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListKeysRequest").msgclass
+        ListKeysResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListKeysResponse").msgclass
+        GetKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.GetKeyRequest").msgclass
+        UpdateKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.UpdateKeyRequest").msgclass
+        DeleteKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.DeleteKeyRequest").msgclass
+        Key = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Key").msgclass
+        WebKeySettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.WebKeySettings").msgclass
+        WebKeySettings::IntegrationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType").enummodule
+        WebKeySettings::ChallengeSecurityPreference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference").enummodule
+        AndroidKeySettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AndroidKeySettings").msgclass
+        IOSKeySettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.IOSKeySettings").msgclass
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto for package 'Google.Cloud.RecaptchaEnterprise.V1'
+# Original file comments:
+# Copyright 2020 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
+#
+#     http://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.
+#
+
+require 'grpc'
+require 'google/cloud/recaptchaenterprise/v1/recaptchaenterprise_pb'
+
+module Google
+  module Cloud
+    module RecaptchaEnterprise
+      module V1
+        module RecaptchaEnterpriseService
+          # Service to determine the likelihood an event is legitimate.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService'
+
+            # Creates an Assessment of the likelihood an event is legitimate.
+            rpc :CreateAssessment, Google::Cloud::RecaptchaEnterprise::V1::CreateAssessmentRequest, Google::Cloud::RecaptchaEnterprise::V1::Assessment
+            # Annotates a previously created Assessment to provide additional information
+            # on whether the event turned out to be authentic or fradulent.
+            rpc :AnnotateAssessment, Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest, Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse
+            # Creates a new reCAPTCHA Enterprise key.
+            rpc :CreateKey, Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest, Google::Cloud::RecaptchaEnterprise::V1::Key
+            # Returns the list of all keys that belong to a project.
+            rpc :ListKeys, Google::Cloud::RecaptchaEnterprise::V1::ListKeysRequest, Google::Cloud::RecaptchaEnterprise::V1::ListKeysResponse
+            # Returns the specified key.
+            rpc :GetKey, Google::Cloud::RecaptchaEnterprise::V1::GetKeyRequest, Google::Cloud::RecaptchaEnterprise::V1::Key
+            # Updates the specified key.
+            rpc :UpdateKey, Google::Cloud::RecaptchaEnterprise::V1::UpdateKeyRequest, Google::Cloud::RecaptchaEnterprise::V1::Key
+            # Deletes the specified key.
+            rpc :DeleteKey, Google::Cloud::RecaptchaEnterprise::V1::DeleteKeyRequest, Google::Protobuf::Empty
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# reCAPTCHA Enterprise V1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end