maskerade 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: acc7e01071137d4e8d0af63cb890f83782a56957f856151008510d01d68f47ba
+  data.tar.gz: 1826c49ba8c23deb12492c5b894a5ff62630039fa03f5331bdf609c43068f6d1
+SHA512:
+  metadata.gz: 4414accea7a7ffb9c166ed59aac8e96ee2812f5bc73ce0bae1897bead3f920f6f50779ce480d26e1e8577d20eb9db42ad6aafd970c261b7529cdffb09494a896
+  data.tar.gz: ee44f4271256f03cd880e4915e79db8a18b54d487600d72ed855f7a6324b0e0d8a6c2436c3e827e0253e5643011942c211e9eb18cd273ecc28a8e90829f581aa

data/.gitignore

@@ -0,0 +1,15 @@
+/.vscode/
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  mad_rubocop: .rubocop.yml
+
+# Styles that are modified from the defaults
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'coverage/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.6

data/.ruby-gemset

@@ -0,0 +1 @@
+maskerade

data/Gemfile

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

data/README.md

@@ -0,0 +1,44 @@
+![maskerade.png](maskerade.png)
+
+# Maskerade
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'maskerade'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install maskerade
+
+## Usage
+
+```ruby
+masker = ::Maskerade::CreditCardMasker.new(:replacement_token => "X", :expose_last => 4)
+masker.mask("4111-1111-1111-1111")  # "XXXX-XXXX-XXXX-1111"
+```
+
+```ruby
+masker = ::Maskerade::CreditCardMasker.new(:replacement_text => "[MASKED]")
+masker.mask("4111-1111-1111-1111")  # "[MASKED]"
+```
+
+## Notes
+
+This gem works similar to the zendesk credit_card_sanitizer gem, but has the advantage of being able to work
+even when the card number is preceded or followed by extra numbers:
+* E.g., it works on "Starbucks Store #555 6011 0726 6818 0642"
+* See https://github.com/zendesk/credit_card_sanitizer/issues/47
+
+## 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).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "maskerade"
+
+# 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(__FILE__)

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/lib/maskerade.rb

@@ -0,0 +1,5 @@
+require "maskerade/version"
+require "maskerade/credit_card_masker"
+
+module Maskerade
+end

data/lib/maskerade/credit_card_masker.rb

@@ -0,0 +1,62 @@
+require "luhn_checksum"
+
+# Masks all possible credit card numbers, which may be seperated by dashes or spaces.
+# Some options are available to control how the card gets masked.
+module Maskerade
+  class CreditCardMasker
+    attr_reader :replacement_token, :expose_last
+
+    COMPANY_CARD_REGEX = {
+      :visa => /\b4\d{3}[ -]?\d{4}[ -]?\d{4}[ -]?(?:\d|\d{4}|\d{7})\b/,
+      :amex => /\b3[47]\d{2}[ -]?\d{6}[ -]?\d{5}\b/,
+      :diners_club => /\b3(?:0[0-5]|[68]\d)\d[ -]?\d{6}[ -]?(?:\d{4}|\d{9})\b/,
+      :mastercard => /\b(?:5[1-5]\d{2}[ -]?\d{2}|6771[ -]?89|222[1-9][ -]?\d{2}|22[3-9]\d[ -]?\d{2}|2[3-6]\d{2}[ -]?\d{2}|27[01]\d[ -]?\d{2}|2720[ -]?\d{2})\d{2}[ -]?\d{4}[ -]?\d{4}\b/,
+      :discover => /\b(?:6011|65\d{2}|64[4-9]\d)[ -]?\d{4}[ -]?\d{4}[ -]?(?:\d{4}|\d{7})\b/,
+      :union_pay => /\b62\d{2}[ -]?\d{4}[ -]?\d{4}[ -]?\d{4}\b/,
+      :jcb => /\b(?:308[89]|309[0-4]|309[6-9]|310[0-2]|311[2-9]|3120|315[8-9]|333[7-9]|334[0-9]|352[89]|35[3-8]\d)[ -]?\d{4}[ -]?\d{4}[ -]?(?:\d{4}|\d{7})\b/,
+      :switch_short_iin => /\b(?:4903|4905|4911|4936|6333|6759)[ -]?\d{4}[ -]?\d{4}[ -]?\d{4}(?:\d{2,3})?\b/,
+      :switch_long_iin => /\b(?:5641[ -]?82|6331[ -]?10)\d{2}[ -]?\d{4}[ -]?\d{4}(?:\d{2,3})?\b/,
+      :solo => /\b(?:6334|6767)[ -]?\d{4}[ -]?\d{4}[ -]?\d{4}(?:\d{2,3})?\b/,
+      :dankort => /\b5019[ -]?\d{4}[ -]?\d{4}[ -]?\d{4}\b/,
+      :maestro => /\b(?:5[06-8]|6\d)\d{2}[ -]?\d{4}[ -]?\d{4}[ -]?\d{0,7}\b$/,
+      :forbrugsforeningen => /\b6007[ -]?22\d{2}[ -]?\d{4}[ -]?\d{4}\b/,
+      :laser => /\b(?:6304|6706|6709|6771(?!89))[ -]?\d{4}[ -]?\d{4}[ -]?(?:\d{4}|\d{6,7})?\b/
+    }
+
+    ALL_CARDS_REGEX = ::Regexp.union(COMPANY_CARD_REGEX.values)
+    DIGIT_REGEX = /[[:digit:]]/
+
+    # Options:
+    #   replacement_text: The entire card number gets replaced with this text; if set, the other two options are ignored.
+    #   replacement_token: The character used to replace digits of the credit number.  Defaults to "X".
+    #   expose_last: The number of trailing digits of the credit card number to leave intact.  Defaults to 0.
+    def initialize(replacement_text: nil, replacement_token: "X", expose_last: 0)
+      @replacement_text = replacement_text
+      @replacement_token = replacement_token
+      @expose_last = expose_last
+    end
+
+    def mask(value)
+      value&.gsub(ALL_CARDS_REGEX) do |match|
+        mask_one(match)
+      end
+    end
+
+  private
+
+    def mask_one(value)
+      digits = value.tr("^0-9", "")
+      return value unless ::LuhnChecksum.valid?(digits)
+
+      return @replacement_text if @replacement_text
+
+      value.gsub(DIGIT_REGEX).with_index do |number, index|
+        if index < digits.size - expose_last
+          replacement_token
+        else
+          number
+        end
+      end
+    end
+  end
+end

data/lib/maskerade/version.rb

@@ -0,0 +1,3 @@
+module Maskerade
+  VERSION = "0.1.4"
+end

data/maskerade.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "maskerade/version"
+
+::Gem::Specification.new do |spec|
+  spec.name          = "maskerade"
+  spec.version       = ::Maskerade::VERSION
+  spec.authors       = ["Phillip Hellewell"]
+  spec.email         = ["sshock@gmail.com"]
+
+  spec.summary       = "Credit card masker"
+  spec.description   = "Credit card masker with support for major credit cards and luhn check"
+  spec.homepage      = "https://github.com/mxenabled/maskerade"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 "luhn_checksum", "0.1.1"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mad_rubocop"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: maskerade
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Phillip Hellewell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: luhn_checksum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: mad_rubocop
+  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: Credit card masker with support for major credit cards and luhn check
+email:
+- sshock@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/maskerade.rb
+- lib/maskerade/credit_card_masker.rb
+- lib/maskerade/version.rb
+- maskerade.gemspec
+- maskerade.png
+homepage: https://github.com/mxenabled/maskerade
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Credit card masker
+test_files: []