/fullcontact-api-ruby

Primary LanguageRubyMIT LicenseMIT

FullContact Ruby Gem

A Ruby wrapper for the FullContact API

Installation

gem install fullcontact

Documentation

http://rdoc.info/gems/fullcontact

Usage Examples

require "rubygems"
require "fullcontact"

# This could go in an initializer
FullContact.configure do |config|
	config.api_key = "fullcontact_api_key_goes_here"
end

# Get information about a email address
person = FullContact.person(email: "brawest@gmail.com")

# Get information about a twitter
person2 = FullContact.person(twitter: "brawest")

# Get information about a twitter and ensure a 30s socket open timeout and a 15s socket read timeout
# Can throw a Faraday::Error::TimeoutError if timeouts are exceeded
person3 = FullContact.person({:twitter => "brawest"}, {:request => {:timeout => 15, :open_timeout => 30}})

# Get person's family_name
puts person.contact_info.family_name

Contributions

  • Michael Rose (Xorlev)
  • Ian Fisher (i-taptera)
  • Scott Watermasysk (scottwater)

Copyright

Copyright (c) 2012 FullContact, Brandon West

See LICENSE for details.