command_tower 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 408a811a73f66bbaa2785653542b4b94e1824381f325f5f60a1cfc06e97a913a
-  data.tar.gz: 84a05525bd6cba9201672711ffee110ad20e856d3a0d278f23994610e57d389e
+  metadata.gz: 465f6aea711f7cb8158e7b3eb9389663c2ac06d5104e89335da339d04cda81b6
+  data.tar.gz: 3e8c5a0b870ec8fd71f954ee3e04573cf87bf3eb3b8091e056dddb0db37176a6
 SHA512:
-  metadata.gz: 1fe68a093c4add78fb8143068ba91c2aad354219aa33ed8f7b80b3c205e0d72025888842364c26034ed1856b7899c2ce05f4d52ee8a4a94c4a7d53d989c04eb5
-  data.tar.gz: f538a68acaffbe712d185ab5fc843b171c2c07d95837e6d81fc3f334b70f6fb6b2d71b4ffeb61805c2c72ada4828dbe68f165fe304bf84ae28c8274b38eb4740
+  metadata.gz: 38ac950878823bda838001b2948ef4c54fe6b07cd0520242681607415f0ffce8c3ac795280fda9248a8a7ba449ffeef1cd8403a89777940d1ee0e846ba683906
+  data.tar.gz: b42d36dc8afb1cc9d0df9f254622b01981984d50f7839eebe8040056714e91d04b1b30dd397828133f270056f7032a695b06071c7cb958d65f4f0885d95c415f

data/app/controllers/command_tower/application_controller.rb

@@ -3,6 +3,7 @@
 module CommandTower
   class ApplicationController < ActionController::API
     include CommandTower::Execution::HttpBoundary
+    include CommandTower::Execution::ClientCompatibilityBoundary
 
     AUTHENTICATION_HEADER = CommandTower::Jwt::AuthorizationHelper::AUTHENTICATION_HEADER
     AUTHENTICATION_EXPIRE_HEADER = CommandTower::Jwt::AuthorizationHelper::AUTHENTICATION_EXPIRE_HEADER

data/app/controllers/command_tower/me/experience_states_controller.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Me
+    class ExperienceStatesController < CommandTower::ApplicationController
+      include CommandTower::Auth::AuthenticationBoundary
+      include CommandTower::Auth::AuthorizationBoundary
+
+      before_action :authenticate_request!
+      before_action :authorize_request!
+
+      def index
+        result = CommandTower::Workflows::Me::ExperienceStates::ListWorkflow.call(
+          current_user: current_user,
+          auth_context: current_auth_context,
+        )
+        render_application_result(result)
+      end
+
+      def complete
+        deserialized = CommandTower::Deserializers::Me::ExperienceStates::CompleteDeserializer.call(params)
+        return render_deserializer_errors unless deserialized.success?
+
+        result = CommandTower::Workflows::Me::ExperienceStates::CompleteWorkflow.call(
+          current_user: current_user,
+          experience_key: deserialized.input.experience_key,
+          scope_type: deserialized.input.scope_type,
+          scope_identifier: deserialized.input.scope_identifier,
+          version: deserialized.input.version,
+          auth_context: current_auth_context,
+        )
+        render_application_result(result)
+      end
+
+      private
+
+      def render_deserializer_errors
+        render_application_result(
+          CommandTower::Workflows::WorkflowResult.failure(
+            errors: [
+              CommandTower::Errors::ValidationError.new(
+                details: { base: "Missing or invalid experience state completion fields" },
+              ),
+            ],
+            http_status: :unprocessable_entity,
+          ),
+        )
+      end
+    end
+  end
+end

data/app/controllers/concerns/command_tower/execution/client_compatibility_boundary.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Execution
+    # Runs the client-version-compatibility check for every JSON request,
+    # before any authentication/authorization filter. Transport-only: it
+    # invokes exactly one workflow and renders its result — all decisioning
+    # lives in `Workflows::ClientCompatibility::EvaluateWorkflow` /
+    # `Services::ClientCompatibility::Evaluate` (authority §10).
+    #
+    # Hosts that need to exempt a controller (e.g. a healthz-style endpoint)
+    # do so with `skip_before_action :evaluate_client_compatibility!`.
+    module ClientCompatibilityBoundary
+      extend ActiveSupport::Concern
+
+      included do
+        include CommandTower::Api::ApplicationResponseRenderer
+        before_action :evaluate_client_compatibility!
+      end
+
+      private
+
+      def evaluate_client_compatibility!
+        result = CommandTower::Workflows::ClientCompatibility::EvaluateWorkflow.call(
+          request: request,
+          controller_class: self.class,
+          action_name: action_name
+        )
+
+        unless result.success?
+          render_application_result(result)
+          return false
+        end
+
+        true
+      end
+    end
+  end
+end

data/app/deserializers/command_tower/deserializers/me/experience_states/complete_deserializer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Deserializers
+    module Me
+      module ExperienceStates
+        class CompleteDeserializer < CommandTower::Deserializers::ApplicationDeserializer
+          Input = Data.define(:experience_key, :scope_type, :scope_identifier, :version)
+
+          MAX_LENGTH = 128
+
+          def call(params)
+            experience_key = extract(params, :experienceKey, :experience_key)
+            scope_type = extract(params, :scopeType, :scope_type)
+            scope_identifier = extract(params, :scopeIdentifier, :scope_identifier)
+            version = extract(params, :version, :Version)
+
+            if [experience_key, scope_type, scope_identifier, version].any?(&:blank?)
+              return failure(errors: { message: "missing_required_fields" })
+            end
+
+            if [experience_key, scope_type, scope_identifier, version].any? { |value| value.length > MAX_LENGTH }
+              return failure(errors: { message: "invalid_field_length" })
+            end
+
+            success(
+              Input.new(
+                experience_key:,
+                scope_type:,
+                scope_identifier:,
+                version:,
+              ),
+            )
+          end
+
+          private
+
+          def extract(params, *keys)
+            keys.each do |key|
+              raw = params[key] || params[key.to_s]
+              next if raw.nil?
+
+              value = raw.to_s.strip
+              return value unless value.empty?
+            end
+            ""
+          end
+        end
+      end
+    end
+  end
+end

data/app/errors/command_tower/errors/account/experience_states_host_unconfigured_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Errors
+    module Account
+      class ExperienceStatesHostUnconfiguredError < CommandTower::Errors::ApplicationError
+        def code
+          "experience_states_host_unconfigured"
+        end
+
+        def message
+          "Experience states are currently unavailable"
+        end
+
+        def log_level
+          :warn
+        end
+      end
+    end
+  end
+end

data/app/errors/command_tower/errors/client_update_required_error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Errors
+    # Hard client-version incompatibility (authority §14). Deliberately NOT
+    # registered in `SessionErrorStatus` — its HTTP status (426) is set
+    # directly by `Workflows::ClientCompatibility::EvaluateWorkflow`, not
+    # derived from that closed 401/403/412 mapping table.
+    class ClientUpdateRequiredError < ApplicationError
+      def initialize(details: {})
+        super(details:)
+      end
+
+      def code
+        "client_update_required"
+      end
+
+      def message
+        "Client update required"
+      end
+
+      def log_level
+        :warn
+      end
+    end
+  end
+end

data/app/models/command_tower/user_experience_state.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CommandTower
+  class UserExperienceState < CommandTower::ApplicationRecord
+    self.table_name = "user_experience_states"
+
+    belongs_to :user
+
+    validates :host_key, :experience_key, :scope_type, :scope_identifier, :version, presence: true
+    validates :experience_key,
+              uniqueness: {
+                scope: %i[user_id host_key scope_type scope_identifier version],
+              }
+
+    scope :for_user_and_host, ->(user:, host_key:) { where(user:, host_key:) }
+  end
+end

data/app/serializers/command_tower/serializers/me/experience_states/experience_state_serializer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Serializers
+    module Me
+      module ExperienceStates
+        class ExperienceStateSerializer
+          def self.serialize(state)
+            new(state).serialize
+          end
+
+          def self.serialize_collection(states)
+            {
+              experienceStates: Array(states).map { |state| serialize(state) },
+            }
+          end
+
+          def initialize(state)
+            @state = state
+          end
+
+          def serialize
+            {
+              hostKey: @state.host_key,
+              experienceKey: @state.experience_key,
+              scopeType: @state.scope_type,
+              scopeIdentifier: @state.scope_identifier,
+              version: @state.version,
+              completedAt: @state.completed_at&.iso8601,
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/app/serializers/command_tower/serializers/messaging/inbox.rb

@@ -16,7 +16,8 @@ module CommandTower
           def self.serialize(item)
             ItemSerializer.serialize(item).merge(
               body: item.fetch(:body), metadata: item[:metadata],
-              notificationTypeKey: item.fetch(:notification_type_key)
+              notificationTypeKey: item.fetch(:notification_type_key),
+              content: item.fetch(:content)
             )
           end
         end

data/app/services/command_tower/email_theme/resolver.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module EmailTheme
+    # Internal rendering-time collaborator (not a Service/Workflow/Controller).
+    #
+    # Assembles the full semantic token set an email template needs: the
+    # visual tokens from CommandTower.config.email_theme plus the identity
+    # tokens CommandTower already exposes (config.application). Shared by
+    # Messaging email templates and, later, CT's own auth mail templates —
+    # hence its own top-level namespace rather than living under
+    # Messaging::Rendering.
+    #
+    # No template calls this yet (Rich Messaging Strategy §12 steps C/D are
+    # separate, later slices). This is deliberately not a
+    # CommandTower::Services::ApplicationService: it takes no arguments,
+    # performs no I/O, and cannot fail under normal config state — there is
+    # nothing to validate and nothing to fail. Mirrors
+    # Messaging::Rendering::TemplateResolver's own documented exemption.
+    class Resolver
+      class << self
+        def resolve
+          new.resolve
+        end
+      end
+
+      def resolve
+        theme = CommandTower.config.email_theme
+        {
+          canvas_background: theme.canvas_background,
+          surface_background: theme.surface_background,
+          surface_border: theme.surface_border,
+          primary_text: theme.primary_text,
+          body_text: theme.body_text,
+          muted_text: theme.muted_text,
+          accent: theme.accent,
+          text_on_accent: theme.text_on_accent,
+          primary_action: theme.primary_action,
+          product_name: CommandTower.app_name_for_comms,
+          product_url: CommandTower.config.application.composed_url
+        }.freeze
+      end
+    end
+  end
+end

data/app/services/command_tower/messaging/notification_types/declaration.rb

@@ -22,6 +22,7 @@ module CommandTower
         :retention,
         :delivery_status_visible,
         :host_ownership,
+        :inbox_document_composer,
       ) do
         def self.build(
           key:,
@@ -41,7 +42,8 @@ module CommandTower
           priority: nil,
           retention: nil,
           delivery_status_visible: nil,
-          host_ownership: nil
+          host_ownership: nil,
+          inbox_document_composer: nil
         )
           new(
             key: key.nil? ? nil : key.to_s,
@@ -62,6 +64,17 @@ module CommandTower
             retention:,
             delivery_status_visible:,
             host_ownership:,
+            # Rich Messaging Slice 2.5 revision — String class name of a
+            # pure-Ruby Inbox document composer (`.call(communication:) ->
+            # InboxDocument`), lazily `.constantize`d by
+            # `InboxDocumentRenderer` at render time, never at registration
+            # time (mirrors the existing RBAC `Entity#controller` deferred
+            # class-string convention — decouples host `to_prepare`
+            # registration order from composer class-load order). `nil`
+            # means this type intentionally has no custom Inbox document and
+            # renders via `InboxDocumentRenderer#build_generic`. See
+            # artifacts/visual-improvements/rich-messaging/authority/RICH_MESSAGING_RUBY_INBOX_DEFINITION_DISCOVERY.md.
+            inbox_document_composer: inbox_document_composer.nil? ? nil : inbox_document_composer.to_s,
           ).freeze
         end
 

data/app/services/command_tower/messaging/rendering/channel_renderer.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "erb"
 require "cgi"
 
 module CommandTower
@@ -12,7 +11,7 @@ module CommandTower
         PUSHOVER_CHANNEL = "pushover"
         PUSH_CHANNEL = "push"
         SUPPORTED_CHANNELS = [EMAIL_CHANNEL, SMS_CHANNEL, PUSHOVER_CHANNEL, PUSH_CHANNEL].freeze
-        TEMPLATE_DIR = CommandTower::Engine.root.join("app/views/command_tower/messaging/rendering")
+        TEMPLATE_FILENAME_PATTERN = /\A(?<basename>[a-z]+)\.(?<format>html|text)\.erb\z/
         DEFAULT_TITLE = "Notification"
 
         def self.render(communication:, channel_key:, recipient_address:)
@@ -120,24 +119,56 @@ module CommandTower
         alias pushover_title notification_title
 
         def render_template(filename)
-          path = TEMPLATE_DIR.join(filename)
-          raise Errno::ENOENT, "missing template #{filename}" unless path.file?
-
-          template = ERB.new(path.read, trim_mode: "-")
-          template.result_with_hash(template_locals)
+          match = TEMPLATE_FILENAME_PATTERN.match(filename.to_s)
+          raise Errno::ENOENT, "missing template #{filename}" unless match
+
+          TemplateResolver.render(
+            basename: match[:basename],
+            format: match[:format].to_sym,
+            notification_type_key: @communication.notification_type_key,
+            generic_locals: template_locals,
+            type_locals: type_template_locals,
+          )
         end
 
+        # ActionView's OutputBuffer auto-escapes any interpolated value that is
+        # not marked `html_safe?`, for every format (html and text alike) —
+        # see `ActionView::OutputBuffer#<<`. Generic templates historically
+        # relied on plain ERB, which never auto-escaped anything; callers
+        # (namely `email.html.erb`) explicitly call `h.call(...)` when they
+        # want escaping. To preserve that exact contract under ActionView
+        # rendering, `title`/`body`/`deep_link` are pre-marked `html_safe` (so
+        # raw interpolation stays unescaped, matching legacy behavior) and
+        # `h.call` marks its own already-escaped output `html_safe` too, so it
+        # is not escaped a second time by the output buffer.
         def template_locals
+          {
+            title: @communication.title.to_s.html_safe,
+            body: @communication.body.to_s.html_safe,
+            deep_link: deep_link_from_metadata&.html_safe,
+            h: ->(value) { CGI.escapeHTML(value.to_s).html_safe },
+          }
+        end
+
+        def type_template_locals
+          template_locals.merge(
+            metadata: frozen_metadata,
+            notification_type_key: @communication.notification_type_key.to_s,
+          )
+        end
+
+        def deep_link_from_metadata
           metadata = @communication.metadata
           deep_link = metadata.is_a?(Hash) ? metadata["deep_link"] || metadata[:deep_link] : nil
           deep_link = deep_link.to_s if deep_link
+          deep_link.presence
+        end
 
-          {
-            title: @communication.title.to_s,
-            body: @communication.body.to_s,
-            deep_link: deep_link.presence,
-            h: ->(value) { CGI.escapeHTML(value.to_s) },
-          }
+        def frozen_metadata
+          metadata = @communication.metadata
+          return {}.freeze unless metadata.is_a?(Hash)
+
+          metadata.to_h.transform_keys(&:to_s).freeze
         end
       end
     end

data/app/services/command_tower/messaging/rendering/inbox_document.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module CommandTower
+  module Messaging
+    module Rendering
+      # Frozen v1 Inbox content document. Rendered at read (never persisted) by
+      # `InboxDocumentRenderer`. Blocks are plain frozen Hashes, not nested
+      # `Data` objects, so `#to_h` is already the exact JSON-serializable shape
+      # the `content` response key needs — no extra conversion at the
+      # serializer boundary.
+      #
+      # This value object only guarantees the envelope (`schema` tag, `blocks`
+      # is an Array); block-level construction and validation is
+      # `InboxDocumentRenderer`'s responsibility.
+      InboxDocument = Data.define(:schema, :blocks)
+
+      # Reopened (rather than defined inside the `Data.define` block) so that
+      # `SCHEMA_V1` and `.build` attach to `InboxDocument` under normal
+      # lexical constant scoping — a block passed to `Data.define` does not
+      # change the lexical scope for constant assignment the way `class ...
+      # end` does.
+      class InboxDocument
+        SCHEMA_V1 = "inbox_document_v1"
+
+        def self.build(blocks:)
+          raise ArgumentError, "blocks must be an Array" unless blocks.is_a?(Array)
+          raise ArgumentError, "arbitrary hashes are not accepted as blocks entries" if blocks.any? { |b| !b.is_a?(Hash) }
+
+          new(schema: SCHEMA_V1, blocks: blocks.freeze).freeze
+        end
+
+        # Small pure-Ruby authoring DSL (Rich Messaging Slice 2.5 revision —
+        # replaces `inbox_document.json.erb` entirely; see
+        # artifacts/visual-improvements/rich-messaging/authority/RICH_MESSAGING_RUBY_INBOX_DEFINITION_DISCOVERY.md).
+        # A notification-type Inbox document composer calls `.compose` and
+        # authors an ordered document via exactly three methods:
+        #
+        #   doc.paragraph "..."
+        #   doc.cta "label", path: "/internal/route"
+        #   doc.cta "label", href: "https://external.example/..."
+        #   doc.presentation "pickem.make_picks", variant: :compact
+        #
+        # `cta` takes exactly one of `path:` (an internal, origin-free
+        # destination the host's own navigation owns) or `href:` (an
+        # absolute external URL opened via the platform's normal external-
+        # link handling). The composer — which already knows whether a
+        # destination is its own app's route or a third-party URL — states
+        # that intent explicitly via a typed `destination`, rather than
+        # having the frontend infer it from an absolute URL (Slice 2.6.4;
+        # see artifacts/visual-improvements/rich-messaging/plans/
+        # 2.6.4-ct-fe-inbox-navigation-capability.md).
+        # `presentation` intentionally has no `data:`/`props:` argument at
+        # all — the message type may only *name* a registered presentation
+        # capability. Its data is composed separately, post-authoring, by
+        # `InboxDocumentRenderer` and the registered presentation composer
+        # (Rich Messaging Presentation Authority §8). There is no argument
+        # slot to violate that boundary with.
+        def self.compose
+          builder = Builder.new
+          yield builder
+          build(blocks: builder.blocks)
+        end
+
+        class Builder
+          UNSAFE_SCHEMES = %w[javascript data vbscript].freeze
+          DEFAULT_CTA_LABEL = "Open"
+
+          def initialize
+            @blocks = []
+          end
+
+          def paragraph(text)
+            return self unless text.is_a?(String) && !text.empty?
+
+            @blocks << { type: "paragraph", text: }.freeze
+            self
+          end
+
+          def cta(label, path: nil, href: nil)
+            destination = cta_destination(path:, href:)
+            return self unless destination
+
+            resolved_label = label.is_a?(String) && !label.strip.empty? ? label : DEFAULT_CTA_LABEL
+            @blocks << { type: "cta", label: resolved_label, destination: }.freeze
+            self
+          end
+
+          def presentation(key, variant: nil)
+            @blocks << { type: "presentation", key: key.to_s, variant: variant&.to_s }.freeze
+            self
+          end
+
+          def blocks
+            @blocks
+          end
+
+          private
+
+          # Internal takes precedence when both are supplied — a `cta` only
+          # ever means one navigation intent, and a composer that mistakenly
+          # supplies both almost certainly means the internal one.
+          def cta_destination(path:, href:)
+            if safe_internal_path?(path)
+              { kind: "internal", path: }
+            elsif safe_href?(href)
+              { kind: "external", href: }
+            end
+          end
+
+          # A leading `//` is rejected even though it "starts with a slash" —
+          # it is a protocol-relative URL (browsers/RN resolve it against
+          # whatever scheme is active), not a safe same-app-only destination.
+          def safe_internal_path?(path)
+            path.is_a?(String) && path.start_with?("/") && !path.start_with?("//")
+          end
+
+          def safe_href?(href)
+            return false unless href.is_a?(String) && !href.strip.empty?
+
+            scheme = URI.parse(href).scheme&.downcase
+            scheme.present? && UNSAFE_SCHEMES.exclude?(scheme)
+          rescue URI::InvalidURIError
+            false
+          end
+        end
+      end
+    end
+  end
+end