rack-berater 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1fad5e57124897f72b0fac11bf460c6b3dc279d057f56f22127ec32274d782d
+  data.tar.gz: aa7e1c738a450ff6fb72aa9b92e1211ed51c544f801a2ffef475a2a89805db5c
+SHA512:
+  metadata.gz: 0ec05fa53c35aea22a9c29e93b5d509c8a161364542641ada1af1c421320d671cd634dc8ab74abc597f38a056fb3d8638b69786cf82e26357b0ace12bf483ee9
+  data.tar.gz: c9f1c61d05ac9f297b88fad401fdf635cd553a15d2040a2fc7e45282fe2776e00967b8e7181cec5a621c5cb69771676cf7d70a34ee63e6be2b74dd7784b7b7d2

data/lib/rack/berater/handler.rb

@@ -0,0 +1,37 @@
+module Rack
+  module Berater
+    class Handler
+      def initialize(app, options = {})
+        @app = app
+        @options = {
+          status_code: options.fetch(:status_code, 429),
+          body: options.fetch(:body, true),
+        }
+      end
+
+      def call(env)
+        @app.call(env)
+      rescue ::Berater::Overloaded => e
+        code = @options[:status_code]
+        body = case @options[:body]
+          when true
+            Rack::Utils::HTTP_STATUS_CODES[code]
+          when nil, false
+            nil
+          when String
+            @options[:body]
+          when Proc
+            @options[:body].call(env, e)
+          else
+            raise ArgumentError, "invalid :body option: #{@options[:body]}"
+          end
+
+        [
+          code,
+          {},
+          [ body ].compact,
+        ]
+      end
+    end
+  end
+end

data/lib/rack/berater/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails/railtie'
+
+module Rack
+  module Berater
+    class Railtie < Rails::Railtie
+      initializer "rack.berater.initializer" do |app|
+        app.middleware.use Rack::Berater
+      end
+    end
+  end
+end

data/lib/rack/berater/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Berater
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack/berater.rb

@@ -0,0 +1,9 @@
+require "rack/berater/version"
+
+module Rack
+  module Berater
+    autoload :Handler, "rack/berater/handler"
+    # autoload :Limiter, "rack/berater/limiter"
+    autoload :Railtie, "rack/berater/railtie"
+  end
+end

data/lib/rack-berater.rb

@@ -0,0 +1,3 @@
+require "berater"
+require "rack"
+require "rack/berater"

data/spec/handler_spec.rb

@@ -0,0 +1,98 @@
+describe Rack::Berater::Handler do
+  let(:app) do
+    Rack::Builder.new do
+      use Rack::Lint
+      run (lambda do |env|
+        raise ::Berater::Overloaded if ::Berater.test_mode == :fail
+        [200, {"Content-Type" => "text/plain"}, ["OK"]]
+      end)
+    end
+  end
+  let(:response) { get "/" }
+
+  shared_examples "works nominally" do
+    it { expect(response.status).to eq 200 }
+    it { expect(response.body).to eq "OK" }
+  end
+
+  context "without Handler" do
+    include_examples "works nominally"
+
+    it "does not catch limit errors" do
+      Berater.test_mode = :fail
+      expect {
+        response
+      }.to be_overloaded
+    end
+  end
+
+  context "with Handler using default settings" do
+    context "with default settings" do
+      before { app.use described_class }
+
+      include_examples "works nominally"
+
+      it "catches and transforms limit errors" do
+        Berater.test_mode = :fail
+        expect(response.status).to eq 429
+        expect(response.body).to eq "Too Many Requests"
+      end
+    end
+  end
+
+  context "with Handler using custom settings" do
+    before do
+      app.use described_class, options
+      Berater.test_mode = :fail
+    end
+
+    context "with custom status code" do
+      let(:options) { { status_code: 503 } }
+
+      it "catches and transforms limit errors" do
+        expect(response.status).to eq 503
+        expect(response.body).to eq "Service Unavailable"
+      end
+    end
+
+    context "with body disabled" do
+      let(:options) { { body: false } }
+
+      it "should not send a body" do
+        expect(response.body).to be_empty
+      end
+    end
+
+    context "with body nil" do
+      let(:options) { { body: nil } }
+
+      it "should not send a body" do
+        expect(response.body).to be_empty
+      end
+    end
+
+    context "with custom body" do
+      let(:body) { "none shall pass!" }
+      let(:options) { { body: body } }
+
+      it "should send the custom string" do
+        expect(response.body).to eq body
+      end
+    end
+
+    context "with a dynamic body" do
+      let(:body) { "none shall pass!" }
+      let(:fn) { proc { body } }
+      let(:options) { { body: fn } }
+
+      it "should call the Proc and send the result" do
+        expect(response.body).to eq body
+      end
+
+      it "should pass in the env and error" do
+        expect(fn).to receive(:call).with(Hash, ::Berater::Overloaded)
+        response
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: rack-berater
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Pepper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: berater
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "..."
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack-berater.rb
+- lib/rack/berater.rb
+- lib/rack/berater/handler.rb
+- lib/rack/berater/railtie.rb
+- lib/rack/berater/version.rb
+- spec/handler_spec.rb
+homepage: https://github.com/dpep/rack-berater
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Rack::Berater
+test_files:
+- spec/handler_spec.rb