gapic-generator-cloud 0.10.1 → 0.45.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +330 -0
  3. data/README.md +82 -61
  4. data/bin/protoc-gen-bazel_ruby_cloud +2 -2
  5. data/bin/protoc-gen-ruby_cloud +2 -2
  6. data/lib/gapic/generator/cloud/version.rb +1 -1
  7. data/lib/gapic/generators/cloud_generator.rb +20 -21
  8. data/lib/gapic/generators/cloud_generator_parameters.rb +5 -1
  9. data/lib/gapic/presenters/cloud_gem_presenter.rb +60 -13
  10. data/lib/gapic/presenters/wrapper_gem_presenter.rb +31 -9
  11. data/lib/gapic/presenters/wrapper_service_presenter.rb +23 -1
  12. data/lib/gapic/presenters/wrapper_service_rest_presenter.rb +49 -0
  13. data/templates/cloud/gem/authentication.text.erb +125 -0
  14. data/templates/cloud/gem/{rakefile.erb → rakefile.text.erb} +0 -37
  15. data/templates/cloud/gem/{readme.erb → readme.text.erb} +48 -26
  16. data/templates/cloud/gem/{repo-metadata.erb → repo-metadata.text.erb} +3 -0
  17. data/templates/cloud/gem/{rubocop.erb → rubocop.text.erb} +3 -0
  18. data/templates/cloud/gem/{yardopts.erb → yardopts.text.erb} +1 -1
  19. data/templates/cloud/service/rest/client/method/def/_rescue.text.erb +3 -0
  20. data/templates/cloud/wrapper_gem/{_main.erb → _main.text.erb} +69 -9
  21. data/templates/cloud/wrapper_gem/client_test.text.erb +59 -0
  22. data/templates/cloud/wrapper_gem/gemfile.text.erb +29 -0
  23. data/templates/cloud/wrapper_gem/{gemspec.erb → gemspec.text.erb} +2 -11
  24. data/templates/cloud/wrapper_gem/{rakefile.erb → rakefile.text.erb} +2 -37
  25. data/templates/cloud/wrapper_gem/{readme.erb → readme.text.erb} +45 -35
  26. data/templates/cloud/wrapper_gem/{version_test.erb → version_test.text.erb} +1 -1
  27. data/templates/cloud/wrapper_gem/{yardopts.erb → yardopts.text.erb} +1 -1
  28. metadata +34 -151
  29. data/templates/cloud/gem/authentication.erb +0 -174
  30. data/templates/cloud/gem/yardopts-cloudrad.erb +0 -15
  31. data/templates/cloud/service/rest/client/method/def/_rescue.erb +0 -4
  32. data/templates/cloud/wrapper_gem/client_test.erb +0 -22
  33. data/templates/cloud/wrapper_gem/gemfile.erb +0 -8
  34. data/templates/cloud/wrapper_gem/yardopts-cloudrad.erb +0 -17
  35. /data/templates/cloud/gem/{gitignore.erb → gitignore.text.erb} +0 -0
  36. /data/templates/cloud/gem/{license.erb → license.text.erb} +0 -0
  37. /data/templates/cloud/service/client/{_credentials.erb → _credentials.text.erb} +0 -0
  38. /data/templates/cloud/service/client/{_requires.erb → _requires.text.erb} +0 -0
  39. /data/templates/cloud/service/client/{_self_configure.erb → _self_configure.text.erb} +0 -0
  40. /data/templates/cloud/service/client/method/def/{_rescue.erb → _rescue.text.erb} +0 -0
  41. /data/templates/cloud/service/client/method/docs/{_error.erb → _error.text.erb} +0 -0
  42. /data/templates/cloud/service/rest/client/method/docs/{_error.erb → _error.text.erb} +0 -0
  43. /data/templates/cloud/shared/{_license.erb → _license.text.erb} +0 -0
  44. /data/templates/cloud/wrapper_gem/{entrypoint.erb → entrypoint.text.erb} +0 -0
  45. /data/templates/cloud/wrapper_gem/{main.erb → main.text.erb} +0 -0
  46. /data/templates/cloud/wrapper_gem/{rubocop.erb → rubocop.text.erb} +0 -0
metadata CHANGED
@@ -1,144 +1,30 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gapic-generator-cloud
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.1
4
+ version: 0.45.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ernest Landrito
8
8
  - Chris Smith
9
9
  - Mike Moore
10
- autorequire:
11
10
  bindir: bin
12
11
  cert_chain: []
13
- date: 2021-08-27 00:00:00.000000000 Z
12
+ date: 1980-01-02 00:00:00.000000000 Z
14
13
  dependencies:
15
- - !ruby/object:Gem::Dependency
16
- name: actionpack
17
- requirement: !ruby/object:Gem::Requirement
18
- requirements:
19
- - - "~>"
20
- - !ruby/object:Gem::Version
21
- version: '5.2'
22
- type: :runtime
23
- prerelease: false
24
- version_requirements: !ruby/object:Gem::Requirement
25
- requirements:
26
- - - "~>"
27
- - !ruby/object:Gem::Version
28
- version: '5.2'
29
14
  - !ruby/object:Gem::Dependency
30
15
  name: gapic-generator
31
16
  requirement: !ruby/object:Gem::Requirement
32
17
  requirements:
33
18
  - - '='
34
19
  - !ruby/object:Gem::Version
35
- version: 0.10.1
20
+ version: 0.45.1
36
21
  type: :runtime
37
22
  prerelease: false
38
23
  version_requirements: !ruby/object:Gem::Requirement
39
24
  requirements:
40
25
  - - '='
41
26
  - !ruby/object:Gem::Version
42
- version: 0.10.1
43
- - !ruby/object:Gem::Dependency
44
- name: google-style
45
- requirement: !ruby/object:Gem::Requirement
46
- requirements:
47
- - - "~>"
48
- - !ruby/object:Gem::Version
49
- version: 1.25.1
50
- type: :runtime
51
- prerelease: false
52
- version_requirements: !ruby/object:Gem::Requirement
53
- requirements:
54
- - - "~>"
55
- - !ruby/object:Gem::Version
56
- version: 1.25.1
57
- - !ruby/object:Gem::Dependency
58
- name: protobuf
59
- requirement: !ruby/object:Gem::Requirement
60
- requirements:
61
- - - "~>"
62
- - !ruby/object:Gem::Version
63
- version: '3.8'
64
- type: :runtime
65
- prerelease: false
66
- version_requirements: !ruby/object:Gem::Requirement
67
- requirements:
68
- - - "~>"
69
- - !ruby/object:Gem::Version
70
- version: '3.8'
71
- - !ruby/object:Gem::Dependency
72
- name: grpc-tools
73
- requirement: !ruby/object:Gem::Requirement
74
- requirements:
75
- - - "~>"
76
- - !ruby/object:Gem::Version
77
- version: 1.36.0
78
- type: :development
79
- prerelease: false
80
- version_requirements: !ruby/object:Gem::Requirement
81
- requirements:
82
- - - "~>"
83
- - !ruby/object:Gem::Version
84
- version: 1.36.0
85
- - !ruby/object:Gem::Dependency
86
- name: minitest
87
- requirement: !ruby/object:Gem::Requirement
88
- requirements:
89
- - - "~>"
90
- - !ruby/object:Gem::Version
91
- version: '5.0'
92
- type: :development
93
- prerelease: false
94
- version_requirements: !ruby/object:Gem::Requirement
95
- requirements:
96
- - - "~>"
97
- - !ruby/object:Gem::Version
98
- version: '5.0'
99
- - !ruby/object:Gem::Dependency
100
- name: minitest-autotest
101
- requirement: !ruby/object:Gem::Requirement
102
- requirements:
103
- - - "~>"
104
- - !ruby/object:Gem::Version
105
- version: '1.0'
106
- type: :development
107
- prerelease: false
108
- version_requirements: !ruby/object:Gem::Requirement
109
- requirements:
110
- - - "~>"
111
- - !ruby/object:Gem::Version
112
- version: '1.0'
113
- - !ruby/object:Gem::Dependency
114
- name: minitest-focus
115
- requirement: !ruby/object:Gem::Requirement
116
- requirements:
117
- - - "~>"
118
- - !ruby/object:Gem::Version
119
- version: '1.0'
120
- type: :development
121
- prerelease: false
122
- version_requirements: !ruby/object:Gem::Requirement
123
- requirements:
124
- - - "~>"
125
- - !ruby/object:Gem::Version
126
- version: '1.0'
127
- - !ruby/object:Gem::Dependency
128
- name: rake
129
- requirement: !ruby/object:Gem::Requirement
130
- requirements:
131
- - - ">="
132
- - !ruby/object:Gem::Version
133
- version: '12.0'
134
- type: :development
135
- prerelease: false
136
- version_requirements: !ruby/object:Gem::Requirement
137
- requirements:
138
- - - ">="
139
- - !ruby/object:Gem::Version
140
- version: '12.0'
141
- description:
27
+ version: 0.45.1
142
28
  email:
143
29
  - landrito@google.com
144
30
  - quartzmo@gmail.com
@@ -163,40 +49,38 @@ files:
163
49
  - lib/gapic/presenters/cloud_gem_presenter.rb
164
50
  - lib/gapic/presenters/wrapper_gem_presenter.rb
165
51
  - lib/gapic/presenters/wrapper_service_presenter.rb
166
- - templates/cloud/gem/authentication.erb
167
- - templates/cloud/gem/gitignore.erb
168
- - templates/cloud/gem/license.erb
169
- - templates/cloud/gem/rakefile.erb
170
- - templates/cloud/gem/readme.erb
171
- - templates/cloud/gem/repo-metadata.erb
172
- - templates/cloud/gem/rubocop.erb
173
- - templates/cloud/gem/yardopts-cloudrad.erb
174
- - templates/cloud/gem/yardopts.erb
175
- - templates/cloud/service/client/_credentials.erb
176
- - templates/cloud/service/client/_requires.erb
177
- - templates/cloud/service/client/_self_configure.erb
178
- - templates/cloud/service/client/method/def/_rescue.erb
179
- - templates/cloud/service/client/method/docs/_error.erb
180
- - templates/cloud/service/rest/client/method/def/_rescue.erb
181
- - templates/cloud/service/rest/client/method/docs/_error.erb
182
- - templates/cloud/shared/_license.erb
183
- - templates/cloud/wrapper_gem/_main.erb
184
- - templates/cloud/wrapper_gem/client_test.erb
185
- - templates/cloud/wrapper_gem/entrypoint.erb
186
- - templates/cloud/wrapper_gem/gemfile.erb
187
- - templates/cloud/wrapper_gem/gemspec.erb
188
- - templates/cloud/wrapper_gem/main.erb
189
- - templates/cloud/wrapper_gem/rakefile.erb
190
- - templates/cloud/wrapper_gem/readme.erb
191
- - templates/cloud/wrapper_gem/rubocop.erb
192
- - templates/cloud/wrapper_gem/version_test.erb
193
- - templates/cloud/wrapper_gem/yardopts-cloudrad.erb
194
- - templates/cloud/wrapper_gem/yardopts.erb
52
+ - lib/gapic/presenters/wrapper_service_rest_presenter.rb
53
+ - templates/cloud/gem/authentication.text.erb
54
+ - templates/cloud/gem/gitignore.text.erb
55
+ - templates/cloud/gem/license.text.erb
56
+ - templates/cloud/gem/rakefile.text.erb
57
+ - templates/cloud/gem/readme.text.erb
58
+ - templates/cloud/gem/repo-metadata.text.erb
59
+ - templates/cloud/gem/rubocop.text.erb
60
+ - templates/cloud/gem/yardopts.text.erb
61
+ - templates/cloud/service/client/_credentials.text.erb
62
+ - templates/cloud/service/client/_requires.text.erb
63
+ - templates/cloud/service/client/_self_configure.text.erb
64
+ - templates/cloud/service/client/method/def/_rescue.text.erb
65
+ - templates/cloud/service/client/method/docs/_error.text.erb
66
+ - templates/cloud/service/rest/client/method/def/_rescue.text.erb
67
+ - templates/cloud/service/rest/client/method/docs/_error.text.erb
68
+ - templates/cloud/shared/_license.text.erb
69
+ - templates/cloud/wrapper_gem/_main.text.erb
70
+ - templates/cloud/wrapper_gem/client_test.text.erb
71
+ - templates/cloud/wrapper_gem/entrypoint.text.erb
72
+ - templates/cloud/wrapper_gem/gemfile.text.erb
73
+ - templates/cloud/wrapper_gem/gemspec.text.erb
74
+ - templates/cloud/wrapper_gem/main.text.erb
75
+ - templates/cloud/wrapper_gem/rakefile.text.erb
76
+ - templates/cloud/wrapper_gem/readme.text.erb
77
+ - templates/cloud/wrapper_gem/rubocop.text.erb
78
+ - templates/cloud/wrapper_gem/version_test.text.erb
79
+ - templates/cloud/wrapper_gem/yardopts.text.erb
195
80
  homepage: https://github.com/googleapis/gapic-generator-ruby
196
81
  licenses:
197
82
  - Apache-2.0
198
83
  metadata: {}
199
- post_install_message:
200
84
  rdoc_options: []
201
85
  require_paths:
202
86
  - lib
@@ -204,15 +88,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
204
88
  requirements:
205
89
  - - ">="
206
90
  - !ruby/object:Gem::Version
207
- version: '2.5'
91
+ version: '3.1'
208
92
  required_rubygems_version: !ruby/object:Gem::Requirement
209
93
  requirements:
210
94
  - - ">="
211
95
  - !ruby/object:Gem::Version
212
96
  version: '0'
213
97
  requirements: []
214
- rubygems_version: 3.1.2
215
- signing_key:
98
+ rubygems_version: 3.6.8
216
99
  specification_version: 4
217
100
  summary: An API Client Generator for Ruby in Ruby!
218
101
  test_files: []
@@ -1,174 +0,0 @@
1
- <%- assert_locals gem -%>
2
- <%- service = gem.first_non_common_service.usable_service_presenter -%>
3
- <%- assert_locals service -%>
4
- # Authentication
5
-
6
- In general, the <%= gem.name %> library uses
7
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
8
- credentials to connect to Google Cloud services. When running within
9
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
10
- 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
13
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
14
- for the account (or the JSON itself) in
15
- [environment variables](#environment-variables). Additionally, Cloud SDK
16
- credentials can also be discovered automatically, but this is only recommended
17
- during development.
18
-
19
- ## Quickstart
20
-
21
- 1. [Create a service account and credentials](#creating-a-service-account).
22
- 2. Set the [environment variable](#environment-variables).
23
-
24
- ```sh
25
- export <%= gem.cloud_env_prefix %>_CREDENTIALS=path/to/keyfile.json
26
- ```
27
-
28
- 3. Initialize the client.
29
-
30
- ```ruby
31
- require "<%= gem.entrypoint_require %>"
32
-
33
- client = <%= service.create_client_call %>
34
- ```
35
-
36
- ## Credential Lookup
37
-
38
- The <%= gem.name %> library aims to make authentication
39
- as simple as possible, and provides several mechanisms to configure your system
40
- without requiring **Service Account Credentials** directly in code.
41
-
42
- **Credentials** are discovered in the following order:
43
-
44
- 1. Specify credentials in method arguments
45
- 2. Specify credentials in configuration
46
- 3. Discover credentials path in environment variables
47
- 4. Discover credentials JSON in environment variables
48
- 5. Discover credentials file in the Cloud SDK's path
49
- 6. Discover GCP credentials
50
-
51
- ### Google Cloud Platform environments
52
-
53
- When running on Google Cloud Platform (GCP), including Google Compute Engine
54
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
55
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
56
- Code should be written as if already authenticated.
57
-
58
- ### Environment Variables
59
-
60
- The **Credentials JSON** can be placed in environment variables instead of
61
- declaring them directly in code. Each service has its own environment variable,
62
- allowing for different service accounts to be used for different services. (See
63
- the READMEs for the individual service gems for details.) The path to the
64
- **Credentials JSON** file can be stored in the environment variable, or the
65
- **Credentials JSON** itself can be stored for environments such as Docker
66
- containers where writing files is difficult or not encouraged.
67
-
68
- The environment variables that <%= gem.name %>
69
- checks for credentials are configured on the service Credentials class (such as
70
- <%= service.credentials_class_xref %>):
71
-
72
- <%- if gem.env_prefix -%>
73
- * `<%= gem.env_prefix %>_CREDENTIALS` - Path to JSON file, or JSON contents
74
- * `<%= gem.env_prefix %>_KEYFILE` - Path to JSON file, or JSON contents
75
- <%- end -%>
76
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
77
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
78
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
79
-
80
- ```ruby
81
- require "<%= gem.entrypoint_require %>"
82
-
83
- ENV["<%= gem.cloud_env_prefix %>_CREDENTIALS"] = "path/to/keyfile.json"
84
-
85
- client = <%= service.create_client_call %>
86
- ```
87
-
88
- ### Configuration
89
-
90
- The path to the **Credentials JSON** file can be configured instead of storing
91
- it in an environment variable. Either on an individual client initialization:
92
-
93
- ```ruby
94
- require "<%= gem.entrypoint_require %>"
95
-
96
- client = <%= service.create_client_call %> do |config|
97
- config.credentials = "path/to/keyfile.json"
98
- end
99
- ```
100
-
101
- Or globally for all clients:
102
-
103
- ```ruby
104
- require "<%= gem.entrypoint_require %>"
105
-
106
- <%= service.configure_client_call %> do |config|
107
- config.credentials = "path/to/keyfile.json"
108
- end
109
-
110
- client = <%= service.create_client_call %>
111
- ```
112
-
113
- ### Cloud SDK
114
-
115
- This option allows for an easy way to authenticate during development. If
116
- credentials are not provided in code or in environment variables, then Cloud SDK
117
- credentials are discovered.
118
-
119
- To configure your system for this, simply:
120
-
121
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
122
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
123
- 3. Write code as if already authenticated.
124
-
125
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
126
- *should* only be used during development.
127
-
128
- [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
129
- [dev-console]: https://console.cloud.google.com/project
130
-
131
- [enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
132
-
133
- [create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
134
- [create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
135
- [reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
136
-
137
- ## Creating a Service Account
138
-
139
- Google Cloud requires **Service Account Credentials** to
140
- connect to the APIs. You will use the **JSON key file** to
141
- connect to most services with <%= gem.name %>.
142
-
143
- If you are not running this client within
144
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
145
- need a Google Developers service account.
146
-
147
- 1. Visit the [Google Developers Console][dev-console].
148
- 2. Create a new project or click on an existing project.
149
- 3. Activate the slide-out navigation tray and select **API Manager**. From
150
- here, you will enable the APIs that your application requires.
151
-
152
- ![Enable the APIs that your application requires][enable-apis]
153
-
154
- *Note: You may need to enable billing in order to use these services.*
155
-
156
- 4. Select **Credentials** from the side navigation.
157
-
158
- You should see a screen like one of the following.
159
-
160
- ![Create a new service account][create-new-service-account]
161
-
162
- ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
163
-
164
- Find the "Add credentials" drop down and select "Service account" to be
165
- guided through downloading a new JSON key file.
166
-
167
- If you want to re-use an existing service account, you can easily generate a
168
- new key file. Just select the account you wish to re-use, and click "Generate
169
- new JSON key":
170
-
171
- ![Re-use an existing service account][reuse-service-account]
172
-
173
- The key file you download will be used by this library to authenticate API
174
- requests and should be stored in a secure location.
@@ -1,15 +0,0 @@
1
- <%- assert_locals gem -%>
2
- --no-private
3
- --title=<%= gem.title %> API
4
- --exclude _pb\.rb$
5
- --format yaml
6
- --template-path ../template
7
-
8
- ./lib/**/*.rb
9
- ./proto_docs/**/*.rb
10
- -
11
- README.md
12
- LICENSE.md
13
- <%- unless gem.generic_endpoint? -%>
14
- AUTHENTICATION.md
15
- <%- end -%>
@@ -1,4 +0,0 @@
1
- <%- assert_locals method -%>
2
- rescue ::Faraday::Error => e
3
- gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
4
- raise ::Google::Cloud::Error.from_error(gapic_error)
@@ -1,22 +0,0 @@
1
- <%- assert_locals gem -%>
2
- <%= render partial: "shared/header" -%>
3
-
4
- require "helper"
5
- require "<%= gem.namespace_require %>"
6
- require "gapic/common"
7
- require "gapic/grpc"
8
-
9
- class <%= gem.namespace %>::ClientConstructionMinitest < Minitest::Test
10
- <%- gem.services.each do |service| -%>
11
- def test_<%= service.factory_method_name %>
12
- Gapic::ServiceStub.stub :new, :stub do
13
- grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure
14
- client = <%= gem.namespace %>.<%= service.factory_method_name %> do |config|
15
- config.credentials = grpc_channel
16
- end
17
- assert_kind_of <%= gem.namespaced_class "#{service.module_name}::Client", version: gem.default_version %>, client
18
- end
19
- end
20
-
21
- <%- end -%>
22
- end
@@ -1,8 +0,0 @@
1
- <%- assert_locals gem -%>
2
- source "https://rubygems.org"
3
-
4
- gemspec
5
-
6
- <%- gem.versioned_gems.each do |name| -%>
7
- gem "<%= name %>", path: "../<%= name %>"
8
- <%- end -%>
@@ -1,17 +0,0 @@
1
- <%- assert_locals gem -%>
2
- --no-private
3
- --title=<%= gem.title %> API
4
- --exclude _pb\.rb$
5
- --format yaml
6
- --template-path ../template
7
-
8
- ./lib/**/*.rb
9
- -
10
- README.md
11
- <%- unless gem.generic_endpoint? -%>
12
- AUTHENTICATION.md
13
- <%- end -%>
14
- <%- if gem.migration? -%>
15
- MIGRATING.md
16
- <%- end -%>
17
- LICENSE.md