simple_postmark 0.4.0 → 0.4.1

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+
+gemfile:
+  - Gemfile
+  - gemfiles/Rails_3_0.gemfile
+  - gemfiles/Rails_3_1.gemfile
+  - gemfiles/Rails_3_2.gemfile
+  - gemfiles/Rails_master.gemfile
+
+branches:
+  only:
+    - master
+
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      gemfile: gemfiles/Rails_master.gemfile

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,90 @@
+# simple_postmark
+
+SimplePostmark makes it easy to send mails via [Postmark](http://postmarkapp.com)™ using Rails 3's ActionMailer.
+SimplePostmark is inspired by [postmark-gem](https://github.com/wildbit/postmark-gem), but unfortunately postmark-gem forced to me to use non-standard Rails calls like `postmark_attachments`. SimplePostmark uses the standard Rails 3's ActionMailer syntax to send your emails via Postmark.
+
+[![Build Status](https://secure.travis-ci.org/haihappen/simple_postmark.png)](http://travis-ci.org/haihappen/simple_postmark)
+
+Tested against Ruby versions `1.9.2`, `1.9.3`, `ruby-head` and Rails versions `3.0.x`, `3.1.x`, `3.2.x`, `master` (upcoming Rails `4.0.0`).
+
+If you are still using Ruby `1.8.7` or `Ruby Enterprise Edition` with Rails 3, you can use the backported version of this gem called [simple_postmark18](https://github.com/haihappen/simple_postmark/tree/ruby18).
+
+## Installation
+
+In your `Gemfile`:
+
+```ruby
+group :production do
+  gem 'simple_postmark'
+end
+```
+
+In your `config/environments/production.rb`:
+
+```ruby
+config.action_mailer.delivery_method = :simple_postmark
+config.action_mailer.simple_postmark_settings = { api_key: '********-****-****-****-************' }
+```
+
+## Usage
+
+Just use your standard Rails 3 Mailer:
+
+```ruby
+class NotificationMailer < ActionMailer::Base
+  def notification
+    mail(to: 'ted@himym.tld', from: 'barney@himym.tld', subject: "I'm your bro!") do
+      # ...
+    end
+  end
+end
+```
+
+And of course you can use standard attachment calls and [Postmark's tags](http://developer.postmarkapp.com/developer-build.html#message-format):
+
+```ruby
+class NotificationMailer < ActionMailer::Base
+  def notification
+    attachments['thebrocode.pdf'] = File.read('thebrocode.pdf')
+  
+    mail(to: 'ted@himym.tld', from: 'barney@himym.tld', subject: "I'm your bro!", tag: 'with-attachment') do
+      # ...
+    end
+  end
+end
+```
+
+## Contributing to simple_postmark
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the [issue tracker](https://github.com/haihappen/simple_postmark/issues) to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+(The MIT license)
+
+Copyright (c) 2011-2012 Mario Uher
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('spec/**/*_spec.rb')
+end
+
+task(default: :test)

data/gemfiles/Rails_3_0.gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec path: '../'
+
+gem 'rails', '~> 3.0.0'

data/gemfiles/Rails_3_1.gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec path: '../'
+
+gem 'rails', '~> 3.1.0'

data/gemfiles/Rails_3_2.gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec path: '../'
+
+gem 'rails', '~> 3.2.0'

data/gemfiles/Rails_master.gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gem 'activesupport', git: 'git://github.com/rails/rails.git'
+gem 'httparty'
+gem 'json'
+gem 'mail'
+
+group :development do
+  gem 'minitest'
+  gem 'purdytest'
+  gem 'rails', git: 'git://github.com/rails/rails.git'
+  gem 'webmock'
+end

data/lib/simple_postmark.rb

@@ -4,7 +4,7 @@ require 'httparty'
 require 'json'
 require 'mail'
 
-module SimplePostmark  
+module SimplePostmark
   require 'simple_postmark/mail_ext/message'
   require 'simple_postmark/mail_ext/part'
 

data/simple_postmark.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |gem|
+  gem.name          = 'simple_postmark'
+  gem.version       = '0.4.1'
+  gem.authors       = 'Mario Uher'
+  gem.email         = 'uher.mario@gmail.com'
+  gem.description   = 'SimplePostmark makes it easy to send mails via Postmark™ using Rails 3\'s ActionMailer.'
+  gem.summary       = 'A simple way to use Postmark™ with your Rails app.'
+  gem.homepage      = 'http://haihappen.github.com/simple_postmark'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_path  = 'lib'
+
+  gem.add_dependency 'activesupport', '~> 3.0'
+  gem.add_dependency 'httparty'
+  gem.add_dependency 'json'
+  gem.add_dependency 'mail'
+
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'purdytest'
+  gem.add_development_dependency 'rails', '~> 3.0'
+  gem.add_development_dependency 'webmock'
+end

data/spec/delivery_method_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Mail do
+  describe SimplePostmark do
+    let(:instance) { Mail::SimplePostmark.new({}) }
+
+
+    it 'should respond to deliver!' do
+      instance.must_respond_to(:deliver!)
+    end
+
+
+    describe :deliver! do
+      let(:mail) do
+        Mail.new do
+          from     'barney@himym.tld'
+          to       'ted@himym.tld'
+          subject  "I'm your bro!"
+          body     "Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome. I'm your bro-I'm Broda!"
+          tag      'simple-postmark'
+          add_file(File.join(File.dirname(__FILE__), 'thebrocode.jpg'))
+        end
+      end
+      let(:url) { 'http://api.postmarkapp.com/email' }
+
+      before do
+        mail.delivery_method(Mail::SimplePostmark)
+        stub_request(:post, url)
+      end
+
+
+      it 'should send emails' do
+        mail.deliver
+
+        assert_requested(:post, url)
+      end
+
+
+      it 'should post appropriate data' do
+        mail.deliver
+
+        assert_requested(:post, url, headers: { 'Accept' => 'application/json', 'ContentType' => 'application/json', 'X-Postmark-Server-Token' => '********-****-****-****-************' })
+      end
+    end
+  end
+end

data/spec/mail_ext/message_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Mail::Message do
+  it 'should respond to +to_postmark+' do
+    Mail::Message.new.must_respond_to(:to_postmark)
+  end
+
+
+  it 'should respond to +to_postmark+' do
+    Mail.new.must_respond_to(:to_postmark)
+  end
+
+
+  describe :to_postmark do
+    let(:mail) do
+      Mail.new do
+        from     'barney@himym.tld'
+        to       'ted@himym.tld'
+        subject  "I'm your bro!"
+        body     "Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome. I'm your bro-I'm Broda!"
+        tag      'simple-postmark'
+      end
+    end
+
+
+    it 'should return a hash' do
+      hash = {
+        'From'        => 'barney@himym.tld',
+        'To'          => 'ted@himym.tld',
+        'Subject'     => "I'm your bro!",
+        'TextBody'    => "Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome. I'm your bro-I'm Broda!",
+        'Tag'         => 'simple-postmark',
+        'Attachments' => [{
+          'Name'        => 'thebrocode.jpg',
+          'Content'     => [File.read(File.join(File.dirname(__FILE__), '..', 'thebrocode.jpg'))].pack('m'),
+          'ContentType' => 'image/jpeg'
+        }]
+      }
+      mail.add_file(File.join(File.dirname(__FILE__), '..', 'thebrocode.jpg'))
+      
+      mail.to_postmark.must_equal(hash)
+    end
+
+
+    it 'should return multiple recipients as comma-separated list' do
+      mail.to = ['barney@himym.tld', 'marshall@himym.tld']
+      
+      mail.to_postmark['To'].must_equal('barney@himym.tld, marshall@himym.tld')
+    end
+
+
+    it 'should return all email headers as hash' do
+      mail.bcc = 'lily@himym.tld'
+      mail.cc = 'marshall@himym.tld'
+      mail.reply_to = 'barney@barneystinsonblog.com'
+      
+      hash = {
+        'Bcc'      => 'lily@himym.tld',
+        'Cc'       => 'marshall@himym.tld',
+        'From'     => 'barney@himym.tld',
+        'ReplyTo'  => 'barney@barneystinsonblog.com',
+        'Subject'  => "I'm your bro!",
+        'Tag'      => 'simple-postmark',
+        'TextBody' => "Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome. I'm your bro-I'm Broda!",
+        'To'       => 'ted@himym.tld'
+      }
+      
+      mail.to_postmark.must_equal(hash)
+    end
+  end
+end

data/spec/mail_ext/part_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Mail::Part do
+  it 'should respond to +to_postmark+' do
+    Mail::Part.new.must_respond_to(:to_postmark)
+  end
+
+
+  describe :to_postmark do
+    it 'should return body hash if part is not an attachment' do
+      part = Mail::Part.new do
+        body         "Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome. I'm your bro-I'm Broda!"
+        content_type 'text/plain'
+      end
+      
+      content = "Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome. I'm your bro-I'm Broda!"
+      
+      part.to_postmark.must_equal('Name' => nil, 'Content' => content, 'ContentType' => 'text/plain')
+    end
+
+
+    it 'should return body hash if part is not an attachment' do
+      part = Mail::Part.new do
+        body         "<p>Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome.<br /><br />I'm your bro-I'm Broda!</p>"
+        content_type 'text/html'
+      end
+      
+      content = "<p>Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome.<br /><br />I'm your bro-I'm Broda!</p>"
+      
+      part.to_postmark.must_equal('Name' => nil, 'Content' => content, 'ContentType' => 'text/html')
+    end
+
+
+    it 'should return base64-encoded file-content hash if part is an attachment' do
+      file = File.join(File.dirname(__FILE__), '..', 'thebrocode.jpg')
+      
+      part = Mail::Part.new.tap do |mail|
+        mail.add_file(file)
+      end.attachments.first
+        
+      content = [File.read(file)].pack('m')
+      
+      part.to_postmark.must_equal('Name' => 'thebrocode.jpg', 'Content' => content, 'ContentType' => 'image/jpeg')
+    end
+  end
+end

data/spec/railtie_spec.rb

@@ -0,0 +1,117 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'action_mailer'
+require 'rails'
+require 'simple_postmark/railtie'
+
+ActionMailer::Base.delivery_method = :simple_postmark
+
+class NotificationMailer < ActionMailer::Base
+  default from: 'barney@himym.tld', to: 'ted@himym.tld'
+
+  def im_your_bro
+    mail(subject: "I'm your bro!")
+  end
+
+  def im_your_bro_tagged
+    mail(subject: "I'm your bro!", tag: 'simple-postmark')
+  end
+
+  def im_your_bro_multipart
+    mail(subject: "I'm your bro!") do |as|
+      as.html { render(text: "<p>Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome.<br /><br />I'm your bro-I'm Broda!</p>" )}
+      as.text { render(text: "Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome. I'm your bro-I'm Broda!" )}
+    end
+  end
+
+  def the_bro_code
+    attachments['thebrocode.jpg'] = File.read(File.join(File.dirname(__FILE__), 'thebrocode.jpg'))
+    mail(subject: 'The Brocode!')
+  end
+end
+
+def merge_body(hash = {})
+  Hash[*body.merge(hash).sort.flatten(1)].to_json
+end
+
+describe ActionMailer::Base do
+  let(:url) { 'http://api.postmarkapp.com/email' }
+  let(:api_key) { '********-****-****-****-************' }
+
+  let(:headers) do
+    {
+      'Accept'                  => 'application/json',
+      'ContentType'             => 'application/json',
+      'X-Postmark-Server-Token' => api_key
+    }
+  end
+
+  let(:body) do
+    {
+      'From'    => 'barney@himym.tld',
+      'Subject' => "I'm your bro!",
+      'To'      => 'ted@himym.tld'
+    }
+  end
+
+  before do
+    stub_request(:post, url)
+  end
+
+
+  it 'should respond to +simple_postmark_settings+' do
+    ActionMailer::Base.must_respond_to(:simple_postmark_settings)
+  end
+
+
+  it 'should allow setting an api key' do
+    ActionMailer::Base.simple_postmark_settings = { api_key: api_key }
+    
+    ActionMailer::Base.simple_postmark_settings[:api_key].must_equal(api_key)
+  end
+
+
+  describe 'sending mails' do
+    before do
+      ActionMailer::Base.simple_postmark_settings = { api_key: api_key }
+    end
+
+
+    it 'should work' do
+      NotificationMailer.im_your_bro.deliver
+      
+      assert_requested(:post, url, headers: headers, body: merge_body)
+    end
+
+
+    it 'should allow tags' do
+      NotificationMailer.im_your_bro_tagged.deliver
+      
+      assert_requested(:post, url, headers: headers, body: merge_body('Tag' => 'simple-postmark'))
+    end
+
+
+    it 'should work with attachments' do
+      attachment = {
+        'Content'     => [File.read(File.join(File.dirname(__FILE__), 'thebrocode.jpg'))].pack('m'),
+        'ContentType' => 'image/jpeg',
+        'Name'        => 'thebrocode.jpg'
+      }
+      
+      NotificationMailer.the_bro_code.deliver
+      
+      assert_requested(:post, url, headers: headers, body: merge_body('Subject' => 'The Brocode!', 'Attachments' => [attachment]))
+    end
+
+
+    it 'should work with multipart messages' do
+      bodies = {
+        'HtmlBody' => "<p>Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome.<br /><br />I'm your bro-I'm Broda!</p>",
+        'TextBody' => "Think of me like Yoda, but instead of being little and green I wear suits and I'm awesome. I'm your bro-I'm Broda!"
+      }
+      
+      NotificationMailer.im_your_bro_multipart.deliver
+      
+      assert_requested(:post, url, headers: headers, body: merge_body(bodies))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'purdytest'
+require 'simple_postmark'
+require 'webmock/minitest'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_postmark
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-12 00:00:00.000000000 Z
+date: 2012-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70098743710300 !ruby/object:Gem::Requirement
+  requirement: &70349875971380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70098743710300
+  version_requirements: *70349875971380
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70098743709500 !ruby/object:Gem::Requirement
+  requirement: &70349875970980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70098743709500
+  version_requirements: *70349875970980
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70098743708740 !ruby/object:Gem::Requirement
+  requirement: &70349875970520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70098743708740
+  version_requirements: *70349875970520
 - !ruby/object:Gem::Dependency
   name: mail
-  requirement: &70098743707660 !ruby/object:Gem::Requirement
+  requirement: &70349875970100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70098743707660
+  version_requirements: *70349875970100
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70098743707040 !ruby/object:Gem::Requirement
+  requirement: &70349876018780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70098743707040
+  version_requirements: *70349876018780
 - !ruby/object:Gem::Dependency
   name: purdytest
-  requirement: &70098743706420 !ruby/object:Gem::Requirement
+  requirement: &70349876018360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70098743706420
+  version_requirements: *70349876018360
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70098743705780 !ruby/object:Gem::Requirement
+  requirement: &70349876017860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *70098743705780
+  version_requirements: *70349876017860
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70098743721720 !ruby/object:Gem::Requirement
+  requirement: &70349876017440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70098743721720
+  version_requirements: *70349876017440
 description: SimplePostmark makes it easy to send mails via Postmark™ using Rails
   3's ActionMailer.
 email: uher.mario@gmail.com
@@ -106,13 +106,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- gemfiles/Rails_3_0.gemfile
+- gemfiles/Rails_3_1.gemfile
+- gemfiles/Rails_3_2.gemfile
+- gemfiles/Rails_master.gemfile
+- lib/simple_postmark.rb
 - lib/simple_postmark/delivery_method.rb
 - lib/simple_postmark/mail_ext/message.rb
 - lib/simple_postmark/mail_ext/part.rb
 - lib/simple_postmark/railtie.rb
-- lib/simple_postmark/version.rb
-- lib/simple_postmark.rb
-homepage: https://www.github.com/haihappen/simple_postmark
+- simple_postmark.gemspec
+- spec/delivery_method_spec.rb
+- spec/mail_ext/message_spec.rb
+- spec/mail_ext/part_spec.rb
+- spec/railtie_spec.rb
+- spec/spec_helper.rb
+- spec/thebrocode.jpg
+homepage: http://haihappen.github.com/simple_postmark
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -137,4 +151,3 @@ signing_key:
 specification_version: 3
 summary: A simple way to use Postmark™ with your Rails app.
 test_files: []
-has_rdoc: 

data/lib/simple_postmark/version.rb

@@ -1,3 +0,0 @@
-module SimplePostmark
-  VERSION = '0.4.0'
-end