schneiderlein 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20c6f68046204b95dee35b2fabf1414dd7941318
+  data.tar.gz: c9944fd48128f918e30fab816297c6c2af5ac13b
+SHA512:
+  metadata.gz: 944d61cbeb56ff25b778e02a255e154061b7b5cd191569acf36d28af55dd0f17ebe648c3901f69eabd3d6edab3a1b39d0a984dac669baa68d56fd370e2659b51
+  data.tar.gz: 66a3f38f45bd26a88b81469f23d47cc458890ae72b6a6abf588b133ab5bb6a8eff8ec03caf39fda4331dfa5c33a19359b089b1cf0438a0f4036baa0228892c22

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,34 @@
+# Schneiderlein [![Build Status](https://travis-ci.org/Absolventa/schneiderlein.svg?branch=master)](https://travis-ci.org/Absolventa/schneiderlein)
+
+**Schneiderlein** is a Rack middleware to catch parse errors coming from [ActionDispatch::ParamsParser](https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/params_parser.rb). Malformed XML presents a 500 Internal Server Error to your API consumer. It's hardly meaningful, should instead be in the 4xx range and most importantly: it's not helping.
+
+Since the error appears early in the middleware stack, there is no way to use `rescue_from` on controller-level in a Rails app. **Schneiderlein** blanks the defective POST data from the request environment, saves the `ParseError`'s message and passes the modified Rack env along the middleware stack.
+
+The original error message is saved as `rack.schneiderlein.parse_errors` in the request environment. `Schneiderlein::Catch` aims to provide a convenient accessor. See the usage example below.
+
+## Usage
+
+Add the gem to your Rails app's Gemfile. In your API controller, you may want to add something like this:
+
+```ruby
+class Api::BaseController < ApplicationController
+  before_action :handle_parse_errors
+
+  respond_to :json, :xml
+
+  protected
+
+  def handle_parse_errors
+    schneiderlein = Schneiderlein::Catch.new(request)
+    respond_with schneiderlein.errors, status: 422 if schneiderlein.errors.any?
+  end
+end
+```
+
+## Naming
+The name **Schneiderlein** is derived from the fairytale »Das Tapfere Schneiderlein« (»The Valiant Little Tailor«) by the Grimm Brothers. The Valiant Little Tailor catches flies, **Schneiderlein** catches errors. Funny, eh?
+
+## Changelog
+
+### 1.0.0
+* Initial release

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Schneiderlein'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/assets/stylesheets/schneiderlein/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/schneiderlein/application_controller.rb

@@ -0,0 +1,4 @@
+module Schneiderlein
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/schneiderlein/application_helper.rb

@@ -0,0 +1,4 @@
+module Schneiderlein
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/schneiderlein/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Schneiderlein</title>
+  <%= stylesheet_link_tag    "schneiderlein/application", media: "all" %>
+  <%= javascript_include_tag "schneiderlein/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Schneiderlein::Engine.routes.draw do
+end

data/lib/schneiderlein.rb

@@ -0,0 +1,6 @@
+require "schneiderlein/engine"
+
+module Schneiderlein
+  autoload :FlyCatcher, 'schneiderlein/fly_catcher'
+  autoload :Catch, 'schneiderlein/catch'
+end

data/lib/schneiderlein/catch.rb

@@ -0,0 +1,21 @@
+module Schneiderlein
+  class Catch
+    delegate :any?, :empty?, to: :errors
+
+    attr_reader :request
+
+    def initialize(request)
+      @request = request
+    end
+
+    def to_a
+      request.env.fetch('rack.schneiderlein.parse_errors', [])
+    end
+
+    alias errors to_a
+
+    def to_s
+      to_a.map(&:message).join ' '
+    end
+  end
+end

data/lib/schneiderlein/engine.rb

@@ -0,0 +1,11 @@
+module Schneiderlein
+  class Engine < ::Rails::Engine
+    isolate_namespace Schneiderlein
+
+    initializer 'schneiderlein.middleware' do |app|
+      app.config.middleware.insert_before \
+        'ActionDispatch::ParamsParser', 'Schneiderlein::FlyCatcher'
+    end
+  end
+
+end

data/lib/schneiderlein/fly_catcher.rb

@@ -0,0 +1,24 @@
+module Schneiderlein
+  class FlyCatcher < Struct.new(:app)
+    def call(env)
+      begin
+        app.call(env)
+      rescue ActionDispatch::ParamsParser::ParseError => e
+        env['rack.schneiderlein.parse_errors'] ||= []
+        env['rack.schneiderlein.parse_errors'] << e
+        app.call(remove_errors_from(env))
+      end
+    end
+
+    private
+
+    def remove_errors_from(env)
+      env['rack.input']     = StringIO.new
+      env['rack.errors']    = StringIO.new
+      env['RAW_POST_DATA']  = ''
+      env['CONTENT_LENGTH'] = '0'
+      env
+    end
+
+  end
+end

data/lib/schneiderlein/version.rb

@@ -0,0 +1,3 @@
+module Schneiderlein
+  VERSION = '1.0.0'
+end

data/lib/tasks/schneiderlein_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :schneiderlein do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: schneiderlein
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Carsten Zimmermann
+- Robin Neumann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: sqlite3
+  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-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'
+description: Rescues from ActionDispatch::ParamsParser and continues in middleware
+  stack
+email:
+- cz@aegisnet.de
+- robin.neumann@absolventa.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/schneiderlein/application.css
+- app/controllers/schneiderlein/application_controller.rb
+- app/helpers/schneiderlein/application_helper.rb
+- app/views/layouts/schneiderlein/application.html.erb
+- config/routes.rb
+- lib/schneiderlein.rb
+- lib/schneiderlein/catch.rb
+- lib/schneiderlein/engine.rb
+- lib/schneiderlein/fly_catcher.rb
+- lib/schneiderlein/version.rb
+- lib/tasks/schneiderlein_tasks.rake
+homepage: https://github.com/Absolventa/schneiderlein
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rack middleware that rescues from ActionDispatch::ParamsParser
+test_files: []