postageapp 1.0.24 → 1.2.0

data/lib/postageapp.rb

@@ -13,48 +13,54 @@ require 'postageapp/logger'
 require 'postageapp/request'
 require 'postageapp/failed_request'
 require 'postageapp/response'
-require 'postageapp/rails/railtie' if defined?(Rails::Railtie)
+require 'postageapp/mail'
+require 'postageapp/mail/delivery_method'
+
+require 'postageapp/rails/railtie' if (defined?(Rails::Railtie))
 
 module PostageApp
-  
   class Error < StandardError ; end
   
+  # Call this method to modify your configuration
+  # Example:
+  #   PostageApp.configure do |config|
+  #     config.api_key             = '1234567890abcdef'
+  #     config.recipient_override  = 'test@test.test' if Rails.env.staging?
+  #   end
+  # 
+  # If you do not want/need to initialize the gem in this way, you can use the environment
+  # variable POSTAGEAPP_API_KEY to set up your key.
+  
+  def self.configure
+    yield(configuration)
+  end
+  
+  # Accessor for the PostageApp::Configuration object
+  # Example use:
+  #   PostageApp.configuration.api_key = '1234567890abcdef'
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
   class << self
-    
-    # Call this method to modify your configuration
-    # Example:
-    #   PostageApp.configure do |config|
-    #     config.api_key             = '1234567890abcdef'
-    #     config.recipient_override  = 'test@test.test' if Rails.env.staging?
-    #   end
-    # 
-    # If you do not want/need to initialize the gem in this way, you can use the environment
-    # variable POSTAGEAPP_API_KEY to set up your key.
-    
-    def configure
-      yield configuration
-    end
-    
-    # Accessor for the PostageApp::Configuration object
-    # Example use:
-    #   PostageApp.configuration.api_key = '1234567890abcdef'
-    def configuration
-      @configuration ||= Configuration.new
-    end
     alias :config :configuration
-    
-    # Logger for the plugin
-    def logger
-      @logger ||= begin
-        configuration.logger || PostageApp::Logger.new(
-          if configuration.project_root
-            FileUtils.mkdir_p(File.join(File.expand_path(configuration.project_root), 'log'))
-            File.join(configuration.project_root, "log/postageapp_#{configuration.environment}.log")
-          else
-            STDOUT
-          end
-        )
-      end
+  end
+  
+  # Logger for the plugin
+  def self.logger
+    @logger ||= begin
+      configuration.logger || PostageApp::Logger.new(
+        if (configuration.project_root)
+          FileUtils.mkdir_p(File.join(File.expand_path(configuration.project_root), 'log'))
+          File.join(configuration.project_root, "log/postageapp_#{configuration.environment}.log")
+        else
+          STDOUT
+        end
+      )
     end
   end
 end
+
+require 'postageapp/mail/extensions'
+
+PostageApp::Mail::Extensions.install!

data/lib/postageapp/configuration.rb

@@ -1,5 +1,4 @@
 class PostageApp::Configuration
-  
   # +true+ for https, +false+ for http connections (default: is +true+)
   attr_accessor :secure
   
@@ -12,7 +11,7 @@ class PostageApp::Configuration
   
   # The port on which PostageApp service runs (default: 443 for secure, 80 for 
   # insecure connections)
-  attr_accessor :port
+  attr_writer :port
   
   # The hostname of the proxy server (if using a proxy)
   attr_accessor :proxy_host
@@ -54,43 +53,57 @@ class PostageApp::Configuration
   attr_accessor :logger
   
   def initialize
-    @secure             = true
-    @host               = 'api.postageapp.com'
-    @http_open_timeout  = 5
-    @http_read_timeout  = 10
+    @secure = true
+    @host = 'api.postageapp.com'
+    @http_open_timeout = 5
+    @http_read_timeout = 10
     @requests_to_resend = %w( send_message )
-    @framework          = 'undefined framework'
-    @environment        = 'production'
+    @framework = 'undefined framework'
+    @environment = 'production'
   end
   
   alias_method :secure?, :secure
   
+  # Assign which API key is used to make API calls. Can also be specified
+  # using the `POSTAGEAPP_API_KEY` environment variable.
   def api_key=(key)
     @api_key = key
   end
   
+  # Returns the API key used to make API calls. Can be specified as the
+  # `POSTAGEAPP_API_KEY` environment variable.
   def api_key
-    @api_key || ENV['POSTAGEAPP_API_KEY']
+    @api_key ||= ENV['POSTAGEAPP_API_KEY']
   end
   
+  # Returns the HTTP protocol used to make API calls
   def protocol
-    @protocol || if secure?
-      'https'
-    else
-      'http'
-    end
+    @protocol ||= (secure? ? 'https' : 'http')
   end
   
+  # Returns the port used to make API calls
   def port
-    @port || if secure?
-      443
-    else
-      80
-    end
+    @port ||= (secure? ? 443 : 80)
   end
   
+  # Returns the endpoint URL to make API calls
   def url
     "#{self.protocol}://#{self.host}:#{self.port}"
   end
-  
-end
+
+  # Returns a properly config
+  def http
+    http = Net::HTTP::Proxy(
+      self.proxy_host,
+      self.proxy_port,
+      self.proxy_user,
+      self.proxy_pass
+    ).new(self.host, self.port)
+    
+    http.read_timeout = self.http_read_timeout
+    http.open_timeout = self.http_open_timeout
+    http.use_ssl = self.secure?
+
+    http
+  end
+end

data/lib/postageapp/failed_request.rb

@@ -1,75 +1,99 @@
 module PostageApp::FailedRequest
-  
   # Stores request object into a file for future re-send
   # returns true if stored, false if not (due to undefined project path)
   def self.store(request)
-    return false if !store_path || !PostageApp.configuration.requests_to_resend.member?(request.method.to_s)
+    return false unless (self.store_path) 
+    return false unless (PostageApp.configuration.requests_to_resend.member?(request.method.to_s))
     
-    open(file_path(request.uid), 'wb') do |f|
-      f.write(Marshal.dump(request))
-    end unless File.exists?(file_path(request.uid))
+    unless (File.exists?(file_path(request.uid)))
+      open(file_path(request.uid), 'wb') do |f|
+        f.write(Marshal.dump(request))
+      end
+    end
     
-    PostageApp.logger.info "STORING FAILED REQUEST [#{request.uid}]"
+    PostageApp.logger.info("STORING FAILED REQUEST [#{request.uid}]")
     
     true
   end
+
+  def self.force_delete!(path)
+    File.delete(path)
+
+  rescue
+    nil
+  end
   
   # Attempting to resend failed requests
   def self.resend_all
-    return false if !store_path
+    return false unless (self.store_path)
     
     Dir.foreach(store_path) do |filename|
-      next if !filename.match /^\w{40}$/
+      next unless (filename.match(/^\w{40}$/))
       
       request = initialize_request(filename)
       
-      receipt_response = PostageApp::Request.new(:get_message_receipt, :uid => filename).send(true)
-      if receipt_response.fail?
+      receipt_response = PostageApp::Request.new(
+        :get_message_receipt,
+        :uid => filename
+      ).send(true)
+
+      if (receipt_response.fail?)
         return
-      elsif receipt_response.ok?
-        PostageApp.logger.info "NOT RESENDING FAILED REQUEST [#{filename}]"
-        File.delete(file_path(filename)) rescue nil
-        
-      elsif receipt_response.not_found?
-        PostageApp.logger.info "RESENDING FAILED REQUEST [#{filename}]"
+      elsif (receipt_response.ok?)
+        PostageApp.logger.info("Skipping failed request (already sent) [#{filename}]")
+
+        force_delete!(file_path(filename))
+      elsif (receipt_response.not_found?)
+        PostageApp.logger.info("Retrying failed request [#{filename}]")
+
         response = request.send(true)
         
         # Not a fail, so we can remove this file, if it was then
         # there will be another attempt to resend
-        File.delete(file_path(filename)) rescue nil if !response.fail?
+
+        unless (response.fail?)
+          force_delete!(file_path(filename))
+        end
       else
-        PostageApp.logger.info "NOT RESENDING FAILED REQUEST [#{filename}], RECEIPT CANNOT BE PROCESSED"
-        File.delete(file_path(filename)) rescue nil
+        PostageApp.logger.info("Skipping failed request (non-replayable request type) [#{filename}]")
+
+        force_delete!(file_path(filename))
       end
     end
+
     return
   end
   
   # Initializing PostageApp::Request object from the file
   def self.initialize_request(uid)
-    return false if !store_path
-    
-    if File.exists?(file_path(uid))
-      begin
-        Marshal.load(File.read(file_path(uid))) 
-      rescue
-        File.delete(file_path(uid))
-        return false
-      end
-    end
+    return false unless (self.store_path)
+    return false unless (File.exists?(file_path(uid)))
+
+    Marshal.load(File.read(file_path(uid))) 
+
+  rescue
+    force_delete!(file_path(uid))
+
+    false
   end
   
 protected
-  
   def self.store_path
-    return if !PostageApp.configuration.project_root
-    dir = File.join(File.expand_path(PostageApp.configuration.project_root), 'tmp/postageapp_failed_requests')
-    FileUtils.mkdir_p(dir) unless File.exists?(dir)
-    return dir
+    return unless (PostageApp.configuration.project_root)
+
+    dir = File.join(
+      File.expand_path(PostageApp.configuration.project_root),
+      'tmp/postageapp_failed_requests'
+    )
+    
+    unless (File.exists?(dir))
+      FileUtils.mkdir_p(dir)
+    end
+    
+    dir
   end
   
   def self.file_path(uid)
     File.join(store_path, uid)
   end
-  
-end
+end

data/lib/postageapp/logger.rb

@@ -1,16 +1,15 @@
 class PostageApp::Logger < ::Logger
-  
   def format_message(severity, datetime, progname, msg)
-    timestamp = datetime.strftime('%m/%d/%Y %H:%M:%S %Z')
-    message = case msg
+    "[%s] %s\n" % [
+      datetime.strftime('%m/%d/%Y %H:%M:%S %Z'),
+      case (msg)
       when PostageApp::Request
         "REQUEST [#{msg.url}]\n #{msg.arguments_to_send.to_json}"
       when PostageApp::Response
         "RESPONSE [#{msg.status} #{msg.uid} #{msg.message}]\n #{msg.data.to_json}"
       else
         msg
-    end
-    "[#{timestamp}] #{message}\n"
+      end
+    ]
   end
-  
-end
+end

data/lib/postageapp/mail.rb

@@ -0,0 +1,3 @@
+class PostageApp::Mail
+  require 'postageapp/mail/arguments'
+end

data/lib/postageapp/mail/arguments.rb

@@ -0,0 +1,75 @@
+require 'set'
+
+# This class decomposes a Mail::Message into a PostageApp API call that
+# produces the same result when sent.
+
+class PostageApp::Mail::Arguments
+  # Certain headers need to be ignored since they are generated internally.
+  HEADERS_IGNORED = Set.new(%w[
+    Content-Type
+    To
+  ]).freeze
+
+  # Creates a new instance with the given Mail::Message binding.
+  def initialize(mail)
+    @mail = mail
+  end
+
+  # Returns the extracted arguments. If a pre-existing arguments has is
+  # supplied, arguments are injected into that.
+  def extract(arguments = nil)
+    arguments ||= { }
+    arguments['content'] ||= { }
+    arguments['headers'] ||= { }
+
+    arguments['recipients'] = @mail.to
+
+    if (@mail.multipart?)
+      @mail.parts.each do |part|
+        if (part.content_disposition)
+          add_attachment(arguments, part)
+        else
+          add_part(arguments, part)
+        end
+      end
+    else
+      add_part(arguments, @mail)
+    end
+
+    _headers = arguments['headers']
+    @mail.header.fields.each do |field|
+      next if (HEADERS_IGNORED.include?(field.name))
+
+      _headers[field.name] = field.value
+    end
+
+    if (@mail.has_attachments?)
+      @mail.attachments.each do |attachment|
+        add_attachment(arguments, attachment)
+      end
+    end
+
+    [ :send_message, arguments ]
+  end
+
+protected
+  def add_part(arguments, part)
+    case (part.content_type.to_s.split(/\s*;/).first)
+    when 'text/html'
+      arguments['content']['text/html'] = part.body.to_s
+    when 'text/plain', nil
+      arguments['content']['text/plain'] = part.body.to_s
+    else
+      # Unknown type.
+    end
+  end
+
+  def add_attachment(arguments, part)
+    arguments['attachments'] ||= { }
+
+    arguments['attachments'][part.filename] = {
+      'content' => Base64.encode64(part.body.to_s),
+      'content_type' => part.content_type
+    }
+  end
+end

data/lib/postageapp/mail/delivery_method.rb

@@ -0,0 +1,32 @@
+class PostageApp::Mail::DeliveryMethod
+  def self.deliveries
+    @deliveries ||= [ ]
+  end
+
+  # Creates a new DeliveryMethod instance with the supplied options.
+  def initialize(options)
+    @options = options.dup
+  end
+
+  # Delivers a given Mail::Message through PostageApp using the configuration
+  # specified through Mail defaults or settings applied to ActionMailer.
+  def deliver!(mail)
+    api_method, arguments = PostageApp::Mail::Arguments.new(mail).extract
+
+    case (@options[:api_key])
+    when false, :test
+      # In testing mode, just capture the calls that would have been made so
+      # they can be inspected later using the deliveries class method.
+      self.class.deliveries << [ api_method, arguments ]
+    when nil
+      # If the API key is not defined, raise an error providing a hint as to
+      # how to set that correctly.
+      raise PostageApp::Error,
+        "PostageApp API key not defined: Add :api_key to config.action_mailer.postageapp_settings to config/application.rb"
+    else
+      arguments['api_key'] ||= @options[:api_key]
+
+      PostageApp::Request.new(api_method, arguments).send
+    end
+  end
+end