RubyGems - credit_card_sanitizer - Versions diffs - 0.6.9 → 1.0.0 - Mend

credit_card_sanitizer 0.6.9 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

checksums.yaml +4 -4
data/lib/credit_card_sanitizer.rb +63 -45
metadata +3 -3

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c39e3333f13f9c1130b5f1b6f6499b7eff6c0dca6c8541e481f8d41c4686a7e9
-  data.tar.gz: 69fa1024561a947ffebbad419e8cfe2fdaba89f218f6e6a5dbeade420df77cbf
+  metadata.gz: ed9cddb911074ee952f3f65184cd75c50b81376f5c57b6aa9d198f0bc5859aff
+  data.tar.gz: 735236460e25ffcb4f458046a664a174bfdffc460c6eebbbec2c9a950ef06697
 SHA512:
-  metadata.gz: db8e96b0272a415c3300c2311ba458c6335df036c41e5aa5e0bb8bb8d6157fceca29a90740918526521f73be133910402ce65c470c3c9a6a669ee3fd6550824b
-  data.tar.gz: a2a5d648461566fc101087c12603e361fdc3b38a026c9a920ca1a0ed83819b61d57ab441b63abfa91ad4fbd733b46dd773c13832d231bc106507e41851602ab4
+  metadata.gz: 2536400933a1b3c5ee9a6df3070eb31f4b2447a780c335a3429055fb046df072a416c34813d9e4bd00238beaac3db626a285080b7f7063d1af45b87ef29656b4
+  data.tar.gz: d9f623e2b39d0ca88430bc15407d664c40569b8802dc85c10ca2c3795a339f3b129f95fe0d120e6623eeca1c28f02a9203159bd42c2446fab4000bf8cdd5b6a5

data/lib/credit_card_sanitizer.rb CHANGED Viewed

@@ -1,39 +1,48 @@
-# encoding: utf-8
-require 'luhn_checksum'
-require 'securerandom'
-require 'tracking_number'
+require "luhn_checksum"
+require "securerandom"
+require "tracking_number"
 class CreditCardSanitizer
-  # https://github.com/Shopify/active_merchant/blob/master/lib/active_merchant/billing/credit_card_methods.rb#L5-L18
   CARD_COMPANIES = {
-    'visa'               => /^4\d{12}(\d{3})?(\d{3})?$/,
-    'master'             => /^(5[1-5]\d{4}|677189|222[1-9]\d{2}|22[3-9]\d{3}|2[3-6]\d{4}|27[01]\d{3}|2720\d{2})\d{10}$/,
-    'discover'           => /^((6011|65\d{2}|64[4-9]\d)\d{12}|(62\d{14}))$/,
-    'american_express'   => /^3[47]\d{13}$/,
-    'diners_club'        => /^3(0[0-5]|[68]\d)\d{11}$/,
-    'jcb'                => /^35(28|29|[3-8]\d)\d{12}$/,
-    'switch'             => /^6759\d{12}(\d{2,3})?$/,
-    'solo'               => /^6767\d{12}(\d{2,3})?$/,
-    'dankort'            => /^5019\d{12}$/,
-    'maestro'            => /^(5[06-8]|6\d)\d{10,17}$/,
-    'forbrugsforeningen' => /^600722\d{10}$/,
-    'laser'              => /^(6304|6706|6709|6771(?!89))\d{8}(\d{4}|\d{6,7})?$/
+    "visa" => /^4\d{12}(\d{3})?(\d{3})?$/,
+    "master" => /^(5[1-5]\d{4}|677189|222[1-9]\d{2}|22[3-9]\d{3}|2[3-6]\d{4}|27[01]\d{3}|2720\d{2})\d{10}$/,
+    "discover" => /^((6011\d{12})|(65[4-9]\d{13})|(64[4-9]\d{13})|(622(?:12[6-9]|1[3-9]\d|[2-8]\d{2}|9[01]\d|92[0-5])\d{10}))$/,
+    "american_express" => /^3[47]\d{13}$/,
+    "diners_club" => /^3(0[0-5]|[68]\d)\d{11}$/,
+    "jcb" => /^35(28|29|[3-8]\d)\d{12}$/,
+    "switch" => /^(6759\d{12}(\d{2,3})?|(4903|4905|4911|4936|6333|6759)\d{12}|(4903|4905|4911|4936|6333|6759)\d{14}|(4903|4905|4911|4936|6333|6759)\d{15}|564182\d{10}|564182\d{12}|564182\d{13}|633110\d{10}|633110\d{12}|633110\d{13})$/,
+    "solo" => /^(6767\d{12}(\d{2,3})?|6334\d{12}|6334\d{14}|6334\d{15}|6767\d{14}|6767\d{15})$/,
+    "dankort" => /^5019\d{12}$/,
+    "maestro" => /^(5[06-8]\d{10,17}|6\d\d{10,17}|5018|5020|5038|5893|6304|6759|6761|6762|6763\d{8,15})$/,
+    "forbrugsforeningen" => /^600722\d{10}$/,
+    "laser" => /^(6304|6706|6709|6771(?!89))(\d{12,15}|\d{8}(\d{4}|\d{6,7})?)$/,
+    "bc_global" => /^(6541|6556)\d{12}$/,
+    "carte_blanche" => /^389\d{11}$/,
+    "insta_payment" => /^63[7-9]\d{13}$/,
+    "korean_local" => /^9\d{15}$/,
+    "union_pay" => /^62\d{14,17}$/,
+    "visa_master" => /^(4\d{12}(\d{3})?|5[1-5]\d{14})$/
   }.freeze
   CARD_NUMBER_GROUPINGS = {
-    'visa'               => [[4, 4, 4, 4]],
-    'master'             => [[4, 4, 4, 4]],
-    'discover'           => [[4, 4, 4, 4]],
-    'american_express'   => [[4, 6, 5]],
-    'diners_club'        => [[4, 6, 4]],
-    'jcb'                => [[4, 4, 4, 4]],
-    'switch'             => [[4, 4, 4, 4]],
-    'solo'               => [[4, 4, 4, 4]],
-    'dankort'            => [[4, 4, 4, 4]],
-    'maestro'            => [[4], [5]],
-    'forbrugsforeningen' => [[4, 4, 4, 4]],
-    'laser'              => [[4, 4, 4, 4]]
+    "visa" => [[4, 4, 4, 4]],
+    "master" => [[4, 4, 4, 4]],
+    "discover" => [[4, 4, 4, 4]],
+    "american_express" => [[4, 6, 5]],
+    "diners_club" => [[4, 6, 4]],
+    "jcb" => [[4, 4, 4, 4]],
+    "switch" => [[4, 4, 4, 4]],
+    "solo" => [[4, 4, 4, 4], [4, 4, 4, 4, 2], [4, 4, 4, 4, 3]],
+    "dankort" => [[4, 4, 4, 4]],
+    "maestro" => [[4], [5], [4, 4, 4, 4], [4, 4, 4, 4, 1], [4, 4, 4, 4, 2], [4, 4, 4, 4, 3]],
+    "forbrugsforeningen" => [[4, 4, 4, 4]],
+    "laser" => [[4, 4, 4, 4], [4, 4, 4, 4, 1], [4, 4, 4, 4, 2], [4, 4, 4, 4, 3]],
+    "bc_global" => [[4, 4, 4, 4]],
+    "carte_blanche" => [[4, 6, 4]],
+    "insta_payment" => [[4, 4, 4, 4]],
+    "korean_local" => [[4, 4, 4, 4]],
+    "union_pay" => [[4, 4, 4, 4], [4, 4, 4, 4, 1], [4, 4, 4, 4, 2], [4, 4, 4, 4, 3]],
+    "visa_master" => [[4, 4, 4, 4], [4, 4, 4, 4, 3]]
   }.freeze
   ACCEPTED_PREFIX = /(?:cc|card|visa|amex)\z/i
@@ -44,11 +53,11 @@ class CreditCardSanitizer
   LINE_NOISE_CHAR = /[^\w\n,()&.\/:;<>]/
   LINE_NOISE = /#{LINE_NOISE_CHAR}{,5}/
   NONEMPTY_LINE_NOISE = /#{LINE_NOISE_CHAR}{1,5}/
-  SCHEME_OR_PLUS = /((?:&#43;|\+|\/)|(?:[a-zA-Z][\-+.a-zA-Z\d]{,9}):[^\s>]+)/
+  SCHEME_OR_PLUS = /((?:&#43;|\+|\/)|(?:[a-zA-Z][-+.a-zA-Z\d]{,9}):[^\s>]+)/
   NUMBERS_WITH_LINE_NOISE = /#{SCHEME_OR_PLUS}?\d(?:#{LINE_NOISE}\d){10,30}/
   DEFAULT_OPTIONS = {
-    replacement_token: '▇',
+    replacement_token: "▇",
     expose_first: 6,
     expose_last: 4,
     use_groupings: false,
@@ -88,31 +97,40 @@ class CreditCardSanitizer
   #   sanitize!("I want all your credit card numbers!")
   #   #=> nil
   #
-  # Returns a String of the redacted text if a credit card number was detected.
-  # Returns nil if no credit card numbers were detected.
+  # If options[:return_changes] is false, returns nil if no redaction happened,
+  # else the full text after redaction.
+  #
+  # If options[:return_changes] is true, returns nil if no redaction happened,
+  # else an array of [old_text, new_text] indicating what substrings were redacted.
   def sanitize!(text, options = {})
     options = @settings.merge(options)
     text.force_encoding(Encoding::UTF_8)
-    text.scrub!('�')
-    redacted = nil
+    text.scrub!("�")
+    changes = nil
     without_expiration(text) do
       text.gsub!(NUMBERS_WITH_LINE_NOISE) do |match|
         next match if $1
-        candidate = Candidate.new(match, match.tr('^0-9', ''), $`, $')
+        candidate = Candidate.new(match, match.tr("^0-9", ""), $`, $')
         if valid_context?(candidate, options) && valid_numbers?(candidate, options)
-          redacted = true
-          redact_numbers(candidate, options)
+          redact_numbers(candidate, options).tap do |redacted_text|
+            changes ||= []
+            changes << [candidate.text, redacted_text]
+          end
         else
           match
         end
       end
     end
-    redacted && text
+    if options[:return_changes]
+      changes
+    else
+      changes && text
+    end
   end
   # A proc that can be used
@@ -144,16 +162,16 @@ class CreditCardSanitizer
   def find_company(numbers)
     CARD_COMPANIES.each do |company, pattern|
-      return company if numbers =~ pattern
+      return company if pattern.match?(numbers)
     end
   end
   def valid_grouping?(candidate, options)
     if options[:use_groupings]
-      if company = find_company(candidate.numbers)
+      if (company = find_company(candidate.numbers))
         groupings = candidate.text.split(NONEMPTY_LINE_NOISE).map(&:length)
         return true if groupings.length == 1
-        if company_groupings = CARD_NUMBER_GROUPINGS[company]
+        if (company_groupings = CARD_NUMBER_GROUPINGS[company])
           company_groupings.each do |company_grouping|
             return true if groupings.take(company_grouping.length) == company_grouping
           end
@@ -202,12 +220,12 @@ class CreditCardSanitizer
   end
   def without_expiration(text)
-    expiration_date_boundary = SecureRandom.hex.tr('0123456789', 'ABCDEFGHIJ')
+    expiration_date_boundary = SecureRandom.hex.tr("0123456789", "ABCDEFGHIJ")
     text.gsub!(EXPIRATION_DATE) do |expiration_date|
       match = expiration_date.match(/(?<whitespace>\s*)(?<rest>.*)/m)
       "#{match[:whitespace]}#{expiration_date_boundary}#{match[:rest]}#{expiration_date_boundary}"
     end
     yield
-    text.gsub!(expiration_date_boundary, '')
+    text.gsub!(expiration_date_boundary, "")
   end
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: credit_card_sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.6.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Eric Chapweske
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-02 00:00:00.000000000 Z
+date: 2024-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: luhn_checksum
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Credit card sanitizer