gapic-generator-cloud 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/cloud-rubocop.yml ADDED
@@ -0,0 +1,14 @@
1
+ # This file is to be used as the config for formatting the generated cloud files.
2
+ # We can't reference the generated .rubocop.yml file because Rubocop is so clevar
3
+ # that it won't find the google-style gem unless the file is referenced here.
4
+ inherit_gem:
5
+ google-style: google-style.yml
6
+
7
+ AllCops:
8
+ Exclude:
9
+ - "acceptance/**/*"
10
+ - "*.gemspec"
11
+ - "lib/**/*_pb.rb"
12
+ - "Rakefile"
13
+ - "support/**/*"
14
+ - "test/**/*"
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2018 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
+ module Gapic
18
+ module Generator
19
+ module Cloud
20
+ VERSION = "0.1.0"
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,76 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2018 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
+ require "gapic/generators/default_generator"
18
+
19
+ module Gapic
20
+ module Generators
21
+ # The generator orchestrates the rendering of templates for Google Cloud
22
+ # projects.
23
+ class CloudGenerator < DefaultGenerator
24
+ # Initializes the generator.
25
+ #
26
+ # @param api [Gapic::Schema::Api] The API model/context to
27
+ # generate.
28
+ def initialize api
29
+ gem_config = api.configuration[:gem] ||= {}
30
+ gem_config[:homepage] ||= "https://github.com/googleapis/google-cloud-ruby"
31
+
32
+ super
33
+
34
+ # Configure to use prefer Google Cloud templates
35
+ use_templates! File.join __dir__, "../../../templates/cloud"
36
+ end
37
+
38
+ # Generates all the files for the API.
39
+ #
40
+ # @return [Array<
41
+ # Google::Protobuf::Compiler::CodeGeneratorResponse::File>]
42
+ # The files that were generated for the API.
43
+ def generate
44
+ orig_files = super
45
+
46
+ cloud_files = []
47
+
48
+ gem = gem_presenter @api
49
+
50
+ # Additional Gem level files
51
+ cloud_files << g("gem/repo-metadata.erb", ".repo-metadata.json", gem: gem)
52
+ cloud_files << g("gem/authentication.erb", "AUTHENTICATION.md", gem: gem) unless gem.services.empty?
53
+ cloud_files << g("gem/dashed.erb", "lib/#{gem.name}.rb", gem: gem)
54
+
55
+ format_files cloud_files
56
+
57
+ orig_files + cloud_files
58
+ end
59
+
60
+ private
61
+
62
+ ##
63
+ # Override the default rubocop config file to be used.
64
+ def format_config
65
+ @api.configuration[:format_config] ||
66
+ google_style_config
67
+ end
68
+
69
+ ##
70
+ # Path to the rubocop file for this project, which uses google-style
71
+ def google_style_config
72
+ File.expand_path File.join __dir__, "../../../cloud-rubocop.yml"
73
+ end
74
+ end
75
+ end
76
+ end
@@ -0,0 +1,169 @@
1
+ <%- assert_locals gem -%>
2
+ <%- service = gem.services.first -%>
3
+ <%- assert_locals service -%>
4
+ # Authentication
5
+
6
+ In general, the <%= gem.name %> library uses [Service
7
+ Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
8
+ credentials to connect to Google Cloud services. When running within [Google
9
+ Cloud Platform environments](#google-cloud-platform-environments)
10
+ the credentials will be discovered automatically. When running on other
11
+ environments, the Service Account credentials can be specified by providing the
12
+ path to the [JSON
13
+ keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
14
+ the account (or the JSON itself) in [environment
15
+ variables](#environment-variables). Additionally, Cloud SDK credentials can also
16
+ be discovered automatically, but this is only recommended during development.
17
+
18
+ ## Quickstart
19
+
20
+ 1. [Create a service account and credentials](#creating-a-service-account).
21
+ 2. Set the [environment variable](#environment-variables).
22
+
23
+ ```sh
24
+ export <%= gem.env_prefix %>_CREDENTIALS=path/to/keyfile.json
25
+ ```
26
+
27
+ 3. Initialize the client.
28
+
29
+ ```ruby
30
+ require "<%= service.package.package_require %>"
31
+
32
+ client = <%= service.client_name_full %>.new
33
+ ```
34
+
35
+ ## Credential Lookup
36
+
37
+ The <%= gem.name %> library aims to make authentication
38
+ as simple as possible, and provides several mechanisms to configure your system
39
+ without **Service Account Credentials** directly in code.
40
+
41
+ **Credentials** are discovered in the following order:
42
+
43
+ 1. Specify credentials in method arguments
44
+ 2. Specify credentials in configuration
45
+ 3. Discover credentials path in environment variables
46
+ 4. Discover credentials JSON in environment variables
47
+ 5. Discover credentials file in the Cloud SDK's path
48
+ 6. Discover GCP credentials
49
+
50
+ ### Google Cloud Platform environments
51
+
52
+ When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
53
+ Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
54
+ (GCF) and Cloud Run, **Credentials** and are discovered
55
+ automatically. Code should be written as if already authenticated.
56
+
57
+ ### Environment Variables
58
+
59
+ The **Credentials JSON** can be placed in environment
60
+ variables instead of declaring them directly in code. Each service has its own
61
+ environment variable, allowing for different service accounts to be used for
62
+ different services. (See the READMEs for the individual service gems for
63
+ details.) The path to the **Credentials JSON** file can be stored in the
64
+ environment variable, or the **Credentials JSON** itself can be stored for
65
+ environments such as Docker containers where writing files is difficult or not
66
+ encouraged.
67
+
68
+ The environment variables that <%= gem.name %> checks for credentials are configured on the service Credentials class (such as {<%= service.credentials_name_full %>}):
69
+
70
+ 1. `<%= gem.env_prefix %>_CREDENTIALS` - Path to JSON file, or JSON contents
71
+ 2. `<%= gem.env_prefix %>_KEYFILE` - Path to JSON file, or JSON contents
72
+ 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
73
+ 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
74
+ 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
75
+
76
+ ```ruby
77
+ require "<%= service.package.package_require %>"
78
+
79
+ ENV["<%= gem.env_prefix %>_CREDENTIALS"] = "path/to/keyfile.json"
80
+
81
+ client = <%= service.client_name_full %>.new
82
+ ```
83
+
84
+ ### Configuration
85
+
86
+ The **Credentials JSON** can be configured instead of placing them in environment variables. Either on an individual client initialization:
87
+
88
+ ```ruby
89
+ require "<%= service.package.package_require %>"
90
+
91
+ client = <%= service.client_name_full %>.new 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 "<%= service.package.package_require %>"
100
+
101
+ <%= service.client_name_full %>.configure do |config|
102
+ config.credentials = "path/to/keyfile.json"
103
+ end
104
+
105
+ client = <%= service.client_name_full %>.new
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 <%= gem.name %>.
137
+
138
+ If you are not running this client within [Google Cloud Platform
139
+ environments](#google-cloud-platform-environments), you need a Google
140
+ Developers service account.
141
+
142
+ 1. Visit the [Google Developers Console][dev-console].
143
+ 1. Create a new project or click on an existing project.
144
+ 1. 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
+ 1. 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,2 @@
1
+ <%- assert_locals gem -%>
2
+ require "<%= gem.version_require %>"
@@ -0,0 +1,38 @@
1
+ <%- assert_locals gem -%>
2
+ # -*- ruby -*-
3
+ # encoding: utf-8
4
+ require File.expand_path("lib/<%= gem.version_require %>", __dir__)
5
+
6
+ Gem::Specification.new do |gem|
7
+ gem.name = "<%= gem.name %>"
8
+ gem.version = <%= gem.version_name_full %>
9
+
10
+ gem.authors = <%= gem.authors.inspect %>
11
+ gem.email = <%= gem.email.inspect %>
12
+ gem.description = <%= gem.description.inspect %>
13
+ gem.summary = <%= gem.summary.inspect %>
14
+ gem.homepage = <%= gem.homepage.inspect %>
15
+ gem.license = "Apache-2.0"
16
+
17
+ gem.platform = Gem::Platform::RUBY
18
+
19
+ gem.files = `git ls-files -- lib/*`.split("\n") +
20
+ `git ls-files -- proto_docs/*`.split("\n") +
21
+ ["README.md", "LICENSE.md", "AUTHENTICATION.md", ".yardopts"]
22
+ gem.require_paths = ["lib"]
23
+
24
+ gem.required_ruby_version = ">= 2.4"
25
+
26
+ gem.add_dependency "gapic-common", "~> 0.1.0"
27
+ gem.add_dependency "google-cloud-errors", "~> 1.0"
28
+ <%- if gem.iam_dependency? -%>
29
+ gem.add_dependency "grpc-google-iam-v1", "~> 0.6.9"
30
+ <%- end -%>
31
+
32
+ gem.add_development_dependency "google-style", "~> 1.24.0"
33
+ gem.add_development_dependency "minitest", "~> 5.10"
34
+ gem.add_development_dependency "rake", "~> 12.0"
35
+ gem.add_development_dependency "redcarpet", "~> 3.0"
36
+ gem.add_development_dependency "simplecov", "~> 0.18"
37
+ gem.add_development_dependency "yard", "~> 0.9"
38
+ end
@@ -0,0 +1,21 @@
1
+ <%- assert_locals gem -%>
2
+ # Ignore bundler lockfiles
3
+ Gemfile.lock
4
+ gems.locked
5
+
6
+ # Ignore documentation output
7
+ doc/*
8
+ .yardoc/*
9
+
10
+ # Ignore test output
11
+ coverage/*
12
+
13
+ # Ignore build artifacts
14
+ pkg/*
15
+
16
+ # Ignore files commonly present in certain dev environments
17
+ .vagrant
18
+ .DS_STORE
19
+
20
+ # Ignore synth output
21
+ __pycache__
@@ -0,0 +1,202 @@
1
+ <%- assert_locals gem -%>
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ https://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ https://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.