Promoter API Ruby Client

Unofficial Ruby client for the [Promoter API].

Installation

Add gem 'promoter', github: 'advocately/promoter-ruby' to your application's Gemfile, and then run bundle to install.

Configuration

To get started, you need to configure the client with your secret API key. If you're using Rails, you should add the following to new initializer file in config/initializers/promoter.rb.

require 'promoter'
Promoter.api_key = 'YOUR_API_KEY'

For further options, read the advanced configuration section.

Note: Your API key is secret, and you should treat it like a password. You can find your API key in your Promoter account, under Settings > Integrations > API Keys.

Retrieving a survey response:

# Retrieve an existing survey response
survey_response3 = Promoter::Feedback.retrieve('123')

Listing survey responses:

# List all survey responses
survey_responses = Promoter::Feddback.all({
  page: 3
})

Advanced configuration & testing

The following options are configurable for the client:

Promoter.api_key
Promoter.app_id
Promoter.http_adapter # default: Promoter::HTTPAdapter.new

By default, a shared instance of Promoter::Client is created lazily in Promoter.shared_client. If you want to create your own client, perhaps for test or if you have multiple API keys, you can:

# Create an custom client instance, and pass as last argument to resource actions
client = Promoter::Client.new(:api_key => 'API_KEY')
metrics_from_custom_client = Promoter::Feddback.retrieve({}, client)

# Or, you can set Promoter.shared_client yourself
Promoter.shared_client = Promoter::Client.new(:api_key => 'API_KEY')
metrics_from_custom_shared_client = Promoter::Feddback.retrieve

Supported runtimes

• Ruby MRI (1.8.7+)
• JRuby (1.8 + 1.9 modes)
• RBX (2.1.1)
• REE (1.8.7-2012.02)

Contributing

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