belt 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fcb629702530cd06ffb9af298dcd259c4fc0503107ef19ab58a58da476617b4
-  data.tar.gz: 167a12259478e5079620446f76dad474cde1d456f08b328663fe11f82860fa66
+  metadata.gz: 39a9c396d05b2acfc5c69adc875f0050beb9395a2dc9f31dd4ac2d2221e011db
+  data.tar.gz: ddf3e2d95ea98eafc808f0d2e144196257f4880fb1b8d65ae063dd27becb9213
 SHA512:
-  metadata.gz: bb37dd0fe9e0cd392a0824d14b0ab4c51c5d002b36240fc7795ad11ce2313dd0014bea535c020fab6e4ec8988c7cf4d5a90992e2f8cfcdbcea35bc780586592f
-  data.tar.gz: d8d7423e5b3cd0c3d1598ff7b9e82446c9de4705b68313ade0ee0479ec26a87b5d4e3acd23a52b664ec2f50fd37e66cb046e1383f18bbf696cd01a13d24b140e
+  metadata.gz: f3463e2d5e75fc653437accecb76a3a66683cd28bf7781a9aadbef167b2cf3f18ad4d5e32fb3cb5f57c6e406929253f6f762ebecec5a4d20b2723c9a8118efd8
+  data.tar.gz: f1ccdeca8439a8063940c981f9c05a24abb319bcb0aa76c7212e0883fc6a9c4db7ee10f0e2da1f93105d1bca68844bd108ca7e820b8a462c900d309d35231905

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.6.5
+
+### Added
+
+- **Per-route throttling in `routes.rb`.** Any route or resource accepts
+  `throttle: { rate: 2, burst: 5 }` (requests/second + burst). `belt routes -f json` emits it
+  as `throttle` on the route and conveyor-belt 0.0.20+ applies it as API Gateway stage method
+  settings, winning over the Lambda's `throttle:` in `config/lambda/<fn>.yml`. Malformed values
+  raise at load time. (Fizzy #1756)
+
 ## 0.6.4
 
 ### Added

data/README.md

@@ -209,6 +209,15 @@ end
 
 **Key point:** `namespace` and `scope` are purely organizational — they affect URL paths and controller module resolution but never change which Lambda handles the request. Use `function` when you need routes to go to a different Lambda.
 
+**Per-route throttling:** any route or resource accepts `throttle: { rate:, burst: }` (steady-state requests per second plus the burst the token bucket absorbs). `belt routes -f json` emits it and the conveyor-belt provider (0.0.20+) applies it as API Gateway stage method settings. A route's `throttle` wins over the serving Lambda's `throttle:` in `config/lambda/<fn>.yml`, which in turn wins over the provider's stage-level `throttle` block.
+
+```ruby
+gateway :api, auth: :none do
+  post '/connect/chat', to: 'chat#create', throttle: { rate: 2, burst: 5 }
+  resources :leads, only: [:create], throttle: { rate: 1, burst: 3 }
+end
+```
+
 ### Nested Resource DSL
 
 Inside a `resources` block, you can use Rails-like `member`, `collection`, `scope`, and singular `resource` for DRYer route definitions:

data/lib/belt/cli/routes_command.rb

@@ -165,6 +165,7 @@ module Belt
         }
         rc = route.response_context.to_s
         hash[:response_context] = rc unless rc.empty?
+        hash[:throttle] = route.throttle if route.throttle
         hash
       end
 

data/lib/belt/route_dsl.rb

@@ -9,7 +9,7 @@ module Belt
 
   class Route
     attr_reader :method, :path, :auth, :lambda, :cors, :tables, :route_type,
-                :controller, :action, :request_model, :response_model, :response_context
+                :controller, :action, :request_model, :response_model, :response_context, :throttle
 
     def initialize(method, path, options = {})
       @method = method.to_s.upcase
@@ -17,6 +17,7 @@ module Belt
       @auth = options[:auth]
       @lambda = options[:lambda]
       @cors = options.fetch(:cors, true)
+      @throttle = self.class.normalize_throttle(options[:throttle])
       @tables = options[:tables] || []
       @route_type = options[:route_type] || :action
       @controller = options[:controller]
@@ -26,6 +27,31 @@ module Belt
       @response_context = options[:response_context]&.to_s
     end
 
+    # Per-route API Gateway limit: `throttle: { rate: 2, burst: 5 }` (requests per
+    # second, token bucket). Emitted by `belt routes -f json` and applied by the
+    # conveyor-belt provider (0.0.20+) as stage method settings; it wins over the
+    # Lambda's `throttle:` in config/lambda/<fn>.yml. Returns nil when unset.
+    def self.normalize_throttle(raw)
+      return nil if raw.nil?
+
+      unless raw.is_a?(Hash)
+        raise ArgumentError, "throttle must be a Hash like { rate: 2, burst: 5 } (got #{raw.inspect})"
+      end
+
+      rate = raw[:rate] || raw['rate']
+      burst = raw[:burst] || raw['burst']
+      raise ArgumentError, 'throttle needs rate (requests/second) and burst' if rate.nil? || burst.nil?
+
+      unless rate.is_a?(Numeric) && rate.positive?
+        raise ArgumentError, "throttle rate must be a number > 0 (got #{rate.inspect})"
+      end
+      unless burst.is_a?(Integer) && burst.positive?
+        raise ArgumentError, "throttle burst must be an integer > 0 (got #{burst.inspect})"
+      end
+
+      { rate: rate, burst: burst }
+    end
+
     def resource?
       @route_type == :resource || @route_type == :resources
     end
@@ -494,7 +520,8 @@ module Belt
         action: action,
         request_model: options[:request_model],
         response_model: options[:response_model],
-        response_context: options[:response_context]
+        response_context: options[:response_context],
+        throttle: options[:throttle]
       }
 
       @routes << Belt::Route.new(method, path, route_options)

data/lib/belt/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Belt
-  VERSION = '0.6.4'
+  VERSION = '0.6.5'
 
   # Ruby version new apps run on in Lambda. Rendered into the conveyor-belt
   # provider block (`ruby_version`) by `belt new` / `belt generate environment`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: belt
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Stowzilla