google-cloud-secret_manager 0.1.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: 336c4fcca76d69ba92e21355cc08c61779041c66107df5122badd7cd34271d1c
4
+ data.tar.gz: 8e4540814fa9376a25c672fdcf51620f443d80952d72f52b4fcc156c2d4d3863
5
+ SHA512:
6
+ metadata.gz: b6bfc7dd4b4538ed7e83ca10354e9af6b39b19ca3d8a8893f4a34488970244558483e74ffca9473b6a2e285f7551d5516c2a4cc9ed81e05f4105755b840a7bf5
7
+ data.tar.gz: 373f56472c51ae8aea5e541468083e7b9a2b225f22fcb082710e88839cd4c0795959a196d9433ac5e348a4630f95efbe943559d548ab00aed09fcf8aa30d6bf6
@@ -0,0 +1,11 @@
1
+ --no-private
2
+ --title=Secret Manager API
3
+ --exclude _pb\.rb$
4
+ --markup markdown
5
+ --markup-provider redcarpet
6
+
7
+ ./lib/**/*.rb
8
+ -
9
+ README.md
10
+ AUTHENTICATION.md
11
+ LICENSE
@@ -0,0 +1,172 @@
1
+ # Authentication
2
+
3
+ In general, the google-cloud-secret_manager 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 SECRET_MANAGER_CREDENTIALS=path/to/keyfile.json
22
+ ```
23
+
24
+ 3. Initialize the client.
25
+
26
+ ```ruby
27
+ require "google/cloud/secret_manager"
28
+
29
+ client = Google::Cloud::SecretManager.new
30
+ ```
31
+
32
+ ## Credential Lookup
33
+
34
+ The google-cloud-secret_manager library aims to make authentication
35
+ as simple as possible, and provides several mechanisms to configure your system
36
+ without providing **Service Account Credentials** directly in
37
+ 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 (GCE),
51
+ Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
52
+ (GCF) and Cloud Run, the **Project ID** and **Credentials** and are discovered
53
+ automatically. Code should be written as if already authenticated.
54
+
55
+ ### Environment Variables
56
+
57
+ The **Credentials JSON** can be placed in environment
58
+ variables instead of declaring them directly in code. Each service has its own
59
+ environment variable, allowing for different service accounts to be used for
60
+ different services. (See the READMEs for the individual service gems for
61
+ details.) The path to the **Credentials JSON** file can be stored in the
62
+ environment variable, or the **Credentials JSON** itself can be stored for
63
+ environments such as Docker containers where writing files is difficult or not
64
+ encouraged.
65
+
66
+ The environment variables that google-cloud-secret_manager checks for credentials are configured on `Google::Cloud::SecretManager::V1beta1::SecretManagerService::Credentials`:
67
+
68
+ 1. `SECRET_MANAGER_CREDENTIALS` - Path to JSON file, or JSON contents
69
+ 2. `SECRET_MANAGER_KEYFILE` - Path to JSON file, or JSON contents
70
+ 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
71
+ 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
72
+ 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
73
+
74
+ ```ruby
75
+ require "google/cloud/secret_manager"
76
+
77
+ ENV["SECRET_MANAGER_CREDENTIALS"] = "path/to/keyfile.json"
78
+
79
+ client = Google::Cloud::SecretManager.new
80
+ ```
81
+
82
+ ### Configuration
83
+
84
+ The **Credentials JSON** can be configured instead of placing them in environment variables. Either on an individual client initialization:
85
+
86
+ ```ruby
87
+ require "google/cloud/secret_manager"
88
+
89
+ client = Google::Cloud::SecretManager.new do |config|
90
+ config.credentials = "path/to/keyfile.json"
91
+ end
92
+ ```
93
+
94
+ Or configured globally for all clients:
95
+
96
+ ```ruby
97
+ require "google/cloud/secret_manager"
98
+
99
+ Google::Cloud::SecretManager.configure do |config|
100
+ config.credentials = "path/to/keyfile.json"
101
+ end
102
+
103
+ client = Google::Cloud::SecretManager.new
104
+ ```
105
+
106
+ ### Cloud SDK
107
+
108
+ This option allows for an easy way to authenticate during development. If
109
+ credentials are not provided in code or in environment variables, then Cloud SDK
110
+ credentials are discovered.
111
+
112
+ To configure your system for this, simply:
113
+
114
+ 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
116
+ 3. Write code as if already authenticated.
117
+
118
+ **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
+ *should* only be used during development.
120
+
121
+ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
122
+ [dev-console]: https://console.cloud.google.com/project
123
+
124
+ [enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
125
+
126
+ [create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
127
+ [create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
128
+ [reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
129
+
130
+ ## Creating a Service Account
131
+
132
+ Google Cloud requires **Service Account Credentials** to
133
+ connect to the APIs. You will use the **JSON key file** to
134
+ connect to most services with google-cloud-secret_manager.
135
+
136
+ If you are not running this client within [Google Cloud Platform
137
+ environments](#google-cloud-platform-environments), you need a Google
138
+ Developers service account.
139
+
140
+ 1. Visit the [Google Developers Console][dev-console].
141
+ 1. Create a new project or click on an existing project.
142
+ 1. Activate the slide-out navigation tray and select **API Manager**. From
143
+ here, you will enable the APIs that your application requires.
144
+
145
+ ![Enable the APIs that your application requires][enable-apis]
146
+
147
+ *Note: You may need to enable billing in order to use these services.*
148
+
149
+ 1. Select **Credentials** from the side navigation.
150
+
151
+ You should see a screen like one of the following.
152
+
153
+ ![Create a new service account][create-new-service-account]
154
+
155
+ ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
156
+
157
+ Find the "Add credentials" drop down and select "Service account" to be
158
+ guided through downloading a new JSON key file.
159
+
160
+ If you want to re-use an existing service account, you can easily generate a
161
+ new key file. Just select the account you wish to re-use, and click "Generate
162
+ new JSON key":
163
+
164
+ ![Re-use an existing service account][reuse-service-account]
165
+
166
+ The key file you download will be used by this library to authenticate API
167
+ requests and should be stored in a secure location.
168
+
169
+ ## Troubleshooting
170
+
171
+ If you're having trouble authenticating you can ask for help by following the
172
+ {file:TROUBLESHOOTING.md Troubleshooting Guide}.
data/LICENSE 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.
@@ -0,0 +1,68 @@
1
+ # Ruby Client for Secret Manager API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
2
+
3
+ [Secret Manager API][Product Documentation]:
4
+ Secret Manager provides a secure and convenient tool for storing API keys, passwords, certificates, and other sensitive data.
5
+ - [Client Library Documentation][]
6
+ - [Product Documentation][]
7
+
8
+ ## Quick Start
9
+ In order to use this library, you first need to go through the following
10
+ steps:
11
+
12
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
13
+ 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
14
+ 3. [Enable the Secret Manager API.](https://console.cloud.google.com/apis/library/language.googleapis.com)
15
+ 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-secret_manager/latest/file.AUTHENTICATION.html)
16
+
17
+ ### Installation
18
+ ```
19
+ $ gem install google-cloud-secret_manager
20
+ ```
21
+
22
+ ### Next Steps
23
+ - Read the [Client Library Documentation][] for Secret Manager API
24
+ to see other available methods on the client.
25
+ - Read the [Secret Manager API Product documentation][Product Documentation]
26
+ to learn more about the product and see How-to Guides.
27
+ - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
28
+ to see the full list of Cloud APIs that we cover.
29
+
30
+ [Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-secret_manager/latest
31
+ [Product Documentation]: https://cloud.google.com/natural-language
32
+
33
+ ## Enabling Logging
34
+
35
+ To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
36
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
37
+ or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
38
+ that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
39
+ and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
40
+
41
+ Configuring a Ruby stdlib logger:
42
+
43
+ ```ruby
44
+ require "logger"
45
+
46
+ module MyLogger
47
+ LOGGER = Logger.new $stderr, level: Logger::WARN
48
+ def logger
49
+ LOGGER
50
+ end
51
+ end
52
+
53
+ # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
54
+ module GRPC
55
+ extend MyLogger
56
+ end
57
+ ```
58
+
59
+ ## Supported Ruby Versions
60
+
61
+ This library is supported on Ruby 2.4+.
62
+
63
+ Google provides official support for Ruby versions that are actively supported
64
+ by Ruby Core—that is, Ruby versions that are either in normal maintenance or
65
+ in security maintenance, and not end of life. Currently, this means Ruby 2.4
66
+ and later. Older versions of Ruby _may_ still work, but are unsupported and not
67
+ recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
68
+ about the Ruby support schedule.
@@ -0,0 +1,36 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # https://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+
16
+ ##
17
+ # This file is here to be autorequired by bundler, so that the .langage and
18
+ # #langage methods can be available, but the library and all dependencies
19
+ # won't be loaded until required and used.
20
+
21
+
22
+ gem "google-cloud-core"
23
+ require "google/cloud" unless defined? Google::Cloud.new
24
+ require "google/cloud/config"
25
+ require "googleauth"
26
+
27
+ # Set the default langage configuration
28
+ Google::Cloud.configure.add_config! :secret_manager do |config|
29
+ config.add_field! :credentials, nil, match: [String, Hash, Google::Auth::Credentials]
30
+ config.add_field! :lib_name, nil, match: String
31
+ config.add_field! :lib_version, nil, match: String
32
+ config.add_field! :interceptors, nil, match: Array
33
+ config.add_field! :timeout, nil, match: Numeric
34
+ config.add_field! :metadata, nil, match: Hash
35
+ config.add_field! :retry_policy, nil, match: [Hash, Proc]
36
+ end
@@ -0,0 +1,66 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # https://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+
16
+ require "google-cloud-secret_manager"
17
+
18
+ module Google
19
+ module Cloud
20
+ ##
21
+ # Secret Manager provides a secure and convenient tool for storing API keys, passwords, certificates, and other
22
+ # sensitive data.
23
+ module SecretManager
24
+ ##
25
+ # Create a new `SecretManagerService::Client` object.
26
+ #
27
+ # @param version [String, Symbol] The API version to create the client instance. Optional. If not provided
28
+ # defaults to `:v1beta1`.
29
+ #
30
+ # @return [SecretManagerService::Client] A client object for the specified version.
31
+ #
32
+ def self.secret_manager_service version: :v1beta1, &block
33
+ require "google/cloud/secret_manager/#{version.to_s.downcase}"
34
+
35
+ package_name = Google::Cloud::SecretManager
36
+ .constants
37
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
38
+ .first
39
+ package_module = Google::Cloud::SecretManager.const_get package_name
40
+ package_module.const_get(:SecretManagerService).const_get(:Client).new(&block)
41
+ end
42
+
43
+ ##
44
+ # Configure the Google Secret Manager library.
45
+ #
46
+ # The following Secret Manager configuration parameters are supported:
47
+ #
48
+ # * `credentials` - (String, Hash, Google::Auth::Credentials) The path to the keyfile as a String, the contents of
49
+ # the keyfile as a Hash, or a Google::Auth::Credentials object.
50
+ # * `lib_name` (String)
51
+ # * `lib_version` (String)
52
+ # * `interceptors` (Array)
53
+ # * `timeout` - (Integer) Default timeout to use in requests.
54
+ # * `metadata` (Hash)
55
+ # * `retry_policy` (Hash, Proc)
56
+ #
57
+ # @return [Google::Cloud::Config] The configuration object the Google::Cloud::SecretManager library uses.
58
+ #
59
+ def self.configure
60
+ yield Google::Cloud.configure.secret_manager if block_given?
61
+
62
+ Google::Cloud.configure.secret_manager
63
+ end
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,22 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # https://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+
16
+ module Google
17
+ module Cloud
18
+ module SecretManager
19
+ VERSION = "0.1.0".freeze
20
+ end
21
+ end
22
+ end
metadata ADDED
@@ -0,0 +1,204 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-cloud-secret_manager
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2020-01-10 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-secret_manager-v1beta1
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.1'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.1'
41
+ - !ruby/object:Gem::Dependency
42
+ name: autotest-suffix
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.1'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.1'
55
+ - !ruby/object:Gem::Dependency
56
+ name: google-style
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 1.24.0
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 1.24.0
69
+ - !ruby/object:Gem::Dependency
70
+ name: minitest
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '5.10'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '5.10'
83
+ - !ruby/object:Gem::Dependency
84
+ name: minitest-autotest
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '1.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '1.0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: minitest-focus
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '1.1'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '1.1'
111
+ - !ruby/object:Gem::Dependency
112
+ name: minitest-rg
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '5.2'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '5.2'
125
+ - !ruby/object:Gem::Dependency
126
+ name: redcarpet
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '3.0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '3.0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: simplecov
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '0.9'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '0.9'
153
+ - !ruby/object:Gem::Dependency
154
+ name: yard
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: '0.9'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: '0.9'
167
+ description: google-cloud-secret_manager is the official library for Secret Manager
168
+ API.
169
+ email: googleapis-packages@google.com
170
+ executables: []
171
+ extensions: []
172
+ extra_rdoc_files: []
173
+ files:
174
+ - ".yardopts"
175
+ - AUTHENTICATION.md
176
+ - LICENSE
177
+ - README.md
178
+ - lib/google-cloud-secret_manager.rb
179
+ - lib/google/cloud/secret_manager.rb
180
+ - lib/google/cloud/secret_manager/version.rb
181
+ homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-secret_manager
182
+ licenses:
183
+ - Apache-2.0
184
+ metadata: {}
185
+ post_install_message:
186
+ rdoc_options: []
187
+ require_paths:
188
+ - lib
189
+ required_ruby_version: !ruby/object:Gem::Requirement
190
+ requirements:
191
+ - - ">="
192
+ - !ruby/object:Gem::Version
193
+ version: '2.4'
194
+ required_rubygems_version: !ruby/object:Gem::Requirement
195
+ requirements:
196
+ - - ">="
197
+ - !ruby/object:Gem::Version
198
+ version: '0'
199
+ requirements: []
200
+ rubygems_version: 3.0.6
201
+ signing_key:
202
+ specification_version: 4
203
+ summary: API Client library for Secret Manager API
204
+ test_files: []