No commit activity in last 3 years
No release in over 3 years
The official OmniAuth strategy for authenticating with the Campaign Monitor API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.1
~> 13.0
~> 3.0
~> 3.8

Runtime

 Project Readme

OmniAuth CreateSend

This is the OmniAuth strategy for authenticating with the Campaign Monitor 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 to your Gemfile then bundle install.

gem "omniauth-createsend"

Basic Usage

In Rack applications:

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

In Rails applications:

Rails.application.config.middleware.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 Rack application which demonstrates how to authenticate with the Campaign Monitor API using this OmniAuth strategy.

Once you've authenticated, you should use the createsend gem to access Campaign Monitor resources.

Contributing

Please check the guidelines for contributing to this repository.

This stuff should be green

Build Status Gem Version