dilisense_pep_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 273fac377fd26f38c2114fb2064c9be039ae46fd5c76208ae2a2f052d576a31b
+  data.tar.gz: a05d1cc25e0862acdba9d5cd23735dd83a835e9ba7a4f214f4a757b20623ce39
+SHA512:
+  metadata.gz: 11845d5f7f5a7d727b6c8a189f6148dc7801cb9d274966e0204fe990f63f8e4367df338c9cfc861a055287498fc96d2557a0629c6a1e56999a93c1c54505407c
+  data.tar.gz: 88b14710b78f2b46a2e12a0a98d22238d29e7b0065b3e06e318eb5da00fa7f57ac2e5fdf0f1cb6e59c6c1304b6949b0587e913ad41c002e67be02a835fb32a3d

data/.env.example

@@ -0,0 +1,2 @@
+# Copy this file to .env and add your actual API key
+DILISENSE_API_KEY=your_api_key_here

data/CLAUDE.md

@@ -0,0 +1,141 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is a Ruby gem client library for the Dilisense Screening API, specifically for PEP (Politically Exposed Persons) screening. The gem is owned by Sorbeet Payments OU and licensed under MIT.
+
+## Development Setup
+
+```bash
+# Install dependencies
+bundle install
+
+# Copy environment file and add your API key
+cp .env.example .env
+# Edit .env and add your Dilisense API key
+```
+
+## Development Commands
+
+```bash
+# Run tests
+bundle exec rake test
+
+# Run linter
+bundle exec rubocop
+
+# Run both tests and linting
+bundle exec rake ci
+
+# Build gem
+gem build dilisense_pep_client.gemspec
+
+# Console for testing
+bundle console
+```
+
+## Usage
+
+```ruby
+require 'dilisense_pep_client'
+
+# Configure with API key (or set DILISENSE_API_KEY environment variable)
+DilisensePepClient.configure do |config|
+  config.api_key = 'your_api_key'
+end
+
+# Check individual - returns array with one element per unique person
+result = DilisensePepClient.check_individual(
+  names: "Mari Kask",
+  dob: "15/03/1985",
+  gender: "female"
+)
+# => [] (empty array if no matches)
+
+result = DilisensePepClient.check_individual(names: "Donald Trump")
+# => [
+#   {
+#     name: "Donald Trump Jr.",
+#     source_type: "PEP", 
+#     pep_type: "RELATIVES_AND_CLOSE_ASSOCIATES",
+#     sources: ["dilisense_pep"],
+#     total_records: 1
+#   },
+#   {
+#     name: "Donald Trump",
+#     source_type: "PEP",
+#     pep_type: "POLITICIAN", 
+#     sources: ["dilisense_pep"],
+#     total_records: 2
+#   }
+# ]
+
+# Check entity - also returns array with one element per unique entity
+result = DilisensePepClient.check_entity(names: "ACME Corp")
+# => [] (empty array if no matches)
+
+result = DilisensePepClient.check_entity(names: "Gazprom")
+# => [
+#   {
+#     name: "Gazprom",
+#     source_type: "SANCTION",
+#     jurisdiction: ["RU"],
+#     address: ["Russia"],
+#     sanction_details: ["Subject to sanctions"],
+#     sources: ["us_department_of_treasury_sdn"],
+#     total_records: 1
+#   }
+# ]
+
+# Entity with fuzzy search
+result = DilisensePepClient.check_entity(names: "Gasprom", fuzzy_search: 1)
+```
+
+## Response Format
+
+Both `check_individual` and `check_entity` return an **array** where each element represents a unique person/entity:
+
+### Individual Response
+```ruby
+[
+  {
+    name: "Person Name",              # Primary name
+    source_type: "PEP",              # PEP, SANCTION, CRIMINAL
+    pep_type: "POLITICIAN",          # Only for PEP records
+    gender: "MALE",                  # MALE, FEMALE, UNKNOWN
+    date_of_birth: ["07/10/1952"],   # Array of DOBs
+    citizenship: ["RU"],             # Array of citizenships
+    sources: ["source1", "source2"], # All sources where found
+    total_records: 16,               # Number of raw records
+    raw_records: [...]               # All original API records
+  }
+]
+```
+
+### Entity Response
+```ruby
+[
+  {
+    name: "Company Name",            # Primary entity name
+    source_type: "SANCTION",        # PEP, SANCTION, CRIMINAL
+    pep_type: "STATE_OWNED_ENTERPRISE", # Only for PEP entities
+    jurisdiction: ["RU"],           # Array of jurisdictions
+    address: ["Moscow, Russia"],    # Array of addresses
+    sanction_details: ["Reason"],   # Array of sanction details
+    sources: ["source1", "source2"], # All sources where found
+    total_records: 3,               # Number of raw records
+    raw_records: [...]              # All original API records
+  }
+]
+```
+
+## Implementation Notes
+
+- API key authentication using `x-api-key` header
+- GET requests with query parameters
+- JSON responses with timestamp, total_hits, and found_records
+- Error handling for 400, 401, 403, 500 status codes
+- Uses Faraday for HTTP requests
+- Minimal dependencies (only Faraday)

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sorbeet Payments OU
+
+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/Makefile

@@ -0,0 +1,98 @@
+# Makefile for dilisense_pep_client Ruby gem
+# 
+# This Makefile provides convenient commands for development, testing, and maintenance
+# of the Dilisense PEP/sanctions screening Ruby client library.
+#
+# The gem includes both unit tests (no external dependencies) and integration tests
+# that make real API calls to the Dilisense service. API key must be configured
+# in .env file for integration tests to work properly.
+
+.PHONY: test individual_test unit_test test_fuzzy entity_test install lint ci clean help
+
+# Default target - show available commands
+help:
+	@echo "Dilisense PEP Client - Available Make Commands:"
+	@echo ""
+	@echo "Testing Commands:"
+	@echo "  test           - Run all tests (unit + integration with 2-second delays)"
+	@echo "  individual_test - Run individual screening tests with real API calls"
+	@echo "  unit_test      - Run unit tests only (no external API calls required)"
+	@echo "  test_fuzzy     - Run fuzzy search integration tests with real API calls"
+	@echo "  entity_test    - Run entity screening tests with real API calls"
+	@echo ""
+	@echo "Development Commands:"
+	@echo "  install        - Install Ruby gem dependencies via Bundler"
+	@echo "  lint           - Run RuboCop code style linter and formatter"
+	@echo "  ci             - Run continuous integration suite (tests + linting)"
+	@echo "  clean          - Remove generated coverage reports and temporary files"
+	@echo ""
+	@echo "Requirements:"
+	@echo "  - Ruby 2.7+ with Bundler installed"
+	@echo "  - Valid Dilisense API key in .env file for integration tests"
+	@echo "  - Internet connection for API-based tests"
+
+# Install Ruby gem dependencies via Bundler
+# This will install all gems specified in the Gemfile including development dependencies
+install:
+	@echo "Installing Ruby gem dependencies..."
+	bundle install
+	@echo "Dependencies installed successfully!"
+
+# Run all tests with rate limit protection (2-second delays between tests)
+# Includes both unit tests and integration tests with real API calls
+test:
+	@echo "Running comprehensive test suite with rate limiting..."
+	bundle exec rake test
+
+# Run individual screening integration tests with real API calls
+# Tests person-based PEP screening functionality against live Dilisense API
+individual_test:
+	@echo "Running individual screening integration tests..."
+	@echo "Testing names: Vladimir Putin, Xi Jinping, Joe Biden..."
+	bundle exec ruby -Ilib:test test/test_integration.rb
+	@echo "Individual screening tests completed!"
+
+# Run unit tests only - no external API calls required
+# These tests use mocks and stubs to verify internal logic without network dependencies
+unit_test:
+	@echo "Running unit tests (no API calls)..."
+	bundle exec ruby -Ilib:test test/test_client.rb test/test_dilisense_pep_client.rb
+	@echo "Unit tests completed!"
+
+# Run fuzzy search integration tests with real API calls
+# Tests fuzzy matching capabilities for names with variations and typos
+test_fuzzy:
+	@echo "Running fuzzy search integration tests..."
+	@echo "Testing fuzzy matching for: Vladmir Putin (typo), Xi Jin Ping (spacing)..."
+	bundle exec ruby -Ilib:test test/test_fuzzy.rb
+	@echo "Fuzzy search tests completed!"
+
+# Run entity screening integration tests with real API calls
+# Tests company/organization screening against sanctions and watchlists
+entity_test:
+	@echo "Running entity screening integration tests..."
+	@echo "Testing entities: Bank Rossiya, Gazprom, sanctioned organizations..."
+	bundle exec ruby -Ilib:test test/test_entity.rb
+	@echo "Entity screening tests completed!"
+
+# Run RuboCop linter to check code style and formatting
+# Enforces Ruby style guide and identifies potential issues
+lint:
+	@echo "Running RuboCop code style linter..."
+	bundle exec rubocop
+	@echo "Linting completed!"
+
+# Run continuous integration suite (tests + linting)
+# Comprehensive check suitable for CI/CD pipelines
+ci:
+	@echo "Running CI suite (tests + linting)..."
+	bundle exec rake ci
+	@echo "CI suite completed!"
+
+# Clean generated files and coverage reports
+# Removes temporary files created during testing and development
+clean:
+	@echo "Cleaning generated files..."
+	rm -rf coverage/
+	rm -rf tmp/
+	@echo "Cleanup completed!"