postmark 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04bb2d6b28c097935401c0bef37ca1ea75114d12
-  data.tar.gz: ab9fb06aea0112f5ac0a7ab94902592a0ed7bfab
+  metadata.gz: 0db315ab0a2f924dca2620b8fc4d18f8c07445e5
+  data.tar.gz: 9a322908b988cd2e61126a16359ec95ad02cd391
 SHA512:
-  metadata.gz: 324a336fbf5d24aa554e4d8aba8fd55ed4785cd4bb0b42bc1241bfdb6230e6d59ab8da5165e08343b084c9eed68f11dd2a7d2aa0a7e4ff0761c8a7cf2723215b
-  data.tar.gz: 96c991acef4077c05af52f7f0bda6084e6777e6d3bc3e4c08ae75c0f421b03d8ff943a13d89b5e8ceab732f83432023ad0f58f4f1f22342fc57b2aa9752e0473
+  metadata.gz: 1ae0e033687041435061769f2d9e39cbe3de8cf1d46e5939c808aeaa69f88ad844eb9578d1d3cf8babbeae355d64223b4355edfb17c58fee4778d933c5537c4b
+  data.tar.gz: 7adbede1755f986942d4260cc44c4d96e2ac03aeea90804162a352184d17f75a4dbfca7348950ada41df6f468092e004cb82c8980086ad5d626dc6423ed3c4c4

data/.gitignore

@@ -6,3 +6,4 @@ pkg/*
 .rvmrc
 .idea
 bin/*
+*.swp

data/.travis.yml

@@ -21,6 +21,7 @@ matrix:
     - rvm: 1.9.3
       gemfile: gemfiles/Gemfile.legacy
     - rvm: jruby-19mode
+      jdk: oraclejdk8 
       gemfile: gemfiles/Gemfile.legacy
 script: bundle exec rake spec
 before_install:

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Changelog
 
+== 1.9.0
+
+* Added methods to access domains API endoints
+
 == 1.8.1
 
 * Technical release. Fixed gemspec.

data/VERSION

@@ -1 +1 @@
-1.8.1
+1.9.0

data/lib/postmark/account_api_client.rb

@@ -61,6 +61,46 @@ module Postmark
     end
     alias_method :delete_signature, :delete_sender
 
+    def domains(options = {})
+      find_each('domains', 'Domains', options)
+    end
+
+    def get_domains(options = {})
+      load_batch('domains', 'Domains', options).last
+    end
+
+    def get_domains_count(options = {})
+      get_resource_count('domains', options)
+    end
+
+    def get_domain(id)
+      format_response http_client.get("domains/#{id.to_i}")
+    end
+
+    def create_domain(attributes = {})
+      data = serialize(HashHelper.to_postmark(attributes))
+
+      format_response http_client.post('domains', data)
+    end
+
+    def update_domain(id, attributes = {})
+      data = serialize(HashHelper.to_postmark(attributes))
+
+      format_response http_client.put("domains/#{id.to_i}", data)
+    end
+
+    def verified_domain_spf?(id)
+      !!http_client.post("domains/#{id.to_i}/verifyspf")['SPFVerified']
+    end
+
+    def rotate_domain_dkim(id)
+      format_response http_client.post("domains/#{id.to_i}/rotatedkim")
+    end
+
+    def delete_domain(id)
+      format_response http_client.delete("domains/#{id.to_i}")
+    end
+
     def servers(options = {})
       find_each('servers', 'Servers', options)
     end
@@ -93,4 +133,4 @@ module Postmark
 
   end
 
-end
+end

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.8.1'
+  VERSION = '1.9.0'
 end

data/spec/integration/account_api_client_spec.rb

@@ -31,6 +31,7 @@ describe 'Account API client usage' do
     expect(updated_sender[:name]).to eq('New Name')
     expect(updated_sender[:id]).to eq(new_sender[:id])
 
+
     # spf
     expect(subject.verified_sender_spf?(new_sender[:id])).to be_true
 
@@ -46,6 +47,44 @@ describe 'Account API client usage' do
     expect { subject.delete_sender(new_sender[:id]) }.not_to raise_error
   end
 
+  it 'can be used to manage domains' do
+    new_domain = nil
+    domain_name = "#{unique_token}-gem-integration.test"
+    return_path = "return.#{domain_name}"
+    updated_return_path = "updated-return.#{domain_name}"
+
+    # create & count
+    new_domain = subject.create_domain(:name => domain_name,
+                                       :return_path_domain => return_path)
+    expect(subject.get_domains_count).to be > 0
+
+    # get
+    expect(subject.get_domain(new_domain[:id])[:id]).to eq(new_domain[:id])
+
+    # list
+    domains = subject.get_domains(:count => 50)
+    expect(domains.map { |d| d[:id] }).to include(new_domain[:id])
+
+    # collection
+    expect(subject.domains.map { |d| d[:id] }).to include(new_domain[:id])
+
+    # update
+    updated_domain = subject.update_domain(new_domain[:id], :return_path_domain => updated_return_path)
+    expect(updated_domain[:return_path_domain]).to eq(updated_return_path)
+    expect(updated_domain[:id]).to eq(new_domain[:id])
+
+    # spf
+    expect(subject.verified_domain_spf?(new_domain[:id])).to be_false
+
+    # dkim
+    expect { subject.rotate_domain_dkim(new_domain[:id]) }.
+        to raise_error(Postmark::InvalidMessageError,
+                       'This DKIM is already being renewed.')
+
+    # delete
+    expect { subject.delete_domain(new_domain[:id]) }.not_to raise_error
+  end
+
   it 'can be used to manage servers' do
     new_server = nil
 
@@ -73,4 +112,4 @@ describe 'Account API client usage' do
     expect { subject.delete_server(new_server[:id]) }.not_to raise_error
   end
 
-end
+end

data/spec/unit/postmark/account_api_client_spec.rb

@@ -323,6 +323,221 @@ describe Postmark::AccountApiClient do
       end
 
     end
+    
+    describe '#domains' do
+
+      let(:response) {
+        {
+          'TotalCount' => 10, 'Domains' => [{}, {}]
+        }
+      }
+
+      it 'returns an enumerator' do
+        expect(subject.domains).to be_kind_of(Enumerable)
+      end
+
+      it 'lazily loads domains' do
+        allow(subject.http_client).to receive(:get).
+            with('domains', an_instance_of(Hash)).and_return(response)
+        subject.domains.take(1000)
+      end
+
+    end
+
+    describe '#get_domains' do
+
+      let(:response) {
+        {
+          "TotalCount" => 1,
+          "Domains" => [{
+            "Name" => "example.com",
+            "ID" => 8139
+          }]
+        }
+      }
+
+      it 'performs a GET request to /domains endpoint' do
+        allow(subject.http_client).to receive(:get).
+            with('domains', :offset => 0, :count => 30).
+            and_return(response)
+        subject.get_domains
+      end
+
+      it 'formats the keys of returned list of domains' do
+        allow(subject.http_client).to receive(:get).and_return(response)
+        keys = subject.get_domains.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('domains', :offset => 10, :count => 42).
+            and_return(response)
+        subject.get_domains(:offset => 10, :count => 42)
+      end
+
+    end
+
+    describe '#get_domains_count' do
+
+      let(:response) { {'TotalCount' => 42} }
+
+      it 'returns a total number of domains' do
+        allow(subject.http_client).to receive(:get).
+            with('domains', an_instance_of(Hash)).and_return(response)
+        expect(subject.get_domains_count).to eq(42)
+      end
+
+    end
+
+    describe '#get_domain' do
+
+      let(:response) {
+        {
+          "Name" => "example.com",
+          "ID" => 8139
+        }
+      }
+
+      it 'performs a GET request to /domains/:id endpoint' do
+        allow(subject.http_client).to receive(:get).with("domains/42").
+                                                    and_return(response)
+        subject.get_domain(42)
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:get).and_return(response)
+        keys = subject.get_domain(42).keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+    end
+
+    describe '#create_domain' do
+
+      let(:response) {
+        {
+          "Name" => "example.com",
+          "ID" => 8139
+        }
+      }
+
+      it 'performs a POST request to /domains endpoint' do
+        allow(subject.http_client).to receive(:post).
+            with("domains", an_instance_of(String)).and_return(response)
+        subject.create_domain(:name => 'example.com')
+      end
+
+      it 'converts the domain attributes names to camel case' do
+        allow(subject.http_client).to receive(:post).
+            with("domains", {'FooBar' => 'bar'}.to_json).and_return(response)
+        subject.create_domain(: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_domain(:foo => 'bar').keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+    end
+
+    describe '#update_domain' do
+
+      let(:response) {
+        {
+          "Name" => "example.com",
+          "ReturnPathDomain" => "return.example.com",
+          "ID" => 8139
+        }
+      }
+
+      it 'performs a PUT request to /domains/:id endpoint' do
+        allow(subject.http_client).to receive(:put).
+            with('domains/42', an_instance_of(String)).and_return(response)
+        subject.update_domain(42, :return_path_domain => 'updated-return.example.com')
+      end
+
+      it 'converts the domain attributes names to camel case' do
+        allow(subject.http_client).to receive(:put).
+            with('domains/42', {'FooBar' => 'bar'}.to_json).and_return(response)
+        subject.update_domain(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_domain(42, :foo => 'bar').keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+    end
+
+    describe '#verified_domain_spf?' do
+
+      let(:response) { {"SPFVerified" => true} }
+      let(:false_response) { {"SPFVerified" => false} }
+
+      it 'performs a POST request to /domains/:id/verifyspf endpoint' do
+        allow(subject.http_client).to receive(:post).
+            with('domains/42/verifyspf').and_return(response)
+        subject.verified_domain_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_domain_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_domain_spf?(42)).to be_true
+      end
+
+    end
+
+    describe '#rotate_domain_dkim' do
+
+      let(:response) {
+        {
+          "Name" => "example.com",
+          "ID" => 8139
+        }
+      }
+
+      it 'performs a POST request to /domains/:id/rotatedkim endpoint' do
+        allow(subject.http_client).to receive(:post).
+            with('domains/42/rotatedkim').and_return(response)
+        subject.rotate_domain_dkim(42)
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:post).and_return(response)
+        keys = subject.rotate_domain_dkim(42).keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be_true
+      end
+
+    end
+
+    describe '#delete_domain' do
+
+      let(:response) {
+        {
+          "ErrorCode" => 0,
+          "Message" => "Domain example.com removed."
+        }
+      }
+
+      it 'performs a DELETE request to /domains/:id endpoint' do
+        allow(subject.http_client).to receive(:delete).
+            with('domains/42').and_return(response)
+        subject.delete_domain(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
 
@@ -535,4 +750,4 @@ describe Postmark::AccountApiClient do
 
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Petyo Ivanov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake