Ammitto

Ruby Gem

The Ammitto Ruby gem provides a simple interface for accessing sanctions data in your Ruby and Rails applications.

Installation

Gemfile
# Add to Gemfile
gem 'ammitto'

# Or install directly
gem install ammitto

Basic Usage

Basic Usage
require 'ammitto'

# Initialize client
client = Ammitto::Client.new

# Get all EU entities
eu_entities = client.entities(source: 'eu')

# Search entities
results = client.search('bin laden')

# Get statistics
stats = client.stats

puts "Total entities: #{stats[:total_entities]}"

# Iterate over entities
eu_entities.each do |entity|
  puts entity.primary_name
end

Rails Integration

Rails Configuration
# config/initializers/ammitto.rb
Ammitto.configure do |config|
  config.base_url = 'https://ammitto.github.io/api/v1'
  # Optional: Cache entities
  config.cache_enabled = true
  config.cache_ttl = 3600 # seconds
end

# Usage in a Rails model or service
class SanctionsChecker
  def initialize
    @client = Ammitto::Client.new
  end

  def check_name(name)
    results = @client.search(name)
    results.any?
  end
end

API Reference

MethodParametersDescription
client.entitiessource: (optional)Get all entities, optionally filtered by source
client.searchquery, (optional params)Search entities by name or keyword
client.entityidGet a specific entity by ID
client.statsnoneGet statistics about available data

Configuration Options

  • base_url - Base URL for the API (default: official API)
  • cache_enabled - Enable caching (default: true)
  • cache_ttl - Cache TTL in seconds (default: 3600)
  • timeout - Request timeout in seconds (default: 30)