utf8-cleaner 0.0.4

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Leon Miller-Out
+
+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,41 @@
+# UTF8Cleaner
+
+Removes invalid UTF-8 characters from 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-cleaner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install utf8-cleaner
+
+If you're not running Rails, you'll have to add the middleware to your config.ru:
+
+    require 'uf8-cleaner'
+    use UTF8Cleaner::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
+
+Original middleware author: @phoet - https://gist.github.com/phoet/1336754
+
+Ruby 1.9.3 compatibility: @pithyless - https://gist.github.com/pithyless/3639014

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/utf8-cleaner/middleware.rb

@@ -0,0 +1,60 @@
+module UTF8Cleaner
+  class Middleware
+
+    SANITIZE_ENV_KEYS = [
+     "HTTP_REFERER",
+     "PATH_INFO",
+     "QUERY_STRING",
+     "REQUEST_PATH",
+     "REQUEST_URI",
+    ]
+
+    def initialize(app)
+     @app = app
+    end
+
+    def call(env)
+     @app.call(sanitize_env(env))
+    end
+
+    private
+
+    def sanitize_env(env)
+     SANITIZE_ENV_KEYS.each do |key|
+       next unless value = env[key]
+       value = sanitize_string(URI.decode(value))
+       env[key] = URI.encode(value)
+     end
+     ["HTTP_COOKIE"].each do |key|
+       next unless value = env[key]
+       fixed = sanitize_string(value)
+       env[key] = fixed if fixed
+     end
+     env
+    end
+
+    def sanitize_string(string)
+      return string unless string.is_a? String
+
+      # Try it as UTF-8 directly
+      cleaned = string.dup.force_encoding('UTF-8')
+      if cleaned.valid_encoding?
+        cleaned
+      else
+        utf8clean(string)
+      end
+    rescue EncodingError
+      utf8clean(string)
+    end
+
+    def utf8clean(string)
+      # Force it to UTF-8, throwing out invalid bits
+      if RUBY_VERSION >= "1.9.3"
+        # These converters don't exist in 1.9.2
+        string.encode('UTF-16', 'UTF-8', :invalid => :replace, :replace => '').encode('UTF-8', 'UTF-16')
+      else
+        string.chars.select{|i| i.valid_encoding?}.join
+      end
+    end
+  end
+end

data/lib/utf8-cleaner/railtie.rb

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

data/lib/utf8-cleaner/version.rb

@@ -0,0 +1,3 @@
+module UTF8Cleaner
+  VERSION = "0.0.4"
+end

data/lib/utf8-cleaner.rb

@@ -0,0 +1,3 @@
+require "utf8-cleaner/version"
+require "utf8-cleaner/middleware"
+require "utf8-cleaner/railtie" if defined? Rails

data/spec/middleware_spec.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe 'UTF8Cleaner::Middleware' do
+  let :env do
+    {
+      'PATH_INFO' => 'foo/bar%2e%2fbaz',
+      'QUERY_STRING' => 'foo=bar%FF',
+      'HTTP_REFERER' => 'http://example.com/blog+Result:+%ED%E5+%ED%E0%F8%EB%EE%F1%FC+%F4%EE%F0%EC%FB+%E4%EB%FF+%EE%F2%EF%F0%E0%E2%EA%E8',
+      'REQUEST_URI' => '%C3%89'
+    }
+  end
+
+  let :new_env do
+    UTF8Cleaner::Middleware.new(nil).send(:sanitize_env, env)
+  end
+
+  it "removes invalid UTF-8 sequences" do
+    new_env['QUERY_STRING'].should == 'foo=bar'
+  end
+
+  it "turns valid %-escaped ASCII chars into their ASCII equivalents" do
+    new_env['PATH_INFO'].should == 'foo/bar./baz'
+  end
+
+  it "leaves valid %-escaped UTF-8 chars alone" do
+    new_env['REQUEST_URI'].should == '%C3%89'
+  end
+
+  it "handles an awful URL" do
+    new_env['HTTP_REFERER'].should == 'http://example.com/blog+Result:+++++'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rspec/autorun'
+
+require 'utf8-cleaner'
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

data/utf8-cleaner.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'utf8-cleaner/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "utf8-cleaner"
+  gem.version       = UTF8Cleaner::VERSION
+  gem.authors       = ["Leon Miller-Out"]
+  gem.email         = ["leon@singlebrook.com"]
+  gem.description   = %q{Removes invalid UTF8 characters from the URL and other env vars}
+  gem.summary       = %q{Prevent annoying error reports of "invalid byte sequence in UTF-8"}
+  gem.homepage      = "https://github.com/singlebrook/utf8-cleaner"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: utf8-cleaner
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Leon Miller-Out
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Removes invalid UTF8 characters from the URL and other env vars
+email:
+- leon@singlebrook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/utf8-cleaner.rb
+- lib/utf8-cleaner/middleware.rb
+- lib/utf8-cleaner/railtie.rb
+- lib/utf8-cleaner/version.rb
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- utf8-cleaner.gemspec
+homepage: https://github.com/singlebrook/utf8-cleaner
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Prevent annoying error reports of "invalid byte sequence in UTF-8"
+test_files:
+- spec/middleware_spec.rb
+- spec/spec_helper.rb