PeanutLabs

This is a helper library for PeanutLabs.com integration.

Currently features include:

• Building iframe for survey wall
• Building DirectLinks
• Whitelisting routes in rails

Documentation is here: http://peanut-labs.github.io/publisher-doc/index.html

Add this line to your application's Gemfile:

gem 'peanut_labs'

And then execute:

$ bundle

Or install it yourself as:

$ gem install peanut_labs

You need to provide you app_id and and app_key. Perfect place to do that in rails app is config/initialize/peanutlabs.rb file

PeanutLabs::Credentials.id = <YOUR APP ID>
PeanutLabs::Credentials.key = <YOUR KEY>

You would need callback in your app to receive response from peanutlabs. To do that securely, you need to whitelist your route in rails routes.rb file, like this:

require 'peanut_labs/whitelist'
post "callback/peanutlabs" => "callback#peanutlabs", constraints: PeanutLabs::Whitelist

Whitelist was taken from official documentation: http://peanut-labs.github.io/publisher-doc/index.html#ipwhitelist

PeanutLabs::Builder::IframeUrl.call(id: user.pid)

Possible attributes

• id: required, public user ID (highly recommended not to expose descending IDs in here)
• dob: not required, classes accepted - Date, DateTime, Time or formatted "MM-DD-YYYY" string
• sex: not required, 1 for male, 2 for female

PeanutLabs::Builder::DirectLink.call(user.pid, attributes = {})

Possible attributes (not required)

• payload: a hash with user data attributes for encryption
• sub_id: a secure session id. Will be returned during postback notification
• zl: survey language (for some reason, PN translates only interface but not questions)

Be a good lad and write specs, we love code we can rely on.

Bug reports and pull requests are welcome on GitHub at https://github.com/saberespoder/peanut_labs.

The gem is available as open source under the terms of the MIT License.