gapic-generator 0.47.1 → 0.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85080fd14e5e27a8df3ceab07bab66561e846bfecd776a2296194534d8bbeb75
-  data.tar.gz: fae81b0c5525d979141c327b4282c8eb93026a4533855006fe850b6c767b1076
+  metadata.gz: 0dce081dcba1081cbc1d70ea2ba48cfe5d1b6d0d9312f655498a9b67118475d0
+  data.tar.gz: 1b99595150e4906d28041be94e84a63d53e0385d482bfe9c740de1d1ae776a5e
 SHA512:
-  metadata.gz: 3d93ed47c14a6008ec72ea60b51105f3b898ec7606feea171e0927bd7ca3f37267f5fcd5bc3b4f16a5fca8f321c24d25d29b62b995e275fcfcb803e858c1d0dd
-  data.tar.gz: c81c885b285e0406200b9e8350f69156a706be854a0be8ffc86ededd7943947ced4ec3124776071e8ef99bfed55cfe5846df1725e94643946438068655e839bd
+  metadata.gz: 1cf615c4a0d4fd410bc0e611f2bf789da9bb3f111933d4d302601f34115222cf8296afb40f08fc0c131bfe7ba97a7797176883f40c7d7fc88ec998b4c5dcce76
+  data.tar.gz: '08cb6a4fc4f8bac7397ff675124e05558566d942bf4a678fb0f5668424e98eaf49b72766e39d0148d6ce3c412e4745340bcb5f663f99a34b19f2e08e81197d6e'

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History for gapic-generator
 
+### 0.48.0 / 2026-03-13
+
+* Fix: add per-service apiVersion to gapic_metadata
+* Fix: add api_version breadcrumb to client docs
+* Feature: Upgrade dependencies for Ruby 4.0
+
+### 0.47.2 / 2025-10-22
+
+* Fix: Deprecate credentials via string or hash
+
 ### 0.47.1 / 2025-09-11
 
 No significant changes

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.47.1"
+    VERSION = "0.48.0"
   end
 end

data/lib/gapic/presenters/service_presenter.rb

@@ -526,7 +526,7 @@ module Gapic
       #
       # @return [Hash]
       def drift_manifest
-        {
+        h = {
           clients: {
             grpc: {
               libraryClient: client_name_full,
@@ -538,6 +538,8 @@ module Gapic
             }
           }
         }
+        h[:apiVersion] = @service.api_version unless @service.api_version.empty?
+        h
       end
 
       ##

data/lib/gapic/schema/wrappers.rb

@@ -347,6 +347,18 @@ module Gapic
         @address.join "."
       end
 
+      # @private
+      # This is an override that adds mention of the client's service and API
+      # version if the service has a google.api.api_version set.
+      def docs_leading_comments disable_xrefs: false, transport: nil
+        str = super(disable_xrefs: disable_xrefs, transport: transport)
+        if !str || api_version.nil? || api_version.empty?
+          return str
+        end
+
+        "#{str.strip}\n\nThis client uses #{name} version #{api_version}."
+      end
+
       # @!method name
       #   @return [String] the unqualified name of the service.
       # @!method options

data/templates/default/gem/gemfile.text.erb

@@ -3,10 +3,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "google-style", "~> 1.31.1"
-gem "minitest", "~> 5.22"
+gem "google-style", "~> 1.32.0"
+gem "minitest", "~> 6.0.2"
 gem "minitest-focus", "~> 1.4"
+gem "minitest-mock", "~> 5.27"
 gem "minitest-rg", "~> 5.3"
+gem "ostruct", "~> 0.5.5"
 gem "rake", ">= 13.0"
 gem "redcarpet", "~> 3.6"
 gem "yard", "~> 0.9"

data/templates/default/gem/gemspec.text.erb

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
                       <%= gem.extra_files.inspect %>
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = ">= 3.1"
+  gem.required_ruby_version = ">= 3.2"
 
   <%- gem.dependency_list.each do |name, requirements| -%>
   gem.add_dependency <%= name.inspect %>, <%= requirements.map { |v| v.inspect }.join ", " %>

data/templates/default/gem/test_helper.text.erb

@@ -3,6 +3,7 @@
 
 require "minitest/autorun"
 require "minitest/focus"
+require "minitest/mock"
 require "minitest/rg"
 
 require "grpc"

data/templates/default/service/client/_config.text.erb

@@ -37,8 +37,6 @@
 #   @return [::String,nil]
 # @!attribute [rw] credentials
 #   Credentials to send with calls. You may provide any of the following types:
-#    *  (`String`) The path to a service account key file in JSON format
-#    *  (`Hash`) A service account key as a Hash
 #    *  (`Google::Auth::Credentials`) A googleauth credentials object
 #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
 #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -47,7 +45,26 @@
 #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
 #    *  (`nil`) indicating no credentials
 #
-#   Warning: If you accept a credential configuration (JSON file or Hash) from an
+#   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+#     is deprecated. Providing an unvalidated credential configuration to
+#     Google APIs can compromise the security of your systems and data.
+#
+#   @example
+#
+#     # The recommended way to provide credentials is to use the `make_creds` method
+#     # on the appropriate credentials class for your environment.
+#
+#     require "googleauth"
+#
+#     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+#       json_key_io: ::File.open("/path/to/keyfile.json")
+#     )
+#
+#     client = <%= service.client_name_full %>.new do |config|
+#       config.credentials = credentials
+#     end
+#
+#   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
 #   external source for authentication to Google Cloud, you must validate it before
 #   providing it to a Google API client library. Providing an unvalidated credential
 #   configuration to Google APIs can compromise the security of your systems and data.

data/templates/default/service/test/client.text.erb

@@ -16,6 +16,26 @@ class <%= service.client_name_full %>Test < Minitest::Test
 
 <%- end -%>
 <%= indent render(partial: "service/test/method/configure", locals: { service: service }), 2 %>
+
+  def test_credentials
+    key = OpenSSL::PKey::RSA.new 2048
+    cred_json = {
+      "private_key" => key.to_pem,
+      "client_email" => "app@developer.gserviceaccount.com",
+      "type" => "service_account"
+    }
+    key_file = StringIO.new cred_json.to_json
+    creds = Google::Auth::ServiceAccountCredentials.make_creds({ json_key_io: key_file })
+
+    dummy_stub = ClientStub.new nil, nil
+    Gapic::ServiceStub.stub :new, dummy_stub do
+      client = <%= service.client_name_full %>.new do |config|
+        config.credentials = creds
+      end
+      assert_kind_of <%= service.client_name_full %>, client
+      assert_equal creds, client.configure.credentials
+    end
+  end
 <%- if service.lro? -%>
 
   def test_<%= service.lro_client_var %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.47.1
+  version: 0.48.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.31.1
+        version: 1.32.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.31.1
+        version: 1.32.0
 email:
 - landrito@google.com
 - quartzmo@gmail.com
@@ -358,7 +358,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="