gapic-generator-cloud 0.6.8 → 0.6.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aa7c4a24544f54664242246b3bfe8bf9fdc59817ac65b35c3cfda9b2a6d6192
-  data.tar.gz: c34556e74d94196b68d75dfbaeb720a4f7e15d92e37d0b76e1680b06d727e947
+  metadata.gz: c3b3ebbc7732ba43bd59827bb83762589fa5f95ac37aa644d68d6f4b9b8547bd
+  data.tar.gz: e870d4229bb7b5a3b04ba7b32c61e1c5924556e280f4ae197364e1b02daceba7
 SHA512:
-  metadata.gz: 2fa164b71fc21d681ab356bed317e53922fe5702c9bccdbf6c0716fd03c0487aa5684d93bd9f8ce25967ff6c99f376ffa56b105653910f0c64a33f3cfd6ff7bf
-  data.tar.gz: 77a4cbd3376483742c3bb64a6733366830dfed5d4d3929c58dc30ce85af410f782954bf7ace21d3c4bb7ae89fa05b489f91f2a67ac538046622a36c1a3226c45
+  metadata.gz: d8297b2952f6ad21170822930d8e85a219bb33c4040b2748ffac6ae17e4543657176066dfd43d0fb01cd29c428235f80cf62bde55406430f98d0cfd293a9c266
+  data.tar.gz: 2641b83f2217f920e543928db606930d6201134b53a46cefd4b423542f00bff6502f8326efb3f5bace1f54029b4d9b581d44aab1b179c82490d18fedc57ba4f6

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Release History for gapic-generator-cloud
 
+### 0.6.13 / 2021-02-22
+
+* Includes changes from gapic-generator 0.6.13.
+* Fixed formatting of generated Apache license files.
+* Generate Rake task and special yardopts file for Cloud RAD.
+* Executable entrypoints set the default external locale to utf-8.
+
+### 0.6.12 / 2021-02-01
+
+* Fixed a bug in the identification of versioned clients that incorrectly flagged `google-cloud-vision`.
+
+### 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.

data/bin/protoc-gen-bazel_ruby_cloud

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S ruby -E UTF-8
 # frozen_string_literal: true
 
 # Copyright 2020 Google LLC

data/bin/protoc-gen-ruby_cloud

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S ruby -E UTF-8
 # frozen_string_literal: true
 
 # Copyright 2018 Google LLC

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

@@ -18,7 +18,7 @@
 module Gapic
   module Generator
     module Cloud
-      VERSION = "0.6.8"
+      VERSION = "0.6.13"
     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"
@@ -76,23 +77,24 @@ module Gapic
 
         gem = Gapic::Presenters.wrapper_gem_presenter @api
 
-        files << g("gem/gitignore.erb",            ".gitignore",                                    gem: gem)
-        files << g("gem/repo-metadata.erb",        ".repo-metadata.json",                           gem: gem)
-        files << g("wrapper_gem/rubocop.erb",      ".rubocop.yml",                                  gem: gem)
-        files << g("wrapper_gem/yardopts.erb",     ".yardopts",                                     gem: gem)
-        files << g("gem/authentication.erb",       "AUTHENTICATION.md",                             gem: gem) unless gem.generic_endpoint?
-        files << g("gem/changelog.erb",            "CHANGELOG.md",                                  gem: gem)
-        files << g("wrapper_gem/gemfile.erb",      "Gemfile",                                       gem: gem)
-        files << g("gem/license.erb",              "LICENSE.md",                                    gem: gem)
-        files << g("wrapper_gem/rakefile.erb",     "Rakefile",                                      gem: gem)
-        files << g("wrapper_gem/readme.erb",       "README.md",                                     gem: gem)
-        files << g("wrapper_gem/gemspec.erb",      "#{gem.name}.gemspec",                           gem: gem)
-        files << g("wrapper_gem/entrypoint.erb",   "lib/#{gem.name}.rb",                            gem: gem) if gem.needs_entrypoint?
-        files << g("wrapper_gem/main.erb",         "lib/#{gem.namespace_file_path}",                gem: gem)
-        files << g("gem/version.erb",              "lib/#{gem.version_file_path}",                  gem: gem)
-        files << g("gem/test_helper.erb",          "test/helper.rb",                                gem: gem)
-        files << g("wrapper_gem/client_test.erb",  "test/#{gem.namespace_require}/client_test.rb",  gem: gem)
-        files << g("wrapper_gem/version_test.erb", "test/#{gem.namespace_require}/version_test.rb", gem: gem)
+        files << g("gem/gitignore.erb",                 ".gitignore",                                    gem: gem)
+        files << g("gem/repo-metadata.erb",             ".repo-metadata.json",                           gem: gem)
+        files << g("wrapper_gem/rubocop.erb",           ".rubocop.yml",                                  gem: gem)
+        files << g("wrapper_gem/yardopts.erb",          ".yardopts",                                     gem: gem)
+        files << g("wrapper_gem/yardopts-cloudrad.erb", ".yardopts-cloudrad",                            gem: gem)
+        files << g("gem/authentication.erb",            "AUTHENTICATION.md",                             gem: gem) unless gem.generic_endpoint?
+        files << g("gem/changelog.erb",                 "CHANGELOG.md",                                  gem: gem)
+        files << g("wrapper_gem/gemfile.erb",           "Gemfile",                                       gem: gem)
+        files << g("gem/license.erb",                   "LICENSE.md",                                    gem: gem)
+        files << g("wrapper_gem/rakefile.erb",          "Rakefile",                                      gem: gem)
+        files << g("wrapper_gem/readme.erb",            "README.md",                                     gem: gem)
+        files << g("wrapper_gem/gemspec.erb",           "#{gem.name}.gemspec",                           gem: gem)
+        files << g("wrapper_gem/entrypoint.erb",        "lib/#{gem.name}.rb",                            gem: gem) if gem.needs_entrypoint?
+        files << g("wrapper_gem/main.erb",              "lib/#{gem.namespace_file_path}",                gem: gem)
+        files << g("gem/version.erb",                   "lib/#{gem.version_file_path}",                  gem: gem)
+        files << g("gem/test_helper.erb",               "test/helper.rb",                                gem: gem)
+        files << g("wrapper_gem/client_test.erb",       "test/#{gem.namespace_require}/client_test.rb",  gem: gem)
+        files << g("wrapper_gem/version_test.erb",      "test/#{gem.namespace_require}/version_test.rb", gem: gem)
 
         format_files files
 
@@ -101,6 +103,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\d\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/license.erb

@@ -1,193 +1,191 @@
 <%- assert_locals gem -%>
-Apache License
-==============
-
-* Version 2.0, January 2004
-* https://www.apache.org/licenses/
-
-### TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. **Definitions.**
-
-    "License" shall mean the terms and conditions for use, reproduction,
-    and distribution as defined by Sections 1 through 9 of this document.
-
-    "Licensor" shall mean the copyright owner or entity authorized by
-    the copyright owner that is granting the License.
-
-    "Legal Entity" shall mean the union of the acting entity and all
-    other entities that control, are controlled by, or are under common
-    control with that entity. For the purposes of this definition,
-    "control" means (i) the power, direct or indirect, to cause the
-    direction or management of such entity, whether by contract or
-    otherwise, or (ii) ownership of fifty percent (50%) or more of the
-    outstanding shares, or (iii) beneficial ownership of such entity.
-
-    "You" (or "Your") shall mean an individual or Legal Entity
-    exercising permissions granted by this License.
-
-    "Source" form shall mean the preferred form for making modifications,
-    including but not limited to software source code, documentation
-    source, and configuration files.
-
-    "Object" form shall mean any form resulting from mechanical
-    transformation or translation of a Source form, including but
-    not limited to compiled object code, generated documentation,
-    and conversions to other media types.
-
-    "Work" shall mean the work of authorship, whether in Source or
-    Object form, made available under the License, as indicated by a
-    copyright notice that is included in or attached to the work
-    (an example is provided in the Appendix below).
-
-    "Derivative Works" shall mean any work, whether in Source or Object
-    form, that is based on (or derived from) the Work and for which the
-    editorial revisions, annotations, elaborations, or other modifications
-    represent, as a whole, an original work of authorship. For the purposes
-    of this License, Derivative Works shall not include works that remain
-    separable from, or merely link (or bind by name) to the interfaces of,
-    the Work and Derivative Works thereof.
-
-    "Contribution" shall mean any work of authorship, including
-    the original version of the Work and any modifications or additions
-    to that Work or Derivative Works thereof, that is intentionally
-    submitted to Licensor for inclusion in the Work by the copyright owner
-    or by an individual or Legal Entity authorized to submit on behalf of
-    the copyright owner. For the purposes of this definition, "submitted"
-    means any form of electronic, verbal, or written communication sent
-    to the Licensor or its representatives, including but not limited to
-    communication on electronic mailing lists, source code control systems,
-    and issue tracking systems that are managed by, or on behalf of, the
-    Licensor for the purpose of discussing and improving the Work, but
-    excluding communication that is conspicuously marked or otherwise
-    designated in writing by the copyright owner as "Not a Contribution."
-
-    "Contributor" shall mean Licensor and any individual or Legal Entity
-    on behalf of whom a Contribution has been received by Licensor and
-    subsequently incorporated within the Work.
-
- 2. **Grant of Copyright License.** Subject to the terms and conditions of
-    this License, each Contributor hereby grants to You a perpetual,
-    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-    copyright license to reproduce, prepare Derivative Works of,
-    publicly display, publicly perform, sublicense, and distribute the
-    Work and such Derivative Works in Source or Object form.
-
- 3. **Grant of Patent License.** Subject to the terms and conditions of
-    this License, each Contributor hereby grants to You a perpetual,
-    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-    (except as stated in this section) patent license to make, have made,
-    use, offer to sell, sell, import, and otherwise transfer the Work,
-    where such license applies only to those patent claims licensable
-    by such Contributor that are necessarily infringed by their
-    Contribution(s) alone or by combination of their Contribution(s)
-    with the Work to which such Contribution(s) was submitted. If You
-    institute patent litigation against any entity (including a
-    cross-claim or counterclaim in a lawsuit) alleging that the Work
-    or a Contribution incorporated within the Work constitutes direct
-    or contributory patent infringement, then any patent licenses
-    granted to You under this License for that Work shall terminate
-    as of the date such litigation is filed.
-
- 4. **Redistribution.** You may reproduce and distribute copies of the
-    Work or Derivative Works thereof in any medium, with or without
-    modifications, and in Source or Object form, provided that You
-    meet the following conditions:
-
-     *  **(a)** You must give any other recipients of the Work or
-        Derivative Works a copy of this License; and
-
-     *  **(b)** You must cause any modified files to carry prominent notices
-        stating that You changed the files; and
-
-     *  **(c)** You must retain, in the Source form of any Derivative Works
-        that You distribute, all copyright, patent, trademark, and
-        attribution notices from the Source form of the Work,
-        excluding those notices that do not pertain to any part of
-        the Derivative Works; and
-
-     *  **(d)** If the Work includes a "NOTICE" text file as part of its
-        distribution, then any Derivative Works that You distribute must
-        include a readable copy of the attribution notices contained
-        within such NOTICE file, excluding those notices that do not
-        pertain to any part of the Derivative Works, in at least one
-        of the following places: within a NOTICE text file distributed
-        as part of the Derivative Works; within the Source form or
-        documentation, if provided along with the Derivative Works; or,
-        within a display generated by the Derivative Works, if and
-        wherever such third-party notices normally appear. The contents
-        of the NOTICE file are for informational purposes only and
-        do not modify the License. You may add Your own attribution
-        notices within Derivative Works that You distribute, alongside
-        or as an addendum to the NOTICE text from the Work, provided
-        that such additional attribution notices cannot be construed
-        as modifying the License.
-
-    You may add Your own copyright statement to Your modifications and
-    may provide additional or different license terms and conditions
-    for use, reproduction, or distribution of Your modifications, or
-    for any such Derivative Works as a whole, provided Your use,
-    reproduction, and distribution of the Work otherwise complies with
-    the conditions stated in this License.
-
- 5. **Submission of Contributions.** Unless You explicitly state otherwise,
-    any Contribution intentionally submitted for inclusion in the Work
-    by You to the Licensor shall be under the terms and conditions of
-    this License, without any additional terms or conditions.
-    Notwithstanding the above, nothing herein shall supersede or modify
-    the terms of any separate license agreement you may have executed
-    with Licensor regarding such Contributions.
-
- 6. **Trademarks.** This License does not grant permission to use the trade
-    names, trademarks, service marks, or product names of the Licensor,
-    except as required for reasonable and customary use in describing the
-    origin of the Work and reproducing the content of the NOTICE file.
-
- 7. **Disclaimer of Warranty.** Unless required by applicable law or
-    agreed to in writing, Licensor provides the Work (and each
-    Contributor provides its Contributions) on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-    implied, including, without limitation, any warranties or conditions
-    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-    PARTICULAR PURPOSE. You are solely responsible for determining the
-    appropriateness of using or redistributing the Work and assume any
-    risks associated with Your exercise of permissions under this License.
-
- 8. **Limitation of Liability.** In no event and under no legal theory,
-    whether in tort (including negligence), contract, or otherwise,
-    unless required by applicable law (such as deliberate and grossly
-    negligent acts) or agreed to in writing, shall any Contributor be
-    liable to You for damages, including any direct, indirect, special,
-    incidental, or consequential damages of any character arising as a
-    result of this License or out of the use or inability to use the
-    Work (including but not limited to damages for loss of goodwill,
-    work stoppage, computer failure or malfunction, or any and all
-    other commercial damages or losses), even if such Contributor
-    has been advised of the possibility of such damages.
-
- 9. **Accepting Warranty or Additional Liability.** While redistributing
-    the Work or Derivative Works thereof, You may choose to offer,
-    and charge a fee for, acceptance of support, warranty, indemnity,
-    or other liability obligations and/or rights consistent with this
-    License. However, in accepting such obligations, You may act only
-    on Your own behalf and on Your sole responsibility, not on behalf
-    of any other Contributor, and only if You agree to indemnify,
-    defend, and hold each Contributor harmless for any liability
-    incurred by, or claims asserted against, such Contributor by reason
-    of your accepting any such warranty or additional liability.
-
-_END OF TERMS AND CONDITIONS_
-
-### APPENDIX: How to apply the Apache License to your work.
-
-To apply the Apache License to your work, attach the following
-boilerplate notice, with the fields enclosed by brackets "`[]`"
-replaced with your own identifying information. (Don't include
-the brackets!)  The text should be enclosed in the appropriate
-comment syntax for the file format. We also recommend that a
-file or class name and description of purpose be included on the
-same "printed page" as the copyright notice for easier
-identification within third-party archives.
+                                  Apache License
+                            Version 2.0, January 2004
+                         http://www.apache.org/licenses/
+
+    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+       "License" shall mean the terms and conditions for use, reproduction,
+       and distribution as defined by Sections 1 through 9 of this document.
+
+       "Licensor" shall mean the copyright owner or entity authorized by
+       the copyright owner that is granting the License.
+
+       "Legal Entity" shall mean the union of the acting entity and all
+       other entities that control, are controlled by, or are under common
+       control with that entity. For the purposes of this definition,
+       "control" means (i) the power, direct or indirect, to cause the
+       direction or management of such entity, whether by contract or
+       otherwise, or (ii) ownership of fifty percent (50%) or more of the
+       outstanding shares, or (iii) beneficial ownership of such entity.
+
+       "You" (or "Your") shall mean an individual or Legal Entity
+       exercising permissions granted by this License.
+
+       "Source" form shall mean the preferred form for making modifications,
+       including but not limited to software source code, documentation
+       source, and configuration files.
+
+       "Object" form shall mean any form resulting from mechanical
+       transformation or translation of a Source form, including but
+       not limited to compiled object code, generated documentation,
+       and conversions to other media types.
+
+       "Work" shall mean the work of authorship, whether in Source or
+       Object form, made available under the License, as indicated by a
+       copyright notice that is included in or attached to the work
+       (an example is provided in the Appendix below).
+
+       "Derivative Works" shall mean any work, whether in Source or Object
+       form, that is based on (or derived from) the Work and for which the
+       editorial revisions, annotations, elaborations, or other modifications
+       represent, as a whole, an original work of authorship. For the purposes
+       of this License, Derivative Works shall not include works that remain
+       separable from, or merely link (or bind by name) to the interfaces of,
+       the Work and Derivative Works thereof.
+
+       "Contribution" shall mean any work of authorship, including
+       the original version of the Work and any modifications or additions
+       to that Work or Derivative Works thereof, that is intentionally
+       submitted to Licensor for inclusion in the Work by the copyright owner
+       or by an individual or Legal Entity authorized to submit on behalf of
+       the copyright owner. For the purposes of this definition, "submitted"
+       means any form of electronic, verbal, or written communication sent
+       to the Licensor or its representatives, including but not limited to
+       communication on electronic mailing lists, source code control systems,
+       and issue tracking systems that are managed by, or on behalf of, the
+       Licensor for the purpose of discussing and improving the Work, but
+       excluding communication that is conspicuously marked or otherwise
+       designated in writing by the copyright owner as "Not a Contribution."
+
+       "Contributor" shall mean Licensor and any individual or Legal Entity
+       on behalf of whom a Contribution has been received by Licensor and
+       subsequently incorporated within the Work.
+
+    2. Grant of Copyright License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       copyright license to reproduce, prepare Derivative Works of,
+       publicly display, publicly perform, sublicense, and distribute the
+       Work and such Derivative Works in Source or Object form.
+
+    3. Grant of Patent License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       (except as stated in this section) patent license to make, have made,
+       use, offer to sell, sell, import, and otherwise transfer the Work,
+       where such license applies only to those patent claims licensable
+       by such Contributor that are necessarily infringed by their
+       Contribution(s) alone or by combination of their Contribution(s)
+       with the Work to which such Contribution(s) was submitted. If You
+       institute patent litigation against any entity (including a
+       cross-claim or counterclaim in a lawsuit) alleging that the Work
+       or a Contribution incorporated within the Work constitutes direct
+       or contributory patent infringement, then any patent licenses
+       granted to You under this License for that Work shall terminate
+       as of the date such litigation is filed.
+
+    4. Redistribution. You may reproduce and distribute copies of the
+       Work or Derivative Works thereof in any medium, with or without
+       modifications, and in Source or Object form, provided that You
+       meet the following conditions:
+
+       (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+       (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+       (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+       (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+       You may add Your own copyright statement to Your modifications and
+       may provide additional or different license terms and conditions
+       for use, reproduction, or distribution of Your modifications, or
+       for any such Derivative Works as a whole, provided Your use,
+       reproduction, and distribution of the Work otherwise complies with
+       the conditions stated in this License.
+
+    5. Submission of Contributions. Unless You explicitly state otherwise,
+       any Contribution intentionally submitted for inclusion in the Work
+       by You to the Licensor shall be under the terms and conditions of
+       this License, without any additional terms or conditions.
+       Notwithstanding the above, nothing herein shall supersede or modify
+       the terms of any separate license agreement you may have executed
+       with Licensor regarding such Contributions.
+
+    6. Trademarks. This License does not grant permission to use the trade
+       names, trademarks, service marks, or product names of the Licensor,
+       except as required for reasonable and customary use in describing the
+       origin of the Work and reproducing the content of the NOTICE file.
+
+    7. Disclaimer of Warranty. Unless required by applicable law or
+       agreed to in writing, Licensor provides the Work (and each
+       Contributor provides its Contributions) on an "AS IS" BASIS,
+       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+       implied, including, without limitation, any warranties or conditions
+       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+       PARTICULAR PURPOSE. You are solely responsible for determining the
+       appropriateness of using or redistributing the Work and assume any
+       risks associated with Your exercise of permissions under this License.
+
+    8. Limitation of Liability. In no event and under no legal theory,
+       whether in tort (including negligence), contract, or otherwise,
+       unless required by applicable law (such as deliberate and grossly
+       negligent acts) or agreed to in writing, shall any Contributor be
+       liable to You for damages, including any direct, indirect, special,
+       incidental, or consequential damages of any character arising as a
+       result of this License or out of the use or inability to use the
+       Work (including but not limited to damages for loss of goodwill,
+       work stoppage, computer failure or malfunction, or any and all
+       other commercial damages or losses), even if such Contributor
+       has been advised of the possibility of such damages.
+
+    9. Accepting Warranty or Additional Liability. While redistributing
+       the Work or Derivative Works thereof, You may choose to offer,
+       and charge a fee for, acceptance of support, warranty, indemnity,
+       or other liability obligations and/or rights consistent with this
+       License. However, in accepting such obligations, You may act only
+       on Your own behalf and on Your sole responsibility, not on behalf
+       of any other Contributor, and only if You agree to indemnify,
+       defend, and hold each Contributor harmless for any liability
+       incurred by, or claims asserted against, such Contributor by reason
+       of your accepting any such warranty or additional liability.
+
+    END OF TERMS AND CONDITIONS
+
+    APPENDIX: How to apply the Apache License to your work.
+
+       To apply the Apache License to your work, attach the following
+       boilerplate notice, with the fields enclosed by brackets "[]"
+       replaced with your own identifying information. (Don't include
+       the brackets!)  The text should be enclosed in the appropriate
+       comment syntax for the file format. We also recommend that a
+       file or class name and description of purpose be included on the
+       same "printed page" as the copyright notice for easier
+       identification within third-party archives.
 
     Copyright [yyyy] [name of copyright owner]
 
@@ -195,7 +193,7 @@ identification within third-party archives.
     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
+       http://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,

data/templates/cloud/gem/rakefile.erb

@@ -149,6 +149,11 @@ task :doctest do
   puts "The <%= gem.name %> gem does not have doctest tests."
 end
 
+task :cloudrad do
+  ENV["CLOUDRAD_GEM_NAME"] = "<%= gem.name %>"
+  sh "bundle exec yard doc --fail-on-warning --yardopts .yardopts-cloudrad"
+end
+
 desc "Run the CI build"
 task :ci do
   header "BUILDING <%= gem.name %>"

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,8 @@ Metrics/PerceivedComplexity:
 Naming/FileName:
   Exclude:
     - "lib/<%= gem.name %>.rb"
+Naming/PredicateName:
+  Enabled: false
 Style/AsciiComments:
   Enabled: false
 Style/CaseEquality:

data/templates/cloud/gem/yardopts-cloudrad.erb

@@ -0,0 +1,15 @@
+<%- assert_locals gem -%>
+--no-private
+--title=<%= gem.title %> API
+--exclude _pb\.rb$
+--format yaml
+--template-path ../template
+
+./lib/**/*.rb
+./proto_docs/**/*.rb
+-
+README.md
+LICENSE.md
+<%- unless gem.generic_endpoint? -%>
+AUTHENTICATION.md
+<%- end -%>

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

@@ -148,6 +148,11 @@ task :doctest do
   puts "The <%= gem.name %> gem does not have doctest tests."
 end
 
+task :cloudrad do
+  ENV["CLOUDRAD_GEM_NAME"] = "<%= gem.name %>"
+  sh "bundle exec yard doc --fail-on-warning --yardopts .yardopts-cloudrad"
+end
+
 desc "Run the CI build"
 task :ci do
   header "BUILDING <%= gem.name %>"

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/yardopts-cloudrad.erb

@@ -0,0 +1,17 @@
+<%- assert_locals gem -%>
+--no-private
+--title=<%= gem.title %> API
+--exclude _pb\.rb$
+--format yaml
+--template-path ../template
+
+./lib/**/*.rb
+-
+README.md
+<%- unless gem.generic_endpoint? -%>
+AUTHENTICATION.md
+<%- end -%>
+<%- if gem.migration? -%>
+MIGRATING.md
+<%- end -%>
+LICENSE.md

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator-cloud
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.13
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2021-02-23 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.8
+        version: 0.6.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.8
+        version: 0.6.13
 - !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
@@ -169,6 +170,7 @@ files:
 - templates/cloud/gem/readme.erb
 - templates/cloud/gem/repo-metadata.erb
 - templates/cloud/gem/rubocop.erb
+- templates/cloud/gem/yardopts-cloudrad.erb
 - templates/cloud/gem/yardopts.erb
 - templates/cloud/service/client/_credentials.erb
 - templates/cloud/service/client/_requires.erb
@@ -186,6 +188,7 @@ files:
 - templates/cloud/wrapper_gem/readme.erb
 - templates/cloud/wrapper_gem/rubocop.erb
 - templates/cloud/wrapper_gem/version_test.erb
+- templates/cloud/wrapper_gem/yardopts-cloudrad.erb
 - templates/cloud/wrapper_gem/yardopts.erb
 homepage: https://github.com/googleapis/gapic-generator-ruby
 licenses:
@@ -206,7 +209,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!