postmark 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1079afd6778085afa9f62fe85bb8e3cc43af05b2
-  data.tar.gz: d3f376703b377cd3ebe1befa1a21f0119888341f
+  metadata.gz: 43ae963225ea68dd15633af53a029cfd01a786b5
+  data.tar.gz: 99b445605debe412833a560b4baedcfec0a37ea1
 SHA512:
-  metadata.gz: 2154a90bdf624d656668b68f347b2c5e75c02fc3130c7edcf39a808fabb8324aa1d232b69224e23120eb32e40191fc364e2cb521777916777647db0217d0697e
-  data.tar.gz: 9206abd5fbef93c472bd2ecd51358b0f0c3512e98d1222ec8f310ee6377231297de1bc9bb5abb950bc6e314c4ca425ae6ce3e6fa6c82f962c75e9b45bed9ab11
+  metadata.gz: 90e0fcef06267ce2ad965391348e3786a1999f4d0e889f5a5ab284ce13cd0816e31bdd6818886afdf2e0abc3d38cb716a65529cc592e1d0f80d82f5ce40b52b6
+  data.tar.gz: f553e8b2b973f75b46812a6e7dcf3fb0b86fe2cf07c1128067de8a129d0b1f1108080ece56a298a3c913b58399425d3a5ae55a2334704b8e301df661f669535f

data/.travis.yml

@@ -1,11 +1,14 @@
+env:
+  global:
+    secure: MV+nKlzuLJ5CEoEfCmzwRMlnBOudgB1fTxBYI6aDV9vUkwYRzkcpCPS+Ik6jdCzNEFK+L2dTfv/IfDOvxnK3cZpMi1sp0po04m3Pg+ZhzYoANS1KY6V4sFIFaPtx+x2DVStxjFch4WQV8ktzdoUI0POlCdJrD6GYXLh1aTgbAGU=
 language: ruby
 before_install:
-  - gem update --system 2.1.11
-  - gem --version
+- gem update --system 2.1.11
+- gem --version
 rvm:
-  - "1.8.7"
-  - "1.9.2"
-  - "1.9.3"
-  - "2.0.0"
-  - "jruby-19mode"
+- 1.8.7
+- 1.9.2
+- 1.9.3
+- 2.0.0
+- jruby-19mode
 script: bundle exec rake spec

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
 = Changelog
 
+== 1.1.0
+
+* Added support for inline attachments when using the Mail gem.
+* Added support for the Postmark Messages API.
+
 == 1.0.2
 
 * Removed metaprogramming executed at runtime. [#37]

data/README.md

@@ -83,17 +83,23 @@ client.deliver(from: 'sheldon@bigbangtheory.com',
 
 You can add
 [attachments](http://developer.postmarkapp.com/developer-build.html#attachments)
-to your messages. Keep in mind message size limit (contents and attachment) is currently 10 MB.
+to your messages. Keep in mind message size limit (contents and attachment) is currently 10 MB. For inline attachments it is possible to specify content IDs via the `content_id` attribute.
 
 ``` ruby
 client.deliver(from: 'leonard@bigbangtheory.com',
                to: 'Dr. Sheldon Cooper <sheldon@bigbangtheory.com>',
                subject: 'Have you seen these pictures of yours?',
                text_body: 'You look like a real geek!',
+               html_body: '<p>You look like a real geek!</p><center><img src="cid:42"></center>',
                attachments: [File.open('1.jpeg'),
                              {name: 'sheldon.jpeg',
                               content: [File.read('2.jpeg')].pack('m'),
-                              content_type: 'image/jpeg'}])
+                              content_type: 'image/jpeg'},
+                             {name: 'logo.png',
+                              content: [File.read('1.png')].pack('m'),
+                              content_type: 'image/png',
+                              content_id: 'cid:42'}])
+
 # => {:to=>"Dr. Sheldon Cooper <sheldon@bigbangtheory.com>", :submitted_at=>"2013-05-09T02:56:12.2828813-04:00", :message_id=>"8ec0d283-8b93-xxxx-9d65-241d1777cf0f", :error_code=>0, :message=>"OK"}
 ```
 
@@ -221,6 +227,34 @@ ruby_hash = Postmark::Inbound.to_ruby_hash(postmark_hash)
 # => {:from=>"myUser@theirDomain.com", :from_full=>{:email=>"myUser@theirDomain.com", :name=>"John Doe"}, :to=>"451d9b70cf9364d23ff6f9d51d870251569e+ahoy@inbound.postmarkapp.com", :to_full=>[{:email=>"451d9b70cf9364d23ff6f9d51d870251569e+ahoy@inbound.postmarkapp.com", :name=>""}], :cc=>"\"Full name\" <sample.cc@emailDomain.com>, \"Another Cc\" <another.cc@emailDomain.com>", :cc_full=>[{:email=>"sample.cc@emailDomain.com", :name=>"Full name"}, {:email=>"another.cc@emailDomain.com", :name=>"Another Cc"}], :reply_to=>"myUsersReplyAddress@theirDomain.com", :subject=>"This is an inbound message", :message_id=>"22c74902-a0c1-4511-804f2-341342852c90", :date=>"Thu, 5 Apr 2012 16:59:01 +0200", :mailbox_hash=>"ahoy", :text_body=>"[ASCII]", :html_body=>"[HTML(encoded)]", :tag=>"", :headers=>[{:name=>"X-Spam-Checker-Version", :value=>"SpamAssassin 3.3.1 (2010-03-16) onrs-ord-pm-inbound1.wildbit.com"}, {:name=>"X-Spam-Status", :value=>"No"}, {:name=>"X-Spam-Score", :value=>"-0.1"}, {:name=>"X-Spam-Tests", :value=>"DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,SPF_PASS"}, {:name=>"Received-SPF", :value=>"Pass (sender SPF authorized) identity=mailfrom; client-ip=209.85.160.180; helo=mail-gy0-f180.google.com; envelope-from=myUser@theirDomain.com; receiver=451d9b70cf9364d23ff6f9d51d870251569e+ahoy@inbound.postmarkapp.com"}, {:name=>"DKIM-Signature", :value=>"v=1; a=rsa-sha256; c=relaxed/relaxed;        d=wildbit.com; s=google;        h=mime-version:reply-to:date:message-id:subject:from:to:cc         :content-type;        bh=cYr/+oQiklaYbBJOQU3CdAnyhCTuvemrU36WT7cPNt0=;        b=QsegXXbTbC4CMirl7A3VjDHyXbEsbCUTPL5vEHa7hNkkUTxXOK+dQA0JwgBHq5C+1u         iuAJMz+SNBoTqEDqte2ckDvG2SeFR+Edip10p80TFGLp5RucaYvkwJTyuwsA7xd78NKT         Q9ou6L1hgy/MbKChnp2kxHOtYNOrrszY3JfQM="}, {:name=>"MIME-Version", :value=>"1.0"}, {:name=>"Message-ID", :value=>"<CAGXpo2WKfxHWZ5UFYCR3H_J9SNMG+5AXUovfEFL6DjWBJSyZaA@mail.gmail.com>"}], :attachments=>[{:name=>"myimage.png", :content=>"[BASE64-ENCODED CONTENT]", :content_type=>"image/png", :content_length=>4096}, {:name=>"mypaper.doc", :content=>"[BASE64-ENCODED CONTENT]", :content_type=>"application/msword", :content_length=>16384}]}
 ```
 
+## Working with messages
+
+Use `#get_messages` to retrieve messages (`:count` and `:offset` parameters 
+control pagination). Access inbound messages by passing `:inbound => true` as
+a parameter.
+
+``` ruby
+client.get_messages(count: 1, offset: 0)
+# => [{:message_id=>"41f03342-xxxx-xxxx-xxxx-558caedb5e82", :to=>[{"Email"=>"info@wildbit.com", "Name"=>nil}], :cc=>[], :bcc=>[], :recipients=>["info@wildbit.com"], :received_at=>"2014-01-15T16:41:22.4533537-05:00", :from=>"\"Postmark\" <support@postmarkapp.com>", :subject=>"Good Luck With The Gem", :attachments=>[]}] 
+```
+
+Use `#get_message` to get details for a specific message using ID:
+
+``` ruby
+client.get_message('41f03342-xxxx-xxxx-xxxx-558caedb5e82')
+# => {:text_body=>"...", :body=>"...", :message_id=>"41f03342-xxxx-xxxx-xxxx-558caedb5e82", :to=>[{"Email"=>"info@wildbit.com", "Name"=>nil}], :cc=>[], :bcc=>[], :recipients=>["info@wildbit.com"], :received_at=>"2014-01-15T16:41:22.4533537-05:00", :from=>"\"Postmark\" <support@postmarkapp.com>", :subject=>"Good Luck With The Gem", :attachments=>[]}
+```
+
+Use `#dump_message` to get the full message body:
+
+``` ruby
+client.dump_message('41f03342-xxxx-xxxx-xxxx-558caedb5e82')
+# => {:body=>"..."}
+```
+
+You can get more details about the underlying endpoints and parameters they
+accept in [Postmark Developer Docs](http://developer.postmarkapp.com/developer-messages.html).
+
 ## Working with bounces
 
 Use `#get_bounces` to retrieve a list of bounces (use `:count` and `:offset`
@@ -374,6 +408,18 @@ message.deliver
 # => #<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>>
 ```
 
+You can also make an attachment inline:
+
+``` ruby
+message.attachments.inline['sheldon.jpeg'] = File.read('2.jpeg')
+```
+
+Then simply use `Mail::Part#url` method to reference it from your email body.
+
+``` erb
+<p><img src="<%= message.attachments['sheldon.jpeg'].url %>" alt="Dr. Sheldon Cooper"></p>
+```
+
 ## Multipart message
 
 You can send multipart messages containing both text and HTML using the Postmark gem.
@@ -574,4 +620,4 @@ Postmark.response_parser_class = :Json # :ActiveSupport or :Yajl are also suppor
 
 ## Copyright
 
-Copyright © 2013 Wildbit LLC. See LICENSE for details.
+Copyright © 2014 Wildbit LLC. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.0

data/lib/postmark/api_client.rb

@@ -65,6 +65,21 @@ module Postmark
       response
     end
 
+    def get_messages(options = {})
+      path, params = extract_messages_path_and_params(options)
+      params[:offset] ||= 0
+      params[:count] ||= 50
+      format_response http_client.get(path, params)['Messages']
+    end
+
+    def get_message(id, options = {})
+      get_for_message('details', id, options)
+    end
+
+    def dump_message(id, options = {})
+      get_for_message('dump', id, options)
+    end
+
     def get_bounces(options = {})
       format_response http_client.get("bounces", options)["Bounces"]
     end
@@ -136,6 +151,11 @@ module Postmark
       [e.full_response || {}, e]
     end
 
+    def get_for_message(action, id, options = {})
+      path, params = extract_messages_path_and_params(options)
+      format_response http_client.get("#{path}/#{id}/#{action}", params)
+    end
+
     def format_response(response, compatible = false)
       return {} unless response
 
@@ -146,5 +166,11 @@ module Postmark
       end
     end
 
+    def extract_messages_path_and_params(options = {})
+      options = options.dup
+      path = options.delete(:inbound) ? 'messages/inbound' : 'messages/outbound'
+      [path, options]
+    end
+
   end
 end

data/lib/postmark/message_extensions/mail.rb

@@ -47,9 +47,12 @@ module Mail
 
     def export_native_attachments
       attachments.map do |attachment|
-        {"Name" => attachment.filename,
-         "Content" => pack_attachment_data(attachment.body.decoded),
-         "ContentType" => attachment.mime_type}
+        basics = {"Name" => attachment.filename,
+                  "Content" => pack_attachment_data(attachment.body.decoded),
+                  "ContentType" => attachment.mime_type}
+        specials = attachment.inline? ? {'ContentID' => attachment.url} : {}
+
+        basics.update(specials)
       end
     end
 

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/spec/integration/api_client_hashes_spec.rb

@@ -2,7 +2,9 @@ require 'spec_helper'
 
 describe "Sending messages as Ruby hashes with Postmark::ApiClient" do
   let(:postmark_message_id_format) { /\w{8}\-\w{4}-\w{4}-\w{4}-\w{12}/ }
-  let(:api_client) { Postmark::ApiClient.new('POSTMARK_API_TEST') }
+  let(:api_client) {
+    Postmark::ApiClient.new('POSTMARK_API_TEST', :http_open_timeout => 15)
+  }
 
   let(:message) {
     {

data/spec/integration/api_client_messages_spec.rb

@@ -2,7 +2,9 @@ require 'spec_helper'
 
 describe "Sending Mail::Messages with Postmark::ApiClient" do
   let(:postmark_message_id_format) { /\w{8}\-\w{4}-\w{4}-\w{4}-\w{12}/ }
-  let(:api_client) { Postmark::ApiClient.new('POSTMARK_API_TEST') }
+  let(:api_client) {
+    Postmark::ApiClient.new('POSTMARK_API_TEST', :http_open_timeout => 15)
+  }
 
   let(:message) {
     Mail.new do

data/spec/integration/api_client_resources_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe 'Accessing server resources using the API' do
+
+  let(:api_client) {
+    Postmark::ApiClient.new(ENV['POSTMARK_API_KEY'], :http_open_timeout => 15)
+  }
+  let(:recipient) { ENV['POSTMARK_CI_RECIPIENT'] }
+  let(:message) {
+    {
+      :from => "tema+ci@wildbit.com",
+      :to => recipient,
+      :subject => "Mail::Message object",
+      :text_body => "Lorem ipsum dolor sit amet, consectetur adipisicing elit, " \
+                    "sed do eiusmod tempor incididunt ut labore et dolore " \
+                    "magna aliqua."
+    }
+  }
+
+  context 'Messages API' do
+
+    def with_retries(max_retries = 20, wait_seconds = 3)
+      yield
+    rescue => e
+      retries = retries ? retries + 1 : 1
+      if retries < max_retries
+        sleep wait_seconds
+        retry
+      else
+        raise e
+      end
+    end
+
+    it 'is possible to send a message and access its details via the Messages API' do
+      response = api_client.deliver(message)
+      message = with_retries {
+        api_client.get_message(response[:message_id])
+      }
+      expect(message[:recipients]).to include(recipient)
+    end
+
+    it 'is possible to send a message and dump it via the Messages API' do
+      response = api_client.deliver(message)
+      dump = with_retries {
+        api_client.dump_message(response[:message_id])
+      }
+      expect(dump[:body]).to include('Mail::Message object')
+    end
+
+    it 'is possible to send a message and find it via the Messages API' do
+      response = api_client.deliver(message)
+      expect {
+        with_retries {
+          messages = api_client.get_messages(:recipient => recipient,
+                                  :fromemail => message[:from],
+                                  :subject => message[:subject])
+          unless messages.map { |m| m[:message_id] }.include?(response[:message_id])
+            raise 'Message not found'
+          end
+        }
+      }.not_to raise_error
+    end
+
+  end
+
+end

data/spec/integration/mail_delivery_method_spec.rb

@@ -10,7 +10,8 @@ describe "Sending Mail::Messages with delivery_method Mail::Postmark" do
       subject "Mail::Message object"
       body "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do "
            "eiusmod tempor incididunt ut labore et dolore magna aliqua."
-      delivery_method Mail::Postmark, :api_key => "POSTMARK_API_TEST"
+      delivery_method Mail::Postmark, :api_key => "POSTMARK_API_TEST", :http_open_timeout => 15
+
     end
   }
 
@@ -24,7 +25,7 @@ describe "Sending Mail::Messages with delivery_method Mail::Postmark" do
     Mail.new do
       from "sender@postmarkapp.com"
       to "recipient@postmarkapp.com"
-      delivery_method Mail::Postmark, :api_key => "POSTMARK_API_TEST"
+      delivery_method Mail::Postmark, :api_key => "POSTMARK_API_TEST", :http_open_timeout => 15
     end
   }
 
@@ -38,7 +39,7 @@ describe "Sending Mail::Messages with delivery_method Mail::Postmark" do
     Mail.new do
       from "sender@postmarkapp.com"
       to "@postmarkapp.com"
-      delivery_method Mail::Postmark, :api_key => "POSTMARK_API_TEST"
+      delivery_method Mail::Postmark, :api_key => "POSTMARK_API_TEST", :http_open_timeout => 15
     end
   }
 

data/spec/unit/postmark/api_client_spec.rb

@@ -170,6 +170,90 @@ describe Postmark::ApiClient do
     end
   end
 
+  describe '#get_messages' do
+    let(:http_client) { subject.http_client }
+    let(:response) { {"TotalCount" => 1, "Messages" => [{}]} }
+
+    context 'given outbound' do
+
+      it 'requests data at /messages/outbound' do
+        http_client.should_receive(:get).
+                    with('messages/outbound', :offset => 50, :count => 50).
+                    and_return(response)
+        subject.get_messages(:offset => 50, :count => 50)
+      end
+
+    end
+
+    context 'given inbound' do
+
+      it 'requests data at /messages/inbound' do
+        http_client.should_receive(:get).
+                    with('messages/inbound', :offset => 50, :count => 50).
+                    and_return(response)
+        subject.get_messages(:inbound => true, :offset => 50, :count => 50).
+                should be_an(Array)
+      end
+
+    end
+  end
+
+  describe '#get_message' do
+    let(:id) { '8ad0e8b0-xxxx-xxxx-951d-223c581bb467' }
+    let(:http_client) { subject.http_client }
+    let(:response) { {"To" => "leonard@bigbangtheory.com"} }
+
+    context 'given outbound' do
+
+      it 'requests a single message by id at /messages/outbound/:id/details' do
+        http_client.should_receive(:get).
+                    with("messages/outbound/#{id}/details", {}).
+                    and_return(response)
+        subject.get_message(id).should have_key(:to)
+      end
+
+    end
+
+    context 'given inbound' do
+
+      it 'requests a single message by id at /messages/inbound/:id/details' do
+        http_client.should_receive(:get).
+                    with("messages/inbound/#{id}/details", {}).
+                    and_return(response)
+        subject.get_message(id, :inbound => true).should have_key(:to)
+      end
+
+    end
+  end
+
+  describe '#dump_message' do
+    let(:id) { '8ad0e8b0-xxxx-xxxx-951d-223c581bb467' }
+    let(:http_client) { subject.http_client }
+    let(:response) { {"Body" => "From: <leonard@bigbangtheory.com> \r\n ..."} }
+
+    context 'given outbound' do
+
+      it 'requests a single message by id at /messages/outbound/:id/dump' do
+        http_client.should_receive(:get).
+                    with("messages/outbound/#{id}/dump", {}).
+                    and_return(response)
+        subject.dump_message(id).should have_key(:body)
+      end
+
+    end
+
+    context 'given inbound' do
+
+      it 'requests a single message by id at /messages/inbound/:id/dump' do
+        http_client.should_receive(:get).
+                    with("messages/inbound/#{id}/dump", {}).
+                    and_return(response)
+        subject.dump_message(id, :inbound => true).should have_key(:body)
+      end
+
+    end
+  end
+
   describe "#get_bounces" do
     let(:http_client) { subject.http_client }
     let(:options) { {:foo => :bar} }

data/spec/unit/postmark/message_extensions/mail_spec.rb

@@ -106,22 +106,40 @@ describe Mail::Message do
 
   describe "#export_attachments" do
     let(:file_data) { 'binarydatahere' }
-    let(:exported_data) do
+    let(:exported_data) {
       {'Name' => 'face.jpeg',
        'Content' => "YmluYXJ5ZGF0YWhlcmU=\n",
        'ContentType' => 'image/jpeg'}
-    end
+    }
+
+    context 'given a regular attachment' do
+
+      it "exports native attachments" do
+        mail_message.attachments["face.jpeg"] = file_data
+        mail_message.export_attachments.should include(exported_data)
+      end
+
+      it "still supports the deprecated attachments API" do
+        mail_message.attachments["face.jpeg"] = file_data
+        mail_message.postmark_attachments = exported_data
+        mail_message.export_attachments.should == [exported_data, exported_data]
+      end
 
-    it "exports native attachments" do
-      mail_message.attachments["face.jpeg"] = file_data
-      mail_message.export_attachments.should include(exported_data)
     end
 
-    it "still supports the deprecated attachments API" do
-      mail_message.attachments["face.jpeg"] = file_data
-      mail_message.postmark_attachments = exported_data
-      mail_message.export_attachments.should == [exported_data, exported_data]
+    context 'given an inline attachment' do
+
+      it "exports the attachment with related content id" do
+        mail_message.attachments.inline["face.jpeg"] = file_data
+        attachments = mail_message.export_attachments
+        attachments.count.should_not be_zero
+        attachments.first.should include(exported_data)
+        attachments.first.should have_key('ContentID')
+        attachments.first['ContentID'].should start_with('cid:')
+      end
+
     end
+
   end
 
   describe "#export_headers" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Petyo Ivanov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -124,6 +124,7 @@ files:
 - spec/data/empty.gif
 - spec/integration/api_client_hashes_spec.rb
 - spec/integration/api_client_messages_spec.rb
+- spec/integration/api_client_resources_spec.rb
 - spec/integration/mail_delivery_method_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
@@ -172,6 +173,7 @@ test_files:
 - spec/data/empty.gif
 - spec/integration/api_client_hashes_spec.rb
 - spec/integration/api_client_messages_spec.rb
+- spec/integration/api_client_resources_spec.rb
 - spec/integration/mail_delivery_method_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb