gapic-generator-cloud 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c751d7b581655b797aa620a09b6954f79d741075d443ece0938512e6a816a5db
-  data.tar.gz: dce39d1de70b9426ae427d076bce1150f362c466a49439ca99a73df54176fbf9
+  metadata.gz: ac86ed068a512a634033c1c1d15336857f9d3cc4fdc3818e37d339dc80df7814
+  data.tar.gz: 19553dab1dc41089de60dd030760e362d14335575283f8d3229acfeb018c4615
 SHA512:
-  metadata.gz: 4025efcd6b63862374feaf1b7fc49363cd8d1532d75a27f9246e383018d9cb62936ee6b0b1cb2c57f661a7746b44ecdd6d37189115cf3cb4406d21fd12834577
-  data.tar.gz: d9f83817a4799b72f615c2c34f47cbe2575aa97059ee9634e33a32880d6e3a0b9788d785515393598c116757044d17d2f5e6c0ce748ba1d16cfcf8f7bd643ef2
+  metadata.gz: 014b1551a395518c0da9182cda3d183040af720bb47079c68325597bb44baa251a634c697feacd19fdf20ec53430837a6efbd36bc75f8d8214d44ba4b4a0c7fb
+  data.tar.gz: 398bc287670e347e178c6e7e84c604866162e1e69733cdc72311ef98832c9a783b8956a14f9695d5a178117dbfb01d260eb5e45d2717fa2997d9233fa6b13724

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Release History for gapic-generator-cloud
 
+### 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.
+
+### 0.7.1 / 2021-02-27
+
+* Update generated readmes to reflect that Ruby 2.5 or later is now required.
+
 ### 0.7.0 / 2021-02-27
 
 * Includes changes from gapic-generator 0.7.0, notably dropping Ruby 2.4 support.

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

@@ -18,7 +18,7 @@
 module Gapic
   module Generator
     module Cloud
-      VERSION = "0.7.0"
+      VERSION = "0.8.0"
     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 = {
@@ -42,11 +43,13 @@ module Gapic
         "ruby-cloud-api-shortname"         => ":gem.:api_shortname",
         "ruby-cloud-factory-method-suffix" => ":gem.:factory_method_suffix",
         "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,29 @@ 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
+
+      ##
+      # 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
+        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?
+        result
+      end
     end
 
     def self.cloud_gem_presenter api

data/lib/gapic/presenters/wrapper_gem_presenter.rb

@@ -106,13 +106,15 @@ 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.5" }
+          version_dependencies.each do |version, requirement|
+            deps["#{name}-#{version}"] = "~> #{requirement}"
+          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/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
@@ -93,11 +93,11 @@ end
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.4+.
+This library is supported on Ruby 2.5+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.4
+in security maintenance, and not end of life. Currently, this means Ruby 2.5
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.

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/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/readme.erb

@@ -88,11 +88,11 @@ end
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.4+.
+This library is supported on Ruby 2.5+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.4
+in security maintenance, and not end of life. Currently, this means Ruby 2.5
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.

data/templates/cloud/wrapper_gem/rubocop.erb

@@ -13,10 +13,23 @@ Bundler/OrderedGems:
   Enabled: false
 Documentation:
   Enabled: false
-
+Layout/LineLength:
+  Enabled: false
 Metrics/BlockLength:
   Exclude:
     - "samples/**/acceptance/*.rb"
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
 
 Naming/FileName:
   Exclude:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator-cloud
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-27 00:00:00.000000000 Z
+date: 2021-06-16 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.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 - !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!