postmark 0.9.19 → 1.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 0.9.19
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2013-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,22 +45,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: tmail
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -77,22 +61,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-core
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -109,54 +77,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: fakeweb
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: fakeweb-matcher
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +106,7 @@ files:
 - .gitignore
 - .rake_tasks
 - .rspec
+- .travis.yml
 - CHANGELOG.rdoc
 - Gemfile
 - LICENSE
@@ -194,27 +115,44 @@ files:
 - VERSION
 - init.rb
 - lib/postmark.rb
-- lib/postmark/attachments_fix_for_mail.rb
+- lib/postmark/api_client.rb
 - lib/postmark/bounce.rb
 - lib/postmark/handlers/mail.rb
+- lib/postmark/helpers/hash_helper.rb
+- lib/postmark/helpers/message_helper.rb
 - lib/postmark/http_client.rb
+- lib/postmark/inbound.rb
+- lib/postmark/inflector.rb
 - lib/postmark/json.rb
 - lib/postmark/message_extensions/mail.rb
 - lib/postmark/message_extensions/shared.rb
-- lib/postmark/message_extensions/tmail.rb
 - lib/postmark/response_parsers/active_support.rb
 - lib/postmark/response_parsers/json.rb
 - lib/postmark/response_parsers/yajl.rb
 - lib/postmark/version.rb
 - postmark.gemspec
-- spec/bounce_spec.rb
-- spec/postmark_spec.rb
-- spec/shared_examples.rb
+- spec/data/empty.gif
+- spec/integration/api_client_hashes_spec.rb
+- spec/integration/api_client_messages_spec.rb
+- spec/integration/mail_delivery_method_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/shared_examples.rb
+- spec/unit/postmark/api_client_spec.rb
+- spec/unit/postmark/bounce_spec.rb
+- spec/unit/postmark/handlers/mail_spec.rb
+- spec/unit/postmark/helpers/hash_helper_spec.rb
+- spec/unit/postmark/helpers/message_helper_spec.rb
+- spec/unit/postmark/http_client_spec.rb
+- spec/unit/postmark/inbound_spec.rb
+- spec/unit/postmark/inflector_spec.rb
+- spec/unit/postmark/json_spec.rb
+- spec/unit/postmark/message_extensions/mail_spec.rb
+- spec/unit/postmark_spec.rb
 homepage: http://postmarkapp.com
 licenses: []
 post_install_message: ! "\n    ==================\n    Thanks for installing the postmark
-  gem. If you don't have an account, please sign up at http://postmarkapp.com/.\n
+  gem. If you don't have an account, please\n    sign up at http://postmarkapp.com/.\n\n
   \   Review the README.md for implementation details and examples.\n    ==================\n
   \ "
 rdoc_options:
@@ -229,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1526820895297093205
+      hash: -1032735191678886837
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -238,12 +176,26 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.7
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Official Postmark API wrapper.
 test_files:
-- spec/bounce_spec.rb
-- spec/postmark_spec.rb
-- spec/shared_examples.rb
+- spec/data/empty.gif
+- spec/integration/api_client_hashes_spec.rb
+- spec/integration/api_client_messages_spec.rb
+- spec/integration/mail_delivery_method_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/shared_examples.rb
+- spec/unit/postmark/api_client_spec.rb
+- spec/unit/postmark/bounce_spec.rb
+- spec/unit/postmark/handlers/mail_spec.rb
+- spec/unit/postmark/helpers/hash_helper_spec.rb
+- spec/unit/postmark/helpers/message_helper_spec.rb
+- spec/unit/postmark/http_client_spec.rb
+- spec/unit/postmark/inbound_spec.rb
+- spec/unit/postmark/inflector_spec.rb
+- spec/unit/postmark/json_spec.rb
+- spec/unit/postmark/message_extensions/mail_spec.rb
+- spec/unit/postmark_spec.rb

data/lib/postmark/attachments_fix_for_mail.rb

@@ -1,48 +0,0 @@
-module Postmark
-  
-  #
-  # This fix is needed solely to support neat Rails 3 syntax to create emails.
-  # That one:
-  #
-  #   def invitation
-  #     mail(
-  #       :to => "someone@example.com",
-  #       :postmark_attachments => [File.open(...)]
-  #     )
-  #   end
-  #
-  # That code will automatically put the file to Mail::OptionalField of the Mail::Message object
-  # and will try to encode it before delivery. You are not supposed to store files in
-  # such fields, so Mail will raise an exception. That's why before we actually perform a
-  # delivery we have to remove the files from OptionalField to a regular @_attachments variable.
-  #  
-  module AttachmentsFixForMail
-    
-    def self.included(base)
-      base.class_eval do
-        alias_method :deliver_without_postmark_hook, :deliver
-        alias_method :deliver_without_postmark_hook!, :deliver!
-
-        def deliver!
-          remove_postmark_attachments_from_standard_fields
-          deliver_without_postmark_hook!
-        end
-        
-        def deliver
-          remove_postmark_attachments_from_standard_fields
-          deliver_without_postmark_hook
-        end
-      end
-    end
-
-  private
-
-    def remove_postmark_attachments_from_standard_fields
-      field = self['POSTMARK-ATTACHMENTS']
-      return if field.nil?
-      self.postmark_attachments = field.value
-      header.fields.delete_if{|f| f.name == 'postmark-attachments'}
-    end
-  end
-  
-end

data/lib/postmark/message_extensions/tmail.rb

@@ -1,115 +0,0 @@
-##
-# author: http://fernandoguillen.info
-# date: 2008-08-27
-#
-# When you have a TMail::Mail with plain text and html body parts
-# there is not any easy way to extract just the html body part
-#
-# This is a patch to try to resolve this
-#
-# just require 'extensions/tmail'
-# and every TMail::Mail object will have the .body_html method
-#
-
-module TMail
-  class Mail
-    
-    include Postmark::SharedMessageExtensions
-
-    #
-    # returs an String with just the html part of the body
-    # or nil if there is not any html part
-    #
-    def body_html
-      result = nil
-      if multipart?
-        parts.each do |part|
-          if part.multipart?
-            part.parts.each do |part2|
-              result = part2.unquoted_body if part2.content_type =~ /html/i
-            end
-          elsif !attachment?(part)
-            result = part.unquoted_body if part.content_type =~ /html/i
-          end
-        end
-      else
-        result = unquoted_body if content_type =~ /html/i
-      end
-      result
-    end
-
-    #
-    # returs an String with just the plain text part of the body
-    # or nil if there is not any plain text part
-    #
-    def body_text
-      result = unquoted_body
-      if multipart?
-        parts.each do |part|
-          if part.multipart?
-            part.parts.each do |part2|
-              result = part2.unquoted_body if part2.content_type =~ /plain/i
-            end
-          elsif !attachment?(part)
-            result = part.unquoted_body if part.content_type =~ /plain/i
-          end
-        end
-      else
-        result = unquoted_body if content_type =~ /plain/i
-      end
-      result
-    end
-
-    #
-    # This is only for develop.
-    # print on output all the parts of the Mail with some details
-    #
-    def parts_observer
-      puts "INI"
-      puts "content_type: #{content_type}"
-      puts "body: #{body}"
-      puts "parts.size: #{parts.size}"
-
-      if multipart?
-        parts.each_with_index do |part, index|
-          puts ""
-          puts "  parts[#{index}]"
-          puts "    content_type: #{part.content_type}"
-          puts "    multipart? #{part.multipart?}"
-
-          header = part["content-type"]
-
-          if part.multipart?
-            puts "    --multipart--"
-            part.parts.each_with_index do |part2, index2|
-              puts "    part[#{index}][#{index2}]"
-              puts "      content_type: #{part2.content_type}"
-              puts "      body: #{part2.unquoted_body}"
-            end
-          elsif header.nil?
-            puts "    --header nil--"
-          elsif !attachment?(part)
-            puts "    --no multipart, no header nil, no attachment--"
-            puts "      content_type: #{part.content_type}"
-            puts "      body: #{part.unquoted_body}"
-          else
-            puts "    --no multipart, no header nil, attachment--"
-            puts "     content_type: #{part.content_type}"
-          end
-
-        end
-      else
-        puts "  --no multipart--"
-        puts "    content_type: #{content_type}"
-        puts "    body: #{unquoted_body}"
-      end
-
-      puts "END"
-    end
-
-    def export_attachments
-      postmark_attachments
-    end
-
-  end
-end

data/spec/bounce_spec.rb

@@ -1,53 +0,0 @@
-require 'spec_helper'
-
-describe "Bounce" do
-  let(:bounce_json) { %{{"Type":"HardBounce","MessageID":"d12c2f1c-60f3-4258-b163-d17052546ae4","TypeCode":1,"Details":"test bounce","Email":"jim@test.com","BouncedAt":"#{Time.now.to_s}","DumpAvailable":true,"Inactive":false,"CanActivate":true,"ID":12,"Subject":"Hello from our app!"}} }
-  let(:bounces_json) { %{{"Bounces": [#{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.to_s.should == Time.now.to_s
-      bounce.details.should == "test bounce"
-      bounce.email.should == "jim@test.com"
-      bounce.message_id.should == "d12c2f1c-60f3-4258-b163-d17052546ae4"
-      bounce.subject.should == "Hello from our app!"
-    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,253 +0,0 @@
-require 'spec_helper'
-
-describe Postmark do
-
-  let :tmail_message do
-    TMail::Mail.new.tap do |mail|
-      mail.from = "sheldon@bigbangtheory.com"
-      mail.to = "lenard@bigbangtheory.com"
-      mail.subject = "Hello!"
-      mail.body = "Hello Sheldon!"
-    end
-  end
-
-  let :tmail_html_message do
-    TMail::Mail.new.tap do |mail|
-      mail.from = "sheldon@bigbangtheory.com"
-      mail.to = "lenard@bigbangtheory.com"
-      mail.subject = "Hello!"
-      mail.body = "<b>Hello Sheldon!</b>"
-      mail.content_type = "text/html"
-    end
-  end
-
-  let :mail_message do
-    Mail.new do
-      from    "sheldon@bigbangtheory.com"
-      to      "lenard@bigbangtheory.com"
-      subject "Hello!"
-      body    "Hello Sheldon!"
-    end
-  end
-
-  let :mail_html_message do
-    mail = Mail.new do
-      from          "sheldon@bigbangtheory.com"
-      to            "lenard@bigbangtheory.com"
-      subject       "Hello!"
-      html_part do
-        body        "<b>Hello Sheldon!</b>"
-      end
-    end
-  end
-
-  let :mail_multipart_message do
-    mail = Mail.new do
-      from          "sheldon@bigbangtheory.com"
-      to            "lenard@bigbangtheory.com"
-      subject       "Hello!"
-      text_part do
-        body        "Hello Sheldon!"
-      end
-      html_part do
-        body        "<b>Hello Sheldon!</b>"
-      end
-    end
-  end
-
-  context "service call" do
-
-    before(:all) do
-      Postmark.sleep_between_retries = 0
-    end
-
-    def stub_web!(data={})
-      data[:body] ||= response_body(data[:status].nil? ? 200 : data[:status].first)
-      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email", data)
-    end
-
-    def response_body(status, message="")
-      body = {"ErrorCode" => status, "Message" => message}.to_json
-    end
-
-    it "should send email successfully" do
-      stub_web!
-      Postmark.send_through_postmark(mail_message)
-      FakeWeb.should have_requested(:post, "http://api.postmarkapp.com/email")
-    end
-
-    it "should warn when header is invalid" do
-      stub_web!({:status => [ "401", "Unauthorized" ]})
-      lambda { Postmark.send_through_postmark(mail_message) }.should raise_error(Postmark::InvalidApiKeyError)
-    end
-
-    it "should warn when json is not ok" do
-      stub_web!({:status => [ "422", "Invalid" ]})
-      lambda { Postmark.send_through_postmark(mail_message) }.should raise_error(Postmark::InvalidMessageError)
-    end
-
-    it "should warn when server fails" do
-      stub_web!({:status => [ "500", "Internal Server Error" ]})
-      lambda { Postmark.send_through_postmark(mail_message) }.should raise_error(Postmark::InternalServerError)
-    end
-
-    it "should warn when unknown stuff fails" do
-      stub_web!({:status => [ "485", "Custom HTTP response status" ]})
-      lambda { Postmark.send_through_postmark(mail_message) }.should raise_error(Postmark::UnknownError)
-    end
-
-    it "should warn when the request times out" do
-      Postmark::HttpClient.should_receive(:post).at_least(:once).and_raise(Timeout::Error)
-      lambda { Postmark.send_through_postmark(mail_message) }.should raise_error(Postmark::TimeoutError)
-    end
-
-    it "should retry 3 times" do
-      FakeWeb.register_uri(:post, "http://api.postmarkapp.com/email",
-                          [
-                            { :status => [ 500, "Internal Server Error" ], :body => response_body(500, 'Internal Server Error') },
-                            { :status => [ 500, "Internal Server Error" ], :body => response_body(500, 'Internal Server Error')  },
-                            { :body => response_body(500, 'Internal Server Error')  }
-                          ])
-      lambda { Postmark.send_through_postmark(mail_message) }.should_not raise_error
-    end
-
-    it "should retry on timeout" do
-      Postmark::HttpClient.should_receive(:post).and_raise(Timeout::Error)
-      Postmark::HttpClient.should_receive(:post).and_return('{}')
-      lambda { Postmark.send_through_postmark(mail_message) }.should_not raise_error
-    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", :ruby => 1.8 do
-    require 'tmail'
-    subject { tmail_message }
-    it_behaves_like :mail
-  end
-
-  context "when mail parse" do
-    subject { mail_message }
-    it_behaves_like :mail
-
-    it "should set html body for html message" do
-      Postmark.send(:convert_message_to_options_hash, mail_html_message)['HtmlBody'].should_not be_nil
-    end
-
-    it "should encode custom headers properly" do
-      subject.header["CUSTOM-HEADER"] = "header"
-      subject.should be_serialized_to %q[{"Subject":"Hello!", "From":"sheldon@bigbangtheory.com", "To":"lenard@bigbangtheory.com", "TextBody":"Hello Sheldon!", "Headers":[{"Name":"Custom-Header", "Value":"header"}]}]
-    end
-  end
-
-  context "mail delivery method" do
-    it "should be able to set delivery_method" do
-      mail_message.delivery_method Mail::Postmark
-    end
-
-    it "should wrap Postmark.send_through_postmark" do
-      message = mail_message
-      Postmark.should_receive(:send_through_postmark).with(message)
-      mail_message.delivery_method Mail::Postmark
-      mail_message.deliver
-    end
-
-    it "should allow setting of api_key" do
-      mail_message.delivery_method Mail::Postmark, {:api_key => 'api-key'}
-      mail_message.delivery_method.settings[:api_key].should == 'api-key'
-    end
-  end
-
-  context "attachments hook", :ruby => 1.9 do
-    before(:all) { Mail::Message.send(:include, Postmark::AttachmentsFixForMail) }
-
-    before do
-      mail_message.delivery_method Mail::Postmark
-      mail_message.should_receive(:remove_postmark_attachments_from_standard_fields)
-      Postmark.should_receive(:send_through_postmark).with(mail_message)
-    end
-
-    it "should run postmark attachments hook when using deliver! method" do
-      mail_message.deliver!
-    end
-
-    it "should run postmark attachments hook when using deliver method" do
-      mail_message.deliver
-    end
-  end
-
-  context "attachments setter" do
-    let(:attached_file) { mock("file") }
-    let(:attached_hash) { {'Name' => 'picture.jpeg',
-                           'ContentType' => 'image/jpeg'} }
-    let(:exported_file) { {'Name' => 'file.jpeg',
-                           'ContentType' => 'application/octet-stream',
-                           'Content' => ''} }
-
-    before do
-      attached_file.stub(:is_a?) { |arg| arg == File ? true : false }
-      attached_file.stub(:path) { '/tmp/file.jpeg' }
-    end
-
-    it "should store attachments as array" do
-      mail_message.postmark_attachments = attached_hash
-      mail_message.postmark_attachments.should be_kind_of(Array)
-    end
-
-    it "should save the attachments in attachments array" do
-      IO.should_receive(:read).with("/tmp/file.jpeg").and_return("")
-
-      mail_message.postmark_attachments = [attached_hash, attached_file]
-      attachments = mail_message.export_attachments
-
-      attachments.should include(attached_hash)
-      attachments.should include(exported_file)
-    end
-  end
-
-  context "native attachments" do
-    let(:file_data) { 'binarydatahere' }
-    let(:exported_data) do
-      {'Name' => 'face.jpeg',
-       'Content' => "YmluYXJ5ZGF0YWhlcmU=\n",
-       'ContentType' => 'image/jpeg'}
-    end
-
-    before do
-      mail_message.attachments["face.jpeg"] = file_data
-    end
-
-    it "exports native attachments" do
-      attachments = mail_message.export_attachments
-      attachments.should include(exported_data)
-    end
-  end
-
-  context "JSON library support" do
-    [:Json, :ActiveSupport, :Yajl].each do |lib|
-      begin
-        original_parser_class = Postmark.response_parser_class
-
-        it "decodes json with #{lib}" do
-          Postmark.response_parser_class = lib
-          Postmark::Json.decode(%({"Message":"OK"})).should == { "Message" => "OK" }
-        end
-
-        Postmark.response_parser_class = original_parser_class
-      rescue LoadError # No ActiveSupport or Yajl :(
-      end
-    end
-  end
-
-end