postmark 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b6cd5a5bf46c2c22b7ef83182778ca9d77ae269
-  data.tar.gz: 04066522d985faed76d5aa028c1aa4985304876f
+  metadata.gz: d99b2b07a9b385d8373eb4f0f020806d4ead30fc
+  data.tar.gz: 56f731c91f3d7a660e56c896d5666ee65c177ec1
 SHA512:
-  metadata.gz: 0f667a7423a02dd37de2c4efb28e1384dc0f07ee8b01a54fe9ae2d718e7ce4140eb3381c0073831b0d4799fbe2cddcb05e4ce5b6f4cc6284aa786e9beb269caa
-  data.tar.gz: 941a75f25a9c13b6ed9736b54cace4d445a29723c564c4ad14584c4f2a363dcf3a48f61fb461b0f2b1ab36f9189239fb3aa52a66db765df4f6bd175c4e5ecca4
+  metadata.gz: 1e0545eb81715e7a0d436557498f4cb0c3196fed8964ca8e0bc51699d2e944faacbb269cd8bfc1be537564983b2932a789738d2a9a0ba4271d2487371c3de61c
+  data.tar.gz: 6c5f27e71506ef94a7efb1f07bd14438f9f9403f9d1a209434dab722c3a96e57448e937d02f8da0f394596e4d3e800e2d5baf67cf2ec793e856ae7b364d8abf9

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Changelog
 
+== 1.5.0
+
+* Call API access strings tokens instead of keys. Keep backwards compatibility.
+
 == 1.4.3
 
 * Fix a regression when using the gem with older mail gem versions not implementing Mail::Message#text?.

data/README.md

@@ -1,5 +1,5 @@
 # Postmark Gem
-[![Build Status](https://travis-ci.org/wildbit/postmark-gem.png?branch=master)](https://travis-ci.org/wildbit/postmark-gem) [![Code Climate](https://codeclimate.com/github/wildbit/postmark-gem.png)](https://codeclimate.com/github/wildbit/postmark-gem)
+[![Build Status](https://travis-ci.org/wildbit/postmark-gem.svg?branch=master)](https://travis-ci.org/wildbit/postmark-gem) [![Code Climate](https://codeclimate.com/github/wildbit/postmark-gem/badges/gpa.svg)](https://codeclimate.com/github/wildbit/postmark-gem)
 
 This gem is the official wrapper for the [Postmark HTTP API](http://postmarkapp.com). Postmark allows you to send your application's emails with high delivery rates, including bounce/spam processing and detailed statistics. In addition, Postmark can parse incoming emails which are forwarded back to your application.
 
@@ -17,14 +17,14 @@ Without Bundler:
 gem install postmark
 ```
 
-## Get a Postmark API key
+## Get a Postmark API token
 
 In order to send emails using Postmark ruby gem, you will need a
 [Postmark](http://postmarkapp.com) account. If you don't have one please
 register at https://postmarkapp.com/sign_up.
 
 If you didn’t create any servers yet, please create one, proceed to the
-`Credentials` tab and copy an API key. API keys should be frequently rotated for
+`Credentials` tab and copy an API token. API tokens should be frequently rotated for
 security reasons.
 
 ## Communicating with the API
@@ -35,14 +35,14 @@ every From email address you specify.
 Create an instance of `Postmark::ApiClient` to start sending emails.
 
 ``` ruby
-your_api_key = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
-client = Postmark::ApiClient.new(your_api_key)
+your_api_token = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+client = Postmark::ApiClient.new(your_api_token)
 ```
 
 `Postmark::ApiClient` accepts various options:
 
 ``` ruby
-client = Postmark::ApiClient.new(your_api_key, http_open_timeout: 15)
+client = Postmark::ApiClient.new(your_api_token, http_open_timeout: 15)
 ```
 
 Some useful options are:
@@ -316,7 +316,7 @@ a delivery method for the message:
 ``` ruby
 message = Mail.new do
   # ...
-  delivery_method Mail::Postmark, api_key: 'your-postmark-api-key'
+  delivery_method Mail::Postmark, api_token: 'your-postmark-api-token'
 end
 ```
 
@@ -339,7 +339,7 @@ message = Mail.new do
   body            'That\'s what you said about the Green Lantern movie. You' \
                   'were 114 minutes of wrong.'
 
-  delivery_method Mail::Postmark, :api_key => 'your-postmark-api-key'
+  delivery_method Mail::Postmark, :api_token => 'your-postmark-api-token'
 end
 
 message.deliver
@@ -367,7 +367,7 @@ message = Mail.new do
 
   track_opens     "true" # Feel free to use boolean values on mail >= 2.3.0
 
-  delivery_method Mail::Postmark, :api_key => 'your-postmark-api-key'
+  delivery_method Mail::Postmark, :api_token => 'your-postmark-api-token'
 end
 
 message.deliver
@@ -384,7 +384,7 @@ message = Mail.new do
   body            'You look like a real geek!'
   add_file        '1.jpeg'
 
-  delivery_method Mail::Postmark, :api_key => 'your-postmark-api-key'
+  delivery_method Mail::Postmark, :api_token => 'your-postmark-api-token'
 end
 
 message.attachments['sheldon.jpeg'] = File.read('2.jpeg')
@@ -419,7 +419,7 @@ message = Mail.new do
   from            'sheldon@bigbangtheory.com'
   to              'Leonard Hofstadter <leonard@bigbangtheory.com>'
   subject         'Re: Anything Can Happen Thursday'
-  delivery_method Mail::Postmark, :api_key => 'your-postmark-api-key'
+  delivery_method Mail::Postmark, :api_token => 'your-postmark-api-token'
 
   text_part do
     body          'Apparently the news didn\'t reach my digestive system,' \
@@ -458,7 +458,7 @@ message = Mail.new do
                  'hallway and immediately adjacent to that hallway is this!'
   tag            'confidential'
 
-  delivery_method Mail::Postmark, :api_key => 'your-postmark-api-key'
+  delivery_method Mail::Postmark, :api_token => 'your-postmark-api-token'
 end
 
 message.deliver
@@ -557,7 +557,7 @@ require 'mail'
 require 'json'
 
 Postmark.response_parser_class = :Json
-Postmark.api_key = 'your-postmark-api-key'
+Postmark.api_token = 'your-postmark-api-token'
 
 # Get bounces information: (array of bounce objects)
 Postmark::Bounce.all

data/VERSION

@@ -1 +1 @@
-1.4.3
+1.5.0

data/lib/postmark.rb

@@ -52,10 +52,13 @@ module Postmark
 
   @@api_client_mutex = Mutex.new
 
-  attr_accessor :secure, :api_key, :proxy_host, :proxy_port, :proxy_user,
+  attr_accessor :secure, :api_token, :proxy_host, :proxy_port, :proxy_user,
                 :proxy_pass, :host, :port, :path_prefix,
                 :http_open_timeout, :http_read_timeout, :max_retries
 
+  alias_method :api_key, :api_token
+  alias_method :api_key=, :api_token=
+
   attr_writer :response_parser_class, :api_client
 
   def response_parser_class
@@ -71,7 +74,7 @@ module Postmark
 
     @@api_client_mutex.synchronize do
       @api_client ||= Postmark::ApiClient.new(
-                        self.api_key,
+                        self.api_token,
                         :secure => self.secure,
                         :proxy_host => self.proxy_host,
                         :proxy_port => self.proxy_port,

data/lib/postmark/account_api_client.rb

@@ -2,7 +2,7 @@ module Postmark
 
   class AccountApiClient < Client
 
-    def initialize(api_key, options = {})
+    def initialize(api_token, options = {})
       options[:auth_header_name] = 'X-Postmark-Account-Token'
       super
     end

data/lib/postmark/api_client.rb

@@ -2,7 +2,7 @@ module Postmark
   class ApiClient < Client
     attr_accessor :max_batch_size
 
-    def initialize(api_key, options = {})
+    def initialize(api_token, options = {})
       options = options.dup
       @max_batch_size = options.delete(:max_batch_size) || 500
       super

data/lib/postmark/client.rb

@@ -4,15 +4,16 @@ module Postmark
   class Client
     attr_reader :http_client, :max_retries
 
-    def initialize(api_key, options = {})
+    def initialize(api_token, options = {})
       options = options.dup
       @max_retries = options.delete(:max_retries) || 3
-      @http_client = HttpClient.new(api_key, options)
+      @http_client = HttpClient.new(api_token, options)
     end
 
-    def api_key=(api_key)
-      http_client.api_key = api_key
+    def api_token=(api_token)
+      http_client.api_token = api_token
     end
+    alias_method :api_key=, :api_token=
 
     def find_each(path, name, options = {})
       if block_given?

data/lib/postmark/handlers/mail.rb

@@ -4,13 +4,13 @@ module Mail
     attr_accessor :settings
 
     def initialize(values)
-      self.settings = { :api_key => nil }.merge(values)
+      self.settings = { :api_token => ENV['POSTMARK_API_TOKEN'] }.merge(values)
     end
 
     def deliver!(mail)
       settings = self.settings.dup
-      api_key = settings.delete(:api_key)
-      api_client = ::Postmark::ApiClient.new(api_key, settings)
+      api_token = settings.delete(:api_token) || settings.delete(:api_key)
+      api_client = ::Postmark::ApiClient.new(api_token, settings)
       response = api_client.deliver_message(mail)
 
       if settings[:return_response]

data/lib/postmark/http_client.rb

@@ -3,10 +3,12 @@ require 'cgi'
 
 module Postmark
   class HttpClient
-    attr_accessor :api_key
+    attr_accessor :api_token
     attr_reader :http, :secure, :proxy_host, :proxy_port, :proxy_user,
                 :proxy_pass, :host, :port, :path_prefix,
                 :http_open_timeout, :http_read_timeout, :auth_header_name
+    alias_method :api_key, :api_token
+    alias_method :api_key=, :api_token=
 
     DEFAULTS = {
       :auth_header_name => 'X-Postmark-Server-Token',
@@ -17,8 +19,8 @@ module Postmark
       :http_open_timeout => 5
     }
 
-    def initialize(api_key, options = {})
-      @api_key = api_key
+    def initialize(api_token, options = {})
+      @api_token = api_token
       @request_mutex = Mutex.new
       apply_options(options)
       @http = build_http
@@ -79,7 +81,7 @@ module Postmark
     end
 
     def headers
-      HEADERS.merge(self.auth_header_name => self.api_key.to_s)
+      HEADERS.merge(self.auth_header_name => self.api_token.to_s)
     end
 
     def url_path(path)

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.4.3'
+  VERSION = '1.5.0'
 end

data/spec/integration/mail_delivery_method_spec.rb

@@ -10,7 +10,7 @@ describe "Sending Mail::Messages with delivery_method Mail::Postmark" do
       subject "Mail::Message object"
       body "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do "
            "eiusmod tempor incididunt ut labore et dolore magna aliqua."
-      delivery_method Mail::Postmark, :api_key => "POSTMARK_API_TEST",
+      delivery_method Mail::Postmark, :api_token => "POSTMARK_API_TEST",
                                       :http_open_timeout => 15,
                                       :http_read_timeout => 15
 
@@ -27,7 +27,7 @@ describe "Sending Mail::Messages with delivery_method Mail::Postmark" do
     Mail.new do
       from "sender@postmarkapp.com"
       to "recipient@postmarkapp.com"
-      delivery_method Mail::Postmark, :api_key => "POSTMARK_API_TEST",
+      delivery_method Mail::Postmark, :api_token => "POSTMARK_API_TEST",
                                       :http_open_timeout => 15,
                                       :http_read_timeout => 15
     end
@@ -43,7 +43,7 @@ describe "Sending Mail::Messages with delivery_method Mail::Postmark" do
     Mail.new do
       from "sender@postmarkapp.com"
       to "@postmarkapp.com"
-      delivery_method Mail::Postmark, :api_key => "POSTMARK_API_TEST",
+      delivery_method Mail::Postmark, :api_token => "POSTMARK_API_TEST",
                                       :http_open_timeout => 15,
                                       :http_read_timeout => 15
     end

data/spec/spec_helper.rb

@@ -38,7 +38,7 @@ RSpec.configure do |config|
   }
 
   config.before(:each) do
-    %w(api_client response_parser_class secure api_key proxy_host proxy_port
+    %w(api_client response_parser_class secure api_token proxy_host proxy_port
        proxy_user proxy_pass host port path_prefix http_open_timeout
        http_read_timeout max_retries).each do |var|
       Postmark.instance_variable_set(:"@#{var}", nil)

data/spec/unit/postmark/account_api_client_spec.rb

@@ -2,20 +2,20 @@ require 'spec_helper'
 
 describe Postmark::AccountApiClient do
 
-  let(:api_key) { 'abcd-efgh' }
+  let(:api_token) { 'abcd-efgh' }
   subject { Postmark::AccountApiClient}
 
-  it 'can be created with an API key' do
-    expect { subject.new(api_key) }.not_to raise_error
+  it 'can be created with an API token' do
+    expect { subject.new(api_token) }.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
+  it 'can be created with an API token and options hash' do
+    expect { subject.new(api_token, :http_read_timeout => 5) }.not_to raise_error
   end
 
   context 'instance' do
 
-    subject { Postmark::AccountApiClient.new(api_key) }
+    subject { Postmark::AccountApiClient.new(api_token) }
 
     it 'uses the auth header specific for Account API' do
       auth_header = subject.http_client.auth_header_name

data/spec/unit/postmark/api_client_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Postmark::ApiClient do
 
-  let(:api_key) { "provided-api-key" }
+  let(:api_token) { "provided-api-token" }
   let(:max_retries) { 42 }
   let(:message_hash) {
     {
@@ -16,7 +16,7 @@ describe Postmark::ApiClient do
     end
   }
 
-  let(:api_client) { Postmark::ApiClient.new(api_key) }
+  let(:api_client) { Postmark::ApiClient.new(api_token) }
   subject { api_client }
 
   context "attr readers" do
@@ -32,25 +32,30 @@ describe Postmark::ApiClient do
 
   context "when it's created with user options" do
 
-    subject { Postmark::ApiClient.new(api_key, :max_retries => max_retries,
+    subject { Postmark::ApiClient.new(api_token, :max_retries => max_retries,
                                                :foo => :bar)}
 
     its(:max_retries) { should eq max_retries }
 
     it 'passes other options to HttpClient instance' do
-      Postmark::HttpClient.should_receive(:new).with(api_key, :foo => :bar)
+      Postmark::HttpClient.should_receive(:new).with(api_token, :foo => :bar)
       subject.should be
     end
 
   end
 
-  describe "#api_key=" do
+  describe "#api_token=" do
 
-    let(:api_key) { "new-api-key-value" }
+    let(:api_token) { "new-api-token-value" }
 
-    it 'assigns the api key to the http client instance' do
-      subject.api_key = api_key
-      subject.http_client.api_key.should == api_key
+    it 'assigns the api token to the http client instance' do
+      subject.api_token = api_token
+      subject.http_client.api_token.should == api_token
+    end
+
+    it 'is aliased as api_key=' do
+      subject.api_key = api_token
+      subject.http_client.api_token.should == api_token
     end
 
   end

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

@@ -32,8 +32,20 @@ describe Mail::Postmark do
     message.deliver.should eq message
   end
 
-  it "allows to set the api key" do
-    message.delivery_method Mail::Postmark, {:api_key => 'api-key'}
-    message.delivery_method.settings[:api_key].should == 'api-key'
+  it "allows setting the api token" do
+    message.delivery_method Mail::Postmark, :api_token => 'api-token'
+    message.delivery_method.settings[:api_token].should == 'api-token'
+  end
+
+  it 'uses provided API token' do
+    message.delivery_method Mail::Postmark, :api_token => 'api-token'
+    Postmark::ApiClient.should_receive(:new).with('api-token', {}).and_return(double(:deliver_message => true))
+    message.deliver
+  end
+
+  it 'uses API token provided as legacy api_key' do
+    message.delivery_method Mail::Postmark, :api_key => 'api-token'
+    Postmark::ApiClient.should_receive(:new).with('api-token', {}).and_return(double(:deliver_message => true))
+    message.deliver
   end
 end

data/spec/unit/postmark/http_client_spec.rb

@@ -6,17 +6,19 @@ describe Postmark::HttpClient do
     body = {"ErrorCode" => status, "Message" => message}.to_json
   end
 
-  let(:api_key) { "provided-postmark-api-key" }
-  let(:http_client) { Postmark::HttpClient.new(api_key) }
+  let(:api_token) { "provided-postmark-api-token" }
+  let(:http_client) { Postmark::HttpClient.new(api_token) }
   subject { http_client }
 
   context "attr writers" do
+    it { should respond_to(:api_token=) }
     it { should respond_to(:api_key=) }
   end
 
   context "attr readers" do
     it { should respond_to(:http) }
     it { should respond_to(:secure) }
+    it { should respond_to(:api_token) }
     it { should respond_to(:api_key) }
     it { should respond_to(:proxy_host) }
     it { should respond_to(:proxy_port) }
@@ -30,7 +32,8 @@ describe Postmark::HttpClient do
   end
 
   context "when it is created without options" do
-    its(:api_key) { should eq api_key }
+    its(:api_token) { should eq api_token }
+    its(:api_key) { should eq api_token }
     its(:host) { should eq 'api.postmarkapp.com' }
     its(:port) { should eq 443 }
     its(:secure) { should be_true }
@@ -51,7 +54,7 @@ describe Postmark::HttpClient do
     let(:http_open_timeout) { 42 }
     let(:http_read_timeout) { 42 }
 
-    subject { Postmark::HttpClient.new(api_key, 
+    subject { Postmark::HttpClient.new(api_token,
                                        :secure => secure,
                                        :proxy_host => proxy_host,
                                        :proxy_port => proxy_port,
@@ -63,7 +66,8 @@ describe Postmark::HttpClient do
                                        :http_open_timeout => http_open_timeout,
                                        :http_read_timeout => http_read_timeout) }
 
-    its(:api_key) { should eq api_key }
+    its(:api_token) { should eq api_token }
+    its(:api_key) { should eq api_token }
     its(:secure) { should == secure }
     its(:proxy_host) { should == proxy_host }
     its(:proxy_port) { should == proxy_port }
@@ -86,7 +90,7 @@ describe Postmark::HttpClient do
       FakeWeb.should have_requested(:post, target_url)
     end
 
-    it "raises a custom error when API key authorization fails" do
+    it "raises a custom error when API token authorization fails" do
       FakeWeb.register_uri(:post, target_url, :body => response_body(401),
                                               :status => [ "401", "Unauthorized" ])
       expect { subject.post(target_path) }.to raise_error Postmark::InvalidApiKeyError
@@ -128,7 +132,7 @@ describe Postmark::HttpClient do
       FakeWeb.should have_requested(:get, target_url)
     end
 
-    it "raises a custom error when API key authorization fails" do
+    it "raises a custom error when API token authorization fails" do
       FakeWeb.register_uri(:get, target_url, :body => response_body(401),
                                               :status => [ "401", "Unauthorized" ])
       expect { subject.get(target_path) }.to raise_error Postmark::InvalidApiKeyError
@@ -169,7 +173,7 @@ describe Postmark::HttpClient do
       FakeWeb.should have_requested(:put, target_url)
     end
 
-    it "raises a custom error when API key authorization fails" do
+    it "raises a custom error when API token authorization fails" do
       FakeWeb.register_uri(:put, target_url, :body => response_body(401),
                                              :status => [ "401", "Unauthorized" ])
       expect { subject.put(target_path) }.to raise_error Postmark::InvalidApiKeyError

data/spec/unit/postmark_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Postmark do
-  let(:api_key) { double }
+  let(:api_token) { double }
   let(:secure) { double }
   let(:proxy_host) { double }
   let(:proxy_port) { double }
@@ -13,7 +13,7 @@ describe Postmark do
   let(:max_retries) { double }
 
   before do
-    subject.api_key = api_key
+    subject.api_token = api_token
     subject.secure = secure
     subject.proxy_host = proxy_host
     subject.proxy_port = proxy_port
@@ -28,6 +28,7 @@ describe Postmark do
   context "attr readers" do
     it { should respond_to(:secure) }
     it { should respond_to(:api_key) }
+    it { should respond_to(:api_token) }
     it { should respond_to(:proxy_host) }
     it { should respond_to(:proxy_port) }
     it { should respond_to(:proxy_user) }
@@ -43,6 +44,7 @@ describe Postmark do
   context "attr writers" do
     it { should respond_to(:secure=) }
     it { should respond_to(:api_key=) }
+    it { should respond_to(:api_token=) }
     it { should respond_to(:proxy_host=) }
     it { should respond_to(:proxy_port=) }
     it { should respond_to(:proxy_user=) }
@@ -98,7 +100,7 @@ describe Postmark do
 
       it 'creates a new instance of Postmark::ApiClient' do
         Postmark::ApiClient.should_receive(:new).
-                            with(api_key,
+                            with(api_token,
                                  :secure => secure,
                                  :proxy_host => proxy_host,
                                  :proxy_port => proxy_port,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Petyo Ivanov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-20 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake