Sign up for a SparkPost account and visit our Developer Hub for even more content.

SparkPost Ruby API Client

Travis CI Coverage Status

The official Ruby client library for Sparkpost

Installation

Add this line to your application's Gemfile:

gem 'sparkpost'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sparkpost

Usage

Check examples/transmission.rb

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( http://github.com/ruby-sparkpost/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request