postmark 0.9.18 → 0.9.19

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Changelog
 
+== 0.9.19
+
+* Added support for native attachments API provided by Ruby Mail library.
+
 == 0.9.18
 
 * Fixed regression introduced by removing ActiveSupport#wrap in case when a Hash instance is passed.

data/README.md

@@ -84,34 +84,21 @@ message.deliver
 
 ### Message with attachments
 
-You can use postmark gem to send messages with attachments. Please note that:
-
-* Only allowed file types can be sent as attachments. The message will be rejected (or you will get an SMTP API bounce if using SMTP) with a description of the rejected file, if you try to send a file with a disallowed extension.
-* Attachment size can be 10 MB at most. That means you can send three attachments weighing at three megabytes each, but you won't be able to send a single 11MB attachment. Don't worry about base64 encoding making your data larger than it really is. Attachment size is calculated using the real binary data (after base64-decoding it).
-* Many applications can get away with sending email as a response to a user action and do that right in the same web request handler. Sending attachments changes that. Message size can and will get bigger and the time to submit it to the Postmark servers will get longer. That is why we recommend that you send email with attachments from a background job. Your users will love you for that!
-
-Check out our [special documentation section](http://developer.postmarkapp.com/developer-build.html#attachments)
-for detailed information.
-
 ``` ruby
-require 'rubygems'
-require 'postmark'
-require 'mail'
-require 'json'
-
 message = Mail.new do
   from            'leonard@bigbangtheory.com'
   to              'Dr. Sheldon Cooper <sheldon@bigbangtheory.com>'
   subject         'Have you seen these pictures of yours?'
   body            'You look like a real geek!'
+  add_file        '1.jpeg'
 
   delivery_method Mail::Postmark, :api_key => 'your-postmark-api-key'
 end
 
-message.postmark_attachments = [File.open("1.jpeg"), File.open("2.jpeg")]
+message.attachments['sheldon.jpeg'] = File.read('2.jpeg')
 
 message.deliver
-# => <Mail::Message:70235449249320, Multipart: false, Headers: <From: leonard@bigbangtheory.com>, <To: sheldon@bigbangtheory.com>, <Message-ID: 91cbdb90-9daa-455d-af24-e233711b02c2>, <Subject: Have you seen these pictures of yours?>>
+# => #<Mail::Message:70185826686240, Multipart: true, Headers: <From: leonard@bigbangtheory.com>, <To: sheldon@bigbangtheory.com>, <Message-ID: ba644cc1-b5b1-4bcb-aaf8-2f290b5aad80>, <Subject: Have you seen these pictures of yours?>, <Content-Type: multipart/mixed; boundary=--==_mimepart_5121f9f1ec653_12c53fd569035ad817726>> 
 ```
 
 ### Multipart message

data/VERSION

@@ -1 +1 @@
-0.9.18
+0.9.19

data/lib/postmark.rb

@@ -96,6 +96,7 @@ module Postmark
   def convert_message_to_options_hash(message)
     options = Hash.new
     headers = extract_headers_according_to_message_format(message)
+    attachments = message.export_attachments
 
     options["From"]        = message['from'].to_s                       if message.from
     options["ReplyTo"]     = Array[message.reply_to].flatten.join(", ") if message.reply_to
@@ -103,11 +104,11 @@ module Postmark
     options["Cc"]          = message['cc'].to_s                         if message.cc
     options["Bcc"]         = Array[message.bcc].flatten.join(", ")      if message.bcc
     options["Subject"]     = message.subject
-    options["Attachments"] = message.postmark_attachments
+    options["Attachments"] = attachments                                unless attachments.empty?
     options["Tag"]         = message.tag.to_s                           if message.tag
     options["Headers"]     = headers                                    if headers.size > 0
 
-    options = options.delete_if{|k,v| v.nil?}
+    options = options.delete_if { |k,v| v.nil? }
 
     html = message.body_html
     text = message.body_text

data/lib/postmark/message_extensions/mail.rb

@@ -22,6 +22,20 @@ module Mail
         text_part.body.to_s
       end
     end
+
+    def export_attachments
+      export_native_attachments + postmark_attachments
+    end
+
+  protected
+
+    def export_native_attachments
+      attachments.map do |attachment|
+        {"Name" => attachment.filename,
+         "Content" => pack_attachment_data(attachment.body.decoded),
+         "ContentType" => attachment.mime_type}
+      end
+    end
     
   end
 end

data/lib/postmark/message_extensions/shared.rb

@@ -14,7 +14,7 @@ module Postmark
     end
 
     def postmark_attachments
-      return if @_attachments.nil?
+      return [] if @_attachments.nil?
 
       @_attachments.map do |item|
         if item.is_a?(Hash)
@@ -22,7 +22,7 @@ module Postmark
         elsif item.is_a?(File)
           {
             "Name"        => item.path.split("/")[-1],
-            "Content"     => [ IO.read(item.path) ].pack("m"),
+            "Content"     => pack_attachment_data(IO.read(item.path)),
             "ContentType" => "application/octet-stream"
           }
         end
@@ -31,6 +31,10 @@ module Postmark
 
     protected
 
+    def pack_attachment_data(data)
+      [data].pack('m')
+    end
+
     # From ActiveSupport (Array#wrap)
     def wrap_in_array(object)
       if object.nil?

data/lib/postmark/message_extensions/tmail.rb

@@ -107,5 +107,9 @@ module TMail
       puts "END"
     end
 
+    def export_attachments
+      postmark_attachments
+    end
+
   end
 end

data/lib/postmark/version.rb

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

data/spec/postmark_spec.rb

@@ -187,9 +187,18 @@ describe Postmark do
     end
   end
 
-  context "attachments setter", :ruby => 1.9 do
-    let(:attached_hash) { { "Name" => "picture.jpeg", "ContentType" => "image/jpeg" } }
+  context "attachments setter" do
     let(:attached_file) { mock("file") }
+    let(:attached_hash) { {'Name' => 'picture.jpeg',
+                           'ContentType' => 'image/jpeg'} }
+    let(:exported_file) { {'Name' => 'file.jpeg',
+                           'ContentType' => 'application/octet-stream',
+                           'Content' => ''} }
+
+    before do
+      attached_file.stub(:is_a?) { |arg| arg == File ? true : false }
+      attached_file.stub(:path) { '/tmp/file.jpeg' }
+    end
 
     it "should store attachments as array" do
       mail_message.postmark_attachments = attached_hash
@@ -197,17 +206,31 @@ describe Postmark do
     end
 
     it "should save the attachments in attachments array" do
-      mail_message.postmark_attachments = [attached_hash, attached_file]
-
-      attached_file.stub(:is_a?) { |arg| arg == File ? true : false }
-      attached_file.stub(:path) { '/tmp/file.jpeg' }
       IO.should_receive(:read).with("/tmp/file.jpeg").and_return("")
 
       mail_message.postmark_attachments = [attached_hash, attached_file]
-      attachments = mail_message.postmark_attachments.map { |a| a['Name'] }
+      attachments = mail_message.export_attachments
+
+      attachments.should include(attached_hash)
+      attachments.should include(exported_file)
+    end
+  end
+
+  context "native attachments" do
+    let(:file_data) { 'binarydatahere' }
+    let(:exported_data) do
+      {'Name' => 'face.jpeg',
+       'Content' => "YmluYXJ5ZGF0YWhlcmU=\n",
+       'ContentType' => 'image/jpeg'}
+    end
+
+    before do
+      mail_message.attachments["face.jpeg"] = file_data
+    end
 
-      attachments.should include('picture.jpeg')
-      attachments.should include('file.jpeg')
+    it "exports native attachments" do
+      attachments = mail_message.export_attachments
+      attachments.should include(exported_data)
     end
   end
 

metadata

@@ -1,176 +1,187 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: postmark
-version: !ruby/object:Gem::Version 
-  hash: 31
+version: !ruby/object:Gem::Version
+  version: 0.9.19
   prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 18
-  version: 0.9.18
 platform: ruby
-authors: 
+authors:
 - Petyo Ivanov
 - Ilya Sabanin
 - Artem Chistyakov
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-01-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  type: :runtime
+date: 2013-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: json
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: tmail
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: mail
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
-  prerelease: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  name: activesupport
-  requirement: *id006
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  name: fakeweb
-  requirement: *id007
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: fakeweb-matcher
-  requirement: *id008
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb-matcher
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: timecop
-  requirement: *id009
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: *id010
-description: Use this gem to send emails through Postmark HTTP API and retrieve info about bounces.
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use this gem to send emails through Postmark HTTP API and retrieve info
+  about bounces.
 email: ilya@wildbit.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
-files: 
+files:
 - .document
 - .gitignore
 - .rake_tasks
@@ -202,40 +213,36 @@ files:
 - spec/spec_helper.rb
 homepage: http://postmarkapp.com
 licenses: []
-
-post_install_message: "\n    ==================\n    Thanks for installing the postmark gem. If you don't have an account, please sign up at http://postmarkapp.com/.\n    Review the README.md for implementation details and examples.\n    ==================\n  "
-rdoc_options: 
+post_install_message: ! "\n    ==================\n    Thanks for installing the postmark
+  gem. If you don't have an account, please sign up at http://postmarkapp.com/.\n
+  \   Review the README.md for implementation details and examples.\n    ==================\n
+  \ "
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -1526820895297093205
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 21
-      segments: 
-      - 1
-      - 3
-      - 7
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.7
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Official Postmark API wrapper.
-test_files: 
+test_files:
 - spec/bounce_spec.rb
 - spec/postmark_spec.rb
 - spec/shared_examples.rb