feat(api): expose rule export endpoints (#1602)

* feat(api): expose rule export endpoints * fix(api): tighten rule export contracts * fix(api): document balance sheet auth errors * test(api): align rule API key fixtures * Update docs/api/openapi.yaml Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Juan José Mata <jjmata@jjmata.com> * Quick win Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Juan José Mata <jjmata@jjmata.com> --------- Signed-off-by: Juan José Mata <juanjo.mata@gmail.com> Signed-off-by: Juan José Mata <jjmata@jjmata.com> Co-authored-by: Juan José Mata <juanjo.mata@gmail.com> Co-authored-by: Juan José Mata <jjmata@jjmata.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-05-10 14:15:01 +00:00 · 2026-05-01 11:47:06 -06:00
parent 352c301e4b
commit 783309188f
11 changed files with 795 additions and 0 deletions
--- a/app/controllers/api/v1/rules_controller.rb
+++ b/app/controllers/api/v1/rules_controller.rb
@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+class Api::V1::RulesController < Api::V1::BaseController
+  include Pagy::Backend
+
+  BOOLEAN_FILTERS = {
+    "true" => true,
+    "1" => true,
+    "false" => false,
+    "0" => false
+  }.freeze
+  RESOURCE_TYPES = %w[transaction].freeze
+
+  before_action :ensure_read_scope
+  before_action :set_rule, only: :show
+
+  def index
+    return render_invalid_resource_type_filter if invalid_resource_type_filter?
+
+    @per_page = safe_per_page_param
+    rules_query = current_resource_owner.family.rules
+      .includes(:actions, conditions: :sub_conditions)
+      .order(:created_at, :id)
+
+    rules_query = rules_query.where(resource_type: params[:resource_type]) if params[:resource_type].present?
+    if params[:active].present?
+      active = parse_boolean_filter(params[:active])
+      return if performed?
+
+      rules_query = rules_query.where(active: active)
+    end
+
+    @pagy, @rules = pagy(
+      rules_query,
+      page: safe_page_param,
+      limit: @per_page
+    )
+
+    render :index
+  end
+
+  def show
+    render :show
+  end
+
+  private
+
+    def set_rule
+      @rule = current_resource_owner.family.rules
+        .includes(:actions, conditions: :sub_conditions)
+        .find(params[:id])
+    end
+
+    def ensure_read_scope
+      authorize_scope!(:read)
+    end
+
+    def safe_page_param
+      page = params[:page].to_i
+      page > 0 ? page : 1
+    end
+
+    def safe_per_page_param
+      per_page = params[:per_page].to_i
+      case per_page
+      when 1..100
+        per_page
+      else
+        25
+      end
+    end
+
+    def parse_boolean_filter(value)
+      normalized = value.to_s.downcase
+      return BOOLEAN_FILTERS[normalized] if BOOLEAN_FILTERS.key?(normalized)
+
+      render json: {
+        error: "validation_failed",
+        message: "active must be one of: true, false, 1, 0"
+      }, status: :unprocessable_entity
+      nil
+    end
+
+    def invalid_resource_type_filter?
+      params[:resource_type].present? && !params[:resource_type].in?(RESOURCE_TYPES)
+    end
+
+    def render_invalid_resource_type_filter
+      render json: {
+        error: "validation_failed",
+        message: "resource_type must be one of: #{RESOURCE_TYPES.join(", ")}"
+      }, status: :unprocessable_entity
+    end
+end