google-cloud-os_login 1.0.1 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.md +188 -190
- data/MIGRATING.md +47 -1
- data/README.md +63 -4
- data/lib/google/cloud/os_login.rb +15 -9
- data/lib/google/cloud/os_login/version.rb +1 -1
- metadata +6 -34
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '0436158ab16fe6c84f9b3e3ddd3bfab723e3ad30311ab14762a9d0d117d8d2c0'
|
|
4
|
+
data.tar.gz: c0f63ff7e82446f32ce1f7dac06530872e98c5143727734460dcee57190cbc62
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d81cd0a078de77f65fa96722f13b86d93cedfa1d6a7c961586773a1ec8937759250fc6a2af5c29655eb1df4260078a8bb846f2e60e8591180fd9cc4c807f8575
|
|
7
|
+
data.tar.gz: 8fb3e9f118a82080c32654da1ad31a1ef76d487c17b99cfe8913cc36b95478a9eea692b7e47a263d9061e073275672e571bcd995c22901dc2192cfd31671e7c7
|
data/LICENSE.md
CHANGED
|
@@ -1,192 +1,190 @@
|
|
|
1
|
-
Apache License
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
same "printed page" as the copyright notice for easier
|
|
189
|
-
identification within third-party archives.
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://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.
|
|
190
188
|
|
|
191
189
|
Copyright [yyyy] [name of copyright owner]
|
|
192
190
|
|
|
@@ -194,7 +192,7 @@ identification within third-party archives.
|
|
|
194
192
|
you may not use this file except in compliance with the License.
|
|
195
193
|
You may obtain a copy of the License at
|
|
196
194
|
|
|
197
|
-
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
196
|
|
|
199
197
|
Unless required by applicable law or agreed to in writing, software
|
|
200
198
|
distributed under the License is distributed on an "AS IS" BASIS,
|
data/MIGRATING.md
CHANGED
|
@@ -30,6 +30,10 @@ To summarize:
|
|
|
30
30
|
resource paths. These paths are now instance methods on the client objects,
|
|
31
31
|
and are also available in a separate paths module. See
|
|
32
32
|
[Resource Path Helpers](#resource-path-helpers) for more info.
|
|
33
|
+
* Previously, clients reported RPC errors by raising instances of
|
|
34
|
+
`Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
|
|
35
|
+
`Google::Cloud::Error` and its subclasses. See
|
|
36
|
+
[Handling Errors](#handling-errors) for more info.
|
|
33
37
|
* Some classes have moved into different namespaces. See
|
|
34
38
|
[Class Namespaces](#class-namespaces) for more info.
|
|
35
39
|
|
|
@@ -238,7 +242,7 @@ In the 1.0 client, you can also use the paths module as a convenience module.
|
|
|
238
242
|
|
|
239
243
|
New:
|
|
240
244
|
```
|
|
241
|
-
# Bring the
|
|
245
|
+
# Bring the path helper methods into the current class
|
|
242
246
|
include Google::Cloud::OsLogin::V1::OsLoginService::Paths
|
|
243
247
|
|
|
244
248
|
def foo
|
|
@@ -253,6 +257,48 @@ def foo
|
|
|
253
257
|
end
|
|
254
258
|
```
|
|
255
259
|
|
|
260
|
+
### Handling Errors
|
|
261
|
+
|
|
262
|
+
The client reports standard
|
|
263
|
+
[gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
|
|
264
|
+
by raising exceptions. In older releases, these exceptions were located in the
|
|
265
|
+
`Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
|
|
266
|
+
exception class, defined in the `google-gax` gem. However, these classes were
|
|
267
|
+
different from the standard exceptions (subclasses of `Google::Cloud::Error`)
|
|
268
|
+
thrown by other client libraries such as `google-cloud-storage`.
|
|
269
|
+
|
|
270
|
+
The 1.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
|
|
271
|
+
for consistency across all the Google Cloud client libraries. In general, these
|
|
272
|
+
exceptions have the same name as their counterparts from older releases, but
|
|
273
|
+
are located in the `Google::Cloud` namespace rather than the `Google::Gax`
|
|
274
|
+
namespace.
|
|
275
|
+
|
|
276
|
+
Old:
|
|
277
|
+
```
|
|
278
|
+
client = Google::Cloud::OsLogin.new
|
|
279
|
+
|
|
280
|
+
key_name = "users/my-user/sshPublicKeys/12345"
|
|
281
|
+
|
|
282
|
+
begin
|
|
283
|
+
response = client.get_ssh_public_key key_name
|
|
284
|
+
rescue Google::Gax::Error => e
|
|
285
|
+
# Handle exceptions that subclass Google::Gax::Error
|
|
286
|
+
end
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
New:
|
|
290
|
+
```
|
|
291
|
+
client = Google::Cloud::OsLogin.os_login_service
|
|
292
|
+
|
|
293
|
+
key_name = "users/my-user/sshPublicKeys/12345"
|
|
294
|
+
|
|
295
|
+
begin
|
|
296
|
+
response = client.get_ssh_public_key name: key_name
|
|
297
|
+
rescue Google::Cloud::Error => e
|
|
298
|
+
# Handle exceptions that subclass Google::Cloud::Error
|
|
299
|
+
end
|
|
300
|
+
```
|
|
301
|
+
|
|
256
302
|
### Class Namespaces
|
|
257
303
|
|
|
258
304
|
In older releases, some data type (protobuf) classes were located under the
|
data/README.md
CHANGED
|
@@ -6,9 +6,10 @@ Use OS Login to manage SSH access to your instances using IAM without having to
|
|
|
6
6
|
|
|
7
7
|
Actual client classes for the various versions of this API are defined in
|
|
8
8
|
_versioned_ client gems, with names of the form `google-cloud-os_login-v*`.
|
|
9
|
-
The gem `google-cloud-os_login` is
|
|
9
|
+
The gem `google-cloud-os_login` is the main client library that brings the
|
|
10
10
|
verisoned gems in as dependencies, and provides high-level methods for
|
|
11
|
-
constructing clients.
|
|
11
|
+
constructing clients. More information on versioned clients can be found below
|
|
12
|
+
in the section titled *Which client should I use?*.
|
|
12
13
|
|
|
13
14
|
View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-os_login/latest)
|
|
14
15
|
for this library, google-cloud-os_login, to see the convenience methods for
|
|
@@ -70,11 +71,69 @@ end
|
|
|
70
71
|
|
|
71
72
|
## Supported Ruby Versions
|
|
72
73
|
|
|
73
|
-
This library is supported on Ruby 2.
|
|
74
|
+
This library is supported on Ruby 2.5+.
|
|
74
75
|
|
|
75
76
|
Google provides official support for Ruby versions that are actively supported
|
|
76
77
|
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.
|
|
78
|
+
in security maintenance, and not end of life. Currently, this means Ruby 2.5
|
|
78
79
|
and later. Older versions of Ruby _may_ still work, but are unsupported and not
|
|
79
80
|
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
|
80
81
|
about the Ruby support schedule.
|
|
82
|
+
|
|
83
|
+
## Which client should I use?
|
|
84
|
+
|
|
85
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
|
86
|
+
client library with a name such as `google-cloud-os_login`,
|
|
87
|
+
and lower-level _versioned_ client libraries with names such as
|
|
88
|
+
`google-cloud-os_login-v1`.
|
|
89
|
+
_In most cases, you should install the main client._
|
|
90
|
+
|
|
91
|
+
### What's the difference between the main client and a versioned client?
|
|
92
|
+
|
|
93
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
|
94
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
|
95
|
+
versions, there might be a separate versioned client for each service version.)
|
|
96
|
+
Most versioned clients are written and maintained by a code generator.
|
|
97
|
+
|
|
98
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
|
99
|
+
interfaces for the service. There will be only one main client for any given
|
|
100
|
+
service, even a service with multiple versions. The main client includes
|
|
101
|
+
factory methods for constructing the client objects we recommend for most
|
|
102
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
|
103
|
+
client; in other cases, they will be handwritten higher-level client objects
|
|
104
|
+
with additional capabilities, convenience methods, or best practices built in.
|
|
105
|
+
Generally, the main client will default to a recommended service version,
|
|
106
|
+
although in some cases you can override this if you need to talk to a specific
|
|
107
|
+
service version.
|
|
108
|
+
|
|
109
|
+
### Why would I want to use the main client?
|
|
110
|
+
|
|
111
|
+
We recommend that most users install the main client gem for a service. You can
|
|
112
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
|
113
|
+
`google-cloud-os_login`.
|
|
114
|
+
The main client is recommended because it will embody the best practices for
|
|
115
|
+
accessing the service, and may also provide more convenient interfaces or
|
|
116
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
|
117
|
+
documentation and samples published by Google will generally demonstrate use of
|
|
118
|
+
the main client.
|
|
119
|
+
|
|
120
|
+
### Why would I want to use a versioned client?
|
|
121
|
+
|
|
122
|
+
You can use a versioned client if you are content with a possibly lower-level
|
|
123
|
+
class interface, you explicitly want to avoid features provided by the main
|
|
124
|
+
client, or you want to access a specific service version not be covered by the
|
|
125
|
+
main client. You can identify versioned client gems because the service version
|
|
126
|
+
is part of the name, e.g. `google-cloud-os_login-v1`.
|
|
127
|
+
|
|
128
|
+
### What about the google-apis-<name> clients?
|
|
129
|
+
|
|
130
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
|
131
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
|
132
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
|
133
|
+
not offer the same performance, features, and ease of use provided by more
|
|
134
|
+
modern clients.
|
|
135
|
+
|
|
136
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
|
137
|
+
might need to use one if there is no modern client available for the service.
|
|
138
|
+
However, if a modern client is available, we generally recommend it over the
|
|
139
|
+
older `google-apis-` clients.
|
|
@@ -29,13 +29,16 @@ require "google/cloud/config"
|
|
|
29
29
|
|
|
30
30
|
# Set the default configuration
|
|
31
31
|
::Google::Cloud.configure.add_config! :os_login do |config|
|
|
32
|
-
config.add_field! :
|
|
33
|
-
config.add_field! :
|
|
34
|
-
config.add_field! :
|
|
35
|
-
config.add_field! :
|
|
36
|
-
config.add_field! :
|
|
37
|
-
config.add_field! :
|
|
38
|
-
config.add_field! :
|
|
32
|
+
config.add_field! :endpoint, "oslogin.googleapis.com", match: ::String
|
|
33
|
+
config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
|
|
34
|
+
config.add_field! :scope, nil, match: [::Array, ::String]
|
|
35
|
+
config.add_field! :lib_name, nil, match: ::String
|
|
36
|
+
config.add_field! :lib_version, nil, match: ::String
|
|
37
|
+
config.add_field! :interceptors, nil, match: ::Array
|
|
38
|
+
config.add_field! :timeout, nil, match: ::Numeric
|
|
39
|
+
config.add_field! :metadata, nil, match: ::Hash
|
|
40
|
+
config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
|
|
41
|
+
config.add_field! :quota_project, nil, match: ::String
|
|
39
42
|
end
|
|
40
43
|
|
|
41
44
|
module Google
|
|
@@ -88,8 +91,8 @@ module Google
|
|
|
88
91
|
# The library version as recorded in instrumentation and logging.
|
|
89
92
|
# * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
|
|
90
93
|
# An array of interceptors that are run before calls are executed.
|
|
91
|
-
# * `timeout` (*type:* `
|
|
92
|
-
# Default timeout in
|
|
94
|
+
# * `timeout` (*type:* `Numeric`) -
|
|
95
|
+
# Default timeout in seconds.
|
|
93
96
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) -
|
|
94
97
|
# Additional gRPC headers to be sent with the call.
|
|
95
98
|
# * `retry_policy` (*type:* `Hash`) -
|
|
@@ -110,3 +113,6 @@ module Google
|
|
|
110
113
|
end
|
|
111
114
|
end
|
|
112
115
|
end
|
|
116
|
+
|
|
117
|
+
helper_path = ::File.join __dir__, "os_login", "helpers.rb"
|
|
118
|
+
require "google/cloud/os_login/helpers" if ::File.file? helper_path
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-os_login
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0
|
|
4
|
+
version: 1.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2021-03-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: google-cloud-core
|
|
@@ -52,34 +52,20 @@ dependencies:
|
|
|
52
52
|
- - "~>"
|
|
53
53
|
- !ruby/object:Gem::Version
|
|
54
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
55
|
- !ruby/object:Gem::Dependency
|
|
70
56
|
name: google-style
|
|
71
57
|
requirement: !ruby/object:Gem::Requirement
|
|
72
58
|
requirements:
|
|
73
59
|
- - "~>"
|
|
74
60
|
- !ruby/object:Gem::Version
|
|
75
|
-
version: 1.
|
|
61
|
+
version: 1.25.1
|
|
76
62
|
type: :development
|
|
77
63
|
prerelease: false
|
|
78
64
|
version_requirements: !ruby/object:Gem::Requirement
|
|
79
65
|
requirements:
|
|
80
66
|
- - "~>"
|
|
81
67
|
- !ruby/object:Gem::Version
|
|
82
|
-
version: 1.
|
|
68
|
+
version: 1.25.1
|
|
83
69
|
- !ruby/object:Gem::Dependency
|
|
84
70
|
name: minitest
|
|
85
71
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -94,20 +80,6 @@ dependencies:
|
|
|
94
80
|
- - "~>"
|
|
95
81
|
- !ruby/object:Gem::Version
|
|
96
82
|
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
83
|
- !ruby/object:Gem::Dependency
|
|
112
84
|
name: minitest-focus
|
|
113
85
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -221,14 +193,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
221
193
|
requirements:
|
|
222
194
|
- - ">="
|
|
223
195
|
- !ruby/object:Gem::Version
|
|
224
|
-
version: '2.
|
|
196
|
+
version: '2.5'
|
|
225
197
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
226
198
|
requirements:
|
|
227
199
|
- - ">="
|
|
228
200
|
- !ruby/object:Gem::Version
|
|
229
201
|
version: '0'
|
|
230
202
|
requirements: []
|
|
231
|
-
rubygems_version: 3.
|
|
203
|
+
rubygems_version: 3.2.13
|
|
232
204
|
signing_key:
|
|
233
205
|
specification_version: 4
|
|
234
206
|
summary: API Client library for the Cloud OS Login API
|