postmark 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  data.tar.gz: cb99b9ac9a2d5bdf8e7821b7ba920c6ef5c130c9
-  metadata.gz: 83c5dc42e240a0dd0b400560b5b5f9621ca79e47
+  metadata.gz: 923bce8373580308c169aa8e11f9f284366f03c6
+  data.tar.gz: da7597f415f0875cdc6f25f9466fd986b4e1893f
 SHA512: 
-  data.tar.gz: 562a81cdfc164088c052fb8a92293d7e4049381ea248ed8a4b9badc6075c77544d1a54e4113aea20a8a079bd647f0c90930f2c6778bfc4de9c8ccaee404fcdff
-  metadata.gz: f7074eea782237a6419e729f37492b89e441647a2a6fe68014db990a683bda16f431f119aa90ac51eb0182efdbc0b4ed317e5f03a24bda04239c62077de076f2
+  metadata.gz: 2b883d6b1fd1e6afa8d80de6383b9756677fc9757a1ee14547bb193f9d1df27940d2d451ff534ffa83cc91cbd46fc37f1ab5f4abae25bc2256d7829dabd8f5a2
+  data.tar.gz: 7dbd50bc42683980f83befda6d7e91cc040676ed6ffe1e3ce4435e513cc192cf1621370c7d77c1ac04f2b5b31b97167b9fc30a76279f0e8142cdfa3292b76a35

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
 = Changelog
 
+== 1.4.0
+
+* Add descriptive User-Agent string.
+* Enable secure HTTP connections by default.
+
 == 1.3.1
 
 * Allow track_open header to be String for compatibility with older versions of the mail gem.

data/README.md

@@ -42,13 +42,12 @@ client = Postmark::ApiClient.new(your_api_key)
 `Postmark::ApiClient` accepts various options:
 
 ``` ruby
-client = Postmark::ApiClient.new(your_api_key, secure: true
-                                               http_open_timeout: 15)
+client = Postmark::ApiClient.new(your_api_key, http_open_timeout: 15)
 ```
 
 Some useful options are:
 
-* `secure` (`true` or `false`): set to true to use SSL connection.
+* `secure` (`true` or `false`): set to false to disable SSL connection.
 * `http_read_timeout` (positive number): limit HTTP read time to `n` seconds.
 * `http_open_timeout` (positive number): limit HTTP open time to `n` seconds.
 * `proxy_host` (string): proxy address to use.
@@ -317,7 +316,7 @@ a delivery method for the message:
 ``` ruby
 message = Mail.new do
   # ...
-  delivery_method Mail::Postmark, api_key: 'your-postmark-api-key', secure: true
+  delivery_method Mail::Postmark, api_key: 'your-postmark-api-key'
 end
 ```
 
@@ -366,7 +365,7 @@ 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" # Fee free to use true on mail >= 2.3.0
+  track_opens     "true" # Feel free to use boolean values on mail >= 2.3.0
 
   delivery_method Mail::Postmark, :api_key => 'your-postmark-api-key'
 end

data/VERSION

@@ -1 +1 @@
-1.3.1
+1.4.0

data/lib/postmark.rb

@@ -2,6 +2,7 @@ require 'net/http'
 require 'net/https'
 require 'thread' unless defined? Mutex # For Ruby 1.8.7
 
+require 'postmark/version'
 require 'postmark/inflector'
 require 'postmark/helpers/hash_helper'
 require 'postmark/helpers/message_helper'
@@ -42,6 +43,7 @@ module Postmark
   end
 
   HEADERS = {
+    'User-Agent'   => "Postmark Ruby Gem v#{VERSION}",
     'Content-type' => 'application/json',
     'Accept'       => 'application/json'
   }

data/lib/postmark/api_client.rb

@@ -178,7 +178,7 @@ module Postmark
     def update_message(message, response)
       response ||= {}
       message['Message-ID'] = response['MessageID']
-      message.delivered = !!response['MessageID']
+      message.delivered = response['ErrorCode'] && response['ErrorCode'].zero?
       message.postmark_response = response
     end
 

data/lib/postmark/http_client.rb

@@ -11,7 +11,7 @@ module Postmark
     DEFAULTS = {
       :auth_header_name => 'X-Postmark-Server-Token',
       :host => 'api.postmarkapp.com',
-      :secure => false,
+      :secure => true,
       :path_prefix => '/',
       :http_read_timeout => 15,
       :http_open_timeout => 5

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = "1.3.1"
+  VERSION = '1.4.0'
 end

data/spec/integration/api_client_messages_spec.rb

@@ -42,6 +42,14 @@ describe "Sending Mail::Messages with Postmark::ApiClient" do
   let(:partially_valid_messages) { [message, message.dup, message_with_no_body] }
   let(:invalid_messages) { [message_with_no_body, message_with_no_body.dup] }
 
+  context 'invalid API code' do
+    it "doesn't deliver messages" do
+      expect {
+        Postmark::ApiClient.new('INVALID').deliver_message(message) rescue Postmark::InvalidApiKeyError
+      }.to change{message.delivered?}.to(false)
+    end
+  end
+
   context "message by message" do
     it 'delivers a plain text message' do
       api_client.deliver_message(message).should have_key(:message_id)

data/spec/unit/postmark/http_client_spec.rb

@@ -7,17 +7,6 @@ describe Postmark::HttpClient do
   end
 
   let(:api_key) { "provided-postmark-api-key" }
-  let(:secure) { true }
-  let(:proxy_host) { "providedproxyhostname.com" }
-  let(:proxy_port) { 42 }
-  let(:proxy_user) { "provided proxy user" }
-  let(:proxy_pass) { "provided proxy pass" }
-  let(:host) { "providedhostname.org" }
-  let(:port) { 443 }
-  let(:path_prefix) { "/provided/path/prefix" }
-  let(:http_open_timeout) { 42 }
-  let(:http_read_timeout) { 42 }
-
   let(:http_client) { Postmark::HttpClient.new(api_key) }
   subject { http_client }
 
@@ -43,14 +32,25 @@ describe Postmark::HttpClient do
   context "when it is created without options" do
     its(:api_key) { should eq api_key }
     its(:host) { should eq 'api.postmarkapp.com' }
-    its(:port) { should eq 80 }
-    its(:secure) { should be_false }
+    its(:port) { should eq 443 }
+    its(:secure) { should be_true }
     its(:path_prefix) { should eq '/' }
     its(:http_read_timeout) { should eq 15 }
     its(:http_open_timeout) { should eq 5 }
   end
 
   context "when it is created with options" do
+    let(:secure) { true }
+    let(:proxy_host) { "providedproxyhostname.com" }
+    let(:proxy_port) { 42 }
+    let(:proxy_user) { "provided proxy user" }
+    let(:proxy_pass) { "provided proxy pass" }
+    let(:host) { "providedhostname.org" }
+    let(:port) { 443 }
+    let(:path_prefix) { "/provided/path/prefix" }
+    let(:http_open_timeout) { 42 }
+    let(:http_read_timeout) { 42 }
+
     subject { Postmark::HttpClient.new(api_key, 
                                        :secure => secure,
                                        :proxy_host => proxy_host,
@@ -78,7 +78,7 @@ describe Postmark::HttpClient do
 
   describe "#post" do
     let(:target_path) { "path/on/server" }
-    let(:target_url) { "http://api.postmarkapp.com/#{target_path}" }
+    let(:target_url) { "https://api.postmarkapp.com/#{target_path}" }
 
     it "sends a POST request to provided URI" do
       FakeWeb.register_uri(:post, target_url, :body => response_body(200))
@@ -120,7 +120,7 @@ describe Postmark::HttpClient do
 
   describe "#get" do
     let(:target_path) { "path/on/server" }
-    let(:target_url) { "http://api.postmarkapp.com/#{target_path}" }
+    let(:target_url) { "https://api.postmarkapp.com/#{target_path}" }
 
     it "sends a GET request to provided URI" do
       FakeWeb.register_uri(:get, target_url, :body => response_body(200))
@@ -136,25 +136,24 @@ describe Postmark::HttpClient do
 
     it "raises a custom error when sent JSON was not valid" do
       FakeWeb.register_uri(:get, target_url, :body => response_body(422),
-                                              :status => [ "422", "Invalid" ])
+                                             :status => [ "422", "Invalid" ])
       expect { subject.get(target_path) }.to raise_error Postmark::InvalidMessageError
     end
 
     it "raises a custom error when server fails to process the request" do
       FakeWeb.register_uri(:get, target_url, :body => response_body(500),
-                                              :status => [ "500", "Internal Server Error" ])
+                                             :status => [ "500", "Internal Server Error" ])
       expect { subject.get(target_path) }.to raise_error Postmark::InternalServerError
     end
 
     it "raises a custom error when the request times out" do
-      subject.http.should_receive(:get).at_least(:once).
-                                             and_raise(Timeout::Error)
+      subject.http.should_receive(:get).at_least(:once).and_raise(Timeout::Error)
       expect { subject.get(target_path) }.to raise_error Postmark::TimeoutError
     end
 
     it "raises a default error when unknown issue occurs" do
       FakeWeb.register_uri(:get, target_url, :body => response_body(485),
-                                              :status => [ "485", "Custom HTTP response status" ])
+                                             :status => [ "485", "Custom HTTP response status" ])
       expect { subject.get(target_path) }.to raise_error Postmark::UnknownError
     end
     
@@ -162,7 +161,7 @@ describe Postmark::HttpClient do
 
   describe "#put" do
     let(:target_path) { "path/on/server" }
-    let(:target_url) { "http://api.postmarkapp.com/#{target_path}" }
+    let(:target_url) { "https://api.postmarkapp.com/#{target_path}" }
 
     it "sends a PUT request to provided URI" do
       FakeWeb.register_uri(:put, target_url, :body => response_body(200))
@@ -172,31 +171,30 @@ describe Postmark::HttpClient do
 
     it "raises a custom error when API key authorization fails" do
       FakeWeb.register_uri(:put, target_url, :body => response_body(401),
-                                              :status => [ "401", "Unauthorized" ])
+                                             :status => [ "401", "Unauthorized" ])
       expect { subject.put(target_path) }.to raise_error Postmark::InvalidApiKeyError
     end
 
     it "raises a custom error when sent JSON was not valid" do
       FakeWeb.register_uri(:put, target_url, :body => response_body(422),
-                                              :status => [ "422", "Invalid" ])
+                                             :status => [ "422", "Invalid" ])
       expect { subject.put(target_path) }.to raise_error Postmark::InvalidMessageError
     end
 
     it "raises a custom error when server fails to process the request" do
       FakeWeb.register_uri(:put, target_url, :body => response_body(500),
-                                              :status => [ "500", "Internal Server Error" ])
+                                             :status => [ "500", "Internal Server Error" ])
       expect { subject.put(target_path) }.to raise_error Postmark::InternalServerError
     end
 
     it "raises a custom error when the request times out" do
-      subject.http.should_receive(:put).at_least(:once).
-                                             and_raise(Timeout::Error)
+      subject.http.should_receive(:put).at_least(:once).and_raise(Timeout::Error)
       expect { subject.put(target_path) }.to raise_error Postmark::TimeoutError
     end
 
     it "raises a default error when unknown issue occurs" do
       FakeWeb.register_uri(:put, target_url, :body => response_body(485),
-                                              :status => [ "485", "Custom HTTP response status" ])
+                                             :status => [ "485", "Custom HTTP response status" ])
       expect { subject.put(target_path) }.to raise_error Postmark::UnknownError
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: postmark
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors: 
 - Petyo Ivanov
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-06-05 00:00:00 Z
+date: 2014-12-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake