kevintyll-ssn_validator 0.1.1 → 0.1.2

data/History.txt

@@ -2,3 +2,9 @@
 
 * 1 major enhancement:
   * Initial release
+
+== 0.1.2 2009-15-14
+
+* 2 minor enhancements:
+  * Added rdoc files
+  * Updated documentation

data/PostInstall.txt

@@ -2,6 +2,7 @@
 For more information on ssn_validator, see http://kevintyll.github.com/ssn_validator/
 
 * To create the necessary db migration, from the command line, run:  script/generate ssn_validator_migration
+* Require the gem in your environment.rb file in the Rails::Initializer block:  config.gem 'ssn_validator'
 * To load your table with the current SSN data, from the command line, run:  rake ssn_validator:update_data
 * The SSN data is updated monthly, so you'll want to run this rake task monthly to keep your validations accurate.
 

data/README.rdoc

@@ -1,32 +1,43 @@
 = ssn_validator
 
-* http://kevintyll.github.com/ssn_validator/
+* http://kevintyll.github.com/ssn_validator
+* http://www.drexel-labs.com
 
 == DESCRIPTION:
 
-A ruby gem that validates whether an SSN has likely been issued or not.
+ssn_validator is a ruby gem that validates whether an SSN has likely been issued or not.
+What exactly does that mean "likely" been issued?  We can't tell for sure if an SSN belongs
+to a particular person, but knowing the "rules"[http://www.socialsecurity.gov/employer/ssnweb.htm]
+on how the social security administration assigns numbers, we can determine whether a number
+has ever been issued or not.
+
+ssn_validator started as a need for the company I work for, Clarity Services Inc.  Incredibly, we
+couldn't find an existing gem or service that provided what we needed.  Since we were going to have
+to role our own solution, we decided to create a gem out of it and share it with the community.  Much
+thanks goes to the management at Clarity Services Inc. for allowing this code to be open sourced.
 
 
 == FEATURES/PROBLEMS:
 
-* Validates the likelyhood that an SSN has been issued to someone.
+* What it can do:
+    Validates the likelyhood that an SSN has been issued to someone.
 
 * What it cannot do:
     Validate that an SSN actually belongs to a particular person.
 
-* What it's planned to do if I can find the data:
-    Determine when an SSN was issued.  This can be used to further validate an SSN by comparing it to a Date of Birth.
-    Check the Death Master File if the SSN belongs to a dead person.
+* What it's planned to do:
+    Determine when an SSN was issued...if i can find the historical data.  This can be used to further validate an SSN by comparing it to a Date of Birth.
+    Check the Death Master File if the SSN belongs to a dead person.  This will require you to purchase the dmf data from https://dmf.ntis.gov 
 
 == SYNOPSIS:
 
-  Just instantiate the object with an SSN.
+* Just instantiate the object with an SSN.
     ssn = SsnValidator::Ssn.new('123-45-6789')
 
-  Then check if it's valid
+* Then check if it's valid
     ssn.valid?
 
-  You can check the errors array to see why it's not valid.
+* You can check the errors array to see why it's not valid.
     ssn.errors
 
 == REQUIREMENTS:
@@ -35,9 +46,14 @@ A ruby gem that validates whether an SSN has likely been issued or not.
 
 == INSTALL:
 
-* sudo gem install kevintyll-ssn_validator
-* To create the necessary db migration, from the command line, run:  script/generate ssn_validator_migration
-* To load your table with the current SSN data, from the command line, run:  rake ssn_validator:update_data
+* To install the gem:
+    sudo gem install kevintyll-ssn_validator
+* To create the necessary db migration, from the command line, run:
+    script/generate ssn_validator_migration
+* Require the gem in your environment.rb file in the Rails::Initializer block:
+    config.gem 'ssn_validator'
+* To load your table with the current SSN data, from the command line, run:
+    rake ssn_validator:update_data
 * The SSN data is updated monthly, so you'll want to run this rake task monthly to keep your validations accurate.
 
 == LICENSE:

data/lib/ssn_validator/models/ssn_high_group_code.rb

@@ -2,33 +2,29 @@ require 'activerecord'
 require 'net/http'
 class SsnHighGroupCode < ActiveRecord::Base
 
-  ###############
-  #class mehtods#
-  ###############
-
-  def self.load_historical_high_group_codes_file
-    ['Jan','Feb','Mar','Apr','May','June','July','Aug','Sept','Oct','Nov','Dec'].each do |month|
-      (1..10).each do |day|
-        string_day = day.to_s
-        string_day.insert(0,'0') if day < 10
-        current_year = Date.today.year
-        #(1932..current_year).each do |year|
-        [2003].each do |year|
-          string_year = year.to_s.last(2)
-          ['','corrected'].each do |mod|
-            ['ssns','ssnvs'].each do |url_mod|
-              file_name = "HG#{month}#{string_day}#{string_year}#{mod}.txt"
-              text = Net::HTTP.get(URI.parse("http://www.socialsecurity.gov/employer/#{url_mod}/#{file_name}"))
-              puts file_name.inspect
-              puts '@@@@@@@@@ found file_name = ' + file_name.inspect unless text.include? 'File Not Found'
-            end
-          end
-          
-        end
-      end
-      
-    end
-  end
+#  def self.load_historical_high_group_codes_file
+#    ['Jan','Feb','Mar','Apr','May','June','July','Aug','Sept','Oct','Nov','Dec'].each do |month|
+#      (1..10).each do |day|
+#        string_day = day.to_s
+#        string_day.insert(0,'0') if day < 10
+#        current_year = Date.today.year
+#        #(1932..current_year).each do |year|
+#        [2003].each do |year|
+#          string_year = year.to_s.last(2)
+#          ['','corrected'].each do |mod|
+#            ['ssns','ssnvs'].each do |url_mod|
+#              file_name = "HG#{month}#{string_day}#{string_year}#{mod}.txt"
+#              text = Net::HTTP.get(URI.parse("http://www.socialsecurity.gov/employer/#{url_mod}/#{file_name}"))
+#              puts file_name.inspect
+#              puts '@@@@@@@@@ found file_name = ' + file_name.inspect unless text.include? 'File Not Found'
+#            end
+#          end
+#
+#        end
+#      end
+#
+#    end
+#  end
 
   #Loads the most recent file from http://www.socialsecurity.gov/employer/ssns/highgroup.txt
   def self.load_current_high_group_codes_file
@@ -36,23 +32,12 @@ class SsnHighGroupCode < ActiveRecord::Base
     create_records(parse_text(text),extract_as_of_date(text))
   end
 
+
+  private
+
   def self.already_loaded?(file_as_of_date)
     self.find_by_as_of(file_as_of_date)
   end
-  ###################
-  #end class mehtods#
-  ###################
-
-  ##################
-  #instance mehtods#
-  ##################
-
-  
-
-  ######################
-  #end instance mehtods#
-  ######################
-  private
 
   def self.create_records(area_groups,file_as_of)
     if already_loaded?(file_as_of)

data/lib/ssn_validator/models/ssn_validator.rb

@@ -5,6 +5,8 @@ module SsnValidator
     attr_reader :errors
 
 
+    #Instantiate the object passing in a social security number.
+    #The ssn can be a string or integer, with or without the '-'s.
     def initialize(ssn)
       @errors = []
       ssn = ssn.to_s
@@ -52,6 +54,8 @@ module SsnValidator
 
     end
 
+    #Determines whether or not the passed in
+    #ssn passed all validations.
     def valid?
       @errors.empty?
     end

data/lib/ssn_validator.rb

@@ -9,5 +9,5 @@ require 'rake'
 import "#{File.dirname(__FILE__)}/tasks/ssn_validator.rake"
 
 module SsnValidator
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevintyll-ssn_validator
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Kevin Tyll