postmark 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8805ed14f8ffc61a08bc09e84eee2295b58eaa21
-  data.tar.gz: c7cfb0d603081a3b87d9be13f5580c44e997dca9
+  metadata.gz: c414ac502ae3d54ffecc5b0d6a04a667c1a654c2
+  data.tar.gz: 908d808ab21e2e296464ba06e7d27e4d8af39585
 SHA512:
-  metadata.gz: c0d157f01d2f9fa37a0797bc8714570766e36fd9e0530382c1d9ee79ec8b28ea3268cd76983baf2d7a72c73ccdb509c65806ba474aa98eab67637bb0bb0b200a
-  data.tar.gz: 5a25f5e31dc092898b8939118f943dc931cb92b5e30e23795f85ce4b8c5d6c335135810a206b7a06b2195ebf5248a7c076e52ca819f9836bb30d55b2175e905e
+  metadata.gz: 6a4f9cf05ae33f8f0ca016a652cf64bf9efd2c7963c7fd48880f6ea7656247267802a3da886ee43174e8ceecdde33056d8e0339de8ca6a64473e0154ab5f6728
+  data.tar.gz: da5f57cc564fa14b9110b36e5bd2f6adcf6dc149ba03d092ba1affc0eef337afc3c6ee1be12a3069bc57f37e2b1f34ca177dc684ca4522c5de7f136e6a2a6add

data/CHANGELOG.rdoc

@@ -1,5 +1,11 @@
 = Changelog
 
+== 1.3.0
+
+* Add support for TrackOpens flag of the Delivery API.
+* Add support for the Opens API.
+* Add support for the Triggers API.
+
 == 1.2.1
 
 * Fixed a bug in Postmark::ApiClient causing #get_bounces to return unexpected value.

data/Gemfile

@@ -7,4 +7,5 @@ group :test do
   gem 'rspec', '~> 2.14.0'
   gem 'fakeweb'
   gem 'fakeweb-matcher'
+  gem 'mime-types', '~> 1.25.1'
 end

data/README.md

@@ -67,7 +67,9 @@ client.deliver(from: 'sheldon@bigbangtheory.com',
 # => {:to=>"Leonard Hofstadter <leonard@bigbangtheory.com>", :submitted_at=>"2013-05-09T02:45:16.2059023-04:00", :message_id=>"b2b268e3-6a70-xxxx-b897-49c9eb8b1d2e", :error_code=>0, :message=>"OK"}
 ```
 
-## Sending an HTML message
+## Sending an HTML message (with open tracking!)
+
+Simply pass an HTML document as html_body parameter to `#deliver`. You can also enable open tracking by setting `track_opens` to `true`.
 
 ``` ruby
 client.deliver(from: 'sheldon@bigbangtheory.com',
@@ -75,7 +77,8 @@ client.deliver(from: 'sheldon@bigbangtheory.com',
                subject: 'Re: What, to you, is a large crowd?',
                html_body: '<p>Any group big enough to trample me to death. ' \
                           'General rule of thumb is 36 adults or 70 ' \
-                          'children.</p>')
+                          'children.</p>',
+               track_opens: true)
 # => {:to=>"Leonard Hofstadter <leonard@bigbangtheory.com>", :submitted_at=>"2013-05-09T02:51:08.8789433-04:00", :message_id=>"75c28987-564e-xxxx-b6eb-e8071873ac06", :error_code=>0, :message=>"OK"}
 ```
 
@@ -227,41 +230,6 @@ 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=>"..."}
-```
-
-There is also a handy `#messages` enumerator allowing you to easily manipulate big data arrays.
-
-``` ruby
-client.messages.lazy.select { |m| DateTime.parse(m[:received_at]).day.even? }.first(5)
-# => [{...}, {...}]
-```
-
-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`
@@ -379,7 +347,9 @@ message.deliver
 # => #<Mail::Message:70355890541720, Multipart: false, Headers: <From: sheldon@bigbangtheory.com>, <To: leonard@bigbangtheory.com>, <Message-ID: e439fec0-4c89-475b-b3fc-eb446249a051>, <Subject: Re: Come on, Sheldon. It will be fun.>>
 ```
 
-## HTML message
+## HTML message (with open tracking)
+
+Notice that we set `track_opens` field to `true`, to enable open tracking for this message.
 
 ``` ruby
 require 'rubygems'
@@ -396,6 +366,8 @@ message = Mail.new do
   body            '<p>Any group big enough to trample me to death. General ' \
                   'rule of thumb is 36 adults or 70 children.</p>'
 
+  track_opens     true
+
   delivery_method Mail::Postmark, :api_key => 'your-postmark-api-key'
 end
 
@@ -565,6 +537,14 @@ message.message_id
 
 Postmark allows you to automatically scale your sending infrastructure with the Account API. Learn how in the [Account API Support](https://github.com/wildbit/postmark-gem/wiki/The-Account-API-Support) guide.
 
+## The Triggers API Support
+
+[The Triggers API](https://github.com/wildbit/postmark-gem/wiki/The-Triggers-API-Support) can be used to tell Postmark to automatically track opens for all messages with a certain tag.
+
+## The Messages API Support
+
+If you ever need to access your messages or their metadata (i.e. open tracking info), [the Messages API](https://github.com/wildbit/postmark-gem/wiki/The-Messages-API-support) is a great place to start.
+
 ## ActiveModel-like Interface For Bounces
 
 To provide an interface similar to ActiveModel for bounces, the Postmark gem adds

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.0

data/lib/postmark.rb

@@ -13,7 +13,6 @@ require 'postmark/http_client'
 require 'postmark/client'
 require 'postmark/api_client'
 require 'postmark/account_api_client'
-require 'postmark/message_extensions/shared'
 require 'postmark/message_extensions/mail'
 require 'postmark/handlers/mail'
 

data/lib/postmark/api_client.rb

@@ -109,6 +109,53 @@ module Postmark
       format_response http_client.put("bounces/#{id}/activate")["Bounce"]
     end
 
+    def opens(options = {})
+      find_each('messages/outbound/opens', 'Opens', options)
+    end
+
+    def get_opens(options = {})
+      _, batch = load_batch('messages/outbound/opens', 'Opens', options)
+      batch
+    end
+
+    def get_opens_by_message_id(message_id, options ={})
+      _, batch = load_batch("messages/outbound/opens/#{message_id}",
+                            'Opens',
+                            options)
+      batch
+    end
+
+    def opens_by_message_id(message_id, options = {})
+      find_each("messages/outbound/opens/#{message_id}", 'Opens', options)
+    end
+
+    def create_trigger(type, options)
+      data = serialize(HashHelper.to_postmark(options))
+      format_response http_client.post("triggers/#{type}", data)
+    end
+
+    def get_trigger(type, id)
+      format_response http_client.get("triggers/#{type}/#{id}")
+    end
+
+    def update_trigger(type, id, options)
+      data = serialize(HashHelper.to_postmark(options))
+      format_response http_client.put("triggers/#{type}/#{id}", data)
+    end
+
+    def delete_trigger(type, id)
+      format_response http_client.delete("triggers/#{type}/#{id}")
+    end
+
+    def get_triggers(type, options = {})
+      _, batch = load_batch("triggers/#{type}", 'Tags', options)
+      batch
+    end
+
+    def triggers(type, options = {})
+      find_each("triggers/#{type}", 'Tags', options)
+    end
+
     def server_info
       format_response http_client.get("server")
     end

data/lib/postmark/mail_message_converter.rb

@@ -17,7 +17,7 @@ module Postmark
     end
 
     def delete_blank_fields(message_hash)
-      message_hash.delete_if { |k, v| v.nil? || v.empty? }
+      message_hash.delete_if { |k, v| v.nil? || (v.respond_to?(:empty?) && v.empty?) }
     end
 
     def headers_part
@@ -29,7 +29,8 @@ module Postmark
         'Bcc' => @message['bcc'].to_s,
         'Subject' => @message.subject,
         'Headers' => @message.export_headers,
-        'Tag' => @message.tag.to_s
+        'Tag' => @message.tag.to_s,
+        'TrackOpens' => !!@message.track_opens
       }
     end
 

data/lib/postmark/message_extensions/mail.rb

@@ -1,7 +1,43 @@
 module Mail
   class Message
 
-    include Postmark::SharedMessageExtensions
+    attr_accessor :delivered, :postmark_response
+
+    def delivered?
+      self.delivered
+    end
+
+    def tag(val = nil)
+      default 'TAG', val
+    end
+
+    def tag=(val)
+      header['TAG'] = val
+    end
+
+    def track_opens(val = nil)
+      default 'TRACK-OPENS', !!val
+    end
+
+    def track_opens=(val)
+      header['TRACK-OPENS'] = !!val
+    end
+
+    def postmark_attachments=(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.")
+
+      ::Postmark::MessageHelper.attachments_to_postmark(@_attachments)
+    end
 
     def html?
       content_type && content_type.include?('text/html')
@@ -45,6 +81,10 @@ module Mail
 
   protected
 
+    def pack_attachment_data(data)
+      ::Postmark::MessageHelper.encode_in_base64(data)
+    end
+
     def export_native_attachments
       attachments.map do |attachment|
         basics = {"Name" => attachment.filename,
@@ -65,6 +105,7 @@ module Mail
         cc           bcc
         subject      tag
         attachment   to
+        track-opens
       ]
     end
 

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/spec/integration/account_api_client_spec.rb

@@ -12,10 +12,9 @@ describe 'Account API client usage' do
     new_sender = nil
 
     # create & count
-    expect {
-      new_sender = subject.create_sender(:name => 'Integration Test',
-                                         :from_email => unique_from_email)
-    }.to change { subject.get_senders_count }.by(1)
+    new_sender = subject.create_sender(:name => 'Integration Test',
+                                       :from_email => unique_from_email)
+    expect(subject.get_senders_count).to be > 0
 
     # get
     expect(subject.get_sender(new_sender[:id])[:id]).to eq(new_sender[:id])
@@ -51,10 +50,9 @@ describe 'Account API client usage' do
     new_server = nil
 
     # create & count
-    expect {
-      new_server = subject.create_server(:name => "server-#{unique_token}",
-                                         :color => 'red')
-    }.to change { subject.get_servers_count }.by(1)
+    new_server = subject.create_server(:name => "server-#{unique_token}",
+                                       :color => 'red')
+    expect(subject.get_servers_count).to be > 0
 
     # get
     expect(subject.get_server(new_server[:id])[:id]).to eq(new_server[:id])

data/spec/integration/api_client_resources_spec.rb

@@ -17,6 +17,28 @@ describe 'Accessing server resources using the API' do
     }
   }
 
+  context 'Triggers API' do
+
+    let(:unique_token) { rand(36**32).to_s(36) }
+
+    it 'can be used to manage tag triggers via the API' do
+      trigger = api_client.create_trigger(:tags,
+                                          :match_name => "gemtest_#{unique_token}",
+                                          :track_opens => true)
+      api_client.update_trigger(:tags,
+                                trigger[:id],
+                                :match_name => "pre_#{trigger[:match_name]}")
+      updated = api_client.get_trigger(:tags, trigger[:id])
+
+      expect(updated[:id]).to eq(trigger[:id])
+      expect(updated[:match_name]).not_to eq(trigger[:id])
+      expect(api_client.triggers(:tags).map { |t| t[:id] }).to include(trigger[:id])
+
+      api_client.delete_trigger(:tags, trigger[:id])
+    end
+
+  end
+
   context 'Messages API' do
 
     def with_retries(max_retries = 20, wait_seconds = 3)

data/spec/unit/postmark/api_client_spec.rb

@@ -102,7 +102,7 @@ describe Postmark::ApiClient do
 
   describe "#deliver_message" do
     let(:email) { message.to_postmark_hash }
-    let(:email_json) { JSON.dump(email) }
+    let(:email_json) { Postmark::Json.encode(email) }
     let(:http_client) { subject.http_client }
 
     it 'turns message into a JSON document and posts it to /email' do
@@ -135,7 +135,7 @@ describe Postmark::ApiClient do
 
     let(:email) { message.to_postmark_hash }
     let(:emails) { [email, email, email] }
-    let(:emails_json) { JSON.dump(emails) }
+    let(:emails_json) { Postmark::Json.encode(emails) }
     let(:http_client) { subject.http_client }
     let(:response) { [{}, {}, {}] }
 
@@ -391,6 +391,155 @@ describe Postmark::ApiClient do
     end
   end
 
+  describe '#opens' do
+
+    it 'returns an Enumerator' do
+      expect(subject.opens).to be_kind_of(Enumerable)
+    end
+
+    it 'performs a GET request to /opens/tags' do
+      allow(subject.http_client).to receive(:get).
+          with('messages/outbound/opens', an_instance_of(Hash)).
+          and_return('TotalCount' => 1, 'Opens' => [{}])
+      expect(subject.opens.first(5).count).to eq(1)
+    end
+
+  end  
+
+  describe '#get_opens' do
+    let(:http_client) { subject.http_client }
+    let(:options) { {:offset => 5} }
+    let(:response) { {'Opens' => [], 'TotalCount' => 0} }
+
+    it 'performs a GET request to /messages/outbound/opens' do
+      allow(http_client).to receive(:get).with('messages/outbound/opens', options) { response }
+      expect(subject.get_opens(options)).to be_an(Array)
+      expect(subject.get_opens(options).count).to be_zero
+    end
+  end
+
+  describe '#get_opens_by_message_id' do
+    let(:http_client) { subject.http_client }
+    let(:message_id) { 42 }
+    let(:options) { {:offset => 5} }
+    let(:response) { {'Opens' => [], 'TotalCount' => 0} }
+
+    it 'performs a GET request to /messages/outbound/opens' do
+      allow(http_client).
+          to receive(:get).with("messages/outbound/opens/#{message_id}",
+                                options).
+                           and_return(response)
+      expect(subject.get_opens_by_message_id(message_id, options)).to be_an(Array)
+      expect(subject.get_opens_by_message_id(message_id, options).count).to be_zero
+    end
+  end
+
+  describe '#opens_by_message_id' do
+    let(:message_id) { 42 }
+
+    it 'returns an Enumerator' do
+      expect(subject.opens_by_message_id(message_id)).to be_kind_of(Enumerable)
+    end
+
+    it 'performs a GET request to /opens/tags' do
+      allow(subject.http_client).to receive(:get).
+          with("messages/outbound/opens/#{message_id}", an_instance_of(Hash)).
+          and_return('TotalCount' => 1, 'Opens' => [{}])
+      expect(subject.opens_by_message_id(message_id).first(5).count).to eq(1)
+    end
+  end
+
+  describe '#create_trigger' do
+    let(:http_client) { subject.http_client }
+    let(:options) { {:foo => 'bar'} }
+    let(:response) { {'Foo' => 'Bar'} }
+
+    it 'performs a POST request to /triggers/tags with given options' do
+      allow(http_client).to receive(:post).with('triggers/tags',
+                                                {'Foo' => 'bar'}.to_json)
+      subject.create_trigger(:tags, options)
+    end
+
+    it 'symbolizes response keys' do
+      allow(http_client).to receive(:post).and_return(response)
+      expect(subject.create_trigger(:tags, options)).to eq(:foo => 'Bar')
+    end
+  end
+
+  describe '#get_trigger' do
+    let(:http_client) { subject.http_client }
+    let(:id) { 42 }
+
+    it 'performs a GET request to /triggers/tags/:id' do
+      allow(http_client).to receive(:get).with("triggers/tags/#{id}")
+      subject.get_trigger(:tags, id)
+    end
+
+    it 'symbolizes response keys' do
+      allow(http_client).to receive(:get).and_return('Foo' => 'Bar')
+      expect(subject.get_trigger(:tags, id)).to eq(:foo => 'Bar')
+    end
+  end
+
+  describe '#update_trigger' do
+    let(:http_client) { subject.http_client }
+    let(:options) { {:foo => 'bar'} }
+    let(:id) { 42 }
+
+    it 'performs a PUT request to /triggers/tags/:id' do
+      allow(http_client).to receive(:put).with("triggers/tags/#{id}",
+                                               {'Foo' => 'bar'}.to_json)
+      subject.update_trigger(:tags, id, options)
+    end
+
+    it 'symbolizes response keys' do
+      allow(http_client).to receive(:put).and_return('Foo' => 'Bar')
+      expect(subject.update_trigger(:tags, id, options)).to eq(:foo => 'Bar')
+    end
+  end
+
+  describe '#delete_trigger' do
+    let(:http_client) { subject.http_client }
+    let(:id) { 42 }
+
+    it 'performs a DELETE request to /triggers/tags/:id' do
+      allow(http_client).to receive(:delete).with("triggers/tags/#{id}")
+      subject.delete_trigger(:tags, id)
+    end
+
+    it 'symbolizes response keys' do
+      allow(http_client).to receive(:delete).and_return('Foo' => 'Bar')
+      expect(subject.delete_trigger(:tags, id)).to eq(:foo => 'Bar')
+    end
+  end
+
+  describe '#get_triggers' do
+    let(:http_client) { subject.http_client }
+    let(:options) { {:offset => 5} }
+    let(:response) { {'Tags' => [], 'TotalCount' => 0} }
+
+    it 'performs a GET request to /triggers/tags' do
+      allow(http_client).to receive(:get).with('triggers/tags', options) { response }
+      expect(subject.get_triggers(:tags, options)).to be_an(Array)
+      expect(subject.get_triggers(:tags, options).count).to be_zero
+    end
+  end
+
+  describe '#triggers' do
+
+    it 'returns an Enumerator' do
+      expect(subject.triggers(:tags)).to be_kind_of(Enumerable)
+    end
+
+    it 'performs a GET request to /triggers/tags' do
+      allow(subject.http_client).to receive(:get).
+          with('triggers/tags', an_instance_of(Hash)).
+          and_return('TotalCount' => 1, 'Tags' => [{}])
+      expect(subject.triggers(:tags).first(5).count).to eq(1)
+    end
+
+  end
+
   describe "#server_info" do
     let(:http_client) { subject.http_client }
     let(:response) { {"Name" => "Testing",

data/spec/unit/postmark/helpers/message_helper_spec.rb

@@ -56,7 +56,7 @@ describe Postmark::MessageHelper do
         "Tag" => "Invitation",
         "HtmlBody" => "<b>Hello</b>",
         "TextBody" => "Hello",
-        "ReplyTo" => "reply@example.com"
+        "ReplyTo" => "reply@example.com",
       }
     }
 
@@ -76,6 +76,14 @@ describe Postmark::MessageHelper do
       postmark_message_with_headers.merge("Attachments" => postmark_attachments)
     }
 
+    let(:message_with_open_tracking) {
+      message.merge(:track_opens => true)
+    }
+
+    let(:postmark_message_with_open_tracking) {
+      postmark_message.merge("TrackOpens" => true)
+    }
+
     it 'converts messages without custom headers and attachments correctly' do
       subject.to_postmark(message).should == postmark_message
     end
@@ -88,6 +96,10 @@ describe Postmark::MessageHelper do
       subject.to_postmark(message_with_headers_and_attachments).should == postmark_message_with_headers_and_attachments
     end
 
+    it 'includes open tracking flag when specified' do
+      expect(subject.to_postmark(message_with_open_tracking)).to eq(postmark_message_with_open_tracking)
+    end
+
   end
 
   describe ".headers_to_postmark" do

data/spec/unit/postmark/mail_message_converter_spec.rb

@@ -23,6 +23,17 @@ describe Postmark::MailMessageConverter do
     end
   end
 
+  let(:mail_message_with_tracking) do
+    mail = Mail.new do
+      from          "sheldon@bigbangtheory.com"
+      to            "lenard@bigbangtheory.com"
+      subject       "Hello!"
+      content_type  'text/html; charset=UTF-8'
+      body          "<b>Hello Sheldon!</b>"
+      track_opens   true
+    end
+  end
+
 
   let(:tagged_mail_message) do
     Mail.new do
@@ -72,7 +83,7 @@ describe Postmark::MailMessageConverter do
       to      "\"Leonard Hofstadter\" <leonard@bigbangtheory.com>"
       subject "Hello!"
       body    "Hello Sheldon!"
-      reply_to 'Penny "The Neighbor" <penny@bigbangtheory.com>'
+      reply_to '"Penny The Neighbor" <penny@bigbangtheory.com>'
     end
   end
 
@@ -81,7 +92,8 @@ describe Postmark::MailMessageConverter do
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "TextBody" => "Hello Sheldon!",
-        "To" => "lenard@bigbangtheory.com"}
+        "To" => "lenard@bigbangtheory.com",
+        'TrackOpens' => false}
   end
 
   it 'converts tagged text messages correctly' do
@@ -90,14 +102,16 @@ describe Postmark::MailMessageConverter do
         "Subject" => "Hello!",
         "TextBody" => "Hello Sheldon!",
         "Tag" => "sheldon",
-        "To"=>"lenard@bigbangtheory.com"}
+        "To"=>"lenard@bigbangtheory.com",
+        'TrackOpens' => false}
   end
 
   it 'converts plain text messages without body correctly' do
     subject.new(mail_message_without_body).run.should == {
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
-        "To" => "lenard@bigbangtheory.com"}
+        "To" => "lenard@bigbangtheory.com",
+        'TrackOpens' => false}
   end
 
   it 'converts html messages correctly' do
@@ -105,7 +119,8 @@ describe Postmark::MailMessageConverter do
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "HtmlBody" => "<b>Hello Sheldon!</b>",
-        "To" => "lenard@bigbangtheory.com"}
+        "To" => "lenard@bigbangtheory.com",
+        'TrackOpens' => false}
   end
 
   it 'converts multipart messages correctly' do
@@ -114,7 +129,8 @@ describe Postmark::MailMessageConverter do
         "Subject" => "Hello!",
         "HtmlBody" => "<b>Hello Sheldon!</b>",
         "TextBody" => "Hello Sheldon!",
-        "To" => "lenard@bigbangtheory.com"}
+        "To" => "lenard@bigbangtheory.com",
+        'TrackOpens' => false}
   end
 
   it 'converts messages with attachments correctly' do
@@ -125,7 +141,8 @@ describe Postmark::MailMessageConverter do
                            "Content"=>encoded_empty_gif_data,
                            "ContentType"=>"image/gif"}],
         "TextBody"=>"Hello Sheldon!",
-        "To"=>"lenard@bigbangtheory.com"}
+        "To"=>"lenard@bigbangtheory.com",
+        'TrackOpens' => false}
   end
 
   it 'converts messages with named addresses correctly' do
@@ -134,10 +151,20 @@ describe Postmark::MailMessageConverter do
         "Subject" => "Hello!",
         "TextBody" => "Hello Sheldon!",
         "To" => "Leonard Hofstadter <leonard@bigbangtheory.com>",
-        "ReplyTo" => "\"Penny \\\"The Neighbor\\\"\" <penny@bigbangtheory.com>"
+        "ReplyTo" => 'Penny The Neighbor <penny@bigbangtheory.com>',
+        'TrackOpens' => false
     }
   end
 
+  it 'recognizes when open tracking is enabled' do
+    subject.new(mail_message_with_tracking).run.should == {
+        "From" => "sheldon@bigbangtheory.com",
+        "Subject" => "Hello!",
+        "HtmlBody" => "<b>Hello Sheldon!</b>",
+        "To" => "lenard@bigbangtheory.com",
+        "TrackOpens" => true}
+  end
+
   context 'when bcc is empty' do
     it 'excludes bcc from message' do
       mail_message.bcc = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Petyo Ivanov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -117,7 +117,6 @@ files:
 - lib/postmark/json.rb
 - lib/postmark/mail_message_converter.rb
 - lib/postmark/message_extensions/mail.rb
-- lib/postmark/message_extensions/shared.rb
 - lib/postmark/response_parsers/active_support.rb
 - lib/postmark/response_parsers/json.rb
 - lib/postmark/response_parsers/yajl.rb

data/lib/postmark/message_extensions/shared.rb

@@ -1,45 +0,0 @@
-module Postmark
-  module SharedMessageExtensions
-
-    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=(val)
-      header['TAG'] = val
-    end
-
-    def postmark_attachments=(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.")
-
-      Postmark::MessageHelper.attachments_to_postmark(@_attachments)
-    end
-
-    protected
-
-    def pack_attachment_data(data)
-      MessageHelper.encode_in_base64(data)
-    end
-
-  end
-end