invalid_json_error_middleware 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d64ab061dbd3ab808d0780de3364a890196190f78c591cc432aeb53981ec0665
+  data.tar.gz: a4a4ffed8c403d819324e219b4f4d4e4ec341d0849ea578b74467b6f9284bf6a
+SHA512:
+  metadata.gz: 683a3d700a8bfd527acbd677e7c32ded9a6ec87d553d0a1a942081b1fdff5bf0698e68534de47d571cb70f08cb2b5bca84b3d3d9d4467d76064fd88f91fd0f0e
+  data.tar.gz: d62ab2792d51c46919d48e12ea96d880c2db71982bb18c1418f74c08398783dd5c3ce38b7179a31f1910b7f7094acffb8020fd82fec77720c87f34b68b751827

data/README.md

@@ -0,0 +1,42 @@
+# Rails rack middleware to catch JSON parse errors
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'invalid_json_error_middleware'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install invalid_json_error_middleware
+
+## Usage
+
+config/application.rb
+
+```ruby
+class Application < Rails::Application
+  config.middleware.use InvalidJsonErrorMiddleware
+end
+```
+
+For using additional filter checks or/and custom error message: 
+```ruby
+class Application < Rails::Application
+  config.middleware.use InvalidJsonErrorMiddleware, filter_handler: ->(env) { env['HTTP_ACCEPT'] =~ /json/ }, error_handler: ->(error) { "Custom error message: #{error}" }
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Snick555/invalid_json_error_middleware. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/invalid_json_error_middleware.rb

@@ -0,0 +1,44 @@
+class InvalidJsonErrorMiddleware
+  def initialize(app, filter_handler: ->(_) { true }, error_handler: ->(error) { error_message(error) })
+    @app = app
+    @filter_handler = filter_handler
+    @error_handler = error_handler
+  end
+
+  def call(env)
+    begin
+      @app.call(env)
+    rescue parse_error_class => error
+      if raise_custom_error?(env)
+        return [
+          400, { 'Content-Type' => 'application/json' },
+          [{ status: 400, error: @error_handler.call(error) }.to_json]
+        ]
+      else
+        raise error
+      end
+    end
+  end
+
+  private
+
+  def parse_error_class
+    if defined?(ActionDispatch::Http::Parameters::ParseError)
+      ActionDispatch::Http::Parameters::ParseError
+    else
+      ActionDispatch::ParamsParser::ParseError
+    end
+  end
+
+  def raise_custom_error?(env)
+    @filter_handler.call(env) && content_type?(env)
+  end
+
+  def content_type?(env)
+    env['CONTENT_TYPE'] =~ /application\/json/
+  end
+
+  def error_message(error)
+    "There was a problem in the JSON you submitted: #{error}"
+  end
+end

data/lib/invalid_json_error_middleware/version.rb

@@ -0,0 +1,3 @@
+module InvalidJsonErrorMiddleware
+  VERSION = '0.0.2'
+end

data/spec/invalid_json_error_middleware_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe 'InvalidJsonErrorMiddleware' do
+  let(:test_app) { double('Test Rack App') }
+  let(:error_message) { 'some error message' }
+
+  before do
+    allow(test_app).to receive(:call).and_raise(ActionDispatch::Http::Parameters::ParseError.new(error_message))
+  end
+
+  context 'app without additional params' do
+    let(:app) { InvalidJsonErrorMiddleware.new(test_app) }
+
+    it 'raises default error when CONTENT_TYPE header is not application/json' do
+      expect {
+        post '/', {}, { 'CONTENT_TYPE' => 'text/html' }
+      }.to raise_error(ActionDispatch::Http::Parameters::ParseError, error_message)
+    end
+
+    it 'raises custom error when CONTENT_TYPE header is application/json' do
+      post '/', {}, { 'CONTENT_TYPE' => 'application/json' }
+
+      expect(last_response.status).to eql 400
+      expect(last_response.content_type).to eql 'application/json'
+      expect(last_response.body).to match error_message
+    end
+
+    it 'raises custom error when undefined ActionDispatch::Http::Parameters::ParseError' do
+      allow(test_app).to receive(:call).and_raise(ActionDispatch::ParamsParser::ParseError.new(error_message))
+      allow(app).to receive(:parse_error_class).and_return(ActionDispatch::ParamsParser::ParseError)
+
+      post '/', {}, { 'CONTENT_TYPE' => 'application/json' }
+
+      expect(last_response.status).to eql 400
+      expect(last_response.content_type).to eql 'application/json'
+      expect(last_response.body).to match error_message
+    end
+  end
+
+  context 'app with additional filter param' do
+    let(:app) { InvalidJsonErrorMiddleware.new(test_app, filter_handler: filter_handler) }
+
+    context 'when additional filter param true' do
+      let(:filter_handler) { ->(_) { true } }
+
+      it 'raises custom error' do
+        post '/', {}, { 'CONTENT_TYPE' => 'application/json' }
+
+        expect(last_response.status).to eql 400
+        expect(last_response.content_type).to eql 'application/json'
+        expect(last_response.body).to match error_message
+      end
+    end
+
+    context 'when additional filter param false' do
+      let(:filter_handler) { ->(_) { false } }
+
+      it 'raises default error' do
+        expect {
+          post '/', {}, { 'CONTENT_TYPE' => 'application/json' }
+        }.to raise_error(ActionDispatch::Http::Parameters::ParseError, error_message)
+      end
+    end
+  end
+
+  context 'app with additional error param' do
+    let(:custom_error_message) { 'Some custom error message' }
+    let(:app) { InvalidJsonErrorMiddleware.new(test_app, error_handler: ->(_) { custom_error_message }) }
+
+    it 'raises custom error' do
+      post '/', {}, { 'CONTENT_TYPE' => 'application/json' }
+
+      expect(last_response.status).to eql 400
+      expect(last_response.content_type).to eql 'application/json'
+      expect(last_response.body).to match custom_error_message
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rack/test'
+require 'json'
+require 'invalid_json_error_middleware'
+
+include Rack::Test::Methods
+
+module ActionDispatch
+  module ParamsParser
+    class ParseError < Exception
+    end
+  end
+
+  module Http
+    module Parameters
+      class ParseError < Exception
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: invalid_json_error_middleware
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ihor Voloshyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-20 00:00:00.000000000 Z
+dependencies:
+- !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: 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: json
+  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'
+description: Rails rack middleware to catch JSON parse errors
+email: ivoloshy@cisco.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/invalid_json_error_middleware.rb
+- lib/invalid_json_error_middleware/version.rb
+- spec/invalid_json_error_middleware_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Cisco-AMP/invalid_json_error_middleware
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Invalid Json Error Middleware
+test_files: []