google-cloud-recaptcha_enterprise 0.1.0

data/lib/google/cloud/recaptcha_enterprise.rb

@@ -0,0 +1,140 @@
+# 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.
+
+
+require "google/gax"
+require "pathname"
+
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for reCAPTCHA Enterprise API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
+    #
+    # [reCAPTCHA Enterprise API][Product Documentation]:
+    #
+    # - [Product Documentation][]
+    #
+    # ## Quick Start
+    # In order to use this library, you first need to go through the following
+    # steps:
+    #
+    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+    # 3. [Enable the reCAPTCHA Enterprise API.](https://console.cloud.google.com/apis/library/recaptchaenterprise.googleapis.com)
+    # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Installation
+    # ```
+    # $ gem install google-cloud-recaptcha_enterprise
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [reCAPTCHA Enterprise API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/recaptchaenterprise
+    #
+    # ## Enabling Logging
+    #
+    # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+    # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+    # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+    # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+    # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+    #
+    # Configuring a Ruby stdlib logger:
+    #
+    # ```ruby
+    # require "logger"
+    #
+    # module MyLogger
+    #   LOGGER = Logger.new $stderr, level: Logger::WARN
+    #   def logger
+    #     LOGGER
+    #   end
+    # end
+    #
+    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+    # module GRPC
+    #   extend MyLogger
+    # end
+    # ```
+    #
+    module RecaptchaEnterprise
+      # rubocop:enable LineLength
+
+      FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("recaptcha_enterprise"))
+
+      AVAILABLE_VERSIONS = Dir["#{FILE_DIR}/*"]
+        .select { |file| File.directory?(file) }
+        .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
+        .select { |dir| File.exist?(dir + ".rb") }
+        .map { |dir| File.basename(dir) }
+
+      ##
+      # Service to determine the likelihood an event is legitimate.
+      #
+      # @param version [Symbol, String]
+      #   The major version of the service to be used. By default :v1beta1
+      #   is used.
+      # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
+      #   @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+      #     Provides the means for authenticating requests made by the client. This parameter can
+      #     be many types.
+      #     A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+      #     authenticating requests made by this client.
+      #     A `String` will be treated as the path to the keyfile to be used for the construction of
+      #     credentials for this client.
+      #     A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+      #     credentials for this client.
+      #     A `GRPC::Core::Channel` will be used to make calls through.
+      #     A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+      #     should already be composed with a `GRPC::Core::CallCredentials` object.
+      #     A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+      #     metadata for requests, generally, to give OAuth credentials.
+      #   @param scopes [Array<String>]
+      #     The OAuth scopes for this service. This parameter is ignored if
+      #     an updater_proc is supplied.
+      #   @param client_config [Hash]
+      #     A Hash for call options for each method. See
+      #     Google::Gax#construct_settings for the structure of
+      #     this data. Falls back to the default config if not specified
+      #     or the specified config is missing data points.
+      #   @param timeout [Numeric]
+      #     The default timeout, in seconds, for calls made through this client.
+      #   @param metadata [Hash]
+      #     Default metadata to be sent with each request. This can be overridden on a per call basis.
+      #   @param exception_transformer [Proc]
+      #     An optional proc that intercepts any exceptions raised during an API call to inject
+      #     custom error handling.
+      def self.new(*args, version: :v1beta1, **kwargs)
+        unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
+          raise "The version: #{version} is not available. The available versions " \
+            "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
+        end
+
+        require "#{FILE_DIR}/#{version.to_s.downcase}"
+        version_module = Google::Cloud::RecaptchaEnterprise
+          .constants
+          .select {|sym| sym.to_s.downcase == version.to_s.downcase}
+          .first
+        Google::Cloud::RecaptchaEnterprise.const_get(version_module).new(*args, **kwargs)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,138 @@
+# 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.
+
+
+require "google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_client"
+require "google/cloud/recaptcha_enterprise/v1beta1/helpers"
+
+module Google
+  module Cloud
+    module RecaptchaEnterprise
+      # rubocop:disable LineLength
+
+      ##
+      # # Ruby Client for reCAPTCHA Enterprise API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
+      #
+      # [reCAPTCHA Enterprise API][Product Documentation]:
+      #
+      # - [Product Documentation][]
+      #
+      # ## Quick Start
+      # In order to use this library, you first need to go through the following
+      # steps:
+      #
+      # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+      # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+      # 3. [Enable the reCAPTCHA Enterprise API.](https://console.cloud.google.com/apis/library/recaptchaenterprise.googleapis.com)
+      # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+      #
+      # ### Installation
+      # ```
+      # $ gem install google-cloud-recaptcha_enterprise
+      # ```
+      #
+      # ### Next Steps
+      # - Read the [reCAPTCHA Enterprise API Product documentation][Product Documentation]
+      #   to learn more about the product and see How-to Guides.
+      # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
+      #   to see the full list of Cloud APIs that we cover.
+      #
+      # [Product Documentation]: https://cloud.google.com/recaptchaenterprise
+      #
+      # ## Enabling Logging
+      #
+      # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+      # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+      # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+      # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+      # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+      #
+      # Configuring a Ruby stdlib logger:
+      #
+      # ```ruby
+      # require "logger"
+      #
+      # module MyLogger
+      #   LOGGER = Logger.new $stderr, level: Logger::WARN
+      #   def logger
+      #     LOGGER
+      #   end
+      # end
+      #
+      # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+      # module GRPC
+      #   extend MyLogger
+      # end
+      # ```
+      #
+      module V1beta1
+        # rubocop:enable LineLength
+
+        ##
+        # Service to determine the likelihood an event is legitimate.
+        #
+        # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+        #   Provides the means for authenticating requests made by the client. This parameter can
+        #   be many types.
+        #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+        #   authenticating requests made by this client.
+        #   A `String` will be treated as the path to the keyfile to be used for the construction of
+        #   credentials for this client.
+        #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+        #   credentials for this client.
+        #   A `GRPC::Core::Channel` will be used to make calls through.
+        #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+        #   should already be composed with a `GRPC::Core::CallCredentials` object.
+        #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+        #   metadata for requests, generally, to give OAuth credentials.
+        # @param scopes [Array<String>]
+        #   The OAuth scopes for this service. This parameter is ignored if
+        #   an updater_proc is supplied.
+        # @param client_config [Hash]
+        #   A Hash for call options for each method. See
+        #   Google::Gax#construct_settings for the structure of
+        #   this data. Falls back to the default config if not specified
+        #   or the specified config is missing data points.
+        # @param timeout [Numeric]
+        #   The default timeout, in seconds, for calls made through this client.
+        # @param metadata [Hash]
+        #   Default metadata to be sent with each request. This can be overridden on a per call basis.
+        # @param exception_transformer [Proc]
+        #   An optional proc that intercepts any exceptions raised during an API call to inject
+        #   custom error handling.
+        def self.new \
+            credentials: nil,
+            scopes: nil,
+            client_config: nil,
+            timeout: nil,
+            metadata: nil,
+            exception_transformer: nil,
+            lib_name: nil,
+            lib_version: nil
+          kwargs = {
+            credentials: credentials,
+            scopes: scopes,
+            client_config: client_config,
+            timeout: timeout,
+            metadata: metadata,
+            exception_transformer: exception_transformer,
+            lib_name: lib_name,
+            lib_version: lib_version
+          }.select { |_, v| v != nil }
+          Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseClient.new(**kwargs)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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.
+
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module RecaptchaEnterprise
+      module V1beta1
+        class Credentials < Google::Auth::Credentials
+          SCOPE = [
+            "https://www.googleapis.com/auth/cloud-platform"
+          ].freeze
+          PATH_ENV_VARS = %w(RECAPTCHA_ENTERPRISE_CREDENTIALS
+                             RECAPTCHA_ENTERPRISE_KEYFILE
+                             GOOGLE_CLOUD_CREDENTIALS
+                             GOOGLE_CLOUD_KEYFILE
+                             GCLOUD_KEYFILE)
+          JSON_ENV_VARS = %w(RECAPTCHA_ENTERPRISE_CREDENTIALS_JSON
+                             RECAPTCHA_ENTERPRISE_KEYFILE_JSON
+                             GOOGLE_CLOUD_CREDENTIALS_JSON
+                             GOOGLE_CLOUD_KEYFILE_JSON
+                             GCLOUD_KEYFILE_JSON)
+          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,153 @@
+# 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 Cloud
+    module Recaptchaenterprise
+      module V1beta1
+        # The create assessment request message.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required. The name of the project in which the assessment will be created,
+        #     in the format "projects/\\{project_number}".
+        # @!attribute [rw] assessment
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::Assessment]
+        #     The asessment details.
+        class CreateAssessmentRequest; end
+
+        # The request message to annotate an Assessment.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The resource name of the Assessment, in the format
+        #     "projects/\\{project_number}/assessments/\\{assessment_id}".
+        # @!attribute [rw] annotation
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
+        #     The annotation that will be assigned to the Event.
+        class AnnotateAssessmentRequest
+          # Enum that reprensents the types of annotations.
+          module Annotation
+            # Default unspecified type.
+            ANNOTATION_UNSPECIFIED = 0
+
+            # Provides information that the event turned out to be legitimate.
+            LEGITIMATE = 1
+
+            # Provides information that the event turned out to be fraudulent.
+            FRAUDULENT = 2
+          end
+        end
+
+        # Empty response for AnnotateAssessment.
+        class AnnotateAssessmentResponse; end
+
+        # A recaptcha assessment resource.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Output only. The resource name for the Assessment in the format
+        #     "projects/\\{project_number}/assessments/\\{assessment_id}".
+        # @!attribute [rw] event
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::Event]
+        #     The event being assessed.
+        # @!attribute [rw] score
+        #   @return [Float]
+        #     Output only. Legitimate event score from 0.0 to 1.0.
+        #     (1.0 means very likely legitimate traffic while 0.0 means very likely
+        #     non-legitimate traffic).
+        # @!attribute [rw] token_properties
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::TokenProperties]
+        #     Output only. Properties of the provided event token.
+        # @!attribute [rw] reasons
+        #   @return [Array<Google::Cloud::Recaptchaenterprise::V1beta1::Assessment::ClassificationReason>]
+        #     Output only. Reasons contributing to the risk analysis verdict.
+        class Assessment
+          # LINT.IfChange(classification_reason)
+          # Reasons contributing to the risk analysis verdict.
+          module ClassificationReason
+            # Default unspecified type.
+            CLASSIFICATION_REASON_UNSPECIFIED = 0
+
+            # The event appeared to be automated.
+            AUTOMATION = 1
+
+            # The event was not made from the proper context on the real site.
+            UNEXPECTED_ENVIRONMENT = 2
+
+            # Browsing behavior leading up to the event was generated was out of the
+            # ordinary.
+            UNEXPECTED_USAGE_PATTERNS = 4
+
+            # Too little traffic has been received from this site thus far to generate
+            # quality risk analysis.
+            PROVISIONAL_RISK_ANALYSIS = 5
+          end
+        end
+
+        # @!attribute [rw] token
+        #   @return [String]
+        #     The user response token provided by the reCAPTCHA client-side integration
+        #     on your site.
+        # @!attribute [rw] site_key
+        #   @return [String]
+        #     The site key that was used to invoke reCAPTCHA on your site and generate
+        #     the token.
+        class Event; end
+
+        # @!attribute [rw] valid
+        #   @return [true, false]
+        #     Output only. Whether the provided user response token is valid.
+        # @!attribute [rw] invalid_reason
+        #   @return [Google::Cloud::Recaptchaenterprise::V1beta1::TokenProperties::InvalidReason]
+        #     Output only. Reason associated with the response when valid = false.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. The timestamp corresponding to the generation of the token.
+        # @!attribute [rw] hostname
+        #   @return [String]
+        #     Output only. The hostname of the page on which the token was generated.
+        # @!attribute [rw] action
+        #   @return [String]
+        #     Output only. Action name provided at token generation.
+        class TokenProperties
+          # Enum that represents the types of invalid token reasons.
+          module InvalidReason
+            # Default unspecified type.
+            INVALID_REASON_UNSPECIFIED = 0
+
+            # If the failure reason was not accounted for.
+            UNKNOWN_INVALID_REASON = 1
+
+            # The provided user verification token was malformed.
+            MALFORMED = 2
+
+            # The user verification token had expired.
+            EXPIRED = 3
+
+            # The user verification had already been seen.
+            DUPE = 4
+
+            # The user verification token did not match the provided site secret.
+            # This may be a configuration error (e.g. development keys used in
+            # production) or end users trying to use verification tokens from other
+            # sites.
+            SITE_MISMATCH = 5
+
+            # The user verification token was not present.  It is a required input.
+            MISSING = 6
+          end
+        end
+      end
+    end
+  end
+end