gapic-generator-cloud 0.5.0 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4f766977ecdc350e26164bb6bd394c47f3be8b0bc7dce34c8051c2fc1df63ee
-  data.tar.gz: 5c8fcf1e0ca303a4680693bf474a45aa8a3183563249e74357d2d4975d1b5540
+  metadata.gz: ee1c961d3ff79710f768e7920d76bb914b3208c63b65d2aad6562d908e54f37e
+  data.tar.gz: a34cd45e118de2e91b9c5e6883c7ef5a0167ca5272e08f2ff3c74a62ff370cb9
 SHA512:
-  metadata.gz: c5cebafecabfcbd86ed369076f9066d059abee8121ffe59b3f1ae6da4996790d2174a5397205cd743e3cfc23f4ef77aeff7848859054b425d785f2f9067e40f1
-  data.tar.gz: dd7ffa499023b899215a825a0a30a6cb40bf22b6b8e7e65125c5de3a715044643b16bec8f6baa6f0d811a9b52874718117ea328a8084d58a5b4554e0231847a7
+  metadata.gz: 92ab73a7d712a6405ac2e680b6c75c13d675cab23ad2a2df1a0589bc3e0a254e1b877723b515266feeac5267bc2a76baac175b8273e99b6ae964e06d8beeb910
+  data.tar.gz: 6527f5369f55e0f258bf1bc674cdc2a06b61b181a1b7ad00f43f68a0bf98f70272b77f5bd1c7c899866f9b9455dc2d888f545ac7e1489e84ee84b4cdf9f3e15c

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Release History for gapic-generator-cloud
 
+### 0.6.3 / 2020-06-27
+
+* Includes changes from gapic-generator 0.6.3.
+
+### 0.6.2 / 2020-06-18
+
+* Includes changes from gapic-generator 0.6.2.
+
+### 0.6.1 / 2020-06-16
+
+* Includes changes from gapic-generator 0.6.1.
+* Populate additional repo-metadata fields.
+* Remove authentication file from the gemspec for generic wrappers.
+
+### 0.6.0 / 2020-06-02
+
+* Includes changes from gapic-generator 0.6.0.
+* Support for clients with generic endpoint and credentials.
+* Support for adding extra dependencies.
+* Fix the logic determining whether a wrapper needs a separate entrypoint file.
+* Disable Metrics/BlockLength check for all sample tests.
+
+### 0.5.1 / 2020-05-21
+
+* Includes changes from gapic-generator 0.5.1
+
 ### 0.5.0 / 2020-05-19
 
 * Includes changes from gapic-generator 0.5.0

data/bin/ruby-cloud-docker-entrypoint

@@ -21,7 +21,8 @@ require "fileutils"
 # Boolean options may have values "true" or "false" (as strings)
 bool_option_map = {
   ":gem.:free_tier" => "ruby-cloud-free-tier",
-  ":gem.:yard_strict" => "ruby-cloud-yard-strict"
+  ":gem.:yard_strict" => "ruby-cloud-yard-strict",
+  ":gem.:generic_endpoint" => "ruby-cloud-generic-endpoint"
 }
 
 # Value options always take string values.
@@ -37,7 +38,9 @@ value_option_map = {
   ":gem.:version_dependencies" => "ruby-cloud-wrapper-of",
   ":gem.:migration_version" => "ruby-cloud-migration-version",
   ":gem.:product_documentation_url" => "ruby-cloud-product-url",
+  ":gem.:issue_tracker_url" => "ruby-cloud-issues-url",
   ":gem.:api_id" => "ruby-cloud-api-id",
+  ":gem.:api_shortname" => "ruby-cloud-api-shortname",
   ":gem.:factory_method_suffix" => "ruby-cloud-factory-method-suffix"
 }
 
@@ -53,7 +56,9 @@ path_option_map = {
 map_option_map = {
   ":common_services" => "ruby-cloud-common-services",
   ":overrides.:file_path" => "ruby-cloud-path-override",
-  ":overrides.:namespace" => "ruby-cloud-namespace-override"
+  ":overrides.:namespace" => "ruby-cloud-namespace-override",
+  ":overrides.:service" => "ruby-cloud-service-override",
+  ":gem.:extra_dependencies" => "ruby-cloud-extra-dependencies"
 }
 
 # A set of files that, if generated, should be removed.

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

@@ -18,7 +18,7 @@
 module Gapic
   module Generator
     module Cloud
-      VERSION = "0.5.0"
+      VERSION = "0.6.3"
     end
   end
 end

data/lib/gapic/generators/cloud_generator.rb

@@ -16,6 +16,7 @@
 
 require "gapic/generators/default_generator"
 require "gapic/presenters"
+require "gapic/presenters/cloud_gem_presenter"
 require "gapic/presenters/wrapper_gem_presenter"
 
 module Gapic
@@ -42,19 +43,19 @@ module Gapic
       # @return [Array<
       #   Google::Protobuf::Compiler::CodeGeneratorResponse::File>]
       #   The files that were generated for the API.
-      def generate
+      def generate gem_presenter: nil
         gem_config = @api.configuration[:gem] ||= {}
         return generate_wrapper if gem_config[:version_dependencies]
 
-        orig_files = super
-
-        cloud_files = []
-
-        gem = Gapic::Presenters.gem_presenter @api
+        gem = gem_presenter || Gapic::Presenters.cloud_gem_presenter(@api)
+        orig_files = super gem_presenter: gem
 
         # Additional Gem level files
-        cloud_files << g("gem/repo-metadata.erb",  ".repo-metadata.json", gem: gem)
-        cloud_files << g("gem/authentication.erb", "AUTHENTICATION.md",   gem: gem) unless gem.services.empty?
+        cloud_files = []
+        cloud_files << g("gem/repo-metadata.erb", ".repo-metadata.json", gem: gem)
+        unless gem.services.empty? || gem.generic_endpoint?
+          cloud_files << g("gem/authentication.erb", "AUTHENTICATION.md", gem: gem)
+        end
 
         format_files cloud_files
 
@@ -79,7 +80,7 @@ module Gapic
         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)
+        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)

data/lib/gapic/presenters/cloud_gem_presenter.rb

@@ -0,0 +1,46 @@
+# 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/presenters"
+require "gapic/presenters/wrapper_service_presenter"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter subclass for cloud gems.
+    #
+    class CloudGemPresenter < GemPresenter
+      def license_name
+        "Apache-2.0"
+      end
+
+      def extra_files
+        return ["README.md", "LICENSE.md", ".yardopts"] if generic_endpoint?
+        ["README.md", "LICENSE.md", "AUTHENTICATION.md", ".yardopts"]
+      end
+
+      def dependencies
+        deps = super
+        deps["google-cloud-errors"] = "~> 1.0"
+        deps
+      end
+    end
+
+    def self.cloud_gem_presenter api
+      CloudGemPresenter.new api
+    end
+  end
+end

data/lib/gapic/presenters/wrapper_gem_presenter.rb

@@ -22,7 +22,7 @@ module Gapic
     ##
     # A presenter for wrapper gems.
     #
-    class WrapperGemPresenter < GemPresenter
+    class WrapperGemPresenter < CloudGemPresenter
       def entrypoint_require
         namespace_require
       end
@@ -30,7 +30,7 @@ module Gapic
       def services
         @services ||= begin
           files = @api.generate_files
-          files.map(&:services).flatten.map { |s| WrapperServicePresenter.new @api, s }
+          files.map(&:services).flatten.map { |s| WrapperServicePresenter.new self, @api, s }
         end
       end
 
@@ -51,7 +51,7 @@ module Gapic
       end
 
       def needs_entrypoint?
-        name != namespace_file_path
+        name != namespace_require
       end
 
       def needs_default_config_block?
@@ -79,8 +79,9 @@ module Gapic
       end
 
       def extra_files
-        files = ["README.md", "AUTHENTICATION.md", "LICENSE.md", ".yardopts"]
-        files << "MIGRATING.md" if migration?
+        files = ["README.md", "LICENSE.md", ".yardopts"]
+        files.insert 1, "AUTHENTICATION.md" unless generic_endpoint?
+        files.append "MIGRATING.md" if migration?
         files
       end
 
@@ -92,19 +93,24 @@ module Gapic
         gem_config(:version_dependencies).to_s.split(";").map { |str| str.split ":" }
       end
 
-      def gem_version_dependencies
-        version_dependencies.sort_by { |version, _requirement| version }
-                            .map { |version, requirement| ["#{name}-#{version}", requirement] }
-      end
-
       def versioned_gems
-        gem_version_dependencies.map { |name, _requirement| name }
+        version_dependencies.map { |version, _requirement| "#{name}-#{version}" }.sort
       end
 
       def default_version
         version_dependencies.first&.first
       end
 
+      def dependencies
+        deps = { "google-cloud-core" => "~> 1.5" }
+        version_dependencies.each do |version, requirement|
+          deps["#{name}-#{version}"] = "~> #{requirement}"
+        end
+        extra_deps = gem_config :extra_dependencies
+        deps.merge! extra_deps if extra_deps
+        deps
+      end
+
       def google_cloud_short_name
         m = /^google-cloud-(.*)$/.match name
         return nil unless m

data/lib/gapic/presenters/wrapper_service_presenter.rb

@@ -23,10 +23,6 @@ module Gapic
     # A presenter for wrapper services.
     #
     class WrapperServicePresenter < ServicePresenter
-      def gem
-        WrapperGemPresenter.new @api
-      end
-
       def factory_method_name
         @factory_method_name ||= begin
           method_name = ActiveSupport::Inflector.underscore name

data/templates/cloud/gem/rakefile.erb

@@ -53,7 +53,7 @@ end
 # Acceptance tests
 desc "Run the <%= gem.name %> acceptance tests."
 task :acceptance, :project, :keyfile do |t, args|
-  <%- if service -%>
+  <%- if service && !gem.generic_endpoint? -%>
   project = args[:project]
   project ||=
     ENV["<%= gem.env_prefix %>_TEST_PROJECT"] ||
@@ -79,8 +79,8 @@ task :acceptance, :project, :keyfile do |t, args|
   ENV["<%= gem.env_prefix %>_PROJECT"] = project
   ENV["<%= gem.env_prefix %>_TEST_PROJECT"] = project
   ENV["<%= gem.env_prefix %>_KEYFILE_JSON"] = keyfile
-  <%- end -%>
 
+  <%- end -%>
   Rake::Task["acceptance:run"].invoke
 end
 

data/templates/cloud/gem/readme.erb

@@ -12,6 +12,7 @@
 $ gem install <%= gem.name %>
 ```
 
+<%- unless gem.generic_endpoint? -%>
 ## Before You Begin
 
 In order to use this library, you first need to go through the following steps:
@@ -25,10 +26,11 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
 <%- end -%>
 <%- if gem.api_id -%>
-1. [Enable the API.](https://console.cloud.google.com/apis/library/<%= gem.api_id %>.googleapis.com)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/<%= gem.api_id %>)
 <%- end -%>
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+<%- end -%>
 ## Quick Start
 
 <%- if gem.packages? -%>

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

@@ -1,6 +1,21 @@
 <%- assert_locals gem -%>
 {
-    "language": "ruby",
+<%- if gem.api_id -%>
+    "api_id": "<%= gem.api_id %>",
+<%- end -%>
+    "client_documentation": "<%= gem.library_documentation_url %>",
     "distribution_name": "<%= gem.name %>",
-    "client_documentation": "https://googleapis.dev/ruby/<%= gem.name %>/latest"
+<%- if gem.issue_tracker_url -%>
+    "issue_tracker": "<%= gem.issue_tracker_url %>",
+<%- end -%>
+    "language": "ruby",
+<%- if gem.api_shortname -%>
+    "name": "<%= gem.api_shortname %>",
+<%- end -%>
+    "name_pretty": "<%= gem.title %> API",
+<%- if gem.product_documentation_url -%>
+    "product_documentation": "<%= gem.product_documentation_url %>",
+<%- end -%>
+    "repo": "googleapis/google-cloud-ruby",
+    "requires_billing": <%= !gem.free_tier? %>
 }

data/templates/cloud/gem/yardopts.erb

@@ -10,4 +10,6 @@
 -
 README.md
 LICENSE.md
+<%- unless gem.generic_endpoint? -%>
 AUTHENTICATION.md
+<%- end -%>

data/templates/cloud/wrapper_gem/gemfile.erb

@@ -3,12 +3,6 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "google-cloud-core", path: "../google-cloud-core"
-gem "google-cloud-env", path: "../google-cloud-env"
-gem "google-cloud-errors", path: "../google-cloud-errors"
-<%- gem.gem_version_dependencies.each do |name, _requirement| -%>
+<%- gem.versioned_gems.each do |name| -%>
 gem "<%= name %>", path: "../<%= name %>"
 <%- end -%>
-
-# google-protobuf 3.12.0 requires Ruby 2.5 or later, so pin to 3.11 on older Rubies
-gem "google-protobuf", (RUBY_VERSION < "2.5" ? "~> 3.11.4" : "~> 3.12")

data/templates/cloud/wrapper_gem/gemspec.erb

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.description   = <%= gem.description.inspect %>
   gem.summary       = <%= gem.summary.inspect %>
   gem.homepage      = <%= gem.homepage.inspect %>
-  gem.license       = "Apache-2.0"
+  gem.license       = <%= gem.license_name.inspect %>
 
   gem.platform      = Gem::Platform::RUBY
 
@@ -23,9 +23,8 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 2.4"
 
-  gem.add_dependency "google-cloud-core", "~> 1.5"
-  <%- gem.gem_version_dependencies.each do |name, requirement| -%>
-  gem.add_dependency "<%= name %>", "~> <%= requirement %>"
+  <%- gem.dependency_list.each do |name, requirements| -%>
+  gem.add_dependency <%= name.inspect %>, <%= requirements.map { |v| v.inspect }.join ", " %>
   <%- end -%>
 
   gem.add_development_dependency "google-style", "~> 1.24.0"

data/templates/cloud/wrapper_gem/readme.erb

@@ -32,6 +32,7 @@ for more usage information.
 $ gem install <%= gem.name %>
 ```
 
+<%- unless gem.generic_endpoint? -%>
 In order to use this library, you first need to go through the following steps:
 
 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
@@ -43,10 +44,11 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
 <%- end -%>
 <%- if gem.api_id -%>
-1. [Enable the API.](https://console.cloud.google.com/apis/library/<%= gem.api_id %>.googleapis.com)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/<%= gem.api_id %>)
 <%- end -%>
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+<%- end -%>
 <%- if gem.migration? %>
 ## Migrating from <%= gem.pre_migration_version %> versions
 

data/templates/cloud/wrapper_gem/rubocop.erb

@@ -16,7 +16,7 @@ Documentation:
 
 Metrics/BlockLength:
   Exclude:
-    - "samples/acceptance/*.rb"
+    - "samples/**/acceptance/*.rb"
 
 Naming/FileName:
   Exclude:

data/templates/cloud/wrapper_gem/yardopts.erb

@@ -8,7 +8,9 @@
 ./lib/**/*.rb
 -
 README.md
+<%- unless gem.generic_endpoint? -%>
 AUTHENTICATION.md
+<%- end -%>
 <%- if gem.migration? -%>
 MIGRATING.md
 <%- end -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator-cloud
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.3
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -68,34 +68,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 1.30.0.pre1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 1.30.0.pre1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -172,10 +158,10 @@ files:
 - cloud-rubocop.yml
 - lib/gapic/generator/cloud/version.rb
 - lib/gapic/generators/cloud_generator.rb
+- lib/gapic/presenters/cloud_gem_presenter.rb
 - lib/gapic/presenters/wrapper_gem_presenter.rb
 - lib/gapic/presenters/wrapper_service_presenter.rb
 - templates/cloud/gem/authentication.erb
-- templates/cloud/gem/gemspec.erb
 - templates/cloud/gem/gitignore.erb
 - templates/cloud/gem/license.erb
 - templates/cloud/gem/rakefile.erb

data/templates/cloud/gem/gemspec.erb

@@ -1,40 +0,0 @@
-<%- assert_locals gem -%>
-# -*- ruby -*-
-# encoding: utf-8
-require File.expand_path("lib/<%= gem.version_require %>", __dir__)
-
-Gem::Specification.new do |gem|
-  gem.name          = "<%= gem.name %>"
-  gem.version       = <%= gem.version_name_full %>
-
-  gem.authors       = <%= gem.authors.inspect %>
-  gem.email         = <%= gem.email.inspect %>
-  gem.description   = <%= gem.description.inspect %>
-  gem.summary       = <%= gem.summary.inspect %>
-  gem.homepage      = <%= gem.homepage.inspect %>
-  gem.license       = "Apache-2.0"
-
-  gem.platform      = Gem::Platform::RUBY
-
-  gem.files         = `git ls-files -- lib/*`.split("\n") +
-                      `git ls-files -- proto_docs/*`.split("\n") +
-                      ["README.md", "LICENSE.md", "AUTHENTICATION.md", ".yardopts"]
-  gem.require_paths = ["lib"]
-
-  gem.required_ruby_version = ">= 2.4"
-
-  gem.add_dependency "gapic-common", "~> 0.2"
-  gem.add_dependency "google-cloud-errors", "~> 1.0"
-  <%- if gem.iam_dependency? -%>
-  gem.add_dependency "grpc-google-iam-v1", ">= 0.6.10", "< 2.0"
-  <%- end -%>
-
-  gem.add_development_dependency "google-style", "~> 1.24.0"
-  gem.add_development_dependency "minitest", "~> 5.14"
-  gem.add_development_dependency "minitest-focus", "~> 1.1"
-  gem.add_development_dependency "minitest-rg", "~> 5.2"
-  gem.add_development_dependency "rake", ">= 12.0"
-  gem.add_development_dependency "redcarpet", "~> 3.0"
-  gem.add_development_dependency "simplecov", "~> 0.18"
-  gem.add_development_dependency "yard", "~> 0.9"
-end