postageapp 1.0.24 → 1.2.0

data/lib/postageapp/mail/extensions.rb

@@ -0,0 +1,21 @@
+module PostageApp::Mail::Extensions
+  def self.install!
+    # Register PostageApp as a valid Mail delivery method, allows the shorthand
+    # Mail.delivery_method :postageapp
+    ::Mail::Configuration.class_eval do
+      alias_method :__base_lookup_delivery_method, :lookup_delivery_method
+
+      # This requires wrapping around the lookup_delivery_method method to
+      # add a new case. Unlike ActionMailer there is no way to register new
+      # delivery methods.
+      def lookup_delivery_method(method)
+        case (method.is_a?(String) ? method.to_sym : method)
+        when :postageapp
+          PostageApp::Mail::DeliveryMethod
+        else
+          __base_lookup_delivery_method(method)
+        end
+      end
+    end
+  end
+end

data/lib/postageapp/mailer.rb

@@ -1,52 +1,104 @@
-require 'action_mailer'
-require 'action_mailer/version'
-
-# Loading PostageApp::Mailer class depending on what action_mailer is
-# currently installed on the system. Assuming we're dealing only with
-# ones that come with Rails 2 and 3
-if ActionMailer::VERSION::MAJOR == 4
-  require File.expand_path('../mailer/mailer_4', __FILE__)
-elsif ActionMailer::VERSION::MAJOR == 3
-  require File.expand_path('../mailer/mailer_3', __FILE__)
-else
-  require File.expand_path('../mailer/mailer_2', __FILE__)
+begin
+  require 'action_mailer'
+  require 'action_mailer/version'
+
+rescue LoadError
+  # ActionMailer not available
+end
+
+if (defined?(ActionMailer))
+  # Loading PostageApp::Mailer class depending on what action_mailer is
+  # currently installed on the system. Assuming we're dealing only with
+  # ones that come with Rails 2 and 3
+  case (ActionMailer::VERSION::MAJOR)
+  when 4
+    require File.expand_path('mailer/mailer_4', File.dirname(__FILE__))
+  when 3
+    require File.expand_path('mailer/mailer_3', File.dirname(__FILE__))
+  else
+    require File.expand_path('mailer/mailer_2', File.dirname(__FILE__))
+  end
 end
 
 # General helper methods for Request object to act more like TMail::Mail
 # of Mail for testing
 class PostageApp::Request
-
   # Getter and setter for headers. You can specify headers in the following
   # formats:
   #   headers['Custom-Header'] = 'Custom Value'
   #   headers 'Custom-Header-1' => 'Custom Value 1',
   #           'Custom-Header-2' => 'Custom Value 2'
   def headers(value = nil)
-    self.arguments['headers'] ||= { }
-    if value && value.is_a?(Hash)
+    _headers = self.arguments['headers'] ||= { }
+
+    case (value)
+    when Hash
       value.each do |k, v|
-        self.arguments['headers'][k.to_s] = v.to_s
+        _headers[k.to_s] = v.to_s
       end
     end
-    self.arguments['headers']
+
+    _headers
+  end
+
+  def [](key)
+    case (key)
+    when :to, 'to'
+      self.to
+    when :from, 'from'
+      self.from
+    when :bcc, 'bcc'
+      # Not supported via API at this time
+      [ ]
+    end
   end
 
   def to
     out = self.arguments_to_send.dig('arguments', 'recipients')
-    out.is_a?(Hash) ? out : [out].flatten
+
+    case (out)
+    when Hash
+      out
+    else
+      [ out ].flatten
+    end
+  end
+
+  def to=(list)
+    self.arguments['recipients'] = list
   end
 
   def from
-    [self.arguments_to_send.dig('arguments', 'headers', 'from')].flatten
+    [ self.arguments_to_send.dig('arguments', 'headers', 'from') ].flatten
+  end
+
+  def from=(address)
+    _headers = self.arguments['headers'] ||= { }
+
+    _headers['from'] = address.to_s
+  end
+
+  def bcc
+    # Not supported natively via API at this time
+    [ ]
+  end
+
+  def bcc=(list)
+    # Not supported natively via API at this time
   end
 
   def subject
     self.arguments_to_send.dig('arguments', 'headers', 'subject')
   end
 
+  def subject=(subject)
+    _headers = self.arguments['headers'] ||= { }
+
+    _headers['subject'] = subject.to_s
+  end
+
   def body
     out = self.arguments_to_send.dig('arguments', 'content')
     out.is_a?(Hash) ? out.values.join("\n\n") : out.to_s
   end
-
 end

data/lib/postageapp/mailer/mailer_2.rb

@@ -25,9 +25,10 @@
 #   request = Notifier.create_signup_notification(user) # creates PostageApp::Request object
 #
 class PostageApp::Mailer < ActionMailer::Base
-  
   # Using :test as a delivery method if set somewhere else
-  self.delivery_method = :postage unless (self.delivery_method == :test)
+  unless (self.delivery_method == :test)
+    self.delivery_method = :postage
+  end
   
   adv_attr_accessor :postageapp_uid
   adv_attr_accessor :postageapp_api_key
@@ -39,50 +40,92 @@ class PostageApp::Mailer < ActionMailer::Base
   end
   
   def deliver!(mail = @mail)
-    raise 'PostageApp::Request object not present, cannot deliver' unless mail
-    __send__("perform_delivery_#{delivery_method}", mail) if perform_deliveries
+    unless (mail)
+      raise 'PostageApp::Request object not present, cannot deliver'
+    end
+
+    if (perform_deliveries)
+      __send__("perform_delivery_#{delivery_method}", mail)
+    end
   end
   
   # Creating a Postage::Request object unlike TMail one in ActionMailer::Base
   def create_mail
     params = { }
-    params['recipients'] = self.recipients unless self.recipients.blank?
+
+    unless (self.recipients.blank?)
+      params['recipients'] = self.recipients
+    end
     
     params['headers'] = { }
-    params['headers']['subject']  = self.subject  unless self.subject.blank?
-    params['headers']['from']     = self.from     unless self.from.blank?
-    params['headers'].merge!(self.headers)        unless self.headers.blank?
+
+    unless (self.subject.blank?)
+      params['headers']['subject'] = self.subject
+    end
+
+    unless (self.subject.blank?)
+      params['headers']['from'] = self.from
+    end
+
+    unless (self.headers.blank?)
+      params['headers'].merge!(self.headers)
+    end
     
     params['content'] = { }
     params['attachments'] = { }
     
-    if @parts.empty?
-      params['content'][self.content_type] = self.body unless self.body.blank?
+    if (@parts.empty?)
+      unless (self.body.blank?)
+        params['content'][self.content_type] = self.body
+      end
     else
       self.parts.each do |part|
-        case part.content_disposition
+        case (part.content_disposition)
         when 'inline'
-          part.content_type = 'text/plain' if part.content_type.blank? && String === part.body
+          if (part.content_type.blank? && String === part.body)
+            part.content_type = 'text/plain'
+          end
+
           params['content'][part.content_type] = part.body
         when 'attachment'
           params['attachments'][part.filename] = {
             'content_type' => part.content_type,
-            'content'      => Base64.encode64(part.body)
+            'content' => Base64.encode64(part.body)
           }
         end
       end
     end
     
-    params['template']  = self.postageapp_template  unless self.postageapp_template.blank?
-    params['variables'] = self.postageapp_variables unless self.postageapp_variables.blank?
+    unless (self.postageapp_template.blank?)
+      params['template']  = self.postageapp_template
+    end
+
+    unless (self.postageapp_variables.blank?)
+      params['variables'] = self.postageapp_variables
+    end
     
-    params.delete('headers')     if params['headers'].blank?
-    params.delete('content')     if params['content'].blank?
-    params.delete('attachments') if params['attachments'].blank?
+    if (params['headers'].blank?)
+      params.delete('headers')
+    end
+
+    if (params['content'].blank?)
+      params.delete('content')
+    end
+
+    if (params['attachments'].blank?)
+      params.delete('attachments')
+    end
     
     @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?
+
+    unless (self.postageapp_uid.blank?)
+      @mail.uid = self.postageapp_uid
+    end
+
+    unless (self.postageapp_api_key.blank?)
+      @mail.api_key = self.postageapp_api_key
+    end
+
     @mail
   end
   
@@ -90,8 +133,8 @@ class PostageApp::Mailer < ActionMailer::Base
   # provided that the template is defined.
   def render(opts)
     super(opts)
+
   rescue ActionView::MissingTemplate
     # do nothing
   end
-  
-end
+end

data/lib/postageapp/mailer/mailer_3.rb

@@ -25,34 +25,37 @@
 #
 #   request = Notifier.signup_notification(user) # creates PostageApp::Request object
 #   response = request.deliver # attempts to deliver the message and creates a PostageApp::Response
-#
-class PostageApp::Mailer < ActionMailer::Base
 
+class PostageApp::Mailer < ActionMailer::Base
   # Wrapper for creating attachments
   # Attachments sent to PostageApp are in the following format:
   #  'filename.ext' => {
   #    'content_type' => 'content/type',
   #    'content'      => 'base64_encoded_content'
   #   }
-  class Attachments < Hash
 
+  class Attachments < Hash
     def initialize(message)
       @_message = message
+
       message.arguments['attachments'] ||= { }
     end
 
     def []=(filename, attachment)
       default_content_type = MIME::Types.type_for(filename).first.content_type rescue ''
-      if attachment.is_a?(Hash)
-        content_type  = attachment[:content_type] || default_content_type
-        content       = Base64.encode64(attachment[:body])
+
+      case (attachment)
+      when Hash
+        content_type = attachment[:content_type] || default_content_type
+        content = Base64.encode64(attachment[:body])
       else
-        content_type  = default_content_type
-        content       = Base64.encode64(attachment)
+        content_type = default_content_type
+        content = Base64.encode64(attachment)
       end
+
       @_message.arguments['attachments'][filename] = {
-        'content_type'  => content_type,
-        'content'       => content
+        'content_type' => content_type,
+        'content' => content
       }
     end
   end
@@ -60,8 +63,12 @@ class PostageApp::Mailer < ActionMailer::Base
   # Instead of initializing Mail object, we prepare PostageApp::Request
   def initialize(method_name = nil, *args)
     super()
+
     @_message = PostageApp::Request.new(:send_message)
-    process(method_name, *args) if method_name
+
+    if method_name
+      process(method_name, *args)
+    end
   end
 
   # Possible to define custom uid. Should be sufficiently unique
@@ -76,12 +83,20 @@ class PostageApp::Mailer < ActionMailer::Base
   # In API call we can specify PostageApp template that will be used
   # to generate content of the message
   def postageapp_template(value = nil)
-    value ? @_message.arguments['template'] = value : @_message.arguments['template']
+    if (value)
+      @_message.arguments['template'] = value
+    else
+      @_message.arguments['template']
+    end
   end
 
   # Hash of variables that will be used to inject into the content
   def postageapp_variables(value = nil)
-    value ? @_message.arguments['variables'] = value : @_message.arguments['variables']
+    if (value)
+      @_message.arguments['variables'] = value
+    else
+      @_message.arguments['variables']
+    end
   end
 
   def attachments
@@ -89,13 +104,13 @@ class PostageApp::Mailer < ActionMailer::Base
   end
 
   # Override for headers assignment
-  def headers(args=nil)
+  def headers(args = nil)
     @_message.headers(args)
   end
 
   # Overriding method that prepares Mail object. This time we'll be
   # contructing PostageApp::Request payload.
-  def mail(headers = {}, &block)
+  def mail(headers = { }, &block)
     # Guard flag to prevent both the old and the new API from firing
     # Should be removed when old API is removed
     @mail_was_called = true
@@ -103,11 +118,15 @@ class PostageApp::Mailer < ActionMailer::Base
 
     # At the beginning, do not consider class default for parts order neither content_type
     content_type = headers[:content_type]
-    parts_order  = headers[:parts_order]
+    parts_order = headers[:parts_order]
 
     # Call all the procs (if any)
     default_values = self.class.default.merge(self.class.default) do |k,v|
-      v.respond_to?(:call) ? v.bind(self).call : v
+      if (v.respond_to?(:call))
+        v.bind(self).call
+      else
+        v
+      end
     end
 
     # Handle defaults
@@ -131,22 +150,20 @@ class PostageApp::Mailer < ActionMailer::Base
   end
 
 protected
-
   def create_parts_from_responses(m, responses) #:nodoc:
-    content = m.arguments['content'] ||= {}
+    content = m.arguments['content'] ||= { }
+
     responses.each do |part|
       content[part[:content_type]] = part[:body]
     end
   end
-
 end
 
 # A set of methods that are useful when request needs to behave as Mail
 class PostageApp::Request
-
-  attr_accessor :delivery_handler,
-                :perform_deliveries,
-                :raise_delivery_errors
+  attr_accessor :delivery_handler
+  attr_accessor :perform_deliveries
+  attr_accessor :raise_delivery_errors
 
   def inform_interceptors
     Mail.inform_interceptors(self)
@@ -156,8 +173,9 @@ class PostageApp::Request
   # Probably not the best way as we're skipping way too many intermediate methods
   def deliver
     inform_interceptors
-    if perform_deliveries
-      if @delivery_method == Mail::TestMailer
+
+    if (perform_deliveries)
+      if (@delivery_method == Mail::TestMailer)
         @delivery_method.deliveries << self
       else
         self.send
@@ -166,8 +184,7 @@ class PostageApp::Request
   end
 
   # Not 100% on this, but I need to assign this so I can properly handle deliver method
-  def delivery_method(method = nil, settings = {})
+  def delivery_method(method = nil, settings = { })
     @delivery_method = method
   end
-
 end

data/lib/postageapp/mailer/mailer_4.rb

@@ -9,9 +9,9 @@
 #   class Notifier < PostageApp::Mailer
 #     def signup_notification(recipient)
 #       mail(
-#         :to       => recipient.email,
-#         :from     => 'sender@test.test',
-#         :subject  => 'Test Message'
+#         to: recipient.email,
+#         from: 'sender@test.test',
+#         subject: 'Test Message'
 #       )
 #     end
 #   end
@@ -25,17 +25,21 @@
 #
 #   request = Notifier.signup_notification(user) # creates PostageApp::Request object
 #   response = request.deliver # attempts to deliver the message and creates a PostageApp::Response
-#
+
 class PostageApp::Mailer < ActionMailer::Base
+  CONTENT_TYPE_MAP = {
+    'html' => 'text/html',
+    'text' => 'text/plain'
+  }
 
   # Wrapper for creating attachments
   # Attachments sent to PostageApp are in the following format:
   #  'filename.ext' => {
-  #    'content_type' => 'content/type',
-  #    'content'      => 'base64_encoded_content'
+  #    content_type: 'content/type',
+  #    content: 'base64_encoded_content'
   #   }
-  class Attachments < Hash
 
+  class Attachments < Hash
     def initialize(message)
       @_message = message
       message.arguments['attachments'] ||= { }
@@ -43,16 +47,19 @@ class PostageApp::Mailer < ActionMailer::Base
 
     def []=(filename, attachment)
       default_content_type = MIME::Types.type_for(filename).first.content_type rescue ''
-      if attachment.is_a?(Hash)
-        content_type  = attachment[:content_type] || default_content_type
-        content       = Base64.encode64(attachment[:body])
+
+      case (attachment)
+      when Hash
+        content_type = attachment[:content_type] || default_content_type
+        content = Base64.encode64(attachment[:body])
       else
-        content_type  = default_content_type
-        content       = Base64.encode64(attachment)
+        content_type = default_content_type
+        content = Base64.encode64(attachment)
       end
+
       @_message.arguments['attachments'][filename] = {
-        'content_type'  => content_type,
-        'content'       => content
+        'content_type' => content_type,
+        'content' => content
       }
     end
   end
@@ -60,28 +67,48 @@ class PostageApp::Mailer < ActionMailer::Base
   # Instead of initializing Mail object, we prepare PostageApp::Request
   def initialize(method_name = nil, *args)
     super()
+
     @_message = PostageApp::Request.new(:send_message)
-    process(method_name, *args) if method_name
+
+    if (method_name)
+      process(method_name, *args)
+    end
   end
 
   # Possible to define custom uid. Should be sufficiently unique
   def postageapp_uid(value = nil)
-    value ? @_message.uid = value : @_message.uid
+    if (value)
+      @_message.uid = value
+    else
+      @_message.uid
+    end
   end
 
   def postageapp_api_key(value = nil)
-    value ? @_message.api_key = value : @_message.api_key
+    if (value)
+      @_message.api_key = value
+    else
+      @_message.api_key
+    end
   end
 
   # In API call we can specify PostageApp template that will be used
   # to generate content of the message
   def postageapp_template(value = nil)
-    value ? @_message.arguments['template'] = value : @_message.arguments['template']
+    if (value)
+      @_message.arguments['template'] = value
+    else
+      @_message.arguments['template']
+    end
   end
 
   # Hash of variables that will be used to inject into the content
   def postageapp_variables(value = nil)
-    value ? @_message.arguments['variables'] = value : @_message.arguments['variables']
+    if (value)
+      @_message.arguments['variables'] = value
+    else
+      @_message.arguments['variables']
+    end
   end
 
   def attachments
@@ -89,13 +116,13 @@ class PostageApp::Mailer < ActionMailer::Base
   end
 
   # Override for headers assignment
-  def headers(args=nil)
+  def headers(args = nil)
     @_message.headers(args)
   end
 
   # Overriding method that prepares Mail object. This time we'll be
   # contructing PostageApp::Request payload.
-  def mail(headers = {}, &block)
+  def mail(headers = { }, &block)
     # Guard flag to prevent both the old and the new API from firing
     # Should be removed when old API is removed
     @_mail_was_called = true
@@ -117,13 +144,23 @@ class PostageApp::Mailer < ActionMailer::Base
     charset = headers[:charset]
 
     # Set configure delivery behavior
-    wrap_delivery_behavior!(headers.delete(:delivery_method),headers.delete(:delivery_method_options))
+    wrap_delivery_behavior!(
+      headers.delete(:delivery_method),
+      headers.delete(:delivery_method_options)
+    )
 
     # Assigning recipients
     m.arguments['recipients'] = headers.delete(:to)
 
     # Assign all headers except parts_order, content_type and body
-    assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)
+    assignable = headers.except(
+      :parts_order,
+      :content_type,
+      :body,
+      :template_name,
+      :template_path
+    )
+    
     m.headers.merge!(assignable)
 
     # Render the templates and blocks
@@ -134,34 +171,29 @@ class PostageApp::Mailer < ActionMailer::Base
   end
 
 protected
-
   def each_template(paths, name, &block) #:nodoc:
     templates = lookup_context.find_all(name, paths)
-    if templates.present?
+
+    if (templates.present?)
       templates.uniq { |t| t.formats }.each(&block)
     end
   end
 
   def create_parts_from_responses(m, responses) #:nodoc:
-    map = {
-      'html' => 'text/html',
-      'text' => 'text/plain'
-    }
-    content = m.arguments['content'] ||= {}
+    content = m.arguments['content'] ||= { }
+
     responses.each do |part|
-      content_type = map[part[:content_type]] || part[:content_type]
+      content_type = CONTENT_TYPE_MAP[part[:content_type]] || part[:content_type]
       content[content_type] = part[:body]
     end
   end
-
 end
 
 # A set of methods that are useful when request needs to behave as Mail
 class PostageApp::Request
-
-  attr_accessor :delivery_handler,
-                :perform_deliveries,
-                :raise_delivery_errors
+  attr_accessor :delivery_handler
+  attr_accessor :perform_deliveries
+  attr_accessor :raise_delivery_errors
 
   def inform_interceptors
     Mail.inform_interceptors(self)
@@ -171,8 +203,9 @@ class PostageApp::Request
   # Probably not the best way as we're skipping way too many intermediate methods
   def deliver
     inform_interceptors
-    if perform_deliveries
-      if @delivery_method == Mail::TestMailer
+
+    if (perform_deliveries)
+      if (@delivery_method == Mail::TestMailer)
         @delivery_method.deliveries << self
       else
         self.send
@@ -181,8 +214,7 @@ class PostageApp::Request
   end
 
   # Not 100% on this, but I need to assign this so I can properly handle deliver method
-  def delivery_method(method = nil, settings = {})
+  def delivery_method(method = nil, settings = nil)
     @delivery_method = method
   end
-
 end