Sha256: 3ff1a0ec82a37a0c44c509b80750d1f5eb12c1d0f6515e2fd1d5549ce91e7698

Contents?: true

Size: 1.27 KB

Versions: 3

Compression:

Stored size: 1.27 KB

Contents

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

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: "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](https://github.com/brandonmwest/rainmaker/blob/master/LICENSE.md) for details.

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
fullcontact-0.5.0 README.md
fullcontact-0.4.4 README.md
fullcontact-0.4.1 README.md