pan 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e439926c079be533eaae81268a515e263efe6cfa
+  data.tar.gz: 3eeaac383f04043f7703d6c2e4044dcd218fceeb
+SHA512:
+  metadata.gz: f14cf72b8f7b604e3d6411127767a7fa3df37771648c6f4048156e70a6fed3e4037eca0f7bed22b48a1ee95a23797327fc1b0427192e195b2cb97d964434321a
+  data.tar.gz: 93b04840f500cd10cb5f15d6dbb6c7ce65480c8e91a5fefaa7b9458752bc057697e408dc8866f4a8e1de2cd30559631197a7262470d3c468c6d3f7a4a1a39801

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Clearhaus
+
+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,46 @@
+# pan
+
+Cares about PANs ([Primary Account Number](https://en.wikipedia.org/wiki/Payment_card_number)).
+
+## Examples
+
+```ruby
+require 'pan'
+
+pan = '1234567890123456'
+
+Pan.mask(pan)
+#=> '123456******3456'
+
+pan
+#=> '1234567890123456'
+
+Pan.truncate(pan)
+#=> '123456******3456'
+
+pan
+#=> '123456******3456'
+```
+
+(Yes, that's the difference between masking and truncating a PAN in PCI DSS
+terminology.)
+
+You may decide how much to mask (or truncate) and the character(s) that the
+digits are replaced with:
+
+```ruby
+Pan.template = [0, 'x', 4]
+
+Pan.mask('1234567890123456')
+#=> 'xxxxxxxxxxxx3456'
+```
+
+```ruby
+pan = '1234567890123456'
+
+Pan.mask(pan, template: [4, 'X', 4])
+#=> '1234XXXXXXXX3456'
+
+Pan.truncate(pan, template: [6, '*', 4]); pan
+#=> '123456******3456'
+```

data/lib/pan.rb

@@ -0,0 +1,29 @@
+class Pan
+  VERSION = '1.0.0'
+
+  singleton_class.class_eval do
+    attr_accessor :template
+  end
+
+  DEFAULT_TEMPLATE = [6, '*', 4]
+  self.template = DEFAULT_TEMPLATE
+
+  class Error < RuntimeError; end
+
+  def self.mask(pan, template: self.template)
+    fail Pan::Error, 'invalid template' unless template.first >= 0 and template.last >= 0 and template[1].is_a?(String)
+    fail Pan::Error, 'invalid pan' unless pan.is_a?(String)
+
+    mask_length = pan.length - template.first - template.last
+
+    return pan if mask_length <= 0
+
+    pan.slice(0, template.first) \
+      + (template[1] * mask_length) \
+      + pan.slice(-template.last, template.last)
+  end
+
+  def self.truncate(pan, template: self.template)
+    pan.replace(self.mask(pan, template: template))
+  end
+end

data/spec/pan_spec.rb

@@ -0,0 +1,97 @@
+require_relative '../lib/pan.rb'
+
+describe 'Pan#mask' do
+  it 'default template' do
+    expect(Pan.mask('')).to                     eq ''
+    expect(Pan.mask('1')).to                    eq '1'
+    expect(Pan.mask('12')).to                   eq '12'
+    expect(Pan.mask('123')).to                  eq '123'
+    expect(Pan.mask('1234')).to                 eq '1234'
+    expect(Pan.mask('12345')).to                eq '12345'
+    expect(Pan.mask('123456')).to               eq '123456'
+    expect(Pan.mask('1234567')).to              eq '1234567'
+    expect(Pan.mask('12345678')).to             eq '12345678'
+    expect(Pan.mask('123456789')).to            eq '123456789'
+    expect(Pan.mask('1234567890')).to           eq '1234567890'
+    expect(Pan.mask('12345678901')).to          eq '123456*8901'
+    expect(Pan.mask('123456789012')).to         eq '123456**9012'
+    expect(Pan.mask('1234567890123')).to        eq '123456***0123'
+    expect(Pan.mask('12345678901234')).to       eq '123456****1234'
+    expect(Pan.mask('123456789012345')).to      eq '123456*****2345'
+    expect(Pan.mask('1234567890123456')).to     eq '123456******3456'
+    expect(Pan.mask('12345678901234567')).to    eq '123456*******4567'
+    expect(Pan.mask('123456789012345678')).to   eq '123456********5678'
+    expect(Pan.mask('1234567890123456789')).to  eq '123456*********6789'
+    expect(Pan.mask('12345678901234567890')).to eq '123456**********7890'
+  end
+
+  it 'per mask template' do
+    expect(Pan.mask('1234', template: [1,'-',1])).to eq '1--4'
+  end
+
+  it 'long replacement string' do
+    expect(Pan.mask('1234', template: [1,'abc',1])).to eq '1abcabc4'
+  end
+
+  context 'front/end corner cases' do
+    let (:pan) { '12345' }
+
+    it 'some in front, some in end' do
+      expect(Pan.mask(pan, template: [2,'-',2])).to eq '12-45'
+    end
+
+    it 'none in front, some in end' do
+      expect(Pan.mask(pan, template: [0,'-',2])).to eq '---45'
+    end
+
+    it 'some in front, none in end' do
+      expect(Pan.mask(pan, template: [2,'-',0])).to eq '12---'
+    end
+
+    it 'none in front, none in end' do
+      expect(Pan.mask(pan, template: [0,'-',0])).to eq '-----'
+    end
+  end
+
+  context 'pan corner cases' do
+    it 'empty pan' do
+      expect(Pan.mask('', template: [1,'x',1])).to eq ''
+      expect(Pan.mask('', template: [0,'x',0])).to eq ''
+    end
+
+    it 'nil pan fail' do
+      expect{Pan.mask(nil)}.to raise_error(Pan::Error, /invalid pan/)
+    end
+
+    it 'integer pan fail' do
+      expect{Pan.mask(1234567890123456)}.to raise_error(Pan::Error, /invalid pan/)
+    end
+  end
+
+  it 'fails on invalid template' do
+    expect{Pan.mask('', template: [-1,'x',0])}.to raise_error(Pan::Error, /invalid template/)
+  end
+
+  it 'custom global template' do
+    previous_template, Pan.template = Pan.template, [2,'X',2]
+
+    expect(Pan.mask('1234567890123456')).to eq '12XXXXXXXXXXXX56'
+
+    Pan.template = previous_template
+  end
+
+  it 'does not changes the object' do
+    pan = '1234567890123456'
+    expect(Pan.mask(pan)).to eq '123456******3456'
+    expect(pan).to eq pan
+  end
+end
+
+describe 'Pan#truncate' do
+  it 'uses #mask and changes the object' do
+    pan = '1234'
+    expect(Pan).to receive(:mask).with(pan, template: Pan::DEFAULT_TEMPLATE).and_return('1**4')
+    Pan.truncate(pan)
+    expect(pan).to eq '1**4'
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: pan
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Casper Thomsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: |2
+      A credit card number AKA Primary Account Number (PAN) often needs to be
+      masked or truncated, that is, have "enough" digits made unreadable.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/pan.rb
+- spec/pan_spec.rb
+homepage: http://github.com/clearhaus/pan
+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.6
+signing_key: 
+specification_version: 4
+summary: Cares about PANs (credit card numbers)
+test_files: []
+has_rdoc: