import_export 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dac572ba1ce74703c74a6f337b7d8a143fcbe3a4
+  data.tar.gz: 15f193720338f0ab44563371c6cf53eb0525ae5a
+SHA512:
+  metadata.gz: 2ea81976a3ee0549e2c809be7be1d05d3251c74038d90163c2c173b5fe7afadd7c162bcdc629a571e7dd32ec602201383f1bcabf69dd978198caeb9b20f9f8d6
+  data.tar.gz: b606eccfb48acfc2292284f36954c65c38340845b392f5a5c328bd6b5f44f1992c77c23fcbb55653988db0d345d0d9ce7c42ebac94c10c08565cc317ac83d27a

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1
+script: "script/cibuild"
+sudo: false
+cache: bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in consolidated_screening_list.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ben Balter
+
+MIT License
+
+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,44 @@
+# ImportExport
+
+A Ruby client for [Trade.gov's Consolidated Screening List](http://developer.trade.gov/consolidated-screening-list.html)
+
+## Usage
+
+```irb
+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">,
+  ...
+]
+```
+
+### 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)
+* `api_key` (defaults to ENV["TRADE_API_KEY"])
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require './lib/import_export'
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["--order", "rand", "--color"]
+end

data/import_export.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'import_export/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "import_export"
+  spec.version       = ImportExport::VERSION
+  spec.authors       = ["Ben Balter"]
+  spec.email         = ["ben.balter@github.com"]
+  spec.summary       = "A Ruby client for Trade.gov's Consolidated Screening List"
+  spec.homepage      = "https://github.com/benbalter/impot_export"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dotenv", "~> 2.0"
+  spec.add_dependency "rest-client", "~> 1.8"
+  spec.add_dependency "iso_country_codes", "~> 0.7"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "webmock", "~> 1.2"
+end

data/lib/import_export.rb

@@ -0,0 +1,24 @@
+require 'iso_country_codes'
+require 'rest_client'
+require 'dotenv'
+require 'uri'
+require 'logger'
+require 'json'
+
+require "import_export/version"
+require "import_export/source"
+require "import_export/result"
+require "import_export/client"
+require "import_export/query"
+
+Dotenv.load
+RestClient.log = Logger.new(STDOUT) unless ENV["DEBUG"].to_s.empty?
+
+module ImportExport
+  
+  API_BASE = "https://api.trade.gov/consolidated_screening_list/"
+
+  def self.user_agent
+    "ImportExport/#{ImportExport::VERSION}; +https://github.com/benbalter/import_export)"
+  end
+end

data/lib/import_export/client.rb

@@ -0,0 +1,31 @@
+module ImportExport
+  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]
+    end
+
+    def api_key
+      @api_key || ENV["TRADE_API_KEY"]
+    end
+
+    def search(params = {})
+      params = { :api_key => api_key }.merge(params)
+      parse_response Query.new(params).call
+    end
+
+    private
+
+    def parse_response(response)
+      JSON.parse(response)["results"].map { |data| Result.new(data) }
+    end
+  end
+end

data/lib/import_export/query.rb

@@ -0,0 +1,66 @@
+module ImportExport
+  class Query
+
+    class << self
+      def countries
+        @countries ||= IsoCountryCodes.all.map { |c| c.alpha2 }
+      end
+
+      def endpoint
+        @endpoint ||= URI.join(ImportExport::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,
+      :api_key    => nil,
+    }
+
+    TYPES = %w[
+      Individual
+      Entity
+      Vessel
+    ]
+
+    def initialize(params)
+      params = { :q => params } if params.is_a? String
+      @params = PARAMETERS.merge(params)
+
+      if invalid = @params.find { |key,value| !PARAMETERS.keys.include?(key) }
+        raise ArgumentError, "Invalid parameter: #{invalid[0]}"
+      end
+
+      if invalid = @params[:sources].find { |source| !Source.find_by_key(source) }
+        raise ArgumentError, "Invalid source: #{invalid}"
+      end
+
+      if invalid = @params[:countries].find { |country| !Query.countries.include?(country) }
+        raise ArgumentError, "Invalid country: #{invalid}"
+      end
+    end
+
+    def call
+      RestClient.get Query.endpoint, {
+        :params => params,
+        "User-Agent" => ImportExport.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/import_export/result.rb

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

data/lib/import_export/source.rb

@@ -0,0 +1,51 @@
+module ImportExport
+  class Source
+
+    SOURCES = {
+      "DPL" => "Denied Persons List",
+      "EL"  => "Entity List",
+      "FSE" => "Foreign Sanctions Evaders",
+      "DTC" => "ITAR Debarred",
+      "ISA" => "Non-SDN Iranian Sanctions Act List",
+      "ISN" => "Nonproliferation Sanctions",
+      "PLC" => "Palestinian Legislative Council List",
+      "561" => "Part 561 List",
+      "SSI" => "Sectoral Sanctions Identifications List",
+      "SDN" => "Specially Designated Nationals",
+      "UVL" => "Unverified List"
+    }
+
+    class << self
+      def all
+        @all ||= SOURCES.map { |key, value| self.new(key) }
+      end
+
+      def find_by_key(key)
+        all.find { |source| source.key == key }
+      end
+      alias_method :[], :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
+      "#<ImportExport::Source key=\"#{key}\" name=\"#{name}\">"
+    end
+
+    def name
+      SOURCES[key]
+    end
+  end
+end

data/lib/import_export/version.rb

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

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+bundle install

data/script/cibuild

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+bundle exec rake spec

data/script/console

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+DEBUG=1 bundle exec pry -r ./lib/import_export.rb

data/script/release

@@ -0,0 +1,38 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Build a new gem archive.
+
+rm -rf import_export-*.gem
+gem build -q import_export.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls import_export-*.gem | sed 's/^import_export-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push import_export-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

data/spec/import_export_client_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe ImportExport::Client do
+  it "accepts an api key" do
+    client = ImportExport::Client.new :api_key => "foo"
+    expect(client.api_key).to eql("foo")
+  end
+
+  it "defaults to the env API key" do
+    with_env "TRADE_API_KEY", "foo2" do
+      expect(subject.api_key).to eql("foo2")
+    end
+  end
+
+  it "calls the API" do
+    stub = stub_request(:get, /https:\/\/api\.trade\.gov\/consolidated_screening_list\/search.*/).
+         to_return(:status => 200, :body => '{"results": [{"foo": "bar"}, {"foo2": "bar2"}]}')
+
+    search = subject.search :q => "smith"
+    expect(stub).to have_been_requested
+
+    expect(search.count).to eql(2)
+    expect(search.first.class).to eql(ImportExport::Result)
+    expect(search.first.foo).to eql("bar")
+  end
+end

data/spec/import_export_query_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe ImportExport::Query do
+  subject { ImportExport::Query.new :q => "smith" }
+
+  it "returns the country list" do
+    expect(ImportExport::Query.countries.count).to eql(249)
+    expect(ImportExport::Query.countries.first).to eql("AF")
+  end
+
+  it "builds the endpoint" do
+    expected = "https://api.trade.gov/consolidated_screening_list/search"
+    expect(ImportExport::Query.endpoint).to eql(expected)
+  end
+
+  it "accepts params as a hash" do
+    expect(subject.instance_variable_get("@params")[:q]).to eql("smith")
+  end
+
+  it "accepts params as a string" do
+    query = ImportExport::Query.new "smith"
+    expect(query.instance_variable_get("@params")[:q]).to eql("smith")
+  end
+
+  it "merges the default params" do
+    expect(subject.instance_variable_get("@params")[:offset]).to eql(0)
+  end
+
+  it "builds the param lists" do
+    expect(subject.send(:params)[:countries]).to match(/AF\,AX/)
+    expect(subject.send(:params)[:sources]).to match(/DPL\,EL/)
+  end
+
+  it "strips empty params " do
+    count = subject.send(:params).count { |k,v| v.nil? }
+    expect(count).to eql(0)
+  end
+
+  it "calls the API" do
+    json = '{"results": [{"foo": "bar"}]}'
+    stub = stub_request(:get, /https:\/\/api\.trade\.gov\/consolidated_screening_list\/search.*/).
+      to_return(:status => 200, :body => json)
+
+    expect(subject.call).to eql(json)
+    expect(stub).to have_been_requested
+  end
+end

data/spec/import_export_result_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ImportExport::Query do
+  subject { ImportExport::Result.new "foo" => "bar" }
+
+  it "stores the data" do
+    expect(subject.data["foo"]).to eql("bar")
+  end
+  
+  it "exposes properties as methods" do
+    expect(subject.foo).to eql("bar")
+  end
+end

data/spec/import_export_source_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe ImportExport::Source do
+
+  subject { ImportExport::Source.all.first }
+
+  it "returns all sources" do
+    expect(ImportExport::Source.all.count).to eql(11)
+  end
+
+  it "returns a source by key" do
+    source = ImportExport::Source.find_by_key(subject.key)
+    expect(source.key).to eql(subject.key)
+  end
+
+  it "returns a source by name" do
+    source = ImportExport::Source.find_by_name(subject.name)
+    expect(source.name).to eql(subject.name)
+  end
+
+  it "returns the keys" do
+    expect(ImportExport::Source.keys.count).to eql(11)
+    expect(ImportExport::Source.keys.first).to eql(subject.key)
+  end
+
+  it "returns the key" do
+    expect(subject.key).to eql("DPL")
+  end
+
+  it "returns the name" do
+    expect(subject.name).to eql("Denied Persons List")
+  end
+end

data/spec/import_export_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ImportExport do
+  it "returns the user agent" do
+    expect(subject.user_agent).to match(/ImportExport\/\d\.\d\.\d/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "bundler/setup"
+require 'webmock/rspec'
+require_relative "../lib/import_export"
+
+WebMock.disable_net_connect!
+
+def with_env(key, value)
+  old_env = ENV[key]
+  ENV[key] = value
+  yield
+  ENV[key] = old_env
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: import_export
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email:
+- ben.balter@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- import_export.gemspec
+- lib/import_export.rb
+- lib/import_export/client.rb
+- lib/import_export/query.rb
+- lib/import_export/result.rb
+- lib/import_export/source.rb
+- lib/import_export/version.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/release
+- spec/import_export_client_spec.rb
+- spec/import_export_query_spec.rb
+- spec/import_export_result_spec.rb
+- spec/import_export_source_spec.rb
+- spec/import_export_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/benbalter/impot_export
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A Ruby client for Trade.gov's Consolidated Screening List
+test_files:
+- spec/import_export_client_spec.rb
+- spec/import_export_query_spec.rb
+- spec/import_export_result_spec.rb
+- spec/import_export_source_spec.rb
+- spec/import_export_spec.rb
+- spec/spec_helper.rb