ConsolidatedScreeningList

A Ruby client for Trade.gov's Consolidated Screening List

This gem was originally forked from benbalter/import_export.

Adding to a gem:

# my-cool-gem.gemspec
Gem::Specification.new do |spec|
  # ...
  spec.add_dependency "consolidated_screening_list", "~> 0.0.2"
  # ...
end

Or adding to your project:

# Gemfile
gem "consolidated_screening_list", "~> 0.0.2"

• Ruby (MRI) >= 2.3.0

⚠️ These are incomplete

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">,
  ...
]

• 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.

consolidated_screening_list [NAME]

Bug reports and pull requests are welcome on GitHub at https://github.com/andrewmcodes/consolidated_screening_list.

This project will be following Coventional Commits v1.0.0 moving forward.

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Valid types:

• build
• ci
• chore
• docs
• feat
• fix
• perf
• refactor
• revert
• style
• test

The gem is available as open source under the terms of the MIT License.