postmark-rails 0.2.0 → 0.3.0

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+= Changelog
+
+== 0.3.0
+
+* Added support for Rails 3.

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "actionmailer"
+gem "postmark", ">= 0.8.0"
+gem "rake"
+
+group :test do
+  gem "ruby-debug"
+  gem "rspec"
+  gem "jeweler"
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.0)
+    builder (2.1.2)
+    columnize (0.3.1)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    linecache (0.43)
+    mail (2.2.6.1)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    postmark (0.7.1)
+      tmail
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rspec (1.3.0)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    tmail (1.2.7.1)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionmailer
+  jeweler
+  postmark
+  rake
+  rspec
+  ruby-debug

data/README.rdoc

@@ -1,63 +1,107 @@
-= Postmark rails gem
+= postmark-rails gem
 
-Postmark plug-in for ActionMailer
+The Postmark Rails Gem is a drop-in plug-in for ActionMailer to send emails via Postmark, an email delivery service for web apps. The gem has been created for fast implementation and fully supports all of Postmark’s features.
 
-== Install
+== Supported Rails Versions
 
-The gem is hosted at gemcutter. If you don't have it, install it first:
+* lower than 2.3: could work, but not tested
+* 2.3 and higher
+* 3.0
 
-    sudo gem install gemcutter
-    gem tumble
+== Install
 
-Then
+    sudo gem install postmark
     sudo gem install postmark-rails
 
-== Example
+== Requirements
 
-  config/environment.rb
+* "postmark" gem version 0.8 and higher is required.
+* You will also need a Postmark account, server and sender signature set up to use it. To get an account, sign up at http://postmarkapp.com.
 
-    Rails::Initializer.run do |config|
+== Configuring your Rails application
+
+=== Rails 3
+
+Add this to your Gemfile: (change version numbers if needed)
+
+    gem 'postmark', '0.8.0'
+    gem 'postmark-rails', '0.3.0'
+    
+Don't forget to run "bundle install" command every time you change something in the Gemfile.
+
+Add this to your config/application.rb:
+
+    config.action_mailer.delivery_method   = :postmark
+    config.action_mailer.postmark_settings = { :api_key => "your-api-key" }
+    
+=== Rails 2
+
+Add this to config/environment.rb:
 
+    Rails::Initializer.run do |config|
+    
+      ...
+    
+      config.gem 'postmark'
       config.gem 'postmark-rails'
-      require 'postmark-rails'
+      require    'postmark-rails'
+      
       config.action_mailer.postmark_api_key = "your-api-key"
-      # ...
+      config.action_mailer.delivery_method  = :postmark
+      
+      ...
+      
     end
 
-Next, make postmark the delivery method for the production environment:
+For API details, refer to the developer documentation at http://developer.postmarkapp.com.
 
-  config/environments/production.rb
+== Tagging your deliveries
 
-    config.action_mailer.delivery_method = :postmark
+You can use a tag to categorize outgoing messages and attach application-specific information. Tagging the different types of email that you send lets you review statistics and bounce reports separately. Read more at http://developer.postmarkapp.com/developer-build.html#message-format.
 
-You may also tag messages, in order to track bounces more precisely.
+=== Rails 3
 
     class TestMailer < ActionMailer::Base
+    
       def tagged_message
-        subject    'hello'
-        recipients 'sheldon@bigbangtheory.com'
-        from       'leonard@bigbangtheory.com'
-        tag        'delivery'
+        mail(
+          :subject => 'hello',
+          :to      => 'sheldon@bigbangtheory.com',
+          :from    => 'leonard@bigbangtheory.com',
+          :tag     => 'my-tag'
+        )
       end
+      
+    end
+      
+=== Rails 2
+
+    class SuperMailer < ActionMailer::Base
+    
+      def email
+        from       "no-reply@beanseedapp.com"
+        subject    "Testing new gem for Postmark"
+        recipients "ilya@wildbit.com"
+        tag        "my-another-tag"
+      end
+    
     end
-
-== Limitations
-
-  Currently postmark API does not support attachments. For more information, check the docs here:
-  http://developer.postmarkapp.com
-
-== Requirements
-
-You will also need postmark account, server and sender signature set up to use it.
 
 == 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.
+* Add tests for it. This is important so we 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.
+* Send a pull request. Bonus points for topic branches.
+
+== Authors & Contributors
+
+* Petyo Ivanov
+* Ilya Sabanin
+* Hristo Deshev
+* Randy Schmidt
 
 == Copyright
 
-Copyright (c) 2009 Wildbit LLC. See LICENSE for details.
+Copyright © 2010 Wildbit LLC. See LICENSE for details.

data/Rakefile

@@ -7,11 +7,9 @@ begin
     gem.name = "postmark-rails"
     gem.summary = %Q{Postmark adapter for ActionMailer}
     gem.description = %Q{Use this plugin in your rails applications to send emails through the Postmark API}
-    gem.email = "underlog@gmail.com"
+    gem.email = "ilya@wildbit.com"
     gem.homepage = "http://postmarkapp.com"
-    gem.authors = ["Petyo Ivanov"]
-    gem.add_development_dependency "rspec"
-    gem.add_dependency 'postmark'
+    gem.authors = ["Petyo Ivanov", "Ilya Sabanin"]
 
     gem.post_install_message = %q[
       ==================

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/postmark-rails.rb

@@ -1,36 +1,26 @@
-require 'postmark'
 require 'action_mailer'
+require 'postmark'
+require 'postmark_delivery_method'
 
-module PostmarkMethods
-  def perform_delivery_postmark(message)
-    Postmark.send_through_postmark(message)
-  end
-
-  def tag(value)
-    @tag = value
-  end
-
-  def self.included(base)
-    base.extend(ClassMethods)
-    base.class_eval do
-      alias_method_chain :create_mail, :tag
+module PostmarkInstaller
+  extend self
+  
+  def auto_detect_and_install
+    if ActionMailer::Base.respond_to?(:add_delivery_method)
+      install_in_rails_3
+    else
+      install_in_rails_2
     end
   end
-
-  def create_mail_with_tag
-    returning create_mail_without_tag do |mail|
-      mail.tag = @tag if @tag
-    end
+  
+  def install_in_rails_2
+    ActionMailer::Base.send(:include, PostmarkDeliveryMethod)
   end
-
-  module ClassMethods
-    def postmark_api_key=(value)
-      Postmark.api_key = value
-    end
+  
+  def install_in_rails_3
+    ActionMailer::Base.add_delivery_method :postmark, Mail::Postmark, :api_key => nil
   end
-
+  
 end
 
-class ActionMailer::Base
-  include PostmarkMethods
-end
+PostmarkInstaller.auto_detect_and_install

data/lib/postmark_delivery_method.rb

@@ -0,0 +1,36 @@
+#
+# This module is only used for Rails 2.
+#
+module PostmarkDeliveryMethod
+  
+  module ClassMethods
+    
+    def postmark_api_key=(value)
+      Postmark.api_key = value
+    end
+    
+  end
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+    
+    base.class_eval do      
+      alias_method_chain :create_mail, :tag      
+    end
+  end
+  
+  def perform_delivery_postmark(message)
+    Postmark.send_through_postmark(message)
+  end
+
+  def tag(value)
+    @tag = value
+  end
+
+  def create_mail_with_tag
+    returning create_mail_without_tag do |mail|
+      mail.tag = @tag if @tag
+    end
+  end
+  
+end

data/postmark-rails.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{postmark-rails}
-  s.version = "0.2.0"
+  s.version = "0.3.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-23}
+  s.authors = ["Petyo Ivanov", "Ilya Sabanin"]
+  s.date = %q{2010-09-16}
   s.description = %q{Use this plugin in your rails applications to send emails through the Postmark API}
-  s.email = %q{underlog@gmail.com}
+  s.email = %q{ilya@wildbit.com}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -19,15 +19,19 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG.rdoc",
+     "Gemfile",
+     "Gemfile.lock",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "lib/postmark-rails.rb",
+     "lib/postmark_delivery_method.rb",
      "postmark-rails.gemspec",
      "spec/fixtures/models/test_mailer.rb",
-     "spec/fixtures/views/test_mailer/multipart_message.text.html.erb",
-     "spec/fixtures/views/test_mailer/multipart_message.text.plain.erb",
+     "spec/fixtures/views/test_mailer/multipart_message.html.erb",
+     "spec/fixtures/views/test_mailer/multipart_message.text.erb",
      "spec/fixtures/views/test_mailer/simple_message.erb",
      "spec/fixtures/views/test_mailer/tagged_message.erb",
      "spec/postmark-rails_spec.rb",
@@ -56,15 +60,9 @@ Gem::Specification.new do |s|
     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_runtime_dependency(%q<postmark>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<postmark>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<postmark>, [">= 0"])
   end
 end
 

data/spec/fixtures/models/test_mailer.rb

@@ -1,22 +1,20 @@
 class TestMailer < ActionMailer::Base
-
+  default :subject  => 'hello', 
+          :to       => 'sheldon@bigbangtheory.com', 
+          :from     => 'leonard@bigbangtheory.com'
+          
   def simple_message
-    subject    'hello'
-    recipients 'sheldon@bigbangtheory.com'
-    from       'leonard@bigbangtheory.com'
-  end
-
-  def multipart_message
-    subject    'hello'
-    recipients 'sheldon@bigbangtheory.com'
-    from       'leonard@bigbangtheory.com'
+    mail
   end
 
   def tagged_message
-    subject    'hello'
-    recipients 'sheldon@bigbangtheory.com'
-    from       'leonard@bigbangtheory.com'
-    tag        'delivery'
+    mail(:tag => 'delivery')
   end
 
-end
+  def multipart_message
+    mail(:subject => "Your invitation to join Mixlr.") do |format|
+      format.text
+      format.html
+    end
+  end
+end

data/spec/postmark-rails_spec.rb

@@ -1,19 +1,34 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "PostmarkRails" do
-
+describe "PostmarkRails3" do
+  it "should allow setting an api key" do
+    Postmark.stub!(:send_through_postmark)
+    ActionMailer::Base.postmark_settings = {:api_key => 'api-key'}
+    ActionMailer::Base.postmark_settings[:api_key].should == 'api-key'
+    Postmark.should_receive(:api_key=).with('api-key')
+    TestMailer.simple_message.deliver
+  end
+  
   it "should use postmark for delivery" do
     Postmark.should_receive(:send_through_postmark) do |message|
       message.subject.should == "hello"
     end
-    TestMailer.deliver_simple_message
+    TestMailer.simple_message.deliver
   end
 
   it "should allow tagging of message" do
     Postmark.should_receive(:send_through_postmark) do |message|
       message.tag.to_s.should == "delivery"
     end
-    TestMailer.deliver_tagged_message
+    TestMailer.tagged_message.deliver
   end
-
-end
+  
+  it "should work with multipart messages" do
+    Postmark.should_receive(:send_through_postmark) do |message|
+        message.should be_multipart
+        message.body_text.strip.should == "hello"
+        message.body_html.strip.should == "<b>hello</b>"
+    end
+    TestMailer.multipart_message.deliver
+  end
+end

data/spec/spec_helper.rb

@@ -1,18 +1,13 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
 require 'rubygems'
-require 'ruby-debug'
-require 'actionmailer'
-require 'postmark-rails'
+require 'postmark'
+require 'lib/postmark-rails'
 require 'spec'
 require 'spec/autorun'
 
 ActionMailer::Base.delivery_method = :postmark
-ActionMailer::Base.template_root = File.join(File.dirname(__FILE__), "fixtures", "views")
-
-# require models
-Dir["#{File.dirname(__FILE__)}/fixtures/models/*.rb"].each { |f| require f }
+ActionMailer::Base.prepend_view_path(File.join(File.dirname(__FILE__), "fixtures", "views"))
 
-Spec::Runner.configure do |config|
-  
-end
+Dir["#{File.dirname(__FILE__)}/fixtures/models/*.rb"].each { |f| require f }

metadata

@@ -4,45 +4,23 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Petyo Ivanov
+- Ilya Sabanin
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-03-23 00:00:00 +02:00
+date: 2010-09-16 00:00:00 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: postmark
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
+dependencies: []
+
 description: Use this plugin in your rails applications to send emails through the Postmark API
-email: underlog@gmail.com
+email: ilya@wildbit.com
 executables: []
 
 extensions: []
@@ -53,15 +31,19 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/postmark-rails.rb
+- lib/postmark_delivery_method.rb
 - postmark-rails.gemspec
 - spec/fixtures/models/test_mailer.rb
-- spec/fixtures/views/test_mailer/multipart_message.text.html.erb
-- spec/fixtures/views/test_mailer/multipart_message.text.plain.erb
+- spec/fixtures/views/test_mailer/multipart_message.html.erb
+- spec/fixtures/views/test_mailer/multipart_message.text.erb
 - spec/fixtures/views/test_mailer/simple_message.erb
 - spec/fixtures/views/test_mailer/tagged_message.erb
 - spec/postmark-rails_spec.rb