ssn_validation 0.1.2 → 0.1.7

checksums.yaml

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

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    ssn_validation (0.1.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (5.2.6)
+      activesupport (= 5.2.6)
+    activesupport (5.2.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.9)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (12.3.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  activemodel (~> 5)
+  minitest
+  rake (~> 12)
+  ssn_validation!
+
+BUNDLED WITH
+   2.2.22

data/README.md

@@ -0,0 +1,43 @@
+# SsnValidation
+
+SsnValidation is a very basic ruby gem that can validate a US Social Security Number (SSN) or ITIN.  It returns a hash of error keys/messages that can be 
+used within ActiveRecord errors or otherwise to ensure syntactically valid SSNs.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ssn_validation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ssn_validation
+
+## Usage
+
+```
+❯ irb
+> require 'ssn_validation'
+> SsnValidation::Ssn.validate('abc')
+=> {:nine_digits=>"SSN value is not 9 digits", :non_digits=>"SSN value contains non-digits"}
+> SsnValidation::Ssn.validate(123006789)
+=> {:zero_group=>"SSN value contains zeros in group number xxx-00-xxxx"}
+> SsnValidation::Ssn.validate(nil)
+=> {:nine_digits=>"SSN value is not 9 digits"}
+> SsnValidation::Ssn.validate('')
+=> {:nine_digits=>"SSN value is not 9 digits"}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/johnsinco/ssn_validation
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,7 +1,9 @@
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
   t.warning = true
 end

data/lib/ssn_validation/ssn.rb

@@ -2,10 +2,11 @@ module SsnValidation
   module Ssn
     DIGITS     = %w[0 1 2 3 4 5 6 7 8 9].freeze
     DIGITS_EX0 = DIGITS[1..-1]
+    VALID_ITIN_GROUPS = [50..65, 70..88, 90..92, 94..99].map(&:to_a).flatten.freeze
 
     # 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
+      ssn    = ssn.to_s.delete('-') # be lenient with incoming dash chars
       errors = {}
       return errors if test_ssn?(ssn)
 
@@ -18,15 +19,23 @@ module SsnValidation
       (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"
+
+      # check extra validations for possible fake ssns if enabled
+      errors.merge!(validate_ascending_descending(ssn)) if enable_ascending?
       errors
     end
 
+    def self.validate_ascending_descending(ssn)
+      errors = {}
+      ascending?(ssn) && errors[:ascending]               = "SSN value contains all ASCENDING digits"
+      descending?(ssn) && errors[:descending]             = "SSN value contains all DESCENDING digits"
+      return 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)
@@ -41,13 +50,20 @@ module SsnValidation
       false
     end
 
+    # https://www.irs.gov/irm/part3/irm_03-021-263r
     def self.invalid_itin?(ssn)
-      ssn[0] == "9" && !%w[7 8].include?(ssn[3])
+      return false unless ssn[0] == "9" 
+      group = ssn[3..4].to_i
+      !VALID_ITIN_GROUPS.include?(group)
     end
 
     def self.test_ssn?(ssn)
       SsnValidation.config.test_ssns.any? {|p| p.match(ssn)}
     end
+
+    def self.enable_ascending?
+      SsnValidation.config.enable_ascending
+    end
   end
 
   def self.validate(ssn)

data/lib/ssn_validation/ssn_validation.rb

@@ -10,9 +10,11 @@ module SsnValidation
 
   class Configuration
     attr_accessor :test_ssns
+    attr_accessor :enable_ascending
 
     def initialize
       @test_ssns = []
+      @enable_ascending = false
     end
   end
 end

data/lib/ssn_validation.rb

@@ -1,2 +1,9 @@
 require 'ssn_validation/ssn_validation'
 require 'ssn_validation/ssn'
+
+# optional ActiveModel dependency for custom validator
+begin
+  require 'validators/social_security_number_validator'
+rescue 
+  nil
+end

data/lib/validators/social_security_number_validator.rb

@@ -1,10 +1,13 @@
+require 'active_model'
+require 'ssn_validation/ssn'
+
 module ActiveModel
   module Validations
     class SocialSecurityNumberValidator < EachValidator
       def validate_each(record, attribute, value)
-        ssn_errors = Ssn.validate(value)
+        ssn_errors = SsnValidation::Ssn.validate(value)
         return if ssn_errors.blank?
-        ssn_errors.values.each {|error| record.errors[attribute] << error}
+        ssn_errors.values.each { |error| record.errors.add(attribute, error) }
       end
     end
   end

data/lib/version.rb

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

data/ssn_validation.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3'
   spec.add_development_dependency "rake", '~> 12'
   spec.add_development_dependency "activemodel", '~> 5'
+  spec.add_development_dependency "minitest" 
 end
 

data/test/lib/ssn_validation/ssn_test.rb

@@ -1,5 +1,5 @@
 require 'minitest/autorun'
-require 'ssn_validation/ssn'
+require 'ssn_validation'
 
 class SsnTest < Minitest::Test
   include SsnValidation
@@ -7,103 +7,120 @@ class SsnTest < Minitest::Test
     describe 'valid formats' do
       describe 'valid ITIN' do
         it 'is valid' do
-          assert_equal({}, Ssn.validate('911781111'))
+          _(Ssn.validate('911781111')).must_equal({})
+          _(Ssn.validate('911501111')).must_equal({})
+          _(Ssn.validate('911651111')).must_equal({})
+          _(Ssn.validate('911651111')).must_equal({})
+          _(Ssn.validate('911881111')).must_equal({})
+          _(Ssn.validate('911901111')).must_equal({})
+          _(Ssn.validate('911991111')).must_equal({})
         end
       end
       describe 'valid SSN' do
         it 'is valid' do
-          assert_equal({}, Ssn.validate('123432100'))
+          _(Ssn.validate('123432100')).must_equal({})
         end
       end
       describe 'valid repeating SSN' do
         it 'is valid' do
-          assert_equal({}, Ssn.validate('123444444'))
+          _(Ssn.validate('123444444')).must_equal({})
+        end
+      end
+      describe 'valid with dashes' do
+        it 'ignores the dashes' do
+          _(Ssn.validate('123-44-4444')).must_equal({})
         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'))
+          _(Ssn.validate('666123210')).must_equal({excluded_666: 'SSN value contains excluded area 666-xx-xxxx'})
         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'))
+          _(Ssn.validate('000567890')).must_equal({zero_area: 'SSN value contains zeros in area number 000-xx-xxxx'})
         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'))
+          _(Ssn.validate('567007890')).must_equal({zero_group: 'SSN value contains zeros in group number xxx-00-xxxx'})
         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'))
+          _(Ssn.validate('567890000')).must_equal({zero_serial: 'SSN value contains zeros in serial number xxx-xx-0000'})
         end
       end
       describe 'non digits invalid' do
         it 'is invalid' do
-          assert_equal({non_digits: 'SSN value contains non-digits'}, Ssn.validate('ABCDEFGHI'))
+          _(Ssn.validate('ABCDEFGHI')).must_equal({non_digits: 'SSN value contains non-digits'})
         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'))
+          _(Ssn.validate('303')).must_equal({nine_digits: 'SSN value is not 9 digits'})
         end
       end
-      describe 'ascending digits invalid' do
+      describe 'repeating 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'))
+          _(Ssn.validate('888888888')).must_equal({repeating: 'SSN value contains repeating digits'})
         end
       end
-      describe 'ascending digits ex 0 invalid' do
+      describe 'invalid ITIN' 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'))
+          _(Ssn.validate('900121234')).must_equal({invalid_itin: 'SSN value contains invalid ITIN format 9xx-[x]x-xxxx'})
+          _(Ssn.validate('900441234')).must_equal({invalid_itin: 'SSN value contains invalid ITIN format 9xx-[x]x-xxxx'})
         end
       end
-      describe 'descending digits invalid' do
+    end
+    describe 'do extra validations based on probably bogus SSNSs' do
+      before do
+        SsnValidation.config.enable_ascending = true
+      end
+      describe 'ascending 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'))
+          _(Ssn.validate('123456789')).must_equal({ascending: 'SSN value contains all ASCENDING digits'})
+          _(Ssn.validate('567891234')).must_equal({ascending: 'SSN value contains all ASCENDING digits'})
         end
       end
-      describe 'descending digits ex 0 invalid' do
+      describe 'ascending 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'))
+          _(Ssn.validate('678912345')).must_equal({ascending: 'SSN value contains all ASCENDING digits'})
+          _(Ssn.validate('123456789')).must_equal({ascending: 'SSN value contains all ASCENDING digits'})
+          _(Ssn.validate('234567891')).must_equal({ascending: 'SSN value contains all ASCENDING digits'})
         end
       end
-      describe 'repeating digits invalid' do
+      describe 'descending digits invalid' do
         it 'is invalid' do
-          assert_equal({repeating: 'SSN value contains repeating digits'}, Ssn.validate('888888888'))
+          _(Ssn.validate('876543210')).must_equal({descending: 'SSN value contains all DESCENDING digits'})
+          _(Ssn.validate('321098765')).must_equal({descending: 'SSN value contains all DESCENDING digits'})
+          _(Ssn.validate('765432109')).must_equal({descending: 'SSN value contains all DESCENDING digits'})
         end
       end
-      describe 'invalid ITIN' do
+      describe 'descending digits ex 0 invalid' do
         it 'is invalid' do
-          assert_equal({invalid_itin: 'SSN value contains invalid ITIN format 9xx-[x]x-xxxx'}, Ssn.validate('900991234'))
+          _(Ssn.validate('321987654')).must_equal({descending: 'SSN value contains all DESCENDING digits'})
+          _(Ssn.validate('765432198')).must_equal({descending: 'SSN value contains all DESCENDING digits'})
         end
       end
     end
     describe 'allowing dummy ssns' do
       it 'allows 666xxxxx' do
         SsnValidation.config.test_ssns = [/^666/]
-        assert_equal({}, Ssn.validate('666123456'))
+        _(Ssn.validate('666123456')).must_equal({})
         SsnValidation.config.test_ssns = []
       end
       it 'allows random test ssns' do
         SsnValidation.config.test_ssns = ['509421234']
-        assert_equal({}, Ssn.validate('509421234'))
+        _(Ssn.validate('509421234')).must_equal({})
         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'))
+        _(Ssn.validate('666123456')).must_equal({})
+        _(Ssn.validate('999999999')).must_equal({})
         SsnValidation.config.test_ssns = []
       end
     end

data/test/lib/validators/social_security_number_validator_test.rb

@@ -1,18 +1,30 @@
-# require 'minitest/autorun'
-# require 'ssn_validation'
-# require 'activemodel'
+require 'minitest/autorun'
+require 'active_model'
+require 'ssn_validation'
+require 'validators/social_security_number_validator'
 
-# class SsnTestModel
-#   include ActiveModel::Validations
-#   attr_accessor :ssn
-#   validates :ssn, social_security_number: true
-# end
+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
+class SocialSecurityNumberValidatorTest < Minitest::Test
+  describe 'it uses the ssn validation rules' do
+    it 'validates' do
+      subject = SsnTestModel.new
+      subject.ssn = '123454321'
+      assert subject.valid?
+      assert_equal({}, subject.errors.to_h)
+    end
+
+    it 'can use the ascending validation rules' do
+      SsnValidation.config.enable_ascending = true
+      subject = SsnTestModel.new
+      subject.ssn = '123456789'
+      subject.valid?
+      assert_equal({ssn: 'SSN value contains all ASCENDING digits'}, subject.errors.to_h)
+      SsnValidation.config.enable_ascending = false 
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssn_validation
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - John Stewart
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-26 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,12 +38,30 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-description: 
-email: 
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
 - Rakefile
 - lib/ssn_validation.rb
 - lib/ssn_validation/ssn.rb
@@ -58,7 +76,7 @@ homepage: https://github.com/johnsinco/ssn_validation
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,9 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Social Security Number (SSN) Validation
 test_files: