utf8_gatekeeper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb14e2d751a46edd014eedf402b742c7bf5b496c
+  data.tar.gz: ade7707161b8ed9b41364cbcf9fe8ff90b5f59d8
+SHA512:
+  metadata.gz: 343f89b32d419caee2c5e25660ae77a8dcf80e29a807b5e7daffbb068fd39925af26d6dbc6ef7b86d59dac32ffd1f6f005f00c1c9d88a8c4ac3c294e141f0ba4
+  data.tar.gz: 53a2adc6b478f8923e53b56b7c9d455c236779a7162744006689bf056e20687f69489e795bccec1c8d54f508b0007f62bd9addbe7b7f9f51a3eb4a53d44c0acc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - 2.2.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2015 Leon Miller-Out and Edward Robinson
+
+MIT License
+
+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,45 @@
+# UTF8Gatekeeper
+
+Returns a 400 error when there are invalid UTF-8 characters in the environment so that your app doesn't choke
+on them. This prevents errors like "invalid byte sequence in UTF-8".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'utf8_gatekeeper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install utf8_gatekeeper
+
+If you're not running Rails, you'll have to add the middleware to your config.ru:
+
+    require 'utf8_gatekeeper'
+    use UTF8Gatekeeper::Middleware
+
+## Usage
+
+There's nothing to "use". It just works!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+Forked from https://github.com/singlebrook/utf8-cleaner
+
+Original middleware author: @phoet - https://gist.github.com/phoet/1336754
+
+* Ruby 1.9.3 compatibility: @pithyless - https://gist.github.com/pithyless/3639014
+* Code review and cleanup: @nextmat
+* POST body sanitization: @salrepe

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task build: :spec

data/lib/utf8_gatekeeper.rb

@@ -0,0 +1,3 @@
+require 'utf8_gatekeeper/version'
+require 'utf8_gatekeeper/middleware'
+require 'utf8_gatekeeper/railtie' if defined? Rails

data/lib/utf8_gatekeeper/middleware.rb

@@ -0,0 +1,47 @@
+module UTF8Gatekeeper
+  class Middleware
+
+    CHECK_ENV_KEYS = %w(HTTP_REFERER PATH_INFO QUERY_STRING REQUEST_PATH REQUEST_URI HTTP_COOKIE)
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if check?(env)
+        @app.call(env)
+      else
+        [400, { 'Content-Type' => 'text/plain' }, ['Sorry, you need to use valid UTF8 if you want this to work']]
+      end
+    end
+
+    private
+
+    def check?(env)
+      check_env_keys?(env) &&
+        check_env_rack_input?(env)
+    end
+
+    def check_env_keys?(env)
+      CHECK_ENV_KEYS.map do |key|
+        next unless value = env[key]
+        value.valid_encoding?
+      end.compact.all?
+    end
+
+    def check_env_rack_input?(env)
+      case env['CONTENT_TYPE']
+      when 'application/x-www-form-urlencoded'
+        valid = env['rack.input'].read.valid_encoding?
+        env['rack.input'].rewind if valid
+        valid
+      when 'multipart/form-data'
+        # Don't check the data since it may contain binary content
+        true
+      else
+        # Unknown content type. Leave it alone
+        true
+      end
+    end
+  end
+end

data/lib/utf8_gatekeeper/railtie.rb

@@ -0,0 +1,7 @@
+module UTF8Gatekeeper
+  class Railtie < Rails::Railtie
+    initializer 'utf8-gatekeeper.insert_middleware' do |app|
+      app.config.middleware.insert_before 0, 'UTF8Gatekeeper::Middleware'
+    end
+  end
+end

data/lib/utf8_gatekeeper/version.rb

@@ -0,0 +1,3 @@
+module UTF8Gatekeeper
+  VERSION = '0.0.1'
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'rack/lint'
+
+describe UTF8Gatekeeper::Middleware do
+  subject { described_class.new(app) }
+
+  class FakeApp
+    def call(env)
+      [200, { 'Content-Type' => 'text/plain' }, [env['rack.input'].read]]
+    end
+  end
+
+  let(:app) { FakeApp.new }
+
+  let(:env) do
+    {
+      'PATH_INFO' => path_info,
+      'QUERY_STRING' => query_string,
+      'HTTP_REFERER' => http_referer,
+      'HTTP_COOKIE' => http_cookie,
+      'REQUEST_URI' => request_uri,
+      'rack.input' => Rack::Lint::InputWrapper.new(StringIO.new(rack_input)),
+      'CONTENT_TYPE' => content_type,
+    }
+  end
+
+  let(:content_type) { 'application/x-www-form-urlencoded' }
+
+  let(:path_info)    { 'foo/bar_baz' }
+  let(:query_string) { 'foo=bar' }
+  let(:http_cookie)  { 'foo=bar:watsit=whatever' }
+  let(:http_referer) { 'http://example.com/blog' }
+  let(:request_uri)  { 'foo-bar-whatever' }
+  let(:rack_input)   { 'foo-foo-foo' }
+
+  context 'with clean data' do
+    it 'calls the app' do
+      expect(subject.call(env)).to eq(
+        [
+          200,
+          { 'Content-Type' => 'text/plain' },
+          [ 'foo-foo-foo' ],
+        ]
+      )
+    end
+  end
+
+  context 'with garbage' do
+    let(:garbage) { (100..1000).to_a.pack('c*').force_encoding('utf-8') }
+
+    shared_examples 'error' do
+      it 'returns a 400' do
+        expect(subject.call(env).first).to eq 400
+      end
+
+      it 'sets content type header to text/plain' do
+        expect(subject.call(env)[1]['Content-Type']).to eq 'text/plain'
+      end
+
+      it 'returns some useful body text' do
+        expect(subject.call(env).last).to eq ['Sorry, you need to use valid UTF8 if you want this to work']
+      end
+    end
+
+    context 'in PATH_INFO' do
+      let(:path_info) { garbage }
+      it_behaves_like 'error'
+    end
+
+    context 'in QUERY_STRING' do
+      let(:query_string) { garbage }
+      it_behaves_like 'error'
+    end
+
+    context 'in HTTP_REFERER' do
+      let(:http_referer) { garbage }
+      it_behaves_like 'error'
+    end
+
+    context 'in REQUEST_URI' do
+      let(:request_uri) { garbage }
+      it_behaves_like 'error'
+    end
+
+    context 'in HTTP_COOKIE' do
+      let(:http_cookie) { garbage }
+      it_behaves_like 'error'
+    end
+
+    context 'in rack.input' do
+      let(:rack_input) { garbage }
+
+      context 'when the CONTENT_TYPE is application/x-www-form-urlencoded' do
+        it_behaves_like 'error'
+      end
+
+      context 'when the CONTENT_TYPE is multipart/form-data' do
+        let(:content_type) { 'multipart/form-data' }
+
+        it 'calls the app' do
+          expect(subject.call(env)).to eq(
+            [
+              200,
+              { 'Content-Type' => 'text/plain' },
+              [ garbage ],
+          ]
+          )
+        end
+      end
+
+      context 'when the CONTENT_TYPE is some/unknown-content-type' do
+        let(:content_type) { 'some/unknown-content-type' }
+
+        it 'calls the app' do
+          expect(subject.call(env)).to eq(
+            [
+              200,
+              { 'Content-Type' => 'text/plain' },
+              [ garbage ],
+          ]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'utf8_gatekeeper'
+
+RSpec.configure do |config|
+  config.order = 'random'
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

data/utf8_gatekeeper.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'utf8_gatekeeper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'utf8_gatekeeper'
+  gem.version       = UTF8Gatekeeper::VERSION
+  gem.authors       = ['Ed Robinson']
+  gem.email         = ['ed@reevoo.com']
+  gem.description   = 'Prevents invalid UTF8 characters from the URL and other env vars reaching your app'
+  gem.summary       = 'Prevent annoying error reports of "invalid byte sequence in UTF-8"'
+  gem.homepage      = 'https://github.com/reevoo/utf8_gatekeeper'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.test_files    = gem.files.grep(/^spec\//)
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: utf8_gatekeeper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ed Robinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+    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
+  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: Prevents invalid UTF8 characters from the URL and other env vars reaching
+  your app
+email:
+- ed@reevoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/utf8_gatekeeper.rb
+- lib/utf8_gatekeeper/middleware.rb
+- lib/utf8_gatekeeper/railtie.rb
+- lib/utf8_gatekeeper/version.rb
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- utf8_gatekeeper.gemspec
+homepage: https://github.com/reevoo/utf8_gatekeeper
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Prevent annoying error reports of "invalid byte sequence in UTF-8"
+test_files:
+- spec/middleware_spec.rb
+- spec/spec_helper.rb