houdini/gems/houdini_full_contact/README.md

30 lines
845 B
Markdown
Raw Normal View History

# FullContact
2020-06-22 20:41:32 +00:00
An Houdini add-on to use FullContact's Enrich API. This add-on provides a few features:
* a event listener for supporter_create which downloads information from the Enrich API.
* adds a has_many relation on Supporter for every set of data about that Supporter downloaded.
Each item is an instance of `Houdini::FullContact::Info`
## Usage
2020-06-22 20:41:32 +00:00
You can provide your FullContact API key in one of two ways:
* Setting the `FULL_CONTACT_KEY` environment variable or
* Setting the `houdini.full_contact.api_key` configuration option
## Installation
Add this line to your application's Gemfile:
```ruby
2020-06-11 18:28:02 +00:00
gem 'houdini_full_contact', path: 'gems/houdini_full_contact
```
And then execute:
```bash
$ bundle
```
2020-06-22 20:41:32 +00:00
And then install the database migrations for houdini_full_contact:
```bash
2020-06-22 20:41:32 +00:00
bin/rails houdini_full_contact:install:migrations
```