consolidated_screening_list 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e812e7200b3a2f450bc727a7895cd57ef8ffb4c23daba4181a4144cb60f9b76a
+  data.tar.gz: 3370598ff2ad9fbb030a147f970ea8e883c9846b0fe0a562ccf50f92a435857f
+SHA512:
+  metadata.gz: 0f51ca556ad96803506b9d431c5b62ff51588bb3716df43930a09511e73b417bc1649eb9b2d8bbf76ac42881a822f00e92523a1aad5610e71e96506e2a4a6de6
+  data.tar.gz: 6a4f46071510d3603c0c48c086c110141cbf0161025c871c71c41cbff29362170e65b6e5d0b6b2947e7454c75b42c968e8978e658bf2d7bfa79e9243cb039e5e

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrew Mason
+
+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,57 @@
+# ConsolidatedScreeningList
+
+A Ruby client for [Trade.gov's Consolidated Screening List](https://developer.trade.gov/consolidated-screening-list.html)
+
+## Usage
+
+```sh
+client = ImportExport::Client.new :api_key => "12345"
+client.search :q => "smith"
+=> [
+  #<ImportExport::Result name="PRIDMORE-SMITH, BRAMWELL J.">,
+  #<ImportExport::Result name="PRIDMORE-SMITH, JOHN B.">
+]
+
+client.search :name => "smith", :fuzzy_name => true
+=> [
+  #<ImportExport::Result name="PRIDMORE-SMITH, JOHN B.">,
+  #<ImportExport::Result name="PRIDMORE-SMITH, BRAMWELL J.">,
+  #<ImportExport::Result name="MID-SOUTH INVESTMENTS LIMITED">,
+  #<ImportExport::Result name="SOUTH-EAST MOVEMENT">,
+  ...
+]
+```
+
+NOTE: `api_key` defaults to `ENV["TRADE_API_KEY"]` if not specified.
+
+### Available parameters
+
+* `q`
+* `sources`
+* `countries` (defaults to all countries)
+* `address`
+* `name`
+* `fuzzy_name` (true or false)
+* `type`
+* `size` (number of results per page, defaults to 100)
+* `offset` (defaults to 0)
+
+For more information, see [the Consolidated Screening List API docs](https://developer.trade.gov/consolidated-screening-list.html).
+
+### Command line usage
+
+```sh
+import_export [NAME]
+```
+
+## Contributing
+
+1. [Fork it](https://github.com/andrewmcodes/consolidated_screening_list/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Attribution
+
+This gem was originally forked from [benbalter/import_export](https://github.com/benbalter/import_export).

data/lib/consolidated_screening_list.rb

@@ -0,0 +1,26 @@
+require "iso_country_codes"
+require "rest_client"
+require "dotenv"
+require "uri"
+require "logger"
+require "json"
+require "uuid"
+
+require "consolidated_screening_list/version"
+require "consolidated_screening_list/source"
+require "consolidated_screening_list/result"
+require "consolidated_screening_list/client"
+require "consolidated_screening_list/query"
+
+Dotenv.load
+RestClient.log = STDOUT unless ENV["DEBUG"].to_s.empty?
+
+module ConsolidatedScreeningList
+  class Error < StandardError; end
+
+  API_BASE = "https://api.trade.gov/gateway/v1/consolidated_screening_list/".freeze
+
+  def self.user_agent
+    "ConsolidatedScreeningList/#{ConsolidatedScreeningList::VERSION}; +https://github.com/andrewmcodes/consolidated_screening_list)"
+  end
+end

data/lib/consolidated_screening_list/client.rb

@@ -0,0 +1,25 @@
+module ConsolidatedScreeningList
+  class Client
+    class << self
+      def search(options = {})
+        Client.new.search(options)
+      end
+    end
+
+    attr_reader :api_key
+
+    def initialize(options = {})
+      @api_key = options[:api_key] || ENV["TRADE_API_KEY"]
+    end
+
+    def search(params = {})
+      parse_response Query.new(params, api_key).call
+    end
+
+    private
+
+    def parse_response(response)
+      JSON.parse(response)["results"].map { |data| Result.new(data) }
+    end
+  end
+end

data/lib/consolidated_screening_list/query.rb

@@ -0,0 +1,62 @@
+module ConsolidatedScreeningList
+  class Query
+    class << self
+      def countries
+        @countries ||= IsoCountryCodes.all.map { |c| c.alpha2 }
+      end
+
+      def endpoint
+        @endpoint ||= URI.join(ConsolidatedScreeningList::API_BASE, "search").to_s
+      end
+    end
+
+    PARAMETERS = {
+      q: nil,
+      sources: Source.keys,
+      countries: Query.countries,
+      address: nil,
+      name: nil,
+      fuzzy_name: false,
+      type: nil,
+      size: 100,
+      offset: 0,
+    }
+
+    TYPES = %w[
+      Individual
+      Entity
+      Vessel
+    ]
+
+    def initialize(params, api_key)
+      params = {q: params} if params.is_a? String
+      @params = PARAMETERS.merge(params)
+      @api_key = api_key
+      invalid_parameter = @params.find { |key, value| !PARAMETERS.key?(key) }
+      invalid_source = @params[:sources].find { |source| !Source.find_by_key(source) }
+      invalid_country = @params[:countries].find { |country| !Query.countries.include?(country) }
+      invalid_api_key = !UUID.validate(api_key)
+      raise ArgumentError, "Invalid parameter: #{invalid[0]}" if invalid_parameter
+      raise ArgumentError, "Invalid source: #{invalid}" if invalid_source
+      raise ArgumentError, "Invalid country: #{invalid}" if invalid_country
+      raise ArgumentError, "Invalid API key: #{invalid}" if invalid_api_key
+    end
+
+    def call
+      RestClient.get Query.endpoint, {
+        :params => params,
+        "Authorization" => "Bearer #{@api_key}",
+        "User-Agent" => ConsolidatedScreeningList.user_agent,
+      }
+    end
+
+    private
+
+    def params
+      params = @params.clone
+      params[:countries] = params[:countries].join(",")
+      params[:sources] = params[:sources].join(",")
+      params.reject { |k, v| v.nil? }
+    end
+  end
+end

data/lib/consolidated_screening_list/result.rb

@@ -0,0 +1,29 @@
+module ConsolidatedScreeningList
+  class Result
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def inspect
+      "#<ConsolidatedScreeningList::Result name=\"#{name}\">"
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      if data.key?(method_name.to_s)
+        data[method_name.to_s]
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      if data.key?(method_name.to_s)
+        true
+      else
+        super
+      end
+    end
+  end
+end

data/lib/consolidated_screening_list/source.rb

@@ -0,0 +1,51 @@
+module ConsolidatedScreeningList
+  class Source
+    SOURCES = {
+      "CAP" => "Correspondent Account or Payable-Through Account Sanctions (CAPTA)",
+      "DPL" => "Denied Persons List",
+      "DTC" => "ITAR Debarred",
+      "EL" => "Entity List",
+      "FSE" => "Foreign Sanctions Evaders",
+      "ISN" => "Nonproliferation Sanctions",
+      "PIB" => "Persons Identified as Blocked",
+      "PLC" => "Palestinian Legislative Council List",
+      "SDN" => "Specially Designated Nationals",
+      "SSI" => "Sectoral Sanctions Identifications List",
+      "UVL" => "Unverified List",
+      "561" => "Part 561 List",
+    }.freeze
+
+    class << self
+      def all
+        @all ||= SOURCES.map { |key, value| new(key) }
+      end
+
+      def find_by_key(key)
+        all.find { |source| source.key == key }
+      end
+      alias [] find_by_key
+
+      def find_by_name(name)
+        all.find { |source| source.name == name }
+      end
+
+      def keys
+        @keys ||= SOURCES.keys
+      end
+    end
+
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    def inspect
+      "#<ConsolidatedScreeningList::Source key=\"#{key}\" name=\"#{name}\">"
+    end
+
+    def name
+      SOURCES[key]
+    end
+  end
+end

data/lib/consolidated_screening_list/version.rb

@@ -0,0 +1,3 @@
+module ConsolidatedScreeningList
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: consolidated_screening_list
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Mason
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: iso_country_codes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: A Ruby client for Trade.gov's Consolidated Screening List.
+email:
+- andrewmcodes@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/consolidated_screening_list.rb
+- lib/consolidated_screening_list/client.rb
+- lib/consolidated_screening_list/query.rb
+- lib/consolidated_screening_list/result.rb
+- lib/consolidated_screening_list/source.rb
+- lib/consolidated_screening_list/version.rb
+homepage: https://github.com/andrewmcodes/consolidated_screening_list
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/andrewmcodes/consolidated_screening_list/issues
+  homepage_uri: https://github.com/andrewmcodes/consolidated_screening_list
+  source_code_uri: https://github.com/andrewmcodes/consolidated_screening_list
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Ruby client for Trade.gov's Consolidated Screening List.
+test_files: []