ofac_sdn 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1bfde7b0ba49c30964a0d8abe93a6b81786ff19
+  data.tar.gz: 91b0a014f538b09d91f4ab4e058f6153625e6b00
+SHA512:
+  metadata.gz: 4ee32d8ac6b628b7c20531a307bb9675ed92be6bd36745535faa21dd6f87c39d2d793bb1c177b7ba511ac9771557e423ec0d431d5cecc3b63924f1184696b739
+  data.tar.gz: 9c00b548c70a02b81ac5a8df7564c013039a69f604197c7893bb6706e008b2218f5f7db108dd801c13e9393d313f80fa41de5600a34cc37f05590cfbeaa09205

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ofac_sdn.gemspec
+# gem 'pry-byebug'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    ofac_sdn (0.1.0)
+      nokogiri (~> 1.8.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.1)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.10.2)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  ofac_sdn!
+  pry-byebug
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Bryam Noguera
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# OfacSdn
+This gem provides the OFAC `sdn.xml` as an easy to use Ruby hash. This allows you to conduct your own search criteria on your own system.
+
+You can find the OFAC downloads here: 
+[OFAC Downloads](https://www.treasury.gov/ofac/downloads)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ofac_sdn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ofac_sdn
+
+## Usage
+You should run this in a worker since parsing an XML and converting it to a pretty Hash does take relatively long.
+
+```
+require 'ofac_sdn'
+
+sdn_hash = OfacSdn::Read.call
+```
+
+Check to see if there are any new updates in the date or record count from your last database insertion to avoid pulling the data again:
+
+```
+date  = OfacSdn::Read.publish_date 
+count = OfacSdn::Read.record_count
+```
+
+* How often is the Specially Designated Nationals (SDN) List updated? [OFAC FAQ](https://www.treasury.gov/resource-center/faqs/Sanctions/Pages/faq_lists.aspx)
+
+	* The SDN list is frequently updated. There is no predetermined timetable, but rather names are added or removed as necessary and appropriate.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/csebryam/ofac_sdn.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ofac_sdn"
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry-byebug"
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/ofac_sdn/document.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'open-uri'
+
+module OfacSdn
+  # OfacSdn::Document holds the XML OFAC document
+  class Document
+    def self.call
+      new.call
+    end
+    attr_reader :data_url, :xml_path
+
+    def initialize
+      @data_url = 'https://www.treasury.gov/ofac/downloads/sdn.xml'.freeze
+      @xml_path = open(data_url)
+    end
+
+    def call
+      Nokogiri::XML(xml_path)
+    end
+  end
+end

data/lib/ofac_sdn/parser.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module OfacSdn
+  # OfacSdn::Parser parses the XML document and returns a formatted hash
+  class Parser
+    def self.run(**kwargs)
+      new(**kwargs).call
+    end
+
+    attr_reader :document, :result, :xsd
+
+    def initialize(xsd:, document:)
+      @xsd = xsd
+      @document = document
+    end
+
+    def call
+      initialize_result_hash
+      build_hash_with('sdnList > sdnEntry')
+      result
+    end
+
+    private
+
+    def build_hash(sdn_entry)
+      result[:sdnEntry] << sdn_entry_hash(sdn_entry)
+      sdn_id = result[:sdnEntry].last[:id]
+      build_sdn_lists(sdn_entry, sdn_id)
+    end
+
+    def build_hash_with(search_css)
+      document.css(search_css).map do |sdn_entry|
+        build_hash(sdn_entry)
+      end
+    end
+
+    def build_sdn_list(table, sdn_entry, sdn_id)
+      element = set_element(table, sdn_entry)
+      return if element.empty?
+      element.each_with_object({}) do |k, h|
+        col_type = xsd[table][:element][k.name.to_sym]
+        next unless col_type
+        set_hash(h, k, col_type) unless k.nil?
+        h[:sdn_id] = sdn_id
+      end
+    end
+
+    def build_sdn_lists(sdn_entry, sdn_id)
+      xsd.each_key do |table|
+        next if table == :sdnEntry
+        table_hash = build_sdn_list(table, sdn_entry, sdn_id)
+        result[table] << table_hash unless table_hash.nil?
+      end
+    end
+
+    def initialize_result_hash
+      @result ||= xsd.keys.each_with_object({}) { |t, h| h[t] = [] }
+    end
+
+    def sdn_entry_hash(sdn_entry)
+      xsd[:sdnEntry][:element].each_with_object({}) do |(e, e_type), h|
+        element = sdn_entry.children.css(e).first
+        set_hash(h, element, e_type) unless element.nil?
+      end
+    end
+
+    def set_element(table, sdn_entry)
+      element = sdn_entry.css(table).children
+      element = element[1].children if xsd[table][:key] && !element.empty?
+      element
+    end
+
+    def set_hash(hash, element, column_type)
+      key = :id if element.name == 'uid'
+      key ||= element.name.to_sym
+      hash[key] = to_type(element.text, column_type)
+    end
+
+    def to_type(value, type)
+      case type
+      when 'int'
+        value.to_i
+      when 'bool'
+        return false if value == 'false'
+        true
+      else
+        value.to_s
+      end
+    end
+  end
+end

data/lib/ofac_sdn/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OfacSdn
+  VERSION = "0.1.1"
+end

data/lib/ofac_sdn/xsd.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module OfacSdn
+  # https://www.treasury.gov/resource-center/sanctions/SDN-List/Documents/sdn.xsd
+  XSD_HASH =
+    {
+      sdnEntry: {
+        element: {
+          uid: 'int',
+          firstName: 'string',
+          lastName: 'string',
+          title: 'string',
+          sdnType: 'string',
+          remarks: 'string'
+        }
+      },
+      programList: {
+        element: {
+          program: 'string'
+        }
+      },
+      idList: {
+        key: 'id',
+        element: {
+          uid: 'int',
+          idType: 'string',
+          idNumber: 'string',
+          idCountry: 'string',
+          issueDate: 'string',
+          expirationDate: 'string'
+        }
+      },
+      akaList: {
+        key: 'aka',
+        element: {
+          uid: 'int',
+          type: 'string',
+          category: 'string',
+          lastName: 'string',
+          firstName: 'string'
+        }
+      },
+      addressList: {
+        key: 'address',
+        element:
+        {
+          uid: 'int',
+          address1: 'string',
+          address2: 'string',
+          address3: 'string',
+          city: 'string',
+          stateOrProvince: 'string',
+          postalCode: 'string',
+          country: 'string'
+        }
+      },
+      nationalityList: {
+        key: 'nationality',
+        element: {
+          uid: 'int',
+          country: 'string',
+          mainEntry: 'bool'
+        }
+      },
+      citizenshipList: {
+        key: 'citizenship',
+        element: {
+          uid: 'int',
+          country: 'string',
+          mainEntry: 'bool'
+        }
+      },
+      dateOfBirthList: {
+        key: 'dateOfBirthItem',
+        element: {
+          uid: 'int',
+          dateOfBirth: 'string',
+          mainEntry: 'bool'
+        }
+      },
+      placeOfBirthList: {
+        key: 'placeOfBirthItem',
+        element: {
+          uid: 'int',
+          placeOfBirth: 'string',
+          mainEntry: 'bool'
+        }
+      },
+      vesselInfo: {
+        element: {
+          callSign: 'string',
+          vesselType: 'string',
+          vesselFlag: 'string',
+          vesselOwner: 'string',
+          tonnage: 'int',
+          grossRegisteredTonnage: 'int'
+        }
+      }
+    }.freeze
+end

data/lib/ofac_sdn.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'ofac_sdn/document'
+require 'ofac_sdn/parser'
+require 'ofac_sdn/version'
+require 'ofac_sdn/xsd'
+
+module OfacSdn
+  # OfacSdn::Read.new creates the SDN Hash document
+  class Read
+    class << self
+      def call
+        new.call(document)
+      end
+
+      def document
+        @document ||= Document.call
+      end
+
+      def publish_date
+        document.css('sdnList publshInformation Publish_Date').text
+      end
+
+      def record_count
+        document.css('sdnList publshInformation Record_Count').text.to_i
+      end
+    end
+
+    def call(document)
+      Parser.run(document: document, xsd: XSD_HASH)
+    end
+  end
+end

data/ofac_sdn.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ofac_sdn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ofac_sdn'
+  spec.version       = OfacSdn::VERSION
+  spec.authors       = ['Bryam Noguera']
+  spec.email         = ['bryam@primetrust.com']
+
+  spec.summary       = 'returns a hash for the ofac sdn.xml list'
+  spec.homepage      = 'https://github.com/csebryam/ofac-sdn'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.8.2'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: ofac_sdn
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Bryam Noguera
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+description: 
+email:
+- bryam@primetrust.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ofac_sdn.rb
+- lib/ofac_sdn/document.rb
+- lib/ofac_sdn/parser.rb
+- lib/ofac_sdn/version.rb
+- lib/ofac_sdn/xsd.rb
+- ofac_sdn.gemspec
+homepage: https://github.com/csebryam/ofac-sdn
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: returns a hash for the ofac sdn.xml list
+test_files: []