rack-robustness 1.0.0 → 1.2.0

data/spec/test_last_resort.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+describe Rack::Robustness, 'last resort' do
+  include Rack::Test::Methods
+
+  before do
+    $seen_ex = nil
+  end
+
+  context 'when the response cannot be built and no catch all' do
+    let(:app){
+      mock_app do |g|
+        g.no_catch_all
+        g.response{|ex| NoSuchResponseClass.new }
+        g.ensure(true){|ex| $seen_ex = ex }
+      end
+    }
+
+    it 'reraises the internal error' do
+      lambda{
+        get '/argument-error'
+      }.should raise_error(NameError, /NoSuchResponseClass/)
+    end
+
+    it 'passes into the ensure block with the original error' do
+      lambda{
+        get '/argument-error'
+      }.should raise_error(NameError, /NoSuchResponseClass/)
+      expect($seen_ex).to be_a(ArgumentError)
+    end
+  end
+
+  context 'when the response cannot be built and catch all' do
+    let(:app){
+      mock_app do |g|
+        g.response{|ex| NoSuchResponseClass.new }
+      end
+    }
+
+    it 'falls back to last resort response' do
+      get '/argument-error'
+      expect(last_response.status).to eq(500)
+      expect(last_response.content_type).to eq("text/plain")
+      expect(last_response.body).to eq("An internal error occured, sorry for the disagreement.")
+    end
+  end
+
+  context 'when an ensure block raises an error and no catch all' do
+    let(:app){
+      mock_app do |g|
+        g.no_catch_all
+        g.ensure{|ex| NoSuchResponseClass.new }
+      end
+    }
+
+    it 'reraises the internal error' do
+      lambda{
+        get '/argument-error'
+      }.should raise_error(NameError, /NoSuchResponseClass/)
+    end
+  end
+
+  context 'when an ensure block raises an error and catch all' do
+    let(:app){
+      mock_app do |g|
+        g.ensure{|ex| NoSuchResponseClass.new }
+      end
+    }
+
+    it 'reraises the internal error' do
+      get '/argument-error'
+      expect(last_response.status).to eq(500)
+      expect(last_response.content_type).to eq("text/plain")
+      expect(last_response.body).to eq("An internal error occured, sorry for the disagreement.")
+    end
+  end
+
+  context 'when the response block fails and the ensure block uses the response object' do
+    let(:app){
+      mock_app do |g|
+        g.response{|ex| NoSuchResponseClass.new }
+        g.ensure{|ex| $seen_response = response }
+      end
+    }
+
+    before do
+      $seen_response = nil
+    end
+
+    it 'sets a default response object for the ensure clause' do
+      get '/argument-error'
+      expect(last_response.status).to eq(500)
+      expect(last_response.content_type).to eq("text/plain")
+      expect(last_response.body).to eq("An internal error occured, sorry for the disagreement.")
+      expect($seen_response).to_not be_nil
+    end
+  end
+
+end

data/spec/test_rescue.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+describe Rack::Robustness, 'rescue' do
+  include Rack::Test::Methods
+
+  let(:app){
+    mock_app do |g|
+      g.status 400
+      g.rescue(ArgumentError){|ex| 'argument-error' }
+      g.rescue(SecurityError, 'security-error')
+      g.on(TypeError)        {|ex| 'type-error'     }
+    end
+  }
+
+  it 'correctly rescues specified errors' do
+    get '/argument-error'
+    expect(last_response.status).to eq(400)
+    expect(last_response.body).to eq("argument-error")
+  end
+
+  it 'correctly support a non-block shortcut' do
+    get '/security-error'
+    expect(last_response.status).to eq(400)
+    expect(last_response.body).to eq("security-error")
+  end
+
+  it 'is has a `on` alias' do
+    get '/type-error'
+    expect(last_response.status).to eq(400)
+    expect(last_response.body).to eq("type-error")
+  end
+
+end

data/spec/test_response.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+describe Rack::Robustness, 'response' do
+  include Rack::Test::Methods
+
+  class MyFooResponse < Rack::Response
+
+    def initialize(*args)
+      super
+      self['Content-Type'] = "application/json"
+    end
+
+    def each
+      yield("response text")
+    end
+
+  end
+
+  let(:app){
+    mock_app do |g|
+      g.status 400
+      g.response{|ex| MyFooResponse.new }
+    end
+  }
+
+  it 'correctly sets the status' do
+    get '/argument-error'
+    expect(last_response.status).to eq(400)
+  end
+
+  xit 'correctly sets the body' do
+    get '/argument-error'
+    expect(last_response.body).to eq("response text")
+  end
+
+  it 'correctly sets the content type' do
+    get '/argument-error'
+    expect(last_response.content_type).to eq("application/json")
+  end
+
+end

data/spec/test_robustness.rb

@@ -2,28 +2,13 @@ require 'spec_helper'
 describe Rack::Robustness do
   include Rack::Test::Methods
 
-  def mock_app(&bl)
-    Rack::Builder.new do
-      use Rack::Robustness, &bl
-      map '/happy' do
-        run lambda{|env| [200, {'Content-Type' => 'text/plain'}, ['happy']]}
-      end
-      map "/argument-error" do
-        run lambda{|env| raise ArgumentError, "an argument error" }
-      end
-      map "/type-error" do
-        run lambda{|env| raise TypeError, "a type error" }
-      end
-    end
-  end
-
   shared_examples_for 'A transparent middleware for happy paths' do
 
     it 'let happy responses unchanged' do
       get '/happy'
-      last_response.status.should eq(200)
-      last_response.content_type.should eq('text/plain')
-      last_response.body.should eq('happy')
+      expect(last_response.status).to eq(200)
+      expect(last_response.content_type).to eq('text/plain')
+      expect(last_response.body).to eq('happy')
     end
   end
 
@@ -36,9 +21,16 @@ describe Rack::Robustness do
 
     it 'set a status 500 with a standard error message by default' do
       get '/argument-error'
-      last_response.status.should eq(500)
-      last_response.content_type.should eq("text/plain")
-      last_response.body.should eq("Sorry, a fatal error occured.")
+      expect(last_response.status).to eq(500)
+      expect(last_response.content_type).to eq("text/plain")
+      expect(last_response.body).to eq("Sorry, a fatal error occured.")
+    end
+
+    it 'catches all exceptions by default' do
+      get '/security-error'
+      expect(last_response.status).to eq(500)
+      expect(last_response.content_type).to eq("text/plain")
+      expect(last_response.body).to eq("Sorry, a fatal error occured.")
     end
   end
 
@@ -55,9 +47,9 @@ describe Rack::Robustness do
 
     it 'set the specified status and body on errors' do
       get '/argument-error'
-      last_response.status.should eq(501)
-      last_response.content_type.should eq("text/test")
-      last_response.body.should eq("An error occured")
+      expect(last_response.status).to eq(501)
+      expect(last_response.content_type).to eq("text/test")
+      expect(last_response.body).to eq("An error occured")
     end
   end
 
@@ -74,7 +66,7 @@ describe Rack::Robustness do
     it 'set the specified headers on error' do
       get '/argument-error'
       last_response.headers['Foo'].should eq('Bar')
-      last_response.content_type.should eq("text/test")
+      expect(last_response.content_type).to eq("text/test")
     end
   end
 
@@ -91,16 +83,16 @@ describe Rack::Robustness do
 
     it 'correctly sets the status, content_type and body on ArgumentError' do
       get '/argument-error'
-      last_response.status.should eq(400)
-      last_response.content_type.should eq('text/arg')
-      last_response.body.should eq('an argument error')
+      expect(last_response.status).to eq(400)
+      expect(last_response.content_type).to eq('text/arg')
+      expect(last_response.body).to eq('an argument error')
     end
 
     it 'correctly sets the status, content_type and body on TypeError' do
       get '/type-error'
-      last_response.status.should eq(500)
-      last_response.content_type.should eq('text/other')
-      last_response.body.should eq('a type error')
+      expect(last_response.status).to eq(500)
+      expect(last_response.content_type).to eq('text/other')
+      expect(last_response.body).to eq('a type error')
     end
   end
 
@@ -117,12 +109,12 @@ describe Rack::Robustness do
 
     it 'correctly sets the specified headers on an ArgumentError' do
       get '/argument-error'
-      last_response.content_type.should eq("text/arg")
+      expect(last_response.content_type).to eq("text/arg")
     end
 
     it 'correctly sets the specified headers on a TypeError' do
       get '/type-error'
-      last_response.content_type.should eq("text/other")
+      expect(last_response.content_type).to eq("text/other")
     end
   end
 
@@ -139,13 +131,13 @@ describe Rack::Robustness do
     it 'correctly sets the specified headers on an ArgumentError' do
       get '/argument-error'
       last_response.headers['Foo'].should eq('Bar')
-      last_response.content_type.should eq("text/arg")
+      expect(last_response.content_type).to eq("text/arg")
     end
 
     it 'correctly sets the specified headers on a TypeError' do
       get '/type-error'
       last_response.headers['Foo'].should eq('Bar')
-      last_response.content_type.should eq("text/other")
+      expect(last_response.content_type).to eq("text/other")
     end
   end
 
@@ -165,16 +157,16 @@ describe Rack::Robustness do
 
     it 'uses the response on ArgumentError' do
       get '/argument-error'
-      last_response.status.should eq(401)
-      last_response.content_type.should eq('text/arg')
-      last_response.body.should eq("an argument error")
+      expect(last_response.status).to eq(401)
+      expect(last_response.content_type).to eq('text/arg')
+      expect(last_response.body).to eq("an argument error")
     end
 
     it 'uses the response on TypeError' do
       get '/type-error'
-      last_response.status.should eq(402)
-      last_response.content_type.should eq('default/one')
-      last_response.body.should eq("a type error")
+      expect(last_response.status).to eq(402)
+      expect(last_response.content_type).to eq('default/one')
+      expect(last_response.body).to eq("a type error")
     end
   end
 
@@ -187,9 +179,9 @@ describe Rack::Robustness do
 
     it 'uses the status and fallback to defaults for the rest' do
       get '/argument-error'
-      last_response.status.should eq(401)
-      last_response.content_type.should eq('text/plain')
-      last_response.body.should eq("Sorry, a fatal error occured.")
+      expect(last_response.status).to eq(401)
+      expect(last_response.content_type).to eq('text/plain')
+      expect(last_response.body).to eq("Sorry, a fatal error occured.")
     end
   end
 
@@ -202,9 +194,9 @@ describe Rack::Robustness do
 
     it 'uses it as body and fallback to defaults for the rest' do
       get '/argument-error'
-      last_response.status.should eq(500)
-      last_response.content_type.should eq('text/plain')
-      last_response.body.should eq("an argument error")
+      expect(last_response.status).to eq(500)
+      expect(last_response.content_type).to eq('text/plain')
+      expect(last_response.body).to eq("an argument error")
     end
   end
 
@@ -218,7 +210,7 @@ describe Rack::Robustness do
 
     it 'matches known errors' do
       get '/argument-error'
-      last_response.status.should eq(401)
+      expect(last_response.status).to eq(401)
     end
 
     it 'raises on unknown error' do
@@ -239,8 +231,8 @@ describe Rack::Robustness do
 
     it 'matches known errors' do
       get '/argument-error'
-      last_response.status.should eq(401)
-      last_response.body.should eq("Sorry, a fatal error occured.")
+      expect(last_response.status).to eq(401)
+      expect(last_response.body).to eq("Sorry, a fatal error occured.")
     end
 
     it 'raises on unknown error' do

data/spec/test_subclass.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+describe "Rack::Robustness subclasses" do
+  include Rack::Test::Methods
+
+  class Shield < Rack::Robustness
+    self.body{|ex| ex.message }
+    self.rescue(ArgumentError){|ex| 400 }
+  end
+
+  let(:app){
+    mock_app(Shield)
+  }
+
+  it 'works as expected' do
+    get '/argument-error'
+    expect(last_response.status).to eq(400)
+    expect(last_response.body).to eq("an argument error")
+  end
+
+end

data/tasks/gem.rake

@@ -1,73 +1,39 @@
-# Installs rake tasks for gemming and packaging
-#
-# This file installs the 'rake package', 'rake gem' tasks and associates
-# (clobber_package, repackage, ...). It is automatically generated by Noe
-# from your .noespec file, and should therefore be configured there, under
-# the variables/rake_tasks/gem entry, as illustrated below:
-#
-# variables:
-#   rake_tasks:
-#     gem:
-#       package_dir: pkg
-#       need_tar: false
-#       need_tar_gz: false
-#       need_tar_bz2: false
-#       need_zip: false
-#       ...
-#
-# If you have specific needs requiring manual intervention on this file,
-# don't forget to set safe-override to false in your noe specification:
-#
-# template-info:
-#   manifest:
-#     tasks/gem.rake:
-#       safe-override: false
-#
-begin
-  require 'rubygems/package_task'
+require 'rubygems/package_task'
 
-  # Dynamically load the gem spec
-  gemspec_file = File.expand_path('../../rack-robustness.gemspec', __FILE__)
-  gemspec      = Kernel.eval(File.read(gemspec_file))
+# Dynamically load the gem spec
+gemspec_file = File.expand_path('../../rack-robustness.gemspec', __FILE__)
+gemspec      = Kernel.eval(File.read(gemspec_file))
 
-  Gem::PackageTask.new(gemspec) do |t|
+Gem::PackageTask.new(gemspec) do |t|
 
-    # Name of the package
-    t.name = gemspec.name
+  # Name of the package
+  t.name = gemspec.name
 
-    # Version of the package
-    t.version = gemspec.version
+  # Version of the package
+  t.version = gemspec.version
 
-    # Directory used to store the package files
-    t.package_dir = "pkg"
+  # Directory used to store the package files
+  t.package_dir = "pkg"
 
-    # True if a gzipped tar file (tgz) should be produced
-    t.need_tar = false
+  # True if a gzipped tar file (tgz) should be produced
+  t.need_tar = false
 
-    # True if a gzipped tar file (tar.gz) should be produced
-    t.need_tar_gz = false
+  # True if a gzipped tar file (tar.gz) should be produced
+  t.need_tar_gz = false
 
-    # True if a bzip2'd tar file (tar.bz2) should be produced
-    t.need_tar_bz2 = false
+  # True if a bzip2'd tar file (tar.bz2) should be produced
+  t.need_tar_bz2 = false
 
-    # True if a zip file should be produced (default is false)
-    t.need_zip = false
+  # True if a zip file should be produced (default is false)
+  t.need_zip = false
 
-    # List of files to be included in the package.
-    t.package_files = gemspec.files
+  # List of files to be included in the package.
+  t.package_files = gemspec.files
 
-    # Tar command for gzipped or bzip2ed archives.
-    t.tar_command = "tar"
+  # Tar command for gzipped or bzip2ed archives.
+  t.tar_command = "tar"
 
-    # Zip command for zipped archives.
-    t.zip_command = "zip"
+  # Zip command for zipped archives.
+  t.zip_command = "zip"
 
-  end
-rescue LoadError
-  task :gem do
-    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
-  end
-  task :package do
-    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
-  end
 end

data/tasks/test.rake

@@ -0,0 +1,11 @@
+namespace :test do
+  require 'rspec/core/rake_task'
+
+  desc %q{Run all RSpec tests}
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.rspec_opts = %w[-I. -Ilib -Ispec --pattern=spec/**/test_*.rb --color .]
+  end
+
+  task :all => :"unit"
+end
+task :test => :"test:all"

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: rack-robustness
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.12'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 description: Rack::Robustness provides you with an easy way to handle errors in your
@@ -86,46 +77,53 @@ extra_rdoc_files:
 - CHANGELOG.md
 - LICENCE.md
 files:
-- rack-robustness.gemspec
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- lib/rack/robustness.rb
 - LICENCE.md
 - Manifest.txt
-- Rakefile
 - README.md
+- Rakefile
+- lib/rack/robustness.rb
+- rack-robustness.gemspec
 - spec/spec_helper.rb
+- spec/test_context.rb
+- spec/test_ensure.rb
+- spec/test_last_resort.rb
+- spec/test_rescue.rb
+- spec/test_response.rb
 - spec/test_robustness.rb
+- spec/test_subclass.rb
 - tasks/gem.rake
-- tasks/spec_test.rake
+- tasks/test.rake
 homepage: https://github.com/blambeau/rack-robustness
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2934394792950840478
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.1.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rack::Robustness, the rescue clause of your Rack stack.
 test_files:
-- spec/spec_helper.rb
+- spec/test_response.rb
+- spec/test_rescue.rb
 - spec/test_robustness.rb
+- spec/test_subclass.rb
+- spec/test_ensure.rb
+- spec/test_context.rb
+- spec/spec_helper.rb
+- spec/test_last_resort.rb