malone-acd 1.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8304a6c962c3ce511c5c6013fc12e79f089fecf
+  data.tar.gz: dc8d668a2610da9dc24617f906431e6b83191e75
+SHA512:
+  metadata.gz: 2c10db3e69a24e740e71ff7025c573d0f2d17f24e82eca81420fec1ddf0af2d9d2ffe781c4b0c5cbc8193ed796a2810f3e8135fc8efb4abe02c4616be78d061b
+  data.tar.gz: cbfe96fe372643cc263d0e11af4e64febdf936077ac889760edd5195ab01d0620acbc9d31ffee11ddcc6a214b904120a8548e266d8832199cd36aae1a834ae7a

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/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Cyril David
+
+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,82 @@
+malone(1) -- send mail using smtp without any fuss
+==================================================
+
+## USAGE
+
+    require "malone"
+
+    # Typically you would do this somewhere in the bootstrapping
+    # part of your application
+
+    m = Malone.connect(url: "smtp://foo%40bar.com:pass@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 pass in :html
+    # for multipart emails.
+
+    Malone.deliver(from: "me@me.com", to: "you@me.com",
+                   subject: "Test subject",
+                   text: "Great!", html: "<b>Great!</b>")
+
+
+## TESTING
+
+    require "malone/test"
+
+    m = Malone.connect(url: "smtp://foo%40bar.com:pass@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
+
+## INSTALLATION
+
+    gem install malone
+
+## CONFIGURATION TIPS
+
+If you're used to doing configuration via environment
+variables, similar to how Heroku does configuration, then
+you can simply set an environment variable in your
+production machine like so:
+
+    export MALONE_URL=smtp://foo%40bar.com:pass@smtp.gmail.com:587
+
+Then you can connect using the environment variable in your
+code like so:
+
+    Malone.connect(url: ENV["MALONE_URL"])
+
+    # or quite simply
+    Malone.connect
+
+By default Malone tries for the environment variable `MALONE_URL` when
+you call `Malone.connect` without any arguments.

data/lib/malone/test.rb

@@ -0,0 +1,13 @@
+require "ostruct"
+
+class Malone
+  def self.deliveries
+    @deliveries ||= []
+  end
+
+  def deliver(*args)
+    self.class.deliveries << OpenStruct.new(*args)
+  end
+end
+
+

data/lib/malone.rb

@@ -0,0 +1,127 @@
+require "cgi"
+require "mailfactory"
+require "net/smtp"
+require "uri"
+
+class Malone
+  attr :config
+
+  def self.connect(options = {})
+    @config = Configuration.new(options)
+
+    current
+  end
+
+  def self.current
+    unless defined?(@config)
+      raise RuntimeError, "Missing configuration: Try doing `Malone.connect`."
+    end
+
+    return new(@config)
+  end
+
+  def self.deliver(dict)
+    current.deliver(dict)
+  end
+
+  def initialize(config)
+    @config = config
+  end
+
+  def deliver(dict)
+    mail = envelope(dict)
+
+    smtp = Net::SMTP.new(config.host, config.port)
+    smtp.enable_starttls_auto if config.tls
+
+    begin
+      smtp.start(config.domain, config.user, config.password, config.auth)
+      smtp.send_message(mail.to_s, mail.from.first, *recipients(mail))
+    ensure
+      smtp.finish if smtp.started?
+    end
+  end
+
+  def recipients(mail)
+    [].tap do |ret|
+      ret.push(*mail.to)
+      ret.push(*mail.cc)
+      ret.push(*mail.bcc)
+    end
+  end
+
+  def envelope(dict)
+    envelope = Envelope.new
+    envelope.from    = dict[:from]
+    envelope.to      = dict[:to]
+    envelope.replyto = dict[:replyto]
+    envelope.cc      = dict[:cc] if dict[:cc]
+    envelope.bcc     = dict[:bcc] if dict[:bcc]
+    envelope.text    = dict[:text]
+    envelope.rawhtml = dict[:html] if dict[:html]
+    envelope.subject = dict[:subject]
+
+    envelope.attach(dict[:attach]) if dict[:attach]
+    
+    envelope.add_attachment_as(*dict[:attach_as]) if dict[:attach_as]
+
+    return envelope
+  end
+
+  class Configuration
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :user
+    attr_accessor :password
+    attr_accessor :domain
+    attr_accessor :auth
+    attr_accessor :tls
+
+    def initialize(options)
+      opts = options.dup
+
+      @tls = true
+
+      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
+
+  class Envelope < MailFactory
+    attr :bcc
+
+    def initialize
+      super
+
+      @bcc = []
+    end
+
+    def bcc=(bcc)
+      @bcc.push(bcc)
+    end
+  end
+end

data/malone.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'malone-acd'
+  s.version = "1.0.7"
+  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-acd"
+  s.add_development_dependency "cutest-cj"
+end

data/test/helper.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require "cutest"
+require "malone"

data/test/malone.rb

@@ -0,0 +1,223 @@
+require_relative "helper"
+
+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 "configuration via url" do
+  m = Malone.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587")
+
+  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 "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
+  assert_equal true, c.tls
+
+  # 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", tls: false)
+  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
+  assert_equal false, c.tls
+end
+
+test "typos in configuration" do
+  assert_raise NoMethodError do
+    Malone.connect(pass: "pass")
+  end
+end
+
+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>",
+                    cc: "cc@me.com", bcc: "bcc@me.com",
+                    replyto: "other@me.com")
+
+  assert_equal ["recipient@me.com"], mail.to
+  assert_equal ["cc@me.com"], mail.cc
+  assert_equal ["bcc@me.com"], mail.bcc
+  assert_equal ["no-reply@mydomain.com"], mail.from
+  assert_equal ["=?utf-8?Q?SUB?="], mail.subject
+  assert_equal "other@me.com", mail.replyto
+
+  assert_equal "TEXT", mail.instance_variable_get(:@text)
+  assert_equal "<h1>TEXT</h1>", mail.instance_variable_get(:@html)
+end
+
+scope do
+  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
+
+    def finish
+      @finish = true
+    end
+
+    def send_message(blob, from, *recipients)
+      @blob, @from, @recipients = blob, from, recipients
+    end
+
+    def [](key)
+      instance_variable_get(:"@#{key}")
+    end
+  end
+
+  module Net
+    def SMTP.new(host, port)
+      $smtp = FakeSMTP.new(host, port)
+    end
+  end
+
+  setup do
+    Malone.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587",
+                   domain: "mydomain.com", auth: :login)
+  end
+
+  test "delivering successfully" do |m|
+    m.deliver(to: "recipient@me.com", from: "no-reply@mydomain.com",
+              subject: "SUB", text: "TEXT", cc: "cc@me.com", bcc: "bcc@me.com")
+
+    assert_equal "smtp.gmail.com", $smtp.host
+    assert_equal 587, $smtp.port
+
+    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]
+
+
+    assert_equal ["recipient@me.com", "cc@me.com", "bcc@me.com"], $smtp[:recipients]
+    assert_equal "no-reply@mydomain.com", $smtp[:from]
+
+    assert ! $smtp[:blob].include?("bcc@me.com")
+
+    assert $smtp[:started]
+    assert $smtp[:finish]
+  end
+
+  test "Malone.deliver forwards to Malone.current" do |m|
+    Malone.deliver(to: "recipient@me.com", from: "no-reply@mydomain.com",
+                   subject: "SUB", text: "TEXT")
+
+    assert_equal "smtp.gmail.com", $smtp.host
+    assert_equal 587, $smtp.port
+
+    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]
+
+    assert_equal ["recipient@me.com"], $smtp[:recipients]
+    assert_equal "no-reply@mydomain.com", $smtp[:from]
+
+    assert $smtp[:started]
+    assert $smtp[:finish]
+  end
+
+  test "calls #finish even when it fails during send_message" do |m|
+    class FakeSMTP
+      def send_message(*args)
+        raise
+      end
+    end
+
+    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
+
+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

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: malone-acd
+version: !ruby/object:Gem::Version
+  version: 1.0.7
+platform: ruby
+authors:
+- Cyril David
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mailfactory-acd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cutest-cj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: me@cyrildavid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- LICENSE
+- README.md
+- lib/malone.rb
+- lib/malone/test.rb
+- malone.gemspec
+- test/helper.rb
+- test/malone.rb
+homepage: http://github.com/cyx/malone
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Dead-simple Ruby mailing solution which always delivers.
+test_files: []