ofac 1.2.3 → 1.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. data/History.txt +5 -0
  2. data/Rakefile +2 -1
  3. data/VERSION.yml +1 -1
  4. data/lib/ofac/models/ofac_sdn_loader.rb +61 -56
  5. data/ofac.gemspec +50 -13
  6. data/rdoc/Ofac.html +423 -0
  7. data/rdoc/OfacMatch.html +282 -0
  8. data/rdoc/OfacSdn.html +133 -0
  9. data/rdoc/OfacSdnLoader.html +225 -0
  10. data/rdoc/README_rdoc.html +267 -0
  11. data/rdoc/String.html +245 -0
  12. data/rdoc/created.rid +8 -1
  13. data/rdoc/images/add.png +0 -0
  14. data/rdoc/images/brick.png +0 -0
  15. data/rdoc/images/brick_link.png +0 -0
  16. data/rdoc/images/bug.png +0 -0
  17. data/rdoc/images/bullet_black.png +0 -0
  18. data/rdoc/images/bullet_toggle_minus.png +0 -0
  19. data/rdoc/images/bullet_toggle_plus.png +0 -0
  20. data/rdoc/images/date.png +0 -0
  21. data/rdoc/images/delete.png +0 -0
  22. data/rdoc/images/find.png +0 -0
  23. data/rdoc/images/loadingAnimation.gif +0 -0
  24. data/rdoc/images/macFFBgHack.png +0 -0
  25. data/rdoc/images/package.png +0 -0
  26. data/rdoc/images/page_green.png +0 -0
  27. data/rdoc/images/page_white_text.png +0 -0
  28. data/rdoc/images/page_white_width.png +0 -0
  29. data/rdoc/images/plugin.png +0 -0
  30. data/rdoc/images/ruby.png +0 -0
  31. data/rdoc/images/tag_blue.png +0 -0
  32. data/rdoc/images/tag_green.png +0 -0
  33. data/rdoc/images/transparent.png +0 -0
  34. data/rdoc/images/wrench.png +0 -0
  35. data/rdoc/images/wrench_orange.png +0 -0
  36. data/rdoc/images/zoom.png +0 -0
  37. data/rdoc/index.html +83 -21
  38. data/rdoc/js/darkfish.js +153 -0
  39. data/rdoc/js/jquery.js +18 -0
  40. data/rdoc/js/navigation.js +142 -0
  41. data/rdoc/js/search.js +94 -0
  42. data/rdoc/js/search_index.js +1 -0
  43. data/rdoc/js/searcher.js +228 -0
  44. data/rdoc/lib/ofac/models/ofac_rb.html +89 -0
  45. data/rdoc/lib/ofac/models/ofac_sdn_loader_rb.html +89 -0
  46. data/rdoc/lib/ofac/models/ofac_sdn_rb.html +89 -0
  47. data/rdoc/lib/ofac/ofac_match_rb.html +89 -0
  48. data/rdoc/lib/ofac/ruby_string_extensions_rb.html +89 -0
  49. data/rdoc/lib/ofac_rb.html +89 -0
  50. data/rdoc/rdoc.css +543 -0
  51. data/rdoc/table_of_contents.html +94 -0
  52. metadata +52 -19
data/rdoc/OfacMatch.html ADDED
@@ -0,0 +1,282 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>Class: OfacMatch</title>
8
+
9
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "./";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="./index.html">Home</a>
28
+ <a href="./table_of_contents.html#classes">Classes</a>
29
+ <a href="./table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/ofac/ofac_match.rb
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link">Object
63
+
64
+ </nav>
65
+
66
+
67
+ <!-- Method Quickref -->
68
+ <nav id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+
71
+ <ul class="link-list">
72
+
73
+ <li><a href="#method-c-new">::new</a>
74
+
75
+ <li><a href="#method-i-score">#score</a>
76
+
77
+ </ul>
78
+ </nav>
79
+
80
+ </div>
81
+
82
+ <div id="project-metadata">
83
+ <nav id="fileindex-section" class="section project-section">
84
+ <h3 class="section-header">Pages</h3>
85
+
86
+ <ul>
87
+
88
+ <li class="file"><a href="./README_rdoc.html">README</a>
89
+
90
+ </ul>
91
+ </nav>
92
+
93
+ <nav id="classindex-section" class="section project-section">
94
+ <h3 class="section-header">Class and Module Index</h3>
95
+
96
+ <ul class="link-list">
97
+
98
+ <li><a href="./Ofac.html">Ofac</a>
99
+
100
+ <li><a href="./OfacMatch.html">OfacMatch</a>
101
+
102
+ <li><a href="./OfacSdn.html">OfacSdn</a>
103
+
104
+ <li><a href="./OfacSdnLoader.html">OfacSdnLoader</a>
105
+
106
+ <li><a href="./String.html">String</a>
107
+
108
+ </ul>
109
+ </nav>
110
+
111
+ </div>
112
+ </nav>
113
+
114
+ <div id="documentation">
115
+ <h1 class="class">class OfacMatch</h1>
116
+
117
+ <div id="description" class="description">
118
+
119
+ </div><!-- description -->
120
+
121
+
122
+
123
+
124
+ <section id="5Buntitled-5D" class="documentation-section">
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+ <!-- Attributes -->
133
+ <section id="attribute-method-details" class="method-section section">
134
+ <h3 class="section-header">Attributes</h3>
135
+
136
+
137
+ <div id="attribute-i-possible_hits" class="method-detail">
138
+ <div class="method-heading attribute-method-heading">
139
+ <span class="method-name">possible_hits</span><span
140
+ class="attribute-access-type">[R]</span>
141
+ </div>
142
+
143
+ <div class="method-description">
144
+
145
+
146
+
147
+ </div>
148
+ </div>
149
+
150
+ </section><!-- attribute-method-details -->
151
+
152
+
153
+ <!-- Methods -->
154
+
155
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
156
+ <h3 class="section-header">Public Class Methods</h3>
157
+
158
+
159
+ <div id="method-c-new" class="method-detail ">
160
+
161
+ <div class="method-heading">
162
+ <span class="method-name">new</span><span
163
+ class="method-args">(stats={})</span>
164
+ <span class="method-click-advice">click to toggle source</span>
165
+ </div>
166
+
167
+
168
+ <div class="method-description">
169
+
170
+ <p>Intialize a Match object with a record hash of fields you want to match on.
171
+ Each key in the hash, also has a data hash value for the weight, token, and
172
+ type.</p>
173
+
174
+ <pre class="ruby"> <span class="ruby-identifier">match</span> = <span class="ruby-constant">Ofac</span><span class="ruby-operator">::</span><span class="ruby-constant">Match</span>.<span class="ruby-identifier">new</span>({:<span class="ruby-identifier">name</span> =<span class="ruby-operator">&gt;</span> {:<span class="ruby-identifier">weight</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">10</span>, :<span class="ruby-identifier">token</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'Kevin Tyll'</span>},
175
+ :<span class="ruby-identifier">city</span> =<span class="ruby-operator">&gt;</span> {:<span class="ruby-identifier">weight</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">40</span>, :<span class="ruby-identifier">token</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'Clearwater'</span>, },
176
+ :<span class="ruby-identifier">address</span> =<span class="ruby-operator">&gt;</span> {:<span class="ruby-identifier">weight</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">40</span>, :<span class="ruby-identifier">token</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'1234 Park St.'</span>, },
177
+ :<span class="ruby-identifier">zip</span> =<span class="ruby-operator">&gt;</span> {:<span class="ruby-identifier">weight</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">10</span>, :<span class="ruby-identifier">token</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'33759'</span>, :<span class="ruby-identifier">type</span> =<span class="ruby-operator">&gt;</span> :<span class="ruby-identifier">number</span>}})
178
+
179
+ <span class="ruby-identifier">data</span> <span class="ruby-identifier">hash</span> <span class="ruby-identifier">keys</span><span class="ruby-operator">:</span>
180
+ * <span class="ruby-operator">&lt;</span><span class="ruby-identifier">tt</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">data</span>[:<span class="ruby-identifier">weight</span>]<span class="ruby-operator">&lt;</span><span class="ruby-regexp">/tt&gt; - value to apply to the score if there is a match (Default is 100/</span><span class="ruby-identifier">umber</span> <span class="ruby-identifier">of</span> <span class="ruby-identifier">keys</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">record</span> <span class="ruby-identifier">hash</span>)
181
+ * <span class="ruby-operator">&lt;</span><span class="ruby-identifier">tt</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">data</span>[:<span class="ruby-identifier">token</span>]<span class="ruby-operator">&lt;</span><span class="ruby-regexp">/tt&gt; - string to match
182
+ * &lt;tt&gt;data[:match]&lt;/</span><span class="ruby-identifier">tt</span><span class="ruby-operator">&gt;</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">set</span> <span class="ruby-identifier">from</span> <span class="ruby-identifier">records</span> <span class="ruby-identifier">hash</span>
183
+ * <span class="ruby-operator">&lt;</span><span class="ruby-identifier">tt</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">data</span>[:<span class="ruby-identifier">score</span>]<span class="ruby-operator">&lt;</span><span class="ruby-regexp">/tt&gt; - output field
184
+ * &lt;tt&gt;data[:type]&lt;/</span><span class="ruby-identifier">tt</span><span class="ruby-operator">&gt;</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">type</span> <span class="ruby-identifier">of</span> <span class="ruby-identifier">match</span> <span class="ruby-identifier">that</span> <span class="ruby-identifier">should</span> <span class="ruby-identifier">be</span> <span class="ruby-identifier">performed</span> (<span class="ruby-identifier">valid</span> <span class="ruby-identifier">values</span> <span class="ruby-identifier">are</span> <span class="ruby-operator">+</span>:<span class="ruby-identifier">sound</span><span class="ruby-operator">+</span> <span class="ruby-operator">|</span> <span class="ruby-operator">+</span>:<span class="ruby-identifier">number</span><span class="ruby-operator">+</span>) (<span class="ruby-constant">Default</span> <span class="ruby-identifier">is</span> <span class="ruby-operator">+</span>:<span class="ruby-identifier">sound</span><span class="ruby-operator">+</span>)
185
+ </pre>
186
+
187
+
188
+
189
+ <div class="method-source-code" id="new-source">
190
+ <pre><span class="ruby-comment"># File lib/ofac/ofac_match.rb, line 19</span>
191
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">stats</span>={})
192
+ <span class="ruby-ivar">@possible_hits</span> = []
193
+ <span class="ruby-ivar">@stats</span> = <span class="ruby-identifier">stats</span>.<span class="ruby-identifier">dup</span>
194
+ <span class="ruby-identifier">weight</span> = <span class="ruby-value">100</span>
195
+ <span class="ruby-identifier">weight</span> = <span class="ruby-value">100</span> <span class="ruby-operator">/</span> <span class="ruby-ivar">@stats</span>.<span class="ruby-identifier">length</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@stats</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
196
+ <span class="ruby-ivar">@stats</span>.<span class="ruby-identifier">each_value</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
197
+ <span class="ruby-identifier">data</span>[<span class="ruby-value">:weight</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">weight</span>
198
+ <span class="ruby-identifier">data</span>[<span class="ruby-value">:match</span>] <span class="ruby-operator">||=</span> <span class="ruby-string">''</span>
199
+ <span class="ruby-identifier">data</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">||=</span> <span class="ruby-value">:sound</span>
200
+ <span class="ruby-identifier">data</span>[<span class="ruby-value">:score</span>] <span class="ruby-operator">||=</span> <span class="ruby-value">0</span>
201
+ <span class="ruby-identifier">data</span>[<span class="ruby-value">:token</span>] = <span class="ruby-identifier">data</span>[<span class="ruby-value">:token</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">upcase</span>
202
+ <span class="ruby-keyword">end</span>
203
+ <span class="ruby-keyword">end</span></pre>
204
+ </div><!-- new-source -->
205
+
206
+ </div>
207
+
208
+
209
+
210
+
211
+ </div><!-- new-method -->
212
+
213
+
214
+ </section><!-- public-class-method-details -->
215
+
216
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
217
+ <h3 class="section-header">Public Instance Methods</h3>
218
+
219
+
220
+ <div id="method-i-score" class="method-detail ">
221
+
222
+ <div class="method-heading">
223
+ <span class="method-name">score</span><span
224
+ class="method-args">(match_records)</span>
225
+ <span class="method-click-advice">click to toggle source</span>
226
+ </div>
227
+
228
+
229
+ <div class="method-description">
230
+
231
+ <p>match_records is an array of hashes.</p>
232
+
233
+ <p>The hash keys must match the record hash keys set when initialized.</p>
234
+
235
+ <p>score will return the highest score of all the records that are sent in
236
+ match_records.</p>
237
+
238
+
239
+
240
+ <div class="method-source-code" id="score-source">
241
+ <pre><span class="ruby-comment"># File lib/ofac/ofac_match.rb, line 39</span>
242
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">score</span>(<span class="ruby-identifier">match_records</span>)
243
+ <span class="ruby-identifier">score_results</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
244
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">match_records</span>.<span class="ruby-identifier">empty?</span>
245
+ <span class="ruby-comment">#place the match_records information</span>
246
+ <span class="ruby-comment">#into our @stats hash</span>
247
+ <span class="ruby-identifier">match_records</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span>
248
+ <span class="ruby-identifier">match</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
249
+ <span class="ruby-ivar">@stats</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>][<span class="ruby-value">:match</span>] = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">upcase</span>
250
+ <span class="ruby-keyword">end</span>
251
+ <span class="ruby-identifier">record_score</span> = <span class="ruby-identifier">calculate_record</span>
252
+ <span class="ruby-identifier">score_results</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">record_score</span>)
253
+ <span class="ruby-ivar">@possible_hits</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">match</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:score</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">record_score</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">record_score</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
254
+ <span class="ruby-keyword">end</span>
255
+ <span class="ruby-identifier">score</span> = <span class="ruby-identifier">score_results</span>.<span class="ruby-identifier">max</span> <span class="ruby-comment">#take max score</span>
256
+ <span class="ruby-keyword">end</span>
257
+ <span class="ruby-ivar">@possible_hits</span>.<span class="ruby-identifier">uniq!</span>
258
+ <span class="ruby-identifier">score</span> <span class="ruby-operator">||=</span> <span class="ruby-value">0</span>
259
+ <span class="ruby-keyword">end</span></pre>
260
+ </div><!-- score-source -->
261
+
262
+ </div>
263
+
264
+
265
+
266
+
267
+ </div><!-- score-method -->
268
+
269
+
270
+ </section><!-- public-instance-method-details -->
271
+
272
+ </section><!-- 5Buntitled-5D -->
273
+
274
+ </div><!-- documentation -->
275
+
276
+
277
+ <footer id="validator-badges">
278
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
279
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
280
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
281
+ </footer>
282
+
data/rdoc/OfacSdn.html ADDED
@@ -0,0 +1,133 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>Class: OfacSdn</title>
8
+
9
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "./";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="./index.html">Home</a>
28
+ <a href="./table_of_contents.html#classes">Classes</a>
29
+ <a href="./table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/ofac/models/ofac_sdn.rb
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link">ActiveRecord::Base
63
+
64
+ </nav>
65
+
66
+
67
+
68
+ </div>
69
+
70
+ <div id="project-metadata">
71
+ <nav id="fileindex-section" class="section project-section">
72
+ <h3 class="section-header">Pages</h3>
73
+
74
+ <ul>
75
+
76
+ <li class="file"><a href="./README_rdoc.html">README</a>
77
+
78
+ </ul>
79
+ </nav>
80
+
81
+ <nav id="classindex-section" class="section project-section">
82
+ <h3 class="section-header">Class and Module Index</h3>
83
+
84
+ <ul class="link-list">
85
+
86
+ <li><a href="./Ofac.html">Ofac</a>
87
+
88
+ <li><a href="./OfacMatch.html">OfacMatch</a>
89
+
90
+ <li><a href="./OfacSdn.html">OfacSdn</a>
91
+
92
+ <li><a href="./OfacSdnLoader.html">OfacSdnLoader</a>
93
+
94
+ <li><a href="./String.html">String</a>
95
+
96
+ </ul>
97
+ </nav>
98
+
99
+ </div>
100
+ </nav>
101
+
102
+ <div id="documentation">
103
+ <h1 class="class">class OfacSdn</h1>
104
+
105
+ <div id="description" class="description">
106
+
107
+ </div><!-- description -->
108
+
109
+
110
+
111
+
112
+ <section id="5Buntitled-5D" class="documentation-section">
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+ <!-- Methods -->
122
+
123
+ </section><!-- 5Buntitled-5D -->
124
+
125
+ </div><!-- documentation -->
126
+
127
+
128
+ <footer id="validator-badges">
129
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
130
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
131
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
132
+ </footer>
133
+
data/rdoc/OfacSdnLoader.html ADDED
@@ -0,0 +1,225 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>Class: OfacSdnLoader</title>
8
+
9
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "./";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="./index.html">Home</a>
28
+ <a href="./table_of_contents.html#classes">Classes</a>
29
+ <a href="./table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/ofac/models/ofac_sdn_loader.rb
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link">Object
63
+
64
+ </nav>
65
+
66
+
67
+ <!-- Method Quickref -->
68
+ <nav id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+
71
+ <ul class="link-list">
72
+
73
+ <li><a href="#method-c-load_current_sdn_file">::load_current_sdn_file</a>
74
+
75
+ </ul>
76
+ </nav>
77
+
78
+ </div>
79
+
80
+ <div id="project-metadata">
81
+ <nav id="fileindex-section" class="section project-section">
82
+ <h3 class="section-header">Pages</h3>
83
+
84
+ <ul>
85
+
86
+ <li class="file"><a href="./README_rdoc.html">README</a>
87
+
88
+ </ul>
89
+ </nav>
90
+
91
+ <nav id="classindex-section" class="section project-section">
92
+ <h3 class="section-header">Class and Module Index</h3>
93
+
94
+ <ul class="link-list">
95
+
96
+ <li><a href="./Ofac.html">Ofac</a>
97
+
98
+ <li><a href="./OfacMatch.html">OfacMatch</a>
99
+
100
+ <li><a href="./OfacSdn.html">OfacSdn</a>
101
+
102
+ <li><a href="./OfacSdnLoader.html">OfacSdnLoader</a>
103
+
104
+ <li><a href="./String.html">String</a>
105
+
106
+ </ul>
107
+ </nav>
108
+
109
+ </div>
110
+ </nav>
111
+
112
+ <div id="documentation">
113
+ <h1 class="class">class OfacSdnLoader</h1>
114
+
115
+ <div id="description" class="description">
116
+
117
+ </div><!-- description -->
118
+
119
+
120
+
121
+
122
+ <section id="5Buntitled-5D" class="documentation-section">
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <!-- Methods -->
132
+
133
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
134
+ <h3 class="section-header">Public Class Methods</h3>
135
+
136
+
137
+ <div id="method-c-load_current_sdn_file" class="method-detail ">
138
+
139
+ <div class="method-heading">
140
+ <span class="method-name">load_current_sdn_file</span><span
141
+ class="method-args">() { |"Downloading OFAC data from http://treas.gov/offices/enforcement/ofac/sdn"| ... }</span>
142
+ <span class="method-click-advice">click to toggle source</span>
143
+ </div>
144
+
145
+
146
+ <div class="method-description">
147
+
148
+ <p>Loads the most recent file from <a
149
+ href="http://www.treas.gov/offices/enforcement/ofac/sdn/delimit/index.shtml">www.treas.gov/offices/enforcement/ofac/sdn/delimit/index.shtml</a></p>
150
+
151
+
152
+
153
+ <div class="method-source-code" id="load_current_sdn_file-source">
154
+ <pre><span class="ruby-comment"># File lib/ofac/models/ofac_sdn_loader.rb, line 9</span>
155
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">load_current_sdn_file</span>
156
+ <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;Reloading OFAC sdn data&quot;</span>
157
+ <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;Downloading OFAC data from http://www.treas.gov/offices/enforcement/ofac/sdn&quot;</span>
158
+ <span class="ruby-keyword">yield</span> <span class="ruby-string">&quot;Downloading OFAC data from http://www.treas.gov/offices/enforcement/ofac/sdn&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
159
+ <span class="ruby-comment">#get the 3 data files</span>
160
+ <span class="ruby-identifier">sdn</span> = <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'sdn'</span>)
161
+ <span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">'http://www.treasury.gov/ofac/downloads/sdn.pip'</span>)
162
+
163
+ <span class="ruby-identifier">proxy_addr</span>, <span class="ruby-identifier">proxy_port</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-string">'http_proxy'</span>].<span class="ruby-identifier">gsub</span>(<span class="ruby-string">&quot;http://&quot;</span>, <span class="ruby-string">&quot;&quot;</span>).<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/:/</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'http_proxy'</span>]
164
+ <span class="ruby-identifier">proxy_user</span>, <span class="ruby-identifier">proxy_pass</span> = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">userinfo</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/:/</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">userinfo</span>
165
+
166
+ <span class="ruby-identifier">bytes</span> = <span class="ruby-identifier">sdn</span>.<span class="ruby-identifier">write</span>(<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Proxy</span>(<span class="ruby-identifier">proxy_addr</span>, <span class="ruby-identifier">proxy_port</span>, <span class="ruby-identifier">proxy_user</span>, <span class="ruby-identifier">proxy_pass</span>).<span class="ruby-identifier">get</span>(<span class="ruby-identifier">uri</span>))
167
+ <span class="ruby-identifier">sdn</span>.<span class="ruby-identifier">rewind</span>
168
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">bytes</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">convert_line_to_array</span>(<span class="ruby-identifier">sdn</span>.<span class="ruby-identifier">readline</span>).<span class="ruby-identifier">size</span> <span class="ruby-operator">!=</span> <span class="ruby-value">12</span>
169
+ <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;Trouble downloading file. The url may have changed.&quot;</span>
170
+ <span class="ruby-keyword">yield</span> <span class="ruby-string">&quot;Trouble downloading file. The url may have changed.&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
171
+ <span class="ruby-keyword">return</span>
172
+ <span class="ruby-keyword">else</span>
173
+ <span class="ruby-identifier">sdn</span>.<span class="ruby-identifier">rewind</span>
174
+ <span class="ruby-keyword">end</span>
175
+ <span class="ruby-identifier">address</span> = <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'sdn'</span>)
176
+ <span class="ruby-identifier">address</span>.<span class="ruby-identifier">write</span>(<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">get</span>(<span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">'http://www.treasury.gov/ofac/downloads/add.pip'</span>)))
177
+ <span class="ruby-identifier">address</span>.<span class="ruby-identifier">rewind</span>
178
+ <span class="ruby-identifier">alt</span> = <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'sdn'</span>)
179
+ <span class="ruby-identifier">alt</span>.<span class="ruby-identifier">write</span>(<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">get</span>(<span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">'http://www.treasury.gov/ofac/downloads/alt.pip'</span>)))
180
+ <span class="ruby-identifier">alt</span>.<span class="ruby-identifier">rewind</span>
181
+
182
+ <span class="ruby-keyword">if</span> <span class="ruby-constant">OfacSdn</span>.<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">ConnectionAdapters</span><span class="ruby-operator">::</span><span class="ruby-constant">MysqlAdapter</span>)
183
+ <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;Converting file to csv format for Mysql import. This could take several minutes.&quot;</span>
184
+ <span class="ruby-keyword">yield</span> <span class="ruby-string">&quot;Converting file to csv format for Mysql import. This could take several minutes.&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
185
+
186
+ <span class="ruby-identifier">csv_file</span> = <span class="ruby-identifier">convert_to_flattened_csv</span>(<span class="ruby-identifier">sdn</span>, <span class="ruby-identifier">address</span>, <span class="ruby-identifier">alt</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">status</span><span class="ruby-operator">|</span>
187
+ <span class="ruby-keyword">yield</span> <span class="ruby-identifier">status</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
188
+ <span class="ruby-keyword">end</span>
189
+
190
+ <span class="ruby-identifier">bulk_mysql_update</span>(<span class="ruby-identifier">csv_file</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">status</span><span class="ruby-operator">|</span>
191
+ <span class="ruby-keyword">yield</span> <span class="ruby-identifier">status</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
192
+ <span class="ruby-keyword">end</span>
193
+ <span class="ruby-keyword">else</span>
194
+ <span class="ruby-identifier">active_record_file_load</span>(<span class="ruby-identifier">sdn</span>, <span class="ruby-identifier">address</span>, <span class="ruby-identifier">alt</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">status</span><span class="ruby-operator">|</span>
195
+ <span class="ruby-keyword">yield</span> <span class="ruby-identifier">status</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
196
+ <span class="ruby-keyword">end</span>
197
+ <span class="ruby-keyword">end</span>
198
+
199
+ <span class="ruby-identifier">sdn</span>.<span class="ruby-identifier">close</span>
200
+ <span class="ruby-ivar">@address</span>.<span class="ruby-identifier">close</span>
201
+ <span class="ruby-ivar">@alt</span>.<span class="ruby-identifier">close</span>
202
+ <span class="ruby-keyword">end</span></pre>
203
+ </div><!-- load_current_sdn_file-source -->
204
+
205
+ </div>
206
+
207
+
208
+
209
+
210
+ </div><!-- load_current_sdn_file-method -->
211
+
212
+
213
+ </section><!-- public-class-method-details -->
214
+
215
+ </section><!-- 5Buntitled-5D -->
216
+
217
+ </div><!-- documentation -->
218
+
219
+
220
+ <footer id="validator-badges">
221
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
222
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
223
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
224
+ </footer>
225
+