/planet_express

An intergalactic email delivery library to send Emails with Silverpop provider.

Primary LanguageRubyMIT LicenseMIT

Planet Express.rb

Description

Planet Express, Inc. is an intergalactic email delivery company lib built in Ruby. Is meant to be used with Silverpop mailing system, to provide an easy way to send emails. We're using it with Rails 3 apps.

"Our crew is replaceable. Your package email isn't."

Features

  • Send emails using Silverpop.

Examples

You only need three things, the package, the destination and the data. Then create a new deliver, prepare the ship and deliver it!

require 'planet_express'

recipient  = 'email@test.com'
package_id = 432524234
cargo      = { html_body_text: "<h1>Good news everyone!</h1><img src='http://goo.gl/XazeH'>" }

job = PlanetExpress::Delivery.new
request   = job.prepare package_id, recipient, cargo
response  = job.deliver!

Configuration

job.configure do |config|
  config.gateway_url = 'https://transact3.silverpop.com/XTMail'
end

Installation

Add this line to your application's Gemfile gem 'planet_express' and then execute bundle install. Or install it yourself as: gem install planet_express.

Silverpop API

Check this file: doc/silverpop_api.md

Build

do changes and update version.rb and CHANGELOG.

git commit & push

rake build; rake release;

Contributing

  1. Fork it
  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

Build

  1. Do changes.
  2. Increase the version.rb using http://semver.org/ pattern.
  3. Run specs
  4. Commit changes
  5. Release to RubyGems.org with rake release
  6. Fun

@MarioZaizar