simple_postmark 0.4.3 → 0.4.4

data/.travis.yml

@@ -19,4 +19,7 @@ branches:
 matrix:
   exclude:
     - rvm: 1.9.2
-      gemfile: gemfiles/Rails_master.gemfile
+      gemfile: gemfiles/Rails_master.gemfile
+  allow_failures:
+    - rvm: ruby-head
+    - gemfile: gemfiles/Rails_master.gemfile

data/README.md

@@ -1,9 +1,10 @@
-# simple_postmark [![Build Status](https://secure.travis-ci.org/haihappen/simple_postmark.png?branch=master)](http://travis-ci.org/haihappen/simple_postmark)
+# 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.
 
-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`).
+Tested against Ruby versions `1.9.2`, `1.9.3` and Rails versions `3.0.x`, `3.1.x`, `3.2.x`.
+`ruby-head` (a.k.a. Ruby `2.0`) and Rails `master` (upcoming Rails `4.0`) should work too btw.
 
 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).
 
@@ -44,7 +45,7 @@ And of course you can use standard attachment calls and [Postmark's tags](http:/
 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
@@ -52,6 +53,31 @@ class NotificationMailer < ActionMailer::Base
 end
 ```
 
+## Advanced Configuration
+
+* `api_key`: Your Postmark API key. Go to [your Rack](https://postmarkapp.com/servers),
+selected the one you want to use and then go to the **Credentials** tab to find your API key.
+
+* `return_response`: In order to receive the response from the Postmark API
+– for example, if you want to store ErrorCode or MessageID -
+set it to `true`. ([Mail](https://github.com/mikel/mail) which is the base of simple_postmark
+expects this option.)
+
+Example how the ErrorCode, MessageID and other values can be received from Postmark:
+
+```ruby
+# config/environments/production.rb
+config.action_mailer.simple_postmark_settings = { api_key: '********-****-****-****-************', return_response: true }
+
+# your_mailer.rb
+response = YourMailer.email.deliver!.parsed_response
+
+response['MessageID']
+  # => "b7bc2f4a-e38e-4336-af7d-e6c392c2f817"
+response['ErrorCode']
+  # => 0
+```
+
 ## Contributing
 
 1. Fork it
@@ -83,4 +109,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/gemfiles/Rails_master.gemfile

@@ -1,7 +1,7 @@
 source :rubygems
 
 gem 'activesupport', github: 'rails/rails'
-gem 'active_record_deprecated_finders', github: 'rails/active_record_deprecated_finders'
+gem 'activerecord-deprecated_finders', github: 'rails/activerecord-deprecated_finders'
 gem 'httparty'
 gem 'json'
 gem 'mail'

data/lib/simple_postmark/mail_ext/message.rb

@@ -22,7 +22,10 @@ module Mail
 
     def to_postmark
       %w[attachments bcc cc from html_body reply_to subject tag text_body to].each.with_object({}) do |key, hash|
-        hash[key.camelcase] = case (value = public_send(key).presence or next)
+        # mail returns different responses for mail[:reply_to] than mail.reply_to, and we want to prefer the former
+        # as it includes the name, not just the email
+        key_value = self[key.to_sym].nil? ? public_send(key) : self[key.to_sym]
+        hash[key.camelcase] = case (value = key_value.presence or next)
           when AttachmentsList then value.map(&:to_postmark)
           when Array then value.join(', ')
           else value.to_s
@@ -30,4 +33,4 @@ module Mail
       end
     end
   end
-end
+end

data/simple_postmark.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'simple_postmark'
-  gem.version       = '0.4.3'
+  gem.version       = '0.4.4'
   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.'

data/spec/integration_spec.rb

@@ -96,6 +96,7 @@ describe 'SimplePostmark integration' do
       
       response['To'].must_equal(ENV['SIMPLE_POSTMARK_TO'])
       response['Message'].must_equal('OK')
+      response['MessageID'].wont_be_empty
     end
   end
 end if ENV['SIMPLE_POSTMARK_INTEGRATION_SPEC']

data/spec/mail_ext/message_spec.rb

@@ -1,18 +1,28 @@
 require File.expand_path('../../spec_helper', __FILE__)
 
 describe Mail::Message do
-  it 'responds to +to_postmark+' do
-    Mail::Message.new.must_respond_to(:to_postmark)
+  describe 'integration into Mail::Message' do
+    subject { Mail::Message.new }
+
+
+    it 'responds to +to_postmark+' do
+      subject.must_respond_to(:to_postmark)
+    end
   end
 
 
-  it 'responds to +to_postmark+' do
-    Mail.new.must_respond_to(:to_postmark)
+  describe 'integration into Mail' do
+    subject { Mail.new }
+
+
+    it 'responds to +to_postmark+' do
+      subject.must_respond_to(:to_postmark)
+    end
   end
 
 
   describe :to_postmark do
-    let(:mail) do
+    subject do
       Mail.new do
         from     'barney@himym.tld'
         to       'ted@himym.tld'
@@ -36,23 +46,23 @@ describe Mail::Message do
           'ContentType' => 'image/jpeg'
         }]
       }
-      mail.add_file(File.join(File.dirname(__FILE__), '..', 'thebrocode.jpg'))
+      subject.add_file(File.join(File.dirname(__FILE__), '..', 'thebrocode.jpg'))
       
-      mail.to_postmark.must_equal(hash)
+      subject.to_postmark.must_equal(hash)
     end
 
 
     it 'returns multiple recipients as comma-separated list' do
-      mail.to = ['barney@himym.tld', 'marshall@himym.tld']
+      subject.to = ['barney@himym.tld', 'marshall@himym.tld']
       
-      mail.to_postmark['To'].must_equal('barney@himym.tld, marshall@himym.tld')
+      subject.to_postmark['To'].must_equal('barney@himym.tld, marshall@himym.tld')
     end
 
 
     it 'returns all email headers as hash' do
-      mail.bcc = 'lily@himym.tld'
-      mail.cc = 'marshall@himym.tld'
-      mail.reply_to = 'barney@barneystinsonblog.com'
+      subject.bcc = 'lily@himym.tld'
+      subject.cc = 'marshall@himym.tld'
+      subject.reply_to = 'barney@barneystinsonblog.com'
       
       hash = {
         'Bcc'      => 'lily@himym.tld',
@@ -65,7 +75,29 @@ describe Mail::Message do
         'To'       => 'ted@himym.tld'
       }
       
-      mail.to_postmark.must_equal(hash)
+      subject.to_postmark.must_equal(hash)
+    end
+
+
+    it 'should use the from and reply-to names as well as the email addresses' do
+      subject.to = 'Lily <lily@himym.tld>'
+      subject.from = 'Marshall <marshall@himym.tld>'
+      subject.reply_to = 'Barney <barney@barneystinsonblog.com>'
+      subject.bcc = 'lily@himym.tld'
+      subject.cc = 'marshall@himym.tld'
+      
+      hash = {
+        'To'       => 'Lily <lily@himym.tld>',
+        'From'     => 'Marshall <marshall@himym.tld>',
+        'ReplyTo'  => 'Barney <barney@barneystinsonblog.com>',
+        'Bcc'      => 'lily@himym.tld',
+        'Cc'       => 'marshall@himym.tld',
+        '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!",
+      }
+      
+      subject.to_postmark.must_equal(hash)
     end
   end
-end
+end

data/spec/mail_ext/part_spec.rb

@@ -1,46 +1,62 @@
 require File.expand_path('../../spec_helper', __FILE__)
 
 describe Mail::Part do
-  it 'responds to +to_postmark+' do
-    Mail::Part.new.must_respond_to(:to_postmark)
+  describe 'integration into Mail::Part' do
+    subject { Mail::Part.new }
+
+
+    it 'responds to +to_postmark+' do
+      subject.new.must_respond_to(:to_postmark)
+    end
   end
 
 
   describe :to_postmark do
-    it 'returns 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'
+    describe 'a text/plain part' do
+      let(: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!" }
+      subject do
+        Mail::Part.new do
+          body         content
+          content_type 'text/plain'
+        end
+      end
+
+
+      it 'returns body hash' do
+        part.to_postmark.must_equal('Name' => nil, 'Content' => content, 'ContentType' => '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 'returns 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'
+    describe 'a text/html part' do
+      let(: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>" }
+      subject do
+        Mail::Part.new do
+          body         content
+          content_type 'text/html'
+        end
+      end
+
+
+      it 'returns body hash' do
+        part.to_postmark.must_equal('Name' => nil, 'Content' => content, 'ContentType' => '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 'returns 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')
+    describe 'a file part' do
+      let(:file) { File.join(File.dirname(__FILE__), '..', 'thebrocode.jpg') }
+      let(:content) { [File.read(file)].pack('m') }
+      subject do
+        Mail::Part.new.tap do |mail|
+          mail.add_file(file)
+        end.attachments.first
+      end
+
+
+      it 'returns base64-encoded file-content hash if part is an attachment' do
+        part.to_postmark.must_equal('Name' => 'thebrocode.jpg', 'Content' => content, 'ContentType' => 'image/jpeg')
+      end
     end
   end
 end

metadata

@@ -1,132 +1,135 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: simple_postmark
-version: !ruby/object:Gem::Version 
-  hash: 9
+version: !ruby/object:Gem::Version
+  version: 0.4.4
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 3
-  version: 0.4.3
 platform: ruby
-authors: 
+authors:
 - Mario Uher
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-09 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: httparty
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: mail
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rails
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-description: "SimplePostmark makes it easy to send mails via Postmark\xE2\x84\xA2 using Rails 3's ActionMailer."
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SimplePostmark makes it easy to send mails via Postmark™ using Rails
+  3's ActionMailer.
 email: uher.mario@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
@@ -151,39 +154,28 @@ files:
 - spec/railtie_spec.rb
 - spec/spec_helper.rb
 - spec/thebrocode.jpg
-has_rdoc: true
 homepage: http://haihappen.github.com/simple_postmark
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: "A simple way to use Postmark\xE2\x84\xA2 with your Rails app."
+summary: A simple way to use Postmark™ with your Rails app.
 test_files: []
-