ree_lib 1.3.9 → 1.3.11

data/lib/ree_lib/packages/ree_roda/spec/ree_roda/plugins/ree_routes_audit_spec.rb

@@ -0,0 +1,281 @@
+require "rack/test"
+
+package_require("ree_roda/app")
+package_require("ree_actions/dsl")
+package_require("ree_routes/dsl")
+package_require("ree_roda/plugins/ree_routes")
+package_require("ree_audit/beans/audit")
+
+require "warden"
+
+RSpec.describe "ree_routes audit" do
+  include Rack::Test::Methods
+
+  link :audit, from: :ree_audit
+
+  before :all do
+    Ree.enable_irb_mode
+
+    module ReeRodaAuditTest
+      include Ree::PackageDSL
+
+      package do
+        depends_on :ree_actions
+        depends_on :ree_errors
+      end
+    end
+
+    class ReeRodaAuditTest::OkCmd
+      include ReeActions::DSL
+
+      action :ok_cmd
+
+      def call(access, attrs)
+        {result: "ok"}
+      end
+    end
+
+    class ReeRodaAuditTest::DeniedCmd
+      include ReeActions::DSL
+
+      action :denied_cmd do
+        link :permission_error, from: :ree_errors
+      end
+
+      PermissionErr = permission_error(:no_access, msg: "not allowed")
+
+      def call(access, attrs)
+        raise PermissionErr
+      end
+    end
+
+    class ReeRodaAuditTest::BoomCmd
+      include ReeActions::DSL
+
+      action :boom_cmd
+
+      def call(access, attrs)
+        raise ArgumentError.new("boom")
+      end
+    end
+
+    class ReeRodaAuditTest::Routes
+      include ReeRoutes::DSL
+
+      opts = {from: :ree_roda_audit_test}
+
+      routes :routes do
+        default_warden_scope :audit_visitor
+
+        get "api/internal_default" do
+          summary "Internal route"
+          sections "Admin"
+          visibility :internal
+          action :ok_cmd, **opts
+        end
+
+        get "api/internal_silenced" do
+          summary "Internal route we do not want in the trail"
+          sections "Admin"
+          visibility :internal
+          audit false
+          action :ok_cmd, **opts
+        end
+
+        get "api/public_default" do
+          summary "Public route"
+          sections "Public"
+          action :ok_cmd, **opts
+        end
+
+        get "api/public_audited" do
+          summary "Public route touching someone else's data"
+          sections "Public"
+          audit true
+          action :ok_cmd, **opts
+        end
+
+        get "api/internal_denied" do
+          summary "Internal route refusing access"
+          sections "Admin"
+          visibility :internal
+          action :denied_cmd, **opts
+        end
+
+        get "api/internal_boom" do
+          summary "Internal route blowing up"
+          sections "Admin"
+          visibility :internal
+          action :boom_cmd, **opts
+        end
+      end
+    end
+
+    class AuditVisitorStrategy < Warden::Strategies::Base
+      include Ree::LinkDSL
+
+      def valid?
+        true
+      end
+
+      def authenticate!
+        success!({user: "visitor"})
+      end
+    end
+
+    Warden::Strategies.add(:audit_visitor, AuditVisitorStrategy)
+
+    audit_bean = audit
+
+    # Class.new keeps `audit_bean` in scope; a `class` keyword would open a new
+    # lexical scope and lose it.
+    audited_app = Class.new(ReeRoda::App) do
+      use Warden::Manager do |config|
+        config.default_strategies :audit_visitor
+        config.default_scope = :audit_visitor
+        config.scope_defaults :audit_visitor, strategies: [:audit_visitor], store: false
+
+        config.failure_app = -> (env) {
+          [401, {"Content-Type" => "text/plain"}, ["requires authentication"]]
+        }
+      end
+
+      plugin :ree_routes, audit: audit_bean
+
+      ree_routes ReeRodaAuditTest::Routes.new, api_url: "http://some.api.url:1337"
+
+      route do |r|
+        r.ree_routes
+      end
+    end
+
+    Object.const_set(:AuditedTestApp, audited_app)
+
+    # Same routes, no `audit:` option — the regression guard for every other
+    # project running on ree_lib.
+    plain_app = Class.new(ReeRoda::App) do
+      use Warden::Manager do |config|
+        config.default_strategies :audit_visitor
+        config.default_scope = :audit_visitor
+        config.scope_defaults :audit_visitor, strategies: [:audit_visitor], store: false
+
+        config.failure_app = -> (env) {
+          [401, {"Content-Type" => "text/plain"}, ["requires authentication"]]
+        }
+      end
+
+      plugin :ree_routes
+
+      ree_routes ReeRodaAuditTest::Routes.new, api_url: "http://some.api.url:1337"
+
+      route do |r|
+        r.ree_routes
+      end
+    end
+
+    Object.const_set(:PlainTestApp, plain_app)
+  end
+
+  after :all do
+    Ree.disable_irb_mode
+  end
+
+  let(:test_sink) {
+    Class.new(ReeAudit::Sink) do
+      attr_reader :events
+
+      def initialize
+        @events = []
+      end
+
+      def write(event)
+        @events << event
+      end
+    end.new
+  }
+
+  let(:app) { AuditedTestApp.app }
+
+  before {
+    audit.sink = test_sink
+    ReeAudit::Context.clear
+  }
+
+  after {
+    audit.sink = ReeAudit::NullSink.new
+    ReeAudit::Context.clear
+  }
+
+  it "writes an internal route to the trail" do
+    get "api/internal_default"
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq("{}")
+
+    expect(test_sink.events.size).to eq(1)
+
+    event = test_sink.events.first
+    expect(event.action_name).to eq(:ok_cmd)
+    expect(event.package_name).to eq(:ree_roda_audit_test)
+    expect(event.status).to eq(:ok)
+    expect(event.sections).to eq(["Admin"])
+    expect(event.request_method).to eq(:get)
+    expect(event.path).to eq("api/internal_default")
+    expect(event.request_path).to eq("/api/internal_default")
+    expect(event.accessor).to eq({user: "visitor"})
+  end
+
+  it "leaves a silenced internal route out of the trail" do
+    get "api/internal_silenced"
+
+    expect(last_response.status).to eq(200)
+    expect(test_sink.events).to be_empty
+  end
+
+  it "leaves a public route out of the trail" do
+    get "api/public_default"
+
+    expect(last_response.status).to eq(200)
+    expect(test_sink.events).to be_empty
+  end
+
+  it "writes a public route that asked to be audited" do
+    get "api/public_audited"
+
+    expect(last_response.status).to eq(200)
+    expect(test_sink.events.size).to eq(1)
+    expect(test_sink.events.first.status).to eq(:ok)
+  end
+
+  it "records a refusal and still answers 403" do
+    get "api/internal_denied"
+
+    expect(last_response.status).to eq(403)
+
+    event = test_sink.events.first
+    expect(event.status).to eq(:denied)
+    expect(event.error_message).to eq("not allowed")
+  end
+
+  it "records a failure and still lets the error handler answer 500" do
+    get "api/internal_boom"
+
+    expect(last_response.status).to eq(500)
+
+    event = test_sink.events.first
+    expect(event.status).to eq(:error)
+    expect(event.error_type).to eq("ArgumentError")
+  end
+
+  context "an application that never asked for audit" do
+    let(:app) { PlainTestApp.app }
+
+    it "behaves exactly as before" do
+      get "api/internal_default"
+
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq("{}")
+      expect(test_sink.events).to be_empty
+    end
+  end
+end

data/lib/ree_lib/packages/ree_roda/spec/spec_helper.rb

@@ -1,3 +1,6 @@
 RSpec.configure do |config|
   config.extend Ree::RSpecLinkDSL
 end
+
+# The audit plugin option is inert unless the package itself is enabled.
+ENV['AUDIT_ENABLED'] = 'true'

data/lib/ree_lib/packages/ree_routes/package/ree_routes/route.rb

@@ -3,7 +3,9 @@
 class ReeRoutes::Route
   attr_accessor :summary, :request_method, :serializer, :respond_to,
                 :sections, :action, :route, :warden_scopes, :path, :override,
-                :visibility
+                :visibility, :before, :redirect
+
+  attr_writer :audit
 
   # Routing always includes every route; visibility only affects generated docs.
   def public?
@@ -14,6 +16,14 @@ class ReeRoutes::Route
     !public?
   end
 
+  # Internal routes are audited unless told otherwise. `visibility` is
+  # mandatory for admin paths (see DSL#define_route), so this list can never
+  # drift away from the set of routes that actually touch client data — which a
+  # hand-maintained list of audited routes inevitably would.
+  def audited?
+    @audit.nil? ? internal? : @audit
+  end
+
   def valid?
     !action.nil? && !summary.nil? && !warden_scopes.nil? && !warden_scopes.empty?
   end

data/lib/ree_lib/packages/ree_routes/package/ree_routes/route_builder.rb

@@ -44,6 +44,13 @@ class ReeRoutes::RouteBuilder
     @route.summary = str
   end
 
+  # Needed in exactly two cases: silencing a noisy internal route, and turning
+  # the trail on for a public route that reaches into someone else's data.
+  contract Bool => Bool
+  def audit(value)
+    @route.audit = value
+  end
+
   contract Symbol => Symbol
   def visibility(value)
     if !VISIBILITIES.include?(value)

data/lib/ree_lib/packages/ree_routes/spec/ree_routes/dsl_spec.rb

@@ -68,6 +68,38 @@ RSpec.describe ReeRoutes::DSL, type: [:autoclean] do
         end
       end
     end
+
+    class ReeRoutesTest::AuditRoutes
+      include ReeRoutes::DSL
+
+      routes :audit_routes do
+        default_warden_scope :user
+
+        get "internal_default" do
+          summary "Internal route, audited by default"
+          action :cmd, from: :ree_routes_test
+          visibility :internal
+        end
+
+        get "internal_silenced" do
+          summary "Internal route, deliberately not audited"
+          action :cmd, from: :ree_routes_test
+          visibility :internal
+          audit false
+        end
+
+        get "public_default" do
+          summary "Public route, not audited"
+          action :cmd, from: :ree_routes_test
+        end
+
+        get "public_audited" do
+          summary "Public route reaching into someone else's data"
+          action :cmd, from: :ree_routes_test
+          audit true
+        end
+      end
+    end
   end
 
   after :all do
@@ -92,4 +124,15 @@ RSpec.describe ReeRoutes::DSL, type: [:autoclean] do
 
     expect(csv_route.respond_to).to eq(:csv)
   }
+
+  it {
+    routes = ReeRoutesTest::AuditRoutes.new.each_with_object({}) { |r, acc|
+      acc[r.path] = r
+    }
+
+    expect(routes["internal_default"].audited?).to eq(true)
+    expect(routes["internal_silenced"].audited?).to eq(false)
+    expect(routes["public_default"].audited?).to eq(false)
+    expect(routes["public_audited"].audited?).to eq(true)
+  }
 end

data/lib/ree_lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReeLib
-  VERSION = "1.3.9"
+  VERSION = "1.3.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ree_lib
 version: !ruby/object:Gem::Version
-  version: 1.3.9
+  version: 1.3.11
 platform: ruby
 authors:
 - Ruslan Gatiyatov
@@ -276,6 +276,20 @@ files:
 - lib/ree_lib/packages/ree_array/spec/ree_array/functions/split_by_spec.rb
 - lib/ree_lib/packages/ree_array/spec/ree_array/functions/wrap_spec.rb
 - lib/ree_lib/packages/ree_array/spec/spec_helper.rb
+- lib/ree_lib/packages/ree_audit/.rspec
+- lib/ree_lib/packages/ree_audit/package/ree_audit.rb
+- lib/ree_lib/packages/ree_audit/package/ree_audit/beans/audit.rb
+- lib/ree_lib/packages/ree_audit/package/ree_audit/config.rb
+- lib/ree_lib/packages/ree_audit/package/ree_audit/context.rb
+- lib/ree_lib/packages/ree_audit/package/ree_audit/event.rb
+- lib/ree_lib/packages/ree_audit/package/ree_audit/functions/filter_params.rb
+- lib/ree_lib/packages/ree_audit/package/ree_audit/sinks/logger_sink.rb
+- lib/ree_lib/packages/ree_audit/package/ree_audit/sinks/null_sink.rb
+- lib/ree_lib/packages/ree_audit/package/ree_audit/sinks/sink.rb
+- lib/ree_lib/packages/ree_audit/spec/ree_audit/beans/audit_spec.rb
+- lib/ree_lib/packages/ree_audit/spec/ree_audit/context_spec.rb
+- lib/ree_lib/packages/ree_audit/spec/ree_audit/functions/filter_params_spec.rb
+- lib/ree_lib/packages/ree_audit/spec/spec_helper.rb
 - lib/ree_lib/packages/ree_dao/.gitignore
 - lib/ree_lib/packages/ree_dao/.rspec
 - lib/ree_lib/packages/ree_dao/bin/console
@@ -303,6 +317,7 @@ files:
 - lib/ree_lib/packages/ree_dao/package/ree_dao/thread_parents.rb
 - lib/ree_lib/packages/ree_dao/package/ree_dao/wrappers/pg_array.rb
 - lib/ree_lib/packages/ree_dao/package/ree_dao/wrappers/pg_jsonb.rb
+- lib/ree_lib/packages/ree_dao/spec/ree_dao/db_load_performance_mode_spec.rb
 - lib/ree_lib/packages/ree_dao/spec/ree_dao/functions/build_dto_spec.rb
 - lib/ree_lib/packages/ree_dao/spec/ree_dao/functions/build_pg_connection_spec.rb
 - lib/ree_lib/packages/ree_dao/spec/ree_dao/functions/build_sqlite_connection/max_connections_spec.rb
@@ -624,6 +639,7 @@ files:
 - lib/ree_lib/packages/ree_dto/package/ree_dto/entity_dsl.rb
 - lib/ree_lib/packages/ree_dto/package/ree_dto/functions/build_dto.rb
 - lib/ree_lib/packages/ree_dto/package/ree_dto/functions/build_dto_collection_class.rb
+- lib/ree_lib/packages/ree_dto/spec/ree_dto/build_from_attrs_spec.rb
 - lib/ree_lib/packages/ree_dto/spec/ree_dto/dsl_spec.rb
 - lib/ree_lib/packages/ree_dto/spec/ree_dto/entity_dsl_spec.rb
 - lib/ree_lib/packages/ree_dto/spec/spec_helper.rb
@@ -763,6 +779,7 @@ files:
 - lib/ree_lib/packages/ree_mapper/.rspec
 - lib/ree_lib/packages/ree_mapper/bin/console
 - lib/ree_lib/packages/ree_mapper/package/ree_mapper.rb
+- lib/ree_lib/packages/ree_mapper/package/ree_mapper/db_load_compiler.rb
 - lib/ree_lib/packages/ree_mapper/package/ree_mapper/default_factory.rb
 - lib/ree_lib/packages/ree_mapper/package/ree_mapper/dsl.rb
 - lib/ree_lib/packages/ree_mapper/package/ree_mapper/errors/argument_error.rb
@@ -797,7 +814,9 @@ files:
 - lib/ree_lib/packages/ree_mapper/package/ree_mapper/types/time.rb
 - lib/ree_lib/packages/ree_mapper/package/ree_mapper/wrappers/abstract_wrapper.rb
 - lib/ree_lib/packages/ree_mapper/package/ree_mapper/wrappers/array.rb
+- lib/ree_lib/packages/ree_mapper/spec/ree_mapper/benchmarks/db_load_benchmark_spec.rb
 - lib/ree_lib/packages/ree_mapper/spec/ree_mapper/benchmarks/mapper_benchmark_spec.rb
+- lib/ree_lib/packages/ree_mapper/spec/ree_mapper/db_load_performance_mode_spec.rb
 - lib/ree_lib/packages/ree_mapper/spec/ree_mapper/dsl/dsl_spec.rb
 - lib/ree_lib/packages/ree_mapper/spec/ree_mapper/functions/build_mapper_factory_spec.rb
 - lib/ree_lib/packages/ree_mapper/spec/ree_mapper/functions/build_mapper_strategy_spec.rb
@@ -892,6 +911,7 @@ files:
 - lib/ree_lib/packages/ree_roda/package/ree_roda/services/status_from_error.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/app_spec.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/plugins/ree_logger_spec.rb
+- lib/ree_lib/packages/ree_roda/spec/ree_roda/plugins/ree_routes_audit_spec.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/services/build_routing_tree_spec.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/services/build_swagger_from_routes_spec.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/services/locales/en.yml