ofac 1.2.5 → 1.3.0

data/History.txt

@@ -1,3 +1,8 @@
+== 1.3.0 2012-03-16
+
+*  1 enhancements:
+   * Rails 3 generator added
+
 == 1.2.5 2012-02-15
 
 *  1 enhancements:

data/README.rdoc

@@ -106,6 +106,8 @@ Acceptable hash keys and their weighting in score calculation:
 
 == INSTALL:
 
+==== Rails 2.0
+
 * To install the gem:
     sudo gem install kevintyll-ofac
 * To create the necessary db migration, from the command line, run:
@@ -118,6 +120,21 @@ Acceptable hash keys and their weighting in score calculation:
     * 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.
 
+==== Rails 3.0
+
+* To create the necessary db migration, from the command line, run:
+    rails generate ofac_migration:build
+* To add the gem to your Rails project:
+===== Add the gem to your Gemfile:
+    gem "ofac", "~> 1.3.0"
+===== Run the Bundler install command
+		bundle install
+* To load your table with the current OFAC data, from the command line, run:
+    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.
+
 == Copyright
 
 Copyright (c) 2009 Kevin Tyll. See LICENSE for details.

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 1
-:minor: 2
-:patch: 5
-:build: 
+:minor: 3
+:patch: 0
+:build:

data/lib/generators/ofac_migration/build/build_generator.rb

@@ -0,0 +1,29 @@
+require 'rails'
+
+module OfacMigration
+	module Generators
+		class BuildGenerator < ::Rails::Generators::Base
+			include Rails::Generators::Migration
+			source_root File.expand_path('../templates', __FILE__)
+			desc "Adds the migration for the ofac_sdns table."
+			
+			# Get the next migration number
+			#
+			def self.next_migration_number(path)
+				unless @prev_migration_nr
+					@prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+				else
+					@prev_migration_nr += 1
+				end
+				@prev_migration_nr.to_s
+			end
+			
+			# copy the migration file over
+			#
+			def copy_migrations
+				migration_template "create_ofac_sdns.rb", "db/migrate/create_ofac_sdns.rb"
+			end
+			
+		end
+	end
+end

data/lib/generators/ofac_migration/build/templates/create_ofac_sdns.rb

@@ -0,0 +1,31 @@
+class CreateOfacSdns < ActiveRecord::Migration
+  
+  def self.up
+    create_table :ofac_sdns do |t|
+      t.text      :name
+      t.string    :sdn_type
+      t.string    :program
+      t.string    :title
+      t.string    :vessel_call_sign
+      t.string    :vessel_type
+      t.string    :vessel_tonnage
+      t.string    :gross_registered_tonnage
+      t.string    :vessel_flag
+      t.string    :vessel_owner
+      t.text      :remarks
+      t.text      :address
+      t.string    :city
+      t.string    :country
+      t.string    :address_remarks
+      t.string    :alternate_identity_type
+      t.text      :alternate_identity_name
+      t.string    :alternate_identity_remarks
+      t.timestamps
+    end
+    add_index :ofac_sdns, :sdn_type
+  end
+  
+  def self.down
+    drop_table :ofac_sdns
+  end
+end

data/ofac.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ofac}
-  s.version = "1.2.5"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Kevin Tyll}]
-  s.date = %q{2012-02-15}
+  s.date = %q{2012-03-16}
   s.description = %q{Attempts to find a hit on the Office of Foreign Assets Control's Specially Designated Nationals list.}
   s.email = %q{kevintyll@gmail.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,8 @@ Gem::Specification.new do |s|
     "generators/ofac_migration/ofac_migration_generator.rb",
     "generators/ofac_migration/templates/.DS_Store",
     "generators/ofac_migration/templates/migration.rb",
+    "lib/generators/ofac_migration/build/build_generator.rb",
+    "lib/generators/ofac_migration/build/templates/create_ofac_sdns.rb",
     "lib/ofac.rb",
     "lib/ofac/models/ofac.rb",
     "lib/ofac/models/ofac_sdn.rb",
@@ -40,8 +42,12 @@ Gem::Specification.new do |s|
     "ofac.gemspec",
     "pkg/ofac-0.1.0.gem",
     "pkg/ofac-1.0.0.gem",
+    "rdoc/CreateOfacSdns.html",
     "rdoc/Ofac.html",
     "rdoc/OfacMatch.html",
+    "rdoc/OfacMigration.html",
+    "rdoc/OfacMigration/Generators.html",
+    "rdoc/OfacMigration/Generators/BuildGenerator.html",
     "rdoc/OfacSdn.html",
     "rdoc/OfacSdnLoader.html",
     "rdoc/README_rdoc.html",
@@ -93,6 +99,8 @@ Gem::Specification.new do |s|
     "rdoc/js/search.js",
     "rdoc/js/search_index.js",
     "rdoc/js/searcher.js",
+    "rdoc/lib/generators/ofac_migration/build/build_generator_rb.html",
+    "rdoc/lib/generators/ofac_migration/build/templates/create_ofac_sdns_rb.html",
     "rdoc/lib/ofac/models/ofac_rb.html",
     "rdoc/lib/ofac/models/ofac_sdn_loader_rb.html",
     "rdoc/lib/ofac/models/ofac_sdn_rb.html",

data/rdoc/CreateOfacSdns.html

@@ -0,0 +1,240 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>Class: CreateOfacSdns</title>
+
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+
+
+<body id="top" class="class">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="./index.html">Home</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/generators/ofac_migration/build/templates/create_ofac_sdns.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    <nav id="parent-class-section" class="section">
+  <h3 class="section-header">Parent</h3>
+  
+  <p class="link">ActiveRecord::Migration
+  
+</nav>
+
+    
+    <!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+  <h3 class="section-header">Methods</h3>
+
+  <ul class="link-list">
+    
+    <li><a href="#method-c-down">::down</a>
+    
+    <li><a href="#method-c-up">::up</a>
+    
+  </ul>
+</nav>
+
+  </div>
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  
+    <li class="file"><a href="./README_rdoc.html">README</a>
+  
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="./OfacMigration.html">OfacMigration</a>
+  
+    <li><a href="./OfacMigration/Generators.html">OfacMigration::Generators</a>
+  
+    <li><a href="./OfacMigration/Generators/BuildGenerator.html">OfacMigration::Generators::BuildGenerator</a>
+  
+    <li><a href="./CreateOfacSdns.html">CreateOfacSdns</a>
+  
+    <li><a href="./Ofac.html">Ofac</a>
+  
+    <li><a href="./OfacMatch.html">OfacMatch</a>
+  
+    <li><a href="./OfacSdn.html">OfacSdn</a>
+  
+    <li><a href="./OfacSdnLoader.html">OfacSdnLoader</a>
+  
+    <li><a href="./String.html">String</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="class">class CreateOfacSdns</h1>
+
+  <div id="description" class="description">
+    
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    <!-- Methods -->
+    
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Class Methods</h3>
+
+    
+      <div id="method-c-down" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">down</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+
+          
+          <div class="method-source-code" id="down-source">
+            <pre><span class="ruby-comment"># File lib/generators/ofac_migration/build/templates/create_ofac_sdns.rb, line 28</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">down</span>
+  <span class="ruby-identifier">drop_table</span> <span class="ruby-value">:ofac_sdns</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- down-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- down-method -->
+
+    
+      <div id="method-c-up" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">up</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+
+          
+          <div class="method-source-code" id="up-source">
+            <pre><span class="ruby-comment"># File lib/generators/ofac_migration/build/templates/create_ofac_sdns.rb, line 3</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">up</span>
+  <span class="ruby-identifier">create_table</span> <span class="ruby-value">:ofac_sdns</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">text</span>      <span class="ruby-value">:name</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:sdn_type</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:program</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:title</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:vessel_call_sign</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:vessel_type</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:vessel_tonnage</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:gross_registered_tonnage</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:vessel_flag</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:vessel_owner</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">text</span>      <span class="ruby-value">:remarks</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">text</span>      <span class="ruby-value">:address</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:city</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:country</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:address_remarks</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:alternate_identity_type</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">text</span>      <span class="ruby-value">:alternate_identity_name</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span>    <span class="ruby-value">:alternate_identity_remarks</span>
+    <span class="ruby-identifier">t</span>.<span class="ruby-identifier">timestamps</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-identifier">add_index</span> <span class="ruby-value">:ofac_sdns</span>, <span class="ruby-value">:sdn_type</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- up-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- up-method -->
+
+    
+    </section><!-- public-class-method-details -->
+  
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+

data/rdoc/Ofac.html

@@ -99,6 +99,14 @@
 
   <ul class="link-list">
   
+    <li><a href="./OfacMigration.html">OfacMigration</a>
+  
+    <li><a href="./OfacMigration/Generators.html">OfacMigration::Generators</a>
+  
+    <li><a href="./OfacMigration/Generators/BuildGenerator.html">OfacMigration::Generators::BuildGenerator</a>
+  
+    <li><a href="./CreateOfacSdns.html">CreateOfacSdns</a>
+  
     <li><a href="./Ofac.html">Ofac</a>
   
     <li><a href="./OfacMatch.html">OfacMatch</a>

data/rdoc/OfacMatch.html

@@ -95,6 +95,14 @@
 
   <ul class="link-list">
   
+    <li><a href="./OfacMigration.html">OfacMigration</a>
+  
+    <li><a href="./OfacMigration/Generators.html">OfacMigration::Generators</a>
+  
+    <li><a href="./OfacMigration/Generators/BuildGenerator.html">OfacMigration::Generators::BuildGenerator</a>
+  
+    <li><a href="./CreateOfacSdns.html">CreateOfacSdns</a>
+  
     <li><a href="./Ofac.html">Ofac</a>
   
     <li><a href="./OfacMatch.html">OfacMatch</a>

data/rdoc/OfacMigration.html

@@ -0,0 +1,135 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>Module: OfacMigration</title>
+
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+
+
+<body id="top" class="module">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="./index.html">Home</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/generators/ofac_migration/build/build_generator.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    
+    
+    
+  </div>
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  
+    <li class="file"><a href="./README_rdoc.html">README</a>
+  
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="./OfacMigration.html">OfacMigration</a>
+  
+    <li><a href="./OfacMigration/Generators.html">OfacMigration::Generators</a>
+  
+    <li><a href="./OfacMigration/Generators/BuildGenerator.html">OfacMigration::Generators::BuildGenerator</a>
+  
+    <li><a href="./CreateOfacSdns.html">CreateOfacSdns</a>
+  
+    <li><a href="./Ofac.html">Ofac</a>
+  
+    <li><a href="./OfacMatch.html">OfacMatch</a>
+  
+    <li><a href="./OfacSdn.html">OfacSdn</a>
+  
+    <li><a href="./OfacSdnLoader.html">OfacSdnLoader</a>
+  
+    <li><a href="./String.html">String</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="module">module OfacMigration</h1>
+
+  <div id="description" class="description">
+    
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    <!-- Methods -->
+    
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+