Contents

FullContact Ruby Gem
====================
A Ruby wrapper for the [FullContact API](http://www.fullcontact.com/)

Changes
-------

0.6.0 - Removal of timeoutSeconds parameter. This parameter is automatically stripped from your request if included.

Installation
------------
    gem install fullcontact

Documentation
-------------
[http://rdoc.info/gems/fullcontact](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: "[e-mail]")
    
    # Get information about a twitter handle
    person2 = FullContact.person(twitter: "brawest")

    # Get information about a facebook username
    person3 = FullContact.person(facebookUsername: "bart.lorang")
    
    # Get information from a phone number
    person4 = FullContact.person(phone:[phone])
    
    # 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)
- Stefano Fontanelli (stefanofontanelli)

Copyright
---------
Copyright (c) 2013 FullContact, Brandon West

See [LICENSE](https://github.com/brandonmwest/rainmaker/blob/master/LICENSE.md) for details.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
fullcontact-0.6.1	README.md