malone 0.1.0.rc1 → 1.0.0.rc1

data/CHANGELOG

@@ -0,0 +1,21 @@
+1.0.0
+
+- Malone.configure has been replaced with Malone.connect
+  Use Malone.current to retrieve the last configured Malone
+  instance (using Malone.connect)
+
+- Malone.deliver has been replaced with an instance method.
+  Call deliver (with the same arguments as before) on the
+  return value of Malone.connect or Malone.current.
+
+- Malone#deliver now receives :text and :html instead of :body.
+
+- No need to pass in TLS. it's tries to do TLS automatically.
+
+- Errors during SMTP authentication (and any other error) aren't
+  trapped silently now. (via @tizoc, @elpollila)
+
+- Configuration parameters are more strict (i.e. passing :password
+  would throw a NoMethodError via @tizoc, @elpollila)
+
+- malone/sandbox has been renamed to malone/test.

data/README.md

@@ -0,0 +1,71 @@
+Originally taken from my initial draft [here][blogpost].
+
+[blogpost]: http://www.pipetodevnull.com/past/2010/11/27/simple_mailer/
+
+## USAGE
+
+```ruby
+$ gem install malone
+
+require "malone"
+
+# Typically you would do this somewhere in the bootstrapping
+# part of your application
+
+m = Malone.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587",
+                   domain: "mysite.com")
+
+m.deliver(from: "me@me.com", to: "you@me.com",
+          subject: "Test subject", text: "Great!")
+
+# Malone.current will now remember the last configuration you setup.
+Malone.current.config == m.config
+
+# Now you can also do Malone.deliver, which is syntactic sugar
+# for Malone.current.deliver
+Malone.deliver(from: "me@me.com", to: "you@me.com",
+               subject: "Test subject", text: "Great!")
+
+# Also starting with Malone 1.0, you can also pass in :html
+# for multipart emails.
+
+m.deliver(from: "me@me.com", to: "you@me.com",
+          subject: "Test subject",
+          text: "Great!", html: "<b>Great!</b>")
+
+```
+
+That's it!
+
+## TESTING
+
+```ruby
+require "malone/test"
+
+m = Malone.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587",
+                   domain: "mysite.com")
+
+m.deliver(from: "me@me.com", to: "you@me.com",
+          subject: "Test subject", text: "Great!")
+
+Malone.deliveries.size == 1
+# => true
+
+mail = Malone.deliveries.first
+
+"me@me.com" == mail.from
+# => true
+
+"you@me.com" == mail.to
+# => true
+
+"FooBar" == mail.text
+# => true
+
+"Hello World" == envelope.subject
+# => true
+```
+
+## LICENSE
+
+MIT

data/lib/malone.rb

@@ -1,47 +1,95 @@
-require "net/smtp"
-require "ostruct"
+require "cgi"
 require "mailfactory"
+require "net/smtp"
+require "uri"
 
 class Malone
-  attr :envelope
+  attr :config
+
+  def self.connect(options = {})
+    @config = Configuration.new(options)
 
-  def self.deliver(params = {})
-    new(params).deliver
+    current
   end
-  
-  def self.configure(hash)
-    @config = OpenStruct.new(hash)
+
+  def self.current
+    unless defined?(@config)
+      raise RuntimeError, "Missing configuration: Try doing `Malone.connect`."
+    end
+
+    return new(@config)
   end
 
-  def self.config
-    @config
+  def self.deliver(dict)
+    current.deliver(dict)
   end
 
-  def initialize(params = {})
-    @envelope = MailFactory.new
-    @envelope.from    = params[:from]
-    @envelope.to      = params[:to]
-    @envelope.text    = params[:text]
-    @envelope.html    = params[:html] if params[:html]
-    @envelope.subject = params[:subject]
+  def initialize(config)
+    @config = config
   end
 
-  def deliver
-    smtp = Net::SMTP.new config.host, config.port
-    smtp.enable_starttls if config.tls
-    
+  def deliver(dict)
+    mail = envelope(dict)
+
+    smtp = Net::SMTP.new(config.host, config.port)
+    smtp.enable_starttls_auto
+
     begin
-      smtp.start(config.domain, config.user, config.pass, config.auth)
-      smtp.send_message(envelope.to_s, envelope.from.first, envelope.to)
+      smtp.start(config.domain, config.user, config.password, config.auth)
+      smtp.send_message(mail.to_s, mail.from.first, mail.to)
     ensure
-      smtp.finish
+      smtp.finish if smtp.started?
     end
   end
 
-private
-  NotConfigured = Class.new(StandardError)
+  def envelope(dict)
+    envelope = MailFactory.new
+    envelope.from    = dict[:from]
+    envelope.to      = dict[:to]
+    envelope.text    = dict[:text]
+    envelope.rawhtml = dict[:html] if dict[:html]
+    envelope.subject = dict[:subject]
+
+    return envelope
+  end
+
+  class Configuration
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :user
+    attr_accessor :password
+    attr_accessor :domain
+    attr_accessor :auth
 
-  def config
-    self.class.config or raise(NotConfigured)
+    def initialize(options)
+      opts = options.dup
+
+      url = opts.delete(:url) || ENV["MALONE_URL"]
+
+      if url
+        uri = URI(url)
+
+        opts[:host]     ||= uri.host
+        opts[:port]     ||= uri.port.to_i
+        opts[:user]     ||= unescaped(uri.user)
+        opts[:password] ||= unescaped(uri.password)
+      end
+
+      opts.each do |key, val|
+        send(:"#{key}=", val)
+      end
+    end
+
+    def auth=(val)
+      @auth = val
+      @auth = @auth.to_sym if @auth
+    end
+
+  private
+    def unescaped(val)
+      return if val.to_s.empty?
+
+      CGI.unescape(val)
+    end
   end
 end

data/lib/malone/{sandbox.rb → test.rb}

@@ -5,8 +5,8 @@ class Malone
     @deliveries ||= []
   end
 
-  def self.deliver(*args)
-    deliveries << OpenStruct.new(*args)
+  def deliver(*args)
+    self.class.deliveries << OpenStruct.new(*args)
   end
 end
 

data/malone.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'malone'
+  s.version = "1.0.0.rc1"
+  s.summary = %{Dead-simple Ruby mailing solution which always delivers.}
+  s.date = "2011-01-10"
+  s.author = "Cyril David"
+  s.email = "me@cyrildavid.com"
+  s.homepage = "http://github.com/cyx/malone"
+
+  s.files = Dir[
+    "CHANGELOG",
+    "LICENSE",
+    "README.md",
+    "lib/**/*.rb",
+    "test/*.*",
+    "*.gemspec"
+  ]
+
+  s.require_paths = ["lib"]
+
+  s.add_dependency "mailfactory", "~> 1.4"
+  s.add_development_dependency "cutest"
+end

data/test/helper.rb

@@ -1,44 +1,4 @@
-require "cutest"
-require "flexmock/base"
-
-require File.expand_path("../lib/malone", File.dirname(__FILE__))
-
-class FlexMock
-  class CutestFrameworkAdapter
-    def assert_block(msg, &block)
-      unless yield
-        puts msg
-        flunk(7)
-      end
-    end
-
-    def assert_equal(a, b, msg=nil)
-      flunk unless a == b
-    end
-
-    class AssertionFailedError < StandardError; end
-
-    def assertion_failed_error
-      Cutest::AssertionFailed
-    end
-  end
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
 
-  @framework_adapter = CutestFrameworkAdapter.new
-end
-
-module Cutest::Flexmocked
-  def test(*args, &block)
-    super
-
-    flexmock_verify
-  ensure
-    flexmock_close
-  end
-end
-
-class Cutest::Scope
-  include FlexMock::ArgumentTypes
-  include FlexMock::MockContainer
-
-  include Cutest::Flexmocked
-end
+require "cutest"
+require "malone"

data/test/malone.rb

@@ -1,125 +1,213 @@
-require File.expand_path("helper", File.dirname(__FILE__))
+require_relative "helper"
 
-setup do
-  m = Malone.new(from: "me@me.com", to: "you@me.com",
-                 body: "FooBar", subject: "Hello World")
+test "basic configuration" do
+  m = Malone.connect(host: "smtp.gmail.com", port: 587,
+                     user: "foo@bar.com", password: "pass1234",
+                     domain: "foo.com", auth: "login")
+
+  c = m.config
+
+  assert_equal "smtp.gmail.com", c.host
+  assert_equal 587, c.port
+  assert_equal "foo@bar.com", c.user
+  assert_equal "pass1234", c.password
+  assert_equal "foo.com", c.domain
+  assert_equal :login, c.auth
 end
 
-test "envelope" do |m|
-  assert m.envelope.from == ["me@me.com"]
-  assert m.envelope.to   == ["you@me.com"]
+test "configuration via url" do
+  m = Malone.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587")
 
-  assert m.envelope.instance_variable_get(:@text)    == "FooBar"
-  assert m.envelope.get_header("subject") == ["=?utf-8?Q?Hello_World?="]
+  c = m.config
+
+  assert_equal "smtp.gmail.com", c.host
+  assert_equal 587, c.port
+  assert_equal "foo@bar.com", c.user
+  assert_equal "pass1234", c.password
 end
 
-test "delivering with no config" do |m|
-  assert_raise Malone::NotConfigured do
-    m.deliver
+test "configuration via url and params" do
+  m = Malone.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587",
+                     domain: "foo.com", auth: "login", password: "barbaz123")
+
+  c = m.config
+
+  assert_equal "smtp.gmail.com", c.host
+  assert_equal 587, c.port
+  assert_equal "foo@bar.com", c.user
+  assert_equal "foo.com", c.domain
+  assert_equal :login, c.auth
+
+  # We verify that parameters passed takes precedence over the URL.
+  assert_equal "barbaz123", c.password
+end
+
+test "configuration via MALONE_URL" do
+  ENV["MALONE_URL"] = "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587"
+
+  m = Malone.connect(domain: "foo.com", auth: "login")
+  c = m.config
+
+  assert_equal "smtp.gmail.com", c.host
+  assert_equal 587, c.port
+  assert_equal "foo@bar.com", c.user
+  assert_equal "foo.com", c.domain
+  assert_equal :login, c.auth
+end
+
+test "typos in configuration" do
+  assert_raise NoMethodError do
+    Malone.connect(pass: "pass")
   end
 end
 
-test "configuring" do
-  Malone.configure(
-    host: "smtp.gmail.com",
-    port: 587,
-    domain: "mydomain.com",
-    tls: true,
-    user: "me@mydomain.com",
-    pass: "mypass",
-    auth: :login
-  )
-
-  assert Malone.config.host == "smtp.gmail.com"
-  assert Malone.config.port == 587
-  assert Malone.config.domain == "mydomain.com"
-  assert Malone.config.tls  == true
-  assert Malone.config.user == "me@mydomain.com"
-  assert Malone.config.pass == "mypass"
-  assert Malone.config.auth == :login
+test "Malone.connect doesn't mutate the options" do
+  ex = nil
+  begin
+    Malone.connect({}.freeze)
+  rescue RuntimeError => ex
+  end
+
+  assert_equal nil, ex
+end
+
+test "Malone.current" do
+  Malone.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587")
+
+  c = Malone.current.config
+
+  assert_equal "smtp.gmail.com", c.host
+  assert_equal 587, c.port
+  assert_equal "foo@bar.com", c.user
+  assert_equal "pass1234", c.password
+end
+
+test "#envelope" do
+  m = Malone.connect
+
+  mail = m.envelope(to: "recipient@me.com", from: "no-reply@mydomain.com",
+                    subject: "SUB", text: "TEXT", html: "<h1>TEXT</h1>")
+
+  assert_equal ["recipient@me.com"], mail.to
+  assert_equal ["no-reply@mydomain.com"], mail.from
+  assert_equal ["=?utf-8?Q?SUB?="], mail.subject
+
+  assert_equal "TEXT", mail.instance_variable_get(:@text)
+  assert_equal "<h1>TEXT</h1>", mail.instance_variable_get(:@html)
 end
 
 scope do
-  setup do
-    Malone.configure(
-      host: "smtp.gmail.com",
-      port: 587,
-      domain: "mydomain.com",
-      tls: true,
-      user: "me@mydomain.com",
-      pass: "mypass",
-      auth: :login
-    )
-  end
+  class FakeSMTP < Struct.new(:host, :port)
+    def enable_starttls_auto
+      @enable_starttls_auto = true
+    end
+
+    def start(domain, user, password, auth)
+      @domain, @user, @password, @auth = domain, user, password, auth
+
+      @started = true
+    end
+
+    def started?
+      defined?(@started)
+    end
 
-  test "delivering successfully" do
-    malone = Malone.new(to: "you@me.com", from: "me@me.com",
-                        subject: "My subject", body: "My body")
+    def finish
+      @finish = true
+    end
 
-    # Let's begin the mocking fun
-    sender = flexmock("smtp sender")
+    def send_message(blob, from, to)
+      @blob, @from, @to = blob, from, to
+    end
 
-    # We start out by capturing the Net::SMTP.new part
-    flexmock(Net::SMTP).should_receive(:new).with(
-      "smtp.gmail.com", 587
-    ).and_return(sender)
+    def [](key)
+      instance_variable_get(:"@#{key}")
+    end
+  end
 
-    # Since we configured it with tls: true, then enable_starttls
-    # should be called
-    sender.should_receive(:enable_starttls).once
+  module Net
+    def SMTP.new(host, port)
+      $smtp = FakeSMTP.new(host, port)
+    end
+  end
 
-    # Now we verify that start was indeed called exactly with the arguments
-    # we passed in
-    sender.should_receive(:start).once.with(
-      "mydomain.com", "me@mydomain.com", "mypass", :login,
-    )
+  setup do
+    Malone.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587",
+                   domain: "mydomain.com", auth: :login)
+  end
 
-    # This is a bit of a hack, since envelope.to_s changes everytime.
-    # Specifically, The Message-ID part changes.
-    envelope_to_s = malone.envelope.to_s
+  test "delivering successfully" do |m|
+    m.deliver(to: "recipient@me.com", from: "no-reply@mydomain.com",
+              subject: "SUB", text: "TEXT")
 
-    # So we get one result of envelope.to_s
-    flexmock(malone.envelope).should_receive(:to_s).and_return(envelope_to_s)
+    assert_equal "smtp.gmail.com", $smtp.host
+    assert_equal 587, $smtp.port
 
-    # And then we make sure that that value of envelope.to_s is used
-    # instead of making it generate a new Message-ID
-    sender.should_receive(:send_message).once.with(
-      envelope_to_s, "me@me.com", ["you@me.com"]
-    ).and_return("OK")
+    assert $smtp[:enable_starttls_auto]
+    assert_equal "mydomain.com", $smtp[:domain]
+    assert_equal "foo@bar.com", $smtp[:user]
+    assert_equal "pass1234", $smtp[:password]
+    assert_equal :login, $smtp[:auth]
 
-    # I think this is important, otherwise the connection to the
-    # smtp server won't be closed properly
-    sender.should_receive(:finish).once
+    assert_equal ["recipient@me.com"], $smtp[:to]
+    assert_equal "no-reply@mydomain.com", $smtp[:from]
 
-    # One important part of the API of malone is that deliver
-    # should return the result of Net::SMTP#send_message.
-    assert "OK" == malone.deliver
+    assert $smtp[:started]
+    assert $smtp[:finish]
   end
 
-  test "delivering and failing" do
-    malone = Malone.new(to: "you@me.com", from: "me@me.com",
-                        subject: "My subject", body: "My body")
+  test "Malone.deliver forwards to Malone.current" do |m|
+    Malone.deliver(to: "recipient@me.com", from: "no-reply@mydomain.com",
+                   subject: "SUB", text: "TEXT")
 
-    # This is more or less the same example as above,
-    # except that here we make send_message fail
-    # and verify that finish is still called
-    sender = flexmock("smtp sender")
+    assert_equal "smtp.gmail.com", $smtp.host
+    assert_equal 587, $smtp.port
 
-    flexmock(Net::SMTP).should_receive(:new).with(
-      "smtp.gmail.com", 587
-    ).and_return(sender)
+    assert $smtp[:enable_starttls_auto]
+    assert_equal "mydomain.com", $smtp[:domain]
+    assert_equal "foo@bar.com", $smtp[:user]
+    assert_equal "pass1234", $smtp[:password]
+    assert_equal :login, $smtp[:auth]
 
-    sender.should_receive(:enable_starttls).once
+    assert_equal ["recipient@me.com"], $smtp[:to]
+    assert_equal "no-reply@mydomain.com", $smtp[:from]
 
-    sender.should_receive(:start).once.with(
-      "mydomain.com", "me@mydomain.com", "mypass", :login,
-    )
+    assert $smtp[:started]
+    assert $smtp[:finish]
+  end
 
-    sender.should_receive(:send_message).once.and_raise(StandardError)
-    sender.should_receive(:finish).once
+  test "calls #finish even when it fails during send_message" do |m|
+    class FakeSMTP
+      def send_message(*args)
+        raise
+      end
+    end
 
-    assert_raise StandardError do
-      assert nil == malone.deliver
+    begin
+      m.deliver(to: "recipient@me.com", from: "no-reply@mydomain.com",
+                subject: "SUB", text: "TEXT")
+    rescue
     end
+
+    assert $smtp[:started]
+    assert $smtp[:finish]
   end
-end
+end
+
+test "sandbox" do
+  require "malone/test"
+
+  m = Malone.connect
+  m.deliver(to: "recipient@me.com", from: "no-reply@mydomain.com",
+            subject: "SUB", text: "TEXT", html: "<h1>TEXT</h1>")
+
+  assert_equal 1, Malone.deliveries.size
+
+  mail = Malone.deliveries.first
+
+  assert_equal "no-reply@mydomain.com", mail.from
+  assert_equal "recipient@me.com", mail.to
+  assert_equal "SUB", mail.subject
+  assert_equal "TEXT", mail.text
+  assert_equal "<h1>TEXT</h1>", mail.html
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: malone
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc1
+  version: 1.0.0.rc1
   prerelease: 6
 platform: ruby
 authors:
@@ -13,29 +13,18 @@ date: 2011-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mailfactory
-  requirement: &2151851760 !ruby/object:Gem::Requirement
+  requirement: &70255670212260 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2151851760
+  version_requirements: *70255670212260
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &2151851120 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2151851120
-- !ruby/object:Gem::Dependency
-  name: flexmock
-  requirement: &2151850660 !ruby/object:Gem::Requirement
+  requirement: &70255670211520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,20 +32,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151850660
+  version_requirements: *70255670211520
 description: 
-email: cyx@pipetodevnull.com
+email: me@cyrildavid.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/malone/sandbox.rb
-- lib/malone.rb
-- README.markdown
+- CHANGELOG
 - LICENSE
+- README.md
+- lib/malone/test.rb
+- lib/malone.rb
 - test/helper.rb
 - test/malone.rb
-- test/sandbox.rb
+- malone.gemspec
 homepage: http://github.com/cyx/malone
 licenses: []
 post_install_message: 
@@ -79,6 +69,6 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Dead-simple Ruby mailing solution which always delivers.
 test_files: []

data/README.markdown

@@ -1,54 +0,0 @@
-Originally taken from my initial draft [here][blogpost].
-
-[blogpost]: http://www.pipetodevnull.com/past/2010/11/27/simple_mailer/
-
-## USAGE
-
-    $ gem install malone
-
-    require "malone"
-
-    # typically you would do this somewhere in the bootstrapping
-    # part of your application
-
-    Malone.configure(
-      host:     "smtp.gmail.com",
-      port:     587,
-      tls:      true,
-      domain:   "mydomain.com",
-      user:     "me@mydomain.com",
-      pass:     "mypass",
-      auth:     :login,
-      from:     "no-reply@mydomain.com"
-    )
-
-    Malone.deliver(from: "me@me.com", to: "you@me.com",
-                   subject: "Test subject", body: "Great!")
-
-That's it!
-
-## TESTING
-
-    require "malone/sandbox"
-
-    Malone.deliver(from: "me@me.com", to: "you@me.com",
-                   subject: "Test subject", body: "Great!")
-
-    Malone.deliveries.size == 1
-    # => true
-
-    envelope = Malone.deliveries.first
-
-    "me@me.com" == envelope.from
-    # => true
-
-    "you@me.com" == envelope.to
-    # => true
-
-    "FooBar" == envelope.body
-    # => true
-
-    "Hello World" == envelope.subject## LICENSE
-    # => true
-
-MIT

data/test/sandbox.rb

@@ -1,16 +0,0 @@
-require File.expand_path("helper", File.dirname(__FILE__))
-require File.expand_path("../lib/malone/sandbox", File.dirname(__FILE__))
-
-test "deliveries" do
-  Malone.deliver from: "me@me.com", to: "you@me.com",
-                 body: "FooBar", subject: "Hello World"
-
-  assert_equal 1, Malone.deliveries.size
-
-  envelope = Malone.deliveries.first
-
-  assert_equal "me@me.com", envelope.from
-  assert_equal "you@me.com", envelope.to
-  assert_equal "FooBar", envelope.body
-  assert_equal "Hello World", envelope.subject
-end