string_scrubber 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d69a96381b06bf1557646ec2d66e41258d9fd9d0
+  data.tar.gz: 53e798dbf0153e94f621c8cbf78bf4cd59cbb42e
+SHA512:
+  metadata.gz: 0959fc9b1982c70654295c3d5b803062f31f8a3c2d3882ea8ffe1915e84b8b6ba0be312ca11275459bf8e8d1c34be4247b155ec3b2df9e7c40c858930f49ee43
+  data.tar.gz: 3ee73fd5bf22105b928aa38d571ada8bccc9af397824c0a64a484057b8fd31837dd0c4d17f5c3e709e5bbbb13419b16ff02ec2abe9dd83425694aec259c3c01d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,59 @@
+# StringScrubber
+
+[![Code
+Climate](https://codeclimate.com/github/ministryofjustice/string_scrubber/badges/gpa.svg)](https://codeclimate.com/github/ministryofjustice/string_scrubber)
+[![Circle
+CI](https://circleci.com/gh/ministryofjustice/string_scrubber.svg?style=svg)](https://circleci.com/gh/ministryofjustice/string_scrubber)
+[![Test
+Coverage](https://codeclimate.com/github/ministryofjustice/string_scrubber/badges/coverage.svg)](https://codeclimate.com/github/ministryofjustice/string_scrubber/coverage)
+
+
+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](https://github.com/shadabahmed/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:
+
+```bash
+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:
+
+```ruby
+gem 'MoJ_IRAT_string_scrubber'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install MoJ_IRAT_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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/MoJ_IRAT_string_scrubber.
+
+## License
+
+[Open Government License v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "string_scrubber"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,6 @@
+machine:
+  ruby:
+    version: 2.2.2
+dependencies:
+  pre:
+    - gem install bundler

data/lib/string_scrubber/version.rb

@@ -0,0 +1,3 @@
+module StringScrubber
+  VERSION = "0.1.0"
+end

data/lib/string_scrubber.rb

@@ -0,0 +1,11 @@
+require 'string_scrubber/version'
+
+module StringScrubber
+  def to_json(options = nil)
+    self.force_encoding('UTF-8') unless self.encoding == Encoding::UTF_8
+    self.scrub! unless self.valid_encoding?
+    super(options)
+  end
+end
+
+String.prepend(StringScrubber)

data/string_scrubber.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'string_scrubber/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "string_scrubber"
+  spec.version       = StringScrubber::VERSION
+  spec.authors       = ["Todd Tyree"]
+  spec.email         = ["todd.tyree@digital.justice.gov.uk"]
+
+  spec.summary       = %q{Drop in fix for JSON UTF-8 encoding errors in logstasher.}
+  spec.description   = %q{Logstasher fails if controller params are not properly encoded. This fixes these.}
+  spec.homepage      = "http://github.com/ministryofjustice/string_scrubber"
+  spec.license       = 'ogl'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "json", "~> 1.8"
+  spec.add_development_dependency "simplecov", "~> 0.10"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: string_scrubber
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Todd Tyree
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Logstasher fails if controller params are not properly encoded. This
+  fixes these.
+email:
+- todd.tyree@digital.justice.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/string_scrubber.rb
+- lib/string_scrubber/version.rb
+- string_scrubber.gemspec
+homepage: http://github.com/ministryofjustice/string_scrubber
+licenses:
+- ogl
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Drop in fix for JSON UTF-8 encoding errors in logstasher.
+test_files: []