A Rails-inspired framework for building serverless Ruby applications on AWS Lambda.
Belt bundles everything you need to go from zero to production:
- BeltController — callbacks, strong parameters, error handling, CORS
- Belt::LambdaHandler — Lambda entry point with observability, CORS preflight, error wrapping
- Belt::ActionRouter — request routing to controllers from route manifests
- ActiveItem — DynamoDB ORM (queries, validations, associations, transactions)
- Lambda Loadout — structured logging, CloudWatch metrics (EMF), error alerting
Add to your Gemfile:
gem "belt"Then:
bundle installmy-app/
├── infrastructure/
│ ├── routes.tf.rb # Belt provider route definitions
│ └── schema.tf.rb # DynamoDB table schemas
├── lambda/
│ ├── config/
│ │ └── environment.rb # App boot file (used by console + Lambda)
│ ├── controllers/
│ │ └── posts_controller.rb
│ ├── models/
│ │ └── post.rb
│ ├── lib/
│ │ └── routes.rb
│ └── api.rb # Lambda entry point
├── .irbrc # Console customization (optional)
├── Gemfile
└── Gemfile.lock
require "activeitem"
class Post < ActiveItem::Base
self.primary_key = :id
attr_accessor :id, :user_id, :title, :body, :created_at
validates :title, presence: true
before_create { self.id ||= SecureRandom.uuid }
endrequire "belt"
class PostsController < BeltController::Base
before_action :authenticate!
# Implicit response: assigns become the JSON body
# → { "posts": [ { "id": "...", "title": "..." }, ... ] }
def index
@posts = Post.where(user_id: current_user_id, index: "UserIndex")
end
def show
@post = Post.find(params["id"])
end
# Implicit body + non-200 status
def create
attrs = params.require(:post).permit(:title, :body).to_h
@post = Post.create!(attrs.merge(user_id: current_user_id))
response_status :created
end
def destroy
Post.find(params["id"]).destroy
head :no_content
end
endUse Belt::LambdaHandler to get automatic observability, CORS preflight handling, and error wrapping:
require "belt"
include Belt::LambdaHandler
ROUTER = Belt::ActionRouter.new(routes: Routes::API, namespace: "api")
def execute(path:, body:, event:)
ROUTER.route(event: event, body: body)
endThat's it. lambda_handler is automatically your Lambda function handler. It:
- Initializes structured logging and CloudWatch metrics
- Handles OPTIONS preflight requests
- Parses JSON request bodies
- Catches unhandled errors and returns proper CORS-enabled error responses
- Calls your
executemethod for routing
The Conveyor Belt Terraform provider (formerly Dispatcher) handles Lambda packaging, API Gateway routing, and IAM permissions.
Add the provider to your Terraform config:
terraform {
required_providers {
conveyor-belt = {
source = "stowzilla/conveyor-belt"
version = "~> 0.0.1"
}
}
}Define routes in infrastructure/routes.tf.rb:
Belt.application.routes.draw do
namespace :api do
resources :posts, only: [:index, :show, :create]
end
endDefine tables in infrastructure/schema.tf.rb:
Belt.application.schema.define do
model :post do
partition_key :id, :string
global_secondary_index :UserIndex, partition_key: :user_id
end
endThen deploy:
terraform init
terraform applyThe provider will:
- Package your Ruby code into Lambda functions
- Create API Gateway routes matching your DSL
- Generate IAM policies for DynamoDB table access
- Set up CloudWatch log groups
class AdminController < BeltController::Base
before_action :authenticate!
before_action :require_admin!, except: [:health]
skip_before_action :authenticate!, only: [:health]
endparams.require(:user).permit(:name, :email, address: [:street, :city])class ApiController < BeltController::Base
rescue_from MyCustomError, with: :handle_custom
private
def handle_custom(exception, _context = {})
error_response(exception.message, 422)
end
endsuccess_response({ id: "123", name: "Example" }) # 200 JSON with CORS
success_response({ id: "123" }, :created) # 201 Created (symbol or int)
error_response("Not found", :not_found) # 404 JSON error
error_response("Nope", :unprocessable_entity) # 422
html_response("<h1>Hello</h1>") # 200 HTML with CORS
head :no_content # 204 empty body
head :created # 201 empty body# App-wide — typically in lambda/config/environment.rb
Belt.configure do |config|
config.default_format = :json # default
end
# Per-controller override
class PagesController < ApplicationController
self.default_format = :html
end:json(default): action assigns →success_response({ posts: [...] }):html: action assigns stay on the controller; Belt implicitlyrendersviews/<controller>/<action>.html.erb. Missing template raisesBelt::TemplateNotFound(no silent JSON fallback).- Explicit helpers always win:
success_response,error_response,html_response,render,head.
def create
@post = Post.create!(...)
response_status :created # → 201 + { post: {...} }
endBelt discovers controllers from the app's namespace module first, then searches Belt.all_controller_paths — which includes app-defined paths. No registration needed.
Belt provides global Belt::Observability::Logger and Belt::Observability::Metrics facades that are set automatically by Belt::LambdaHandler. Access them from anywhere:
Belt::Observability::Logger.info("Something happened", user_id: "123")
Belt::Observability::Metrics.track_event("OrderCreated", model: "Order")| Variable | Purpose |
|---|---|
ENVIRONMENT |
Controls verbose error responses (dev*, local, test) |
BELT_METRICS_NAMESPACE |
CloudWatch metrics namespace (default: Belt) |
ACTION |
Service name for logging (falls back to function name) |
ERROR_NOTIFICATION_TOPIC_ARN |
SNS topic for error alerts |
CORS_ALLOWED_ORIGINS |
Comma-separated origins (overrides domain vars) |
CUSTOMER_APP_DOMAIN |
Primary app domain for CORS |
OPS_APP_DOMAIN |
Internal tools domain for CORS |
Belt includes a command-line interface for project management.
Start an interactive Ruby console with your app loaded. Belt uses convention over configuration:
- Loads
lambda/config/environment.rb(your app's boot file — AWS setup, models, libs) - Starts IRB with
reload!available - Reads
.irbrcfrom the project root (console-specific customization)
belt console # uses BELT_ENV or defaults to 'dev'
belt c prod # specify environment explicitly
belt c dev02 --run "Customer.first" # runner mode (execute and exit)A production safety prompt is shown when the environment is prod.
Display route definitions from your infrastructure/routes.tf.rb. This is the primary way to inspect what endpoints your app exposes.
belt routesOutput (single namespace):
VERB PATH CONTROLLER#ACTION
------------------------------------------------------------------
GET /posts posts#index
GET /posts/{post_id} posts#show
POST /posts posts#create
DELETE /posts/{post_id} posts#destroy
When multiple namespaces (API Gateways) exist, GATEWAY and LAMBDA columns are added automatically:
VERB PATH GATEWAY LAMBDA CONTROLLER#ACTION
---------------------------------------------------------------
GET /posts blog blog posts#index
POST /posts blog blog posts#create
GET /posts ops ops posts#index
POST /posts ops ops posts#create
| Flag | Description |
|---|---|
-g, --grep PATTERN |
Filter routes matching pattern (case-insensitive, matches verb, path, gateway, lambda, controller, or action) |
-f, --format FORMAT |
Output format: concise (default) or json |
--namespace NAMESPACE |
Generate Ruby route files for NAMESPACE (or "all") |
--output-dir DIR |
Output directory for generated Ruby files (default: lambda/lib/routes/) |
--schema FILE |
Path to schema.tf.rb for model definitions (default: same directory as routes file) |
--tables-file FILE |
Path to Terraform file with aws_dynamodb_table resources for table inference |
-h, --help |
Show help |
# Filter routes by pattern
belt routes -g posts
# JSON output (for tooling/CI)
belt routes -f json
# Generate Ruby route constant for the "api" namespace
belt routes --namespace api
# Generate to a custom directory
belt routes --namespace api --output-dir lib/routes
# Include schema models in JSON output
belt routes -f json --schema infrastructure/schema.tf.rb
# Infer DynamoDB table access from Terraform
belt routes -f json --tables-file infrastructure/main.tfWith --format json, the output includes a routes array and optionally a models array (when a schema file is found):
{
"routes": [
{
"name": "posts",
"verb": "GET",
"path": "/posts",
"gateway": "api",
"lambda": "api",
"controller": "posts",
"action": "index",
"auth": "cognito",
"tables": ["posts"],
"request_model": "",
"response_model": ""
}
],
"models": [
{
"name": "CreatePost",
"kind": "request",
"description": "Request model: CreatePost",
"properties": {
"title": { "type": "string" },
"body": { "type": "string" }
},
"required": ["title"]
}
]
}With --namespace NAMESPACE, Belt generates a frozen Ruby constant file at lambda/lib/routes/<namespace>_routes.rb:
# frozen_string_literal: true
# Auto-generated by: belt routes --namespace api
# Do not edit manually
module Routes
API = [
{
verb: "GET",
path: "/posts",
gateway: "api",
lambda: "api",
controller: "posts",
action: "index",
auth: "cognito",
tables: ["posts"]
}
].freeze
endThis is used by Belt::ActionRouter at runtime for request routing.
The command expects infrastructure/routes.tf.rb in the current working directory. Routes are defined using the same DSL as the Belt Terraform provider:
Belt.application.routes.draw do
namespace :api do
resources :posts, only: [:index, :show, :create, :destroy]
resource :profile, only: [:show, :update]
get "health", action: :health
end
endWhen --tables-file is provided, Belt parses aws_dynamodb_table resource blocks from your Terraform files and infers which tables each route accesses based on the resource name in the route path. Routes can also declare tables explicitly in the DSL via tables: [:posts, :comments].
Belt integrates automated pre-deploy backups directly into the deploy lifecycle. No standalone scripts, no generators — belt deploy handles everything.
This walks you through enabling backups for an existing Belt app from scratch.
Create infrastructure/<env>/belt.rb in your environment directory (e.g. infrastructure/prod/belt.rb):
# infrastructure/prod/belt.rb
Belt.configure do |config|
config.backups do
dynamodb :all
retention snapshots: 90
end
endThat's the minimum — every DynamoDB table in this environment will get an on-demand snapshot before each deploy, retained for 90 days. PITR (point-in-time recovery) will be verified as enabled.
belt deploy prodOutput:
━━━ pre-deploy backup ━━━
📦 Creating backup bucket: my-app-backups-prod
✅ Backup bucket created and secured
🔍 Verifying PITR: my-app-prod-posts → enabled ✓
📸 Snapshot: my-app-prod-posts → my-app-prod-posts-20260723-170000 ✓
🧹 Cleanup: 0 expired snapshots removed
━━━ terraform init ━━━
...
The backup bucket is created automatically on first run (versioned, public access blocked). Subsequent deploys reuse it.
As your app grows, add Cognito and S3 backups:
# infrastructure/prod/belt.rb
Belt.configure do |config|
config.backups do
dynamodb :all # On-demand snapshots + PITR verification
cognito :users, :pool_config # Export user list + pool settings to S3
s3 :legal_documents # Sync bucket contents to backup bucket
retention snapshots: 90, cognito: 10, s3: 10
end
end| Backup type | What it does | Retention default |
|---|---|---|
dynamodb :all |
PITR check + on-demand snapshot per table | 90 days |
dynamodb :posts, :users |
Same, but only named tables | 90 days |
cognito :users |
Paginated user export → JSON in backup bucket | 10 copies |
cognito :pool_config |
Pool configuration export → JSON | 10 copies |
s3 :bucket_name |
Full sync to backup bucket | 10 copies |
Don't configure backups for dev environments — just omit the file or the backups block:
# infrastructure/dev01/belt.rb
Belt.configure do |config|
# No backups block = no backups run during deploy
endOr simply don't create infrastructure/dev01/belt.rb at all.
If you only need DynamoDB backups with all defaults:
# infrastructure/prod/belt.rb
Belt.configure do |config|
config.backups = true
endThis enables DynamoDB snapshots for all tables with 90-day retention.
| Flag | Description |
|---|---|
--skip-backup |
Skip backup phase (useful for CI re-runs) |
--backup-only |
Run backups without deploying |
# Normal deploy (runs backups first if configured)
belt deploy prod
# Skip backups this time
belt deploy prod --skip-backup
# Just create a recovery point, don't deploy
belt deploy prod --backup-onlyAll DynamoDB tables generated by Belt include safety defaults:
point_in_time_recovery {
enabled = var.enable_pitr # true by default
}
deletion_protection_enabled = var.deletion_protection # true in prod, false in devThese are set via Terraform variables in each environment's terraform.tfvars. PITR gives you 35 days of continuous recovery regardless of the snapshot schedule.
- Backup bucket — Belt creates
<app-name>-backups-<env>on first run (versioned, public access blocked) - Table discovery — Table names are read from
terraform output(requires at least one prior successful deploy) - DynamoDB — Verifies PITR is enabled, then creates an on-demand backup named
<table>-<timestamp> - Cognito — Uses
list-users(paginated) anddescribe-user-poolto export JSON to the backup bucket - S3 — Runs
aws s3 syncfrom source bucket tos3://<backup-bucket>/s3/<bucket-name>/<timestamp>/ - Cleanup — Removes snapshots/copies older than the configured retention
The backup phase reads table names from Terraform outputs. On a brand-new environment that has never been deployed, there are no outputs yet — Belt will warn and skip the backup phase gracefully. After the first successful deploy, backups run normally on subsequent deploys.
Belt is designed to stay lean. Optional capabilities ship as separate gems that plug into the CLI and runtime the same way Rails engines and generators do.
| Gem | Purpose | Status |
|---|---|---|
belt-messaging |
Two-way SMS via AWS End User Messaging (Pinpoint) | Early (not production-hardened) |
belt-pay |
Stripe payments & subscriptions | Early (not production-hardened) |
Install a plugin in a Belt app:
# Gemfile
gem "belt-messaging"
# gem "belt-pay"bundle install
belt generate messaging # or: belt g pay
belt generate --help # lists built-ins + gem generatorsNo central registry file, no initializer hook. Belt discovers generators by scanning loaded gems:
- Gem is in the app
Gemfileand bundled - Gem ships a file at
lib/belt/generators/<name>_generator.rb - Class lives in
Belt::Generators, named<Name>Generator - Implements
.run(args)(required),.destroy(args)and.description(optional)
That is the whole contract. After bundle install, belt generate <name> and belt destroy <name> just work.
See Belt::CLI::GeneratorRegistry and the CHANGELOG entry for 0.1.13 Generator Extension API.
belt-messaging/
├── belt-messaging.gemspec
├── lib/
│ ├── belt-messaging.rb # require entrypoint
│ └── belt/
│ ├── messaging.rb # Belt::Messaging API
│ ├── messaging/
│ │ ├── configuration.rb
│ │ ├── version.rb
│ │ ├── controllers/ # default controllers (optional)
│ │ └── templates/ # ERB templates for the generator
│ │ ├── terraform/
│ │ ├── lambda/
│ │ ├── config/
│ │ └── controllers/
│ └── generators/
│ └── messaging_generator.rb # ← auto-discovered
└── spec/
Runtime code stays in the gem. Generators copy only what the host app must own (Terraform modules, Lambda entrypoints, optional controller overrides). Prefer gem defaults + belt g <plugin> --controllers over dumping everything into the app (same idea as rails g devise:views).
Scaffold a ready-to-fill gem (Rails-style plugin new):
belt plugin new notifications
# → ./belt-notifications/
belt plugin new pay --path ~/Code --summary "Stripe payments for Belt"
# → ~/Code/belt-pay/Then:
cd belt-notifications
bundle install
# implement lib/belt/notifications/* and the generatorPoint a Belt app at it while developing:
# In the app Gemfile
gem "belt-notifications", path: "../belt-notifications"bundle install
belt generate notificationsWhen packaging Lambdas, belt deploy vendors path gems into vendor/cache so conveyor-belt can package them.
A solid plugin generator typically:
- Terraform module →
infrastructure/modules/<name>/(main.tf,variables.tf,outputs.tf) - Lambda config →
config/lambda/<name>.yml(timeout, memory, env, triggers) - Lambda entrypoint →
lambda/<name>.rbusingBelt::LambdaHandler - Routes / schema → inject into
config/routes.tf.rborinfrastructure/schema.tf.rbwhen needed - Optional overrides →
--controllersflag for app-local subclasses - Destroy path →
belt destroy <name>removes what generate created - Help text →
.description+--helpexplaining what was installed and next steps
Copy from belt-messaging or belt-pay rather than inventing a new structure.
Bug reports and pull requests are welcome on GitHub.
git clone https://github.com/stowzilla/belt.git
cd belt
bundle install
bundle exec rspec
bundle exec rubocop- Branch from
master— open a PR againstmaster - Keep changes focused — one concern per PR when practical
- Follow existing patterns — look at neighboring files and
lib/belt/cli/before inventing new ones - Tests + lint — run
bundle exec rspecandbundle exec rubocopbefore opening (or updating) a PR. CI requires both (plusbundler-audit); failing checks block merge onmaster - Changelog — note user-facing changes in
CHANGELOG.mdunder the next version / Unreleased - No secrets — never commit AWS keys, tokens, or real account IDs
| Path | What lives there |
|---|---|
lib/belt.rb |
Public require entry |
lib/belt/ |
Framework core (controller, router, handler, observability) |
lib/belt/cli/ |
CLI commands (new, generate, deploy, plugin, …) |
lib/belt_controller/ |
BeltController::Base |
lib/templates/ |
ERB templates for belt new, generators, plugin scaffold |
exe/belt |
CLI executable |
spec/ |
RSpec suite |
AGENTS.md |
Agent-oriented map of this gem (layout, CLI, plugin contract) |
AI / coding agents: start with AGENTS.md. Belt apps and plugins scaffolded by the CLI get their own AGENTS.md as well (belt new, belt plugin new).
# In a Belt app's Gemfile
gem "belt", path: "../belt"belt deploy detects path: gems and materializes them into vendor/cache for Lambda packaging so you can iterate without publishing a gem for every try.
Plugins are separate repositories (not vendored into this repo). To add a new first-class capability:
belt plugin new <name>(or copybelt-messaging/belt-pay)- Implement the runtime API + generator contract above
- Document install steps in the plugin README (
gem …→belt generate …) - Open a PR on the plugin repo; optionally link it from this README's plugin table
Questions about plugin design or core changes: open a GitHub issue or discuss in the project Discord.
MIT