haveapi-go-client 0.31.1 → 0.31.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2db2499a0d0a8c758e9da6ee9c29a409636de10a81ee9e924d06cc7fe1065106
-  data.tar.gz: 94888154a8e97d91387f193d26213a7f5d818fc0d2d4ab176c8462f46b8162a7
+  metadata.gz: 8173f3bbbff07f213ebe0a81f076d61d5ebb226fcdabdca72fa2ed2ccb451948
+  data.tar.gz: 341ec4463fe3db550a8a3845bd0669932cb66034a1a1c002fb2827b492d9b10b
 SHA512:
-  metadata.gz: 0371616532eaf5a1d46740a2b2a843e29a54a7fd08c51f7857923d4cae55c7b77962fae3653759d395e6a0f361adabf6c25cf7b6767184e27143380b35875f18
-  data.tar.gz: 6c5c5e06b8982e7796b8625bcc86edd411a45c4a2e6650878697beb3cda7839f1aee02e0b32bc5c81f701f70c0f3ca7e12e0e85522399b1b141a56737a489319
+  metadata.gz: b59d736fd2b7aa75454498871139641bfe6afcfaf413aaeb04a649d0cbb257ba2a0f19b68291e3b9d4a2bad3bded1271db812ccdac2caf08df2ad4c8eb166c06
+  data.tar.gz: 5eb842814c531bb8d0a230d210217ad37dc09aa842bd6a8867f82bf6bb13ac91a3ad9a615bf98b9d0cae6c2891452f1d0f77ac1a36187ef8295b2127f81377c3

data/haveapi-go-client.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'haveapi-client', '~> 0.31.1'
+  spec.add_dependency 'haveapi-client', '~> 0.31.2'
 end

data/lib/haveapi/go_client/documentation.rb

@@ -411,7 +411,8 @@ module HaveAPI::GoClient
               when :basic
                 ['api.SetBasicAuthentication(os.Getenv("HAVEAPI_USER"), os.Getenv("HAVEAPI_PASSWORD"))']
               when :token
-                unless saved[:http_header] == visible[:http_header] && saved[:query_parameter] == visible[:query_parameter]
+                unless same_transport_name?(saved[:http_header], visible[:http_header]) &&
+                       same_transport_name?(saved[:query_parameter], visible[:query_parameter])
                   unsupported!('This authentication method does not match the configured Go SDK.')
                 end
                 ['api.SetExistingTokenAuth(os.Getenv("HAVEAPI_TOKEN"))',
@@ -428,6 +429,11 @@ module HaveAPI::GoClient
       code(program(context, ['os'], lines))
     end
 
+    def same_transport_name?(saved, visible)
+      # Automatic profiles copy Symbol names through JSON as Strings.
+      [saved, visible].all? { |name| name.is_a?(String) || name.is_a?(Symbol) } && saved.to_s == visible.to_s
+    end
+
     def program(context, imports, lines)
       # Saved server routes already include the mount root and /vVERSION.
       origin = URI.parse(context.base_url)

data/lib/haveapi/go_client/version.rb

@@ -1,5 +1,5 @@
 module HaveAPI
   module GoClient
-    VERSION = '0.31.1'.freeze
+    VERSION = '0.31.2'.freeze
   end
 end

data/spec/documentation_profile_check.rb

@@ -22,6 +22,13 @@ class GoDocumentationProfileCheck
     privileged_description = FIXTURE.description(server, user: :privileged)
     context = FIXTURE.context(public_description)
     adapter = profile.adapter
+    saved_token = adapter.instance_variable_get(:@description).dig(:authentication, :token)
+    visible_token = public_description.fetch(:authentication).fetch(:token)
+    assert(saved_token.fetch(:query_parameter) == '_auth_token', 'automatic profile must capture the JSON String query name')
+    assert(visible_token.fetch(:query_parameter) == :_auth_token, 'live token provider must retain its Symbol query name')
+    token_example = adapter.render(kind: :auth, context:, mode: :sync, auth_method: :token, auth_description: visible_token)
+    assert(token_example[:status] == :code, "unexpected token limitation: #{token_example[:reason]}")
+    assert(token_example.fetch(:code).include?('api.SetExistingTokenAuth(os.Getenv("HAVEAPI_TOKEN"))'), 'matching token transport must render environment-token code')
     structural = adapter.instance_variable_get(:@description).dig(:resources, :set_timeout_resource, :resources, :child, :actions, :client)
     assert(!structural.has_key?(:examples), 'the private model must not retain example payloads')
     assert(!structural.dig(:input, :parameters, :private_value).has_key?(:default), 'the private model must not retain parameter defaults')

data/spec/support/documentation_profile_fixture.rb

@@ -2,6 +2,8 @@
 module GoDocumentationProfileFixture
   HOSTILE = "quote\"\\\n雪</script>".freeze
 
+  class TokenConfig < HaveAPI::Authentication::Token::Config; end
+
   module Resources
     class Owner < HaveAPI::Resource
       version '7'
@@ -101,6 +103,7 @@ module GoDocumentationProfileFixture
     server = HaveAPI::Server.new(Resources)
     server.use_version('7')
     server.default_version = '7'
+    server.auth_chain << HaveAPI::Authentication::Token.with_config(TokenConfig)
     server.documentation_clients('7', go: { import_path: 'example.test/current-sdk/client', **go })
     server.mount('/mounted/')
     server

data/spec/unit/documentation_spec.rb

@@ -170,6 +170,62 @@ RSpec.describe HaveAPI::GoClient::Documentation do
     expect(adapter.render(kind: :auth, context:, mode: :sync, auth_method: :token, auth_description: {})).to include(status: :limitation)
   end
 
+  [[String, String], [Symbol, Symbol], [String, Symbol], [Symbol, String]].each do |saved_type, visible_type|
+    it "matches token transport names saved as #{saved_type} and visible as #{visible_type}" do
+      description[:authentication][:token].merge!(http_header: saved_type == String ? 'X-Token' : :'X-Token',
+                                                  query_parameter: saved_type == String ? 'token' : :token)
+      adapter
+      context.description = Marshal.load(Marshal.dump(description))
+      context.description[:authentication][:token].merge!(http_header: visible_type == String ? 'X-Token' : :'X-Token',
+                                                          query_parameter: visible_type == String ? 'token' : :token)
+
+      result = adapter.render(kind: :auth, context:, mode: :sync, auth_method: :token, auth_description: {})
+      expect(result[:status]).to eq(:code)
+      expect(result[:code]).to include('api.SetExistingTokenAuth(os.Getenv("HAVEAPI_TOKEN"))')
+    end
+  end
+
+  %i[http_header query_parameter].each do |field|
+    it "rejects a different token #{field} even when the other transport matches" do
+      adapter
+      context.description = Marshal.load(Marshal.dump(description))
+      context.description[:authentication][:token][field] = 'other'
+
+      expect(adapter.render(kind: :auth, context:, mode: :sync, auth_method: :token, auth_description: {})).to include(
+        status: :limitation, reason: 'This authentication method does not match the configured Go SDK.'
+      )
+    end
+
+    [nil, false, 7].each do |invalid|
+      it "rejects unsupported token #{field} values #{invalid.inspect} without coercion" do
+        [[invalid, invalid], [invalid, invalid.to_s], [invalid.to_s, invalid]].each do |saved, visible|
+          description[:authentication][:token][field] = saved
+          candidate = described_class.new(description:, import_path: 'example.test/sdk/client')
+          context.description = Marshal.load(Marshal.dump(description))
+          context.description[:authentication][:token][field] = visible
+
+          expect(candidate.render(kind: :auth, context:, mode: :sync, auth_method: :token, auth_description: {})).to include(
+            status: :limitation, reason: 'This authentication method does not match the configured Go SDK.'
+          )
+        end
+      end
+    end
+  end
+
+  %i[saved visible descriptor].each do |missing|
+    it "keeps token authentication unavailable without the #{missing} provider description" do
+      description[:authentication].delete(:token) if missing == :saved
+      adapter
+      context.description = Marshal.load(Marshal.dump(description))
+      context.description[:authentication][:token] = GoDocumentationFixture.token
+      context.description[:authentication].delete(:token) if missing == :visible
+
+      result = adapter.render(kind: :auth, context:, mode: :sync, auth_method: :token,
+                              auth_description: missing == :descriptor ? nil : {})
+      expect(result).to include(status: :limitation, reason: 'This authentication method is unavailable in the configured Go SDK.')
+    end
+  end
+
   it 'does not show operation helpers when action-state visibility is absent' do
     action[:blocking] = true
     action[:meta][:global][:output] = GoDocumentationFixture.io({ action_state_id: { type: 'Integer' } }, namespace: false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi-go-client
 version: !ruby/object:Gem::Version
-  version: 0.31.1
+  version: 0.31.2
 platform: ruby
 authors:
 - Jakub Skokan
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.31.1
+        version: 0.31.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.31.1
+        version: 0.31.2
 description: Go client generator
 email:
 - jakub.skokan@vpsfree.cz