gapic-generator-cloud 0.11.0 → 0.45.1

data/templates/cloud/wrapper_gem/client_test.text.erb

@@ -0,0 +1,59 @@
+<%- assert_locals gem -%>
+<%= render partial: "shared/header" -%>
+
+require "helper"
+require "<%= gem.namespace_require %>"
+require "gapic/common"
+<%- if gem.generate_grpc_clients? -%>
+require "gapic/grpc"
+<%- end -%>
+<%- if gem.generate_rest_clients? -%>
+require "gapic/rest"
+<%- end -%>
+
+class <%= gem.namespace %>::ClientConstructionMinitest < Minitest::Test
+  class DummyStub
+    def endpoint
+      "endpoint.example.com"
+    end
+
+    def universe_domain
+      "example.com"
+    end
+
+    def stub_logger
+      nil
+    end
+
+    def logger
+      nil
+    end
+  end
+
+<%- start_line_spacer -%>
+<%- gem.services.each do |service| -%>
+<%- if service.generate_grpc_clients? -%>
+<%= line_spacer %>  def test_<%= service.factory_method_name %>_grpc
+    skip unless <%= gem.namespace %>.<%= service.factory_method_name %>_available?<% if service.supports_multiple_transports? %> transport: :grpc<% end %>
+    Gapic::ServiceStub.stub :new, DummyStub.new do
+      grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure
+      client = <%= gem.namespace %>.<%= service.factory_method_name %><% if service.supports_multiple_transports? %> transport: :grpc<% end %> do |config|
+        config.credentials = grpc_channel
+      end
+      assert_kind_of <%= gem.namespaced_class "#{service.module_name}::#{service.client_name}", version: gem.default_version %>, client
+    end
+  end
+<%- end -%>
+<%- if service.generate_rest_clients? -%>
+<%= line_spacer %>  def test_<%= service.factory_method_name %>_rest
+    skip unless <%= gem.namespace %>.<%= service.factory_method_name %>_available?<% if service.supports_multiple_transports? %> transport: :rest<% end %>
+    Gapic::Rest::ClientStub.stub :new, DummyStub.new do
+      client = <%= gem.namespace %>.<%= service.factory_method_name %><% if service.supports_multiple_transports? %> transport: :rest<% end %> do |config|
+        config.credentials = :dummy_credentials
+      end
+      assert_kind_of <%= gem.namespaced_class "#{service.module_name}::Rest::#{service.client_name}", version: gem.default_version %>, client
+    end
+  end
+<%- end -%>
+<%- end -%>
+end

data/templates/cloud/wrapper_gem/gemfile.text.erb

@@ -0,0 +1,29 @@
+<%- assert_locals gem -%>
+source "https://rubygems.org"
+
+gemspec
+
+local_dependencies = <%= gem.versioned_gems.inspect %>
+
+main_spec = gemspecs.last || Bundler.load_gemspec(File.join __dir__, "<%= gem.name %>.gemspec")
+local_dependencies.each do |name|
+  spec_path = File.expand_path "../#{name}/#{name}.gemspec", __dir__
+  unless File.file? spec_path
+    warn "WARNING: Disabled local dependency for #{name} because gemspec not found."
+    next
+  end
+  version = Bundler.load_gemspec(spec_path).version
+  if main_spec.dependencies.any? { |dep| dep.name == name && !dep.requirement.satisfied_by?(version) }
+    warn "WARNING: Disabled local dependency for #{name} because the gemspec disallows version #{version}."
+    next
+  end
+  gem name, path: "../#{name}"
+end
+
+gem "google-style", "~> 1.30.1"
+gem "minitest", "~> 5.22"
+gem "minitest-focus", "~> 1.4"
+gem "minitest-rg", "~> 5.3"
+gem "rake", ">= 13.0"
+gem "redcarpet", "~> 3.6"
+gem "yard", "~> 0.9"

data/templates/cloud/wrapper_gem/{gemspec.erb → gemspec.text.erb}

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
 
   gem.authors       = <%= gem.authors.inspect %>
   gem.email         = <%= gem.email.inspect %>
-  gem.description   = <%= gem.description.inspect %>
+  gem.description   = <%= gem.gemspec_description.inspect %>
   gem.summary       = <%= gem.summary.inspect %>
   gem.homepage      = <%= gem.homepage.inspect %>
   gem.license       = <%= gem.license_name.inspect %>
@@ -21,18 +21,9 @@ Gem::Specification.new do |gem|
                       <%= gem.extra_files.inspect %>
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = ">= 2.5"
+  gem.required_ruby_version = ">= 3.0"
 
   <%- 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.25.1"
-  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.9"
-  gem.add_development_dependency "yard", "~> 0.9"
 end

data/templates/cloud/wrapper_gem/{rakefile.erb → rakefile.text.erb}

@@ -17,43 +17,16 @@ Rake::TestTask.new do |t|
   t.warning = true
 end
 
-namespace :test do
-  desc "Runs tests with coverage."
-  task :coverage do
-    require "simplecov"
-    SimpleCov.start do
-      command_name "<%= gem.name %>"
-      track_files "lib/**/*.rb"
-      add_filter "test/"
-    end
-
-    Rake::Task[:test].invoke
-  end
-end
-
 desc "Runs the smoke tests."
 Rake::TestTask.new :smoke_test do |t|
   t.test_files = FileList["acceptance/**/*smoke_test.rb"]
   t.warning = false
 end
 
-namespace :smoke_test do
-  desc "Runs smoke tests with coverage."
-  task :coverage do
-    require "simplecov"
-    SimpleCov.start do
-      command_name "<%= gem.name %>"
-      track_files "lib/**/*.rb"
-      add_filter "test/"
-    end
-
-    Rake::Task[:smoke_test].invoke
-  end
-end
-
 # Acceptance tests
 desc "Run the <%= gem.name %> acceptance tests."
 task :acceptance, :project, :keyfile do |t, args|
+  <%- if service && !gem.generic_endpoint? -%>
   project = args[:project]
   project ||=
     ENV["<%= gem.cloud_env_prefix %>_TEST_PROJECT"] ||
@@ -80,6 +53,7 @@ task :acceptance, :project, :keyfile do |t, args|
   ENV["<%= gem.cloud_env_prefix %>_TEST_PROJECT"] = project
   ENV["<%= gem.cloud_env_prefix %>_KEYFILE_JSON"] = keyfile
 
+  <%- end -%>
   Rake::Task["acceptance:run"].invoke
 end
 
@@ -92,10 +66,6 @@ namespace :acceptance do
     end
   end
 
-  desc "Run acceptance tests with coverage."
-  task :coverage do
-  end
-
   desc "Run acceptance cleanup."
   task :cleanup do
   end

data/templates/cloud/wrapper_gem/{readme.erb → readme.text.erb}

@@ -2,12 +2,16 @@
 
 <%= gem.summary %>
 
-<%= gem.description %>
+<%- if gem.summary != gem.description %>
+<% gem.readme_description.each do |line| %>
+<%= line %>
+<% end %>
+<%- end %>
 
 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 the main client library that brings the
-verisoned gems in as dependencies, and provides high-level methods for
+versioned gems in as dependencies, and provides high-level methods for
 constructing clients. More information on versioned clients can be found below
 in the section titled *Which client should I use?*.
 
@@ -18,8 +22,7 @@ themselves can be found in the client library documentation for the versioned
 client gems:
 <%- last_index = gem.versioned_gems.size - 1 -%>
 <%- gem.versioned_gems.each_with_index do |name, i| -%>
-<%- sep = i == last_index ? "." : "," -%>
-[<%= name %>](https://googleapis.dev/ruby/<%= name %>/latest)<%= sep %>
+<%= gem.docs_link gem_name: name, text: name %><%= i == last_index ? "." : "," %>
 <%- end -%>
 
 <%- if gem.product_documentation_url -%>
@@ -47,7 +50,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 -%>
 <%- if gem.migration? %>
@@ -60,44 +63,49 @@ versions of this library will likely require updates to use this version.
 See the {file:MIGRATING.md MIGRATING.md} document for more information.
 
 <%- end -%>
-<%- unless gem.generate_rest_clients? -%>
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
-
-```ruby
-require "logger"
-
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
-end
-```
-
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+<%- last_index = gem.versioned_gems.size - 1 -%>
+<%- gem.versioned_gems.each_with_index do |name, i| -%>
+<%= gem.docs_link gem_name: name, text: name %><%= i == last_index ? "." : "," %>
 <%- end -%>
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 3.0+.
 
 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.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.
+in security maintenance, and not end of life. 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?
 

data/templates/cloud/wrapper_gem/{version_test.erb → version_test.text.erb}

@@ -6,6 +6,6 @@ require "<%= gem.version_require %>"
 
 class <%= gem.namespace %>::VersionMinitest < Minitest::Test
   def test_has_a_version
-    refute_nil  <%= gem.version_name_full %>
+    refute_nil <%= gem.version_name_full %>
   end
 end

metadata

@@ -1,158 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator-cloud
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.45.1
 platform: ruby
 authors:
 - Ernest Landrito
 - Chris Smith
 - Mike Moore
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: gapic-generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.45.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.0
-- !ruby/object:Gem::Dependency
-  name: google-style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.25.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.25.1
-- !ruby/object:Gem::Dependency
-  name: protobuf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: grpc-tools
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.41.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.41.0
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-autotest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-focus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '12.0'
-description: 
+        version: 0.45.1
 email:
 - landrito@google.com
 - quartzmo@gmail.com
@@ -178,38 +50,37 @@ files:
 - lib/gapic/presenters/wrapper_gem_presenter.rb
 - lib/gapic/presenters/wrapper_service_presenter.rb
 - lib/gapic/presenters/wrapper_service_rest_presenter.rb
-- templates/cloud/gem/authentication.erb
-- templates/cloud/gem/gitignore.erb
-- templates/cloud/gem/license.erb
-- templates/cloud/gem/rakefile.erb
-- templates/cloud/gem/readme.erb
-- templates/cloud/gem/repo-metadata.erb
-- templates/cloud/gem/rubocop.erb
-- templates/cloud/gem/yardopts.erb
-- templates/cloud/service/client/_credentials.erb
-- templates/cloud/service/client/_requires.erb
-- 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
-- templates/cloud/wrapper_gem/entrypoint.erb
-- templates/cloud/wrapper_gem/gemfile.erb
-- templates/cloud/wrapper_gem/gemspec.erb
-- templates/cloud/wrapper_gem/main.erb
-- templates/cloud/wrapper_gem/rakefile.erb
-- templates/cloud/wrapper_gem/readme.erb
-- templates/cloud/wrapper_gem/rubocop.erb
-- templates/cloud/wrapper_gem/version_test.erb
-- templates/cloud/wrapper_gem/yardopts.erb
+- templates/cloud/gem/authentication.text.erb
+- templates/cloud/gem/gitignore.text.erb
+- templates/cloud/gem/license.text.erb
+- templates/cloud/gem/rakefile.text.erb
+- templates/cloud/gem/readme.text.erb
+- templates/cloud/gem/repo-metadata.text.erb
+- templates/cloud/gem/rubocop.text.erb
+- templates/cloud/gem/yardopts.text.erb
+- templates/cloud/service/client/_credentials.text.erb
+- templates/cloud/service/client/_requires.text.erb
+- templates/cloud/service/client/_self_configure.text.erb
+- templates/cloud/service/client/method/def/_rescue.text.erb
+- templates/cloud/service/client/method/docs/_error.text.erb
+- templates/cloud/service/rest/client/method/def/_rescue.text.erb
+- templates/cloud/service/rest/client/method/docs/_error.text.erb
+- templates/cloud/shared/_license.text.erb
+- templates/cloud/wrapper_gem/_main.text.erb
+- templates/cloud/wrapper_gem/client_test.text.erb
+- templates/cloud/wrapper_gem/entrypoint.text.erb
+- templates/cloud/wrapper_gem/gemfile.text.erb
+- templates/cloud/wrapper_gem/gemspec.text.erb
+- templates/cloud/wrapper_gem/main.text.erb
+- templates/cloud/wrapper_gem/rakefile.text.erb
+- templates/cloud/wrapper_gem/readme.text.erb
+- templates/cloud/wrapper_gem/rubocop.text.erb
+- templates/cloud/wrapper_gem/version_test.text.erb
+- templates/cloud/wrapper_gem/yardopts.text.erb
 homepage: https://github.com/googleapis/gapic-generator-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -217,15 +88,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.6.8
 specification_version: 4
 summary: An API Client Generator for Ruby in Ruby!
 test_files: []