postmark 0.9.19 → 1.0.0

data/lib/postmark/helpers/hash_helper.rb

@@ -0,0 +1,35 @@
+module Postmark
+  module HashHelper
+
+    extend self
+
+    def to_postmark(hash)
+      hash.inject({}) { |m, (k,v)| m[Inflector.to_postmark(k)] = v; m }
+    end
+
+    def to_ruby(hash, compatible = false)
+      formatted = hash.inject({}) { |m, (k,v)| m[Inflector.to_ruby(k)] = v; m }
+
+      if compatible
+        formatted.merge!(hash)
+        enhance_with_compatibility_warning(formatted)
+      end
+
+      formatted
+    end
+
+    protected
+
+    def enhance_with_compatibility_warning(hash)
+      def hash.[](key)
+        if key.is_a? String
+          Kernel.warn("Postmark: the CamelCased String keys of response are " \
+                      "deprecated in favor of underscored symbols. The " \
+                      "support will be dropped in the future.")
+        end
+        super
+      end
+    end
+
+  end
+end

data/lib/postmark/helpers/message_helper.rb

@@ -0,0 +1,62 @@
+module Postmark
+  module MessageHelper
+
+    extend self
+
+    def to_postmark(message = {})
+      message = message.dup
+
+      %w(to reply_to cc bcc).each do |field|
+        message[field.to_sym] = Array[*message[field.to_sym]].join(", ")
+      end
+
+      if message[:headers]
+        message[:headers] = headers_to_postmark(message[:headers])
+      end
+
+      if message[:attachments]
+        message[:attachments] = attachments_to_postmark(message[:attachments])
+      end
+
+      HashHelper.to_postmark(message)
+    end
+
+    def headers_to_postmark(headers)
+      wrap_in_array(headers).map do |item|
+        HashHelper.to_postmark(item)
+      end
+    end
+
+    def attachments_to_postmark(attachments)
+      wrap_in_array(attachments).map do |item|
+        if item.is_a?(Hash)
+          HashHelper.to_postmark(item)
+        elsif item.is_a?(File)
+          {
+            "Name"        => item.path.split("/")[-1],
+            "Content"     => encode_in_base64(IO.read(item.path)),
+            "ContentType" => "application/octet-stream"
+          }
+        end
+      end
+    end
+
+    def encode_in_base64(data)
+      [data].pack('m')
+    end
+
+    protected
+
+    # From ActiveSupport (Array#wrap)
+    def wrap_in_array(object)
+      if object.nil?
+        []
+      elsif object.respond_to?(:to_ary)
+        object.to_ary || [object]
+      else
+        [object]
+      end
+    end
+
+  end
+end

data/lib/postmark/http_client.rb

@@ -2,11 +2,26 @@ require 'thread' unless defined? Mutex # For Ruby 1.8.7
 require 'cgi'
 
 module Postmark
-  module HttpClient
-    extend self
-
-    @@client_mutex = Mutex.new
-    @@request_mutex = Mutex.new
+  class HttpClient
+    attr_accessor :api_key
+    attr_reader :http, :secure, :proxy_host, :proxy_port, :proxy_user,
+                :proxy_pass, :host, :port, :path_prefix,
+                :http_open_timeout, :http_read_timeout
+
+    DEFAULTS = {
+      :host => 'api.postmarkapp.com',
+      :secure => false,
+      :path_prefix => '/',
+      :http_read_timeout => 15,
+      :http_open_timeout => 5
+    }
+
+    def initialize(api_key, options = {})
+      @api_key = api_key
+      @request_mutex = Mutex.new
+      apply_options(options)
+      @http = build_http
+    end
 
     def post(path, data = '')
       do_request { |client| client.post(url_path(path), data, headers) }
@@ -22,17 +37,25 @@ module Postmark
 
     protected
 
+    def apply_options(options = {})
+      options = Hash[*options.select { |_, v| !v.nil? }.flatten]
+      DEFAULTS.merge(options).each_pair do |name, value|
+        instance_variable_set(:"@#{name}", value)
+      end
+      @port = options[:port] || @secure ? 443 : 80
+    end
+
     def to_query_string(hash)
       return "" if hash.empty?
       "?" + hash.map { |key, value| "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}" }.join("&")
     end
 
     def protocol
-      Postmark.secure ? "https" : "http"
+      self.secure ? "https" : "http"
     end
 
     def url
-      URI.parse("#{protocol}://#{Postmark.host}:#{Postmark.port}/")
+      URI.parse("#{protocol}://#{self.host}:#{self.port}/")
     end
 
     def handle_response(response)
@@ -51,37 +74,30 @@ module Postmark
     end
 
     def headers
-      @headers ||= HEADERS.merge({ "X-Postmark-Server-Token" => Postmark.api_key.to_s })
+      HEADERS.merge({ "X-Postmark-Server-Token" => self.api_key.to_s })
     end
 
     def url_path(path)
-      Postmark.path_prefix + path
+      self.path_prefix + path
     end
 
     def do_request
-      @@request_mutex.synchronize do
+      @request_mutex.synchronize do
         handle_response(yield(http))
       end
-    end
-
-    def http
-      return @http if @http
-
-      @@client_mutex.synchronize do
-        return @http if @http
-        @http = build_http
-      end
+    rescue Timeout::Error
+      raise TimeoutError.new($!)
     end
 
     def build_http
-      http = Net::HTTP::Proxy(Postmark.proxy_host,
-                              Postmark.proxy_port,
-                              Postmark.proxy_user,
-                              Postmark.proxy_pass).new(url.host, url.port)
-
-      http.read_timeout = Postmark.http_read_timeout
-      http.open_timeout = Postmark.http_open_timeout
-      http.use_ssl = !!Postmark.secure
+      http = Net::HTTP::Proxy(self.proxy_host,
+                              self.proxy_port,
+                              self.proxy_user,
+                              self.proxy_pass).new(url.host, url.port)
+
+      http.read_timeout = self.http_read_timeout
+      http.open_timeout = self.http_open_timeout
+      http.use_ssl = !!self.secure
       http
     end
 
@@ -91,7 +107,7 @@ module Postmark
 
     def error_message_and_code(response_body)
       reply = Postmark::Json.decode(response_body)
-      [reply["Message"], reply["ErrorCode"]]
+      [reply["Message"], reply["ErrorCode"], reply]
     end
 
     def error(clazz, response_body)

data/lib/postmark/inbound.rb

@@ -0,0 +1,21 @@
+module Postmark
+  module Inbound
+    extend self
+
+    def to_ruby_hash(inbound)
+      inbound = Json.decode(inbound) if inbound.is_a?(String)
+      ret = HashHelper.to_ruby(inbound)
+      ret[:from_full] ||= {}
+      ret[:to_full] ||= []
+      ret[:cc_full] ||= []
+      ret[:headers] ||= []
+      ret[:attachments] ||= []
+      ret[:from_full] = HashHelper.to_ruby(ret[:from_full])
+      ret[:to_full] = ret[:to_full].map { |to| HashHelper.to_ruby(to) }
+      ret[:cc_full] = ret[:cc_full].map { |cc| HashHelper.to_ruby(cc) }
+      ret[:headers] = ret[:headers].map { |h| HashHelper.to_ruby(h) }
+      ret[:attachments] = ret[:attachments].map { |a| HashHelper.to_ruby(a) }
+      ret
+    end
+  end
+end

data/lib/postmark/inflector.rb

@@ -0,0 +1,28 @@
+module Postmark
+  module Inflector
+
+    extend self
+
+    def to_postmark(name)
+      name.to_s.split('_').map { |part| capitalize_first_letter(part) }.join('')
+    end
+
+    def to_ruby(name)
+      name.to_s.scan(camel_case_regexp).join('_').downcase.to_sym
+    end
+
+    def camel_case_regexp
+      /(?:[A-Z](?:(?:[A-Z]+(?![a-z\d]))|[a-z\d]*))|[a-z\d\_]+/
+    end
+
+    protected
+
+    def capitalize_first_letter(str)
+      if str.length > 0
+        str.slice(0..0).capitalize + str.slice(1..-1)
+      else
+        str
+      end
+    end
+  end
+end

data/lib/postmark/message_extensions/mail.rb

@@ -1,12 +1,12 @@
 module Mail
   class Message
-    
+
     include Postmark::SharedMessageExtensions
-    
+
     def html?
       content_type && content_type.include?('text/html')
     end
-    
+
     def body_html
       if html_part.nil?
         body.to_s if html?
@@ -17,7 +17,7 @@ module Mail
 
     def body_text
       if text_part.nil?
-        body.to_s
+        body.to_s unless html?
       else
         text_part.body.to_s
       end
@@ -27,6 +27,39 @@ module Mail
       export_native_attachments + postmark_attachments
     end
 
+    def export_headers
+      [].tap do |headers|
+        self.header.fields.each do |field|
+          key, value = field.name, field.value
+          next if bogus_headers.include? key.downcase
+          name = key.split(/-/).map { |i| i.capitalize }.join('-')
+
+          headers << { "Name" => name, "Value" => value }
+        end
+      end
+    end
+
+    def to_postmark_hash
+      options = Hash.new
+      headers = self.export_headers
+      attachments = self.export_attachments
+
+      options["From"] = self['from'].to_s if self.from
+      options["Subject"] = self.subject
+      options["Attachments"] = attachments unless attachments.empty?
+      options["Headers"] = headers if headers.size > 0
+      options["HtmlBody"] = self.body_html
+      options["TextBody"] = self.body_text
+      options["Tag"] = self.tag.to_s if self.tag
+
+      %w(to reply_to cc bcc).each do |field|
+        next unless value = self.send(field)
+        options[::Postmark::Inflector.to_postmark(field)] = Array[value].flatten.join(", ")
+      end
+
+      options.delete_if { |k,v| v.nil? || v.empty? }
+    end
+
   protected
 
     def export_native_attachments
@@ -36,6 +69,18 @@ module Mail
          "ContentType" => attachment.mime_type}
       end
     end
-    
+
+    def bogus_headers
+      %q[
+        return-path  x-pm-rcpt
+        from         reply-to
+        sender       received
+        date         content-type
+        cc           bcc
+        subject      tag
+        attachment
+      ]
+    end
+
   end
 end

data/lib/postmark/message_extensions/shared.rb

@@ -1,49 +1,44 @@
 module Postmark
   module SharedMessageExtensions
 
-    def tag
-      self['TAG']
+    def self.included(klass)
+      klass.instance_eval do
+        attr_accessor :delivered, :postmark_response
+      end
+    end
+
+    def delivered?
+      self.delivered
+    end
+
+    def tag(val = nil)
+      default 'TAG', val
     end
 
-    def tag=(value)
-      self['TAG'] = value
+    def tag=(val)
+      header['TAG'] = val
     end
 
     def postmark_attachments=(value)
-      @_attachments = wrap_in_array(value)
+      Kernel.warn("Mail::Message#postmark_attachments= is deprecated and will " \
+                  "be removed in the future. Please consider using the native " \
+                  "attachments API provided by Mail library.")
+      @_attachments = value
     end
 
     def postmark_attachments
       return [] if @_attachments.nil?
+      Kernel.warn("Mail::Message#postmark_attachments is deprecated and will " \
+                  "be removed in the future. Please consider using the native " \
+                  "attachments API provided by Mail library.")
 
-      @_attachments.map do |item|
-        if item.is_a?(Hash)
-          item
-        elsif item.is_a?(File)
-          {
-            "Name"        => item.path.split("/")[-1],
-            "Content"     => pack_attachment_data(IO.read(item.path)),
-            "ContentType" => "application/octet-stream"
-          }
-        end
-      end
+      Postmark::MessageHelper.attachments_to_postmark(@_attachments)
     end
 
     protected
 
     def pack_attachment_data(data)
-      [data].pack('m')
-    end
-
-    # From ActiveSupport (Array#wrap)
-    def wrap_in_array(object)
-      if object.nil?
-        []
-      elsif object.respond_to?(:to_ary)
-        object.to_ary || [object]
-      else
-        [object]
-      end
+      MessageHelper.encode_in_base64(data)
     end
 
   end

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = "0.9.19"
+  VERSION = "1.0.0"
 end

data/postmark.gemspec

@@ -23,7 +23,9 @@ Gem::Specification.new do |s|
 
   s.post_install_message = %q{
     ==================
-    Thanks for installing the postmark gem. If you don't have an account, please sign up at http://postmarkapp.com/.
+    Thanks for installing the postmark gem. If you don't have an account, please
+    sign up at http://postmarkapp.com/.
+
     Review the README.md for implementation details and examples.
     ==================
   }
@@ -33,12 +35,7 @@ Gem::Specification.new do |s|
   s.add_dependency "rake"
   s.add_dependency "json"
 
-  s.add_development_dependency "tmail"
   s.add_development_dependency "mail"
-  s.add_development_dependency "rspec-core", "~> 2.0"
   s.add_development_dependency "activesupport", "~> 3.0"
-  s.add_development_dependency "fakeweb"
-  s.add_development_dependency "fakeweb-matcher"
-  s.add_development_dependency "timecop"
-  s.add_development_dependency "yajl-ruby"
+  s.add_development_dependency "yajl-ruby" unless RUBY_PLATFORM == "java"
 end