postmark 0.9.19 → 1.0.0

data/spec/unit/postmark/inbound_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Postmark::Inbound do
+  # http://developer.postmarkapp.com/developer-inbound-parse.html#example-hook
+  let(:example_inbound) { '{"From":"myUser@theirDomain.com","FromFull":{"Email":"myUser@theirDomain.com","Name":"John Doe"},"To":"451d9b70cf9364d23ff6f9d51d870251569e+ahoy@inbound.postmarkapp.com","ToFull":[{"Email":"451d9b70cf9364d23ff6f9d51d870251569e+ahoy@inbound.postmarkapp.com","Name":""}],"Cc":"\"Full name\" <sample.cc@emailDomain.com>, \"Another Cc\" <another.cc@emailDomain.com>","CcFull":[{"Email":"sample.cc@emailDomain.com","Name":"Full name"},{"Email":"another.cc@emailDomain.com","Name":"Another Cc"}],"ReplyTo":"myUsersReplyAddress@theirDomain.com","Subject":"This is an inbound message","MessageID":"22c74902-a0c1-4511-804f2-341342852c90","Date":"Thu, 5 Apr 2012 16:59:01 +0200","MailboxHash":"ahoy","TextBody":"[ASCII]","HtmlBody":"[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]","ContentType":"image/png","ContentLength":4096},{"Name":"mypaper.doc","Content":"[BASE64-ENCODED CONTENT]","ContentType":"application/msword","ContentLength":16384}]}' }
+
+  context "given a serialized inbound document" do
+    subject { Postmark::Inbound.to_ruby_hash(example_inbound) }
+
+    it { should have_key(:from) }
+    it { should have_key(:from_full) }
+    it { should have_key(:to) }
+    it { should have_key(:to_full) } 
+    it { should have_key(:cc) }
+    it { should have_key(:cc_full) }
+    it { should have_key(:reply_to) }
+    it { should have_key(:subject) }
+    it { should have_key(:message_id) }
+    it { should have_key(:date) }
+    it { should have_key(:mailbox_hash) }
+    it { should have_key(:text_body) }
+    it { should have_key(:html_body) }
+    it { should have_key(:tag) }
+    it { should have_key(:headers) }
+    it { should have_key(:attachments) }
+
+    context "cc" do
+      it 'has 2 CCs' do
+        subject[:cc_full].count.should == 2
+      end
+
+      it 'stores CCs as an array of Ruby hashes' do
+        cc = subject[:cc_full].last
+        cc.should have_key(:email)
+        cc.should have_key(:name)
+      end
+    end
+
+    context "to" do
+      it 'has 1 recipients' do
+        subject[:to_full].count.should == 1
+      end
+
+      it 'stores TOs as an array of Ruby hashes' do
+        cc = subject[:to_full].last
+        cc.should have_key(:email)
+        cc.should have_key(:name)
+      end
+    end
+
+    context "from" do
+      it 'is a hash' do
+        subject[:from_full].should be_a Hash
+      end
+
+      it 'should have all required fields' do
+        subject[:from_full].should have_key(:email)
+        subject[:from_full].should have_key(:name)
+      end
+    end
+
+    context "headers" do
+      it 'has 8 headers' do
+        subject[:headers].count.should == 8
+      end
+
+      it 'stores headers as an array of Ruby hashes' do
+        header = subject[:headers].last
+        header.should have_key(:name)
+        header.should have_key(:value)
+      end
+    end
+
+    context "attachments" do
+      it 'has 2 attachments' do
+        subject[:attachments].count.should == 2
+      end
+
+      it 'stores attachemnts as an array of Ruby hashes' do
+        attachment = subject[:attachments].last
+        attachment.should have_key(:name)
+        attachment.should have_key(:content)
+        attachment.should have_key(:content_type)
+        attachment.should have_key(:content_length)
+      end
+    end
+  end
+end

data/spec/unit/postmark/inflector_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Postmark::Inflector do
+
+  describe ".to_postmark" do
+    it 'converts rubyish underscored format to camel cased symbols accepted by the Postmark API' do
+      subject.to_postmark(:foo_bar).should == 'FooBar'
+      subject.to_postmark(:_bar).should == 'Bar'
+      subject.to_postmark(:really_long_long_long_long_symbol).should == 'ReallyLongLongLongLongSymbol'
+      subject.to_postmark(:foo_bar_1).should == 'FooBar1'
+    end
+
+    it 'accepts strings as well' do
+      subject.to_postmark('foo_bar').should == 'FooBar'
+    end
+
+    it 'acts idempotentely' do
+      subject.to_postmark('FooBar').should == 'FooBar'
+    end
+  end
+
+  describe ".to_ruby" do
+    it 'converts camel cased symbols returned by the Postmark API to underscored Ruby symbols' do
+      subject.to_ruby('FooBar').should == :foo_bar
+      subject.to_ruby('LongTimeAgoInAFarFarGalaxy').should == :long_time_ago_in_a_far_far_galaxy
+      subject.to_ruby('MessageID').should == :message_id
+    end
+
+    it 'acts idempotentely' do
+      subject.to_ruby(:foo_bar).should == :foo_bar
+      subject.to_ruby(:foo_bar_1).should == :foo_bar_1
+    end
+  end
+
+end

data/spec/unit/postmark/json_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Postmark::Json do
+  let(:data) { {"bar" => "foo", "foo" => "bar"} }
+
+  shared_examples "json parser" do
+    it 'encodes and decodes data correctly' do
+      hash = Postmark::Json.decode(Postmark::Json.encode(data))
+      hash.should have_key("bar")
+      hash.should have_key("foo")
+    end
+  end
+
+  context "given response parser is JSON" do
+    before do
+      Postmark.response_parser_class = :Json
+    end
+
+    it_behaves_like "json parser"
+  end
+
+  context "given response parser is ActiveSupport::JSON" do
+    before do
+      Postmark.response_parser_class = :ActiveSupport
+    end
+
+    it_behaves_like "json parser"
+  end
+
+  context "given response parser is Yajl", :skip_for_platform => 'java' do
+    before do
+      Postmark.response_parser_class = :Yajl
+    end
+
+    it_behaves_like "json parser"
+  end
+end

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

@@ -0,0 +1,205 @@
+require 'spec_helper'
+
+describe Mail::Message do
+  before do
+    Kernel.stub(:warn)
+  end
+
+  let(:mail_message) do
+    Mail.new do
+      from    "sheldon@bigbangtheory.com"
+      to      "lenard@bigbangtheory.com"
+      subject "Hello!"
+      body    "Hello Sheldon!"
+    end
+  end
+
+  let(:tagged_mail_message) do
+    Mail.new do
+      from    "sheldon@bigbangtheory.com"
+      to      "lenard@bigbangtheory.com"
+      subject "Hello!"
+      body    "Hello Sheldon!"
+      tag     "sheldon"
+    end
+  end
+
+  let(:mail_message_without_body) do
+    Mail.new do
+      from    "sheldon@bigbangtheory.com"
+      to      "lenard@bigbangtheory.com"
+      subject "Hello!"
+    end
+  end
+
+  let(:mail_html_message) 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>"
+    end
+  end
+
+  let(:mail_multipart_message) do
+    mail = Mail.new do
+      from          "sheldon@bigbangtheory.com"
+      to            "lenard@bigbangtheory.com"
+      subject       "Hello!"
+      text_part do
+        body        "Hello Sheldon!"
+      end
+      html_part do
+        body        "<b>Hello Sheldon!</b>"
+      end
+    end
+  end
+
+  let(:mail_message_with_attachment) do
+    Mail.new do
+      from    "sheldon@bigbangtheory.com"
+      to      "lenard@bigbangtheory.com"
+      subject "Hello!"
+      body    "Hello Sheldon!"
+      add_file empty_gif_path
+    end
+  end
+
+  describe "#html?" do
+    it 'is true for html only email' do
+      mail_html_message.should be_html
+    end
+  end
+
+  describe "#body_html" do
+    it 'returns html body if present' do
+      mail_html_message.body_html.should == "<b>Hello Sheldon!</b>"
+    end
+  end
+
+  describe "#body_text" do
+    it 'returns text body if present' do
+      mail_message.body_text.should == "Hello Sheldon!"
+    end
+  end
+
+  describe "#postmark_attachments=" do
+    let(:attached_hash) { {'Name' => 'picture.jpeg',
+                           'ContentType' => 'image/jpeg'} }
+
+    it "stores attachments as an array" do
+      mail_message.postmark_attachments = attached_hash
+      mail_message.instance_variable_get(:@_attachments).should include(attached_hash)
+    end
+
+    it "is deprecated" do
+      Kernel.should_receive(:warn).with(/deprecated/)
+      mail_message.postmark_attachments = attached_hash
+    end
+  end
+
+  describe "#postmark_attachments" 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 "supports multiple attachment formats" do
+      IO.should_receive(:read).with("/tmp/file.jpeg").and_return("")
+
+      mail_message.postmark_attachments = [attached_hash, attached_file]
+      attachments = mail_message.export_attachments
+
+      attachments.should include(attached_hash)
+      attachments.should include(exported_file)
+    end
+
+    it "is deprecated" do
+      mail_message.postmark_attachments = attached_hash
+      Kernel.should_receive(:warn).with(/deprecated/)
+      mail_message.postmark_attachments
+    end
+  end
+
+  describe "#export_attachments" do
+    let(:file_data) { 'binarydatahere' }
+    let(:exported_data) do
+      {'Name' => 'face.jpeg',
+       'Content' => "YmluYXJ5ZGF0YWhlcmU=\n",
+       'ContentType' => 'image/jpeg'}
+    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]
+    end
+  end
+
+  describe "#to_postmark_hash" do
+    it 'converts plain text messages correctly' do
+      mail_message.to_postmark_hash.should == {
+          "From" => "sheldon@bigbangtheory.com",
+          "Subject" => "Hello!",
+          "TextBody" => "Hello Sheldon!",
+          "To" => "lenard@bigbangtheory.com"}
+    end
+
+    it 'converts tagged text messages correctly' do
+      tagged_mail_message.to_postmark_hash.should == {
+          "From" => "sheldon@bigbangtheory.com",
+          "Subject" => "Hello!",
+          "TextBody" => "Hello Sheldon!",
+          "Tag" => "sheldon",
+          "To"=>"lenard@bigbangtheory.com"}
+    end
+
+    it 'converts plain text messages without body correctly' do
+      mail_message_without_body.to_postmark_hash.should == {
+          "From" => "sheldon@bigbangtheory.com",
+          "Subject" => "Hello!",
+          "To" => "lenard@bigbangtheory.com"}
+    end
+
+    it 'converts html messages correctly' do
+      mail_html_message.to_postmark_hash.should == {
+          "From" => "sheldon@bigbangtheory.com",
+          "Subject" => "Hello!",
+          "HtmlBody" => "<b>Hello Sheldon!</b>",
+          "To" => "lenard@bigbangtheory.com"}
+    end
+
+    it 'converts multipart messages correctly' do
+      mail_multipart_message.to_postmark_hash.should == {
+          "From" => "sheldon@bigbangtheory.com",
+          "Subject" => "Hello!",
+          "HtmlBody" => "<b>Hello Sheldon!</b>",
+          "TextBody" => "Hello Sheldon!",
+          "To" => "lenard@bigbangtheory.com"}
+    end
+
+    it 'converts messages with attachments correctly' do
+      mail_message_with_attachment.to_postmark_hash.should == {
+          "From" => "sheldon@bigbangtheory.com",
+          "Subject" => "Hello!",
+          "Attachments" => [{"Name"=>"empty.gif",
+                             "Content"=>encoded_empty_gif_data,
+                             "ContentType"=>"image/gif"}],
+          "TextBody"=>"Hello Sheldon!",
+          "To"=>"lenard@bigbangtheory.com"}
+    end
+  end
+end

data/spec/unit/postmark_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+
+describe Postmark do
+  let(:api_key) { mock }
+  let(:secure) { mock }
+  let(:proxy_host) { mock }
+  let(:proxy_port) { mock }
+  let(:proxy_user) { mock }
+  let(:proxy_pass) { mock }
+  let(:host) { mock }
+  let(:port) { mock }
+  let(:path_prefix) { mock }
+  let(:max_retries) { mock }
+
+  before do
+    subject.api_key = api_key
+    subject.secure = secure
+    subject.proxy_host = proxy_host
+    subject.proxy_port = proxy_port
+    subject.proxy_user = proxy_user
+    subject.proxy_pass = proxy_pass
+    subject.host = host
+    subject.port = port
+    subject.path_prefix = path_prefix
+    subject.max_retries = max_retries
+  end
+
+  context "attr readers" do
+    it { should respond_to(:secure) }
+    it { should respond_to(:api_key) }
+    it { should respond_to(:proxy_host) }
+    it { should respond_to(:proxy_port) }
+    it { should respond_to(:proxy_user) }
+    it { should respond_to(:proxy_pass) }
+    it { should respond_to(:host) }
+    it { should respond_to(:port) }
+    it { should respond_to(:path_prefix) }
+    it { should respond_to(:http_open_timeout) }
+    it { should respond_to(:http_read_timeout) }
+    it { should respond_to(:max_retries) }
+  end
+
+  context "attr writers" do
+    it { should respond_to(:secure=) }
+    it { should respond_to(:api_key=) }
+    it { should respond_to(:proxy_host=) }
+    it { should respond_to(:proxy_port=) }
+    it { should respond_to(:proxy_user=) }
+    it { should respond_to(:proxy_pass=) }
+    it { should respond_to(:host=) }
+    it { should respond_to(:port=) }
+    it { should respond_to(:path_prefix=) }
+    it { should respond_to(:http_open_timeout=) }
+    it { should respond_to(:http_read_timeout=) }
+    it { should respond_to(:max_retries=) }
+    it { should respond_to(:response_parser_class=) }
+    it { should respond_to(:api_client=) }
+  end
+
+  describe ".response_parser_class" do
+
+    after do
+      subject.instance_variable_set(:@response_parser_class, nil)
+    end
+
+    it "returns :ActiveSupport when ActiveSupport::JSON is available" do
+      subject.response_parser_class.should == :ActiveSupport
+    end
+
+    it "returns :Json when ActiveSupport::JSON is not available" do
+      hide_const("ActiveSupport::JSON")
+      subject.response_parser_class.should == :Json
+    end
+
+  end
+
+  describe ".configure" do
+
+    it 'yields itself to the block' do
+      expect { |b| subject.configure(&b) }.to yield_with_args(subject)
+    end
+
+  end
+
+  describe ".api_client" do
+    let(:api_client) { mock }
+
+    context "when shared client instance already exists" do
+
+      it 'returns the existing instance' do
+        subject.instance_variable_set(:@api_client, api_client)
+        subject.api_client.should == api_client
+      end
+
+    end
+
+    context "when shared client instance does not exist" do
+
+      it 'creates a new instance of Postmark::ApiClient' do
+        Postmark::ApiClient.should_receive(:new).
+                            with(api_key,
+                                 :secure => secure,
+                                 :proxy_host => proxy_host,
+                                 :proxy_port => proxy_port,
+                                 :proxy_user => proxy_user,
+                                 :proxy_pass => proxy_pass,
+                                 :host => host,
+                                 :port => port,
+                                 :path_prefix => path_prefix,
+                                 :max_retries => max_retries).
+                            and_return(api_client)
+        subject.api_client.should == api_client
+      end
+
+    end
+
+  end
+
+  describe ".deliver_message" do
+    let(:api_client) { mock }
+    let(:message) { mock }
+
+    before do
+      subject.api_client = api_client
+    end
+
+    it 'delegates the method to the shared api client instance' do
+      api_client.should_receive(:deliver_message).with(message)
+      subject.deliver_message(message)
+    end
+
+    it 'is also accessible as .send_through_postmark' do
+      api_client.should_receive(:deliver_message).with(message)
+      subject.send_through_postmark(message)
+    end
+  end
+
+  describe ".deliver_messages" do
+    let(:api_client) { mock }
+    let(:message) { mock }
+
+    before do
+      subject.api_client = api_client
+    end
+
+    it 'delegates the method to the shared api client instance' do
+      api_client.should_receive(:deliver_messages).with(message)
+      subject.deliver_messages(message)
+    end
+  end
+
+  describe ".delivery_stats" do
+    let(:api_client) { mock }
+
+    before do
+      subject.api_client = api_client
+    end
+
+    it 'delegates the method to the shared api client instance' do
+      api_client.should_receive(:delivery_stats)
+      subject.delivery_stats
+    end
+  end  
+end