k9o 1.1.0

data/lib/k9o/barbican.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+require_relative 'kerror'
+
+module K9o
+  # Barbican — free, embeddable L2 guardrail. Input normalization -> Aho-Corasick
+  # deny-list matching over a signed ruleset -> local verdict, plus a streaming
+  # output redactor (buffer-and-scan-before-flush).
+  #
+  # Thin wrapper over the bound core (`k9o-keep-core`, via uniffi) — mirrors the
+  # structural pattern of +K9o::Kibo+ (native-load guard evaluated once at
+  # require time; every call forwards typed arguments to the generated binding
+  # and maps its error -> +K9o::KError+). ZERO guardrail logic lives here: every
+  # normalization pass, deny match, verdict, and redaction decision is the
+  # audited native core's.
+  #
+  # CLAIM BOUNDARY: Barbican is advisory / defense-in-depth (edge filtration).
+  # It is never the enforced sandbox boundary.
+  #
+  # The generated uniffi binding + native lib (+lib/k9o/_ffi/+) are build
+  # artifacts (CI-injected per platform; gitignored) — on a platform/Ruby
+  # without them, +require+ still succeeds and +Barbican.new+ raises a clear
+  # +K9o::KError+, so loading +k9o+ never breaks for the rest of the SDK.
+  class Barbican
+    # Attempt to load the native binding; never raises at require time.
+    NATIVE_AVAILABLE =
+      begin
+        require_relative '_ffi/k9o_keep_core_ffi_uniffi'
+        true
+      rescue LoadError
+        false
+      end
+
+    # +decode_depth+ of 0 uses the core default (3) — a bounded base64/leetspeak
+    # de-obfuscation depth (decode-bomb guard).
+    def initialize(fail_open: false, leet: true, decode_depth: 0)
+      self.class.ensure_native!
+      config = K9oKeepCoreFfiUniffi::KeepConfig.new(
+        fail_open: fail_open, leet: leet, decode_depth: decode_depth
+      )
+      @core = K9oKeepCoreFfiUniffi::KeepCore.new(config)
+    end
+
+    # Load a static ruleset bundled with your gem (Mode-A path: provenance is
+    # vouched for by your package, so signature verification is skipped — the
+    # core still enforces anti-rollback, never loading a version <= the current
+    # one). +rules+ = an array of {id:, pattern:, severity:} (severity one of
+    # low|medium|high|critical; string or symbol keys both accepted). Returns
+    # the accepted version.
+    def load_ruleset(ruleset_version, rules)
+      blob = K9oKeepCoreFfiUniffi::KeepRulesetBlob.new(
+        ruleset_version: ruleset_version,
+        rules: rules.map { |r| build_rule(r) }
+      )
+      begin
+        @core.load_ruleset_unsigned(blob)
+      rescue StandardError => e
+        raise self.class.to_kerror(e)
+      end
+    end
+
+    # Load a Barbican key manifest (compact JWS, +typ k9o.barbican.keys.v1+). The
+    # core checks it against the root key compiled into it and, only if it
+    # verifies, REPLACES the trusted ruleset-signing keys with the ones it lists.
+    # A refusal (wrong signer, rollback, a key changing its public key, a
+    # malformed entry) raises +K9O_BARBICAN_RULESET_INVALID+ with
+    # +context[:stage] == 'key_manifest'+ and leaves the trusted keys unchanged.
+    # Returns the manifest +sequence+.
+    def load_key_manifest(jws, now_secs = nil)
+      @core.load_key_manifest(jws, now_secs || Time.now.to_i)
+    rescue StandardError => e
+      raise self.class.to_kerror(e, 'key_manifest')
+    end
+
+    # Verify a ruleset manifest (compact JWS) under a trusted key and return its
+    # authenticated fields (+ruleset_version+ / +signing_key_kid+ /
+    # +artifact_hash+ / +artifact_url+ / +valid_until+).
+    def verify_manifest(jws)
+      @core.verify_manifest(jws)
+    rescue StandardError => e
+      raise self.class.to_kerror(e)
+    end
+
+    # Load a signed ruleset. The core verifies the Ed25519 signature ITSELF, over
+    # its own canonical bytes, under a key from the loaded key manifest: there is
+    # no key or verifier to pass. Any failure (no key manifest loaded, unknown
+    # key, bad or non-canonical signature, stale version, malformed rules) raises
+    # +K9O_BARBICAN_RULESET_INVALID+ with +context[:reason]+ and leaves the
+    # current ruleset running. +signature+ is the raw 64-byte binary String.
+    # Returns the accepted version.
+    def load_ruleset_signed(ruleset_version, rules, signing_key_kid, signature, created_at = 0)
+      @core.load_ruleset_signed(signed_blob(ruleset_version, rules, signing_key_kid, signature, created_at))
+    rescue StandardError => e
+      raise self.class.to_kerror(e)
+    end
+
+    # Lowercase hex SHA-256 of a ruleset's canonical signing bytes — the value a
+    # manifest's +artifact_hash+ names. A digest only; it decides no trust.
+    def ruleset_digest(ruleset_version, rules, signing_key_kid, signature, created_at = 0)
+      @core.ruleset_digest(signed_blob(ruleset_version, rules, signing_key_kid, signature, created_at))
+    rescue StandardError => e
+      raise self.class.to_kerror(e)
+    end
+
+    # The +sequence+ of the key manifest in force (0 before one is loaded).
+    def key_manifest_sequence
+      @core.key_manifest_sequence
+    end
+
+    # The highest VERIFIED ruleset version loaded (0 = none): the anti-rollback floor for signed updates. A refresh
+    # compares a published version against this, not the version in force.
+    def signed_floor
+      @core.signed_floor
+    end
+
+    # Whether the ruleset in force came from a verified load. +false+ when none is loaded, or when +load_ruleset+
+    # (unsigned, host-vouched) replaced a verified one.
+    def active_ruleset_is_signed?
+      @core.active_ruleset_is_signed
+    end
+
+    # The signing kids the loaded key manifest currently trusts, sorted.
+    def trusted_kids
+      @core.trusted_kids
+    end
+
+    # The trusted kids the key manifest flags deprecated, sorted.
+    def deprecated_kids
+      @core.deprecated_kids
+    end
+
+    # +false+ on every shipped build. +true+ means this binding trusts the
+    # PUBLISHED TEST root and must never be used outside tests.
+    def self.uses_test_trust_root?
+      ensure_native!
+      K9oKeepCoreFfiUniffi.uses_test_trust_root
+    end
+
+    # Inspect an input (normalize -> deny -> local verdict). Obfuscation is
+    # peeled BEFORE matching, so static deny-lists aren't defeated by trivial
+    # tricks. +waypoint_class+ is the manifest's meter hint — it NEVER gates the
+    # decision. Returns the verdict object (+decision+ / +reason+ / +matched+ /
+    # +schema_valid+ / +waypoint_class_hint+ / +fail_mode+ / +ruleset_version+ /
+    # +core_version+).
+    def inspect(text, waypoint_class: nil)
+      @core.inspect_input(text, waypoint_class)
+    end
+
+    # Local L3 stand-in classification ("clear"|"suspicious"|"malicious"). No
+    # receipt — a classification is not an enforcement decision.
+    def classify(text)
+      @core.classify_local(text)
+    end
+
+    # Open an output stream-filter bound to the active ruleset's exfil markers.
+    def create_output_filter
+      OutputFilter.new(@core.output_filter)
+    end
+
+    # The bound core's semver (audit anchor; rides every verdict too).
+    def core_version
+      @core.core_version
+    end
+
+    # Guard: raise a clear KError if the native lib is absent (evaluated BEFORE
+    # any reference to the +K9oKeepCoreFfiUniffi+ namespace, which may be
+    # undefined).
+    def self.ensure_native!
+      return if NATIVE_AVAILABLE
+
+      raise K9o::KError.new(
+        code: 'K9O_BARBICAN_WASM_ERROR',
+        message: 'barbican native library not available for this platform/Ruby; install the platform-specific k9o gem.'
+      )
+    end
+
+    # Map the bound core's error -> +K9o::KError+. +KeepError::RulesetInvalid+
+    # is the only typed variant (bad/stale/malformed ruleset) — its reason token
+    # (+version_stale+ / +signature_invalid+ / +malformed+ / an unknown-severity
+    # message) rides in +context[:reason]+. Anything else from the native layer
+    # (e.g. a Rust panic surfaced as +InternalError+) maps to the generic code.
+    def self.to_kerror(e, stage = 'ruleset')
+      if e.respond_to?(:reason)
+        K9o::KError.new(
+          code: 'K9O_BARBICAN_RULESET_INVALID',
+          message: e.to_s,
+          context: { reason: e.reason, stage: stage }
+        )
+      else
+        K9o::KError.new(code: 'K9O_BARBICAN_WASM_ERROR', message: e.to_s)
+      end
+    end
+
+    # Accept string or symbol keys ({"id" => ..} or {id: ..}) for ergonomics.
+    def build_rule(r)
+      K9oKeepCoreFfiUniffi::KeepRule.new(
+        id: r[:id] || r['id'],
+        pattern: r[:pattern] || r['pattern'],
+        severity: r[:severity] || r['severity']
+      )
+    end
+    private :build_rule
+
+    def signed_blob(ruleset_version, rules, signing_key_kid, signature, created_at)
+      K9oKeepCoreFfiUniffi::KeepSignedRulesetBlob.new(
+        ruleset_version: ruleset_version,
+        rules: rules.map { |r| build_rule(r) },
+        signing_key_kid: signing_key_kid,
+        signature: signature.b,
+        created_at: created_at
+      )
+    end
+    private :signed_blob
+  end
+
+  # A streaming output redactor. Buffer-and-scan-before-flush: never emits a
+  # byte the core has not cleared (no RST-after-leak).
+  class OutputFilter
+    def initialize(handle)
+      @handle = handle
+    end
+
+    # Feed a chunk; returns the cleared (redacted) prefix safe to emit now.
+    def push(chunk)
+      @handle.push(chunk)
+    end
+
+    # Flush the residual buffer (also scanned) at end of stream.
+    def finish
+      @handle.finish
+    end
+
+    # Leak report (counts only — never the leaked values): an object with
+    # +emails+ / +secrets+ / +markers+ / +total+.
+    def report
+      @handle.report
+    end
+  end
+end

data/lib/k9o/client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module K9o
+  # The customer-facing client returned by K9o.create_client.
+  class K9oClient
+    attr_reader :config, :projects, :gate, :studio, :compute, :realtime, :org,
+                :orgs, :migrations, :functions, :policies, :audit, :me, :kibo, :ai, :storage
+
+    def initialize(config)
+      @config = config
+      @projects = Projects.new(config)
+      @gate = Gate.new(config)
+      @studio = Studio.new(config)
+      @compute = Compute.new(config)
+      @realtime = Realtime.new(config)
+      @org = Org.new(config)
+      @orgs = Orgs.new(config)
+      @migrations = Migrations.new(config)
+      @functions = Functions.new(config)
+      @policies = Policies.new(config)
+      @audit = Audit.new(config)
+      @me = Me.new(config)
+      @kibo = KiboNamespace.new(config)
+      @ai = Ai.new(config)
+      @storage = Storage.new(config)
+    end
+
+    def from(collection)
+      FromBuilder.new(@config, collection)
+    end
+
+    def base_url
+      @config.base_url
+    end
+  end
+
+  # Factory — construct a K9oClient bound to the supplied options.
+  #
+  # Per spec sample:
+  #   k9o = K9o.create_client(
+  #     api_key: ENV["K9O_API_KEY"],
+  #     org_slug: "acme",
+  #     project_slug: "member-portal",
+  #   )
+  #
+  # base_url is OPTIONAL. When omitted it
+  # defaults to the platform apex https://api.k9o.io; when the host is the
+  # bare apex and org_slug is set, the canonical org-subdomain wire root
+  # https://<org_slug>.api.k9o.io is composed. Any other host passes through.
+  def self.create_client(base_url: nil, api_key: nil, org_slug: nil, project_slug: nil, default_headers: {}, http_client: nil)
+    normalised = UrlGrammar.resolve_base_url(base_url, org_slug)
+    config = HttpClientConfig.new(
+      base_url: normalised,
+      api_key: api_key, org_slug: org_slug, project_slug: project_slug,
+      default_headers: default_headers, http_client: http_client
+    )
+    K9oClient.new(config)
+  end
+end

data/lib/k9o/compute.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module K9o
+  # Compute namespace (Compute LLMs registry).
+  # k9o.compute.llms.*
+  class Compute
+    # Curated 9-model closed enum (extensible v2.x).
+    LLM_MODEL_IDS = %w[
+      mistral-7b mistral-8x7b llama-3-8b llama-3-70b
+      claude-3-5-sonnet gpt-4o gpt-4o-mini
+      text-embedding-3-small text-embedding-3-large
+    ].freeze
+
+    attr_reader :llms
+
+    def initialize(config)
+      @llms = Llms.new(config)
+    end
+
+    # k9o.compute.llms.*.
+    class Llms
+      def initialize(config)
+        @config = config
+      end
+
+      def list(modality: nil)
+        slug = Studio.require_project_slug(@config, 'compute.llms')
+        q = modality ? { 'modality' => modality } : nil
+        HttpTransport.request(config: @config, method: 'GET',
+                              path: UrlGrammar.project_path(slug, 'compute/llms'), query: q)
+      end
+
+      def read(model_id)
+        slug = Studio.require_project_slug(@config, 'compute.llms')
+        HttpTransport.request(config: @config, method: 'GET',
+                              path: UrlGrammar.project_path(slug, "compute/llms/#{enc(model_id)}"))
+      end
+
+      # Synchronous inference (PROJECT_AUTHOR/ADMIN).
+      def invoke(model_id, prompt:, params: nil)
+        slug = Studio.require_project_slug(@config, 'compute.llms')
+        body = { 'prompt' => prompt }
+        body['params'] = params if params
+        HttpTransport.request(config: @config, method: 'POST',
+                              path: UrlGrammar.project_path(slug, "compute/llms/#{enc(model_id)}/invoke"), body: body)
+      end
+
+      # Streaming inference (SSE per-token). Returns an
+      # Enumerator of chunk hashes (Ruby idiom). Consume with
+      # `.each { |chunk| ... }`.
+      def invoke_stream(model_id, prompt:, params: nil)
+        slug = Studio.require_project_slug(@config, 'compute.llms')
+        body = { 'prompt' => prompt }
+        body['params'] = params if params
+        HttpTransport.stream_sse(config: @config, method: 'POST',
+                                 path: UrlGrammar.project_path(slug, "compute/llms/#{enc(model_id)}/invoke-stream"),
+                                 body: body)
+      end
+
+      private
+
+      def enc(s)
+        ::URI.encode_www_form_component(s)
+      end
+    end
+  end
+end

data/lib/k9o/data.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module K9o
+  # Data-plane DSL.
+  #
+  # Usage:
+  #
+  #   response = k9o.from('posts').select.eq('status', 'published').limit(10).execute
+  #   response.data.each { |row| puts row }
+  class FromBuilder
+    def initialize(config, collection)
+      @config = config
+      @collection = collection
+    end
+
+    def select
+      SelectBuilder.new(@config, @collection)
+    end
+
+    def insert(record)
+      HttpTransport.request(
+        config: @config, method: 'POST', path: FromBuilder.collection_path(@config, @collection), body: record
+      )
+    end
+
+    def update(patch)
+      UpdateBuilder.new(@config, @collection, patch)
+    end
+
+    def delete
+      DeleteBuilder.new(@config, @collection)
+    end
+
+    def self.collection_path(config, collection)
+      raise KError.new(
+        code: 'K9O_MISSING_PROJECT_CONTEXT',
+        message: 'data-plane operations require project_slug to be bound on the client',
+        context: { collection: collection },
+        recommendation: 'Pass project_slug: in K9o.create_client(...).'
+      ) if config.project_slug.nil? || config.project_slug.empty?
+
+      unless collection.is_a?(String) && collection.match?(/\A[a-z][a-z0-9_-]{0,62}\z/)
+        raise KError.new(
+          code: 'K9O_INVALID_FIELD_VALUE',
+          message: "collection name #{collection.inspect} does not match required format",
+          context: { collection: collection }
+        )
+      end
+      UrlGrammar.project_path(config.project_slug, "data/#{collection}")
+    end
+  end
+
+  # Shared filter/pagination state.
+  class BaseBuilder
+    def initialize(config, collection)
+      @config = config
+      @collection = collection
+      @filters = []
+      @limit_val = nil
+      @cursor_val = nil
+      @count_mode = nil
+    end
+
+    %i[eq neq gt gte lt lte like ilike is].each do |op|
+      define_method(op) do |column, value|
+        @filters << [column, op.to_s, value.to_s]
+        self
+      end
+    end
+
+    def in_(column, values)
+      @filters << [column, 'in', "(#{values.map(&:to_s).join(',')})"]
+      self
+    end
+
+    def not_in(column, values)
+      @filters << [column, 'notIn', "(#{values.map(&:to_s).join(',')})"]
+      self
+    end
+
+    def filter(column, op, value)
+      @filters << [column, op.to_s, value.to_s]
+      self
+    end
+
+    def limit(n)
+      @limit_val = n
+      self
+    end
+
+    def cursor(opaque)
+      @cursor_val = opaque
+      self
+    end
+
+    def count(mode)
+      @count_mode = mode
+      self
+    end
+
+    protected
+
+    def to_query
+      q = {}
+      @filters.each do |col, op, val|
+        q[col] = val.start_with?('(') ? "#{op}.#{val}" : "#{op}.#{val}"
+      end
+      q['limit'] = @limit_val.to_s if @limit_val
+      q['cursor'] = @cursor_val if @cursor_val
+      q['count'] = @count_mode if @count_mode
+      q
+    end
+  end
+
+  class SelectBuilder < BaseBuilder
+    def execute
+      HttpTransport.request(
+        config: @config, method: 'GET',
+        path: FromBuilder.collection_path(@config, @collection),
+        query: to_query
+      )
+    end
+  end
+
+  class UpdateBuilder < BaseBuilder
+    def initialize(config, collection, patch)
+      super(config, collection)
+      @patch = patch
+    end
+
+    def execute
+      id_filter = @filters.find { |col, op, _| col == 'id' && op == 'eq' }
+      raise KError.new(
+        code: 'K9O_INVALID_FIELD_VALUE',
+        message: 'update() requires .eq("id", ...) filter; changing many rows in one call is not supported',
+        context: { collection: @collection }
+      ) unless id_filter
+
+      path = "#{FromBuilder.collection_path(@config, @collection)}/#{id_filter[2]}"
+      HttpTransport.request(config: @config, method: 'PATCH', path: path, body: @patch)
+    end
+  end
+
+  class DeleteBuilder < BaseBuilder
+    def execute
+      id_filter = @filters.find { |col, op, _| col == 'id' && op == 'eq' }
+      raise KError.new(
+        code: 'K9O_INVALID_FIELD_VALUE',
+        message: 'delete() requires .eq("id", ...) filter; deleting many rows in one call is not supported',
+        context: { collection: @collection }
+      ) unless id_filter
+
+      path = "#{FromBuilder.collection_path(@config, @collection)}/#{id_filter[2]}"
+      HttpTransport.request(config: @config, method: 'DELETE', path: path)
+    end
+  end
+end

data/lib/k9o/envelope.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module K9o
+  # Standard envelope returned by every k9o surface on success.
+  class Envelope
+    attr_reader :data, :meta
+
+    def initialize(data:, meta:)
+      @data = data
+      @meta = meta
+    end
+
+    def self.from_wire(wire)
+      Envelope.new(
+        data: wire['data'],
+        meta: Meta.from_wire(wire['meta'] || {})
+      )
+    end
+  end
+
+  # Meta accessor sugar.
+  class Meta
+    attr_reader :cursor, :subscription, :idempotency, :warnings, :cost, :timing, :context
+
+    def initialize(cursor: nil, subscription: nil, idempotency: nil, warnings: [], cost: {}, timing: nil, context: nil)
+      @cursor = cursor
+      @subscription = subscription
+      @idempotency = idempotency
+      @warnings = warnings
+      @cost = cost
+      @timing = timing
+      @context = context
+    end
+
+    def self.from_wire(wire)
+      cursor = wire['cursor'] ? MetaCursor.new(next_: wire['cursor']['next'], total_count: wire['cursor']['totalCount']) : nil
+      sub = wire['subscription'] ? MetaSubscription.new(is_initial: !!wire['subscription']['isInitial']) : nil
+      idem = wire['idempotency'] ? MetaIdempotency.new(replayed: !!wire['idempotency']['replayed']) : nil
+      warnings = (wire['warnings'] || []).map { |w| MetaWarning.new(code: w['code'] || '', message: w['message'] || '') }
+      timing = wire['timing'] ? MetaTiming.new(total_ms: wire['timing']['totalMs'].to_i) : nil
+      context = wire['context'] && wire['context']['requestId'] ? MetaContext.new(request_id: wire['context']['requestId']) : nil
+      Meta.new(
+        cursor: cursor, subscription: sub, idempotency: idem,
+        warnings: warnings, cost: wire['cost'] || {},
+        timing: timing, context: context
+      )
+    end
+  end
+
+  class MetaCursor
+    attr_reader :next, :total_count
+
+    def initialize(next_:, total_count:)
+      @next = next_
+      @total_count = total_count
+    end
+  end
+
+  MetaSubscription = Struct.new(:is_initial, keyword_init: true)
+  MetaIdempotency = Struct.new(:replayed, keyword_init: true)
+  MetaWarning = Struct.new(:code, :message, keyword_init: true)
+  MetaTiming = Struct.new(:total_ms, keyword_init: true)
+  MetaContext = Struct.new(:request_id, keyword_init: true)
+end

data/lib/k9o/functions.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module K9o
+  # Function lifecycle namespace — k9o.functions.*.
+  class Functions
+    def initialize(config)
+      @config = config
+    end
+
+    def deploy(name:, runtime:, code:, tier: nil, config: nil)
+      slug = require_project_slug
+      body = { 'name' => name, 'runtime' => runtime, 'code' => code }
+      body['tier'] = tier if tier
+      body['config'] = config if config
+      HttpTransport.request(config: @config, method: 'POST', path: UrlGrammar.project_path(slug, 'functions'), body: body)
+    end
+
+    def list(status: nil)
+      slug = require_project_slug
+      q = status ? { 'status' => status } : nil
+      HttpTransport.request(config: @config, method: 'GET', path: UrlGrammar.project_path(slug, 'functions'), query: q)
+    end
+
+    def get(name)
+      slug = require_project_slug
+      HttpTransport.request(config: @config, method: 'GET', path: UrlGrammar.project_path(slug, "functions/#{enc(name)}"))
+    end
+
+    def delete(name)
+      slug = require_project_slug
+      HttpTransport.request(config: @config, method: 'DELETE', path: UrlGrammar.project_path(slug, "functions/#{enc(name)}"))
+    end
+
+    # Invoke a function; payload passed to the runtime verbatim.
+    def invoke(name, payload)
+      slug = require_project_slug
+      HttpTransport.request(config: @config, method: 'POST',
+                            path: UrlGrammar.project_path(slug, "functions/#{enc(name)}/invoke"), body: payload)
+    end
+
+    private
+
+    def require_project_slug
+      Studio.require_project_slug(@config, 'functions')
+    end
+
+    def enc(s)
+      ::URI.encode_www_form_component(s)
+    end
+  end
+end