postmark 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b07a5971093718b77a48cb6a5917167ba39d2d6e
-  data.tar.gz: a3f227ff7b37009da8a05fef39ae9a971fefe990
+  metadata.gz: 7d65fe77b30becc8c00a0e19a057d885176f20dd
+  data.tar.gz: df33b575861a790eaea91e65ff7d937fd7c0be03
 SHA512:
-  metadata.gz: 1dc9c40d2e9c7410c371d681cebcf90d27b25898c932a729d6dabb8f9391e9060cfa38d8a36b9abde7218ca0be45d8d048af36e91bfeb456980c9690fe8f3ee3
-  data.tar.gz: ef0e6f6cb70ba23b0ad301eac397a2f26287b66131986c2bce421d0b9a5dffc66538d4f53c644db54791de0b0689777234436048d2e5a11f473bdb2480d47221
+  metadata.gz: 001d1b715e69f99ee6eb3a7f1dc63f282f51ef1b8dbe3acf42344e4c421cbc8d5cd23f269c2525460499d4d8ece1f7060355e747bb758024f0ffbcfe9aa5bf5e
+  data.tar.gz: 83ad3ace1faa7086fd327afdd2676737aeae6130fe4f9013e79e291984e0a8bab0f47e44247aa518f41d49fca04aed686e5afa9ced07ba4821621debc1131569

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Changelog
 
+== 1.12.0
+
+* Added support for attaching metadata to messages.
+
 == 1.11.0
 
 * New, improved, and backwards-compatible gem errors (see README).

data/README.md

@@ -97,6 +97,22 @@ client.deliver(from: 'sheldon@bigbangtheory.com',
 # => {: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"}
 ```
 
+## Sending a message with metadata
+
+To send metadata for emails you send, all you need to do is provide metadata for your messages in form of hash map.
+
+``` ruby
+client.deliver(from: 'sheldon@bigbangtheory.com',
+               to: 'Leonard Hofstadter <leonard@bigbangtheory.com>',
+               subject: 'Re: What, to you, is a large crowd?',
+               html_body: '<p>Any group big enough to trample me to death. ' \
+                          'General <a href="http://www.example.com">rule of thumb</a> is 36 adults or 70 ' \
+                          'children.</p>',
+               text_body: 'Any group big enough to trample me to death. General rule of thumb is 36 adults or 70 children - http://www.example.com.',
+               metadata: {'Example1' => 'value', 'Example2' => 'value'})
+# => {: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"}
+```
+
 ## Sending a message with attachments
 
 You can add
@@ -451,6 +467,24 @@ message.deliver
 # => #<Mail::Message:70355902117460, Multipart: true, Headers: <From: sheldon@bigbangtheory.com>, <To: leonard@bigbangtheory.com>, <Message-ID: 1a1370a1-6c21-4304-a03c-320a54cc59f7>, <Subject: Re: What, to you, is a large crowd?>, <Content-Type: multipart/alternative; boundary=--==_mimepart_58380d6029b17_20543fd48543fa14977a>, <TRACK-LINKS: HtmlAndText>>
 ```
 
+## Message with metadata
+
+``` ruby
+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'
+  metadata        {"Example1"=>"value","Example2"=>"value"}
+
+  delivery_method Mail::Postmark, :api_token => 'your-postmark-api-token'
+end
+
+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>>
+```
+
 ## Message with attachments
 
 ``` ruby

data/VERSION

@@ -1 +1 @@
-1.11.0
+1.12.0

data/gemfiles/Gemfile.legacy

@@ -13,5 +13,5 @@ group :test do
   gem 'mime-types', '~> 1.25.1'
   gem 'activesupport', '~> 3.2.0'
   gem 'i18n', '~> 0.6.0'
-  gem 'yajl-ruby', '~> 1.0', :platforms => [:mingw, :mswin, :ruby]
+  gem 'yajl-ruby', '~> 1.0', '< 1.4.0', :platforms => [:mingw, :mswin, :ruby]
 end

data/lib/postmark/mail_message_converter.rb

@@ -31,7 +31,8 @@ module Postmark
         'Headers' => @message.export_headers,
         'Tag' => @message.tag.to_s,
         'TrackOpens' => (cast_to_bool(@message.track_opens) unless @message.track_opens.empty?),
-        'TrackLinks' => (::Postmark::Inflector.to_postmark(@message.track_links) unless @message.track_links.empty?)
+        'TrackLinks' => (::Postmark::Inflector.to_postmark(@message.track_links) unless @message.track_links.empty?),
+        'Metadata' => (@message.metadata unless @message.metadata.nil?)
       }
     end
 

data/lib/postmark/message_extensions/mail.rb

@@ -33,6 +33,15 @@ module Mail
       header['TRACK-OPENS'] = (!!val).to_s
     end
 
+    def metadata(val = nil)
+      @metadata=val unless val.nil?
+      @metadata
+    end
+
+    def metadata=(val)
+      @metadata = 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 " \

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.11.0'
+  VERSION = '1.12.0'
 end

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

@@ -104,20 +104,27 @@ describe Postmark::MessageHelper do
       expect(subject.to_postmark(message_with_headers_and_attachments)).to eq postmark_message_with_headers_and_attachments
     end
 
-    context 'open tracking flag set' do
+    context 'open tracking' do
 
-      it 'true' do
+      it 'converts messages with open tracking flag set to true correctly' do
         expect(subject.to_postmark(message_with_open_tracking)).to eq(postmark_message_with_open_tracking)
       end
 
-      it 'false' do
+      it 'converts messages with open tracking flag set to false correctly' do
         expect(subject.to_postmark(message_with_open_tracking_false)).to eq(postmark_message_with_open_tracking_false)
       end
 
     end
 
-    context 'link tracking flag set' do
+    context 'metadata' do
+      it 'converts messages with metadata correctly' do
+        metadata = {"test" => "value"}
+        data= message.merge(:metadata => metadata)
+        expect(subject.to_postmark(data)).to include(postmark_message.merge("Metadata" => metadata))
+      end
+    end
 
+    context 'link tracking' do
       let(:message_with_link_tracking_html) { message.merge(:track_links => :html_only) }
       let(:message_with_link_tracking_text) { message.merge(:track_links => :text_only) }
       let(:message_with_link_tracking_all) { message.merge(:track_links => :html_and_text) }
@@ -128,24 +135,22 @@ describe Postmark::MessageHelper do
       let(:postmark_message_with_link_tracking_all) { postmark_message.merge("TrackLinks" => 'HtmlAndText') }
       let(:postmark_message_with_link_tracking_none) { postmark_message.merge("TrackLinks" => 'None') }
 
-      it 'html' do
+      it 'converts html body link tracking to Postmark format' do
         expect(subject.to_postmark(message_with_link_tracking_html)).to eq(postmark_message_with_link_tracking_html)
       end
 
-      it 'text' do
+      it 'converts text body link tracking to Postmark format' do
         expect(subject.to_postmark(message_with_link_tracking_text)).to eq(postmark_message_with_link_tracking_text)
       end
 
-      it 'html and text' do
+      it 'converts html and text body link tracking to Postmark format' do
         expect(subject.to_postmark(message_with_link_tracking_all)).to eq(postmark_message_with_link_tracking_all)
       end
 
-      it 'none' do
+      it 'converts no link tracking to Postmark format' do
         expect(subject.to_postmark(message_with_link_tracking_none)).to eq(postmark_message_with_link_tracking_none)
       end
-
     end
-
   end
 
   describe ".headers_to_postmark" do
@@ -159,7 +164,6 @@ describe Postmark::MessageHelper do
   end
 
   describe ".attachments_to_postmark" do
-
     it 'converts attachments to Postmark format' do
       expect(subject.attachments_to_postmark(attachments)).to eq postmark_attachments
     end
@@ -167,7 +171,6 @@ describe Postmark::MessageHelper do
     it 'accepts single attachment as a non-array' do
       expect(subject.attachments_to_postmark(attachments.first)).to eq [postmark_attachments.first]
     end
-
   end
 
 end

data/spec/unit/postmark/mail_message_converter_spec.rb

@@ -225,11 +225,9 @@ describe Postmark::MailMessageConverter do
         "ReplyTo" => 'Penny The Neighbor <penny@bigbangtheory.com>'}
   end
 
-  context 'recognizes open tracking' do
-
+  context 'open tracking' do
     context 'setup inside of mail' do
-
-      it 'enabled' do
+      it 'converts open tracking enabled messages correctly' do
         expect(subject.new(mail_message_with_open_tracking).run).to eq ({
             "From" => "sheldon@bigbangtheory.com",
             "Subject" => "Hello!",
@@ -238,7 +236,7 @@ describe Postmark::MailMessageConverter do
             "TrackOpens" => true})
       end
 
-      it 'disabled' do
+      it 'converts open tracking disabled messages correctly' do
         expect(subject.new(mail_message_with_open_tracking_disabled).run).to eq ({
             "From" => "sheldon@bigbangtheory.com",
             "Subject" => "Hello!",
@@ -246,12 +244,10 @@ describe Postmark::MailMessageConverter do
             "To" => "lenard@bigbangtheory.com",
             "TrackOpens" => false})
       end
-
     end
 
     context 'setup with tracking variable' do
-
-      it 'enabled' do
+      it 'converts open tracking enabled messages correctly' do
         expect(subject.new(mail_message_with_open_tracking_set_variable).run).to eq ({
             "From" => "sheldon@bigbangtheory.com",
             "Subject" => "Hello!",
@@ -260,7 +256,7 @@ describe Postmark::MailMessageConverter do
             "TrackOpens" => true})
       end
 
-      it 'disabled' do
+      it 'converts open tracking disabled messages correctly' do
         expect(subject.new(mail_message_with_open_tracking_disabled_set_variable).run).to eq ({
             "From" => "sheldon@bigbangtheory.com",
             "Subject" => "Hello!",
@@ -268,14 +264,11 @@ describe Postmark::MailMessageConverter do
             "To" => "lenard@bigbangtheory.com",
             "TrackOpens" => false})
       end
-
     end
-
   end
 
   context 'link tracking' do
-
-    it 'html and text' do
+    it 'converts html and text link tracking enabled messages correctly' do
       expect(subject.new(mail_message_with_link_tracking_all).run).to eq ({
           "From" => "sheldon@bigbangtheory.com",
           "Subject" => "Hello!",
@@ -284,7 +277,7 @@ describe Postmark::MailMessageConverter do
           "TrackLinks" => 'HtmlAndText'})
     end
 
-    it 'html only' do
+    it 'converts html only link tracking enabled messages correctly' do
       expect(subject.new(mail_message_with_link_tracking_html).run).to eq ({
           "From" => "sheldon@bigbangtheory.com",
           "Subject" => "Hello!",
@@ -293,7 +286,7 @@ describe Postmark::MailMessageConverter do
           "TrackLinks" => 'HtmlOnly'})
     end
 
-    it 'text only' do
+    it 'converts text only link tracking enabled messages correctly' do
       expect(subject.new(mail_message_with_link_tracking_text).run).to eq ({
           "From" => "sheldon@bigbangtheory.com",
           "Subject" => "Hello!",
@@ -302,7 +295,7 @@ describe Postmark::MailMessageConverter do
           "TrackLinks" => 'TextOnly'})
     end
 
-    it 'none' do
+    it 'converts link tracking disabled messages correctly' do
       expect(subject.new(mail_message_with_link_tracking_none).run).to eq ({
           "From" => "sheldon@bigbangtheory.com",
           "Subject" => "Hello!",
@@ -316,7 +309,30 @@ describe Postmark::MailMessageConverter do
       msg[:track_links] = :html_and_text
       expect(subject.new(msg).run).to include('TrackLinks' => 'HtmlAndText')
     end
+  end
+
+  context 'metadata' do
+    it 'converts single metadata field' do
+      metadata = {:test => 'test'}
+      msg = mail_html_message
+      msg.metadata = metadata
+      expect(subject.new(msg).run).to include('Metadata' => metadata)
+    end
+
+    it 'converts unicode metadata field metadata' do
+      metadata = {:test => "Велик"}
+      msg = mail_html_message
+      msg.metadata = metadata
+      expect(subject.new(msg).run).to include('Metadata' => metadata)
+    end
 
+    it 'converts multiple metadata fields' do
+      metadata = {}
+      metadata = 10.times { |i| metadata["test#{i+1}"] = "t"*80 }
+      msg = mail_html_message
+      msg.metadata = metadata
+      expect(subject.new(msg).run).to include('Metadata' => metadata)
+    end
   end
 
   it 'correctly decodes unicode in messages transfered as quoted-printable' do

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

@@ -58,27 +58,23 @@ describe Mail::Message do
   end
 
   describe '#track_opens' do
+    it 'returns nil if unset' do
+      expect(mail_message.track_opens).to eq ''
+    end
 
-    context 'flag set on track_opens=' do
-
-      it 'true' do
+    context 'when assigned via #track_opens=' do
+      it 'returns assigned value to track opens' do
         mail_message.track_opens = true
         expect(mail_message.track_opens).to eq 'true'
       end
 
-      it 'false' do
+      it 'returns assigned value to not track opens' do
         mail_message.track_opens = false
         expect(mail_message.track_opens).to eq 'false'
       end
-
-      it 'not set' do
-        expect(mail_message.track_opens).to eq ''
-      end
-
     end
 
     context 'flag set on track_opens()' do
-
       it 'true' do
         mail_message.track_opens(true)
         expect(mail_message.track_opens).to eq 'true'
@@ -88,35 +84,49 @@ describe Mail::Message do
         mail_message.track_opens(false)
         expect(mail_message.track_opens).to eq 'false'
       end
-
     end
-
   end
 
-  describe '#track_links' do
+  describe '#metadata' do
+    let(:metadata) {{:test => "test"}}
 
-    context 'flag set on track_links=' do
+    it 'returns nil if unset' do
+      expect(mail_message.metadata).to eq nil
+    end
 
-      it 'set' do
-        mail_message.track_links=:html_only
-        expect(mail_message.track_links).to eq 'HtmlOnly'
+    context 'when assigned via #metadata=' do
+      it 'returns assigned value' do
+        mail_message.metadata=metadata
+        expect(mail_message.metadata).to eq metadata
       end
+    end
 
-      it 'not set' do
-        expect(mail_message.track_links).to eq ''
+    context 'when assigned via metadata()' do
+      it 'returns assigned value' do
+        mail_message.metadata(metadata)
+        expect(mail_message.metadata).to eq metadata
       end
+    end
+  end
 
+  describe '#track_links' do
+    it 'return empty string when if unset' do
+      expect(mail_message.track_links).to eq ''
     end
 
-    context 'flag set on track_links()' do
+    context 'when assigned via #track_links=' do
+      it 'returns track html only body value in Postmark format' do
+        mail_message.track_links=:html_only
+        expect(mail_message.track_links).to eq 'HtmlOnly'
+      end
+    end
 
-      it 'set' do
+    context 'when assigned via track_links()' do
+      it 'returns track html only body value in Postmark format' do
         mail_message.track_links(:html_only)
         expect(mail_message.track_links).to eq 'HtmlOnly'
       end
-
     end
-
   end
 
   describe "#html?" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Petyo Ivanov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake