postmark 0.6.0 → 0.7.0

data/README.rdoc

@@ -22,6 +22,7 @@ Then
 
     message = TMail::Mail.new
     # make sure you have a sender signature with that email
+    # from and to also accept arrays of emails.
     message.from = "leonard@bigbangtheory.com"
     message.to = "Sheldon Cooper <sheldon@bigbangtheory.com>"
     message.subject = "Hi Sheldon!"
@@ -29,11 +30,29 @@ Then
     message.body = "Hello my friend!"
     # set custom headers at will.
     message["CUSTOM-HEADER"] = "my custom header value"
+    # tag message
+    message.tag = "my-tracking-tag"
     # set reply to if you need; also, you can pass array of emails.
     message.reply_to = "penny@bigbangtheory.com"
 
     p Postmark.send_through_postmark(message).body
 
+You can retrieve various information about your server state using the "Public bounces API":http://developer.postmarkapp.com/bounces
+
+    # get delivery stats
+    Postmark.delivery_stats # json
+    Postmark::Bounce.all # [ bounce, bounce ... ]
+    bounce = Postmark::Bounce.find(bounce_id) # Bounce
+    bounce.dump # string, containing raw SMTP data
+    bounce.reactivate # reactivate hard bounce
+
+== Encryption
+
+To use SSL encryption when sending email configure the library as follows:
+
+    Postmark.secure = true
+
+
 == Requirements
 
 The gem relies on TMail for building the message. You will also need postmark account, server and sender signature set up to use it.
@@ -46,7 +65,7 @@ You can also explicitly specify which one to be used, using
 
 == Limitations
 
-Currently postmark API does not support multiple recipients, or attachments. For more information, check the docs at:
+Currently postmark API does not support attachments. For more information, check the docs at:
 
 http://developer.postmarkapp.com
 

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/postmark.rb

@@ -3,6 +3,9 @@ require 'net/https'
 require 'rubygems'
 require 'tmail'
 require 'postmark/tmail_mail_extension'
+require 'postmark/bounce'
+require 'postmark/json'
+require 'postmark/http_client'
 
 module Postmark
 
@@ -25,7 +28,7 @@ module Postmark
   MAX_RETRIES = 2
 
   class << self
-    attr_accessor :host, :host_path, :port, :secure, :api_key, :http_open_timeout, :http_read_timeout,
+    attr_accessor :host, :path_prefix, :port, :secure, :api_key, :http_open_timeout, :http_read_timeout,
       :proxy_host, :proxy_port, :proxy_user, :proxy_pass, :max_retries, :sleep_between_retries
 
     attr_writer :response_parser_class
@@ -45,8 +48,8 @@ module Postmark
     end
 
     # The path of the listener
-    def host_path
-      @host_path ||= 'email'
+    def path_prefix
+      @path_prefix ||= '/'
     end
 
     def http_open_timeout
@@ -69,18 +72,10 @@ module Postmark
       yield self
     end
 
-    def protocol #:nodoc:
-      secure ? "https" : "http"
-    end
-
-    def url #:nodoc:
-      URI.parse("#{protocol}://#{host}:#{port}/#{host_path}/")
-    end
-
     def send_through_postmark(message) #:nodoc:
       @retries = 0
       begin
-        attempt_sending(message)
+        HttpClient.post("email", Postmark::Json.encode(convert_tmail(message)))
       rescue Exception => e
         if @retries < max_retries
            @retries += 1
@@ -91,46 +86,11 @@ module Postmark
       end
     end
 
-    def attempt_sending(message)
-      ResponseParsers.const_get(response_parser_class) # loads JSON lib, defining #to_json
-      http = Net::HTTP::Proxy(proxy_host,
-                              proxy_port,
-                              proxy_user,
-                              proxy_pass).new(url.host, url.port)
-
-      http.read_timeout = http_read_timeout
-      http.open_timeout = http_open_timeout
-      http.use_ssl = !!secure
-
-      headers = HEADERS.merge({ "X-Postmark-Server-Token" => api_key.to_s })
-
-      response = http.post(url.path, convert_tmail(message).to_json, headers)
-
-      case response.code.to_i
-      when 200
-        return response
-      when 401
-        raise InvalidApiKeyError, error_message(response.body)
-      when 422
-        raise InvalidMessageError, error_message(response.body)
-      when 500
-        raise InternalServerError, response.body
-      else
-        raise UnknownError, response
-      end
+    def delivery_stats
+      HttpClient.get("deliverystats")
     end
 
-    def error_message(response_body)
-      decode_json(response_body)["Message"]
-    end
-
-    def decode_json(data)
-      ResponseParsers.const_get(response_parser_class).decode(data)
-    end
-
-    def encode_json(data)
-      ResponseParsers.const_get(response_parser_class).encode(data)
-    end
+    protected
 
     def convert_tmail(message)
       options = { "From" => message['from'].to_s, "To" => message['to'].to_s, "Subject" => message.subject }

data/lib/postmark/bounce.rb

@@ -0,0 +1,56 @@
+module Postmark
+  class Bounce
+
+    attr_reader :email, :bounced_at, :type, :details, :name, :id, :server_id, :tag
+
+    def initialize(values = {})
+      @id = values["ID"]
+      @email = values["Email"]
+      @bounced_at = Time.parse(values["BouncedAt"])
+      @type = values["Type"]
+      @name = values["Name"]
+      @details = values["Details"]
+      @tag = values["Tag"]
+      @dump_available = values["DumpAvailable"]
+      @inactive = values["Inactive"]
+      @can_activate = values["CanActivate"]
+    end
+
+    def inactive?
+      !!@inactive
+    end
+
+    def can_activate?
+      !!@can_activate
+    end
+
+    def dump
+      Postmark::HttpClient.get("bounces/#{id}/dump")["Body"]
+    end
+
+    def activate
+      Bounce.new(Postmark::HttpClient.put("bounces/#{id}/activate")["Bounce"])
+    end
+
+    def dump_available?
+      !!@dump_available
+    end
+
+    class << self
+      def find(id)
+        Bounce.new(Postmark::HttpClient.get("bounces/#{id}"))
+      end
+
+      def all(options = {})
+        options[:count] ||= 30
+        options[:offset] ||= 0
+        Postmark::HttpClient.get("bounces", options).map { |bounce_json| Bounce.new(bounce_json) }
+      end
+
+      def tags
+        Postmark::HttpClient.get("bounces/tags")
+      end
+    end
+
+  end
+end

data/lib/postmark/http_client.rb

@@ -0,0 +1,77 @@
+require 'cgi'
+
+module Postmark
+  module HttpClient
+    class << self
+      def post(path, data = '')
+        handle_response(http.post(url_path(path), data, headers))
+      end
+
+      def put(path, data = '')
+        handle_response(http.put(url_path(path), data, headers))
+      end
+
+      def get(path, query = {})
+        handle_response(http.get(url_path(path + to_query_string(query)), headers))
+      end
+
+      protected
+
+      def to_query_string(hash)
+        return "" if hash.empty?
+        "?" + hash.map { |key, value| "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+
+      def protocol
+        Postmark.secure ? "https" : "http"
+      end
+
+      def url
+        URI.parse("#{protocol}://#{Postmark.host}:#{Postmark.port}/")
+      end
+
+      def handle_response(response)
+        case response.code.to_i
+        when 200
+          return Postmark::Json.decode(response.body)
+        when 401
+          raise InvalidApiKeyError, error_message(response.body)
+        when 422
+          raise InvalidMessageError, error_message(response.body)
+        when 500
+          raise InternalServerError, response.body
+        else
+          raise UnknownError, response
+        end
+      end
+
+      def headers
+        @headers ||= HEADERS.merge({ "X-Postmark-Server-Token" => Postmark.api_key.to_s })
+      end
+
+      def url_path(path)
+        Postmark.path_prefix + path
+      end
+
+      def http
+        @http ||= build_http
+      end
+
+      def build_http
+        http = Net::HTTP::Proxy(Postmark.proxy_host,
+                                Postmark.proxy_port,
+                                Postmark.proxy_user,
+                                Postmark.proxy_pass).new(url.host, url.port)
+
+        http.read_timeout = Postmark.http_read_timeout
+        http.open_timeout = Postmark.http_open_timeout
+        http.use_ssl = !!Postmark.secure
+        http
+      end
+
+      def error_message(response_body)
+        Postmark::Json.decode(response_body)["Message"]
+      end
+    end
+  end
+end

data/lib/postmark/json.rb

@@ -0,0 +1,22 @@
+module Postmark
+  module Json
+
+    class << self
+      def encode(data)
+        json_parser
+        data.to_json
+      end
+
+      def decode(data)
+        json_parser.decode(data)
+      end
+
+      private
+
+      def json_parser
+        ResponseParsers.const_get(Postmark.response_parser_class)
+      end
+
+    end
+  end
+end

data/postmark.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{postmark}
-  s.version = "0.6.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Petyo Ivanov"]
-  s.date = %q{2010-03-18}
+  s.date = %q{2010-04-12}
   s.description = %q{Ruby gem for sending emails through http://postmarkapp.com HTTP API. It relieas on TMail::Mail for message construction.}
   s.email = %q{underlog@gmail.com}
   s.extra_rdoc_files = [
@@ -28,11 +28,15 @@ Gem::Specification.new do |s|
      "features/step_definitions/postmark_steps.rb",
      "features/support/env.rb",
      "lib/postmark.rb",
+     "lib/postmark/bounce.rb",
+     "lib/postmark/http_client.rb",
+     "lib/postmark/json.rb",
      "lib/postmark/response_parsers/active_support.rb",
      "lib/postmark/response_parsers/json.rb",
      "lib/postmark/response_parsers/yajl.rb",
      "lib/postmark/tmail_mail_extension.rb",
      "postmark.gemspec",
+     "spec/bounce_spec.rb",
      "spec/postmark_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -49,7 +53,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Ruby gem for sending emails through http://postmarkapp.com HTTP API}
   s.test_files = [
-    "spec/postmark_spec.rb",
+    "spec/bounce_spec.rb",
+     "spec/postmark_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/spec/bounce_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe "Bounce" do
+  let(:bounce_json) { %{{"Type":"HardBounce","TypeCode":1,"Details":"test bounce","Email":"jim@test.com","BouncedAt":"#{Time.now.to_s}","DumpAvailable":true,"Inactive":false,"CanActivate":true,"ID":12}} }
+  let(:bounces_json) { "[#{bounce_json},#{bounce_json}]" }
+
+  context "single bounce" do
+    let(:bounce) { Postmark::Bounce.find(12) }
+
+    before do
+      Timecop.freeze
+      FakeWeb.register_uri(:get, "http://api.postmarkapp.com/bounces/12", { :body => bounce_json })
+    end
+
+    after do
+      Timecop.return
+    end
+
+    it "should retrieve and parce bounce correctly" do
+      bounce.type.should == "HardBounce"
+      bounce.bounced_at.should == Time.now
+      bounce.details.should == "test bounce"
+      bounce.email.should == "jim@test.com"
+    end
+
+    it "should retrieve bounce dump" do
+      FakeWeb.register_uri(:get, "http://api.postmarkapp.com/bounces/12/dump", { :body => %{{"Body": "Some SMTP gibberish"}} } )
+      bounce.dump.should == "Some SMTP gibberish"
+    end
+
+    it "should activate inactive bounce" do
+      FakeWeb.register_uri(:put, "http://api.postmarkapp.com/bounces/12/activate", { :body => %{{"Message":"OK","Bounce":#{bounce_json}}} } )
+      bounce.activate.should be_a(Postmark::Bounce)
+    end
+
+  end
+
+  it "should retrieve bounces" do
+    FakeWeb.register_uri(:get, "http://api.postmarkapp.com/bounces?count=30&offset=0", { :body => bounces_json })
+    bounces = Postmark::Bounce.all
+    bounces.should have(2).entries
+    bounces[0].should be_a(Postmark::Bounce)
+  end
+
+  it "should retrieve bounce tags" do
+    FakeWeb.register_uri(:get, "http://api.postmarkapp.com/bounces/tags", { :body => '["Signup","Commit Notification"]' })
+    tags = Postmark::Bounce.tags
+    tags.should have(2).entries
+    tags.first.should == "Signup"
+  end
+end

data/spec/postmark_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe "Postmark" do
 
@@ -23,38 +23,38 @@ describe "Postmark" do
 
   context "service call" do
 
-    before do
+    before(:all) do
       Postmark.sleep_between_retries = 0
     end
 
     it "should send email successfully" do
-      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email/", {})
+      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email", {})
       Postmark.send_through_postmark(message)
-      FakeWeb.should have_requested(:post, "http://api.postmarkapp.com/email/")
+      FakeWeb.should have_requested(:post, "http://api.postmarkapp.com/email")
     end
 
     it "should warn when header is invalid" do
-      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email/", {:status => [ "401", "Unauthorized" ], :body => "Missing API token"})
+      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email", {:status => [ "401", "Unauthorized" ], :body => "Missing API token"})
       lambda { Postmark.send_through_postmark(message) }.should raise_error(Postmark::InvalidApiKeyError)
     end
 
     it "should warn when json is not ok" do
-      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email/", {:status => [ "422", "Invalid" ], :body => "Invalid JSON"})
+      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email", {:status => [ "422", "Invalid" ], :body => "Invalid JSON"})
       lambda { Postmark.send_through_postmark(message) }.should raise_error(Postmark::InvalidMessageError)
     end
 
     it "should warn when server fails" do
-      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email/", {:status => [ "500", "Internal Server Error" ]})
+      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email", {:status => [ "500", "Internal Server Error" ]})
       lambda { Postmark.send_through_postmark(message) }.should raise_error(Postmark::InternalServerError)
     end
 
     it "should warn when unknown stuff fails" do
-      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email/", {:status => [ "485", "Custom HTTP response status" ]})
+      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email", {:status => [ "485", "Custom HTTP response status" ]})
       lambda { Postmark.send_through_postmark(message) }.should raise_error(Postmark::UnknownError)
     end
 
     it "should retry 3 times" do
-      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email/",
+      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email",
                            [ { :status => [ 500, "Internal Server Error" ] },
                            { :status => [ 500, "Internal Server Error" ] },
                            {  } ]
@@ -63,19 +63,32 @@ describe "Postmark" do
     end
   end
 
+  context "delivery stats" do
+    let(:response_body) { %{{"InactiveMails":1,"Bounces":[{"TypeCode":0,"Name":"All","Count":2},{"Type":"HardBounce","TypeCode":1,"Name":"Hard bounce","Count":1},{"Type":"SoftBounce","TypeCode":4096,"Name":"Soft bounce","Count":1}]}} }
+
+    it "should query the service for delivery stats" do
+      FakeWeb.register_uri(:get, "http://api.postmarkapp.com/deliverystats", { :body => response_body })
+      results = Postmark.delivery_stats
+      results["InactiveMails"].should == 1
+      results["Bounces"].should be_an(Array)
+      results["Bounces"].should have(3).entries
+      FakeWeb.should have_requested(:get, "http://api.postmarkapp.com/deliverystats")
+    end
+  end
+
   context "tmail parse" do
     it "should set text body for plain message" do
-      Postmark.convert_tmail(message)['TextBody'].should_not be_nil
+      Postmark.send(:convert_tmail, message)['TextBody'].should_not be_nil
     end
 
     it "should set html body for html message" do
-      Postmark.convert_tmail(html_message)['HtmlBody'].should_not be_nil
+      Postmark.send(:convert_tmail, html_message)['HtmlBody'].should_not be_nil
     end
   end
 
   def be_serialized_to(json)
     simple_matcher "be serialized to #{json}" do |message|
-      Postmark.convert_tmail(message).should == JSON.parse(json)
+      Postmark.send(:convert_tmail, message).should == JSON.parse(json)
     end
   end
 
@@ -111,7 +124,7 @@ describe "Postmark" do
 
         it "decodes json with #{lib}" do
           Postmark.response_parser_class = lib
-          Postmark.decode_json(%({"Message":"OK"})).should == { "Message" => "OK" }
+          Postmark::Json.decode(%({"Message":"OK"})).should == { "Message" => "OK" }
         end
 
         Postmark.response_parser_class = original_parser_class

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'json'
 require 'ruby-debug'
 require 'fakeweb'
 require 'fakeweb_matcher'
+require 'timecop'
 require 'spec'
 require 'spec/autorun'
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Petyo Ivanov
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-18 00:00:00 +02:00
+date: 2010-04-12 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,11 +74,15 @@ files:
 - features/step_definitions/postmark_steps.rb
 - features/support/env.rb
 - lib/postmark.rb
+- lib/postmark/bounce.rb
+- lib/postmark/http_client.rb
+- lib/postmark/json.rb
 - lib/postmark/response_parsers/active_support.rb
 - lib/postmark/response_parsers/json.rb
 - lib/postmark/response_parsers/yajl.rb
 - lib/postmark/tmail_mail_extension.rb
 - postmark.gemspec
+- spec/bounce_spec.rb
 - spec/postmark_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -113,5 +117,6 @@ signing_key:
 specification_version: 3
 summary: Ruby gem for sending emails through http://postmarkapp.com HTTP API
 test_files: 
+- spec/bounce_spec.rb
 - spec/postmark_spec.rb
 - spec/spec_helper.rb