rack-error_handler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12f6a71c1bfb6a8cee0ec368d18338b17915b29341bcc7ba952086e54e6696b6
+  data.tar.gz: 5e8c76a3faa6a333cbf4b45894d86d01ef707efdadee6df099170ae61d113e68
+SHA512:
+  metadata.gz: 4c6234b07a94e2c11ce8d7f5d2992ac3452a1dd711b1e34cb419236168b18276b43dcfd5739835423945e626a5f3b68649811dd6ae2dd23e76fcb76683364353
+  data.tar.gz: e4db4ab20b15282daebe0696559e5a39abe067051217cc187f1390d53be53c22ae16b7f47e4c4840afd0fbf8796d833e3e040157e7ec1577c38973ae2a30f85b

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [ '**' ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test:
+
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+rack-error_handler

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-error_handler.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    rack-error_handler (1.0.0)
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    colorin (2.0.0)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    docile (1.3.5)
+    json (2.6.3)
+    method_source (0.9.2)
+    minitest (5.10.3)
+    minitest-colorin (0.1.6)
+      colorin (~> 2.0)
+      minitest (~> 5.0)
+    minitest-line (0.6.5)
+      minitest (~> 5.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rake (11.3.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.2.2)
+    tins (1.32.1)
+      sync
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  coveralls (~> 0.8)
+  minitest (~> 5.0, < 5.11)
+  minitest-colorin (~> 0.1)
+  minitest-line (~> 0.6)
+  pry-nav (~> 0.2)
+  rack-error_handler!
+  rack-test (~> 2.0)
+  rake (~> 11.0)
+  simplecov (~> 0.14)
+
+BUNDLED WITH
+   2.3.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Gabriel Naiman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Rack::ErrorHandler
+
+[![Gem Version](https://badge.fury.io/rb/rack-error_handler.svg)](https://rubygems.org/gems/rack-error_handler)
+[![CI](https://github.com/gabynaiman/rack-error_handler/actions/workflows/ci.yml/badge.svg)](https://github.com/gabynaiman/rack-error_handler/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/gabynaiman/rack-error_handler/badge.svg?branch=master)](https://coveralls.io/r/gabynaiman/rack-error_handler?branch=master)
+[![Code Climate](https://codeclimate.com/github/gabynaiman/rack-error_handler.svg)](https://codeclimate.com/github/gabynaiman/rack-error_handler)
+
+Rack middleware to log request errors and respond with standard message
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-error_handler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-error_handler
+
+## Usage
+
+```ruby
+logger = Logger.new STDOUT
+
+use Rack::ErrorHandler, logger: Logger.new(STDOUT)
+
+use Rack::ErrorHandler, logger: logger,
+                        error_message: '<html><body><h1>Server Error</h1></body></html>'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gabynaiman/rack-error_handler.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.libs << 'lib'
+  t.pattern = ENV['DIR'] ? File.join(ENV['DIR'], '**', '*_spec.rb') : 'spec/**/*_spec.rb'
+  t.verbose = false
+  t.warning = false
+  t.loader = nil if ENV['TEST']
+  ENV['TEST'], ENV['LINE'] = ENV['TEST'].split(':') if ENV['TEST'] && !ENV['LINE']
+  t.options = ''
+  t.options << "--name=/#{ENV['NAME']}/ " if ENV['NAME']
+  t.options << "-l #{ENV['LINE']} " if ENV['LINE'] && ENV['TEST']
+end
+
+task default: :spec
+
+desc 'Pry console'
+task :console do
+  require 'rack-error_handler'
+  require 'pry'
+  ARGV.clear
+  Pry.start
+end

data/lib/rack/error_handler/request_error.rb

@@ -0,0 +1,29 @@
+module Rack
+  class ErrorHandler
+    class RequestError < StandardError
+
+      def initialize(request, error)
+        @request = request
+        @error = error
+      end
+
+      def message
+        [
+          "#{request.request_method} #{request.path}",
+          "Query: \"#{request.query_string}\"",
+          "Body: \"#{request.body.read}\"",
+          "[#{error.class}] #{error.message}"
+        ].join("\n")
+      end
+
+      def backtrace
+        error.backtrace
+      end
+
+      private
+
+      attr_reader :request, :error
+
+    end
+  end
+end

data/lib/rack/error_handler/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class ErrorHandler
+    VERSION = '1.0.0'
+  end
+end

data/lib/rack/error_handler.rb

@@ -0,0 +1,31 @@
+require 'rack'
+require_relative 'error_handler/request_error'
+require_relative 'error_handler/version'
+
+module Rack
+  class ErrorHandler
+
+    DEFAULT_ERROR_MESSAGE = 'Internal Server Error'.freeze
+
+    def initialize(app, options={})
+      @app = app
+      @logger = options.fetch(:logger)
+      @error_message = options[:error_message] || DEFAULT_ERROR_MESSAGE
+    end
+
+    def call(env)
+      app.call env
+
+    rescue => error
+      request = Rack::Request.new env
+      request_error = RequestError.new request, error
+      logger.error(self.class) { request_error }
+      [500, {}, [error_message]]
+    end
+
+    private
+
+    attr_reader :app, :logger, :error_message
+
+  end
+end

data/lib/rack-error_handler.rb

@@ -0,0 +1 @@
+require_relative 'rack/error_handler'

data/rack-error_handler.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+require_relative 'lib/rack/error_handler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-error_handler'
+  spec.version       = Rack::ErrorHandler::VERSION
+  spec.authors       = ['Gabriel Naiman']
+  spec.email         = ['gabynaiman@gmail.com']
+
+  spec.summary       = 'Rack middleware to log request errors and respond with standard message'
+  spec.description   = 'Rack middleware to log request errors and respond with standard message'
+  spec.homepage      = 'https://github.com/gabynaiman/rack-error_handler'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rack'
+
+  spec.add_development_dependency 'rack-test', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'minitest', '~> 5.0', '< 5.11'
+  spec.add_development_dependency 'minitest-colorin', '~> 0.1'
+  spec.add_development_dependency 'minitest-line', '~> 0.6'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'pry-nav', '~> 0.2'
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: rack-error_handler
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gabriel Naiman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-06-16 00:00:00.000000000 Z
+dependencies:
+- !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: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-colorin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-line
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Rack middleware to log request errors and respond with standard message
+email:
+- gabynaiman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-error_handler.rb
+- lib/rack/error_handler.rb
+- lib/rack/error_handler/request_error.rb
+- lib/rack/error_handler/version.rb
+- rack-error_handler.gemspec
+homepage: https://github.com/gabynaiman/rack-error_handler
+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.3.14
+signing_key: 
+specification_version: 4
+summary: Rack middleware to log request errors and respond with standard message
+test_files: []