Sha256: 09255ae720e993b1c32932bf11c2238b833f6b6147d7292ada370db5a6013a7d

Contents?: true

Size: 1.17 KB

Versions: 1

Compression:

Stored size: 1.17 KB

Contents

# OmniAuth CreateSend

This is the official [OmniAuth](http://www.omniauth.org/) strategy for authenticating with the [Campaign Monitor API](http://www.campaignmonitor.com/api/). You'll need to register an OAuth Application in your Campaign Monitor account to get a Client ID and Client Secret to use with this OmniAuth strategy.

## Installing

Add a dependency in your `Gemfile`:

```ruby
gem 'omniauth-createsend'
```

Then `bundle install`.

## Basic Usage

```ruby
use OmniAuth::Builder do
  provider "createsend", ENV['CREATESEND_CLIENT_ID'], ENV['CREATESEND_CLIENT_SECRET'], :scope => 'ViewReports,CreateCampaigns,SendCampaigns'
end
```

This gem also includes an [example](https://github.com/campaignmonitor/omniauth-createsend/tree/master/example) Rack application which demonstrates how to authenticate with the Campaign Monitor API using this OmniAuth strategy.

## Contributing
1. Fork the repository
2. Make your changes, including tests for your changes.
3. Ensure that the build passes, by running `bundle exec rake` (CI runs on: `1.9.3`, `1.9.2`, `1.8.7` and `ree`)
4. It should go without saying, but do not increment the version number in your commits.
5. Submit a pull request.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
omniauth-createsend-1.0.0 README.md