postmark 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Petyo Ivanov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,40 @@
+= Postmark gem
+
+Ruby gem for sending emails through http://postmarkapp.com HTTP API
+
+== Example
+
+    #!/usr/bin/env ruby
+
+    require 'rubygems'
+    require 'postmark'
+    require 'tmail'
+
+    Postmark.api_key = "your-api-key"
+
+    message = TMail::Mail.new
+    message.from = "leonard@bigbangtheory.com"
+    message.to = "Sheldon Cooper, Ph.D. <sheldon@bigbangtheory.com>"
+    message.subject = "Hi Sheldon!"
+    message.content_type = "text/html"
+    message.body = "Hello my friend!"
+
+    p Postmark.send_through_postmark(message).body
+
+== 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. 
+If you plan using it in a rails project, check out the postmark-rails gem, which is meant to integrate with ActionMailer. 
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.  
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Wildbit LLC. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "postmark"
+    gem.summary = %Q{Ruby gem for sending emails through http://postmarkapp.com HTTP API}
+    gem.description = %Q{Ruby gem for sending emails through http://postmarkapp.com HTTP API. It relieas on TMail::Mail for message construction.}
+    gem.email = "underlog@gmail.com"
+    gem.homepage = "http://github.com/underlog/postmark"
+    gem.authors = ["Petyo Ivanov"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "cucumber"
+    gem.add_dependency "tmail"
+    gem.files << "lib/postmark/tmail_mail_extension.rb"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "postmark #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/features/postmark.feature

@@ -0,0 +1,15 @@
+Feature: sending emails through Postmark API
+  In order to communicate effectively with the world
+  My application should be able to deliver emails through the postmark API
+
+  Background: 
+    Given the service listens to "http://postmarkapp.local"
+    And I have an account with api key "mykey"
+    
+  Scenario: Sending simple email
+    Given I send the following email:
+      | From    | leonard@bigbangtheory.com |
+      | To      | sheldon@bigbangtheory.com |
+      | Subject | About that last night     |
+      | Body    | Sorry for not coming      |
+    Then the service should receive an email on behalf of "mykey" for "sheldon@bigbangtheory.com"

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'postmark'
+
+require 'spec/expectations'

data/lib/postmark.rb

@@ -0,0 +1,106 @@
+require 'net/http'
+require 'net/https'
+require 'rubygems'
+require 'active_support'
+require 'tmail'
+require 'json'
+require 'postmark/tmail_mail_extension'
+
+module Postmark
+
+  class InvalidApiKeyError < StandardError; end 
+  class UnknownError < StandardError; end
+  class InvalidMessageError < StandardError; end
+  class InternalServerError < StandardError; end
+
+  HEADERS = {
+    'Content-type' => 'application/json',
+    'Accept'       => 'application/json'
+  }
+
+  class << self
+    attr_accessor :host, :host_path, :port, :secure, :api_key, :http_open_timeout, :http_read_timeout,
+      :proxy_host, :proxy_port, :proxy_user, :proxy_pass
+
+    # The port on which your Postmark server runs.
+    def port
+      @port || (secure ? 443 : 80)
+    end
+
+    # The host to connect to.
+    def host
+      @host ||= 'postmarkapp.com'
+    end
+
+    # The path of the listener
+    def host_path
+      @host_path ||= 'email'
+    end
+
+    # The HTTP open timeout (defaults to 2 seconds).
+    def http_open_timeout
+      @http_open_timeout ||= 2
+    end
+
+    # The HTTP read timeout (defaults to 5 seconds).
+    def http_read_timeout
+      @http_read_timeout ||= 5
+    end
+
+    def configure
+      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:
+      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 })
+
+      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
+    end
+
+    def error_message(response_body)
+      JSON.parse(response_body)["Message"]
+    end
+
+    def convert_tmail(message)
+      { "From" => message['from'].to_s, "To" => message['to'].to_s, "Subject" => message.subject }.tap do |hash|
+        if html = message.body_html
+          hash["HtmlBody"] = html
+        else
+          hash["TextBody"] = message.body
+        end
+      end
+    end
+
+  end
+
+end

data/lib/postmark/tmail_mail_extension.rb

@@ -0,0 +1,87 @@
+##
+# 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 'tmail_mail_extension'
+# and every TMail::Mail object will have the .body_html method
+#
+
+module TMail
+  class Mail
+
+    #
+    # 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
+    
+    #
+    # 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 "    --multipartt--"
+            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
+    
+  end
+end

data/postmark.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{postmark}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Petyo Ivanov"]
+  s.date = %q{2009-11-04}
+  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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "features/postmark.feature",
+     "features/step_definitions/postmark_steps.rb",
+     "features/support/env.rb",
+     "lib/postmark.rb",
+     "lib/postmark/tmail_mail_extension.rb",
+     "lib/postmark/tmail_mail_extension.rb",
+     "postmark.gemspec",
+     "spec/postmark_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/underlog/postmark}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Ruby gem for sending emails through http://postmarkapp.com HTTP API}
+  s.test_files = [
+    "spec/postmark_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_runtime_dependency(%q<tmail>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<tmail>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<tmail>, [">= 0"])
+  end
+end

data/spec/postmark_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Postmark" do
+  context "configuration" do
+    it "should allow configuration of host" do
+      Postmark.configure { |config| config.host = "test" }
+      Postmark.host.should == "test"
+    end
+  end
+
+  let :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 :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 :net_http_proxy do
+    stub(:new => http_request)
+  end
+
+  def http_response(code)
+    Net::HTTPResponse.new("1.1", code, nil).tap do |resp|
+      resp.stub! :body => '{ "Message": "OK" }'
+    end
+  end
+
+  let :http_response_ok do
+    http_response(200)
+  end
+
+  let :http_response_unauthorized do
+    http_response(401)
+  end
+
+  let :http_response_invalid do
+    http_response(422)
+  end
+
+  let :http_response_server_error do
+    http_response(500)
+  end
+
+  let :http_response_unknown do
+    http_response(503)
+  end
+
+  let :http_request do
+    stub(:read_timeout= => nil, :open_timeout= => nil, :use_ssl= => nil)
+  end
+
+  before do
+    Net::HTTP.stub!(:Proxy).and_return(net_http_proxy)
+  end
+
+  context "service call" do
+    it "should send email successfully" do
+      http_request.stub! :post => http_response_ok
+      lambda { Postmark.send_through_postmark(message) }.should_not raise_error
+    end
+
+    it "should warn when header is invalid" do
+      http_request.stub! :post => http_response_unauthorized
+      lambda { Postmark.send_through_postmark(message) }.should raise_error(Postmark::InvalidApiKeyError)
+    end
+
+    it "should warn when json is not ok" do
+      http_request.stub! :post => http_response_invalid
+      lambda { Postmark.send_through_postmark(message) }.should raise_error(Postmark::InvalidMessageError)
+    end
+
+    it "should warn when server fails" do
+      http_request.stub! :post => http_response_server_error
+      lambda { Postmark.send_through_postmark(message) }.should raise_error(Postmark::InternalServerError)
+    end
+
+    it "should warn when unknown stuff fails" do
+      http_request.stub! :post => http_response_unknown
+      lambda { Postmark.send_through_postmark(message) }.should raise_error(Postmark::UnknownError)
+    end
+  end
+
+  context "tmail parse" do
+    it "should set text body for plain message" do
+      Postmark.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
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format specdoc
+--loadby mtime

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'postmark'
+require 'rubygems'
+require 'ruby-debug'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: postmark
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Petyo Ivanov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tmail
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby gem for sending emails through http://postmarkapp.com HTTP API. It relieas on TMail::Mail for message construction.
+email: underlog@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/postmark.feature
+- features/step_definitions/postmark_steps.rb
+- features/support/env.rb
+- lib/postmark.rb
+- lib/postmark/tmail_mail_extension.rb
+- postmark.gemspec
+- spec/postmark_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/underlog/postmark
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Ruby gem for sending emails through http://postmarkapp.com HTTP API
+test_files: 
+- spec/postmark_spec.rb
+- spec/spec_helper.rb