kevintyll-ofac 1.0.0 → 1.1.0

data/History.txt

@@ -6,4 +6,9 @@
 == 1.0.0 2009-05-11
 
 * 1 major enhancement:
-  * Initail release
+  * Initail release
+
+== 1.1.0 2009-05-12
+
+* 1 minor enhancement:
+  * Modified the match alogorithm to reduct the score if there is not an address or city match if the data is in the database.

data/README.rdoc

@@ -52,14 +52,28 @@ and Tyll will find a match, and there were 2 elements in the searched name, the
 for <tt>:name</tt>.  So since the weight for <tt>:name</tt> is 60, then we will add 60 to the score.
 
 If you are trying to match the name Kevin Tyll, and there is a record for Teel, Kevin in the database, then an exact match
-will be found for Kevin, and a sounds like match will be made for Tyll.  Since there were 2 elements in hte searched name,
+will be found for Kevin, and a sounds like match will be made for Tyll.  Since there were 2 elements in the searched name,
 and the weight for <tt>:name</tt> is 60, then each element is worth 30.  Since Kevin was an exact match, it will add 30, and
 since Tyll was a sounds like match, it will add 30 * .75.  So the <tt>:name</tt> portion of the search will be worth 53.
 
+If data is in the database for city and or address, and you pass data in for these elements, the score will be reduced by 10%
+of the weight if there is no match or sounds like match.  So if you get a match on name, you've already got a score of 60.  So
+if you don't pass in an address or city, or if you do, but there is no city or address info in the database, then your final score
+will be 60.  But if you do pass in a city, say Tampa, and the city in the Database is New York, then we will deduct 10% of the
+weight (30 * .1) = 3 from the score since 30 is the weight for <tt>:city</tt>.  So the final score will be 57.
+
+If were searching for New York, and the database had New Deli, then there would be a match on New, but not on Deli.
+Since there were 2 elements in the searched city, each hit is worth 15.  So the match on New would add 15, but the non-match
+on York would subtract (15 * .1) = 1.5 from the score.  So the score would be (60 + 15 - 1.5) = 74, due to rounding.
+
+Only <tt>:city</tt> and <tt>:address</tt> subtract from the score, No match on name simply returns 0.
+
 Matches for name are made for both the name and any aliases in the OFAC database.
 
 Matches for <tt>:city</tt> and <tt>:address</tt> will only be added to the score if there is first a match on <tt>:name</tt>.
 
+We consider a score of 60 to be reasonable as a hit.
+
 == SYNOPSIS:
 Accepts a hash with the identity's demographic information
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 0
+:minor: 1
 :patch: 0
 :major: 1

data/lib/ofac/models/ofac.rb

@@ -55,13 +55,27 @@ class Ofac
   # for <tt>:name</tt>.  So since the weight for <tt>:name</tt> is 60, then we will add 60 to the score.
   #
   # If you are trying to match the name Kevin Tyll, and there is a record for Teel, Kevin in the database, then an exact match
-  # will be found for Kevin, and a sounds like match will be made for Tyll.  Since there were 2 elements in hte searched name,
+  # will be found for Kevin, and a sounds like match will be made for Tyll.  Since there were 2 elements in the searched name,
   # and the weight for <tt>:name</tt> is 60, then each element is worth 30.  Since Kevin was an exact match, it will add 30, and
   # since Tyll was a sounds like match, it will add 30 * .75.  So the <tt>:name</tt> portion of the search will be worth 53.
   #
+  # If data is in the database for city and or address, and you pass data in for these elements, the score will be reduced by 10%
+  # of the weight if there is no match or sounds like match.  So if you get a match on name, you've already got a score of 60.  So
+  # if you don't pass in an address or city, or if you do, but there is no city or address info in the database, then your final score
+  # will be 60.  But if you do pass in a city, say Tampa, and the city in the Database is New York, then we will deduct 10% of the
+  # weight (30 * .1) = 3 from the score since 30 is the weight for <tt>:city</tt>.  So the final score will be 57.
+  #
+  # If were searching for New York, and the database had New Deli, then there would be a match on New, but not on Deli.
+  # Since there were 2 elements in the searched city, each hit is worth 15.  So the match on New would add 15, but the non-match
+  # on York would subtract (15 * .1) = 1.5 from the score.  So the score would be (60 + 15 - 1.5) = 74, due to rounding.
+  #
+  # Only <tt>:city</tt> and <tt>:address</tt> subtract from the score, No match on name simply returns 0.
+  #
   # Matches for name are made for both the name and any aliases in the OFAC database.
   #
   # Matches for <tt>:city</tt> and <tt>:address</tt> will only be added to the score if there is first a match on <tt>:name</tt>.
+  #
+  # We consider a score of 60 to be reasonable as a hit.
   def score
     @score || calculate_score
   end

data/lib/ofac/ofac_match.rb

@@ -100,9 +100,10 @@ class OfacMatch
 
                 value = 0
                 partial_weight = 1/token_array.length.to_f
+                
                 token_array.each do |partial_token|
                   #first see if we get an exact match of the partial
-                  if match_array.include?(partial_token)
+                  if success = match_array.include?(partial_token)
                     value += partial_weight
                   else
                     #otherwise, see if the partial sounds like any part of the OFAC record
@@ -110,10 +111,18 @@ class OfacMatch
                       if partial_match.ofac_sounds_like(partial_token,false)
                         #give partial value for every part of token that is matched.
                         value += partial_weight * 0.75
+                        success = true
                         break
                       end
                     end
                   end
+                  unless success
+                    #if this for :address or :city
+                    #and there is no match at all, subtract 10% of the weight from :name score
+                    unless field == :name
+                      value -= partial_weight * 0.1
+                    end
+                  end
                 end
               end
             end

data/test/ofac_test.rb

@@ -7,7 +7,7 @@ class OfacTest < Test::Unit::TestCase
       setup_ofac_sdn_table
       OfacSdnLoader.load_current_sdn_file #this method is mocked to load test files instead of the live files from the web.
     end
-    
+
     should "give a score of 0 if no name is given" do
       assert_equal 0, Ofac.new({:address => '123 somewhere'}).score
     end
@@ -20,11 +20,27 @@ class OfacTest < Test::Unit::TestCase
       assert_equal 0, Ofac.new({:name => 'Kevin', :address => '123 somewhere ln', :city => 'Clearwater'}).score
     end
 
-    should "give a score of 60 if there is a name match" do
+    should "give a score of 60 if there is a name match and deduct scores for non matches on address and city" do
       assert_equal 60, Ofac.new({:name => 'Oscar Hernandez'}).score
-      assert_equal 60, Ofac.new({:name => 'Oscar Hernandez', :city => 'no match', :address => 'no match'}).score
-      assert_equal 60, Ofac.new({:name => 'Oscar Hernandez', :city => 'Las Vegas', :address => 'no match'}).score
-      assert_equal 60, Ofac.new({:name => 'Luis Lopez', :city => 'Las Vegas', :address => 'no match'}).score
+    end
+
+    should "deduct scores for non matches on address and city if data is in the database" do
+      #if there is data for address or city in the database, and that info is passed in, then 10%
+      #of the weight will be deducted if there is not match or sounds like match
+
+      #only name matches
+      assert_equal 56, Ofac.new({:name => 'Oscar Hernandez', :city => 'no match', :address => 'no match'}).score
+      #only name matches
+      assert_equal 56, Ofac.new({:name => 'Oscar Hernandez', :city => 'Las Vegas', :address => 'no match'}).score
+      #name and city match
+      assert_equal 89, Ofac.new({:name => 'Oscar Hernandez', :city => 'Clearwater', :address => 'no match'}).score
+      #city is a partial match - Clearwater matches, but not Bay
+      #score = 60 for name + 15 for Clearwater - (15 * .1) for Bay = 73.5
+      assert_equal 74, Ofac.new({:name => 'Oscar Hernandez', :city => 'Clearwater Bay'}).score
+    end
+
+    should "not deduct from score if no data for city or address is in the database" do
+      assert_equal 60, Ofac.new({:name => 'Luis Lopez', :city => 'no match', :address => 'no match'}).score
     end
 
     should "give a score of 60 if there is a name match on alternate identity name" do
@@ -38,7 +54,7 @@ class OfacTest < Test::Unit::TestCase
     end
 
     should "give a score of 90 if there is a name and city match" do
-      assert_equal 90, Ofac.new({:name => 'Oscar Hernandez', :city => 'Clearwater', :address => 'no match'}).score
+      assert_equal 90, Ofac.new({:name => 'Oscar Hernandez', :city => 'Clearwater'}).score
     end
 
     should "give a score of 100 if there is a name and city and address match" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevintyll-ofac
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Kevin Tyll
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-11 00:00:00 -07:00
+date: 2009-05-12 00:00:00 -07:00
 default_executable: 
 dependencies: []