postageapp 1.0.24 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 137d68c70e3e36a0ffa2d4701477ff1e264b4550
+  data.tar.gz: 847c08f7a96c8eb75f4decd3ab54b0bf1beedc65
+SHA512:
+  metadata.gz: f5130b3ceddd00f85e15e1823adf766c2727415aff2d77673a2dceaa2bc770bb08abe34da1cdb9a0ee18af1a811d96018c25945eabad95f1001ee61b2ad22343
+  data.tar.gz: 2b44293bf9bf5eee65de1855c18645bd4992c3c7420175540da99c50209844cf0bba498986d0b7681ce08337db881a7497e0065880cb31535419e37fdc307d7e

data/.travis.yml

@@ -1,23 +1,24 @@
 language: ruby
+before_install: gem install bundler
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - ree
-  - 2.0.0
+  - 1.9.3-p551
+  - 2.0.0-p598
+  - 2.1.5
+  - 2.2.0
 gemfile:
+  - test/gemfiles/Gemfile.ruby
   - test/gemfiles/Gemfile.rails-2.3.x
   - test/gemfiles/Gemfile.rails-3.0.x
   - test/gemfiles/Gemfile.rails-3.1.x
   - test/gemfiles/Gemfile.rails-3.2.x
   - test/gemfiles/Gemfile.rails-4.0.x
+  - test/gemfiles/Gemfile.rails-4.1.x
+  - test/gemfiles/Gemfile.rails-4.2.x
 matrix:
   exclude:
-    - rvm: 2.0.0
+    - rvm: 2.0.0-p598
+      gemfile: test/gemfiles/Gemfile.rails-2.3.x
+    - rvm: 2.1.5
+      gemfile: test/gemfiles/Gemfile.rails-2.3.x
+    - rvm: 2.2.0
       gemfile: test/gemfiles/Gemfile.rails-2.3.x
-    - rvm: 1.8.7
-      gemfile: test/gemfiles/Gemfile.rails-4.0.x
-    - rvm: ree
-      gemfile: test/gemfiles/Gemfile.rails-4.0.x
-    - rvm: 1.9.2
-      gemfile: test/gemfiles/Gemfile.rails-4.0.x

data/Gemfile

@@ -2,8 +2,13 @@ source 'http://rubygems.org'
 
 gemspec
 
-group :test do
+gem 'mail', '>= 2.4.0'
+
+group :development do
+  gem 'rake'
+  gem 'jeweler'
   gem 'minitest'
+  gem 'minitest-reporters'
   gem 'rails'
   gem 'mocha'
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2014 Oleg Khabarov, The Working Group, Inc
+Copyright (c) 2011-2015 Scott Tadman, Oleg Khabarov, The Working Group, Inc
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,15 +1,27 @@
 # [PostageApp](http://postageapp.com) Ruby Gem [![Build Status](https://secure.travis-ci.org/postageapp/postageapp-ruby.png)](http://travis-ci.org/postageapp/postageapp-ruby)
 
-This is the gem used to integrate Ruby apps with PostageApp service.
-Personalized, mass email sending can be offloaded to PostageApp via JSON based API.
+This gem is used to integrate Ruby apps with [PostageApp](http://postageapp.com/)
+service. Personalized high-volume email sending can be offloaded to PostageApp
+via a simple [JSON-based API](http://dev.postageapp.com/api.html).
 
-### [API Documentation](http://help.postageapp.com/kb/api/api-overview) • [Knowledge Base](http://help.postageapp.com/kb) • [Help Portal](http://help.postageapp.com)
+### [API Documentation](http://help.postageapp.com/kb/api/api-overview) • [Knowledge Base](http://help.postageapp.com/kb) • [Help Portal](http://help.postageapp.com/)
 
-Installation
-------------
+# Installation
 
-### Rails 3 / 4
-Add postageapp gem to your Gemfile:
+### Rails 4.x
+
+Add the `postageapp` gem to your Gemfile:
+
+    gem 'postageapp'
+
+Then from the Rails project's root run:
+
+    bundle install
+    bin/rails generate postageapp --api-key PROJECT_API_KEY
+
+### Rails 3.x
+
+Add the `postageapp` gem to your Gemfile:
 
     gem 'postageapp'
 
@@ -18,8 +30,9 @@ Then from the Rails project's root run:
     bundle install
     script/rails generate postageapp --api-key PROJECT_API_KEY
 
-### Rails 2
-In config/environment.rb add the following:
+### Rails 2.x
+
+In `config/environment.rb` add the following:
 
     config.gem 'postageapp'
 
@@ -30,11 +43,12 @@ Then from the Rails project's root run:
     script/generate postageapp --api-key PROJECT_API_KEY
 
 ### Sinatra / Rack / Others
+
 You'll need to install the gem first:
 
     $ sudo gem install postageapp
 
-And then it's as simple as doing something like this:
+The configuration will need to be loaded before executing any API calls:
 
 ```ruby
 require 'postageapp'
@@ -44,26 +58,35 @@ PostageApp.configure do |config|
 end
 ```
 
-Usage
------
+If it's more convenient, setting the `POSTAGEAPP_API_KEY` environment variable
+with the appropriate API key will also work.
+
+# Usage
+
 Here's an example of sending a message ([See full API documentation](http://help.postageapp.com/faqs/api/send_message)):
 
 ```ruby
-request = PostageApp::Request.new(:send_message, {
-  'headers'     => { 'from'     => 'sender@example.com',
-                     'subject'  => 'Email Subject' },
-  'recipients'  => 'recipient@example.com',
-  'content'     => {
-    'text/plain'  => 'text email content',
-    'text/html'   => 'html email content'
-  },
-  'attachments' => {
-    'document.pdf' => {
-      'content_type'  => 'application/pdf',
-      'content'       => Base64.encode64(File.open('/path/to/document.pdf', 'rb').read)
+request = PostageApp::Request.new(
+  :send_message,
+  {
+    headers: {
+      from: 'sender@example.com',
+      subject: 'Email Subject'
+    },
+    recipients: 'recipient@example.com',
+    content: {
+      'text/plain' => 'text email content',
+      'text/html' => 'html email content'
+    },
+    attachments: {
+      'document.pdf' => {
+        content_type: application/pdf',
+        content: Base64.encode64(File.open('/path/to/document.pdf', 'rb').read)
+      }
     }
   }
-})
+)
+
 response = request.send
 ```
 
@@ -85,26 +108,44 @@ Response usually comes back with data:
     => { 'message' => { 'id' => '12345' }}
 
 ### Recipient Override
-Sometimes you don't want to send emails to real people in your application. For that there's an ability to override to what address all emails will be delivered. All you need to do is modify configuration block like this (in Rails projects it's usually found in `RAILS_ROOT/config/initializers/postageapp.rb`):
+
+Sometimes you don't want to send emails to real people in your application. For
+that there's an ability to override to what address all emails will be
+delivered. All you need to do is modify configuration block like this (in Rails
+projects it's usually found in `RAILS_ROOT/config/initializers/postageapp.rb`):
 
 ```ruby
 PostageApp.configure do |config|
-  config.api_key            = 'PROJECT_API_KEY'
-  config.recipient_override = 'you@example.com' unless Rails.env.production?
+  config.api_key = 'PROJECT_API_KEY'
+
+  unless (Rails.env.production?)
+    config.recipient_override = 'you@example.com'
+  end
 end
 ```
 
-ActionMailer Integration
-------------------------
-You can quickly convert your existing mailers to use PostageApp service by simply changing `class MyMailer < ActionMailer::Base` to `class MyMailer < PostageApp::Mailer`.  If you using ActionMailer from outside of Rails make sure you have this line somewhere: `require 'postageapp/mailer'`
+# ActionMailer Integration
 
-There are custom methods that allow setting of `template` and `variables` parts of the API call. They are `postageapp_template` and `postageapp_variables`. Examples how they are used are below. For details what they do please see [documentation](http://help.postageapp.com/faqs)
+You can quickly convert your existing mailers to use PostageApp service by
+simply changing `class MyMailer < ActionMailer::Base` to
+`class MyMailer < PostageApp::Mailer`. When using ActionMailer from outside
+of Rails, this will have to be loaded manually:
 
-Please note that `deliver` method will return `PostageApp::Response` object. This way you can immediately check the status of the delivery. For example:
+```ruby
+require 'postageapp/mailer'
+```
 
-    >> response = UserMailer.welcome_email(@user).deliver
-    >> response.ok?
-    => true
+There are custom methods that allow setting of `template` and `variables` parts
+of the API call. They are `postageapp_template` and `postageapp_variables`.
+Examples how they are used are below. For details what they do please see
+[documentation](http://help.postageapp.com/faqs)
+
+Please note that `deliver` method will return `PostageApp::Response` object.
+This way you can immediately check the status of the delivery. For example:
+
+    response = UserMailer.welcome_email(@user).deliver
+    response.ok?
+    # => true
 
 ### Rails 3 / 4
 
@@ -114,9 +155,7 @@ Here's an example of a mailer in Rails 3 environment:
 require 'postageapp/mailer'
 
 class Notifier < PostageApp::Mailer
-
   def signup_notification
-
     attachments['example.zip'] = File.read('/path/to/example.zip')
 
     headers['Special-Header'] = 'SpecialValue'
@@ -130,44 +169,49 @@ class Notifier < PostageApp::Mailer
 
     # You can manually specify uid for the message payload.
     # Make sure it's sufficiently unique.
-    postageapp_uid Digest::SHA1.hexdigest([@user.id, Time.now].to_s)
+    postageapp_uid Digest::SHA1.hexdigest([ @user.id, Time.now ].to_s)
 
     mail(
-      :from     => 'test@test.test',
-      :subject  => 'Test Message',
-      :to       => {
+      from: 'test@test.test',
+      subject: 'Test Message',
+      to: {
         'recipient_1@example.com' => { 'variable' => 'value' },
         'recipient_2@example.com' => { 'variable' => 'value' }
-      })
+      }
+    )
   end
 end
 ```
 
-API of previous ActionMailer is partially supported under Rails 3 environment. Please note that it's not 100% integrated, some methods/syntax will not work. You may still define you mailers in this way (but really shouldn't):
+API of previous ActionMailer is partially supported under Rails 3 environment.
+Please note that it's not 100% integrated, some methods/syntax will not work.
+You may still define you mailers in this way (but really shouldn't):
 
 ```ruby
 require 'postageapp/mailer'
 
 class Notifier < PostageApp::Mailer
-
   def signup_notification
-    from        'sender@example.com'
-    subject     'Test Email'
-    recipients  'recipient@example.com'
+    from 'sender@example.com'
+    subject 'Test Email'
+    recipients 'recipient@example.com'
   end
 end
 ```
 
 #### Interceptors
 
-Here's an example of using an interceptor
+Here's an example of using an interceptor:
 
 ```ruby
 class DevelopmentPostageappInterceptor
   def self.delivering_email(postageapp_msg)
     postageapp_msg.arguments["headers"][:subject] =
       "[#{postageapp_msg.arguments["recipients"]}] #{postageapp_msg.arguments["headers"][:subject]}"
+
     postageapp_msg.arguments["recipients"] = "test@example.com"
+
+    # Deliveries can be disabled if required
     # postageapp_msg.perform_deliveries = false
   end
 end
@@ -182,36 +226,44 @@ require 'postageapp/mailer'
 
 class Notifier < PostageApp::Mailer
   def signup_notification
-
-    from        'system@example.com'
-    subject     'New Account Information'
+    from 'system@example.com'
+    subject 'New Account Information'
 
     # Recipients can be in any format API allows.
     # Here's an example of a hash format
-    recipients  ({
-      'recipient_1@example.com' => { 'variable_name_1' => 'value',
-                                     'variable_name_2' => 'value' },
-      'recipient_2@example.com' => { 'variable_name_1' => 'value',
-                                     'variable_name_2' => 'value' },
-    })
-
-    attachment  :content_type => 'application/zip',
-                :filename     => 'example.zip',
-                :body         => File.read('/path/to/example.zip')
+    recipients(
+      'recipient_1@example.com' => {
+        'variable_name_1' => 'value',
+        'variable_name_2' => 'value'
+      },
+      'recipient_2@example.com' => {
+        'variable_name_1' => 'value',
+        'variable_name_2' => 'value'
+      },
+    )
+
+    attachment(
+      :content_type => 'application/zip',
+      :filename => 'example.zip',
+      :body => File.read('/path/to/example.zip'
+    )
 
     # PostageApp specific elements:
     postageapp_template 'example_template'
     postageapp_variables 'global_variable' => 'value'
-
   end
 end
 ```
 
-Automatic resending in case of failure
---------------------------------------
-For those ultra rare occasions when api.postageapp.com is not reachable this gem will temporarily store requests and then will attempt to resend them with the next successful connection. In Rails environment it will create a folder: `RAILS_ROOT/tmp/postageapp_failed_requests` and save all failed requests there. On successful resend file for that request will be deleted.
+# Automatic resending in case of failure
 
-For projects other than Rails you'll need to tell where there project_root is at:
+For those rare occasions when the API is not reachable or unresponsive,
+this gem will temporarily store requests and then will attempt to resend them
+with the next successful connection. In Rails environment it will create a
+folder: `RAILS_ROOT/tmp/postageapp_failed_requests` and save all failed
+requests there. On successful resend file for that request will be deleted.
+
+For projects other than Rails you'll need to tell where the `project_root` is:
 
 ```ruby
 PostageApp.configure do |config|
@@ -220,6 +272,6 @@ PostageApp.configure do |config|
 end
 ```
 
-Copyright
----------
-(C) 2011-2014 Oleg Khabarov, [The Working Group, Inc](http://www.twg.ca/)
+# Copyright
+
+(C) 2011-2015 Scott Tadman, Oleg Khabarov, [The Working Group, Inc](http://www.twg.ca/)

data/Rakefile

@@ -1,7 +1,6 @@
-require 'bundler'
-require 'rake/testtask'
+require 'bundler/setup'
 
-Bundler.require
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -9,4 +8,20 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-task :default => :test
+namespace :travis do
+  desc "Run tests across different environments, simulating Travis"
+  task :test do
+    require File.expand_path('test/travis_test', File.dirname(__FILE__))
+
+    TravisTest.run!
+  end
+
+  desc "Report on which versions of Ruby are installed"
+  task :versions do
+    require File.expand_path('test/travis_test', File.dirname(__FILE__))
+
+    TravisTest.validate_ruby_versions!
+  end
+end
+
+task :default => :test

data/generators/postageapp/postageapp_generator.rb

@@ -7,7 +7,6 @@ end
 
 # Rails 2 Generator
 class PostageappGenerator < Rails::Generator::Base
-  
   def add_options!(opt)
     opt.on('-k=key', '--api-key=key') do |value|
       options[:api_key] = value
@@ -15,20 +14,19 @@ class PostageappGenerator < Rails::Generator::Base
   end
   
   def manifest
-    if !options[:api_key]
+    unless (options[:api_key])
       puts 'Must pass --api-key with API key of your PostageApp.com project'
       exit
     end
     
     record do |m|
       m.template 'initializer.rb', 'config/initializers/postageapp.rb', 
-        :assigns    => { :api_key => options[:api_key] },
-        :collision  => :force
+        :assigns => { :api_key => options[:api_key] },
+        :collision => :force
       m.directory 'lib/tasks'
       m.file 'postageapp_tasks.rake', 'lib/tasks/postageapp_tasks.rake',
-        :collision  => :force
+        :collision => :force
       m.rake 'postageapp:test'
     end
   end
-  
-end
+end

data/lib/generators/postageapp/postageapp_generator.rb

@@ -2,26 +2,32 @@ require 'rails/generators'
 
 # Rails 3 Generator
 class PostageappGenerator < Rails::Generators::Base
-  
-  class_option :api_key, :aliases => ['-k=value', '--api-key=value'], :type => :string, :desc => 'Your PostageApp API key'
+  class_option :api_key,
+    :aliases => [ '-k=value', '--api-key=value' ],
+    :type => :string,
+    :desc => 'Your PostageApp API key'
   
   def self.source_root
-    @_hoptoad_source_root ||= File.expand_path('../../../../generators/postageapp/templates', __FILE__)
+    @_hoptoad_source_root ||= File.expand_path(
+      '../../../../generators/postageapp/templates',
+      __FILE__
+    )
   end
   
   def install
-    if !options[:api_key]
+    unless (options[:api_key])
       puts 'Must pass --api-key with API key of your PostageApp.com project'
-      exit
+
+      exit(-1)
     end
     
-    template 'initializer.rb', 'config/initializers/postageapp.rb'
-    copy_file 'postageapp_tasks.rake', 'lib/tasks/postageapp_tasks.rake'
+    template('initializer.rb', 'config/initializers/postageapp.rb')
+    copy_file('postageapp_tasks.rake', 'lib/tasks/postageapp_tasks.rake')
+
     puts run('rake postageapp:test')
   end
   
   def api_key
     options[:api_key]
   end
-  
-end
+end