rack-berater 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3475519672f1074d749de982b36d3a2d0d15a468d38d35b91e0f237de02ba2f8
-  data.tar.gz: fd08c05ccc694adc8ca540a2468956144c0d180611dd4622070e15aa8dd120ef
+  metadata.gz: 7db43d04f14f84dd3e2f3f96352226a48d4e36bfe17467fd1e4eb77015ca6148
+  data.tar.gz: 40f79342ca6cd92145a32e2d0b76455850cc4bdd25d701e83157a7acf330bc15
 SHA512:
-  metadata.gz: 88428422463a296369f8a2f141c74dadc90f132e2d2072c3505bf33012e344668277e23146125cf43bca55a7d6ec83da0871d6e5b23684a72f3875e48f5d43d7
-  data.tar.gz: be42f6faa19469ccbfed7995f02b81533051b828e688779d8b5986be6a83174baf71c8ca399b9fabb419766a59fbd8a0c366eefdee977865d7c215970e815527
+  metadata.gz: 1f8b3b29d9d62796a49701340fb53446cfca19258f2083c5973bd17e9a9314abb28c7faf7070a260cd4128bb9028346d18f24c98d96d5d8a9e503e5d113f8456
+  data.tar.gz: 7ee2bef14d6c4334ef2d65b67a60fe432047a0ce8581f62461cf1fd0c65264083833bbd9f3fe45f2909be3b52cb2147db9704a44e2f9cbc9017b83f69da182d4

data/lib/rack/berater/railtie.rb

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

data/lib/rack/berater/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Berater
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/rack/berater.rb

@@ -7,7 +7,7 @@ module Rack
   class Berater
     autoload :Railtie, "rack/berater/railtie"
 
-    ERROR_TYPES = Set.new([ ::Berater::Overloaded ])
+    ERRORS = Set[ ::Berater::Overloaded ]
 
     def initialize(app, options = {})
       @app = app
@@ -39,11 +39,11 @@ module Rack
 
     def call(env)
       if enabled?(env)
-        @limiter.limit { @app.call(env) }
+        limit(env) { @app.call(env) }
       else
         @app.call(env)
       end
-    rescue *ERROR_TYPES => e
+    rescue *ERRORS => e
       [
         @options[:status_code],
         @options[:headers],
@@ -57,5 +57,10 @@ module Rack
       return false unless @limiter
       @enabled.nil? ? true : @enabled.call(env)
     end
+
+    def limit(env, &block)
+      limiter = @limiter.respond_to?(:call) ? @limiter.call(env) : @limiter
+      limiter.limit(&block)
+    end
   end
 end

data/spec/limiter_spec.rb

@@ -39,20 +39,42 @@ describe Rack::Berater do
   end
 
   describe "limiter option" do
-    let(:limiter) { ::Berater::Unlimiter.new }
+    context "when limiter is a limiter" do
+      let(:limiter) { ::Berater::Unlimiter.new }
 
-    include_examples "works nominally"
+      include_examples "works nominally"
+
+      it "calls the limiter" do
+        expect(limiter).to receive(:limit).and_call_original
+        response
+      end
+
+      context "when operating beyond limits" do
+        before { Berater.test_mode = :fail }
 
-    it "calls the limiter" do
-      expect(limiter).to receive(:limit).and_call_original
-      response
+        it "returns an error" do
+          expect(response.status).to eq 429
+        end
+      end
     end
 
-    context "when operating beyond limits" do
-      before { Berater.test_mode = :fail }
+    context "when limiter is a proc" do
+      let(:limiter_instance) { ::Berater::Unlimiter.new }
+      let(:limiter) { Proc.new { limiter_instance } }
+
+      include_examples "works nominally"
+
+      it "calls the proc with env" do
+        expect(limiter).to receive(:call).with(Hash).and_call_original
+        response
+      end
+
+      context "when operating beyond limits" do
+        before { Berater.test_mode = :fail }
 
-      it "returns an error" do
-        expect(response.status).to eq 429
+        it "returns an error" do
+          expect(response.status).to eq 429
+        end
       end
     end
   end

data/spec/railtie_spec.rb

@@ -0,0 +1,17 @@
+require "rails"
+require "rack/berater/railtie"
+
+RSpec.describe Rack::Berater::Railtie do
+  subject { Rails.initialize! }
+
+  before do
+    Rails.application = Class.new(Rails::Application) do
+      config.eager_load = false
+      config.logger = ActiveSupport::Logger.new($stdout)
+    end
+  end
+
+  it "adds middleware automatically" do
+    expect(subject.middleware).to include(Rack::Berater)
+  end
+end

data/spec/rescuer_spec.rb

@@ -61,7 +61,7 @@ describe Rack::Berater do
       context "with body nil" do
         let(:options) { { body: nil } }
 
-        it "should default to sending a body" do
+        it "falls back to the default" do
           expect(response.body).to eq "Too Many Requests"
         end
       end
@@ -86,6 +86,16 @@ describe Rack::Berater do
           expect(response.body).to eq body
         end
       end
+
+      context "with an erroneous value" do
+        let(:options) { { body: 123 } }
+
+        it 'should raise an error' do
+          expect {
+            response
+          }.to raise_error(ArgumentError)
+        end
+      end
     end
 
     context "with custom headers" do
@@ -132,9 +142,9 @@ describe Rack::Berater do
 
     context "when an error type is registered with middleware" do
       around do |example|
-        Rack::Berater::ERROR_TYPES << IOError
+        Rack::Berater::ERRORS << IOError
         example.run
-        Rack::Berater::ERROR_TYPES.delete(IOError)
+        Rack::Berater::ERRORS.delete(IOError)
       end
 
       it "catches and transforms limit errors" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-berater
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-03 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berater
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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
@@ -119,6 +133,7 @@ files:
 - lib/rack/berater/railtie.rb
 - lib/rack/berater/version.rb
 - spec/limiter_spec.rb
+- spec/railtie_spec.rb
 - spec/rescuer_spec.rb
 homepage: https://github.com/dpep/rack-berater
 licenses:
@@ -139,10 +154,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Rack::Berater
 test_files:
+- spec/railtie_spec.rb
 - spec/rescuer_spec.rb
 - spec/limiter_spec.rb