RubyGems - ofac - Versions diffs - 2.0.1 → 2.0.2 - Mend

ofac 2.0.1 → 2.0.2

Files changed (87) hide show

checksums.yaml +4 -4
data/Rakefile +24 -49
data/lib/ofac/version.rb +1 -0
data/test/test_helper.rb +5 -1
metadata +118 -94
data/.document +0 -5
data/.ruby-gemset +0 -1
data/.ruby-version +0 -1
data/History.txt +0 -134
data/PostInstall.txt +0 -11
data/VERSION.yml +0 -5
data/generators/ofac_migration/.DS_Store +0 -0
data/generators/ofac_migration/ofac_migration_generator.rb +0 -12
data/generators/ofac_migration/templates/.DS_Store +0 -0
data/generators/ofac_migration/templates/migration.rb +0 -31
data/nbproject/project.properties +0 -7
data/nbproject/project.xml +0 -15
data/ofac.gemspec +0 -129
data/rdoc/CreateOfacSdns.html +0 -249
data/rdoc/Ofac.html +0 -434
data/rdoc/OfacMatch.html +0 -299
data/rdoc/OfacMigration.html +0 -138
data/rdoc/OfacMigration/Generators.html +0 -138
data/rdoc/OfacMigration/Generators/BuildGenerator.html +0 -251
data/rdoc/OfacSdn.html +0 -209
data/rdoc/OfacSdnLoader.html +0 -238
data/rdoc/README_rdoc.html +0 -323
data/rdoc/String.html +0 -262
data/rdoc/classes/Ofac.html +0 -411
data/rdoc/classes/OfacMatch.html +0 -239
data/rdoc/classes/OfacSdn.html +0 -111
data/rdoc/classes/OfacSdnLoader.html +0 -190
data/rdoc/classes/String.html +0 -207
data/rdoc/created.rid +0 -10
data/rdoc/files/README_rdoc.html +0 -317
data/rdoc/files/lib/ofac/models/ofac_rb.html +0 -101
data/rdoc/files/lib/ofac/models/ofac_sdn_loader_rb.html +0 -110
data/rdoc/files/lib/ofac/models/ofac_sdn_rb.html +0 -108
data/rdoc/files/lib/ofac/ofac_match_rb.html +0 -101
data/rdoc/files/lib/ofac/ruby_string_extensions_rb.html +0 -101
data/rdoc/files/lib/ofac_rb.html +0 -113
data/rdoc/fr_class_index.html +0 -31
data/rdoc/fr_file_index.html +0 -33
data/rdoc/fr_method_index.html +0 -35
data/rdoc/images/add.png +0 -0
data/rdoc/images/arrow_up.png +0 -0
data/rdoc/images/brick.png +0 -0
data/rdoc/images/brick_link.png +0 -0
data/rdoc/images/bug.png +0 -0
data/rdoc/images/bullet_black.png +0 -0
data/rdoc/images/bullet_toggle_minus.png +0 -0
data/rdoc/images/bullet_toggle_plus.png +0 -0
data/rdoc/images/date.png +0 -0
data/rdoc/images/delete.png +0 -0
data/rdoc/images/find.png +0 -0
data/rdoc/images/loadingAnimation.gif +0 -0
data/rdoc/images/macFFBgHack.png +0 -0
data/rdoc/images/package.png +0 -0
data/rdoc/images/page_green.png +0 -0
data/rdoc/images/page_white_text.png +0 -0
data/rdoc/images/page_white_width.png +0 -0
data/rdoc/images/plugin.png +0 -0
data/rdoc/images/ruby.png +0 -0
data/rdoc/images/tag_blue.png +0 -0
data/rdoc/images/tag_green.png +0 -0
data/rdoc/images/transparent.png +0 -0
data/rdoc/images/wrench.png +0 -0
data/rdoc/images/wrench_orange.png +0 -0
data/rdoc/images/zoom.png +0 -0
data/rdoc/index.html +0 -96
data/rdoc/js/darkfish.js +0 -155
data/rdoc/js/jquery.js +0 -18
data/rdoc/js/navigation.js +0 -142
data/rdoc/js/search.js +0 -94
data/rdoc/js/search_index.js +0 -1
data/rdoc/js/searcher.js +0 -228
data/rdoc/lib/generators/ofac_migration/build/build_generator_rb.html +0 -97
data/rdoc/lib/generators/ofac_migration/build/templates/create_ofac_sdns_rb.html +0 -97
data/rdoc/lib/ofac/models/ofac_rb.html +0 -97
data/rdoc/lib/ofac/models/ofac_sdn_loader_rb.html +0 -97
data/rdoc/lib/ofac/models/ofac_sdn_rb.html +0 -97
data/rdoc/lib/ofac/ofac_match_rb.html +0 -97
data/rdoc/lib/ofac/ruby_string_extensions_rb.html +0 -97
data/rdoc/lib/ofac_rb.html +0 -97
data/rdoc/rdoc-style.css +0 -208
data/rdoc/rdoc.css +0 -595
data/rdoc/table_of_contents.html +0 -120

@@ -1,207 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Class: String</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
-          <td class="class-name-in-header">String</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/lib/ofac/ruby_string_extensions_rb.html">
-                lib/ofac/ruby_string_extensions.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Object
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-   </div>
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-      <div class="name-list">
-      <a href="#M000003">ofac_soundex</a>&nbsp;&nbsp;
-      <a href="#M000004">ofac_sounds_like</a>&nbsp;&nbsp;
-      </div>
-    </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <div id="constants-list">
-      <h3 class="section-bar">Constants</h3>
-      <div class="name-list">
-        <table summary="Constants">
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">Ofac_SoundexChars</td>
-          <td>=</td>
-          <td class="context-item-value">'BPFVCSKGJQXZDTLMNR'</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">Ofac_SoundexNums</td>
-          <td>=</td>
-          <td class="context-item-value">'111122222222334556'</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">Ofac_SoundexCharsEx</td>
-          <td>=</td>
-          <td class="context-item-value">'^' + Ofac_SoundexChars</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">Ofac_SoundexCharsDel</td>
-          <td>=</td>
-          <td class="context-item-value">'^A-Z'</td>
-        </tr>
-        </table>
-      </div>
-    </div>
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000003" class="method-detail">
-        <a name="M000003"></a>
-        <div class="method-heading">
-          <a href="#M000003" class="method-signature">
-          <span class="method-name">ofac_soundex</span><span class="method-args">(census = true)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-desc: <a
-href="http://en.wikipedia.org/wiki/Soundex">en.wikipedia.org/wiki/Soundex</a>
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000003-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/ofac/ruby_string_extensions.rb, line 9</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ofac_soundex</span>(<span class="ruby-identifier">census</span> = <span class="ruby-keyword kw">true</span>)
-    <span class="ruby-identifier">str</span> = <span class="ruby-identifier">upcase</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-constant">Ofac_SoundexCharsDel</span>).<span class="ruby-identifier">squeeze</span>
-    <span class="ruby-identifier">str</span>[<span class="ruby-value">0</span> <span class="ruby-operator">..</span> <span class="ruby-value">0</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">str</span>[<span class="ruby-value">1</span> <span class="ruby-operator">..</span> <span class="ruby-value">-1</span>].
-      <span class="ruby-identifier">delete</span>(<span class="ruby-constant">Ofac_SoundexCharsEx</span>).
-      <span class="ruby-identifier">tr</span>(<span class="ruby-constant">Ofac_SoundexChars</span>, <span class="ruby-constant">Ofac_SoundexNums</span>)[<span class="ruby-value">0</span> <span class="ruby-operator">..</span> (<span class="ruby-identifier">census</span> <span class="ruby-value">? </span><span class="ruby-value">2</span> <span class="ruby-operator">:</span> <span class="ruby-value">-1</span>)].
-      <span class="ruby-identifier">ljust</span>(<span class="ruby-value">3</span>, <span class="ruby-value str">'0'</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-value str">''</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
-        <div class="method-heading">
-          <a href="#M000004" class="method-signature">
-          <span class="method-name">ofac_sounds_like</span><span class="method-args">(other, census = true)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000004-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/ofac/ruby_string_extensions.rb, line 18</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ofac_sounds_like</span>(<span class="ruby-identifier">other</span>, <span class="ruby-identifier">census</span> = <span class="ruby-keyword kw">true</span>)
-    <span class="ruby-identifier">ofac_soundex</span>(<span class="ruby-identifier">census</span>) <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">ofac_soundex</span>(<span class="ruby-identifier">census</span>)
-  <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-</body>
-</html>

data/rdoc/created.rid DELETED

@@ -1,10 +0,0 @@
-Tue, 07 Jan 2014 10:20:16 -0500
-README.rdoc	Tue, 07 Jan 2014 09:55:46 -0500
-lib/generators/ofac_migration/build/build_generator.rb	Fri, 16 Mar 2012 15:37:08 -0400
-lib/generators/ofac_migration/build/templates/create_ofac_sdns.rb	Fri, 16 Mar 2012 15:37:08 -0400
-lib/ofac.rb	Thu, 02 Sep 2010 14:42:06 -0400
-lib/ofac/models/ofac.rb	Tue, 07 Jan 2014 09:45:35 -0500
-lib/ofac/models/ofac_sdn.rb	Tue, 07 Jan 2014 10:18:10 -0500
-lib/ofac/models/ofac_sdn_loader.rb	Wed, 05 Jun 2013 09:04:58 -0400
-lib/ofac/ofac_match.rb	Wed, 29 Jul 2009 13:27:13 -0400
-lib/ofac/ruby_string_extensions.rb	Mon, 11 May 2009 12:39:33 -0400

data/rdoc/files/README_rdoc.html DELETED

@@ -1,317 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>File: README.rdoc</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-  <div id="fileHeader">
-    <h1>README.rdoc</h1>
-    <table class="header-table">
-    <tr class="top-aligned-row">
-      <td><strong>Path:</strong></td>
-      <td>README.rdoc
-      </td>
-    </tr>
-    <tr class="top-aligned-row">
-      <td><strong>Last Update:</strong></td>
-      <td>Tue May 12 11:20:38 -0400 2009</td>
-    </tr>
-    </table>
-  </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-    <div id="description">
-      <h1>ofac</h1>
-<ul>
-<li><a href="http://kevintyll.github.com/ofac">kevintyll.github.com/ofac</a>
-</li>
-<li><a href="http://www.drexel-labs.com">www.drexel-labs.com</a>
-</li>
-<li><a
-href="http://www.treas.gov/offices/enforcement/ofac/sdn/index.shtml">www.treas.gov/offices/enforcement/ofac/sdn/index.shtml</a>
-</li>
-</ul>
-<h2>DESCRIPTION:</h2>
-<p>
-ofac is a ruby gem that tries to find a match of a person&#8216;s name and
-address against the Office of Foreign Assets Control&#8216;s Specially
-Designated Nationals list...the so called terrorist watch list.
-</p>
-<p>
-This gem, like the ssn_validator gem, started as a need for the company I
-work for, Clarity Services Inc. We decided once again 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. Thanks
-also to Larry Berland at Clarity Services Inc. The matching logic in the
-ofac_match.rb file was derived from his work.
-</p>
-<h2>FEATURES:</h2>
-<p>
-Creates a score, 1 - 100, based on how well the name, address and city
-match the data on the SDN list. Since we have to match on strings, the
-likely hood of an exact match are virtually nil. So we&#8216;ve created an
-algorithm that creates a score. The better the match, the higher the score.
-A score of 100 would be a perfect match.
-</p>
-<p>
-The score is calculated by adding up the weightings of each part that is
-matched. So if only name is matched, then the max score is the weight for
-<tt>:name</tt> which is 60
-</p>
-<p>
-It&#8216;s possible to get partial matches, which will add partial weight
-to the score. If there is not a match on the element as it is passed in,
-then each word element gets broken down and matches are tried on each
-partial element. The weighting is distrubuted equally for each partial that
-is matched.
-</p>
-<p>
-If exact matches are not made, then a sounds like match is attempted. Any
-match made by sounds like is given 75% of it&#8216;s weight to the score.
-Example:
-</p>
-<p>
-If you are trying to match the name Kevin Tyll and there is a record for
-Smith, Kevin in the database, then we will try to match both Kevin and Tyll
-separately, with each element Smith and Kevin. Since only Kevin will find a
-match, and there were 2 elements in the searched name, the score will be
-added by half the weighting for <tt>:name</tt>. So since the weight for
-<tt>:name</tt> is 60, then we will add 30 to the score.
-</p>
-<p>
-If you are trying to match the name Kevin Gregory Tyll and there is a
-record for Tyll, Kevin in the database, then we will try to match Kevin and
-Gregory and Tyll separately, with each element Tyll and Kevin. Since both
-Kevin and Tyll will find a match, and there were 3 elements in the searched
-name, the score will be added by 2/3 the weighting for <tt>:name</tt>. So
-since the weight for <tt>:name</tt> is 60, then we will add 40 to the
-score.
-</p>
-<p>
-If you are trying to match the name Kevin Tyll and there is a record for
-Kevin Gregory Tyll in the database, then we will try to match Kevin and
-Tyll separately, with each element Tyll and Kevin and Gregory. Since both
-Kevin and Tyll will find a match, and there were 2 elements in the searched
-name, the score will be added by 2/2 the weighting for <tt>:name</tt>. So
-since the weight for <tt>:name</tt> is 60, then we will add 60 to the
-score.
-</p>
-<p>
-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 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.
-</p>
-<p>
-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&#8216;ve already got a score of 60. So if you don&#8216;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.
-</p>
-<p>
-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.
-</p>
-<p>
-Only <tt>:city</tt> and <tt>:address</tt> subtract from the score, No match
-on name simply returns 0.
-</p>
-<p>
-Matches for name are made for both the name and any aliases in the OFAC
-database.
-</p>
-<p>
-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>.
-</p>
-<p>
-We consider a score of 60 to be reasonable as a hit.
-</p>
-<h2>SYNOPSIS:</h2>
-<p>
-Accepts a hash with the identity&#8216;s demographic information
-</p>
-<pre>
-   Ofac.new({:name =&gt; 'Oscar Hernandez', :city =&gt; 'Clearwater', :address =&gt; '123 somewhere ln'})
-</pre>
-<p>
-<tt>:name</tt> is required to get a score. If <tt>:name</tt> is missing, an
-error will not be thrown, but a score of 0 will be returned.
-</p>
-<p>
-The more information provided, the higher the score could be. A score of
-100 would mean all fields were passed in, and all fields were 100% matches.
-If only the name is passed in without an address, it will be impossible to
-get a score of 100, even if the name matches perfectly.
-</p>
-<p>
-Acceptable hash keys and their weighting in score calculation:
-</p>
-<ul>
-<li><tt>:name</tt> (weighting = 60%) (required) This can be a person, business,
-or marine vessel
-</li>
-<li><tt>:address</tt> (weighting = 10%)
-</li>
-<li><tt>:city</tt> (weighting = 30%)
-</li>
-<li>Instantiate the object with the identity&#8216;s name, street address, and
-city.
-<pre>
-  ofac = Ofac.new(:name =&gt; 'Kevin Tyll', :city =&gt; 'Clearwater', :address =&gt; '123 Somewhere Ln.')
-</pre>
-</li>
-<li>Then get the score
-<pre>
-  ofac.score =&gt; return the score 1 - 100
-</pre>
-</li>
-<li>You can also get the list of all the partial matches with the score of each
-record.
-<pre>
-  ofac.possible_hits =&gt; returns an array of hashes.
-</pre>
-</li>
-</ul>
-<h2>REQUIREMENTS:</h2>
-<ul>
-<li>Rails 2.0.0 or greater
-</li>
-</ul>
-<h2>INSTALL:</h2>
-<ul>
-<li>To install the gem:
-<pre>
-  sudo gem install kevintyll-ofac
-</pre>
-</li>
-<li>To create the necessary db migration, from the command line, run:
-<pre>
-  script/generate ofac_migration
-</pre>
-</li>
-<li>Require the gem in your environment.rb file in the Rails::Initializer
-block:
-<pre>
-  config.gem 'kevintyll-ofac', :lib =&gt; 'ofac'
-</pre>
-</li>
-<li>To load your table with the current OFAC data, from the command line, run:
-<pre>
-  rake ofac:update_data
-  * The OFAC data is not updated with any regularity, but you can sign up for email notifications when the data changes at
-      http://www.treas.gov/offices/enforcement/ofac/sdn/index.shtml.
-</pre>
-</li>
-</ul>
-<h2>Copyright</h2>
-<p>
-Copyright (c) 2009 Kevin Tyll. See LICENSE for details.
-</p>
-    </div>
-   </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-  </div>
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-</body>
-</html>