Sha256: 3aec1dbeefd3e25eb8605e5c148516c78c18c9f859ecafa74da80244ec67f89d

Contents?: true

Size: 1.66 KB

Versions: 6

Compression:

Stored size: 1.66 KB

Contents

Planet Express.rb
=================

Description
-----------

Planet Express, Inc. is an intergalactic email delivery <strike>company</strike>
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 <strike>package</strike> 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](./doc/silverpop_api.md)

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**

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
planet_express-0.1.5 README.md
planet_express-0.1.4 README.md
planet_express-0.1.3 README.md
planet_express-0.1.2 README.md
planet_express-0.1.1 README.md
planet_express-0.1.0 README.md