cache_bro 0.1.0

data/lib/generators/cache_bro/install/install_generator.rb

@@ -0,0 +1,35 @@
+require "rails/generators"
+require "generators/bro_hub/installable"
+
+module CacheBro
+  module Generators
+    # bin/rails generate cache_bro:install
+    class InstallGenerator < Rails::Generators::Base
+      # BroHub first (one mount for all the Bro gems), then CacheBro itself.
+      include BroHub::Generators::Installable
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Sets up the BroHub dashboard (CacheBro lives in it), adds the CacheBro initializer and copies the migration."
+
+      def copy_initializer
+        copy_config_once "cache_bro.rb", "config/initializers/cache_bro.rb"
+      end
+
+      def copy_migrations
+        rails_command "cache_bro:install:migrations", inline: true
+      end
+
+      def next_steps
+        say <<~TEXT
+
+          CacheBro is installed. Next:
+            1. bin/rails db:migrate
+            2. Say who may do what in config/initializers/cache_bro.rb
+            3. Give your Redis cache store a namespace (config.cache_store = :redis_cache_store, { namespace: "myapp" })
+            4. Visit #{bro_hub_path}/cache_bro (BroHub mounts CacheBro under its own path)
+        TEXT
+      end
+    end
+  end
+end

data/lib/generators/cache_bro/install/templates/cache_bro.rb

@@ -0,0 +1,32 @@
+# CacheBro lets people browse, inspect and purge the Redis cache from the BroHub dashboard.
+CacheBro.configure do |config|
+  # Who may do what. Each lambda gets the signed in user (nil when signed out).
+  # Everything is denied until you change these.
+  config.can_view_keys = ->(user) { false }   # open CacheBro, search keys, see TTL and size, e.g. user&.developer?
+  config.can_view_values = ->(user) { false } # reveal what a key holds (audited). Values can hold personal data
+  config.can_delete = ->(user) { false }      # delete one key
+  config.can_purge = ->(user) { false }       # delete every key matching a pattern, e.g. user&.lead?
+  config.can_flush = ->(user) { false }       # delete everything in the store's namespace, e.g. user&.admin?
+  config.can_audit = ->(user) { false }       # read the audit log
+  # Higher includes lower: flush includes purge and delete, purge includes delete, and all of them include
+  # view_keys. view_values and audit stand alone.
+
+  # Which cache stores to manage. The name shows in the UI and the audit log. Only Rails' :redis_cache_store
+  # is supported, and it should have a `namespace:` so CacheBro stays out of keys that aren't the cache's.
+  # config.stores = { "Rails.cache" => -> { Rails.cache } }
+  # config.stores = { "App cache" => -> { Rails.cache }, "Sessions" => -> { MySessionCache } }
+
+  # Destructive actions that need a typed reason (kept in the audit log): any of :reveal, :delete, :purge, :flush.
+  # config.reason_required_for = %i[ purge flush ]
+
+  # A single purge deletes at most this many keys, then stops (run it again for more).
+  # config.max_purge_keys = 100_000
+
+  # Engine controllers inherit from parent_controller, so its authentication applies.
+  # config.parent_controller = "::ApplicationController"
+  # config.current_user = ->(controller) { controller.send(:current_user) }
+  # config.user_label = ->(user) { user.email }
+
+  # Reject plain HTTP.
+  # config.require_ssl = Rails.env.production?
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: cache_bro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ruby Dev SRL
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: bro_hub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+description: 'A mountable Rails engine for the BroHub dashboard: search cache keys,
+  see TTL and size, reveal a value, delete a key or purge a pattern. Permissions are
+  plain lambdas, destructive actions can require a reason, and everything lands in
+  an append-only audit log.'
+email:
+- office@rubydev.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/cache_bro/application_controller.rb
+- app/controllers/cache_bro/audit_events_controller.rb
+- app/controllers/cache_bro/flushes_controller.rb
+- app/controllers/cache_bro/keys_controller.rb
+- app/controllers/cache_bro/purges_controller.rb
+- app/helpers/cache_bro/application_helper.rb
+- app/models/cache_bro/application_record.rb
+- app/models/cache_bro/audit_event.rb
+- app/views/cache_bro/audit_events/index.html.erb
+- app/views/cache_bro/audit_events/show.html.erb
+- app/views/cache_bro/flushes/new.html.erb
+- app/views/cache_bro/keys/index.html.erb
+- app/views/cache_bro/keys/show.html.erb
+- app/views/cache_bro/purges/new.html.erb
+- app/views/cache_bro/purges/preview.html.erb
+- app/views/cache_bro/shared/_store_tabs.html.erb
+- app/views/cache_bro/shared/forbidden.html.erb
+- app/views/cache_bro/shared/unsupported.html.erb
+- config/routes.rb
+- db/migrate/20261115130000_create_cache_bro_audit_events.rb
+- lib/cache_bro.rb
+- lib/cache_bro/audit.rb
+- lib/cache_bro/configuration.rb
+- lib/cache_bro/engine.rb
+- lib/cache_bro/errors.rb
+- lib/cache_bro/redis_store.rb
+- lib/cache_bro/version.rb
+- lib/generators/cache_bro/install/install_generator.rb
+- lib/generators/cache_bro/install/templates/cache_bro.rb
+homepage: https://www.rubydev.ro
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://www.rubydev.ro
+  source_code_uri: https://github.com/rubydevro/cache_bro
+  bug_tracker_uri: https://github.com/rubydevro/cache_bro/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Browse, inspect and purge your Rails Redis cache from the browser, with every
+  action audited.
+test_files: []