gapic-generator-cloud 0.6.6 → 0.6.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e359e61601902da9832af1c7ad6189098a9758d2030cbc000fedd1314022167
-  data.tar.gz: 2af72feba6c809ebf3ac4d6603a5e2443ab304747596373a2680b63d99718da4
+  metadata.gz: 2957bcfef6da89ca64200f8299f0f84767da2fa04830230dd9d2a27d43ecf2a5
+  data.tar.gz: 2d591da86b144ce9817d3a75d90084ea1b8d6b33e79e61ee3c90bffa3c3b412b
 SHA512:
-  metadata.gz: 7a3550151980f55d5a31e17e67226e8e0767af2ae0c993f8225056bfb96b94979966c207be0977b9e97e1289bdfb5db8ed9c525e214d762a96bc17fec19f1ea9
-  data.tar.gz: f3914d12bf66c93bfdec7ebccb13fd55f1d366b76c7053bc3cb87bbb347964d60b9b1142c53dffd80706cc6664eb9859913a5daafbf0aca491d136e9c4f94301
+  metadata.gz: 991ec0c1d722ff6a851ad908a2f003dddaeb1abfa0e035b939e293fa0914fcf1fd73444b8f86e1afa3cc74672f4780da91383e110a4787dbbecca94474b2bb9c
+  data.tar.gz: 22d52a0982fd15315f009fe2fac863c00985669cad9b5426e70a3a9e25e86927bc76f3f3ffe9da970eebcc42e1c22baf4028cb69e9a296f473aadaf422a4fb49

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Release History for gapic-generator-cloud
 
+### 0.6.11 / 2021-02-01
+
+* Includes changes from gapic-generator 0.6.11.
+* Updated generated readmes to cover main vs versioned clients.
+
+### 0.6.10 / 2021-01-13
+
+* Includes changes from gapic-generator 0.6.10.
+* A set of human-readable cloud-specific command-line parameters can now be specified for the gapic-generator-cloud, e.g. `ruby-cloud-gem-name`. These parameters strictly duplicate the existing behaviour of old command-line parameters, e.g. `:gem.:name`.
+
+### 0.6.9 / 2020-12-07
+
+* Includes changes from gapic-generator 0.6.9.
+
+### 0.6.8 / 2020-09-16
+
+* Includes changes from gapic-generator 0.6.8.
+
+### 0.6.7 / 2020-08-07
+
+* Includes changes from gapic-generator 0.6.7.
+
 ### 0.6.6 / 2020-08-05
 
 * Includes changes from gapic-generator 0.6.6.

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

@@ -18,7 +18,7 @@
 module Gapic
   module Generator
     module Cloud
-      VERSION = "0.6.6"
+      VERSION = "0.6.11"
     end
   end
 end

data/lib/gapic/generators/cloud_generator.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 require "gapic/generators/default_generator"
+require "gapic/generators/cloud_generator_parameters"
 require "gapic/presenters"
 require "gapic/presenters/cloud_gem_presenter"
 require "gapic/presenters/wrapper_gem_presenter"
@@ -101,6 +102,13 @@ module Gapic
 
       # rubocop:enable all
 
+      # Schema of the parameters that the generator accepts
+      # @return [Gapic::Schema::ParameterSchema]
+      def self.parameter_schema
+        CloudGeneratorParameters.default_schema
+      end
+
+
       private
 
       ##

data/lib/gapic/generators/cloud_generator_parameters.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "gapic/generators/default_generator_parameters"
+
+module Gapic
+  module Generators
+    # 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"
+      }.freeze
+
+      STRING_PARAMETERS_ALIASES = {
+        "ruby-cloud-gem-name"              => ":gem.:name",
+        "ruby-cloud-gem-namespace"         => ":gem.:namespace",
+        "ruby-cloud-title"                 => ":gem.:title",
+        "ruby-cloud-description"           => ":gem.:description",
+        "ruby-cloud-summary"               => ":gem.:summary",
+        "ruby-cloud-homepage"              => ":gem.:homepage",
+        "ruby-cloud-env-prefix"            => ":gem.:env_prefix",
+        "ruby-cloud-wrapper-of"            => ":gem.:version_dependencies",
+        "ruby-cloud-migration-version"     => ":gem.:migration_version",
+        "ruby-cloud-product-url"           => ":gem.:product_documentation_url",
+        "ruby-cloud-issues-url"            => ":gem.:issue_tracker_url",
+        "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-default-service-host"  => ":defaults.:service.:default_host",
+        "ruby-cloud-grpc-service-config"   => "grpc_service_config"
+      }.freeze
+
+      ARRAY_PARAMETERS_ALIASES = {
+        "ruby-cloud-default-oauth-scopes" => ":defaults.:service.:oauth_scopes"
+      }.freeze
+
+      MAP_PARAMETERS_ALIASES = {
+        "ruby-cloud-common-services"    => ":common_services",
+        "ruby-cloud-path-override"      => ":overrides.:file_path",
+        "ruby-cloud-namespace-override" => ":overrides.:namespace",
+        "ruby-cloud-service-override"   => ":overrides.:service",
+        "ruby-cloud-extra-dependencies" => ":gem.:extra_dependencies"
+      }.freeze
+
+      def self.default_schema
+        Gapic::Generators::DefaultGeneratorParameters.default_schema.extend_with_aliases(
+          bool_aliases:   BOOL_PARAMETERS_ALIASES,
+          string_aliases: STRING_PARAMETERS_ALIASES,
+          array_aliases:  ARRAY_PARAMETERS_ALIASES,
+          map_aliases:    MAP_PARAMETERS_ALIASES
+        )
+      end
+    end
+  end
+end

data/lib/gapic/presenters/cloud_gem_presenter.rb

@@ -37,6 +37,36 @@ module Gapic
         deps["google-cloud-errors"] = "~> 1.0"
         deps
       end
+
+      ##
+      # The name of the wrapper gem corresponding to this versioned gem
+      # @return [String]
+      #
+      def wrapper_name
+        minfo = /^(.+)-v\w+$/.match name
+        minfo ? minfo[1] : nil
+      end
+
+      alias_method :readme_description, :description # rubocop:disable Style/Alias
+
+      ##
+      # Overrides the gemspec description including a note that users should
+      # consider installing the wrapper instead of this versioned gem.
+      #
+      # Note: The method `readme_description` was aliased to the superclass
+      # method because the description without this note is used in the readme.
+      #
+      # @return [String]
+      #
+      def description
+        desc = readme_description
+        if wrapper_name
+          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
     end
 
     def self.cloud_gem_presenter api

data/lib/gapic/presenters/wrapper_gem_presenter.rb

@@ -101,6 +101,10 @@ module Gapic
         version_dependencies.first&.first
       end
 
+      def default_versioned_gem
+        versioned_gems.first
+      end
+
       def dependencies
         deps = { "google-cloud-core" => "~> 1.5" }
         version_dependencies.each do |version, requirement|

data/templates/cloud/gem/rakefile.erb

@@ -102,6 +102,40 @@ namespace :acceptance do
   end
 end
 
+task :samples do
+  Rake::Task["samples:latest"].invoke
+end
+
+namespace :samples do
+  task :latest do
+    if File.directory? "samples"
+      Dir.chdir "samples" do
+        Bundler.with_clean_env do
+          ENV["GOOGLE_CLOUD_SAMPLES_TEST"] = "not_master"
+          sh "bundle update"
+          sh "bundle exec rake test"
+        end
+      end
+    else
+      puts "The <%= gem.name %> gem has no samples to test."
+    end
+  end
+
+  task :master do
+    if File.directory? "samples"
+      Dir.chdir "samples" do
+        Bundler.with_clean_env do
+          ENV["GOOGLE_CLOUD_SAMPLES_TEST"] = "master"
+          sh "bundle update"
+          sh "bundle exec rake test"
+        end
+      end
+    else
+      puts "The <%= gem.name %> gem has no samples to test."
+    end
+  end
+end
+
 require "yard"
 require "yard/rake/yardoc_task"
 YARD::Rake::YardocTask.new do |y|

data/templates/cloud/gem/readme.erb

@@ -2,10 +2,18 @@
 
 <%= gem.summary %>
 
-<%= gem.description %>
+<%= gem.readme_description %>
 
 <%= gem.homepage %>
 
+<%- if gem.wrapper_name -%>
+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,
+[<%= gem.wrapper_name %>](https://rubygems.org/gems/<%= gem.wrapper_name %>).
+See the section below titled *Which client should I use?* for more information.
+
+<%- end -%>
 ## Installation
 
 ```
@@ -93,3 +101,63 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 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.
+<%- if gem.wrapper_name -%>
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `<%= gem.wrapper_name %>`,
+and lower-level _versioned_ client libraries with names such as
+`<%= gem.name %>`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`<%= gem.wrapper_name %>`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `<%= gem.name %>`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.
+<%- end -%>

data/templates/cloud/gem/rubocop.erb

@@ -28,6 +28,10 @@ Metrics/PerceivedComplexity:
 Naming/FileName:
   Exclude:
     - "lib/<%= gem.name %>.rb"
+Naming/PredicateName:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
 Style/CaseEquality:
   Enabled: false
 Style/IfUnlessModifier:

data/templates/cloud/wrapper_gem/_main.erb

@@ -76,8 +76,8 @@ end
 #   The library version as recorded in instrumentation and logging.
 # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
 #   An array of interceptors that are run before calls are executed.
-# * `timeout` (*type:* `Integer`) -
-#   Default timeout in milliseconds.
+# * `timeout` (*type:* `Numeric`) -
+#   Default timeout in seconds.
 # * `metadata` (*type:* `Hash{Symbol=>String}`) -
 #   Additional gRPC headers to be sent with the call.
 # * `retry_policy` (*type:* `Hash`) -

data/templates/cloud/wrapper_gem/readme.erb

@@ -6,9 +6,10 @@
 
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `<%= gem.name %>-v*`.
-The gem `<%= gem.name %>` is a convenience wrapper library that brings the
+The gem `<%= gem.name %>` is the main client library that brings the
 verisoned gems in as dependencies, and provides high-level methods for
-constructing clients.
+constructing clients. More information on versioned clients can be found below
+in the section titled *Which client should I use?*.
 
 View the [Client Library Documentation](<%= gem.library_documentation_url %>)
 for this library, <%= gem.name %>, to see the convenience methods for
@@ -95,3 +96,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 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.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `<%= gem.name %>`,
+and lower-level _versioned_ client libraries with names such as
+`<%= gem.default_versioned_gem %>`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`<%= gem.name %>`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `<%= gem.default_versioned_gem %>`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/templates/cloud/wrapper_gem/rubocop.erb

@@ -21,3 +21,6 @@ Metrics/BlockLength:
 Naming/FileName:
   Exclude:
     - "lib/<%= gem.name %>.rb"
+
+Style/AsciiComments:
+  Enabled: false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator-cloud
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.6.11
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2021-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: 0.6.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: 0.6.11
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +159,7 @@ files:
 - cloud-rubocop.yml
 - lib/gapic/generator/cloud/version.rb
 - lib/gapic/generators/cloud_generator.rb
+- lib/gapic/generators/cloud_generator_parameters.rb
 - lib/gapic/presenters/cloud_gem_presenter.rb
 - lib/gapic/presenters/wrapper_gem_presenter.rb
 - lib/gapic/presenters/wrapper_service_presenter.rb
@@ -206,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: An API Client Generator for Ruby in Ruby!