postageapp 1.0.22 → 1.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6380fa116f59e249ad1fce5897f34d160708caef
-  data.tar.gz: 87c9ee3959cc3d6f1b2b68a22b74e8367dfa89b5
+  metadata.gz: e4ce66fba6cb35602ebc6afe19498db5cdedb98f
+  data.tar.gz: 7bd2753935e216bce6283cf62f5c4bcc5c9a1885
 SHA512:
-  metadata.gz: 280c702bde5cd63bf66c9b05fd8beac698cf9e2ad201416bc1ee542e122048d971ddf0b0c4aaf1b4bc512a874e4b1f9b6910253af8eab413486ef128c7aac67f
-  data.tar.gz: 0eb12f766ca5cc385e88ffb5aceacd4d10469ba920541fcdac36f6f0fdcccb234c689aa52523f055691755e1a28bae74418185055820f02b2ca2f3396016fb0d
+  metadata.gz: c05d91dc01449f819db82997e123a89140c7d0fa01c8ac2c99a6342a71630cd58d93908b27f48458c3d50596c98c8ed082604173897cf81fd10ae08072d575af
+  data.tar.gz: 6ae7f5cc98f0041bc1c5dde01326fbae16eb5f7e0db836480e061333a7ba8cc44327357387fc41e3f26d0ebf8e5127e9cccc450e1c5bf064ffaee7e7e1c4cb76

data/README.md

@@ -10,32 +10,32 @@ Installation
 
 ### Rails 3 / 4
 Add postageapp gem to your Gemfile:
-    
+
     gem 'postageapp'
-    
+
 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:
-    
+
     config.gem 'postageapp'
-    
+
 Then from the Rails project's root run:
-    
+
     rake gems:install
     rake gems:unpack GEM=postageapp
     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:
-    
+
 ```ruby
 require 'postageapp'
 
@@ -47,7 +47,7 @@ end
 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',
@@ -66,24 +66,24 @@ request = PostageApp::Request.new(:send_message, {
 })
 response = request.send
 ```
-  
+
 `PostageApp::Response` object allows you to check the status:
-  
+
     >> response.status
     => 'ok'
-  
+
 Alternatively you may use:
 
     >> response.fail?
     => false
     >> response.ok?
     => true
-  
+
 Response usually comes back with data:
-  
+
     >> response.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`):
 
@@ -116,22 +116,22 @@ 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'
-    
+
     # 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',
@@ -142,7 +142,7 @@ class Notifier < PostageApp::Mailer
   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
@@ -167,10 +167,10 @@ 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  ({
@@ -179,25 +179,25 @@ class Notifier < PostageApp::Mailer
       '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.
 
 For projects other than Rails you'll need to tell where there project_root is at:
-  
+
 ```ruby
 PostageApp.configure do |config|
   config.api_key      = 'PROJECT_API_KEY'
@@ -205,6 +205,20 @@ PostageApp.configure do |config|
 end
 ```
 
+Interceptors (Rails 3)
+----------------------
+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"
+    # postageapp_msg.perform_deliveries = false
+  end
+end
+```
+
 Copyright
 ---------
 (C) 2011-13 Oleg Khabarov, [The Working Group, Inc](http://www.twg.ca/)

data/lib/postageapp/mailer/mailer_3.rb

@@ -148,13 +148,20 @@ class PostageApp::Request
                 :perform_deliveries,
                 :raise_delivery_errors
 
+  def inform_interceptors
+    Mail.inform_interceptors(self)
+  end
+
   # Either doing an actual send, or passing it along to Mail::TestMailer
   # Probably not the best way as we're skipping way too many intermediate methods
   def deliver
-    if @delivery_method == Mail::TestMailer
-      @delivery_method.deliveries << self
-    else
-      self.send
+    inform_interceptors
+    if perform_deliveries
+      if @delivery_method == Mail::TestMailer
+        @delivery_method.deliveries << self
+      else
+        self.send
+      end
     end
   end
 
@@ -163,4 +170,4 @@ class PostageApp::Request
     @delivery_method = method
   end
 
-end
+end

data/lib/postageapp/mailer/mailer_4.rb

@@ -141,7 +141,7 @@ protected
       templates.uniq { |t| t.formats }.each(&block)
     end
   end
-  
+
   def create_parts_from_responses(m, responses) #:nodoc:
     map = {
       'html' => 'text/html',
@@ -163,13 +163,20 @@ class PostageApp::Request
                 :perform_deliveries,
                 :raise_delivery_errors
 
+  def inform_interceptors
+    Mail.inform_interceptors(self)
+  end
+
   # Either doing an actual send, or passing it along to Mail::TestMailer
   # Probably not the best way as we're skipping way too many intermediate methods
   def deliver
-    if @delivery_method == Mail::TestMailer
-      @delivery_method.deliveries << self
-    else
-      self.send
+    inform_interceptors
+    if perform_deliveries
+      if @delivery_method == Mail::TestMailer
+        @delivery_method.deliveries << self
+      else
+        self.send
+      end
     end
   end
 

data/lib/postageapp/version.rb

@@ -1,3 +1,3 @@
 module PostageApp
-  VERSION = "1.0.22"
+  VERSION = "1.0.23"
 end

data/test/mailer_3_test.rb

@@ -92,6 +92,14 @@ class Mailer3Test < Test::Unit::TestCase
       assert_equal [mail], ActionMailer::Base.deliveries
     end
 
+    def test_deliver_for_not_performing_deliveries_with_test_mailer
+      mail = Notifier.with_simple_view
+      mail.perform_deliveries = false
+      mail.delivery_method(Mail::TestMailer)
+      mail.deliver
+      assert_equal [], ActionMailer::Base.deliveries
+    end
+
   else
     puts "\e[0m\e[31mSkipping #{File.basename(__FILE__)}\e[0m"
     def test_nothing ; end

data/test/mailer_4_test.rb

@@ -7,12 +7,12 @@ class Mailer4Test < Test::Unit::TestCase
 
     require File.expand_path('../mailer/action_mailer_3/notifier', __FILE__)
     puts "\e[0m\e[32mRunning #{File.basename(__FILE__)} for action_mailer #{ActionMailer::VERSION::STRING}\e[0m"
-    
+
     def test_create_with_no_content
       mail = Notifier.with_no_content
       assert_equal ({}), mail.arguments['content']
     end
-    
+
     def test_create_with_no_subject
       mail = Notifier.with_no_subject
       assert mail.arguments['headers'][:subject].nil?
@@ -92,6 +92,14 @@ class Mailer4Test < Test::Unit::TestCase
       assert_equal [mail], ActionMailer::Base.deliveries
     end
 
+    def test_deliver_for_not_performing_deliveries_with_test_mailer
+      mail = Notifier.with_simple_view
+      mail.perform_deliveries = false
+      mail.delivery_method(Mail::TestMailer)
+      mail.deliver
+      assert_equal [], ActionMailer::Base.deliveries
+    end
+
   else
     puts "\e[0m\e[31mSkipping #{File.basename(__FILE__)}\e[0m"
     def test_nothing ; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postageapp
 version: !ruby/object:Gem::Version
-  version: 1.0.22
+  version: 1.0.23
 platform: ruby
 authors:
 - Oleg Khabarov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2013-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json