google-cloud-recaptcha_enterprise 0.6.0 → 1.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +2 -1
- data/AUTHENTICATION.md +51 -54
- data/LICENSE.md +203 -0
- data/MIGRATING.md +329 -0
- data/README.md +94 -23
- data/lib/{google/cloud/recaptcha_enterprise/v1beta1/doc/google/protobuf/empty.rb → google-cloud-recaptcha_enterprise.rb} +4 -14
- data/lib/google/cloud/recaptcha_enterprise.rb +87 -116
- data/lib/google/cloud/recaptcha_enterprise/version.rb +6 -2
- metadata +63 -56
- data/LICENSE +0 -201
- data/lib/google/cloud/recaptcha_enterprise/v1beta1.rb +0 -146
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/credentials.rb +0 -41
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/doc/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb +0 -321
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/doc/google/protobuf/field_mask.rb +0 -222
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/doc/google/protobuf/timestamp.rb +0 -113
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/helpers.rb +0 -47
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_client.rb +0 -572
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_client_config.json +0 -61
- data/lib/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_pb.rb +0 -156
- data/lib/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_services_pb.rb +0 -61
data/LICENSE
DELETED
@@ -1,201 +0,0 @@
|
|
1
|
-
Apache License
|
2
|
-
Version 2.0, January 2004
|
3
|
-
https://www.apache.org/licenses/
|
4
|
-
|
5
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
-
|
7
|
-
1. Definitions.
|
8
|
-
|
9
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
-
|
12
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
-
the copyright owner that is granting the License.
|
14
|
-
|
15
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
-
other entities that control, are controlled by, or are under common
|
17
|
-
control with that entity. For the purposes of this definition,
|
18
|
-
"control" means (i) the power, direct or indirect, to cause the
|
19
|
-
direction or management of such entity, whether by contract or
|
20
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
-
|
23
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
-
exercising permissions granted by this License.
|
25
|
-
|
26
|
-
"Source" form shall mean the preferred form for making modifications,
|
27
|
-
including but not limited to software source code, documentation
|
28
|
-
source, and configuration files.
|
29
|
-
|
30
|
-
"Object" form shall mean any form resulting from mechanical
|
31
|
-
transformation or translation of a Source form, including but
|
32
|
-
not limited to compiled object code, generated documentation,
|
33
|
-
and conversions to other media types.
|
34
|
-
|
35
|
-
"Work" shall mean the work of authorship, whether in Source or
|
36
|
-
Object form, made available under the License, as indicated by a
|
37
|
-
copyright notice that is included in or attached to the work
|
38
|
-
(an example is provided in the Appendix below).
|
39
|
-
|
40
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
-
form, that is based on (or derived from) the Work and for which the
|
42
|
-
editorial revisions, annotations, elaborations, or other modifications
|
43
|
-
represent, as a whole, an original work of authorship. For the purposes
|
44
|
-
of this License, Derivative Works shall not include works that remain
|
45
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
-
the Work and Derivative Works thereof.
|
47
|
-
|
48
|
-
"Contribution" shall mean any work of authorship, including
|
49
|
-
the original version of the Work and any modifications or additions
|
50
|
-
to that Work or Derivative Works thereof, that is intentionally
|
51
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
-
means any form of electronic, verbal, or written communication sent
|
55
|
-
to the Licensor or its representatives, including but not limited to
|
56
|
-
communication on electronic mailing lists, source code control systems,
|
57
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
-
Licensor for the purpose of discussing and improving the Work, but
|
59
|
-
excluding communication that is conspicuously marked or otherwise
|
60
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
-
|
62
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
-
on behalf of whom a Contribution has been received by Licensor and
|
64
|
-
subsequently incorporated within the Work.
|
65
|
-
|
66
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
-
this License, each Contributor hereby grants to You a perpetual,
|
68
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
-
copyright license to reproduce, prepare Derivative Works of,
|
70
|
-
publicly display, publicly perform, sublicense, and distribute the
|
71
|
-
Work and such Derivative Works in Source or Object form.
|
72
|
-
|
73
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
-
this License, each Contributor hereby grants to You a perpetual,
|
75
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
-
(except as stated in this section) patent license to make, have made,
|
77
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
-
where such license applies only to those patent claims licensable
|
79
|
-
by such Contributor that are necessarily infringed by their
|
80
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
-
with the Work to which such Contribution(s) was submitted. If You
|
82
|
-
institute patent litigation against any entity (including a
|
83
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
-
or a Contribution incorporated within the Work constitutes direct
|
85
|
-
or contributory patent infringement, then any patent licenses
|
86
|
-
granted to You under this License for that Work shall terminate
|
87
|
-
as of the date such litigation is filed.
|
88
|
-
|
89
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
-
Work or Derivative Works thereof in any medium, with or without
|
91
|
-
modifications, and in Source or Object form, provided that You
|
92
|
-
meet the following conditions:
|
93
|
-
|
94
|
-
(a) You must give any other recipients of the Work or
|
95
|
-
Derivative Works a copy of this License; and
|
96
|
-
|
97
|
-
(b) You must cause any modified files to carry prominent notices
|
98
|
-
stating that You changed the files; and
|
99
|
-
|
100
|
-
(c) You must retain, in the Source form of any Derivative Works
|
101
|
-
that You distribute, all copyright, patent, trademark, and
|
102
|
-
attribution notices from the Source form of the Work,
|
103
|
-
excluding those notices that do not pertain to any part of
|
104
|
-
the Derivative Works; and
|
105
|
-
|
106
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
-
distribution, then any Derivative Works that You distribute must
|
108
|
-
include a readable copy of the attribution notices contained
|
109
|
-
within such NOTICE file, excluding those notices that do not
|
110
|
-
pertain to any part of the Derivative Works, in at least one
|
111
|
-
of the following places: within a NOTICE text file distributed
|
112
|
-
as part of the Derivative Works; within the Source form or
|
113
|
-
documentation, if provided along with the Derivative Works; or,
|
114
|
-
within a display generated by the Derivative Works, if and
|
115
|
-
wherever such third-party notices normally appear. The contents
|
116
|
-
of the NOTICE file are for informational purposes only and
|
117
|
-
do not modify the License. You may add Your own attribution
|
118
|
-
notices within Derivative Works that You distribute, alongside
|
119
|
-
or as an addendum to the NOTICE text from the Work, provided
|
120
|
-
that such additional attribution notices cannot be construed
|
121
|
-
as modifying the License.
|
122
|
-
|
123
|
-
You may add Your own copyright statement to Your modifications and
|
124
|
-
may provide additional or different license terms and conditions
|
125
|
-
for use, reproduction, or distribution of Your modifications, or
|
126
|
-
for any such Derivative Works as a whole, provided Your use,
|
127
|
-
reproduction, and distribution of the Work otherwise complies with
|
128
|
-
the conditions stated in this License.
|
129
|
-
|
130
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
-
any Contribution intentionally submitted for inclusion in the Work
|
132
|
-
by You to the Licensor shall be under the terms and conditions of
|
133
|
-
this License, without any additional terms or conditions.
|
134
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
-
the terms of any separate license agreement you may have executed
|
136
|
-
with Licensor regarding such Contributions.
|
137
|
-
|
138
|
-
6. Trademarks. This License does not grant permission to use the trade
|
139
|
-
names, trademarks, service marks, or product names of the Licensor,
|
140
|
-
except as required for reasonable and customary use in describing the
|
141
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
-
|
143
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
-
agreed to in writing, Licensor provides the Work (and each
|
145
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
-
implied, including, without limitation, any warranties or conditions
|
148
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
-
appropriateness of using or redistributing the Work and assume any
|
151
|
-
risks associated with Your exercise of permissions under this License.
|
152
|
-
|
153
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
-
whether in tort (including negligence), contract, or otherwise,
|
155
|
-
unless required by applicable law (such as deliberate and grossly
|
156
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
-
liable to You for damages, including any direct, indirect, special,
|
158
|
-
incidental, or consequential damages of any character arising as a
|
159
|
-
result of this License or out of the use or inability to use the
|
160
|
-
Work (including but not limited to damages for loss of goodwill,
|
161
|
-
work stoppage, computer failure or malfunction, or any and all
|
162
|
-
other commercial damages or losses), even if such Contributor
|
163
|
-
has been advised of the possibility of such damages.
|
164
|
-
|
165
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
-
or other liability obligations and/or rights consistent with this
|
169
|
-
License. However, in accepting such obligations, You may act only
|
170
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
-
of any other Contributor, and only if You agree to indemnify,
|
172
|
-
defend, and hold each Contributor harmless for any liability
|
173
|
-
incurred by, or claims asserted against, such Contributor by reason
|
174
|
-
of your accepting any such warranty or additional liability.
|
175
|
-
|
176
|
-
END OF TERMS AND CONDITIONS
|
177
|
-
|
178
|
-
APPENDIX: How to apply the Apache License to your work.
|
179
|
-
|
180
|
-
To apply the Apache License to your work, attach the following
|
181
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
-
replaced with your own identifying information. (Don't include
|
183
|
-
the brackets!) The text should be enclosed in the appropriate
|
184
|
-
comment syntax for the file format. We also recommend that a
|
185
|
-
file or class name and description of purpose be included on the
|
186
|
-
same "printed page" as the copyright notice for easier
|
187
|
-
identification within third-party archives.
|
188
|
-
|
189
|
-
Copyright [yyyy] [name of copyright owner]
|
190
|
-
|
191
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
-
you may not use this file except in compliance with the License.
|
193
|
-
You may obtain a copy of the License at
|
194
|
-
|
195
|
-
https://www.apache.org/licenses/LICENSE-2.0
|
196
|
-
|
197
|
-
Unless required by applicable law or agreed to in writing, software
|
198
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
-
See the License for the specific language governing permissions and
|
201
|
-
limitations under the License.
|
@@ -1,146 +0,0 @@
|
|
1
|
-
# Copyright 2020 Google LLC
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
|
16
|
-
require "google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_client"
|
17
|
-
require "google/cloud/recaptcha_enterprise/v1beta1/helpers"
|
18
|
-
|
19
|
-
module Google
|
20
|
-
module Cloud
|
21
|
-
module RecaptchaEnterprise
|
22
|
-
# rubocop:disable LineLength
|
23
|
-
|
24
|
-
##
|
25
|
-
# # Ruby Client for reCAPTCHA Enterprise API
|
26
|
-
#
|
27
|
-
# [reCAPTCHA Enterprise API][Product Documentation]:
|
28
|
-
#
|
29
|
-
# - [Product Documentation][]
|
30
|
-
#
|
31
|
-
# ## Quick Start
|
32
|
-
# In order to use this library, you first need to go through the following
|
33
|
-
# steps:
|
34
|
-
#
|
35
|
-
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
36
|
-
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
37
|
-
# 3. [Enable the reCAPTCHA Enterprise API.](https://console.cloud.google.com/apis/library/recaptchaenterprise.googleapis.com)
|
38
|
-
# 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-recaptcha_enterprise/latest/file.AUTHENTICATION.html)
|
39
|
-
#
|
40
|
-
# ### Installation
|
41
|
-
# ```
|
42
|
-
# $ gem install google-cloud-recaptcha_enterprise
|
43
|
-
# ```
|
44
|
-
#
|
45
|
-
# ### Next Steps
|
46
|
-
# - Read the [reCAPTCHA Enterprise API Product documentation][Product Documentation]
|
47
|
-
# to learn more about the product and see How-to Guides.
|
48
|
-
# - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
49
|
-
# to see the full list of Cloud APIs that we cover.
|
50
|
-
#
|
51
|
-
# [Product Documentation]: https://cloud.google.com/recaptcha-enterprise
|
52
|
-
#
|
53
|
-
# ## Enabling Logging
|
54
|
-
#
|
55
|
-
# To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
56
|
-
# 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,
|
57
|
-
# or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
|
58
|
-
# 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)
|
59
|
-
# and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
60
|
-
#
|
61
|
-
# Configuring a Ruby stdlib logger:
|
62
|
-
#
|
63
|
-
# ```ruby
|
64
|
-
# require "logger"
|
65
|
-
#
|
66
|
-
# module MyLogger
|
67
|
-
# LOGGER = Logger.new $stderr, level: Logger::WARN
|
68
|
-
# def logger
|
69
|
-
# LOGGER
|
70
|
-
# end
|
71
|
-
# end
|
72
|
-
#
|
73
|
-
# # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
|
74
|
-
# module GRPC
|
75
|
-
# extend MyLogger
|
76
|
-
# end
|
77
|
-
# ```
|
78
|
-
#
|
79
|
-
module V1beta1
|
80
|
-
# rubocop:enable LineLength
|
81
|
-
|
82
|
-
##
|
83
|
-
# Service to determine the likelihood an event is legitimate.
|
84
|
-
#
|
85
|
-
# @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
|
86
|
-
# Provides the means for authenticating requests made by the client. This parameter can
|
87
|
-
# be many types.
|
88
|
-
# A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
|
89
|
-
# authenticating requests made by this client.
|
90
|
-
# A `String` will be treated as the path to the keyfile to be used for the construction of
|
91
|
-
# credentials for this client.
|
92
|
-
# A `Hash` will be treated as the contents of a keyfile to be used for the construction of
|
93
|
-
# credentials for this client.
|
94
|
-
# A `GRPC::Core::Channel` will be used to make calls through.
|
95
|
-
# A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
|
96
|
-
# should already be composed with a `GRPC::Core::CallCredentials` object.
|
97
|
-
# A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
|
98
|
-
# metadata for requests, generally, to give OAuth credentials.
|
99
|
-
# @param scopes [Array<String>]
|
100
|
-
# The OAuth scopes for this service. This parameter is ignored if
|
101
|
-
# an updater_proc is supplied.
|
102
|
-
# @param client_config [Hash]
|
103
|
-
# A Hash for call options for each method. See
|
104
|
-
# Google::Gax#construct_settings for the structure of
|
105
|
-
# this data. Falls back to the default config if not specified
|
106
|
-
# or the specified config is missing data points.
|
107
|
-
# @param timeout [Numeric]
|
108
|
-
# The default timeout, in seconds, for calls made through this client.
|
109
|
-
# @param metadata [Hash]
|
110
|
-
# Default metadata to be sent with each request. This can be overridden on a per call basis.
|
111
|
-
# @param service_address [String]
|
112
|
-
# Override for the service hostname, or `nil` to leave as the default.
|
113
|
-
# @param service_port [Integer]
|
114
|
-
# Override for the service port, or `nil` to leave as the default.
|
115
|
-
# @param exception_transformer [Proc]
|
116
|
-
# An optional proc that intercepts any exceptions raised during an API call to inject
|
117
|
-
# custom error handling.
|
118
|
-
def self.new \
|
119
|
-
credentials: nil,
|
120
|
-
scopes: nil,
|
121
|
-
client_config: nil,
|
122
|
-
timeout: nil,
|
123
|
-
metadata: nil,
|
124
|
-
service_address: nil,
|
125
|
-
service_port: nil,
|
126
|
-
exception_transformer: nil,
|
127
|
-
lib_name: nil,
|
128
|
-
lib_version: nil
|
129
|
-
kwargs = {
|
130
|
-
credentials: credentials,
|
131
|
-
scopes: scopes,
|
132
|
-
client_config: client_config,
|
133
|
-
timeout: timeout,
|
134
|
-
metadata: metadata,
|
135
|
-
exception_transformer: exception_transformer,
|
136
|
-
lib_name: lib_name,
|
137
|
-
service_address: service_address,
|
138
|
-
service_port: service_port,
|
139
|
-
lib_version: lib_version
|
140
|
-
}.select { |_, v| v != nil }
|
141
|
-
Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseClient.new(**kwargs)
|
142
|
-
end
|
143
|
-
end
|
144
|
-
end
|
145
|
-
end
|
146
|
-
end
|
@@ -1,41 +0,0 @@
|
|
1
|
-
# Copyright 2020 Google LLC
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
|
16
|
-
require "googleauth"
|
17
|
-
|
18
|
-
module Google
|
19
|
-
module Cloud
|
20
|
-
module RecaptchaEnterprise
|
21
|
-
module V1beta1
|
22
|
-
class Credentials < Google::Auth::Credentials
|
23
|
-
SCOPE = [
|
24
|
-
"https://www.googleapis.com/auth/cloud-platform"
|
25
|
-
].freeze
|
26
|
-
PATH_ENV_VARS = %w(RECAPTCHA_ENTERPRISE_CREDENTIALS
|
27
|
-
RECAPTCHA_ENTERPRISE_KEYFILE
|
28
|
-
GOOGLE_CLOUD_CREDENTIALS
|
29
|
-
GOOGLE_CLOUD_KEYFILE
|
30
|
-
GCLOUD_KEYFILE)
|
31
|
-
JSON_ENV_VARS = %w(RECAPTCHA_ENTERPRISE_CREDENTIALS_JSON
|
32
|
-
RECAPTCHA_ENTERPRISE_KEYFILE_JSON
|
33
|
-
GOOGLE_CLOUD_CREDENTIALS_JSON
|
34
|
-
GOOGLE_CLOUD_KEYFILE_JSON
|
35
|
-
GCLOUD_KEYFILE_JSON)
|
36
|
-
DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
|
37
|
-
end
|
38
|
-
end
|
39
|
-
end
|
40
|
-
end
|
41
|
-
end
|
@@ -1,321 +0,0 @@
|
|
1
|
-
# Copyright 2020 Google LLC
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
|
16
|
-
module Google
|
17
|
-
module Cloud
|
18
|
-
module RecaptchaEnterprise
|
19
|
-
module V1beta1
|
20
|
-
# The create assessment request message.
|
21
|
-
# @!attribute [rw] parent
|
22
|
-
# @return [String]
|
23
|
-
# Required. The name of the project in which the assessment will be created,
|
24
|
-
# in the format "projects/\\{project_number}".
|
25
|
-
# @!attribute [rw] assessment
|
26
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment]
|
27
|
-
# Required. The assessment details.
|
28
|
-
class CreateAssessmentRequest; end
|
29
|
-
|
30
|
-
# The request message to annotate an Assessment.
|
31
|
-
# @!attribute [rw] name
|
32
|
-
# @return [String]
|
33
|
-
# Required. The resource name of the Assessment, in the format
|
34
|
-
# "projects/\\{project_number}/assessments/\\{assessment_id}".
|
35
|
-
# @!attribute [rw] annotation
|
36
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
|
37
|
-
# Required. The annotation that will be assigned to the Event.
|
38
|
-
class AnnotateAssessmentRequest
|
39
|
-
# Enum that reprensents the types of annotations.
|
40
|
-
module Annotation
|
41
|
-
# Default unspecified type.
|
42
|
-
ANNOTATION_UNSPECIFIED = 0
|
43
|
-
|
44
|
-
# Provides information that the event turned out to be legitimate.
|
45
|
-
LEGITIMATE = 1
|
46
|
-
|
47
|
-
# Provides information that the event turned out to be fraudulent.
|
48
|
-
FRAUDULENT = 2
|
49
|
-
end
|
50
|
-
end
|
51
|
-
|
52
|
-
# Empty response for AnnotateAssessment.
|
53
|
-
class AnnotateAssessmentResponse; end
|
54
|
-
|
55
|
-
# A recaptcha assessment resource.
|
56
|
-
# @!attribute [rw] name
|
57
|
-
# @return [String]
|
58
|
-
# Output only. The resource name for the Assessment in the format
|
59
|
-
# "projects/\\{project_number}/assessments/\\{assessment_id}".
|
60
|
-
# @!attribute [rw] event
|
61
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::Event]
|
62
|
-
# The event being assessed.
|
63
|
-
# @!attribute [rw] score
|
64
|
-
# @return [Float]
|
65
|
-
# Output only. Legitimate event score from 0.0 to 1.0.
|
66
|
-
# (1.0 means very likely legitimate traffic while 0.0 means very likely
|
67
|
-
# non-legitimate traffic).
|
68
|
-
# @!attribute [rw] token_properties
|
69
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::TokenProperties]
|
70
|
-
# Output only. Properties of the provided event token.
|
71
|
-
# @!attribute [rw] reasons
|
72
|
-
# @return [Array<Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment::ClassificationReason>]
|
73
|
-
# Output only. Reasons contributing to the risk analysis verdict.
|
74
|
-
class Assessment
|
75
|
-
# LINT.IfChange(classification_reason)
|
76
|
-
# Reasons contributing to the risk analysis verdict.
|
77
|
-
module ClassificationReason
|
78
|
-
# Default unspecified type.
|
79
|
-
CLASSIFICATION_REASON_UNSPECIFIED = 0
|
80
|
-
|
81
|
-
# Interactions matched the behavior of an automated agent.
|
82
|
-
AUTOMATION = 1
|
83
|
-
|
84
|
-
# The event originated from an illegitimate environment.
|
85
|
-
UNEXPECTED_ENVIRONMENT = 2
|
86
|
-
|
87
|
-
# Traffic volume from the event source is higher than normal.
|
88
|
-
TOO_MUCH_TRAFFIC = 3
|
89
|
-
|
90
|
-
# Interactions with the site were significantly different than expected
|
91
|
-
# patterns.
|
92
|
-
UNEXPECTED_USAGE_PATTERNS = 4
|
93
|
-
|
94
|
-
# Too little traffic has been received from this site thus far to generate
|
95
|
-
# quality risk analysis.
|
96
|
-
LOW_CONFIDENCE_SCORE = 5
|
97
|
-
end
|
98
|
-
end
|
99
|
-
|
100
|
-
# @!attribute [rw] token
|
101
|
-
# @return [String]
|
102
|
-
# Optional. The user response token provided by the reCAPTCHA client-side integration
|
103
|
-
# on your site.
|
104
|
-
# @!attribute [rw] site_key
|
105
|
-
# @return [String]
|
106
|
-
# Optional. The site key that was used to invoke reCAPTCHA on your site and generate
|
107
|
-
# the token.
|
108
|
-
# @!attribute [rw] user_agent
|
109
|
-
# @return [String]
|
110
|
-
# Optional. The user agent present in the request from the user's device related to
|
111
|
-
# this event.
|
112
|
-
# @!attribute [rw] user_ip_address
|
113
|
-
# @return [String]
|
114
|
-
# Optional. The IP address in the request from the user's device related to this event.
|
115
|
-
# @!attribute [rw] expected_action
|
116
|
-
# @return [String]
|
117
|
-
# Optional. The expected action for this type of event. This should be the same action
|
118
|
-
# provided at token generation time on client-side platforms already
|
119
|
-
# integrated with recaptcha enterprise.
|
120
|
-
class Event; end
|
121
|
-
|
122
|
-
# @!attribute [rw] valid
|
123
|
-
# @return [true, false]
|
124
|
-
# Whether the provided user response token is valid.
|
125
|
-
# @!attribute [rw] invalid_reason
|
126
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::TokenProperties::InvalidReason]
|
127
|
-
# Reason associated with the response when valid = false.
|
128
|
-
# @!attribute [rw] create_time
|
129
|
-
# @return [Google::Protobuf::Timestamp]
|
130
|
-
# The timestamp corresponding to the generation of the token.
|
131
|
-
# @!attribute [rw] hostname
|
132
|
-
# @return [String]
|
133
|
-
# The hostname of the page on which the token was generated.
|
134
|
-
# @!attribute [rw] action
|
135
|
-
# @return [String]
|
136
|
-
# Action name provided at token generation.
|
137
|
-
class TokenProperties
|
138
|
-
# LINT.IfChange
|
139
|
-
# Enum that represents the types of invalid token reasons.
|
140
|
-
module InvalidReason
|
141
|
-
# Default unspecified type.
|
142
|
-
INVALID_REASON_UNSPECIFIED = 0
|
143
|
-
|
144
|
-
# If the failure reason was not accounted for.
|
145
|
-
UNKNOWN_INVALID_REASON = 1
|
146
|
-
|
147
|
-
# The provided user verification token was malformed.
|
148
|
-
MALFORMED = 2
|
149
|
-
|
150
|
-
# The user verification token had expired.
|
151
|
-
EXPIRED = 3
|
152
|
-
|
153
|
-
# The user verification had already been seen.
|
154
|
-
DUPE = 4
|
155
|
-
|
156
|
-
# The user verification token did not match the provided site key.
|
157
|
-
# This may be a configuration error (e.g. development keys used in
|
158
|
-
# production) or end users trying to use verification tokens from other
|
159
|
-
# sites.
|
160
|
-
SITE_MISMATCH = 5
|
161
|
-
|
162
|
-
# The user verification token was not present. It is a required input.
|
163
|
-
MISSING = 6
|
164
|
-
end
|
165
|
-
end
|
166
|
-
|
167
|
-
# The create key request message.
|
168
|
-
# @!attribute [rw] parent
|
169
|
-
# @return [String]
|
170
|
-
# Required. The name of the project in which the key will be created, in the
|
171
|
-
# format "projects/\\{project_number}".
|
172
|
-
# @!attribute [rw] key
|
173
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::Key]
|
174
|
-
# Required. Information to create a reCAPTCHA Enterprise key.
|
175
|
-
class CreateKeyRequest; end
|
176
|
-
|
177
|
-
# The list keys request message.
|
178
|
-
# @!attribute [rw] parent
|
179
|
-
# @return [String]
|
180
|
-
# Required. The name of the project that contains the keys that will be
|
181
|
-
# listed, in the format "projects/\\{project_number}".
|
182
|
-
# @!attribute [rw] page_size
|
183
|
-
# @return [Integer]
|
184
|
-
# Optional. The maximum number of keys to return. Default is 10. Max limit is
|
185
|
-
# 1000.
|
186
|
-
# @!attribute [rw] page_token
|
187
|
-
# @return [String]
|
188
|
-
# Optional. The next_page_token value returned from a previous.
|
189
|
-
# ListKeysRequest, if any.
|
190
|
-
class ListKeysRequest; end
|
191
|
-
|
192
|
-
# Response to request to list keys in a project.
|
193
|
-
# @!attribute [rw] keys
|
194
|
-
# @return [Array<Google::Cloud::RecaptchaEnterprise::V1beta1::Key>]
|
195
|
-
# Key details.
|
196
|
-
# @!attribute [rw] next_page_token
|
197
|
-
# @return [String]
|
198
|
-
# Token to retrieve the next page of results. It is set to empty if no keys
|
199
|
-
# remain in results.
|
200
|
-
class ListKeysResponse; end
|
201
|
-
|
202
|
-
# The get key request message.
|
203
|
-
# @!attribute [rw] name
|
204
|
-
# @return [String]
|
205
|
-
# Required. The name of the requested key, in the format
|
206
|
-
# "projects/\\{project_number}/keys/\\{key_id}".
|
207
|
-
class GetKeyRequest; end
|
208
|
-
|
209
|
-
# The update key request message.
|
210
|
-
# @!attribute [rw] key
|
211
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::Key]
|
212
|
-
# Required. The key to update.
|
213
|
-
# @!attribute [rw] update_mask
|
214
|
-
# @return [Google::Protobuf::FieldMask]
|
215
|
-
# Optional. The mask to control which field of the key get updated. If the mask is not
|
216
|
-
# present, all fields will be updated.
|
217
|
-
class UpdateKeyRequest; end
|
218
|
-
|
219
|
-
# The delete key request message.
|
220
|
-
# @!attribute [rw] name
|
221
|
-
# @return [String]
|
222
|
-
# Required. The name of the key to be deleted, in the format
|
223
|
-
# "projects/\\{project_number}/keys/\\{key_id}".
|
224
|
-
class DeleteKeyRequest; end
|
225
|
-
|
226
|
-
# A key used to identify and configure applications (web and/or mobile) that
|
227
|
-
# use reCAPTCHA Enterprise.
|
228
|
-
# @!attribute [rw] name
|
229
|
-
# @return [String]
|
230
|
-
# The resource name for the Key in the format
|
231
|
-
# "projects/\\{project_number}/keys/\\{key_id}".
|
232
|
-
# @!attribute [rw] display_name
|
233
|
-
# @return [String]
|
234
|
-
# Human-readable display name of this key. Modifiable by user.
|
235
|
-
# @!attribute [rw] web_settings
|
236
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings]
|
237
|
-
# Settings for keys that can be used by websites.
|
238
|
-
# @!attribute [rw] android_settings
|
239
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::AndroidKeySettings]
|
240
|
-
# Settings for keys that can be used by Android apps.
|
241
|
-
# @!attribute [rw] ios_settings
|
242
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::IOSKeySettings]
|
243
|
-
# Settings for keys that can be used by iOS apps.
|
244
|
-
class Key; end
|
245
|
-
|
246
|
-
# Settings specific to keys that can be used by websites.
|
247
|
-
# @!attribute [rw] enforce_allowed_domains
|
248
|
-
# @return [true, false]
|
249
|
-
# Whether allowed_domains is enforced or not.
|
250
|
-
# @!attribute [rw] allowed_domains
|
251
|
-
# @return [Array<String>]
|
252
|
-
# Domains or subdomains of websites allowed to use the key. All subdomains
|
253
|
-
# of an allowed domain are automatically allowed. A valid domain requires a
|
254
|
-
# host and must not include any path, port, query or fragment.
|
255
|
-
# Examples: 'example.com' or 'subdomain.example.com'
|
256
|
-
# @!attribute [rw] allow_amp_traffic
|
257
|
-
# @return [true, false]
|
258
|
-
# Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
|
259
|
-
# @!attribute [rw] integration_type
|
260
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::IntegrationType]
|
261
|
-
# Required. Describes how this key is integrated with the website.
|
262
|
-
# @!attribute [rw] challenge_security_preference
|
263
|
-
# @return [Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::ChallengeSecurityPreference]
|
264
|
-
# Settings for the frequency and difficulty at which this key triggers
|
265
|
-
# captcha challenges. This should only be specified for IntegrationTypes
|
266
|
-
# CHECKBOX_CHALLENGE and INVISIBLE_CHALLENGE.
|
267
|
-
class WebKeySettings
|
268
|
-
# Enum that represents the possible challenge frequency and difficulty
|
269
|
-
# configurations for a web key.
|
270
|
-
module ChallengeSecurityPreference
|
271
|
-
# Default type that indicates this enum hasn't been specified.
|
272
|
-
CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0
|
273
|
-
|
274
|
-
# Key tends to show fewer and easier challenges.
|
275
|
-
USABILITY = 1
|
276
|
-
|
277
|
-
# Key tends to show balanced (in amount and difficulty) challenges.
|
278
|
-
BALANCED = 2
|
279
|
-
|
280
|
-
# Key tends to show more and harder challenges.
|
281
|
-
SECURITY = 3
|
282
|
-
end
|
283
|
-
|
284
|
-
# Enum that represents the integration types for web keys.
|
285
|
-
module IntegrationType
|
286
|
-
# Default type that indicates this enum hasn't been specified. This is not
|
287
|
-
# a valid IntegrationType, one of the other types must be specified
|
288
|
-
# instead.
|
289
|
-
INTEGRATION_TYPE_UNSPECIFIED = 0
|
290
|
-
|
291
|
-
# Only used to produce scores. It doesn't display the "I'm not a robot"
|
292
|
-
# checkbox and never shows captcha challenges.
|
293
|
-
SCORE_ONLY = 1
|
294
|
-
|
295
|
-
# Displays the "I'm not a robot" checkbox and may show captcha challenges
|
296
|
-
# after it is checked.
|
297
|
-
CHECKBOX_CHALLENGE = 2
|
298
|
-
|
299
|
-
# Doesn't display the "I'm not a robot" checkbox, but may show captcha
|
300
|
-
# challenges after risk analysis.
|
301
|
-
INVISIBLE_CHALLENGE = 3
|
302
|
-
end
|
303
|
-
end
|
304
|
-
|
305
|
-
# Settings specific to keys that can be used by Android apps.
|
306
|
-
# @!attribute [rw] allowed_package_names
|
307
|
-
# @return [Array<String>]
|
308
|
-
# Android package names of apps allowed to use the key.
|
309
|
-
# Example: 'com.companyname.appname'
|
310
|
-
class AndroidKeySettings; end
|
311
|
-
|
312
|
-
# Settings specific to keys that can be used by iOS apps.
|
313
|
-
# @!attribute [rw] allowed_bundle_ids
|
314
|
-
# @return [Array<String>]
|
315
|
-
# iOS bundle ids of apps allowed to use the key.
|
316
|
-
# Example: 'com.companyname.productname.appname'
|
317
|
-
class IOSKeySettings; end
|
318
|
-
end
|
319
|
-
end
|
320
|
-
end
|
321
|
-
end
|