jangomail-mailer 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,42 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in jangomail-mailer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    jangomail-mailer (0.0.1)
+      mail
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    i18n (0.6.0)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb (~> 1.3.0)
+  jangomail-mailer!
+  rspec (~> 2.5.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jason Rust
+
+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.md

@@ -0,0 +1,42 @@
+# JangoMail Transactional Mailer
+Implements the [JangoMail Transactional API](http://api.jangomail.com/api.asmx?op=SendTransactionalEmail) as a
+custom [mailer](https://github.com/mikel/mail) class.
+
+## Features
+- Accepts JangoMail options (e.g. OpenTrack, ClickTrack, TransactionalGroupID, etc.)
+- Sends both the HTML and plain text parts of the message to the JangoMail API.
+
+## Options
+- `user_name` (required): your JangoMail user name
+- `password` (required): your JangoMail password
+- `options`: hash containing additional JangoMail options (e.g. `{ :OpenTrack => true }`)
+- `api_url`: JangoMail API URL
+
+## Rails Examples
+Put in `config/initializers/jangomail.rb`:
+
+     ActionMailer::Base.add_delivery_method :jangomail, Jangomail::Mailer,
+                                            :user_name => 'username',
+                                            :password  => 'password',
+                                            :options   => { :OpenTrack => true }
+
+And in your ActionMailer class:
+
+    defaults :delivery_method => :jangomail
+
+or for just a particular message:
+
+    def welcome(user) do
+      mail :to => user.email,
+           :delivery_method => :jangomail
+    end
+
+## Non-Rails Example
+Create a mailer instance and deliver
+
+    mailer = Jangomail::Mailer.new :user_name => "username", :password => "password"
+    mail = Mail.new { ... }
+    mailer.deliver! mail
+    
+## Contributors
+- Jason Rust

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/jangomail-mailer.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jangomail-mailer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jangomail-mailer"
+  s.version     = Jangomail::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jason Rust"]
+  s.email       = ["jason@rustedcode.com"]
+  s.homepage    = "http://github.com/jrust/jangomail-mailer"
+  s.summary     = %q{JangoMail mailer}
+  s.description = %q{Implements the JangoMail Transactional API as a custom mailer class.}
+
+  s.add_dependency "mail"
+  s.add_development_dependency "rspec", "~> 2.5.0"
+  s.add_development_dependency "fakeweb", "~> 1.3.0"
+
+  s.rubyforge_project = "jangomail-mailer"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/jangomail-mailer.rb

@@ -0,0 +1,80 @@
+require 'net/http'
+require 'net/https'
+require 'cgi'
+require 'mail'
+
+module Jangomail
+  class Mailer
+
+    def initialize(values = {})
+      self.settings = { :api_url              => 'http://api.jangomail.com/api.asmx/SendTransactionalEmail',
+                        :options              => {},
+                        :logger               => defined?(Rails) && Rails.logger,
+                        :log_level            => :debug,
+                        :user_name            => nil,
+                        :password             => nil,
+                      }.merge!(values)
+      raise ArgumentError, 'User Name needed' unless settings[:user_name]
+      raise ArgumentError, 'Password needed' unless settings[:password]
+    end
+
+    attr_accessor :settings
+
+    def new(*args)
+      self
+    end
+
+    def deliver!(mail)
+      uri = URI.parse(settings[:api_url])
+      if uri.scheme == 'https'
+        http = Net::HTTP.new(uri.host, 443)
+        http.use_ssl = true
+      else
+        http = Net::HTTP.new(uri.host)
+      end
+
+      destinations ||= mail.destinations if mail.respond_to?(:destinations) && mail.destinations
+      if destinations.blank?
+        raise ArgumentError.new('At least one recipient (To, Cc or Bcc) is required to send a message')
+      end
+
+      destinations.each do |destination|
+        data = request_data(mail, destination)
+        http.post(uri.path, data).body.tap do |response|
+          settings[:logger].send(settings[:log_level], "Jangomail: #{response}") if settings[:logger]
+        end
+      end
+    end
+
+    private
+
+    def request_data(mail, destination)
+      # Set the envelope from to be either the return-path, the sender or the first from address
+      envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
+      if envelope_from.blank?
+        raise ArgumentError.new('A sender (Return-Path, Sender or From) required to send a message')
+      end
+
+      option_str = settings[:options].inject([]) do |arr, option|
+        val = case option[1]
+                when TrueClass then 'True'
+                when FalseClass then 'False'
+                else option[1].to_s
+              end
+        arr << "#{option[0].to_s}=#{val}"
+      end.join(',')
+
+      {
+        'Username'      => settings[:user_name],
+        'Password'      => settings[:password],
+        'FromEmail'     => envelope_from,
+        'FromName'      => mail[:from].display_names.first,
+        'ToEmailAddress'=> destination,
+        'Subject'       => mail.subject,
+        'MessagePlain'  => mail.multipart? ? mail.text_part.body.to_s : mail.body.to_s,
+        'MessageHTML'   => mail.multipart? ? mail.html_part.body.to_s : mail.body.to_s,
+        'Options'       => option_str,
+      }.map{ |k, v| "#{CGI.escape(k)}=#{CGI.escape(v)}"}.join('&')
+    end
+  end
+end

data/lib/jangomail-mailer/version.rb

@@ -0,0 +1,3 @@
+module Jangomail
+  VERSION = "0.0.1"
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'jangomail-mailer'

data/spec/jangomail-mailer_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Jangomail::Mailer do
+  subject { Jangomail::Mailer.new(:user_name => 'abc', :password => '123', :options => { :OpenTrack => true }) }
+  let(:mail) do
+    Mail.new("From: \"Some Body\" <sender@example.com>\r\nTo: joe@example.com\r\nSubject: Hello\r\n\r\nHi there!").tap do |mail|
+      mail.html_part = Mail::Part.new do
+        content_type 'text/html; charset=UTF-8'
+        body '<h1>This is HTML</h1>'
+      end
+    end
+  end
+
+  before do
+    FakeWeb.register_uri :post, 'http://api.jangomail.com/api.asmx/SendTransactionalEmail', :body => 'Success'
+  end
+
+  describe 'settings' do
+    it 'requires user name' do
+      expect {
+        Jangomail::Mailer.new(:password => '123')
+      }.to raise_error(ArgumentError, 'User Name needed')
+    end
+
+    it 'requires password' do
+      expect {
+        Jangomail::Mailer.new(:user_name => 'abc')
+      }.to raise_error(ArgumentError, 'Password needed')
+    end
+
+    context 'when defaults are used' do
+      subject { Jangomail::Mailer.new(:user_name => 'abc', :password => '123').settings }
+      its([:api_url]) { should == 'http://api.jangomail.com/api.asmx/SendTransactionalEmail' }
+      its([:options]) { should == {} }
+    end
+
+    context 'when set by user' do
+      subject {
+        Jangomail::Mailer.new(
+          :user_name => 'abc',
+          :password => '123',
+          :api_url => 'http://www.example.com/foo',
+          :options => { :OpenTrack => false }
+        ).settings
+      }
+
+      its([:user_name]) { should == 'abc' }
+      its([:password]) { should == '123' }
+      its([:api_url]) { should == 'http://www.example.com/foo' }
+      its([:options]) { should == { :OpenTrack => false } }
+    end
+  end
+
+  describe '#deliver!' do
+    let(:mock_http) { mock('http', :body => 'Success') }
+
+    before do
+      Net::HTTP.stub!(:new).and_return mock_http
+    end
+
+    it 'posts the message to the API with the required parameters' do
+      post = "FromEmail=sender%40example.com&Options=OpenTrack%3DTrue&Subject=Hello&Username=abc&FromName=Some+Body&MessagePlain=Hi+there%21&MessageHTML=%3Ch1%3EThis+is+HTML%3C%2Fh1%3E&Password=123&ToEmailAddress=joe%40example.com"
+      mock_http.should_receive(:post).with('/api.asmx/SendTransactionalEmail', post).and_return(mock(:body => 'Success'))
+      subject.deliver!(mail)
+    end
+  end
+
+  context 'using Rails' do
+    it 'logs response when is available' do
+      Object.const_set 'Rails', Module.new
+      ::Rails.stub :logger => mock(:logger)
+
+      ::Rails.logger.should_receive(:debug).with('Jangomail: Success')
+      subject.deliver!(mail)
+
+      Object.class_eval { remove_const 'Rails' }
+    end
+
+    it 'does not raise exception when is not available' do
+      expect { subject.deliver!(mail) }.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'jangomail-mailer'
+require 'fakeweb'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: jangomail-mailer
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jason Rust
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+description: Implements the JangoMail Transactional API as a custom mailer class.
+email: 
+- jason@rustedcode.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- jangomail-mailer.gemspec
+- lib/jangomail-mailer.rb
+- lib/jangomail-mailer/version.rb
+- rails/init.rb
+- spec/jangomail-mailer_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jrust/jangomail-mailer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: jangomail-mailer
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: JangoMail mailer
+test_files: 
+- spec/jangomail-mailer_spec.rb
+- spec/spec_helper.rb