gapic-generator-cloud 0.8.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac86ed068a512a634033c1c1d15336857f9d3cc4fdc3818e37d339dc80df7814
-  data.tar.gz: 19553dab1dc41089de60dd030760e362d14335575283f8d3229acfeb018c4615
+  metadata.gz: e19aa05da89d8cd2c3786a6b8df6aabdf3a1e350a759d693f157f7aa97403da5
+  data.tar.gz: 686c3ec9da22e5d3d6de80c53ba6ff7f98cbf32ae92dc60a91f62dee5849b15b
 SHA512:
-  metadata.gz: 014b1551a395518c0da9182cda3d183040af720bb47079c68325597bb44baa251a634c697feacd19fdf20ec53430837a6efbd36bc75f8d8214d44ba4b4a0c7fb
-  data.tar.gz: 398bc287670e347e178c6e7e84c604866162e1e69733cdc72311ef98832c9a783b8956a14f9695d5a178117dbfb01d260eb5e45d2717fa2997d9233fa6b13724
+  metadata.gz: 5040c06a7e04e7d8a1f020bfe3332495ad1c346966237d14e813442b58416ff332eb955443191328c68b0ee35de907f0587d5b821d6015d86b7ce11dd96747cf
+  data.tar.gz: 36d887e5fd2669fe1220f8a57816b1f06efd3a100ff18c9882458bfd57d364a618d8e76be2b514adf1596af1a6554f416fe38881767b98e8b9d7909bffb5bdd9

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Release History for gapic-generator-cloud
 
+### 0.10.1 / 2021-08-27
+
+* Includes changes from gapic-generator 0.10.1
+
+### 0.10.0 / 2021-08-09
+
+* Includes changes from gapic-generator 0.10.0
+
+### 0.9.2 / 2021-07-07
+
+* Includes changes from gapic-generator 0.9.2
+* Disable Style/BlockDelimiters check for sample acceptance tests
+* Flags `--ruby-cloud-generate-standalone-snippets` and `--ruby-cloud-generate-yardoc-snippets` are now recognized
+
+### 0.9.1 / 2021-07-07
+
+* Includes changes from gapic-generator 0.9.1
+* Clarify some text in generated authentication docs
+
+### 0.9.0 / 2021-06-29
+
+* Includes changes from gapic-generator 0.9.0
+
 ### 0.8.0 / 2021-06-16
 
 * Includes changes from gapic-generator 0.8.0

data/lib/gapic/generator/cloud/version.rb

@@ -18,7 +18,7 @@
 module Gapic
   module Generator
     module Cloud
-      VERSION = "0.8.0"
+      VERSION = "0.10.1"
     end
   end
 end

data/lib/gapic/generators/cloud_generator_parameters.rb

@@ -21,10 +21,12 @@ module Gapic
     # Contains the cloud generator's parameters
     module CloudGeneratorParameters
       BOOL_PARAMETERS_ALIASES = {
-        "ruby-cloud-free-tier"         => ":gem.:free_tier",
-        "ruby-cloud-yard-strict"       => ":gem.:yard_strict",
-        "ruby-cloud-generic-endpoint"  => ":gem.:generic_endpoint",
-        "ruby-cloud-generate-metadata" => ":generate_metadata"
+        "ruby-cloud-free-tier"                    => ":gem.:free_tier",
+        "ruby-cloud-yard-strict"                  => ":gem.:yard_strict",
+        "ruby-cloud-generic-endpoint"             => ":gem.:generic_endpoint",
+        "ruby-cloud-generate-metadata"            => ":generate_metadata",
+        "ruby-cloud-generate-standalone-snippets" => ":generate_standalone_snippets",
+        "ruby-cloud-generate-yardoc-snippets"     => ":generate_yardoc_snippets"
       }.freeze
 
       STRING_PARAMETERS_ALIASES = {
@@ -42,6 +44,8 @@ module Gapic
         "ruby-cloud-api-id"                => ":gem.:api_id",
         "ruby-cloud-api-shortname"         => ":gem.:api_shortname",
         "ruby-cloud-factory-method-suffix" => ":gem.:factory_method_suffix",
+        "ruby-cloud-quick-start-service"   => ":gem.:quick_start_service",
+        "ruby-cloud-quick-start-method"    => ":gem.:quick_start_method",
         "ruby-cloud-default-service-host"  => ":defaults.:service.:default_host",
         "ruby-cloud-grpc-service-config"   => "grpc_service_config",
         "ruby-cloud-wrapper-gem-override"  => ":overrides.:wrapper_gem_name"

data/lib/gapic/presenters/cloud_gem_presenter.rb

@@ -47,7 +47,7 @@ module Gapic
 
       ##
       # The name of the wrapper gem corresponding to this versioned gem
-      # @return [String, Nil]
+      # @return [String, nil]
       #
       def wrapper_name
         return @api.wrapper_gem_name_override if @api.wrapper_gem_name_override?
@@ -77,6 +77,10 @@ module Gapic
         desc
       end
 
+      def cloud_env_prefix
+        env_prefix || "GOOGLE_CLOUD"
+      end
+
       ##
       # Returns a hash of extra generator arguments to be rendered into the
       # repo-metadata.json file.
@@ -84,12 +88,14 @@ module Gapic
       def generator_args_for_metadata
         result = {}
         result["ruby-cloud-description"] = description
-        result["ruby-cloud-env-prefix"] = env_prefix
+        result["ruby-cloud-env-prefix"] = env_prefix if env_prefix
         result["ruby-cloud-product-url"] = product_documentation_url if product_documentation_url
         path_overrides = @api.overrides_of(:file_path).map { |k, v| "#{k}=#{v}" }.join ";"
         result["ruby-cloud-path-override"] = path_overrides unless path_overrides.empty?
         namespace_overrides = @api.overrides_of(:namespace).map { |k, v| "#{k}=#{v}" }.join ";"
         result["ruby-cloud-namespace-override"] = namespace_overrides unless namespace_overrides.empty?
+        service_overrides = @api.overrides_of(:service).map { |k, v| "#{k}=#{v}" }.join ";"
+        result["ruby-cloud-service-override"] = service_overrides unless service_overrides.empty?
         result
       end
     end

data/lib/gapic/presenters/wrapper_gem_presenter.rb

@@ -107,9 +107,18 @@ module Gapic
 
       def dependencies
         @dependencies ||= begin
-          deps = { "google-cloud-core" => "~> 1.5" }
+          deps = { "google-cloud-core" => "~> 1.6" }
           version_dependencies.each do |version, requirement|
-            deps["#{name}-#{version}"] = "~> #{requirement}"
+            # For pre-release dependencies on versioned clients, support both
+            # 0.x and 1.x versions to ease the transition to 1.0 (GA) releases
+            # for those dependencies. (Note the 0.x->1.0 transition is
+            # generally not breaking.)
+            deps["#{name}-#{version}"] =
+              if requirement.start_with? "0."
+                [">= #{requirement}", "< 2.a"]
+              else
+                "~> #{requirement}"
+              end
           end
           extra_deps = gem_config_dependencies
           deps.merge! extra_deps if extra_deps

data/templates/cloud/gem/authentication.erb

@@ -1,5 +1,5 @@
 <%- assert_locals gem -%>
-<%- service = gem.first_non_common_service -%>
+<%- service = gem.first_non_common_service.usable_service_presenter -%>
 <%- assert_locals service -%>
 # Authentication
 
@@ -22,7 +22,7 @@ during development.
 2. Set the [environment variable](#environment-variables).
 
 ```sh
-export <%= gem.env_prefix %>_CREDENTIALS=path/to/keyfile.json
+export <%= gem.cloud_env_prefix %>_CREDENTIALS=path/to/keyfile.json
 ```
 
 3. Initialize the client.
@@ -69,24 +69,26 @@ The environment variables that <%= gem.name %>
 checks for credentials are configured on the service Credentials class (such as
 <%= service.credentials_class_xref %>):
 
-1. `<%= gem.env_prefix %>_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `<%= gem.env_prefix %>_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+<%- if gem.env_prefix -%>
+* `<%= gem.env_prefix %>_CREDENTIALS` - Path to JSON file, or JSON contents
+* `<%= gem.env_prefix %>_KEYFILE` - Path to JSON file, or JSON contents
+<%- end -%>
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "<%= gem.entrypoint_require %>"
 
-ENV["<%= gem.env_prefix %>_CREDENTIALS"] = "path/to/keyfile.json"
+ENV["<%= gem.cloud_env_prefix %>_CREDENTIALS"] = "path/to/keyfile.json"
 
 client = <%= service.create_client_call %>
 ```
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "<%= gem.entrypoint_require %>"
@@ -96,7 +98,7 @@ client = <%= service.create_client_call %> do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "<%= gem.entrypoint_require %>"

data/templates/cloud/gem/rakefile.erb

@@ -56,29 +56,29 @@ task :acceptance, :project, :keyfile do |t, args|
   <%- if service && !gem.generic_endpoint? -%>
   project = args[:project]
   project ||=
-    ENV["<%= gem.env_prefix %>_TEST_PROJECT"] ||
+    ENV["<%= gem.cloud_env_prefix %>_TEST_PROJECT"] ||
     ENV["GCLOUD_TEST_PROJECT"]
   keyfile = args[:keyfile]
   keyfile ||=
-    ENV["<%= gem.env_prefix %>_TEST_KEYFILE"] ||
+    ENV["<%= gem.cloud_env_prefix %>_TEST_KEYFILE"] ||
     ENV["GCLOUD_TEST_KEYFILE"]
   if keyfile
     keyfile = File.read keyfile
   else
     keyfile ||=
-      ENV["<%= gem.env_prefix %>_TEST_KEYFILE_JSON"] ||
+      ENV["<%= gem.cloud_env_prefix %>_TEST_KEYFILE_JSON"] ||
       ENV["GCLOUD_TEST_KEYFILE_JSON"]
   end
   if project.nil? || keyfile.nil?
-    fail "You must provide a project and keyfile. e.g. rake acceptance[test123, /path/to/keyfile.json] or <%= gem.env_prefix %>_TEST_PROJECT=test123 <%= gem.env_prefix %>_TEST_KEYFILE=/path/to/keyfile.json rake acceptance"
+    fail "You must provide a project and keyfile. e.g. rake acceptance[test123, /path/to/keyfile.json] or <%= gem.cloud_env_prefix %>_TEST_PROJECT=test123 <%= gem.cloud_env_prefix %>_TEST_KEYFILE=/path/to/keyfile.json rake acceptance"
   end
   require "<%= service.credentials_require %>"
   <%= service.credentials_name_full %>.env_vars.each do |path|
     ENV[path] = nil
   end
-  ENV["<%= gem.env_prefix %>_PROJECT"] = project
-  ENV["<%= gem.env_prefix %>_TEST_PROJECT"] = project
-  ENV["<%= gem.env_prefix %>_KEYFILE_JSON"] = keyfile
+  ENV["<%= gem.cloud_env_prefix %>_PROJECT"] = project
+  ENV["<%= gem.cloud_env_prefix %>_TEST_PROJECT"] = project
+  ENV["<%= gem.cloud_env_prefix %>_KEYFILE_JSON"] = keyfile
 
   <%- end -%>
   Rake::Task["acceptance:run"].invoke

data/templates/cloud/gem/readme.erb

@@ -44,12 +44,12 @@ In order to use this library, you first need to go through the following steps:
 <%- if gem.packages? -%>
 ```ruby
 require "<%= gem.entrypoint_require %>"
-<%- service = gem.first_non_common_service -%>
-<%- method = service&.methods.first -%>
+<%- service = gem.quick_start_service.usable_service_presenter -%>
+<%- method = service&.quick_start_method -%>
 <%- if service && method -%>
 
 client = <%= service.create_client_call %>
-request = my_create_request
+request = <%= method.request_type %>.new # (request fields as keyword arguments...)
 response = client.<%= method.name %> request
 <%- end -%>
 ```
@@ -65,6 +65,7 @@ See also the [Product Documentation](<%= gem.product_documentation_url %>)
 for general usage information.
 
 <%- end -%>
+<%- if gem.show_grpc_logging_docs? -%>
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
@@ -91,6 +92,7 @@ module GRPC
 end
 ```
 
+<%- end -%>
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.5+.

data/templates/cloud/gem/rubocop.erb

@@ -9,6 +9,7 @@ AllCops:
     - "proto_docs/**/*"
     - "test/**/*"
     - "acceptance/**/*"
+    - "samples/acceptance/**/*"
     - "Rakefile"
 
 Layout/LineLength:

data/templates/cloud/service/client/_credentials.erb

@@ -13,13 +13,17 @@ class <%= service.credentials_name %> < ::Google::Auth::Credentials
   ]
   <%- end -%>
   self.env_vars = [
+    <%- if service.gem.env_prefix -%>
     "<%= service.gem.env_prefix %>_CREDENTIALS",
     "<%= service.gem.env_prefix %>_KEYFILE",
+    <%- end -%>
     "GOOGLE_CLOUD_CREDENTIALS",
     "GOOGLE_CLOUD_KEYFILE",
     "GCLOUD_KEYFILE",
+    <%- if service.gem.env_prefix -%>
     "<%= service.gem.env_prefix %>_CREDENTIALS_JSON",
     "<%= service.gem.env_prefix %>_KEYFILE_JSON",
+    <%- end -%>
     "GOOGLE_CLOUD_CREDENTIALS_JSON",
     "GOOGLE_CLOUD_KEYFILE_JSON",
     "GCLOUD_KEYFILE_JSON"

data/templates/cloud/wrapper_gem/rakefile.erb

@@ -56,29 +56,29 @@ desc "Run the <%= gem.name %> acceptance tests."
 task :acceptance, :project, :keyfile do |t, args|
   project = args[:project]
   project ||=
-    ENV["<%= gem.env_prefix %>_TEST_PROJECT"] ||
+    ENV["<%= gem.cloud_env_prefix %>_TEST_PROJECT"] ||
     ENV["GCLOUD_TEST_PROJECT"]
   keyfile = args[:keyfile]
   keyfile ||=
-    ENV["<%= gem.env_prefix %>_TEST_KEYFILE"] ||
+    ENV["<%= gem.cloud_env_prefix %>_TEST_KEYFILE"] ||
     ENV["GCLOUD_TEST_KEYFILE"]
   if keyfile
     keyfile = File.read keyfile
   else
     keyfile ||=
-      ENV["<%= gem.env_prefix %>_TEST_KEYFILE_JSON"] ||
+      ENV["<%= gem.cloud_env_prefix %>_TEST_KEYFILE_JSON"] ||
       ENV["GCLOUD_TEST_KEYFILE_JSON"]
   end
   if project.nil? || keyfile.nil?
-    fail "You must provide a project and keyfile. e.g. rake acceptance[test123, /path/to/keyfile.json] or <%= gem.env_prefix %>_TEST_PROJECT=test123 <%= gem.env_prefix %>_TEST_KEYFILE=/path/to/keyfile.json rake acceptance"
+    fail "You must provide a project and keyfile. e.g. rake acceptance[test123, /path/to/keyfile.json] or <%= gem.cloud_env_prefix %>_TEST_PROJECT=test123 <%= gem.cloud_env_prefix %>_TEST_KEYFILE=/path/to/keyfile.json rake acceptance"
   end
   require "<%= service.credentials_require %>"
   <%= service.credentials_name_full %>.env_vars.each do |path|
     ENV[path] = nil
   end
-  ENV["<%= gem.env_prefix %>_PROJECT"] = project
-  ENV["<%= gem.env_prefix %>_TEST_PROJECT"] = project
-  ENV["<%= gem.env_prefix %>_KEYFILE_JSON"] = keyfile
+  ENV["<%= gem.cloud_env_prefix %>_PROJECT"] = project
+  ENV["<%= gem.cloud_env_prefix %>_TEST_PROJECT"] = project
+  ENV["<%= gem.cloud_env_prefix %>_KEYFILE_JSON"] = keyfile
 
   Rake::Task["acceptance:run"].invoke
 end

data/templates/cloud/wrapper_gem/rubocop.erb

@@ -34,3 +34,7 @@ Metrics/PerceivedComplexity:
 Naming/FileName:
   Exclude:
     - "lib/<%= gem.name %>.rb"
+
+Style/BlockDelimiters:
+  Exclude:
+    - "samples/**/acceptance/*.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator-cloud
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: An API Client Generator for Ruby in Ruby!