postmark 0.8.0 → 0.9.0

data/CHANGELOG.rdoc

@@ -0,0 +1,9 @@
+= Changelog
+
+== 0.9.0
+
+* Added support for attachments.
+
+== 0.8.0
+
+* Added support for Rails 3.

data/README.rdoc

@@ -4,10 +4,6 @@ Ruby gem for sending emails through http://postmarkapp.com HTTP API
 
 == Install
 
-The gem is hosted at gemcutter. If you don't have it, install it first:
-
-    sudo gem install gemcutter
-Then
     sudo gem install postmark
 
 == Example
@@ -19,37 +15,48 @@ Then
     require 'tmail'
 
     Postmark.api_key = "your-api-key"
-
-    message = TMail::Mail.new
-    # make sure you have a sender signature with that email
-    # from and to also accept arrays of emails.
-    message.from = "leonard@bigbangtheory.com"
-    message.to = "Sheldon Cooper <sheldon@bigbangtheory.com>"
-    message.subject = "Hi Sheldon!"
+    
+    # Make sure you have a sender signature for every From email you specify.
+    # From can also accept array of addresses.   
+    
+    message              = TMail::Mail.new
+    message.from         = "leonard@bigbangtheory.com"
+    message.to           = "Sheldon Cooper <sheldon@bigbangtheory.com>"
+    message.subject      = "Hi Sheldon!"
     message.content_type = "text/html"
-    message.body = "Hello my friend!"
-    # set custom headers at will.
+    message.body         = "Hello my friend!"
+    
+    # You can set customer headers if you like:
     message["CUSTOM-HEADER"] = "my custom header value"
-    # tag message
+    
+    # Added a tag:
     message.tag = "my-tracking-tag"
-    # set reply to if you need; also, you can pass array of emails.
+    
+    # Add attachments:
+    message.postmark_attachments = [File.open("/path"), File.open("/path")]
+    
+    # Or specify a reply-to address (can also be an array of addresses):
     message.reply_to = "penny@bigbangtheory.com"
 
     Postmark.send_through_postmark(message)
 
 If you are using the Mail gem, you can also use Postmark as a delivery method like:
 
-		message = Mail.new
-		message.delivery_method Mail::Postmark, {:api_key => "your-api-key"}
-		message.deliver
+    message = Mail.new
+    message.delivery_method Mail::Postmark, {:api_key => "your-api-key"}
+    message.deliver
 
 You can retrieve various information about your server state using the Public bounces API - http://developer.postmarkapp.com/bounces
 
-    # get delivery stats
-    Postmark.delivery_stats # json
-    Postmark::Bounce.all # [ bounce, bounce ... ]
-    bounce = Postmark::Bounce.find(bounce_id) # Bounce
-    bounce.dump # string, containing raw SMTP data
+    # Get delivery stats: (JSON format)
+    Postmark.delivery_stats
+    
+    # Get bounces information: (array of bounce objects)    
+    Postmark::Bounce.all
+    
+    # Find specific bounce by id:    
+    bounce = Postmark::Bounce.find(bounce_id)    
+    bounce.dump       # string, containing raw SMTP data
     bounce.reactivate # reactivate hard bounce
 
 == Encryption
@@ -68,12 +75,6 @@ You can also explicitly specify which one to be used, using
 
     Postmark.response_parser_class = :Json # :ActiveSupport or :Yajl is also supported.
 
-== Limitations
-
-Currently postmark API does not support attachments. For more information, check the docs at:
-
-http://developer.postmarkapp.com
-
 == Note on Patches/Pull Requests
 
 * Fork the project.
@@ -83,6 +84,14 @@ http://developer.postmarkapp.com
 * Commit, do not mess with rakefile, version, or history.
 * Send me a pull request. Bonus points for topic branches.
 
+== Authors & Contributors
+
+* Petyo Ivanov
+* Ilya Sabanin
+* Hristo Deshev
+* Randy Schmidt
+* Chris Williams
+
 == Copyright
 
 Copyright (c) 2010 Wildbit LLC. See LICENSE for details.

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.description = %Q{Ruby gem for sending emails through http://postmarkapp.com HTTP API. It relieas on TMail::Mail for message construction.}
     gem.email = "underlog@gmail.com"
     gem.homepage = "http://postmarkapp.com"
-    gem.authors = ["Petyo Ivanov"]
+    gem.authors = ["Petyo Ivanov", "Ilya Sabanin"]
     gem.add_development_dependency "rspec"
     gem.add_development_dependency "cucumber"
     gem.add_dependency "tmail"

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.0

data/lib/postmark.rb

@@ -1,11 +1,18 @@
+def require_local(file)
+  require File.join(File.dirname(__FILE__), 'postmark', file)
+end
+
 require 'net/http'
 require 'net/https'
-require 'postmark/bounce'
-require 'postmark/json'
-require 'postmark/http_client'
-require 'postmark/tmail_mail_extension'
-require 'postmark/mail_message_extension'
-require 'mail/postmark'
+
+require_local 'bounce'
+require_local 'json'
+require_local 'http_client'
+require_local 'message_extensions/shared'
+require_local 'message_extensions/tmail'
+require_local 'message_extensions/mail'
+require_local 'handlers/mail'
+require_local 'attachments_fix_for_mail'
 
 module Postmark
 
@@ -98,8 +105,8 @@ module Postmark
     def delivery_stats
       HttpClient.get("deliverystats")
     end
-
-    protected
+    
+  protected
     
     def convert_mail(message)
       options = { "From" => message.from.to_s, "Subject" => message.subject }
@@ -114,6 +121,8 @@ module Postmark
       options["Cc"] = message.cc.join(", ").to_s unless message.cc.nil?
       
       options["Bcc"] = message.bcc.join(", ").to_s unless message.bcc.nil?
+      
+      options["Attachments"] = message.postmark_attachments unless message.postmark_attachments.nil?
 
       if reply_to = message['reply-to']
         options["ReplyTo"] = reply_to.to_s
@@ -155,6 +164,8 @@ module Postmark
       options["Cc"] = message['cc'].to_s unless message.cc.nil?
 
       options["Bcc"] = message['bcc'].to_s unless message.bcc.nil?
+      
+      options["Attachments"] = message.postmark_attachments unless message.postmark_attachments.nil?
 
       if reply_to = message['reply-to']
         options["ReplyTo"] = reply_to.to_s
@@ -197,9 +208,10 @@ module Postmark
         bcc
         subject
         tag
+        attachment
       ]
     end
-
+    
   end
 
   self.response_parser_class = nil

data/lib/postmark/attachments_fix_for_mail.rb

@@ -0,0 +1,43 @@
+module Postmark
+  
+  #
+  # This fix is needed solely to support neat Rails 3 syntax to create emails.
+  # That one:
+  #
+  #   def invitation
+  #     mail(
+  #       :to => "someone@example.com",
+  #       :postmark_attachments => [File.open(...)]
+  #     )
+  #   end
+  #
+  # That code will automatically put the file to Mail::OptionalField of the Mail::Message object
+  # and will try to encode it before delivery. You are not supposed to store files in
+  # such fields, so Mail will raise an exception. That's why before we actually perform a
+  # delivery we have to remove the files from OptionalField to a regular @_attachments variable.
+  #  
+  module AttachmentsFixForMail
+    
+    def self.included(base)
+      base.class_eval do      
+        alias_method_chain :deliver, :postmark_hook
+      end
+    end
+    
+    def deliver_with_postmark_hook
+      remove_postmark_attachments_from_standard_fields
+      deliver_without_postmark_hook
+    end
+    
+  private
+  
+    def remove_postmark_attachments_from_standard_fields
+      field = self['POSTMARK-ATTACHMENTS']
+      return if field.nil?
+      self.postmark_attachments = field.value
+      header.fields.delete_if{|f| f.name == 'postmark-attachments'}
+    end
+    
+  end
+  
+end

data/lib/{mail/postmark.rb → postmark/handlers/mail.rb}

@@ -1,14 +1,16 @@
 module Mail
   class Postmark
-    def initialize(values)
-      self.settings = {:api_key => nil}.merge(values)
-    end
     
     attr_accessor :settings
     
+    def initialize(values)
+      self.settings = { :api_key => nil }.merge(values)
+    end
+    
     def deliver!(mail)
       ::Postmark.api_key = settings[:api_key]
       ::Postmark.send_through_postmark(mail)
     end
+    
   end
 end

data/lib/postmark/{mail_message_extension.rb → message_extensions/mail.rb}

@@ -1,12 +1,7 @@
 module Mail
   class Message
-    def tag
-      self["TAG"]
-    end
-
-    def tag=(value)
-      self["TAG"] = value
-    end
+    
+    include Postmark::SharedMessageExtensions
     
     def body_html
       unless html_part.nil?
@@ -21,5 +16,6 @@ module Mail
         text_part.body.to_s
       end
     end
+    
   end
 end

data/lib/postmark/message_extensions/shared.rb

@@ -0,0 +1,33 @@
+module Postmark
+  module SharedMessageExtensions
+  
+    def tag
+      self['TAG']
+    end
+
+    def tag=(value)
+      self['TAG'] = value
+    end
+  
+    def postmark_attachments=(value)
+      @_attachments = value.is_a?(Array) ? value : [value]
+    end
+  
+    def postmark_attachments
+      return if @_attachments.nil?
+          
+      @_attachments.collect do |item|
+        if item.is_a?(Hash)
+          item
+        elsif item.is_a?(File)
+          {
+            "Name"        => item.path.split("/")[-1],
+            "Content"     => [ IO.read(item.path) ].pack("m"),
+            "ContentType" => "application/octet-stream"
+          }
+        end
+      end
+    end
+  
+  end
+end

data/lib/postmark/{tmail_mail_extension.rb → message_extensions/tmail.rb}

@@ -7,20 +7,14 @@
 #
 # This is a patch to try to resolve this
 #
-# just require 'tmail_mail_extension'
+# just require 'extensions/tmail'
 # and every TMail::Mail object will have the .body_html method
 #
 
 module TMail
   class Mail
-
-    def tag
-      self["TAG"]
-    end
-
-    def tag=(value)
-      self["TAG"] = value
-    end
+    
+    include Postmark::SharedMessageExtensions
 
     #
     # returs an String with just the html part of the body
@@ -86,7 +80,7 @@ module TMail
           header = part["content-type"]
 
           if part.multipart?
-            puts "    --multipartt--"
+            puts "    --multipart--"
             part.parts.each_with_index do |part2, index2|
               puts "    part[#{index}][#{index2}]"
               puts "      content_type: #{part2.content_type}"

data/postmark.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{postmark}
-  s.version = "0.8.0"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Petyo Ivanov"]
-  s.date = %q{2010-09-16}
+  s.authors = ["Petyo Ivanov", "Ilya Sabanin"]
+  s.date = %q{2010-09-17}
   s.description = %q{Ruby gem for sending emails through http://postmarkapp.com HTTP API. It relieas on TMail::Mail for message construction.}
   s.email = %q{underlog@gmail.com}
   s.extra_rdoc_files = [
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
      ".document",
      ".gitignore",
      ".rake_tasks",
+     "CHANGELOG.rdoc",
      "Gemfile",
      "Gemfile.lock",
      "LICENSE",
@@ -31,16 +32,18 @@ Gem::Specification.new do |s|
      "features/step_definitions/postmark_steps.rb",
      "features/support/env.rb",
      "init.rb",
-     "lib/mail/postmark.rb",
      "lib/postmark.rb",
+     "lib/postmark/attachments_fix_for_mail.rb",
      "lib/postmark/bounce.rb",
+     "lib/postmark/handlers/mail.rb",
      "lib/postmark/http_client.rb",
      "lib/postmark/json.rb",
-     "lib/postmark/mail_message_extension.rb",
+     "lib/postmark/message_extensions/mail.rb",
+     "lib/postmark/message_extensions/shared.rb",
+     "lib/postmark/message_extensions/tmail.rb",
      "lib/postmark/response_parsers/active_support.rb",
      "lib/postmark/response_parsers/json.rb",
      "lib/postmark/response_parsers/yajl.rb",
-     "lib/postmark/tmail_mail_extension.rb",
      "postmark.gemspec",
      "spec/bounce_spec.rb",
      "spec/postmark_spec.rb",

metadata

@@ -4,17 +4,18 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 8
+  - 9
   - 0
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Petyo Ivanov
+- Ilya Sabanin
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-09-16 00:00:00 +02:00
+date: 2010-09-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +68,7 @@ files:
 - .document
 - .gitignore
 - .rake_tasks
+- CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -77,16 +79,18 @@ files:
 - features/step_definitions/postmark_steps.rb
 - features/support/env.rb
 - init.rb
-- lib/mail/postmark.rb
 - lib/postmark.rb
+- lib/postmark/attachments_fix_for_mail.rb
 - lib/postmark/bounce.rb
+- lib/postmark/handlers/mail.rb
 - lib/postmark/http_client.rb
 - lib/postmark/json.rb
-- lib/postmark/mail_message_extension.rb
+- lib/postmark/message_extensions/mail.rb
+- lib/postmark/message_extensions/shared.rb
+- lib/postmark/message_extensions/tmail.rb
 - lib/postmark/response_parsers/active_support.rb
 - lib/postmark/response_parsers/json.rb
 - lib/postmark/response_parsers/yajl.rb
-- lib/postmark/tmail_mail_extension.rb
 - postmark.gemspec
 - spec/bounce_spec.rb
 - spec/postmark_spec.rb