postmark 1.1.2 → 1.2.0

data/spec/unit/postmark/account_api_client_spec.rb

@@ -0,0 +1,538 @@
+require 'spec_helper'
+
+describe Postmark::AccountApiClient do
+
+  let(:api_key) { 'abcd-efgh' }
+  subject { Postmark::AccountApiClient}
+
+  it 'can be created with an API key' do
+    expect { subject.new(api_key) }.not_to raise_error
+  end
+
+  it 'can be created with an API key and options hash' do
+    expect { subject.new(api_key, :http_read_timeout => 5) }.not_to raise_error
+  end
+
+  context 'instance' do
+
+    subject { Postmark::AccountApiClient.new(api_key) }
+
+    it 'uses the auth header specific for Account API' do
+      auth_header = subject.http_client.auth_header_name
+      expect(auth_header).to eq('X-Postmark-Account-Token')
+    end
+
+    describe '#senders' do
+
+      let(:response) {
+        {
+          'TotalCount' => 10, 'SenderSignatures' => [{}, {}]
+        }
+      }
+
+      it 'is aliased as #signatures' do
+        expect(subject).to respond_to(:signatures)
+        expect(subject).to respond_to(:signatures).with(1).argument
+      end
+
+      it 'returns an enumerator' do
+        expect(subject.senders).to be_kind_of(Enumerable)
+      end
+
+      it 'lazily loads senders' do
+        allow(subject.http_client).to receive(:get).
+            with('senders', an_instance_of(Hash)).and_return(response)
+        subject.senders.take(1000)
+      end
+
+    end
+
+    describe '#get_senders' do
+
+      let(:response) {
+        {
+          "TotalCount" => 1,
+          "SenderSignatures" => [{
+            "Domain" => "example.com",
+            "EmailAddress" => "someone@example.com",
+            "ReplyToEmailAddress" => "info@example.com",
+            "Name" => "Example User",
+            "Confirmed" => true,
+            "ID" => 8139
+          }]
+        }
+      }
+
+      it 'is aliased as #get_signatures' do
+        expect(subject).to respond_to(:get_signatures).with(1).argument
+      end
+
+      it 'performs a GET request to /senders endpoint' do
+        allow(subject.http_client).to receive(:get).
+            with('senders', :offset => 0, :count => 30).
+            and_return(response)
+        subject.get_senders
+      end
+
+      it 'formats the keys of returned list of senders' do
+        allow(subject.http_client).to receive(:get).and_return(response)
+        keys = subject.get_senders.map { |s| s.keys }.flatten
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+      it 'accepts offset and count options' do
+        allow(subject.http_client).to receive(:get).
+            with('senders', :offset => 10, :count => 42).
+            and_return(response)
+        subject.get_senders(:offset => 10, :count => 42)
+      end
+
+    end
+
+    describe '#get_senders_count' do
+
+      let(:response) { {'TotalCount' => 42} }
+
+      it 'is aliased as #get_signatures_count' do
+        expect(subject).to respond_to(:get_signatures_count)
+        expect(subject).to respond_to(:get_signatures_count).with(1).argument
+      end
+
+      it 'returns a total number of senders' do
+        allow(subject.http_client).to receive(:get).
+            with('senders', an_instance_of(Hash)).and_return(response)
+        expect(subject.get_senders_count).to eq(42)
+      end
+
+    end
+
+    describe '#get_sender' do
+
+      let(:response) {
+        {
+          "Domain" => "example.com",
+          "EmailAddress" => "someone@example.com",
+          "ReplyToEmailAddress" => "info@example.com",
+          "Name" => "Example User",
+          "Confirmed" => true,
+          "ID" => 8139
+        }
+      }
+
+      it 'is aliased as #get_signature' do
+        expect(subject).to respond_to(:get_signature).with(1).argument
+      end
+
+      it 'performs a GET request to /senders/:id endpoint' do
+        allow(subject.http_client).to receive(:get).with("senders/42").
+                                                    and_return(response)
+        subject.get_sender(42)
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:get).and_return(response)
+        keys = subject.get_sender(42).keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+    end
+
+    describe '#create_sender' do
+
+      let(:response) {
+        {
+          "Domain" => "example.com",
+          "EmailAddress" => "someone@example.com",
+          "ReplyToEmailAddress" => "info@example.com",
+          "Name" => "Example User",
+          "Confirmed" => true,
+          "ID" => 8139
+        }
+      }
+
+      it 'is aliased as #create_signature' do
+        expect(subject).to respond_to(:create_signature).with(1).argument
+      end
+
+      it 'performs a POST request to /senders endpoint' do
+        allow(subject.http_client).to receive(:post).
+            with("senders", an_instance_of(String)).and_return(response)
+        subject.create_sender(:name => 'Chris Nagele')
+      end
+
+      it 'converts the sender attributes names to camel case' do
+        allow(subject.http_client).to receive(:post).
+            with("senders", {'FooBar' => 'bar'}.to_json).and_return(response)
+        subject.create_sender(:foo_bar => 'bar')
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:post).and_return(response)
+        keys = subject.create_sender(:foo => 'bar').keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+    end
+
+    describe '#update_sender' do
+
+      let(:response) {
+        {
+          "Domain" => "example.com",
+          "EmailAddress" => "someone@example.com",
+          "ReplyToEmailAddress" => "info@example.com",
+          "Name" => "Example User",
+          "Confirmed" => true,
+          "ID" => 8139
+        }
+      }
+
+      it 'is aliased as #update_signature' do
+        expect(subject).to respond_to(:update_signature).with(1).argument
+        expect(subject).to respond_to(:update_signature).with(2).arguments
+      end
+
+      it 'performs a PUT request to /senders/:id endpoint' do
+        allow(subject.http_client).to receive(:put).
+            with('senders/42', an_instance_of(String)).and_return(response)
+        subject.update_sender(42, :name => 'Chris Nagele')
+      end
+
+      it 'converts the sender attributes names to camel case' do
+        allow(subject.http_client).to receive(:put).
+            with('senders/42', {'FooBar' => 'bar'}.to_json).and_return(response)
+        subject.update_sender(42, :foo_bar => 'bar')
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:put).and_return(response)
+        keys = subject.update_sender(42, :foo => 'bar').keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+    end
+
+    describe '#resend_sender_confirmation' do
+
+      let(:response) {
+        {
+          "ErrorCode" => 0,
+          "Message" => "Confirmation email for Sender Signature someone@example.com was re-sent."
+        }
+      }
+
+      it 'is aliased as #resend_signature_confirmation' do
+        expect(subject).to respond_to(:resend_signature_confirmation).
+            with(1).argument
+      end
+
+      it 'performs a POST request to /senders/:id/resend endpoint' do
+        allow(subject.http_client).to receive(:post).
+            with('senders/42/resend').and_return(response)
+        subject.resend_sender_confirmation(42)
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:post).and_return(response)
+        keys = subject.resend_sender_confirmation(42).keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+    end
+
+    describe '#verified_sender_spf?' do
+
+      let(:response) { {"SPFVerified" => true} }
+      let(:false_response) { {"SPFVerified" => false} }
+
+      it 'is aliased as #verified_signature_spf?' do
+        expect(subject).to respond_to(:verified_signature_spf?).with(1).argument
+      end
+
+      it 'performs a POST request to /senders/:id/verifyspf endpoint' do
+        allow(subject.http_client).to receive(:post).
+            with('senders/42/verifyspf').and_return(response)
+        subject.verified_sender_spf?(42)
+      end
+
+      it 'returns false when SPFVerified field of the response is false' do
+        allow(subject.http_client).to receive(:post).and_return(false_response)
+        expect(subject.verified_sender_spf?(42)).to be_false
+      end
+
+      it 'returns true when SPFVerified field of the response is true' do
+        allow(subject.http_client).to receive(:post).and_return(response)
+        expect(subject.verified_sender_spf?(42)).to be_true
+      end
+
+    end
+
+    describe '#request_new_sender_dkim' do
+
+      let(:response) {
+        {
+          "Domain" => "example.com",
+          "EmailAddress" => "someone@example.com",
+          "ReplyToEmailAddress" => "info@example.com",
+          "Name" => "Example User",
+          "Confirmed" => true,
+          "ID" => 8139
+        }
+      }
+
+      it 'is aliased as #request_new_signature_dkim' do
+        expect(subject).to respond_to(:request_new_signature_dkim).
+            with(1).argument
+      end
+
+      it 'performs a POST request to /senders/:id/requestnewdkim endpoint' do
+        allow(subject.http_client).to receive(:post).
+            with('senders/42/requestnewdkim').and_return(response)
+        subject.request_new_sender_dkim(42)
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:post).and_return(response)
+        keys = subject.request_new_sender_dkim(42).keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+    end
+
+    describe '#delete_sender' do
+
+      let(:response) {
+        {
+          "ErrorCode" => 0,
+          "Message" => "Signature someone@example.com removed."
+        }
+      }
+
+      it 'is aliased as #delete_signature' do
+        expect(subject).to respond_to(:delete_signature).with(1).argument
+      end
+
+      it 'performs a DELETE request to /senders/:id endpoint' do
+        allow(subject.http_client).to receive(:delete).
+            with('senders/42').and_return(response)
+        subject.delete_sender(42)
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:delete).and_return(response)
+        keys = subject.delete_sender(42).keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+    end
+
+    describe '#servers' do
+
+      let(:response) { {'TotalCount' => 10, 'Servers' => [{}, {}]} }
+
+      it 'returns an enumerator' do
+        expect(subject.servers).to be_kind_of(Enumerable)
+      end
+
+      it 'lazily loads servers' do
+        allow(subject.http_client).to receive(:get).
+            with('servers', an_instance_of(Hash)).and_return(response)
+        subject.servers.take(100)
+      end
+
+    end
+
+    describe '#get_servers' do
+
+      let(:response) {
+        {
+          'TotalCount' => 1,
+          'Servers' => [
+            {
+              "ID" => 11635,
+              "Name" => "Production01",
+              "ApiTokens" => [
+                "fe6ec0cf-ff06-787a-b5e9-e77a41c61ce3"
+              ],
+              "ServerLink" => "https://postmarkapp.com/servers/11635/overview",
+              "Color" => "red",
+              "SmtpApiActivated" => true,
+              "RawEmailEnabled" => false,
+              "InboundAddress" => "7373de3ebd66acea228fjkdkf88dd7d5@inbound.postmarkapp.com",
+              "InboundHookUrl" => "http://inboundhook.example.com/inbound",
+              "BounceHookUrl" => "http://bouncehook.example.com/bounce",
+              "InboundDomain" => "",
+              "InboundHash" => "7373de3ebd66acea228fjkdkf88dd7d5"
+            }
+          ]
+        }
+      }
+
+      it 'performs a GET request to /servers endpoint' do
+        allow(subject.http_client).to receive(:get).
+            with('servers', an_instance_of(Hash)).and_return(response)
+        subject.get_servers
+      end
+
+      it 'formats the keys of returned list of servers' do
+        allow(subject.http_client).to receive(:get).and_return(response)
+        keys = subject.get_servers.map { |s| s.keys }.flatten
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+      it 'accepts offset and count options' do
+        allow(subject.http_client).to receive(:get).
+            with('servers', :offset => 30, :count => 50).
+            and_return(response)
+        subject.get_servers(:offset => 30, :count => 50)
+      end
+    end
+
+    describe '#get_server' do
+
+      let(:response) {
+        {
+          "ID" => 7438,
+          "Name" => "Staging Testing",
+          "ApiTokens" => [
+            "fe6ec0cf-ff06-44aa-jf88-e77a41c61ce3"
+          ],
+          "ServerLink" => "https://postmarkapp.com/servers/7438/overview",
+          "Color" => "red",
+          "SmtpApiActivated" => true,
+          "RawEmailEnabled" => false,
+          "InboundAddress" => "7373de3ebd66acea22812731fb1dd7d5@inbound.postmarkapp.com",
+          "InboundHookUrl" => "",
+          "BounceHookUrl" => "",
+          "InboundDomain" => "",
+          "InboundHash" => "7373de3ebd66acea22812731fb1dd7d5"
+        }
+      }
+
+      it 'performs a GET request to /servers/:id endpoint' do
+        allow(subject.http_client).to receive(:get).
+            with('servers/42').and_return(response)
+        subject.get_server(42)
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:get).and_return(response)
+        keys = subject.get_server(42).keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+    end
+
+    describe '#get_servers_count' do
+
+      let(:response) { {'TotalCount' => 42} }
+
+      it 'returns a total number of servers' do
+        allow(subject.http_client).to receive(:get).
+            with('servers', an_instance_of(Hash)).and_return(response)
+        expect(subject.get_servers_count).to eq(42)
+      end
+
+    end
+
+    describe '#create_server' do
+
+      let(:response) {
+        {
+          "Name" => "Staging Testing",
+          "Color" => "red",
+          "SmtpApiActivated" => true,
+          "RawEmailEnabled" => false,
+          "InboundHookUrl" => "http://hooks.example.com/inbound",
+          "BounceHookUrl" => "http://hooks.example.com/bounce",
+          "InboundDomain" => ""
+        }
+      }
+
+      it 'performs a POST request to /servers endpoint' do
+        allow(subject.http_client).to receive(:post).
+            with('servers', an_instance_of(String)).and_return(response)
+        subject.create_server(:foo => 'bar')
+      end
+
+      it 'converts the server attribute names to camel case' do
+        allow(subject.http_client).to receive(:post).
+            with('servers', {'FooBar' => 'foo_bar'}.to_json).
+            and_return(response)
+        subject.create_server(:foo_bar => 'foo_bar')
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:post).and_return(response)
+        keys = subject.create_server(:foo => 'bar').keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+    end
+
+    describe '#update_server' do
+      let(:response) {
+        {
+          "ID" => 7450,
+          "Name" => "Production Testing",
+          "ApiTokens" => [
+              "fe6ec0cf-ff06-44aa-jf88-e77a41c61ce3"
+          ],
+          "ServerLink" => "https://postmarkapp.com/servers/7438/overview",
+          "Color" => "blue",
+          "SmtpApiActivated" => false,
+          "RawEmailEnabled" => false,
+          "InboundAddress" => "7373de3ebd66acea22812731fb1dd7d5@inbound.postmarkapp.com",
+          "InboundHookUrl" => "http://hooks.example.com/inbound",
+          "BounceHookUrl" => "http://hooks.example.com/bounce",
+          "InboundDomain" => "",
+          "InboundHash" => "7373de3ebd66acea22812731fb1dd7d5"
+        }
+      }
+
+      it 'converts the server attribute names to camel case' do
+        allow(subject.http_client).to receive(:put).
+            with(an_instance_of(String), {'FooBar' => 'foo_bar'}.to_json).
+            and_return(response)
+        subject.update_server(42, :foo_bar => 'foo_bar')
+      end
+
+      it 'performs a PUT request to /servers/:id endpoint' do
+        allow(subject.http_client).to receive(:put).
+            with('servers/42', an_instance_of(String)).
+            and_return(response)
+        subject.update_server(42, :foo => 'bar')
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:put).and_return(response)
+        keys = subject.update_server(42, :foo => 'bar').keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+    end
+
+    describe '#delete_server' do
+
+      let(:response) {
+        {
+          "ErrorCode" => "0",
+          "Message" => "Server Production Testing removed."
+        }
+      }
+
+      it 'performs a DELETE request to /servers/:id endpoint' do
+        allow(subject.http_client).to receive(:delete).
+            with('servers/42').and_return(response)
+        subject.delete_server(42)
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:delete).and_return(response)
+        keys = subject.delete_server(42).keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+    end
+
+  end
+
+end

data/spec/unit/postmark/api_client_spec.rb

@@ -170,6 +170,48 @@ describe Postmark::ApiClient do
     end
   end
 
+  describe '#messages' do
+
+    context 'given outbound' do
+
+      let(:response) {
+        {'TotalCount' => 5,
+         'Messages' => [{}].cycle(5).to_a}
+      }
+
+      it 'returns an enumerator' do
+        expect(subject.messages).to be_kind_of(Enumerable)
+      end
+
+      it 'loads outbound messages' do
+        allow(subject.http_client).to receive(:get).
+            with('messages/outbound', an_instance_of(Hash)).and_return(response)
+        expect(subject.messages.count).to eq(5)
+      end
+
+    end
+
+    context 'given inbound' do
+
+      let(:response) {
+        {'TotalCount' => 5,
+         'InboundMessages' => [{}].cycle(5).to_a}
+      }
+
+      it 'returns an enumerator' do
+        expect(subject.messages(:inbound => true)).to be_kind_of(Enumerable)
+      end
+
+      it 'loads inbound messages' do
+        allow(subject.http_client).to receive(:get).
+            with('messages/inbound', an_instance_of(Hash)).and_return(response)
+        expect(subject.messages(:inbound => true).count).to eq(5)
+      end
+
+    end
+
+  end
+
   describe '#get_messages' do
     let(:http_client) { subject.http_client }
 
@@ -199,6 +241,33 @@ describe Postmark::ApiClient do
     end
   end
 
+  describe '#get_messages_count' do
+
+    let(:response) { {'TotalCount' => 42} }
+
+    context 'given outbound' do
+
+      it 'requests and returns outbound messages count' do
+        allow(subject.http_client).to receive(:get).
+            with('messages/outbound', an_instance_of(Hash)).and_return(response)
+        expect(subject.get_messages_count).to eq(42)
+        expect(subject.get_messages_count(:inbound => false)).to eq(42)
+      end
+
+    end
+
+    context 'given inbound' do
+
+      it 'requests and returns inbound messages count' do
+        allow(subject.http_client).to receive(:get).
+            with('messages/inbound', an_instance_of(Hash)).and_return(response)
+        expect(subject.get_messages_count(:inbound => true)).to eq(42)
+      end
+
+    end
+
+  end
+
   describe '#get_message' do
     let(:id) { '8ad0e8b0-xxxx-xxxx-951d-223c581bb467' }
     let(:http_client) { subject.http_client }
@@ -255,6 +324,21 @@ describe Postmark::ApiClient do
     end
   end
 
+  describe '#bounces' do
+
+    it 'returns an Enumerator' do
+      expect(subject.bounces).to be_kind_of(Enumerable)
+    end
+
+    it 'requests data at /bounces' do
+      allow(subject.http_client).to receive(:get).
+          with('bounces', an_instance_of(Hash)).
+          and_return('TotalCount' => 1, 'Bounces' => [{}])
+      expect(subject.bounces.first(5).count).to eq(1)
+    end
+
+  end
+
   describe "#get_bounces" do
     let(:http_client) { subject.http_client }
     let(:options) { {:foo => :bar} }

data/spec/unit/postmark/bounce_spec.rb

@@ -85,7 +85,7 @@ describe Postmark::Bounce do
 
   describe "#dump" do
 
-    let(:bounce_body) { mock }
+    let(:bounce_body) { double }
     let(:response) { {:body => bounce_body} }
     let(:api_client) { Postmark.api_client }
 

data/spec/unit/postmark/client_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Postmark::Client do
+
+  subject { Postmark::Client.new('abcd-efgh') }
+
+  describe 'instance' do
+
+    describe '#find_each' do
+
+      let(:path) { 'resources' }
+      let(:name) { 'Resources' }
+      let(:response) {
+        {
+          'TotalCount' => 10,
+          name => [{'Foo' => 'bar'}, {'Bar' => 'foo'}]
+        }
+      }
+
+      it 'returns an enumerator' do
+        expect(subject.find_each(path, name)).to be_kind_of(Enumerable)
+      end
+
+      it 'can be iterated' do
+        collection = [{:foo => 'bar'}, {:bar => 'foo'}].cycle(5)
+        allow(subject.http_client).
+            to receive(:get).with(path, an_instance_of(Hash)).
+                             exactly(5).times.and_return(response)
+        expect { |b| subject.find_each(path, name, :count => 2).each(&b) }.
+            to yield_successive_args(*collection)
+      end
+
+      # Only Ruby >= 2.0.0 supports Enumerator#size
+      it 'lazily calculates the collection size',
+        :skip_ruby_version => ['1.8.7', '1.9'] do
+        allow(subject.http_client).
+            to receive(:get).exactly(1).times.and_return(response)
+        collection = subject.find_each(path, name, :count => 2)
+        expect(collection.size).to eq(10)
+      end
+
+      it 'iterates over the collection to count it' do
+        allow(subject.http_client).
+            to receive(:get).exactly(5).times.and_return(response)
+        expect(subject.find_each(path, name, :count => 2).count).to eq(10)
+      end
+
+    end
+
+  end
+
+end