fishman-postmark-rails 0.4.1

data/.document

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

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.rake_tasks
+.bundle

data/CHANGELOG.rdoc

@@ -0,0 +1,13 @@
+= Changelog
+
+== 0.4.1
+
+* Fixed "returning" deprecation warning.
+
+== 0.4.0
+
+* Attachments support.
+
+== 0.3.0
+
+* Added support for Rails 3.

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "ruby-debug",   :platforms => [:ruby_18]
+  gem "ruby-debug19", :platforms => [:ruby_19]
+  gem "rspec"
+  gem "jeweler"
+end

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,151 @@
+= postmark-rails gem
+
+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.
+
+== Supported Rails Versions
+
+* lower than 2.3: could work, but not tested
+* 2.3 and higher
+* 3.0
+
+== Install
+
+    sudo gem install postmark-rails
+
+== Requirements
+
+* "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.
+
+== Configuring your Rails application
+
+=== Rails 3
+
+Add this to your Gemfile: (change version numbers if needed)
+
+    gem 'postmark-rails', '0.4.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-rails'
+      require    'postmark-rails'
+      
+      config.action_mailer.postmark_api_key = "your-api-key"
+      config.action_mailer.delivery_method  = :postmark
+      
+      ...
+      
+    end
+
+For API details, refer to the developer documentation at http://developer.postmarkapp.com.
+
+== Tagging your deliveries
+
+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.
+
+=== Rails 3
+
+    class TestMailer < ActionMailer::Base
+    
+      def tagged_message
+        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@example.com"
+        subject    "Some marvelous email message"
+        recipients "someone-fancy@example.com"
+        tag        "my-another-tag"
+      end
+    
+    end
+
+== Sending attachments
+
+You can also send file attachments with Postmark. Read more here: http://developer.postmarkapp.com/developer-build.html#attachments
+
+=== Rails 3
+
+    class TestMailer < ActionMailer::Base
+    
+      def message_with_attachment
+        mail(
+          :subject              => 'hello',
+          :to                   => 'sheldon@bigbangtheory.com',
+          :from                 => 'leonard@bigbangtheory.com',
+          :postmark_attachments => [File.open("/path/to/file")]
+        )
+      end
+      
+    end
+
+=== Rails 2
+
+    class SuperMailer < ActionMailer::Base
+    
+      def email
+        from                 "no-reply@example.com"
+        subject              "Some marvelous email message"
+        recipients           "someone-fancy@example.com"
+        postmark_attachments [File.open("/path/to/file")]
+      end
+    
+    end
+    
+You can pass either an array of File objects or a single object. Postmark will detect the file name automatically and send an attachment with the "application/octet-stream" content type. If you want more control on how attachments get formatted, you can pass Hash objects, which contain the custom settings such as file name or content-type. Here is an example:
+
+    #
+    # Don't forget to read your file and base64-encode it,
+    # before assigning it to "Content".
+    #
+    message.postmark_attachments = {
+      "Name"        => "fancy-file-name.jpg",
+      "Content"     => [ IO.read("path/to/file") ].pack("m"),
+      "ContentType" => "image/jpeg"
+    }
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* 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 a pull request. Bonus points for topic branches.
+
+== Authors & Contributors
+
+* Petyo Ivanov
+* Ilya Sabanin
+* Hristo Deshev
+* Randy Schmidt
+* Chris Williams
+* Nicolás Sanguinetti
+* Laust Rud Jacobsen (rud)
+
+== Copyright
+
+Copyright © 2010 Wildbit LLC. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    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 = "ilya@wildbit.com"
+    gem.homepage = "http://postmarkapp.com"
+    gem.authors = ["Petyo Ivanov", "Ilya Sabanin"]
+
+    gem.add_dependency "actionmailer"
+    gem.add_dependency "postmark", ">= 0.9.0"
+    gem.add_dependency "rake"
+
+    gem.post_install_message = %q[
+      ==================
+      Thanks for installing the postmark-rails gem. If you don't have an account, please sign up at http://postmarkapp.com/.
+      Review the README.rdoc for implementation details and examples.
+      ==================
+    ]
+    # 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
+
+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-rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.1

data/lib/postmark-rails.rb

@@ -0,0 +1,27 @@
+require 'action_mailer'
+require 'postmark'
+require 'postmark_delivery_method'
+
+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 install_in_rails_2
+    ActionMailer::Base.send(:include, PostmarkDeliveryMethod)
+  end
+  
+  def install_in_rails_3
+    ActionMailer::Base.add_delivery_method :postmark, Mail::Postmark, :api_key => nil
+    Mail::Message.send(:include, Postmark::AttachmentsFixForMail)
+  end
+  
+end
+
+PostmarkInstaller.auto_detect_and_install

data/lib/postmark_delivery_method.rb

@@ -0,0 +1,41 @@
+#
+# 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, :postmark_extras
+    end
+  end
+  
+  def perform_delivery_postmark(message)
+    Postmark.send_through_postmark(message)
+  end
+
+  def tag(value)
+    @tag = value
+  end
+  
+  def postmark_attachments(value)
+    @attachments = value
+  end
+
+  def create_mail_with_postmark_extras
+    create_mail_without_postmark_extras.tap do |mail|
+      mail.tag = @tag                          if @tag
+      mail.postmark_attachments = @attachments if @attachments
+    end
+  end
+  
+end

data/postmark-rails.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fishman-postmark-rails}
+  s.version = "0.4.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Petyo Ivanov", "Ilya Sabanin"]
+  s.date = %q{2010-11-22}
+  s.description = %q{Use this plugin in your rails applications to send emails through the Postmark API}
+  s.email = %q{ilya@wildbit.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG.rdoc",
+     "Gemfile",
+     "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.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",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://postmarkapp.com}
+  s.post_install_message = %q{
+      ==================
+      Thanks for installing the postmark-rails gem. If you don't have an account, please sign up at http://postmarkapp.com/.
+      Review the README.rdoc for implementation details and examples.
+      ==================
+    }
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Postmark adapter for ActionMailer}
+  s.test_files = [
+    "spec/fixtures/models/test_mailer.rb",
+     "spec/postmark-rails_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::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<actionmailer>, [">= 0"])
+      s.add_runtime_dependency(%q<postmark>, [">= 0.9.0"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+    else
+      s.add_dependency(%q<actionmailer>, [">= 0"])
+      s.add_dependency(%q<postmark>, [">= 0.9.0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<actionmailer>, [">= 0"])
+    s.add_dependency(%q<postmark>, [">= 0.9.0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+  end
+end
+

data/spec/fixtures/models/test_mailer.rb

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

data/spec/fixtures/views/test_mailer/multipart_message.html.erb

@@ -0,0 +1 @@
+<b>hello</b>

data/spec/fixtures/views/test_mailer/multipart_message.text.erb

@@ -0,0 +1 @@
+hello

data/spec/fixtures/views/test_mailer/simple_message.erb

@@ -0,0 +1 @@
+hello

data/spec/fixtures/views/test_mailer/tagged_message.erb

@@ -0,0 +1 @@
+test

data/spec/postmark-rails_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+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.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.tagged_message.deliver
+  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.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'postmark'
+require 'postmark-rails'
+require 'spec'
+require 'spec/autorun'
+
+ActionMailer::Base.delivery_method = :postmark
+ActionMailer::Base.prepend_view_path(File.join(File.dirname(__FILE__), "fixtures", "views"))
+
+Dir["#{File.dirname(__FILE__)}/fixtures/models/*.rb"].each { |f| require f }

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: fishman-postmark-rails
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+  prerelease: 
+platform: ruby
+authors:
+- Petyo Ivanov
+- Ilya Sabanin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: postmark
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use this plugin in your rails applications to send emails through the
+  Postmark API
+email: ilya@wildbit.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- .gitignore
+- CHANGELOG.rdoc
+- Gemfile
+- 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.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
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://postmarkapp.com
+licenses: []
+post_install_message: ! "\n      ==================\n      Thanks for installing the
+  postmark-rails gem. If you don't have an account, please sign up at http://postmarkapp.com/.\n
+  \     Review the README.rdoc for implementation details and examples.\n      ==================\n
+  \   "
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Postmark adapter for ActionMailer
+test_files:
+- spec/fixtures/models/test_mailer.rb
+- spec/postmark-rails_spec.rb
+- spec/spec_helper.rb