smplkit 3.0.97 → 3.0.98

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c317a0f573d990742547e60f7e17bba0bd65a6abc13dae8bcf8ab13ca7e167e3
-  data.tar.gz: c02f2385189d409d3f1a8263156f0a659e55ae762d4c2f9940bdf6a51d61f19d
+  metadata.gz: 6e45e17931c6cadc44da209a05f0c043d9fb0d7e08ce28058f6c1ddc67cc7e05
+  data.tar.gz: 97e9506623904814d1272b57e1558959b9be4ecc6d3f68609a69e251f820ccbb
 SHA512:
-  metadata.gz: 33f03cf3bde2e7a38b9856b558be13546c374ceddec2c02ec9cb5d454922f373d46f39188e86ffbbba194421318b9d04bba1a966ac2930ad088c6cf46f6d7cf5
-  data.tar.gz: 91337cdc5b3da03eae931e8b67b7454d0d04925e667446b49ba003ecd0c6bcd091f319f15df58d2c926f818a563a5ab4648ef769261ffacc9422636f125dd3a6
+  metadata.gz: 516b5e35d4441a7ae9a4b5944f8b79292dae8a3b4b8e4979cf20a3b09b513fc399260c68141ff53e886547f71acdd4c07ba0188ab46380cace4e53beeca97352
+  data.tar.gz: 61d0c381f68966b90e08167cc629f259ced3200fec6c16d29d76bbcab7163f8df7321edb32e8dc574b8c6dbefcd055d0d553e59945247044f8a1fe681712f379

data/lib/smplkit/audit/client.rb

@@ -10,12 +10,25 @@ module Smplkit
     # listings (+resource_types+, +event_types+, +categories+), plus SIEM
     # forwarder CRUD on +#forwarders+.
     #
-    # @param api_key [String] API key used to authenticate every request.
-    # @param base_url [String] Full audit-service base URL.
+    # Reachable as +client.audit+ (+Smplkit::Client+) or constructed directly —
+    # +AuditClient.new+ resolves credentials from +~/.smplkit+ / env vars and
+    # derives the audit base URL from +base_domain+/+scheme+ when +base_url+ is
+    # omitted.
+    #
+    # @param api_key [String, nil] API key used to authenticate every request.
+    #   When omitted, resolved from +SMPLKIT_API_KEY+ or +~/.smplkit+.
+    # @param base_url [String, nil] Full audit-service base URL. Usually resolved
+    #   from +base_domain+/+scheme+; supplied directly by the top-level clients
+    #   which have already computed it.
     # @param environment [String, nil] Deployment environment to scope recording
     #   and reads to. Optional — forwarder CRUD and discovery are
     #   environment-agnostic, and reads accept an explicit +environments: [...]+
     #   filter.
+    # @param profile [String, nil] Named +~/.smplkit+ profile section.
+    # @param base_domain [String, nil] Base domain for API requests (default
+    #   +"smplkit.com"+).
+    # @param scheme [String, nil] URL scheme (default +"https"+).
+    # @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,
@@ -25,12 +38,29 @@ module Smplkit
 
       SDK_OWNED_HEADERS = %w[authorization content-type user-agent].freeze
 
-      def initialize(api_key:, base_url:, environment: nil, timeout: 10.0, extra_headers: nil)
+      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)
+        # +base_url+/+api_key+ are used directly when both are supplied (the
+        # path the top-level client takes after it has already resolved them);
+        # otherwise the config resolver fills in whatever is missing
+        # (+~/.smplkit+ / env vars / defaults) and the audit base URL is derived
+        # from +base_domain+/+scheme+ via +service_url+.
+        if api_key.nil? || base_url.nil?
+          resolved = ConfigResolution.resolve_client_config(
+            profile: profile, api_key: api_key, base_domain: base_domain,
+            scheme: scheme, debug: debug
+          )
+          api_key = resolved.api_key if api_key.nil?
+          base_url = ConfigResolution.service_url(resolved.scheme, "audit", resolved.base_domain) if base_url.nil?
+          debug = resolved.debug if debug.nil?
+        end
         cfg = SmplkitGeneratedClient::Audit::Configuration.new
         cfg.host = URI.parse(base_url).host
         cfg.scheme = URI.parse(base_url).scheme
         cfg.access_token = api_key
         cfg.timeout = timeout
+        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}"
@@ -57,4 +87,6 @@ module Smplkit
       end
     end
   end
+
+  AuditClient = Audit::AuditClient
 end

data/lib/smplkit/audit/events.rb

@@ -4,9 +4,10 @@ module Smplkit
   module Audit
     # Audit events surface — accessed via +client.audit.events+.
     #
-    # +#record+ is fire-and-forget — the call enqueues the event onto an
-    # in-memory bounded buffer and returns immediately. +#list+ and +#get+
-    # are synchronous reads.
+    # +#record+ is fire-and-forget by default — the call enqueues the event
+    # onto an in-memory bounded buffer and returns immediately. Pass
+    # +flush: true+ to block until the event is durable before continuing.
+    # +#list+ and +#get+ are synchronous reads.
     class Events
       def initialize(api)
         @api = api
@@ -15,8 +16,12 @@ module Smplkit
 
       # Enqueue an audit event for asynchronous delivery.
       #
-      # Returns immediately — the buffer's worker thread performs the actual
-      # POST with retry on transient failures.
+      # Returns immediately when +flush+ is +false+ (the default) — the
+      # buffer's worker thread performs the actual POST with retry on
+      # transient failures. When +flush: true+, this call blocks until the
+      # buffer has drained or +flush_timeout+ elapses; use it when the caller
+      # needs the event durable before continuing (CLI tools, in-test
+      # assertions, or any flow about to terminate the process).
       #
       # Actor attribution (+actor_type+, +actor_id+, +actor_label+) is
       # customer-supplied and free-form. The audit service stores
@@ -58,11 +63,17 @@ module Smplkit
       #   the event normally but does NOT POST it through any configured SIEM
       #   forwarder. A +skipped_do_not_forward+ delivery row is recorded for each
       #   enabled forwarder so the skip is visible in the forwarder delivery log.
+      # @param flush [Boolean] When +true+, block until the buffer has drained
+      #   (or +flush_timeout+ elapses) before returning. Defaults to +false+
+      #   (fire-and-forget).
+      # @param flush_timeout [Float, nil] Upper bound on the blocking flush, in
+      #   seconds. Ignored when +flush+ is +false+. +nil+ blocks indefinitely.
+      #   Defaults to +5.0+.
       # @return [void]
       def record(event_type:, resource_type:, resource_id:,
                  occurred_at: nil, actor_type: nil, actor_id: nil,
                  actor_label: nil, category: nil, data: nil, idempotency_key: nil,
-                 do_not_forward: false)
+                 do_not_forward: false, flush: false, flush_timeout: 5.0)
         raise ArgumentError, "event_type is required" if event_type.nil? || event_type.to_s.empty?
         raise ArgumentError, "resource_type is required" if resource_type.nil? || resource_type.to_s.empty?
         raise ArgumentError, "resource_id is required" if resource_id.nil? || resource_id.to_s.empty?
@@ -101,6 +112,8 @@ module Smplkit
         )
         body = SmplkitGeneratedClient::Audit::EventRequest.new(data: resource)
         @buffer.enqueue(body, idempotency_key)
+        @buffer.flush(timeout: flush_timeout) if flush
+        nil
       end
 
       # Single-event retrieval.

data/lib/smplkit/flags/models.rb

@@ -241,23 +241,24 @@ module Smplkit
 
       # Append a constrained value to the flag's values list. Call +save+ to persist.
       #
-      # @param flag_value [FlagValue] the value entry to allow the flag to serve.
+      # @param name [String] human-readable label for the value entry.
+      # @param value [Object] the value to allow the flag to serve.
       # @return [self] this flag, so calls can be chained.
-      def add_value(flag_value)
+      def add_value(name, value)
         @values ||= []
-        @values << flag_value
+        @values << FlagValue.new(name: name, value: value)
         self
       end
 
-      # Remove the first values entry whose +name+ matches.
+      # Remove the first values entry whose +value+ matches.
       #
-      # @param name [String] the value-entry name to remove; the first match is
-      #   removed and others are left in place.
+      # @param value [Object] the value to remove. Entries are matched on their
+      #   +value+ field; the first match is removed and others are left in place.
       # @return [self] this flag, so calls can be chained.
-      def remove_value(name)
+      def remove_value(value)
         return self unless @values
 
-        @values = @values.reject { |v| v.name == name }
+        @values = @values.reject { |v| v.value == value }
         self
       end
 

metadata

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