gapic-generator-cloud 0.7.2 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4bffd3280586491e1757835aa38ca85b373970d5ecb88a0fda8d5ea6e259fdf
-  data.tar.gz: 18bfa846048015823c294f296486862adf5a722c8a762d461b87c47f854ac83f
+  metadata.gz: f1eea0abf892b4a55303e5b4a2c34502221507204e9a20f5aa87f7a1e1965eb7
+  data.tar.gz: 1485bdadd75c11011b395cf3b025ef59772ec0e9fe410460dab4ee9d1fcdc14d
 SHA512:
-  metadata.gz: 4a9824a7a6856ad8f21cb36548ac50c4336d9189c12a2e38e7f429459d6f480bc99d0fc8b721f4c23839c9d0c41ae95346d740eb3cddc91949ad30a1a8deadf7
-  data.tar.gz: 5935a2546b5f8eaa34511f554ca5080a0b3cd7fca8a4caac8267f0f7c59c964e1089f38ffbda8a777d8803f4a9f12e1bfcf2ff22a755661c273effd0160ade97
+  metadata.gz: f58c889e346aa2ed848d01370f78ec7905342a3e55de9cedbec1f2fe40bc85a847c1782bcba731b537db0c9134ea0826877bf7916bf7c79e80c0e094c5e7ebf4
+  data.tar.gz: cb7fa4c07625fcd9ccdd85e2547abf6b13a2c691bce3dfcda86600c84e96f034c20b82d7790cccc661794e9a14f7fbc6e173b207f22580660990847346d0153f

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Release History for gapic-generator-cloud
 
+### 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
+
+### 0.7.5 / 2021-05-18
+
+* Includes changes from gapic-generator 0.7.5
+
+### 0.7.4 / 2021-05-07
+
+* Includes changes from gapic-generator 0.7.4
+
+### 0.7.3 / 2021-03-24
+
+* Includes changes from gapic-generator 0.7.3
+* Gapic metadata file generation is enabled by default for gapic-generator-cloud
+
 ### 0.7.2 / 2021-03-05
 
 * Disable metrics-related rubocop checks in generated wrapper libraries.

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

@@ -18,7 +18,7 @@
 module Gapic
   module Generator
     module Cloud
-      VERSION = "0.7.2"
+      VERSION = "0.9.1"
     end
   end
 end

data/lib/gapic/generators/cloud_generator.rb

@@ -33,6 +33,11 @@ module Gapic
         gem_config = api.configuration[:gem] ||= {}
         gem_config[:homepage] ||= "https://github.com/googleapis/google-cloud-ruby"
 
+        # The gapic metadata generation is disabled by default as per spec.
+        # However it should be enabled by default for cloud libraries, otherwise we'll have to
+        # enable it in every synth/bazel file.
+        api.configuration[:generate_metadata] = true if api.configuration[:generate_metadata].nil?
+
         super
 
         # Configure to use prefer Google Cloud templates

data/lib/gapic/generators/cloud_generator_parameters.rb

@@ -21,9 +21,10 @@ 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-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"
       }.freeze
 
       STRING_PARAMETERS_ALIASES = {
@@ -41,12 +42,16 @@ 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-grpc-service-config"   => "grpc_service_config",
+        "ruby-cloud-wrapper-gem-override"  => ":overrides.:wrapper_gem_name"
       }.freeze
 
       ARRAY_PARAMETERS_ALIASES = {
-        "ruby-cloud-default-oauth-scopes" => ":defaults.:service.:oauth_scopes"
+        "ruby-cloud-default-oauth-scopes" => ":defaults.:service.:oauth_scopes",
+        "ruby-cloud-generate-transports"  => ":transports"
       }.freeze
 
       MAP_PARAMETERS_ALIASES = {

data/lib/gapic/presenters/cloud_gem_presenter.rb

@@ -38,11 +38,20 @@ module Gapic
         deps
       end
 
+      ##
+      # Whether this gem has a wrapper
+      # @return [Boolean]
+      def has_wrapper?
+        !wrapper_name.nil?
+      end
+
       ##
       # The name of the wrapper gem corresponding to this versioned gem
-      # @return [String]
+      # @return [String, Nil]
       #
       def wrapper_name
+        return @api.wrapper_gem_name_override if @api.wrapper_gem_name_override?
+
         minfo = /^(.+)-v\d\w*$/.match name
         minfo ? minfo[1] : nil
       end
@@ -60,13 +69,35 @@ module Gapic
       #
       def description
         desc = readme_description
-        if wrapper_name
+        if has_wrapper?
           desc += " Note that #{name} is a version-specific client library." \
             " For most uses, we recommend installing the main client library" \
             " #{wrapper_name} instead. See the readme for more details."
         end
         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.
+      #
+      def generator_args_for_metadata
+        result = {}
+        result["ruby-cloud-description"] = description
+        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
 
     def self.cloud_gem_presenter api

data/lib/gapic/presenters/wrapper_gem_presenter.rb

@@ -106,13 +106,24 @@ module Gapic
       end
 
       def dependencies
-        deps = { "google-cloud-core" => "~> 1.5" }
-        version_dependencies.each do |version, requirement|
-          deps["#{name}-#{version}"] = "~> #{requirement}"
+        @dependencies ||= begin
+          deps = { "google-cloud-core" => "~> 1.6" }
+          version_dependencies.each do |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
+          deps
         end
-        extra_deps = gem_config :extra_dependencies
-        deps.merge! extra_deps if extra_deps
-        deps
       end
 
       def google_cloud_short_name

data/templates/cloud/gem/authentication.erb

@@ -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

@@ -6,7 +6,7 @@
 
 <%= gem.homepage %>
 
-<%- if gem.wrapper_name -%>
+<%- if gem.has_wrapper? -%>
 This gem is a _versioned_ client. It provides basic client classes for a
 specific version of the <%= gem.title %> API. Most users should consider using
 the main client gem,
@@ -36,7 +36,7 @@ In order to use this library, you first need to go through the following steps:
 <%- if gem.api_id -%>
 1. [Enable the API.](https://console.cloud.google.com/apis/library/<%= gem.api_id %>)
 <%- end -%>
-1. {file:AUTHENTICATION.md Set up authentication.}
+1. [Set up authentication.](AUTHENTICATION.md)
 
 <%- end -%>
 ## Quick Start
@@ -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 -%>
+<%- 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 -%>
 ```

data/templates/cloud/gem/repo-metadata.erb

@@ -17,5 +17,9 @@
     "product_documentation": "<%= gem.product_documentation_url %>",
 <%- end -%>
     "repo": "googleapis/google-cloud-ruby",
-    "requires_billing": <%= !gem.free_tier? %>
+    "requires_billing": <%= !gem.free_tier? %>,
+<%- gem.generator_args_for_metadata.each do |key, val| -%>
+    <%= key.inspect %>: <%= val.inspect %>,
+<%- end -%>
+    "library_type": "GAPIC_AUTO"
 }

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/service/rest/client/method/def/_rescue.erb

@@ -0,0 +1,4 @@
+ <%- assert_locals method -%>
+rescue ::Faraday::Error => e
+  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
+  raise ::Google::Cloud::Error.from_error(gapic_error)

data/templates/cloud/service/rest/client/method/docs/_error.erb

@@ -0,0 +1,2 @@
+<%- assert_locals method -%>
+# @raise [::Google::Cloud::Error] if the REST call is aborted.

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator-cloud
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.9.1
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +177,8 @@ files:
 - templates/cloud/service/client/_self_configure.erb
 - templates/cloud/service/client/method/def/_rescue.erb
 - templates/cloud/service/client/method/docs/_error.erb
+- templates/cloud/service/rest/client/method/def/_rescue.erb
+- templates/cloud/service/rest/client/method/docs/_error.erb
 - templates/cloud/shared/_license.erb
 - templates/cloud/wrapper_gem/_main.erb
 - templates/cloud/wrapper_gem/client_test.erb
@@ -209,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: An API Client Generator for Ruby in Ruby!