card_redactor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56468a4a284a7403df9e10a2b90c175aa909156d
+  data.tar.gz: c579b8286fdc3dc0150d61ba986a51fd1dde9176
+SHA512:
+  metadata.gz: 889cf86f76eee8ea4f3547fb61414ab1a41320a5ffcb063ce93cf85cf00c0719029de1c9b8dc5aac21870491b63f9e46db2deeb7b5c4691a59dcb52c8c7d5008
+  data.tar.gz: be1f05511637842980c335985dd0949208d4d1cc66570327619f41531fcd8cbcbc5c0559f36de75a75255f9cfe1843357c190d18a754437ddf54cfa323ba3eae

data/.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,68 @@
+# CardRedactor
+
+A gem for detecting sensitive [credit card PANs](https://en.wikipedia.org/wiki/Payment_card_number) in strings, and redacting them. All digits, except the trailing 4, are replaced with X. The original format of the number is kept intact. Supports Visa, Mastercard, AMEX, and Discover. Useful for cases where user input may inadvertently contain credit card numbers, and you want to ensure they aren't stored.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'card_redactor', '~> 1.0.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install card_redactor
+
+## Usage
+
+Firstly, `CardRedactor` can be used to detect the presence of a credit card PAN in a string:
+
+```ruby
+>> card = "4111-1111-1111-1111"
+=> "4111-1111-1111-1111"
+>> CardRedactor.contains_card?(card)
+=> true
+```
+
+Secondly, you can redact those PANs, replacing all but the last 4 digits with Xs:
+
+```ruby
+>> CardRedactor.redact(card)
+=> "XXXX-XXXX-XXXX-1111"
+```
+
+It'll work with natural language sentences, and leave numbers that aren't credit cards alone:
+
+```ruby
+>> card = "A more complex example, with an NZ bank account 12-1212-343434-01 and a credit card 4111111111111111, wow!"
+=> "A more complex example, with an NZ bank account 12-1212-343434-01 and a credit card 4111111111111111, wow!"
+>> CardRedactor.contains_card?(card)
+=> true
+>> CardRedactor.redact(card)
+=> "A more complex example, with an NZ bank account 12-1212-343434-01 and a credit card XXXXXXXXXXXX1111, wow!"
+```
+
+and strings that contain more than one PAN:
+
+```ruby
+>> card = "I've got 4111111111111111 and 3759-876513-21001"
+=> "I've got 4111111111111111 and 3759-876513-21001"
+>> CardRedactor.redact(card)
+=> "I've got XXXXXXXXXXXX1111 and XXXX-XXXXXX-X1001"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/pocketsmith/card-redactor.
+

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 "card_redactor"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/card_redactor.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "card_redactor"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Regan McEntyre"]
+  spec.email         = ["regan@pocketsmith.com"]
+
+  spec.summary       = "Credit card redactor"
+  spec.description   = "A library to detect and redact credit card numbers (PANs)"
+  spec.homepage      = "https://www.pocketsmith.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 2.3"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/card_redactor.rb

@@ -0,0 +1,56 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+class CardRedactor
+
+  # Matches Visa, Mastercard, AMEX, Discover
+  # Read more: http://www.richardsramblings.com/regex/credit-card-numbers/
+  CARD_PATTERN = /\b(?:3[47]\d{2}([\ \-+]?)\d{6}\1\d|(?:(?:4\d|5[1-5]|65)\d{2}|6011)([\ \-+]?)\d{4}\2\d{4}\2)\d{4}\b/
+
+  class << self
+
+    def contains_card?(string)
+      card_matches(string).any?
+    end
+
+    def card_matches(string)
+      # Scan to get all cards in the string, but get the Matchdata instead
+      # Read more: http://stackoverflow.com/a/13817639/881691
+      [].tap { |matches| string.scan(CARD_PATTERN) { matches << $~ } }
+    end
+
+    def redact(string)
+      matches = card_matches(string)
+
+      return string if matches.none?
+
+      matches.each do |match|
+        card = match[0]
+
+        parts = []
+
+        # In Ruby 1.9, there's no reliable way to deal with chars in strings
+        # individually apart from splitting them into an array. In 2.x, we can
+        # use array access notation to get at individual characters in a byte-safe manner.
+        card.split("").reverse.each_with_index do |char, index|
+          if index < 4 || char !~ /\d/
+            parts << char
+          else
+            # If we've gone past the last 4 digits, redact numbers
+            parts << "X"
+          end
+        end
+
+        # Turn the numbers around the right way and implode them into a string
+        redacted_card = parts.reverse.join("")
+
+        # Replace the plaintext card with the redacted card in the original string
+        string = string.sub(card, redacted_card)
+      end
+
+      string
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: card_redactor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Regan McEntyre
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A library to detect and redact credit card numbers (PANs)
+email:
+- regan@pocketsmith.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- card_redactor.gemspec
+- lib/card_redactor.rb
+homepage: https://www.pocketsmith.com
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Credit card redactor
+test_files: []