postageapp 1.0.17 → 1.0.18

data/.travis.yml

@@ -1,8 +1,15 @@
 rvm:
   - 1.8.7
   - 1.9.2
+  - 1.9.3
   - ree
+  - 2.0.0
 gemfile:
   - 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.1.x
+  - test/gemfiles/Gemfile.rails-3.2.x
+matrix:
+  exclude:
+    - rvm: 2.0.0
+      gemfile: test/gemfiles/Gemfile.rails-2.3.x

data/README.md

@@ -36,32 +36,36 @@ You'll need to install the gem first:
     
 And then it's as simple as doing something like this:
     
-    require 'postageapp'
-    
-    PostageApp.configure do |config|
-      config.api_key = 'PROJECT_API_KEY'
-    end
+```ruby
+require 'postageapp'
+
+PostageApp.configure do |config|
+  config.api_key = 'PROJECT_API_KEY'
+end
+```
 
 Usage
 -----
 Here's an example of sending a message ([See full API documentation](http://help.postageapp.com/faqs/api/send_message)):
   
-    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
+```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)
+    }
+  }
+})
+response = request.send
+```
   
 `PostageApp::Response` object allows you to check the status:
   
@@ -83,10 +87,12 @@ Response usually comes back with data:
 ### 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`):
 
-    PostageApp.configure do |config|
-      config.api_key            = 'PROJECT_API_KEY'
-      config.recipient_override = 'you@example.com' unless Rails.env.production?
-    end
+```ruby
+PostageApp.configure do |config|
+  config.api_key            = 'PROJECT_API_KEY'
+  config.recipient_override = 'you@example.com' unless Rails.env.production?
+end
+```
 
 ActionMailer Integration
 ------------------------
@@ -104,74 +110,87 @@ Please note that `deliver` method will return `PostageApp::Response` object. Thi
 
 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'
-        
-        # PostageApp specific elements:
-        postageapp_template 'example_template'
-        postageapp_variables 'global_variable' => 'value'
-        
-        mail(
-          :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):
+```ruby
+require 'postageapp/mailer'
+
+class Notifier < PostageApp::Mailer
 
-    require 'postageapp/mailer'
+  def signup_notification
     
-    class Notifier < PostageApp::Mailer
+    attachments['example.zip'] = File.read('/path/to/example.zip')
     
-      def signup_notification
-        from        'sender@example.com'
-        subject     'Test Email'
-        recipients  'recipient@example.com'
-      end
-    end
+    headers['Special-Header'] = 'SpecialValue'
+    
+    # PostageApp specific elements:
+    postageapp_template 'example_template'
+    postageapp_variables 'global_variable' => 'value'
+    
+    # You may set api key for a specific mailers
+    postageapp_api_key '123456abcde'
+    
+    # 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)
+    
+    mail(
+      :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):
+
+```ruby
+require 'postageapp/mailer'
+
+class Notifier < PostageApp::Mailer
+
+  def signup_notification
+    from        'sender@example.com'
+    subject     'Test Email'
+    recipients  'recipient@example.com'
+  end
+end
+```
 
 ### Rails 2.x
 
 Here's an example of a mailer you'd set in in a Rails 2 environment:
+
+```ruby
+require 'postageapp/mailer'
+
+class Notifier < PostageApp::Mailer
+  def signup_notification
+    
+    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')
+    
+    # PostageApp specific elements:
+    postageapp_template 'example_template'
+    postageapp_variables 'global_variable' => 'value'
     
-    require 'postageapp/mailer'
-    
-    class Notifier < PostageApp::Mailer
-      def signup_notification
-        
-        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')
-        
-        # PostageApp specific elements:
-        postageapp_template 'example_template'
-        postageapp_variables 'global_variable' => 'value'
-        
-      end
-    end
+  end
+end
+```
     
 Automatic resending in case of failure
 --------------------------------------
@@ -179,11 +198,13 @@ For those ultra rare occasions when api.postageapp.com is not reachable this gem
 
 For projects other than Rails you'll need to tell where there project_root is at:
   
-    PostageApp.configure do |config|
-      config.api_key      = 'PROJECT_API_KEY'
-      config.project_root = "/path/to/your/project"
-    end
+```ruby
+PostageApp.configure do |config|
+  config.api_key      = 'PROJECT_API_KEY'
+  config.project_root = "/path/to/your/project"
+end
+```
 
 Copyright
 ---------
-(C) 2011 Oleg Khabarov, [The Working Group, Inc](http://www.twg.ca/)
+(C) 2011-13 Oleg Khabarov, [The Working Group, Inc](http://www.twg.ca/)

data/VERSION

@@ -1 +1 @@
-1.0.17
+1.0.18

data/lib/postageapp/mailer/mailer_2.rb

@@ -29,9 +29,10 @@ class PostageApp::Mailer < ActionMailer::Base
   # Using :test as a delivery method if set somewhere else
   self.delivery_method = :postage unless (self.delivery_method == :test)
   
+  adv_attr_accessor :postageapp_uid
+  adv_attr_accessor :postageapp_api_key
   adv_attr_accessor :postageapp_template
   adv_attr_accessor :postageapp_variables
-  adv_attr_accessor :postageapp_api_key
   
   def perform_delivery_postage(mail)
     mail.send
@@ -72,15 +73,17 @@ class PostageApp::Mailer < ActionMailer::Base
       end
     end
     
-    params['template'] = self.postageapp_template unless self.postageapp_template.blank?
+    params['template']  = self.postageapp_template  unless self.postageapp_template.blank?
     params['variables'] = self.postageapp_variables unless self.postageapp_variables.blank?
-    params['api_key'] = self.postageapp_api_key unless self.postageapp_api_key.blank?
     
     params.delete('headers')     if params['headers'].blank?
     params.delete('content')     if params['content'].blank?
     params.delete('attachments') if params['attachments'].blank?
     
-    @mail = PostageApp::Request.new(:send_message, params)
+    @mail = PostageApp::Request.new('send_message', params)
+    @mail.uid     = self.postageapp_uid     unless self.postageapp_uid.blank?
+    @mail.api_key = self.postageapp_api_key unless self.postageapp_api_key.blank?
+    @mail
   end
   
   # Not insisting rendering a view if it's not there. PostageApp gem can send blank content

data/lib/postageapp/mailer/mailer_3.rb

@@ -64,6 +64,15 @@ class PostageApp::Mailer < ActionMailer::Base
     process(method_name, *args) if method_name
   end
   
+  # Possible to define custom uid. Should be sufficiently unique
+  def postageapp_uid(value = nil)
+    value ? @_message.uid = value : @_message.uid
+  end
+  
+  def postageapp_api_key(value = nil)
+    value ? @_message.api_key = value : @_message.api_key
+  end
+  
   # In API call we can specify PostageApp template that will be used
   # to generate content of the message
   def postageapp_template(value = nil)
@@ -75,10 +84,6 @@ class PostageApp::Mailer < ActionMailer::Base
     value ? @_message.arguments['variables'] = value : @_message.arguments['variables']
   end
   
-  def postageapp_api_key(value = nil)
-    value ? @_message.arguments['api_key'] = value : @_message.arguments['api_key']
-  end
-  
   def attachments
     @_attachments ||= Attachments.new(@_message)
   end

data/lib/postageapp/request.rb

@@ -22,8 +22,8 @@ class PostageApp::Request
   
   def initialize(method, arguments = {})
     @method     = method
-    @uid        = arguments.delete(:uid)
-    @api_key    = arguments.delete(:api_key) || PostageApp.configuration.api_key
+    @uid        = arguments.delete('uid')
+    @api_key    = arguments.delete('api_key') || PostageApp.configuration.api_key
     @arguments  = arguments
   end
   

data/postageapp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "postageapp"
-  s.version = "1.0.17"
+  s.version = "1.0.18"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oleg Khabarov, The Working Group Inc"]
-  s.date = "2012-12-20"
+  s.date = "2013-03-07"
   s.description = "Gem that interfaces with PostageApp.com service to send emails from web apps"
   s.email = "oleg@twg.ca"
   s.extra_rdoc_files = [
@@ -47,6 +47,7 @@ Gem::Specification.new do |s|
     "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/helper.rb",
     "test/live_test.rb",
     "test/mailer/action_mailer_2/notifier.rb",

data/test/gemfiles/Gemfile.rails-2.3.x

@@ -7,6 +7,6 @@ group :development do
 end
 
 group :test do
-  gem 'rails', '2.3.14'
+  gem 'rails', '~> 2.3.0'
   gem 'mocha'
 end

data/test/gemfiles/Gemfile.rails-3.0.x

@@ -7,6 +7,6 @@ group :development do
 end
 
 group :test do
-  gem 'rails', '3.0.10'
+  gem 'rails', '~> 3.0.0'
   gem 'mocha'
 end

data/test/gemfiles/Gemfile.rails-3.1.x

@@ -7,6 +7,6 @@ group :development do
 end
 
 group :test do
-  gem 'rails', '3.1.0'
+  gem 'rails', '~> 3.1.0'
   gem 'mocha'
 end

data/test/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gem 'json'
+
+group :development do
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'rails', '~> 3.2.0'
+  gem 'mocha'
+end

data/test/mailer/action_mailer_2/notifier.rb

@@ -42,6 +42,11 @@ class Notifier < PostageApp::Mailer
   end
   
   def with_custom_postage_variables
+    postageapp_template   'test-template'
+    postageapp_variables  'variable' => 'value'
+    postageapp_uid        'custom_uid'
+    postageapp_api_key    'custom_api_key'
+    
     from    'test@test.test'
     subject 'Test Email'
     
@@ -49,9 +54,6 @@ class Notifier < PostageApp::Mailer
       'test1@test.text' => { 'name' => 'Test 1' },
       'test2@test.text' => { 'name' => 'Test 2' }
     })
-    postageapp_template 'test-template'
-    postageapp_variables 'variable' => 'value'
-    postageapp_api_key 'custom_api_key'
   end
   
 private

data/test/mailer/action_mailer_3/notifier.rb

@@ -47,9 +47,10 @@ class Notifier < PostageApp::Mailer
     headers['CustomHeader1'] = 'CustomValue1'
     headers 'CustomHeader2' => 'CustomValue2'
     
-    postageapp_template 'test-template'
-    postageapp_variables 'variable' => 'value'
-    postageapp_api_key 'custom_api_key'
+    postageapp_template   'test-template'
+    postageapp_variables  'variable' => 'value'
+    postageapp_api_key    'custom_api_key'
+    postageapp_uid        'custom_uid'
     
     mail(
       :from     => 'test@test.test',

data/test/mailer_2_test.rb

@@ -10,7 +10,7 @@ class Mailer2Test < Test::Unit::TestCase
         
     def test_create_blank
       assert mail = Notifier.create_blank
-      assert_equal :send_message, mail.method
+      assert_equal 'send_message', mail.method
       assert_equal 'https://api.postageapp.com/v.1.0/send_message.json', mail.url.to_s
       assert mail.arguments.blank?
     end
@@ -67,8 +67,9 @@ class Mailer2Test < Test::Unit::TestCase
     
     def test_create_with_custom_postage_variables
       assert mail = Notifier.create_with_custom_postage_variables
+      assert_equal 'custom_uid', mail.uid
+      assert_equal 'custom_api_key', mail.api_key
       assert_equal 'test-template', mail.arguments['template']
-      assert_equal 'custom_api_key', mail.arguments['api_key']
       assert_equal ({ 'variable' => 'value' }), mail.arguments['variables']
       assert_equal ({ 'test2@test.text' => { 'name' => 'Test 2'}, 
                       'test1@test.text' => { 'name' => 'Test 1'}}), mail.arguments['recipients']

data/test/mailer_3_test.rb

@@ -53,17 +53,24 @@ class Mailer3Test < Test::Unit::TestCase
     
     def test_create_with_custom_postage_variables
       mail = Notifier.with_custom_postage_variables
+      args = mail.arguments_to_send
+      
+      assert_equal 'custom_uid',      args['uid']
+      assert_equal 'custom_api_key',  args['api_key']
+      
+      args = args['arguments']
+      
       assert_equal ({
         'test1@test.test' => { 'name' => 'Test 1'},
         'test2@test.test' => { 'name' => 'Test 2'}
-      }), mail.arguments['recipients']
-      assert_equal 'test-template',             mail.arguments['template']
-      assert_equal ({ 'variable' => 'value' }), mail.arguments['variables']
-      assert_equal 'custom_api_key',            mail.arguments['api_key']
-      assert_equal 'CustomValue1',              mail.arguments['headers']['CustomHeader1']
-      assert_equal 'CustomValue2',              mail.arguments['headers']['CustomHeader2']
-      assert_equal 'text content',              mail.arguments['content']['text/plain']
-      assert_equal 'with layout html content',  mail.arguments['content']['text/html']
+      }), args['recipients']
+      
+      assert_equal 'test-template',             args['template']
+      assert_equal ({ 'variable' => 'value' }), args['variables']
+      assert_equal 'CustomValue1',              args['headers']['CustomHeader1']
+      assert_equal 'CustomValue2',              args['headers']['CustomHeader2']
+      assert_equal 'text content',              args['content']['text/plain']
+      assert_equal 'with layout html content',  args['content']['text/html']
     end
     
     def test_create_with_recipient_override

data/test/request_test.rb

@@ -3,7 +3,7 @@ require File.expand_path('../helper', __FILE__)
 class RequestTest < Test::Unit::TestCase
   
   def test_method_uid
-    request = PostageApp::Request.new(:test_method)
+    request = PostageApp::Request.new('test_method')
     uid = request.uid
     assert_match /^\w{40}$/, uid
     assert_equal uid, request.uid
@@ -11,20 +11,20 @@ class RequestTest < Test::Unit::TestCase
   end
   
   def test_method_url
-    request = PostageApp::Request.new(:test_method)
+    request = PostageApp::Request.new('test_method')
     assert_equal 'api.postageapp.com',      request.url.host
     assert_equal 443,                       request.url.port
     assert_equal '/v.1.0/test_method.json', request.url.path
   end
   
   def test_method_arguments_to_send
-    request = PostageApp::Request.new(:send_message, {
-      :headers      => { :from      => 'sender@test.test',
-                         'subject'  => 'Test Message' },
+    request = PostageApp::Request.new('send_message', {
+      'headers'     => { 'from'      => 'sender@test.test',
+                          'subject'   => 'Test Message' },
       'recipients'  => 'test@test.test',
-      :content      => {
+      'content'     => {
         'text/plain'  => 'text content',
-        :"text/html"  => 'html content'
+        'text/html'   => 'html content'
       }
     })
     args = request.arguments_to_send
@@ -46,33 +46,33 @@ class RequestTest < Test::Unit::TestCase
   end
   
   def test_uid_is_enforceable
-    request = PostageApp::Request.new(:test_method)
+    request = PostageApp::Request.new('test_method')
     assert_match /^\w{40}$/, request.arguments_to_send['uid']
     
     request.uid = 'my_uid'
     assert_equal 'my_uid', request.arguments_to_send['uid']
     
-    request = PostageApp::Request.new(:test_method, :uid => 'new_uid', :data => 'value')
+    request = PostageApp::Request.new('test_method', 'uid' => 'new_uid', 'data' => 'value')
     assert_equal 'new_uid', request.uid
-    assert_equal ({:data => 'value'}), request.arguments
+    assert_equal ({'data' => 'value'}), request.arguments
   end
   
   def test_api_key
-    request = PostageApp::Request.new(:test_method)
+    request = PostageApp::Request.new('test_method')
     assert_equal PostageApp.configuration.api_key, request.api_key
     
-    request = PostageApp::Request.new(:test_method, {:api_key => 'custom_api_key'})
+    request = PostageApp::Request.new('test_method', {'api_key' => 'custom_api_key'})
     assert_equal 'custom_api_key', request.api_key
   end
   
   def test_send
     mock_successful_send
     
-    request = PostageApp::Request.new(:send_message, {
-      :headers    => { 'from'     => 'sender@test.test',
-                       'subject'  => 'Test Message'},
-      :recipients => 'test@test.test',
-      :content    => {
+    request = PostageApp::Request.new('send_message', {
+      'headers'     => {  'from'     => 'sender@test.test',
+                          'subject'  => 'Test Message'},
+      'recipients'  => 'test@test.test',
+      'content'     => {
         'text/plain'  => 'text content',
         'text/html'   => 'html content'
       }
@@ -86,11 +86,11 @@ class RequestTest < Test::Unit::TestCase
   def test_send_failure
     mock_failed_send
     
-    request = PostageApp::Request.new(:send_message, {
-      :headers    => { 'from'     => 'sender@test.test',
-                       'subject'  => 'Test Message'},
-      :recipients => 'test@test.test',
-      :content    => {
+    request = PostageApp::Request.new('send_message', {
+      'headers'     => {  'from'     => 'sender@test.test',
+                          'subject'  => 'Test Message'},
+      'recipients'  => 'test@test.test',
+      'content'     => {
         'text/plain'  => 'text content',
         'text/html'   => 'html content'
       }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postageapp
 version: !ruby/object:Gem::Version
-  version: 1.0.17
+  version: 1.0.18
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2013-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -82,6 +82,7 @@ files:
 - 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/helper.rb
 - test/live_test.rb
 - test/mailer/action_mailer_2/notifier.rb
@@ -124,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3558677056440120512
+      hash: -4042654405162661992
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: