Ruby Gem

# Add to Gemfile
gem 'ammitto'

# Or install directly
gem install ammitto

require 'ammitto'

# Search every source. Returns an Ammitto::Search::ResultSet.
results = Ammitto.search('bin laden')

# Narrow it: :sources, :limit and :offset are the options search accepts
eu_results = Ammitto.search('bin laden', sources: [:eu], limit: 25)

puts "Found #{results.size} of #{results.total_count}"

# Entries are entity objects. display_name is the string; primary_name
# returns a NameVariant, which is rarely what you want to print.
results.each do |entity|
  puts "#{entity.entity_type}: #{entity.display_name}"
end

# The set can slice itself without a second query
vessels = results.by_entity_type('vessel')
puts results.entity_types.inspect

# Which sources exist, and what is cached locally
puts Ammitto.sources.inspect
puts Ammitto.cache_status.inspect

# Refresh the local cache (~/.ammitto by default)
Ammitto.refresh_cache

# config/initializers/ammitto.rb
Ammitto.configure do |config|
  # Set this to the host that serves the API. Whatever you point it at
  # must answer directly: the client does not follow redirects, so a
  # host that 301s fails every download.
  config.api_base_url = 'https://www.ammitto.org/api/v1'
  config.cache_dir    = Rails.root.join('tmp', 'ammitto').to_s
  config.cache_ttl    = 3600 # seconds
end

# Usage in a Rails model or service
class SanctionsChecker
  def check_name(name)
    Ammitto.search(name, limit: 1).any?
  end

  def matches_for(name)
    Ammitto.search(name).map do |entity|
      { name: entity.display_name, type: entity.entity_type }
    end
  end
end