google-cloud-recommender-v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: c36c8d1ea536867e2354710653eeaa0a223b1c41b8297d84fcab9f0082eb848a
4
+ data.tar.gz: 30c497a9b7d0066ce4f57226286368a5a2aecde3dcf4a4794bbdc4068644b96b
5
+ SHA512:
6
+ metadata.gz: 61685b5df88863c14478c8242aabd82659e92c905e9a56b4a0053c55ee6134f58356d4a50570e3dfd30802f3361795055e379e20d092f640e955103a7ac72073
7
+ data.tar.gz: 84f1c7bcbd9f4ba61b4d0422a82ee49dd282f8df2bd9c937a79cf1a4f6b2467cf418d36f514b7da887a3f25f2071023c12f1937969ec53758b75cd50e2beded7
data/.yardopts ADDED
@@ -0,0 +1,12 @@
1
+ --no-private
2
+ --title=Recommender V1
3
+ --exclude _pb\.rb$
4
+ --markup markdown
5
+ --markup-provider redcarpet
6
+
7
+ ./lib/**/*.rb
8
+ ./proto_docs/**/*.rb
9
+ -
10
+ README.md
11
+ LICENSE.md
12
+ AUTHENTICATION.md
data/AUTHENTICATION.md ADDED
@@ -0,0 +1,166 @@
1
+ # Authentication
2
+
3
+ In general, the google-cloud-recommender-v1 library uses [Service
4
+ Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
+ credentials to connect to Google Cloud services. When running within [Google
6
+ Cloud Platform environments](#google-cloud-platform-environments)
7
+ the 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 [JSON
10
+ keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
11
+ the account (or the JSON itself) in [environment
12
+ variables](#environment-variables). Additionally, Cloud SDK credentials can also
13
+ be discovered automatically, but this is only recommended during development.
14
+
15
+ ## Quickstart
16
+
17
+ 1. [Create a service account and credentials](#creating-a-service-account).
18
+ 2. Set the [environment variable](#environment-variables).
19
+
20
+ ```sh
21
+ export RECOMMENDER_CREDENTIALS=path/to/keyfile.json
22
+ ```
23
+
24
+ 3. Initialize the client.
25
+
26
+ ```ruby
27
+ require "google/cloud/recommender/v1"
28
+
29
+ client = Google::Cloud::Recommender::V1::Recommender::Client.new
30
+ ```
31
+
32
+ ## Credential Lookup
33
+
34
+ The google-cloud-recommender-v1 library aims to make authentication
35
+ as simple as possible, and provides several mechanisms to configure your system
36
+ without **Service Account Credentials** directly in code.
37
+
38
+ **Credentials** are discovered in the following order:
39
+
40
+ 1. Specify credentials in method arguments
41
+ 2. Specify credentials in configuration
42
+ 3. Discover credentials path in environment variables
43
+ 4. Discover credentials JSON in environment variables
44
+ 5. Discover credentials file in the Cloud SDK's path
45
+ 6. Discover GCP credentials
46
+
47
+ ### Google Cloud Platform environments
48
+
49
+ When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
50
+ Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
51
+ (GCF) and Cloud Run, **Credentials** and are discovered
52
+ automatically. Code should be written as if already authenticated.
53
+
54
+ ### Environment Variables
55
+
56
+ The **Credentials JSON** can be placed in environment
57
+ variables instead of declaring them directly in code. Each service has its own
58
+ environment variable, allowing for different service accounts to be used for
59
+ different services. (See the READMEs for the individual service gems for
60
+ details.) The path to the **Credentials JSON** file can be stored in the
61
+ environment variable, or the **Credentials JSON** itself can be stored for
62
+ environments such as Docker containers where writing files is difficult or not
63
+ encouraged.
64
+
65
+ The environment variables that google-cloud-recommender-v1 checks for credentials are configured on the service Credentials class (such as {Google::Cloud::Recommender::V1::Recommender::Credentials}):
66
+
67
+ 1. `RECOMMENDER_CREDENTIALS` - Path to JSON file, or JSON contents
68
+ 2. `RECOMMENDER_KEYFILE` - Path to JSON file, or JSON contents
69
+ 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
+ 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
72
+
73
+ ```ruby
74
+ require "google/cloud/recommender/v1"
75
+
76
+ ENV["RECOMMENDER_CREDENTIALS"] = "path/to/keyfile.json"
77
+
78
+ client = Google::Cloud::Recommender::V1::Recommender::Client.new
79
+ ```
80
+
81
+ ### Configuration
82
+
83
+ The **Credentials JSON** can be configured instead of placing them in environment variables. Either on an individual client initialization:
84
+
85
+ ```ruby
86
+ require "google/cloud/recommender/v1"
87
+
88
+ client = Google::Cloud::Recommender::V1::Recommender::Client.new do |config|
89
+ config.credentials = "path/to/keyfile.json"
90
+ end
91
+ ```
92
+
93
+ Or configured globally for all clients:
94
+
95
+ ```ruby
96
+ require "google/cloud/recommender/v1"
97
+
98
+ Google::Cloud::Recommender::V1::Recommender::Client.configure do |config|
99
+ config.credentials = "path/to/keyfile.json"
100
+ end
101
+
102
+ client = Google::Cloud::Recommender::V1::Recommender::Client.new
103
+ ```
104
+
105
+ ### Cloud SDK
106
+
107
+ This option allows for an easy way to authenticate during development. If
108
+ credentials are not provided in code or in environment variables, then Cloud SDK
109
+ credentials are discovered.
110
+
111
+ To configure your system for this, simply:
112
+
113
+ 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
114
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
115
+ 3. Write code as if already authenticated.
116
+
117
+ **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
118
+ *should* only be used during development.
119
+
120
+ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
121
+ [dev-console]: https://console.cloud.google.com/project
122
+
123
+ [enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
124
+
125
+ [create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
126
+ [create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
127
+ [reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
128
+
129
+ ## Creating a Service Account
130
+
131
+ Google Cloud requires **Service Account Credentials** to
132
+ connect to the APIs. You will use the **JSON key file** to
133
+ connect to most services with google-cloud-recommender-v1.
134
+
135
+ If you are not running this client within [Google Cloud Platform
136
+ environments](#google-cloud-platform-environments), you need a Google
137
+ Developers service account.
138
+
139
+ 1. Visit the [Google Developers Console][dev-console].
140
+ 1. Create a new project or click on an existing project.
141
+ 1. Activate the slide-out navigation tray and select **API Manager**. From
142
+ here, you will enable the APIs that your application requires.
143
+
144
+ ![Enable the APIs that your application requires][enable-apis]
145
+
146
+ *Note: You may need to enable billing in order to use these services.*
147
+
148
+ 1. Select **Credentials** from the side navigation.
149
+
150
+ You should see a screen like one of the following.
151
+
152
+ ![Create a new service account][create-new-service-account]
153
+
154
+ ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
155
+
156
+ Find the "Add credentials" drop down and select "Service account" to be
157
+ guided through downloading a new JSON key file.
158
+
159
+ If you want to re-use an existing service account, you can easily generate a
160
+ new key file. Just select the account you wish to re-use, and click "Generate
161
+ new JSON key":
162
+
163
+ ![Re-use an existing service account][reuse-service-account]
164
+
165
+ The key file you download will be used by this library to authenticate API
166
+ requests and should be stored in a secure location.
data/LICENSE.md ADDED
@@ -0,0 +1,201 @@
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.
data/README.md ADDED
@@ -0,0 +1,24 @@
1
+ # Recommender V1
2
+
3
+ google-cloud-recommender-v1 is the official library for Recommender V1 API.
4
+
5
+ recommender.googleapis.com
6
+
7
+ https://github.com/googleapis/googleapis
8
+
9
+ ## Installation
10
+
11
+ ```
12
+ $ gem install google-cloud-recommender-v1
13
+ ```
14
+
15
+ ## Supported Ruby Versions
16
+
17
+ This library is supported on Ruby 2.4+.
18
+
19
+ Google provides official support for Ruby versions that are actively supported
20
+ by Ruby Core—that is, Ruby versions that are either in normal maintenance or
21
+ in security maintenance, and not end of life. Currently, this means Ruby 2.4
22
+ and later. Older versions of Ruby _may_ still work, but are unsupported and not
23
+ recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
24
+ about the Ruby support schedule.
@@ -0,0 +1 @@
1
+ require "google/cloud/recommender/v1/version"
@@ -0,0 +1,15 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/common_resources.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/resource_pb'
7
+ Google::Protobuf::DescriptorPool.generated_pool.build do
8
+ add_file("google/cloud/common_resources.proto", :syntax => :proto3) do
9
+ end
10
+ end
11
+
12
+ module Google
13
+ module Cloud
14
+ end
15
+ end
@@ -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/recommender/v1/recommender"