blinkers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aeaf242f5cdd7507cc725d0be5f11b01bd5d70b4
+  data.tar.gz: 31084b83c3164759f49589c80c7eac8cce59b537
+SHA512:
+  metadata.gz: 595cd3b2100c49d067a11b60b31a4bdf3b8664b1a0ba90c4f3cf01e35815843f058a25a12bf7fa6af0d46e88ad3333beb7fe902da46950e6f72c21bb2b2702b1
+  data.tar.gz: cb35c9835245b336bada2d30f2202db0959ffe5166075fc436a8e8582729745d240bd80effeb9f0614bc7bd7b08ae44a67bba650a31433a8dec8ae75fd110e54

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 freee K.K.
+
+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,47 @@
+# Blinkers
+
+A Rails plugin to handle sensitive data securely.
+
+# Usage
+
+Set in Gemfile and install with bundler.
+
+```Gemfile
+gem 'blinkers'
+```
+
+```
+bundle install
+```
+
+# secure_params
+
+`secure_params` is FILTERED params.
+It filters all data specified in `Rails.application.config.filter_parameters` and converts to `[FILTERED]`.
+
+So if you want to pass `params` to log file or other services, passing `secure_params` would be safer.
+
+```rb
+params['password']
+=> 'password123'
+
+secure_params['password']
+=> '[FILTERED]'
+```
+
+## Adding sensitive keys
+
+If you want to filter other data.
+Just add to `filter_parameters`.
+
+```rb
+secure_params['secure_data']
+=> 'THE SECRET DATA'
+
+Rails.application.config.filter_parameters << [:secure_data]
+
+secure_params['secure_data']
+=> '[FILTERED]'
+```
+
+“Rails”, “Ruby on Rails”, and the Rails logo are registered trademarks of David Heinemeier Hansson. All rights reserved.

data/Rakefile

@@ -0,0 +1,19 @@
+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    = 'Blinkers'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks
+

data/config/initializers/00_filter_parameters.rb

@@ -0,0 +1 @@
+Rails.application.config.filter_parameters += Blinkers::SENSITIVE_KEYS

data/config/initializers/02_bugsnag.rb

@@ -0,0 +1,5 @@
+if Object.const_defined?(:Bugsnag)
+  Bugsnag.configure do |config|
+    config.params_filters += Blinkers::SENSITIVE_KEYS
+  end
+end

data/config/initializers/airbrake.rb

@@ -0,0 +1,5 @@
+if Object.const_defined?(:Airbrake)
+  Airbrake.configure do |config|
+    config.params_filters << Blinkers::SENSITIVE_KEYS
+  end
+end

data/config/initializers/bugsnag.rb

@@ -0,0 +1,5 @@
+if Object.const_defined?(:Bugsnag)
+  Bugsnag.configure do |config|
+    config.params_filters += Blinkers::SENSITIVE_KEYS
+  end
+end

data/lib/blinkers.rb

@@ -0,0 +1,9 @@
+require "blinkers/params"
+
+module Blinkers
+  SENSITIVE_KEYS = [/password/, /card_number/, /cvc/, /mynumber/]
+
+  ActiveSupport::on_load(:action_controller) do
+    include Blinkers::Params
+  end
+end

data/lib/blinkers/params.rb

@@ -0,0 +1,19 @@
+module Blinkers
+  module Params
+    def self.included(klass)
+      klass.include InstanceMethods
+    end
+
+    module InstanceMethods
+      def secure_params(*sensitive_keys)
+        query = params.clone
+
+        filter = ActionDispatch::Http::ParameterFilter.new(
+          Rails.application.config.filter_parameters + sensitive_keys
+        )
+
+        filter.filter(query)
+      end
+    end
+  end
+end

data/lib/blinkers/version.rb

@@ -0,0 +1,3 @@
+module Blinkers
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: blinkers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Junichi Kaku
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.1.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: Provides secure_params that converts sensitive data to [FILTERED]. And
+  send [FILTERED] data to error monitoring sevices.
+email:
+- kaku@freee.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/initializers/00_filter_parameters.rb
+- config/initializers/02_bugsnag.rb
+- config/initializers/airbrake.rb
+- config/initializers/bugsnag.rb
+- lib/blinkers.rb
+- lib/blinkers/params.rb
+- lib/blinkers/version.rb
+homepage: https://github.com/freee/blinkers
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A Rails plugin to handle sensitive data securely.
+test_files: []