google-cloud-web_risk 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 5b13dbff300b2b09a2c7c8bb93fc3d25bdb3a640a6d1acad7d06bef136c89a20
4
+ data.tar.gz: f2b24e9bc5f2f24ff9458424fcc22e123c4cfe56342b78e125182f191a730348
5
+ SHA512:
6
+ metadata.gz: 36c38298db623f5249da9adacdb7911e66ef9971c48fa9870b3638df7fe18f186215ef5b9320e242fe7ce3d50a27d9ca450671b2f34aba9817b7106e45300dae
7
+ data.tar.gz: 51fc5a4a5ce2419b3f4bf2ed7f4b00b2d5e5d44b3729231307eeb809f0a73bb537e032367a8b422a11be22e2ab99c18c614dfdaf40fda76a7debe7272f907c30
@@ -0,0 +1,12 @@
1
+ --no-private
2
+ --title=Web Risk API
3
+ --exclude _pb\.rb$
4
+ --markup markdown
5
+ --markup-provider redcarpet
6
+
7
+ ./lib/**/*.rb
8
+ -
9
+ README.md
10
+ AUTHENTICATION.md
11
+ MIGRATING.md
12
+ LICENSE.md
@@ -0,0 +1,169 @@
1
+ # Authentication
2
+
3
+ In general, the google-cloud-web_risk library uses
4
+ [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
+ credentials to connect to Google Cloud services. When running within
6
+ [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
+ credentials will be discovered automatically. When running on other
8
+ environments, the Service Account credentials can be specified by providing the
9
+ path to the
10
+ [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
+ for the account (or the JSON itself) in
12
+ [environment variables](#environment-variables). Additionally, Cloud SDK
13
+ credentials can also be discovered automatically, but this is only recommended
14
+ during development.
15
+
16
+ ## Quickstart
17
+
18
+ 1. [Create a service account and credentials](#creating-a-service-account).
19
+ 2. Set the [environment variable](#environment-variables).
20
+
21
+ ```sh
22
+ export WEBRISK_CREDENTIALS=path/to/keyfile.json
23
+ ```
24
+
25
+ 3. Initialize the client.
26
+
27
+ ```ruby
28
+ require "google/cloud/web_risk"
29
+
30
+ client = Google::Cloud::WebRisk.web_risk_service
31
+ ```
32
+
33
+ ## Credential Lookup
34
+
35
+ The google-cloud-web_risk library aims to make authentication
36
+ as simple as possible, and provides several mechanisms to configure your system
37
+ without requiring **Service Account Credentials** directly in code.
38
+
39
+ **Credentials** are discovered in the following order:
40
+
41
+ 1. Specify credentials in method arguments
42
+ 2. Specify credentials in configuration
43
+ 3. Discover credentials path in environment variables
44
+ 4. Discover credentials JSON in environment variables
45
+ 5. Discover credentials file in the Cloud SDK's path
46
+ 6. Discover GCP credentials
47
+
48
+ ### Google Cloud Platform environments
49
+
50
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
51
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
+ Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
+ Code should be written as if already authenticated.
54
+
55
+ ### Environment Variables
56
+
57
+ The **Credentials JSON** can be placed in environment variables instead of
58
+ declaring them directly in code. Each service has its own environment variable,
59
+ allowing for different service accounts to be used for different services. (See
60
+ the READMEs for the individual service gems for details.) The path to the
61
+ **Credentials JSON** file can be stored in the environment variable, or the
62
+ **Credentials JSON** itself can be stored for environments such as Docker
63
+ containers where writing files is difficult or not encouraged.
64
+
65
+ The environment variables that google-cloud-web_risk
66
+ checks for credentials are configured on the service Credentials class (such as
67
+ `::Google::Cloud::WebRisk::V1::WebRiskService::Credentials`):
68
+
69
+ 1. `WEBRISK_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ 2. `WEBRISK_KEYFILE` - Path to JSON file, or JSON contents
71
+ 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
+ 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
+ 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
74
+
75
+ ```ruby
76
+ require "google/cloud/web_risk"
77
+
78
+ ENV["WEBRISK_CREDENTIALS"] = "path/to/keyfile.json"
79
+
80
+ client = Google::Cloud::WebRisk.web_risk_service
81
+ ```
82
+
83
+ ### Configuration
84
+
85
+ The **Credentials JSON** can be configured instead of placing them in
86
+ environment variables. Either on an individual client initialization:
87
+
88
+ ```ruby
89
+ require "google/cloud/web_risk"
90
+
91
+ client = Google::Cloud::WebRisk.web_risk_service do |config|
92
+ config.credentials = "path/to/keyfile.json"
93
+ end
94
+ ```
95
+
96
+ Or configured globally for all clients:
97
+
98
+ ```ruby
99
+ require "google/cloud/web_risk"
100
+
101
+ Google::Cloud::WebRisk.configure do |config|
102
+ config.credentials = "path/to/keyfile.json"
103
+ end
104
+
105
+ client = Google::Cloud::WebRisk.web_risk_service
106
+ ```
107
+
108
+ ### Cloud SDK
109
+
110
+ This option allows for an easy way to authenticate during development. If
111
+ credentials are not provided in code or in environment variables, then Cloud SDK
112
+ credentials are discovered.
113
+
114
+ To configure your system for this, simply:
115
+
116
+ 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
118
+ 3. Write code as if already authenticated.
119
+
120
+ **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
+ *should* only be used during development.
122
+
123
+ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
124
+ [dev-console]: https://console.cloud.google.com/project
125
+
126
+ [enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
127
+
128
+ [create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
129
+ [create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
130
+ [reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
131
+
132
+ ## Creating a Service Account
133
+
134
+ Google Cloud requires **Service Account Credentials** to
135
+ connect to the APIs. You will use the **JSON key file** to
136
+ connect to most services with google-cloud-web_risk.
137
+
138
+ If you are not running this client within
139
+ [Google Cloud Platform environments](#google-cloud-platform-environments), you
140
+ need a Google Developers service account.
141
+
142
+ 1. Visit the [Google Developers Console][dev-console].
143
+ 2. Create a new project or click on an existing project.
144
+ 3. Activate the slide-out navigation tray and select **API Manager**. From
145
+ here, you will enable the APIs that your application requires.
146
+
147
+ ![Enable the APIs that your application requires][enable-apis]
148
+
149
+ *Note: You may need to enable billing in order to use these services.*
150
+
151
+ 4. Select **Credentials** from the side navigation.
152
+
153
+ You should see a screen like one of the following.
154
+
155
+ ![Create a new service account][create-new-service-account]
156
+
157
+ ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
158
+
159
+ Find the "Add credentials" drop down and select "Service account" to be
160
+ guided through downloading a new JSON key file.
161
+
162
+ If you want to re-use an existing service account, you can easily generate a
163
+ new key file. Just select the account you wish to re-use, and click "Generate
164
+ new JSON key":
165
+
166
+ ![Re-use an existing service account][reuse-service-account]
167
+
168
+ The key file you download will be used by this library to authenticate API
169
+ requests and should be stored in a secure location.
@@ -0,0 +1,203 @@
1
+ Apache License
2
+ ==============
3
+
4
+ * Version 2.0, January 2004
5
+ * https://www.apache.org/licenses/
6
+
7
+ ### TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. **Definitions.**
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. **Grant of Copyright License.** Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. **Grant of Patent License.** Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. **Redistribution.** You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ * **(a)** You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ * **(b)** You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ * **(c)** You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ * **(d)** If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. **Submission of Contributions.** Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. **Trademarks.** This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. **Disclaimer of Warranty.** Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. **Limitation of Liability.** In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. **Accepting Warranty or Additional Liability.** While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ _END OF TERMS AND CONDITIONS_
179
+
180
+ ### APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "`[]`"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright [yyyy] [name of copyright owner]
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ https://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,229 @@
1
+ ## Migrating to google-cloud-web_risk 1.0
2
+
3
+ The `google-cloud-web_risk` gem is a significant upgrade over the older and now
4
+ deprecated `google-cloud-webrisk` gem. It is based on a
5
+ [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
6
+ and includes substantial interface changes. Existing code written for the older
7
+ gem will likely require updates to use this version. This document describes
8
+ the changes that have been made, and what you need to do to update your usage.
9
+
10
+ To summarize:
11
+
12
+ * The new gem supports versions V1 and V1beta1 of the Web Risk service. The
13
+ older gem supported only V1beta1.
14
+ * The client has been broken out into multiple libraries. The new gems
15
+ `google-cloud-web_risk-v1` and `google-cloud-web_risk-v1beta1` contain the
16
+ actual client classes for versions V1 and V1beta1 of the Web Risk service,
17
+ and the gem `google-cloud-web_risk` provides a convenience wrapper.
18
+ See [Library Structure](#library-structure) for more info.
19
+ * Some classes have moved into different namespaces. In particular, the
20
+ `Google::Cloud::Webrisk` module has been renamed to `Google::Cloud::WebRisk`.
21
+ See [Class Namespaces](#class-namespaces) for more info.
22
+ * The library uses a new configuration mechanism giving you closer control
23
+ over endpoint address, network timeouts, and retry. See
24
+ [Client Configuration](#client-configuration) for more info. Furthermore,
25
+ when creating a client object, you can customize its configuration in a
26
+ block rather than passing arguments to the constructor. See
27
+ [Creating Clients](#creating-clients) for more info.
28
+ * Previously, positional arguments were used to indicate required arguments.
29
+ Now, all method arguments are keyword arguments, with documentation that
30
+ specifies whether they are required or optional. Additionally, you can pass
31
+ a proto request object instead of separate arguments. See
32
+ [Passing Arguments](#passing-arguments) for more info.
33
+
34
+ ### Library Structure
35
+
36
+ The older `google-cloud-webrisk` gem was an all-in-one gem
37
+ that included potentially multiple clients for multiple versions of the
38
+ Web Risk service. The `Google::Cloud::Webrisk.new` factory method would
39
+ return you an instance of a `Google::Cloud::Webrisk::V1beta1::WebRiskServiceV1Beta1Client`
40
+ object for the V1beta1 version of the service. (Version V1 of the service was
41
+ not supported by the older gem.)
42
+
43
+ The new `google-cloud-web_risk` gem still provides factory
44
+ methods for obtaining clients. (The method signatures will have changed. See
45
+ [Creating Clients](#creating-clients) for details.) However, the actual client
46
+ classes have been moved into separate gems, one per service version. The
47
+ `Google::Cloud::WebRisk::V1::WebRiskService::Client` class, along with its
48
+ helpers and data types, is now part of the `google-cloud-web_risk-v1` gem.
49
+ Similarly, the `Google::Cloud::WebRisk::V1beta1::WebRiskService::Client`
50
+ class is part of the `google-cloud-web_risk-v1beta1` gem.
51
+
52
+ For normal usage, you can install the `google-cloud-web_risk` gem
53
+ (which will bring in the versioned client gems as dependencies) and continue to
54
+ use factory methods to create clients. However, you may alternatively choose to
55
+ install only one of the versioned gems. For example, if you know you will only
56
+ use `V1` of the service, you can install `google-cloud-web_risk-v1` by
57
+ itself, and construct instances of the
58
+ `Google::Cloud::WebRisk::V1::WebRiskService::Client` client class directly.
59
+
60
+ ### Class Namespaces
61
+
62
+ As part of the gem being renamed from `google-cloud-webrisk` to
63
+ `google-cloud-web_risk`, the main namespace module has also been renamed
64
+ accordingly, from `Google::Cloud::Webrisk` to `Google::Cloud::WebRisk`. (Note
65
+ the "R" in "WebRisk" is now capitalized.) This affects the entire library,
66
+ including clients, data types, and all other modules and classes.
67
+
68
+ Additionally, some of the underlying classes have also been renamed.
69
+ In the older gem, the client object was of classes with names like:
70
+ `Google::Cloud::Webrisk::V1beta1::WebRiskServiceV1Beta1Client`.
71
+ In the new gem, the corresponding client object is of a different class:
72
+ `Google::Cloud::WebRisk::V1beta1::WebRiskService::Client`.
73
+ Note that most users will use the factory methods such as
74
+ `Google::Cloud::WebRisk.web_risk_service` to create instances of the client object,
75
+ so you may not need to reference the actual class directly.
76
+ See [Creating Clients](#creating-clients).
77
+
78
+ In older releases, the credentials object was of class
79
+ `Google::Cloud::Webrisk::V1beta1::Credentials`.
80
+ In the 1.0 release, each service has its own credentials class, e.g.
81
+ `Google::Cloud::WebRisk::V1beta1::WebRiskService::Credentials`.
82
+ Again, most users will not need to reference this class directly.
83
+ See [Client Configuration](#client-configuration).
84
+
85
+ ### Client Configuration
86
+
87
+ In the older gem, if you wanted to customize performance parameters or
88
+ low-level behavior of the client (such as credentials, timeouts, or
89
+ instrumentation), you would pass a variety of keyword arguments to the client
90
+ constructor. It was also extremely difficult to customize the default settings.
91
+
92
+ In the new gem, a configuration interface provides control over these
93
+ parameters, including defaults for all instances of a client, and settings for
94
+ each specific client instance. For example, to set default credentials and
95
+ timeout for all Web Risk V1 clients:
96
+
97
+ ```
98
+ Google::Cloud::WebRisk::V1::WebRiskService::Client.configure do |config|
99
+ config.credentials = "/path/to/credentials.json"
100
+ config.timeout = 10.0
101
+ end
102
+ ```
103
+
104
+ Individual RPCs can also be configured independently. For example, to set the
105
+ timeout for the `search_uris` call:
106
+
107
+ ```
108
+ Google::Cloud::WebRisk::V1::WebRiskService::Client.configure do |config|
109
+ config.rpcs.search_uris.timeout = 20.0
110
+ end
111
+ ```
112
+
113
+ Defaults for certain configurations can be set for all Web Risk versions and
114
+ services globally:
115
+
116
+ ```
117
+ Google::Cloud::WebRisk.configure do |config|
118
+ config.credentials = "/path/to/credentials.json"
119
+ config.timeout = 10.0
120
+ end
121
+ ```
122
+
123
+ Finally, you can override the configuration for each client instance. See the
124
+ next section on [Creating Clients](#creating-clients) for details.
125
+
126
+ ### Creating Clients
127
+
128
+ In the older gem, to create a client object, you would use the
129
+ `Google::Cloud::Webrisk.new` class method. Keyword arguments were available to
130
+ select a service version and to configure parameters such as credentials and
131
+ timeouts.
132
+
133
+ In the new gem, use the `Google::Cloud::WebRisk.web_risk_service` class
134
+ method to create a client object. You may select a service version using the
135
+ `:version` keyword argument. However, other configuration parameters should be
136
+ set in a configuration block when you create the client.
137
+
138
+ Old:
139
+ ```
140
+ client = Google::Cloud::Webrisk.new credentials: "/path/to/credentials.json"
141
+ ```
142
+
143
+ New:
144
+ ```
145
+ client = Google::Cloud::WebRisk.web_risk_service do |config|
146
+ config.credentials = "/path/to/credentials.json"
147
+ end
148
+ ```
149
+
150
+ The configuration block is optional. If you do not provide it, or you do not
151
+ set some configuration parameters, then the default configuration is used. See
152
+ [Client Configuration](#client-configuration).
153
+
154
+ ### Passing Arguments
155
+
156
+ In the older gem, required arguments would be passed as positional method
157
+ arguments, while most optional arguments would be passed as keyword arguments.
158
+
159
+ In the new gem, all RPC arguments are passed as keyword arguments,
160
+ regardless of whether they are required or optional. For example:
161
+
162
+ Old:
163
+ ```
164
+ client = Google::Cloud::Webrisk.new
165
+
166
+ uri = "http://example.com"
167
+ threat_types = [Google::Cloud::Webrisk::V1beta1::ThreatType::MALWARE]
168
+
169
+ # Both uri and threat_types are positional arguments.
170
+ response = client.search_uris uri, threat_types
171
+ ```
172
+
173
+ New:
174
+ ```
175
+ client = Google::Cloud::WebRisk.web_risk_service
176
+
177
+ uri = "http://example.com"
178
+ threat_types = [Google::Cloud::WebRisk::V1::ThreatType::MALWARE]
179
+
180
+ # Both uri and threat_types are keyword arguments.
181
+ response = client.search_uris uri: uri, threat_types: threat_types
182
+ ```
183
+
184
+ In the new gem, it is also possible to pass a request object, either
185
+ as a hash or as a protocol buffer.
186
+
187
+ New:
188
+ ```
189
+ client = Google::Cloud::WebRisk.web_risk_service
190
+
191
+ request = Google::Cloud::WebRisk::V1::SearchUrisRequest.new(
192
+ uri: "http://example.com",
193
+ threat_types: [Google::Cloud::WebRisk::V1::ThreatType::MALWARE]
194
+ )
195
+
196
+ # Pass a request object as a positional argument:
197
+ response = client.search_uris request
198
+ ```
199
+
200
+ Finally, in older releases, to provide call options, you would pass a
201
+ `Google::Gax::CallOptions` object with the `:options` keyword argument. In the
202
+ 1.0 release, pass call options using a _second set_ of keyword arguments.
203
+
204
+ Old:
205
+ ```
206
+ client = Google::Cloud::Webrisk.new
207
+
208
+ uri = "http://example.com"
209
+ threat_types = [Google::Cloud::Webrisk::V1beta1::ThreatType::MALWARE]
210
+
211
+ options = Google::Gax::CallOptions.new timeout: 10.0
212
+
213
+ response = client.search_uris uri, threat_types, options: options
214
+ ```
215
+
216
+ New:
217
+ ```
218
+ client = Google::Cloud::WebRisk.web_risk_service
219
+
220
+ uri = "http://example.com"
221
+ threat_types = [Google::Cloud::WebRisk::V1::ThreatType::MALWARE]
222
+
223
+ # Use a hash to wrap the normal call arguments (or pass a request object), and
224
+ # then add further keyword arguments for the call options.
225
+ response = client.search_uris(
226
+ { uri: uri, threat_types: threat_types },
227
+ timeout: 10.0
228
+ )
229
+ ```
@@ -0,0 +1,80 @@
1
+ # Ruby Client for the Web Risk API
2
+
3
+ API Client library for the Web Risk API
4
+
5
+ Web Risk is an enterprise security product that lets your client applications check URLs against Google's constantly updated lists of unsafe web resources.
6
+
7
+ Actual client classes for the various versions of this API are defined in
8
+ _versioned_ client gems, with names of the form `google-cloud-web_risk-v*`.
9
+ The gem `google-cloud-web_risk` is a convenience wrapper library that brings the
10
+ verisoned gems in as dependencies, and provides high-level methods for
11
+ constructing clients.
12
+
13
+ View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-web_risk/latest)
14
+ for this library, google-cloud-web_risk, to see the convenience methods for
15
+ constructing client objects. Reference documentation for the client objects
16
+ themselves can be found in the client library documentation for the versioned
17
+ client gems:
18
+ [google-cloud-web_risk-v1](https://googleapis.dev/ruby/google-cloud-web_risk-v1/latest),
19
+ [google-cloud-web_risk-v1beta1](https://googleapis.dev/ruby/google-cloud-web_risk-v1beta1/latest).
20
+
21
+ See also the [Product Documentation](https://cloud.google.com/web-risk)
22
+ for more usage information.
23
+
24
+ ## Quick Start
25
+
26
+ ```
27
+ $ gem install google-cloud-web_risk
28
+ ```
29
+
30
+ In order to use this library, you first need to go through the following steps:
31
+
32
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
33
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
34
+ 1. [Enable the API.](https://console.cloud.google.com/apis/library/webrisk.googleapis.com)
35
+ 1. {file:AUTHENTICATION.md Set up authentication.}
36
+
37
+ ## Migrating from 0.x versions
38
+
39
+ The 1.0 release of the google-cloud-web_risk client is a significant upgrade
40
+ based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
41
+ and includes substantial interface changes. Existing code written for earlier
42
+ versions of this library will likely require updates to use this version.
43
+ See the {file:MIGRATING.md MIGRATING.md} document for more information.
44
+
45
+ ## Enabling Logging
46
+
47
+ To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
48
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
49
+ or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
50
+ that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
51
+ and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
52
+
53
+ Configuring a Ruby stdlib logger:
54
+
55
+ ```ruby
56
+ require "logger"
57
+
58
+ module MyLogger
59
+ LOGGER = Logger.new $stderr, level: Logger::WARN
60
+ def logger
61
+ LOGGER
62
+ end
63
+ end
64
+
65
+ # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
66
+ module GRPC
67
+ extend MyLogger
68
+ end
69
+ ```
70
+
71
+ ## Supported Ruby Versions
72
+
73
+ This library is supported on Ruby 2.4+.
74
+
75
+ Google provides official support for Ruby versions that are actively supported
76
+ by Ruby Core—that is, Ruby versions that are either in normal maintenance or
77
+ in security maintenance, and not end of life. Currently, this means Ruby 2.4
78
+ and later. Older versions of Ruby _may_ still work, but are unsupported and not
79
+ recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
80
+ about the Ruby support schedule.
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/web_risk" unless defined? Google::Cloud::WebRisk::VERSION
@@ -0,0 +1,110 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # Require this file early so that the version constant gets defined before
20
+ # requiring "google/cloud". This is because google-cloud-core will load the
21
+ # entrypoint (gem name) file, which in turn re-requires this file (hence
22
+ # causing a require cycle) unless the version constant is already defined.
23
+ require "google/cloud/web_risk/version"
24
+
25
+ require "googleauth"
26
+ gem "google-cloud-core"
27
+ require "google/cloud" unless defined? ::Google::Cloud.new
28
+ require "google/cloud/config"
29
+
30
+ # Set the default configuration
31
+ ::Google::Cloud.configure.add_config! :web_risk do |config|
32
+ config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
33
+ config.add_field! :lib_name, nil, match: ::String
34
+ config.add_field! :lib_version, nil, match: ::String
35
+ config.add_field! :interceptors, nil, match: ::Array
36
+ config.add_field! :timeout, nil, match: ::Numeric
37
+ config.add_field! :metadata, nil, match: ::Hash
38
+ config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
39
+ end
40
+
41
+ module Google
42
+ module Cloud
43
+ module WebRisk
44
+ ##
45
+ # Create a new client object for WebRiskService.
46
+ #
47
+ # By default, this returns an instance of
48
+ # [Google::Cloud::WebRisk::V1::WebRiskService::Client](https://googleapis.dev/ruby/google-cloud-web_risk-v1/latest/Google/Cloud/WebRisk/V1/WebRiskService/Client.html)
49
+ # for version V1 of the API.
50
+ # However, you can specify specify a different API version by passing it in the
51
+ # `version` parameter. If the WebRiskService service is
52
+ # supported by that API version, and the corresponding gem is available, the
53
+ # appropriate versioned client will be returned.
54
+ #
55
+ # ## About WebRiskService
56
+ #
57
+ # Web Risk API defines an interface to detect malicious URLs on your
58
+ # website and in client applications.
59
+ #
60
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
61
+ # Defaults to `:v1`.
62
+ # @return [WebRiskService::Client] A client object for the specified version.
63
+ #
64
+ def self.web_risk_service version: :v1, &block
65
+ require "google/cloud/web_risk/#{version.to_s.downcase}"
66
+
67
+ package_name = Google::Cloud::WebRisk
68
+ .constants
69
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
70
+ .first
71
+ package_module = Google::Cloud::WebRisk.const_get package_name
72
+ package_module.const_get(:WebRiskService).const_get(:Client).new(&block)
73
+ end
74
+
75
+ ##
76
+ # Configure the google-cloud-web_risk library.
77
+ #
78
+ # The following configuration parameters are supported:
79
+ #
80
+ # * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
81
+ # The path to the keyfile as a String, the contents of the keyfile as a
82
+ # Hash, or a Google::Auth::Credentials object.
83
+ # * `lib_name` (*type:* `String`) -
84
+ # The library name as recorded in instrumentation and logging.
85
+ # * `lib_version` (*type:* `String`) -
86
+ # The library version as recorded in instrumentation and logging.
87
+ # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
88
+ # An array of interceptors that are run before calls are executed.
89
+ # * `timeout` (*type:* `Integer`) -
90
+ # Default timeout in milliseconds.
91
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) -
92
+ # Additional gRPC headers to be sent with the call.
93
+ # * `retry_policy` (*type:* `Hash`) -
94
+ # The retry policy. The value is a hash with the following keys:
95
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
96
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
97
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
98
+ # * `:retry_codes` (*type:* `Array<String>`) -
99
+ # The error codes that should trigger a retry.
100
+ #
101
+ # @return [::Google::Cloud::Config] The default configuration used by this library
102
+ #
103
+ def self.configure
104
+ yield ::Google::Cloud.configure.web_risk if block_given?
105
+
106
+ ::Google::Cloud.configure.web_risk
107
+ end
108
+ end
109
+ end
110
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module WebRisk
23
+ VERSION = "1.0.0"
24
+ end
25
+ end
26
+ end
metadata ADDED
@@ -0,0 +1,233 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-cloud-web_risk
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2020-05-07 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: google-cloud-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.5'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.5'
27
+ - !ruby/object:Gem::Dependency
28
+ name: google-cloud-web_risk-v1
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: google-cloud-web_risk-v1beta1
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '0.0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '0.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: autotest-suffix
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.1'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.1'
69
+ - !ruby/object:Gem::Dependency
70
+ name: google-style
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 1.24.0
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 1.24.0
83
+ - !ruby/object:Gem::Dependency
84
+ name: minitest
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '5.14'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '5.14'
97
+ - !ruby/object:Gem::Dependency
98
+ name: minitest-autotest
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '1.0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '1.0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: minitest-focus
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '1.1'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '1.1'
125
+ - !ruby/object:Gem::Dependency
126
+ name: minitest-rg
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '5.2'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '5.2'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rake
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '12.0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '12.0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: redcarpet
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: '3.0'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: '3.0'
167
+ - !ruby/object:Gem::Dependency
168
+ name: simplecov
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: '0.9'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: '0.9'
181
+ - !ruby/object:Gem::Dependency
182
+ name: yard
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: '0.9'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: '0.9'
195
+ description: Web Risk is an enterprise security product that lets your client applications
196
+ check URLs against Google's constantly updated lists of unsafe web resources.
197
+ email: googleapis-packages@google.com
198
+ executables: []
199
+ extensions: []
200
+ extra_rdoc_files: []
201
+ files:
202
+ - ".yardopts"
203
+ - AUTHENTICATION.md
204
+ - LICENSE.md
205
+ - MIGRATING.md
206
+ - README.md
207
+ - lib/google-cloud-web_risk.rb
208
+ - lib/google/cloud/web_risk.rb
209
+ - lib/google/cloud/web_risk/version.rb
210
+ homepage: https://github.com/googleapis/google-cloud-ruby
211
+ licenses:
212
+ - Apache-2.0
213
+ metadata: {}
214
+ post_install_message:
215
+ rdoc_options: []
216
+ require_paths:
217
+ - lib
218
+ required_ruby_version: !ruby/object:Gem::Requirement
219
+ requirements:
220
+ - - ">="
221
+ - !ruby/object:Gem::Version
222
+ version: '2.4'
223
+ required_rubygems_version: !ruby/object:Gem::Requirement
224
+ requirements:
225
+ - - ">="
226
+ - !ruby/object:Gem::Version
227
+ version: '0'
228
+ requirements: []
229
+ rubygems_version: 3.0.6
230
+ signing_key:
231
+ specification_version: 4
232
+ summary: API Client library for the Web Risk API
233
+ test_files: []