simple_mailer 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c29f8a54328df163579bbc2a52d4c88c700e2e8
-  data.tar.gz: e7d81522d9e9059d860510eb2449a053e699cc1e
+  metadata.gz: a983756906bc274eb4c8a9f870af6cb17375ff4d
+  data.tar.gz: f0de651d59f07f38c9a3f885adc419f7a00bb2c6
 SHA512:
-  metadata.gz: 9cc1a9501b92907e8a4a0b2fbf41c1a74ff3b01fed4d79da2009ea4582ba8609df215e55c1d30fea6a1d7b86a804e18c24666d5e9f9caa55bbbf345bc7283814
-  data.tar.gz: 18cf8b2af821be2c7573ddd84a91a1128e35372e2a8d9f8cb69be9ffbe399cb3fc027ea554f452ca86a4996b48d65381bdc69eb99aa2843d10baabd66b4ccdbd
+  metadata.gz: 682559a504a4594ad1771b9349378f7b4e1733b70adab4a95370daf22105e0b34a8cde75381ecb35fcc313ee530e2b9fa1584ce5b25185baf647ecc798625d10
+  data.tar.gz: 29d1c3d59bed320f8fb1055bf679892f1cbf6f407ed6d6c60601e20d77d12956682ed69557e410eeabcce6dfdda758c029ef8117e5f78bac00eae8b9e55f7f8d

data/README

@@ -55,6 +55,19 @@ There are four special headers that simple_mailer processes:
 
 All other headers are used verbatim in the message.
 
+== Configuration
+
+You can pass in options just like with the Mail gem.
+
+  SimpleMailer.smtp_settings.update(
+    :address => "smtp.gmail.com",
+    :port => 587,
+    :domain => "localhost",
+    :user_name => "bob",
+    :password => "secret",
+    :authentication => :plain,
+  )
+
 == Testing
 
 Testing support is probably the main reason to use simple_mailer over

data/lib/simple_mailer.rb

@@ -15,6 +15,7 @@ module SimpleMailer
   extend self
 
   DEFAULT_SMTP_HOST = 'localhost'.freeze
+  DEFAULT_SMTP_DOMAIN = 'localhost'.freeze
 
   # The array of emails sent
   def self.emails_sent
@@ -37,6 +38,16 @@ module SimpleMailer
 
   # The smtp server to sent email to
   attr_accessor :smtp_server
+
+  # Custom SMTP configuration for any service (taken from the "mail" gem)
+  def smtp_settings
+    @smtp_settings ||= {
+      :address              => smtp_server || DEFAULT_SMTP_HOST,
+      :port                 => 25,
+      :enable_starttls_auto => true,
+      :domain               => DEFAULT_SMTP_DOMAIN,
+    }
+  end
   
   # The emails sent in test mode.  Is an array of arrays.  Each
   # element array is a array of three elements, the message, from address,
@@ -91,7 +102,9 @@ END_OF_MESSAGE
     if SimpleMailer.test_mode?
       test_mode_send_email(msg, from, to)
     else
-      Net::SMTP.start(smtp_server || DEFAULT_SMTP_HOST){|s| s.send_message(msg, from, to)}
+      smtp.start(*smtp_settings.values_at(:domain, :user_name, :password, :authentication)) do |s|
+        s.send_message(msg, from, to)
+      end
     end
   end
 
@@ -100,4 +113,11 @@ END_OF_MESSAGE
   def test_mode_send_email(msg, from, to)
     emails_sent << [msg, from, to]
   end
+
+  def smtp
+    Net::SMTP.new(*smtp_settings.values_at(:address, :port)).tap do |smtp|
+      smtp.enable_starttls_auto unless smtp_settings[:enable_starttls_auto] == false
+      smtp.enable_tls if smtp_settings[:tls] || smtp_settings[:ssl]
+    end
+  end
 end

data/spec/simple_mailer.rb

@@ -1,32 +1,54 @@
-#!/usr/bin/env spec
 require File.join(File.dirname(File.dirname(__FILE__)), '/lib/simple_mailer')
 Object.send(:remove_const, :Net)
 
+gem 'minitest'
+require 'minitest/autorun'
+
 $message = [nil, nil, nil]
 module Net
   class SMTP
-    class Mock
-      def initialize(host)
-        @host = host
-      end
-      def send_message(msg, from, to)
-        $message = [msg, from, to, @host]
-      end
+    attr_reader :address, :port, :domain, :user_name, :password, :authentication,
+      :starttls_auto, :tls
+
+    def initialize(address, port = nil)
+      @address, @port = address, port
+    end
+
+    def enable_starttls_auto
+      @starttls_auto = true
+    end
+
+    def enable_tls
+      @tls = true
     end
-    def self.start(host, *args)
-      yield(Mock.new(host))
+
+    def start(domain = nil, user_name = nil, password = nil, authentication = nil)
+      @domain, @user_name, @password, @authentication = domain, user_name, password, authentication
+      yield self
+    end
+
+    def send_message(msg, from, to)
+      $message = [msg, from, to, @address]
+      self
     end
   end
 end
 
-shared_examples_for "simple_mailer" do
+module SimpleMailerSpecs
+  extend Minitest::Spec::DSL
+
   before do
     $message = [nil, nil, nil]
   end
+  after do
+    @mailer.smtp_server = nil
+    @mailer.instance_variable_set(:@smtp_settings, nil)
+    SimpleMailer.instance_variable_set(:@test_mode, false)
+  end
 
-  it "should sent email" do
+  it "should send email" do
     @mailer.send_email('from1@from.com', 'to1@to.com', 'Test Subject 1', 'Test Body 1')
-    $message.should == [<<END_MESSAGE, 'from1@from.com', 'to1@to.com', 'localhost']
+    $message.must_equal [<<END_MESSAGE, 'from1@from.com', 'to1@to.com', 'localhost']
 From: from1@from.com
 To: to1@to.com
 Subject: Test Subject 1
@@ -37,7 +59,7 @@ END_MESSAGE
 
   it "should allow the setting of headers" do
     @mailer.send_email('from2@from.com', 'to2@to.com', 'Test Subject 2', 'Test Body 2', 'HeaderKey2'=>'HeaderValue2')
-    $message.should == [<<END_MESSAGE, 'from2@from.com', 'to2@to.com', 'localhost']
+    $message.must_equal [<<END_MESSAGE, 'from2@from.com', 'to2@to.com', 'localhost']
 From: from2@from.com
 To: to2@to.com
 Subject: Test Subject 2
@@ -49,7 +71,7 @@ END_MESSAGE
 
   it "should recognize the special :cc header" do
     @mailer.send_email('from3@from.com', 'to3@to.com', 'Test Subject 3', 'Test Body 3', :cc=>'cc3@to.com')
-    $message.should == [<<END_MESSAGE, 'from3@from.com', ['to3@to.com', 'cc3@to.com'], 'localhost']
+    $message.must_equal [<<END_MESSAGE, 'from3@from.com', ['to3@to.com', 'cc3@to.com'], 'localhost']
 From: from3@from.com
 To: to3@to.com
 Subject: Test Subject 3
@@ -61,7 +83,7 @@ END_MESSAGE
 
   it "should recognize the special :bcc header" do
     @mailer.send_email('from3@from.com', 'to3@to.com', 'Test Subject 3', 'Test Body 3', :bcc=>'cc3@to.com')
-    $message.should == [<<END_MESSAGE, 'from3@from.com', ['to3@to.com', 'cc3@to.com'], 'localhost']
+    $message.must_equal [<<END_MESSAGE, 'from3@from.com', ['to3@to.com', 'cc3@to.com'], 'localhost']
 From: from3@from.com
 To: to3@to.com
 Subject: Test Subject 3
@@ -72,7 +94,7 @@ END_MESSAGE
 
   it "should recognize the special :smtp_from and :smtp_to headers" do
     @mailer.send_email('from3@from.com', 'to3@to.com', 'Test Subject 3', 'Test Body 3', 'HeaderKey3'=>'HeaderValue3', :smtp_from=>'from@to.com', :smtp_to=>'to@from.com')
-    $message.should == [<<END_MESSAGE, 'from@to.com', 'to@from.com', 'localhost']
+    $message.must_equal [<<END_MESSAGE, 'from@to.com', 'to@from.com', 'localhost']
 From: from3@from.com
 To: to3@to.com
 Subject: Test Subject 3
@@ -85,13 +107,13 @@ END_MESSAGE
   it "should not modify input hash" do
     h = {:smtp_to=>'to@to.com'}
     @mailer.send_email('from3@from.com', 'to3@to.com', 'Test Subject 3', 'Test Body 3', h)
-    h.should == {:smtp_to=>'to@to.com'}
+    h.must_equal(:smtp_to=>'to@to.com')
   end
 
   it "should allow the setting of smtp server" do
     @mailer.smtp_server = 'blah.com'
     @mailer.send_email('from1@from.com', 'to1@to.com', 'Test Subject 1', 'Test Body 1')
-    $message.should == [<<END_MESSAGE, 'from1@from.com', 'to1@to.com', 'blah.com']
+    $message.must_equal [<<END_MESSAGE, 'from1@from.com', 'to1@to.com', 'blah.com']
 From: from1@from.com
 To: to1@to.com
 Subject: Test Subject 1
@@ -103,13 +125,13 @@ END_MESSAGE
   it "should not send emails in test mode" do
     SimpleMailer.test_mode!
     @mailer.send_email('from3@from.com', 'to3@to.com', 'Test Subject 3', 'Test Body 3', 'HeaderKey3'=>'HeaderValue3', :smtp_from=>'from@to.com', :smtp_to=>'to@from.com')
-    $message.should == [nil, nil, nil]
+    $message.must_equal [nil, nil, nil]
   end
 
   it "should record emails sent to emails_sent in test mode" do
     SimpleMailer.test_mode!
     @mailer.send_email('from3@from.com', 'to3@to.com', 'Test Subject 3', 'Test Body 3', 'HeaderKey3'=>'HeaderValue3', :smtp_from=>'from@to.com', :smtp_to=>'to@from.com')
-    @mailer.emails_sent.should == [[<<END_MESSAGE, 'from@to.com', 'to@from.com']]
+    @mailer.emails_sent.must_equal [[<<END_MESSAGE, 'from@to.com', 'to@from.com']]
 From: from3@from.com
 To: to3@to.com
 Subject: Test Subject 3
@@ -119,14 +141,52 @@ Test Body 3
 END_MESSAGE
     SimpleMailer.instance_variable_set(:@test_mode, false)
   end
+
+  it "should give proper default smtp settings" do
+    @mailer.send(:smtp).address.must_equal 'localhost'
+    @mailer.send(:smtp).port.must_equal 25
+    @mailer.send(:smtp).starttls_auto.must_equal true
+
+    smtp = @mailer.send_email('from@from.com', 'to@to.com', 'Test Subject', 'Test Body')
+    smtp.domain.must_equal 'localhost'
+  end
+
+  it "should take smtp_server as the address" do
+    @mailer.smtp_server = 'blah.com'
+    @mailer.send(:smtp).address.must_equal 'blah.com'
+  end
+
+  it "should have configurable smtp settings" do
+    @mailer.smtp_settings.update(
+      :address              => 'smtp.gmail.com',
+      :port                 => 587,
+      :user_name            => 'bob',
+      :password             => 'secret',
+      :domain               => 'mydomain.com',
+      :authentication       => :plain,
+      :enable_starttls_auto => false,
+      :tls                  => true
+    )
+
+    @mailer.send(:smtp).address.must_equal 'smtp.gmail.com'
+    @mailer.send(:smtp).port.must_equal 587
+    @mailer.send(:smtp).starttls_auto.must_equal nil
+    @mailer.send(:smtp).tls.must_equal true
+
+    smtp = @mailer.send_email('from@from.com', 'to@to.com', 'Test Subject', 'Test Body')
+    smtp.domain.must_equal 'mydomain.com'
+    smtp.user_name.must_equal 'bob'
+    smtp.password.must_equal 'secret'
+    smtp.authentication.must_equal :plain
+  end
 end
 
 describe "SimpleMailer module itself" do
   before{@mailer = SimpleMailer}
-  it_should_behave_like "simple_mailer"
+  include SimpleMailerSpecs
 end
 
 describe "Class including SimpleMailer" do
   before{@mailer = Class.new{include SimpleMailer}.new}
-  it_should_behave_like "simple_mailer"
+  include SimpleMailerSpecs
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_mailer
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2015-05-01 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: code@jeremyevans.net
@@ -17,8 +17,8 @@ extensions: []
 extra_rdoc_files:
 - MIT-LICENSE
 files:
-- README
 - MIT-LICENSE
+- README
 - lib/simple_mailer.rb
 - spec/simple_mailer.rb
 homepage: 
@@ -26,25 +26,25 @@ licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --inline-source
-- --line-numbers
+- "--inline-source"
+- "--line-numbers"
 - README
 - lib
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Simple email library with testing support