# ExpressPigeon

# ExpressPigeon [![TravisCI](https://secure.travis-ci.org/just3ws/express_pigeon-rb.png?branch=master)](http://travis-ci.org/just3ws/express_pigeon-rb) [![Gemnasium](https://gemnasium.com/just3ws/express_pigeon-rb.png)](https://gemnasium.com/just3ws/express_pigeon-rb)

Library to interact with ExpressPigeon email service.

## Pre-requisites

1. Go to [Express Pigeon](http://expresspigeon.com)
2. Sign up for a free account
3. Create a Contact List
4. Create a Web Form for the contact list
5. Enable all the fields
6. Take note of the guid generated for the web form.

## Installation

Add this line to your application's Gemfile:

    gem 'express_pigeon'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install express_pigeon

## Usage

TODO: Write usage instructions here

## 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


# Email Fields

    +---------------+--------------+
    | Field         | Type         |
    +---------------+--------------+
    | address1      | varchar(255) |
    | address2      | varchar(255) |
    | city          | varchar(128) |
    | company       | varchar(128) |
    | country       | varchar(128) |
    | date_of_birth | varchar(255) |
    | email         | varchar(50)  | # likely upgraded to 100
    | email_format  | varchar(20)  |
    | first_name    | varchar(50)  |
    | last_name     | varchar(50)  |
    | phone         | varchar(30)  |
    | state         | varchar(48)  |
    | title         | varchar(30)  |
    | zip           | varchar(24)  |
    +---------------+--------------+


## Form Data

view-source:https://expresspigeon.com/subscription/form/51697971-48b4-45d3-ab80-3b23152999ed

- submits to

    <form action="/subscription/add_contact" method="post" id="subscribe_form" class="form-add clearer"

- company name?

    <title just3ws, llc - subscription</title

- Web form name

    <h2 express_pigeon.rb</h2

- Web form title

    <h2 Sign-up for our newsletters.</h2

- Subtitle

    <h4 This is optional text for the form. You may use it to further entice your audience to subscribe</h4

- Form Fields

    input type="hidden" name="guid" value="51697971-48b4-45d3-ab80-3b23152999ed"

    input id="address1" name="address1"
    input id="address2" name="address2"
    input id="city" name="city"
    input id="company" name="company"
    input id="country" name="country"
    input id="date_of_birth" name="date_of_birth"
    input id="email" name="email"
    input id="first_name" name="first_name"
    input id="last_name" name="last_name"
    input id="phone" name="phone"
    input id="state" name="state"
    input id="title" name="title"
    input id="zip" name="zip"

    label for="address1" Group Address 1
    label for="address2" Group Address 2
    label for="city" Group City
    label for="company" Group Name
    label for="country" Group Website
    label for="date_of_birth" Group Twitter Name
    label for="email" Your Email
    label for="first_name" Your First Name
    label for="last_name" Your Last Name
    label for="phone" Group Management Site
    label for="state" Group State
    label for="title" Your Role In Group
    label for="zip" Group Zip


- Submit simple form via cURL

    curl -v -d "guid=51697971-48b4-45d3-ab80-3b23152999ed&email=mdh@just3ws.com"