smplkit 3.0.131 → 3.0.133

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80d71501763192031a0fb659bbe16d4aa0b021c1995dbcef803cb3cc11298355
-  data.tar.gz: e8f81502fe54983ca18c2d83bda4089e36f21b6bd5e6b58aea74ebd4b6a5edec
+  metadata.gz: cb735320cad6cc35e02d16ba48a6a95b307b5befd743f0971511a719c92cc376
+  data.tar.gz: d49318a508cb0f2ebd7387bc1ee3c201c491df7bf18a2177d7dd69cdf03d631b
 SHA512:
-  metadata.gz: cd8267d396fcb466ff2f4b2ac8addfbbd667b33bc122a599628d0a49134be4c93810fae6b779ae12f633d52062fc032ad3da0948d36c5fd472857ac0d604dfae
-  data.tar.gz: 36368e8ea040abb9905ff4d84650cd147cadf3bcef6038165970c1804df311d42e3e84fdd51e522042ee7c5a98324961a3733efc86f207243079db4a0872997d
+  metadata.gz: 3ae89d87c1e2c1df13c09adead2ead58f590e2f8d0a58324772aa56c655962686aa492e592f8c614eae5840cbe77af389703970ebcf802b1c0822de43f362861
+  data.tar.gz: 60844a59a76a58e7917690e145d4432cc7082231ffd409161c6880a38676dd8fa0e58527244f08387d5a5ce46482f465c4b82cdfa3b2bd934472039e23f047a9

data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/groups_api.rb

@@ -20,7 +20,7 @@ module SmplkitGeneratedClient::App
       @api_client = api_client
     end
     # Create Group
-    # Create an Environment Access Group. The caller provides the group id (a snake-case key, unique within the account) in the request body. The id is immutable thereafter. Returns `409` if a group with that id already exists, or `422` if `managed_environments` is not exactly `['*']` or a subset of the account's standard environment keys.
+    # Create an Environment Access Group. The caller provides the group id (a kebab-case key, unique within the account) in the request body. The id is immutable thereafter. Returns `409` if a group with that id already exists, or `422` if `managed_environments` is not exactly `['*']` or a subset of the account's standard environment keys.
     # @param group_create_request [GroupCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [GroupResponse]
@@ -30,7 +30,7 @@ module SmplkitGeneratedClient::App
     end
 
     # Create Group
-    # Create an Environment Access Group. The caller provides the group id (a snake-case key, unique within the account) in the request body. The id is immutable thereafter. Returns `409` if a group with that id already exists, or `422` if `managed_environments` is not exactly `['*']` or a subset of the account's standard environment keys.
+    # Create an Environment Access Group. The caller provides the group id (a kebab-case key, unique within the account) in the request body. The id is immutable thereafter. Returns `409` if a group with that id already exists, or `422` if `managed_environments` is not exactly `['*']` or a subset of the account's standard environment keys.
     # @param group_create_request [GroupCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(GroupResponse, Integer, Hash)>] GroupResponse data, response status code and response headers

data/lib/smplkit/_generated/app/spec/api/groups_api_spec.rb

@@ -34,7 +34,7 @@ describe 'GroupsApi' do
 
   # unit tests for create_group
   # Create Group
-  # Create an Environment Access Group. The caller provides the group id (a snake-case key, unique within the account) in the request body. The id is immutable thereafter. Returns `409` if a group with that id already exists, or `422` if `managed_environments` is not exactly `['*']` or a subset of the account's standard environment keys.
+  # Create an Environment Access Group. The caller provides the group id (a kebab-case key, unique within the account) in the request body. The id is immutable thereafter. Returns `409` if a group with that id already exists, or `422` if `managed_environments` is not exactly `['*']` or a subset of the account's standard environment keys.
   # @param group_create_request 
   # @param [Hash] opts the optional parameters
   # @return [GroupResponse]

data/lib/smplkit/account/client.rb

@@ -36,7 +36,12 @@ module Smplkit
         @headers = {
           "Authorization" => "Bearer #{api_key}",
           "Content-Type" => "application/json"
-        }.merge(extra_headers || {})
+        }
+        # Default SDK User-Agent unless the caller supplied one (any casing) —
+        # without it this raw Faraday connection would fall through to
+        # Faraday's own "Faraday vX.Y.Z" default.
+        @headers["User-Agent"] = Smplkit.user_agent unless Transport.user_agent_supplied?(extra_headers)
+        @headers.merge!(extra_headers || {})
       end
 
       # Fetch the authenticated account's current settings.

data/lib/smplkit/audit/client.rb

@@ -36,8 +36,9 @@ module Smplkit
     # @param debug [Boolean, nil] Enable SDK debug logging.
     # @param timeout [Float] Per-request timeout, in seconds. Defaults to +10.0+.
     # @param extra_headers [Hash{String => String}, nil] Extra headers attached
-    #   to every request. SDK-owned headers (authorization, content-type,
-    #   user-agent) cannot be overridden.
+    #   to every request. SDK-owned headers (authorization, content-type)
+    #   cannot be overridden. A caller-supplied User-Agent (any casing)
+    #   replaces the SDK default +smplkit-sdk-ruby/<version>+.
     # @param buffered [Boolean] Buffer event recording (default +true+):
     #   +events.record+ enqueues onto an in-memory buffer that a background
     #   worker drains with retry, and returns immediately. Set +false+ for the
@@ -48,8 +49,6 @@ module Smplkit
     class AuditClient
       attr_reader :events, :resource_types, :event_types, :categories, :forwarders
 
-      SDK_OWNED_HEADERS = %w[authorization content-type user-agent].freeze
-
       def initialize(api_key: nil, base_url: nil, environment: nil, profile: nil,
                      base_domain: nil, scheme: nil, debug: nil, timeout: 10.0,
                      extra_headers: nil, buffered: true)
@@ -77,17 +76,15 @@ module Smplkit
         cfg.debugging = debug unless debug.nil?
         HttpPool.configure(cfg)
         api_client = SmplkitGeneratedClient::Audit::ApiClient.new(cfg)
-        api_client.default_headers["User-Agent"] = "smplkit-ruby-sdk/#{Smplkit::VERSION}"
         # Runtime audit ops are environment-scoped, but the scoping is
         # body-driven (ADR-055): +events.record+ stamps the configured
         # environment onto the event request body, and the read surfaces
         # (events list plus the resource_type / event_type / category discovery
         # lists) default +filter[environment]+ to it. The transport therefore
-        # carries only auth plus any caller-supplied +extra_headers+ — no
-        # environment header. Forwarder CRUD is environment-agnostic.
-        extra_headers&.each do |k, v|
-          api_client.default_headers[k] = v unless SDK_OWNED_HEADERS.include?(k.downcase)
-        end
+        # carries only auth, the default User-Agent, and any caller-supplied
+        # +extra_headers+ — no environment header. Forwarder CRUD is
+        # environment-agnostic.
+        Transport.apply_headers(api_client, extra_headers)
         @events = Events.new(
           SmplkitGeneratedClient::Audit::EventsApi.new(api_client),
           environment: environment, buffered: buffered

data/lib/smplkit/transport.rb

@@ -15,10 +15,37 @@ module Smplkit
   #
   # @api private
   module Transport
-    SDK_OWNED_HEADERS = %w[authorization content-type user-agent].freeze
+    # Headers the SDK always owns — +extra_headers+ cannot override these
+    # (authorization carries the credential; content-type is set per request
+    # by the generated client). User-Agent is deliberately NOT in this list:
+    # a caller-supplied User-Agent wins over the SDK default.
+    SDK_OWNED_HEADERS = %w[authorization content-type].freeze
 
     module_function
 
+    # Whether an extra-headers hash carries a caller-supplied User-Agent,
+    # under any representation the surface accepts — string keys in any
+    # casing ("User-Agent", "user-agent", …) and symbol keys (:"user-agent").
+    def user_agent_supplied?(extra_headers)
+      (extra_headers || {}).keys.any? { |k| k.to_s.casecmp("user-agent").zero? }
+    end
+
+    # Stamp the default headers onto a generated +ApiClient+.
+    #
+    # User-Agent precedence: caller-supplied via +extra_headers+ (any casing
+    # or symbol representation) > the SDK default (+Smplkit.user_agent+,
+    # +smplkit-sdk-ruby/<version>+) > the generated stack's own default
+    # (+OpenAPI-Generator/x.y.z/ruby+, removed here so exactly one
+    # User-Agent representation remains). Other +extra_headers+ entries are
+    # applied as-is unless SDK-owned.
+    def apply_headers(client, extra_headers)
+      client.default_headers.delete("User-Agent")
+      client.default_headers["User-Agent"] = Smplkit.user_agent unless user_agent_supplied?(extra_headers)
+      (extra_headers || {}).each do |k, v|
+        client.default_headers[k] = v unless SDK_OWNED_HEADERS.include?(k.to_s.downcase)
+      end
+    end
+
     # Project the runtime +ResolvedConfig+ down to the transport subset.
     #
     # The top-level client's resolved config is a superset of what the
@@ -92,11 +119,8 @@ module Smplkit
       configuration.debugging = cfg.debug
       HttpPool.configure(configuration)
       generated_module::ApiClient.new(configuration).tap do |client|
-        client.default_headers["User-Agent"] = "smplkit-ruby-sdk/#{Smplkit::VERSION}"
         client.default_headers["Accept"] = accept if accept
-        (cfg.extra_headers || {}).each do |k, v|
-          client.default_headers[k] = v unless SDK_OWNED_HEADERS.include?(k.downcase)
-        end
+        apply_headers(client, cfg.extra_headers)
       end
     end
   end

data/lib/smplkit/version.rb

@@ -1,5 +1,41 @@
 # frozen_string_literal: true
 
 module Smplkit
+  # Local-development fallback only. The canonical version of a published gem
+  # is stamped into the gem's build-time metadata from the release tag by the
+  # gemspec (see +smplkit.gemspec+); +Smplkit.gem_version+ reads that metadata
+  # at runtime. This constant is used when the SDK runs from a source
+  # checkout that has no installed gem to consult.
   VERSION = "0.0.0"
+
+  # The version of the smplkit gem actually loaded, read from RubyGems
+  # package metadata.
+  #
+  # The release workflow never rewrites +VERSION+ above — the published
+  # version exists only in the git tag and, via the gemspec's build-time
+  # derivation, in the built gem's serialized specification. An installed gem
+  # therefore reports the real release version through +Gem.loaded_specs+,
+  # while a plain source checkout falls back to +VERSION+. The +smplkit-sdk+
+  # name is the ADR-046 §2.1 fallback gem name.
+  #
+  # @api private
+  # @return [String] the loaded gem's version, or +VERSION+ when the SDK is
+  #   not running from an installed gem.
+  def self.gem_version
+    spec = Gem.loaded_specs["smplkit"] || Gem.loaded_specs["smplkit-sdk"]
+    spec ? spec.version.to_s : VERSION
+  end
+
+  # The default User-Agent stamped on every outbound request (HTTP and the
+  # WebSocket handshake) when the caller has not supplied their own.
+  #
+  # The platform sits behind a WAF that rejects requests carrying no
+  # User-Agent, and an SDK-identifying value keeps support/telemetry able to
+  # attribute traffic to an SDK and version in access logs.
+  #
+  # @api private
+  # @return [String] +smplkit-sdk-ruby/<version>+
+  def self.user_agent
+    "smplkit-sdk-ruby/#{gem_version}"
+  end
 end

data/lib/smplkit/ws.rb

@@ -34,7 +34,10 @@ module Smplkit
   class SharedWebSocket
     BACKOFF_SCHEDULE = [1, 2, 4, 8, 16, 32, 60].freeze
 
-    USER_AGENT = "smplkit-ruby-sdk/#{Smplkit::VERSION}".freeze
+    # Sent on the WebSocket upgrade request — the platform WAF rejects
+    # handshakes that carry no User-Agent. There is no caller-supplied
+    # header surface on the WebSocket, so the SDK default always applies.
+    USER_AGENT = Smplkit.user_agent.freeze
 
     def initialize(app_base_url:, api_key:, metrics: nil)
       @app_base_url = app_base_url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.131
+  version: 3.0.133
 platform: ruby
 authors:
 - Smpl Solutions LLC