Project

kickboxer

0.0
No commit activity in last 3 years
No release in over 3 years
Kickboxer
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 0
>= 0
 Project Readme

Kickboxer

Kickboxer is a wrapper around the FullContact API

Installation

Add this line to your application's Gemfile:

gem 'kickboxer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kickboxer

Usage

The Full Contact API requires an API key. Register for a free key at https://www.fullcontact.com/sign-up/. Once you receive your key, you can configure Kickboxer to use it via:

Kickboxer.api_key = '01234decafbad'

The following API endpoints are implemented:

  • Person
    • lookup (by email, phone number, twitter username, or facebook username)
  • User (TODO)
  • Contact List (TODO)
  • Contact (TODO)
  • Snapshot (TODO)
  • Subscription (TODO)
  • Name
    • normalize
    • deduce
    • similarity
    • stats
    • parser
  • Icon (TODO)
  • Provisioning (TODO)
  • Batch Process (TODO)

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request