0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Logstasher fails if controller params are not properly encoded. This fixes these.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.10
~> 1.8
~> 10.0
~> 3.3
~> 0.10

Runtime

~> 0.0.5
 Project Readme

StringScrubber

Code Climate Circle CI Test Coverage Gem Version

This gem prevents #to_json calls from raising exceptions on strings that are not UTF-8 encoded. It was written to deal with logging failures in the logstasher gem.

The exceptions were JSON::GeneratorError and Encoding::UndefinedConversionError and occurred when trying to log controller parameters that contained ASCII-8BIT strings. You can reproduce these errors on a running app using the following curl command:

curl -i -X GET "http://localhost:3000/tests" -d $'param=a\xE2a'

See the specs for a typical example string.

Installation

Add this line to your application's Gemfile:

gem 'string_scrubber'

And then execute:

$ bundle

Or install it yourself as:

$ gem install string_scrubber

Usage

Install it. It does the rest.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ministryofjustice/string_scrubber.

License

Open Government License v3.0