sorbet-hibp

gem 'sorbet-hibp'

require 'haveibeenpwned'

client = HaveIBeenPwned::Client.new(
  api_key: 'your-api-key-here',
  user_agent: 'MyApp/1.0'
)

breaches = client.breached_account('test@example.com')
# => [{"Name"=>"Adobe"}, {"Name"=>"LinkedIn"}]

# Get full breach data
breaches = client.breached_account('test@example.com', truncate_response: false)

# Filter by domain
breaches = client.breached_account('test@example.com', domain: 'adobe.com')

# Exclude unverified breaches
breaches = client.breached_account('test@example.com', include_unverified: false)

# Requires domain verification in your HIBP dashboard
breached = client.breached_domain('example.com')
# => {"alias1"=>["Adobe"], "alias2"=>["Adobe", "LinkedIn"]}

all_breaches = client.breaches
# => [{"Name"=>"Adobe", "Title"=>"Adobe", ...}, ...]

# Filter by domain
adobe_breaches = client.breaches(domain: 'adobe.com')

# Filter spam lists
spam_lists = client.breaches(is_spam_list: true)

breach = client.breach('Adobe')
# => {"Name"=>"Adobe", "Title"=>"Adobe", "Domain"=>"adobe.com", ...}

latest = client.latest_breach
# => {"Name"=>"...", "AddedDate"=>"2025-01-15T10:30:00Z", ...}

classes = client.data_classes
# => ["Account balances", "Email addresses", "Passwords", ...]

domains = client.subscribed_domains
# => [{"DomainName"=>"example.com", "PwnCount"=>150, ...}]

domains = client.stealer_logs_by_email('user@example.com')
# => ["netflix.com", "spotify.com"]

emails = client.stealer_logs_by_website_domain('netflix.com')
# => ["user1@gmail.com", "user2@yahoo.com"]

aliases = client.stealer_logs_by_email_domain('example.com')
# => {"user1"=>["netflix.com"], "user2"=>["spotify.com", "netflix.com"]}

pastes = client.pastes('test@example.com')
# => [{"Source"=>"Pastebin", "Id"=>"8Q0BvKD8", "Title"=>"syslog", ...}]

status = client.subscription_status
# => {"SubscriptionName"=>"Pwned 3", "Rpm"=>100, ...}

count = HaveIBeenPwned::PwnedPasswords.check('password123')
# => 123456 (number of times this password appears in breaches)

# If password not found
count = HaveIBeenPwned::PwnedPasswords.check('very-unique-password-xyz')
# => 0

count = HaveIBeenPwned::PwnedPasswords.check('password123', padding: true)

hash = '5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8' # SHA-1 of 'password'
count = HaveIBeenPwned::PwnedPasswords.check_hash(hash)
# => 123456

# Get all hash suffixes for a prefix
results = HaveIBeenPwned::PwnedPasswords.range_search('5BAA6')
# => "1E4C9B93F3F0682250B6CF8331B7EE68FD8:123456\n..."

begin
  breaches = client.breached_account('test@example.com')
rescue HaveIBeenPwned::NotFoundError
  puts "Account not found in any breaches"
rescue HaveIBeenPwned::UnauthorizedError
  puts "Invalid API key"
rescue HaveIBeenPwned::ForbiddenError
  puts "Missing or invalid user agent"
rescue HaveIBeenPwned::RateLimitError => e
  puts "Rate limit exceeded. Retry after #{e.retry_after} seconds"
rescue HaveIBeenPwned::BadRequestError => e
  puts "Bad request: #{e.message}"
rescue HaveIBeenPwned::ServiceUnavailableError
  puts "Service temporarily unavailable"
rescue HaveIBeenPwned::Error => e
  puts "Unexpected error: #{e.message}"
end

client = HaveIBeenPwned::Client.new(
  api_key: '00000000000000000000000000000000',
  user_agent: 'Testing'
)

# Test account that exists in breaches
breaches = client.breached_account('account-exists@hibp-integration-tests.com')

# Test account with spam list only
spam = client.breached_account('spam-list-only@hibp-integration-tests.com')

# Test account with stealer logs
logs = client.breached_account('stealer-log@hibp-integration-tests.com')

begin
  breaches = client.breached_account('test@example.com')
rescue HaveIBeenPwned::RateLimitError => e
  sleep e.retry_after
  retry
end