ssn_validation 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 055a5606a0f3628720394e6fadc9d7d031cccfd56ae1004184bc7e1c741881b2
+  data.tar.gz: 9fa6a0e907840f4b7e04981144e6d13930a1af4d53103d29ed0d61ad691a0c2b
+SHA512:
+  metadata.gz: 77969a0983d95df462807ea033cf37aca5142e1122d28867e736fcf1515f53b3cf72ed8e8722b1c38603f07f162a225406702fb0ce7671d3510459c38faacffe
+  data.tar.gz: 58ec9cef29eed8d78060b14a3a7d006c746816ab1f6b37f9a3bb2111359b8ad9cd5ae3866fc4850207ed0620e21a44d372ba54cbe0b72c3ac342d18570396620

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/ssn_validation.rb

@@ -0,0 +1,2 @@
+require 'ssn_validation/ssn_validation'
+require 'ssn_validation/ssn'

data/lib/ssn_validation/ssn.rb

@@ -0,0 +1,56 @@
+module SsnValidation
+  module Ssn
+    DIGITS     = %w[0 1 2 3 4 5 6 7 8 9].freeze
+    DIGITS_EX0 = DIGITS[1..-1]
+
+    # returns a hash of 0..n key/value pairs for ssn validation error codes and a default message for each
+    def self.validate(ssn)
+      ssn    = ssn.to_s
+      errors = {}
+      return errors if test_ssn?(ssn)
+
+      (ssn.length != 9) && errors[:nine_digits]        = "SSN value is not 9 digits"
+      (ssn.chars - DIGITS).any? && errors[:non_digits] = "SSN value contains non-digits"
+      return errors if errors.any?  # return if basic conditions fail
+
+      (ssn[0..2] == "666") && errors[:excluded_666]       = "SSN value contains excluded area 666-xx-xxxx"
+      (ssn.chars - [ssn[0]]).empty? && errors[:repeating] = "SSN value contains repeating digits"
+      (ssn[0..2] == "000") && errors[:zero_area]          = "SSN value contains zeros in area number 000-xx-xxxx"
+      (ssn[3..4] == "00") && errors[:zero_group]          = "SSN value contains zeros in group number xxx-00-xxxx"
+      (ssn[5..8] == "0000") && errors[:zero_serial]       = "SSN value contains zeros in serial number xxx-xx-0000"
+      ascending?(ssn) && errors[:ascending]               = "SSN value contains all ASCENDING digits"
+      descending?(ssn) && errors[:descending]             = "SSN value contains all DESCENDING digits"
+      return errors if errors.any?  # return if ssn conditions fail
+
+      # check valid ITIN format last
+      invalid_itin?(ssn) && errors[:invalid_itin] = "SSN value contains invalid ITIN format 9xx-[x]x-xxxx"
+      errors
+    end
+
+    def self.ascending?(ssn)
+      return true if ssn.chars == DIGITS.rotate(ssn[0].to_i)[0..8]
+      return true if ssn.chars == DIGITS_EX0.rotate(ssn[0].to_i - 1)
+
+      false
+    end
+
+    def self.descending?(ssn)
+      return true if ssn.chars == DIGITS.reverse.rotate(-(ssn[0].to_i + 1))[0..8]
+      return true if ssn.chars == DIGITS_EX0.reverse.rotate(-ssn[0].to_i)
+
+      false
+    end
+
+    def self.invalid_itin?(ssn)
+      ssn[0] == "9" && !%w[7 8].include?(ssn[3])
+    end
+
+    def self.test_ssn?(ssn)
+      SsnValidation.config.test_ssns.any? {|p| p.match(ssn)}
+    end
+  end
+
+  def self.validate(ssn)
+    Ssn.validate(ssn)
+  end
+end

data/lib/ssn_validation/ssn_validation.rb

@@ -0,0 +1,18 @@
+module SsnValidation
+  def self.config
+    @@config ||= Configuration.new
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :test_ssns
+
+    def initialize
+      @test_ssns = []
+    end
+  end
+end

data/lib/validators/social_security_number_validator.rb

@@ -0,0 +1,13 @@
+module ActiveModel
+  module Validations
+    class SocialSecurityNumberValidator < EachValidator
+      def validate_each(record, attribute, value)
+        ssn_errors = Ssn.validate(value)
+        return if ssn_errors.blank?
+        ssn_errors.values.each {|error| record.errors[attribute] << error}
+      end
+    end
+  end
+end
+
+

data/lib/version.rb

@@ -0,0 +1,3 @@
+module SsnValidation
+  VERSION = '0.1.2'
+end

data/ssn_validation.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ssn_validation"
+  spec.version       = SsnValidation::VERSION
+  spec.authors       = ["John Stewart"]
+  spec.summary       = 'Social Security Number (SSN) Validation'
+	spec.license       = 'Apache-2.0'
+  spec.homepage      = 'https://github.com/johnsinco/ssn_validation'
+  spec.summary       = 'Social Security Number (SSN) Validation'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.3'
+  spec.add_development_dependency "rake", '~> 12'
+  spec.add_development_dependency "activemodel", '~> 5'
+end
+

data/test/lib/ssn_validation/ssn_test.rb

@@ -0,0 +1,111 @@
+require 'minitest/autorun'
+require 'ssn_validation/ssn'
+
+class SsnTest < Minitest::Test
+  include SsnValidation
+  describe Ssn do
+    describe 'valid formats' do
+      describe 'valid ITIN' do
+        it 'is valid' do
+          assert_equal({}, Ssn.validate('911781111'))
+        end
+      end
+      describe 'valid SSN' do
+        it 'is valid' do
+          assert_equal({}, Ssn.validate('123432100'))
+        end
+      end
+      describe 'valid repeating SSN' do
+        it 'is valid' do
+          assert_equal({}, Ssn.validate('123444444'))
+        end
+      end
+    end
+    describe 'invalid formats' do
+      describe '666 is invalid' do
+        it 'is valid' do
+          assert_equal({excluded_666: 'SSN value contains excluded area 666-xx-xxxx'}, Ssn.validate('666123210'))
+        end
+      end
+      describe 'zero area numbers invalid' do
+        it 'is invalid' do
+          assert_equal({zero_area: 'SSN value contains zeros in area number 000-xx-xxxx'}, Ssn.validate('000567890'))
+        end
+      end
+      describe 'zero group numbers invalid' do
+        it 'is invalid' do
+          assert_equal({zero_group: 'SSN value contains zeros in group number xxx-00-xxxx'}, Ssn.validate('567007890'))
+        end
+      end
+      describe 'zero serial numbers invalid' do
+        it 'is invalid' do
+          assert_equal({zero_serial: 'SSN value contains zeros in serial number xxx-xx-0000'}, Ssn.validate('567890000'))
+        end
+      end
+      describe 'non digits invalid' do
+        it 'is invalid' do
+          assert_equal({non_digits: 'SSN value contains non-digits'}, Ssn.validate('ABCDEFGHI'))
+        end
+      end
+      describe 'not 9 digits invalid' do
+        it 'is invalid' do
+          assert_equal({nine_digits: 'SSN value is not 9 digits'}, Ssn.validate('303'))
+        end
+      end
+      describe 'ascending digits invalid' do
+        it 'is invalid' do
+          assert_equal({ascending: 'SSN value contains all ASCENDING digits'}, Ssn.validate('123456789'))
+          assert_equal({ascending: 'SSN value contains all ASCENDING digits'}, Ssn.validate('567891234'))
+        end
+      end
+      describe 'ascending digits ex 0 invalid' do
+        it 'is invalid' do
+          assert_equal({ascending: 'SSN value contains all ASCENDING digits'}, Ssn.validate('678912345'))
+          assert_equal({ascending: 'SSN value contains all ASCENDING digits'}, Ssn.validate('123456789'))
+          assert_equal({ascending: 'SSN value contains all ASCENDING digits'}, Ssn.validate('234567891'))
+        end
+      end
+      describe 'descending digits invalid' do
+        it 'is invalid' do
+          assert_equal({descending: 'SSN value contains all DESCENDING digits'}, Ssn.validate('876543210'))
+          assert_equal({descending: 'SSN value contains all DESCENDING digits'}, Ssn.validate('321098765'))
+          assert_equal({descending: 'SSN value contains all DESCENDING digits'}, Ssn.validate('987654321'))
+        end
+      end
+      describe 'descending digits ex 0 invalid' do
+        it 'is invalid' do
+          assert_equal({descending: 'SSN value contains all DESCENDING digits'}, Ssn.validate('321987654'))
+          assert_equal({descending: 'SSN value contains all DESCENDING digits'}, Ssn.validate('765432198'))
+        end
+      end
+      describe 'repeating digits invalid' do
+        it 'is invalid' do
+          assert_equal({repeating: 'SSN value contains repeating digits'}, Ssn.validate('888888888'))
+        end
+      end
+      describe 'invalid ITIN' do
+        it 'is invalid' do
+          assert_equal({invalid_itin: 'SSN value contains invalid ITIN format 9xx-[x]x-xxxx'}, Ssn.validate('900991234'))
+        end
+      end
+    end
+    describe 'allowing dummy ssns' do
+      it 'allows 666xxxxx' do
+        SsnValidation.config.test_ssns = [/^666/]
+        assert_equal({}, Ssn.validate('666123456'))
+        SsnValidation.config.test_ssns = []
+      end
+      it 'allows random test ssns' do
+        SsnValidation.config.test_ssns = ['509421234']
+        assert_equal({}, Ssn.validate('509421234'))
+        SsnValidation.config.test_ssns = []
+      end
+      it 'allows multiple test ssns' do
+        SsnValidation.config.test_ssns = ['999999999', /^666/]
+        assert_equal({}, Ssn.validate('666123456'))
+        assert_equal({}, Ssn.validate('999999999'))
+        SsnValidation.config.test_ssns = []
+      end
+    end
+  end
+end

data/test/lib/ssn_validation_test.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'ssn_validation'
+
+class SsnTest < Minitest::Test
+  describe 'shortcut validator' do
+    it 'validates' do
+      assert_equal({}, SsnValidation.validate('123432100'))
+    end
+  end
+end

data/test/lib/validators/social_security_number_validator_test.rb

@@ -0,0 +1,18 @@
+# require 'minitest/autorun'
+# require 'ssn_validation'
+# require 'activemodel'
+
+# class SsnTestModel
+#   include ActiveModel::Validations
+#   attr_accessor :ssn
+#   validates :ssn, social_security_number: true
+# end
+
+# class SocialSecurityNumberValidatorTest < Minitest::Test
+#   describe 'it uses the ssn validation rules' do
+#     it 'validates' do
+#       subject = SsnTestModel.new(ssn: '666000000')
+#       assert_equal({}, subject.errors)
+#     end
+#   end
+# end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: ssn_validation
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- John Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/ssn_validation.rb
+- lib/ssn_validation/ssn.rb
+- lib/ssn_validation/ssn_validation.rb
+- lib/validators/social_security_number_validator.rb
+- lib/version.rb
+- ssn_validation.gemspec
+- test/lib/ssn_validation/ssn_test.rb
+- test/lib/ssn_validation_test.rb
+- test/lib/validators/social_security_number_validator_test.rb
+homepage: https://github.com/johnsinco/ssn_validation
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Social Security Number (SSN) Validation
+test_files:
+- test/lib/ssn_validation/ssn_test.rb
+- test/lib/ssn_validation_test.rb
+- test/lib/validators/social_security_number_validator_test.rb