mail_builder19 1.0-java

data/Doubleshot

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+Doubleshot.new do |config|
+  config.project = "mail_builder19"
+  config.version = "1.0"
+  
+  config.gem "mime-types"
+  
+  config.gemspec do |spec|
+    spec.summary        = "MailBuilder is a simple library for building RFC compliant MIME emails."
+    spec.description    = <<-DESCRIPTION
+MailBuilder is a simple library for building RFC compliant MIME emails.
+DESCRIPTION
+    spec.homepage       = "https://github.com/sam/mail_builder"
+    spec.authors        = [ "Bernerd Schaefer", "Sam Smoot" ]
+    spec.email          = "ssmoot@gmail.com"
+    spec.license        = "MIT-LICENSE"
+  end
+end

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Bernerd J. Schaefer
+
+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,56 @@
+# MailBuilder
+
+[![Build Status](https://secure.travis-ci.org/sam/mail_builder.png)](http://travis-ci.org/sam/mail_builder)
+
+MailBuilder is a library for building RFC compliant MIME messages,
+with support for text and HTML emails, as well as attachments.
+
+## Basic Usage
+
+```ruby
+require 'rubygems'
+require 'mail_builder'
+
+mail = MailBuilder.new
+mail.to = "joe@example.com"
+mail.text = "Body"
+
+sendmail = IO.popen("#{`which sendmail`.chomp} -i -t", "w+")
+sendmail.puts mail
+sendmail.close
+```
+
+#### or
+
+```ruby
+require 'net/smtp'
+
+Net::SMTP.start("smtp.address.com", 25) do |smtp|
+  smtp.send_message(mail.to_s, mail.from, mail.to)
+end
+```
+
+## Advantages
+
+One of the key advantages to using MailBuilder over other libraries
+(such as MailFactory) is that costly operations - generating boundaries,
+reading attached files, etc. - are delayed until the physical message
+is built (by calling `build` or `to_s`).
+
+This gives you the freedom to generate many thousands of emails
+with almost no time-cost. The emails could then be passed to some
+external system - DRb, database - for final delivery.
+
+```ruby
+10_000.times do
+  mail = MailBuilder.new('to' => 'joe@example.com')
+  mail.html = View.new("mailers/large_mailer")
+  mail.attach("large_file.pdf")
+
+  ExternalMailServer.send!(mail)
+end
+```
+
+The external process would then build the email, at which point the
+view would be rendered and attachments read, while the local process
+would complete in very little (on my machine, sub-second) time.

data/lib/mail_builder.rb

@@ -0,0 +1,317 @@
+# encoding: UTF-8
+
+require "java"
+require "pathname"
+require "time"
+
+require "rubygems"
+require "mime/types"
+
+##
+# MailBuilder is a library for building RFC compliant MIME messages,
+# with support for text and HTML emails, as well as attachments.
+#
+# Basic Usage:
+#
+#   mail = MailBuilder.new
+#   mail.to = "joe@example.com"
+#   mail.text = "Body"
+#
+#   sendmail = IO.popen("#{`which sendmail`.chomp} -i -t", "w+")
+#   sendmail.puts mail
+#   sendmail.close
+#
+#   # or
+#
+#   require 'net/smtp'
+#
+#   Net::SMTP.start("smtp.address.com", 25) do |smtp|
+#     smtp.send_message(mail.to_s, mail.from, mail.to)
+#   end
+#
+##
+class MailBuilder
+  require Pathname(__FILE__).dirname + "mail_builder/attachment"
+
+  ##
+  # Boundary characters, slightly adapted from those allowed by rfc1341,
+  # representing:
+  #
+  #   ALPHA / DIGIT / "'" / "(" / ")" / "*" / "," / "-" / "." / "/" / ":"
+  #
+  # See 7.2.1, http://www.w3.org/Protocols/rfc1341/7_2_Multipart.html
+  ##
+  BOUNDARY_CHARS = ((39..58).to_a + (65..90).to_a + (97..122).to_a).map { |_| _.chr }.freeze
+
+  CHARSET = 'utf-8'.freeze
+
+  ##
+  # Printable characters which RFC 2047 says must be escaped.
+  ##
+  RFC2047_REPLACEMENTS = [
+    ['?', '=%X' % ??.ord],
+    ['_', '=%X' % ?_.ord],
+    [' ', '_'],
+    [/=$/, '']
+  ].freeze
+
+  attr_accessor :html, :text
+  attr_reader :headers, :attachments
+
+  ##
+  # Accepts an options hash, setting text and html if provided, and
+  # setting any provided headers.
+  #
+  #   mailer = MailBuilder.new(:text => "Text", :to => "admin@site.com", "X-Priority" => 1)
+  #   mailer.text # => "Text"
+  #   mailer.to # => "admin@site.com"
+  #   mailer.get_header("X-Priority") # => 1
+  ##
+  def initialize(options = {})
+    @headers = []
+    @attachments = []
+    @text = nil
+    @html = nil
+
+    parse_options(options)
+  end
+
+  ##
+  # Adds a header value to the mailer's headers, without removing
+  # previous values.
+  #
+  #   mailer.add_header("From", "admin@example.com")
+  #   mailer.add_header("From", "john@example.com")
+  #
+  #   mailer.headers # => [["From", "admin@example.com"], ["From", "admin@example.com"]]
+  ##
+  def add_header(key, value)
+    @headers << [key.to_s, value]
+  end
+
+  ##
+  # Retrieves a value from the mailer's headers.
+  #
+  #   mailer.get_header("to") # => "admin@example.com"
+  ##
+  def get_header(key)
+    @headers.detect { |k, v| return v if k == key }
+  end
+  alias [] get_header
+
+  def remove_header(key)
+    @headers.reject! { |k,| k == key }
+  end
+
+  ##
+  # Adds a header value to the mailer's headers, replacing previous values.
+  #
+  #   mailer.add_header("From", "admin@example.com")
+  #   mailer.set_header("From", "john@example.com")
+  #
+  #   mailer.headers # => [["From", "admin@example.com"]]
+  ##
+  def set_header(key, value)
+    remove_header(key)
+    add_header(key, value)
+  end
+  alias []= set_header
+
+  ##
+  # Returns the envelope id for this mailer. The mail spec's ENV_ID is
+  # used to provide a unique identifier that follows an email through it's
+  # various states -- including bounces -- allowing it to be tracked.
+  ##
+  def envelope_id
+    @envelope_id ||= java.util.UUID.random_uuid.to_s
+  end
+
+  ##
+  # We define getters and setters for commonly used headers.
+  ##
+  %w(from to cc bcc reply_to subject).each do |header|
+    define_method(header) do
+      get_header(header)
+    end
+
+    define_method(header + "=") do |value|
+      set_header(header, value)
+    end
+  end
+
+  ##
+  # Wrapper for attach_as, setting the attachment filename to the file's
+  # basename.
+  #
+  #   mailer.attach "some/file.pdf"
+  ##
+  def attach(file, type = nil, headers = nil)
+    file = Pathname(file)
+
+    attach_as(file, file.basename, type, headers)
+  end
+
+  ##
+  # Adds an Attachment to the email.
+  #
+  # If file is an IO or File object, it's contents will be read immediately, in case
+  # the mail will be delivered to an external service without access to the object.
+  # Otherwise, the attached file's content will be read when the message is built.
+  #
+  # If no type is provided, the MIME::Types library will be used to find a suitable
+  # content type.
+  #
+  #   mailer.attach "account.html"
+  #   mailer.attach_as StringIO.new("test"), "account.txt"
+  #
+  ##
+  def attach_as(file, name, type = nil, headers = nil)
+    @attachments << Attachment.new(file, name, type, headers)
+  end
+
+  def multipart?
+    attachments? || @html
+  end
+
+  def attachments?
+    @attachments.any?
+  end
+
+  ##
+  # Builds the full email message suitable to be passed to Sendmail, Net::SMTP, etc.
+  #
+  # It sets the Mail-From header (used for tracking emails), date, and message id,
+  # and then assembles the headers, body, and attachments.
+  #
+  # All expensive operations -- generating boundaries, rendering views, reading
+  # attached files -- are delayed until this method is called.
+  ##
+  def build
+    set_header("Mail-From", "#{ENV["USER"]}@localhost ENVID=#{envelope_id}")
+    set_header("Date", Time.now.rfc2822)
+    set_header("Message-ID", "<#{Time.now.to_f}.#{Process.pid}@#{get_header("from").to_s.split("@", 2)[1]}>")
+
+    if multipart?
+      set_header("Mime-Version", "1.0")
+      if attachments?
+        set_header("Content-Type", "multipart/mixed; boundary=\"#{attachment_boundary}\"")
+      else
+        set_header("Content-Type", "multipart/alternative; boundary=\"#{body_boundary}\"")
+      end
+    end
+
+    build_headers + build_body
+  end
+  alias to_s build
+
+  private
+
+  def build_headers
+    @headers.map do |header, value|
+      header = header.gsub("_", "-")
+      key = header.downcase
+
+      value = quote(value, 'rfc2047') if key == "subject"
+      value = quote_address(value) if %w(from to cc bcc reply-to).include?(key)
+
+      "#{header}: #{value}"
+    end.join("\r\n") + "\r\n\r\n"
+  end
+
+  def build_body
+    return @text.to_s unless multipart?
+
+    body = []
+    body << "This is a multi-part message in MIME format."
+    body << "--#{attachment_boundary}\r\nContent-Type: multipart/alternative; boundary=\"#{body_boundary}\""
+
+    body << build_body_boundary('text/plain')
+    body << quote(@text)
+
+    body << build_body_boundary('text/html')
+    body << quote(@html)
+
+    body << "--#{body_boundary}--"
+
+    if attachments?
+      @attachments.each do |attachment|
+        body << build_attachment_boundary(attachment)
+        body << attachment
+        body << "\r\n--#{attachment_boundary}--"
+      end
+    end
+
+    body.join("\r\n\r\n")
+  end
+
+  def build_body_boundary(type)
+    boundary = []
+    boundary << "--#{body_boundary}"
+    boundary << "Content-Type: #{type}; charset=#{CHARSET}#{'; format=flowed' if type == 'text/plain'}"
+    boundary << "Content-Transfer-Encoding: quoted-printable"
+    boundary.join("\r\n")
+  end
+
+  def build_attachment_boundary(attachment)
+    boundary = []
+    boundary << "--#{attachment_boundary}"
+    boundary << "Content-Type: #{attachment.type}; name=\"#{attachment.name}\""
+    boundary << "Content-Transfer-Encoding: base64"
+    boundary << "Content-Disposition: inline; filename=\"#{attachment.name}\""
+
+    boundary.push(*attachment.headers) if attachment.headers
+
+    boundary.join("\r\n")
+  end
+
+  def generate_boundary
+    "----=_NextPart_" + (1..25).map { BOUNDARY_CHARS[rand(BOUNDARY_CHARS.size)] }.join
+  end
+
+  def attachment_boundary
+    @attachment_boundary ||= generate_boundary
+  end
+
+  def body_boundary
+    @body_boundary ||= generate_boundary
+  end
+
+  def parse_options(options)
+    options.each do |key, value|
+      case key
+      when :html
+        self.html = value
+      when :text
+        self.text = text
+      else
+        set_header(key, value)
+      end
+    end
+  end
+
+  def quote(text, method = 'rfc2045')
+    return unless text
+
+    self.send("#{method}_encode", text)
+  end
+
+  def quote_address(address)
+    return address.map { |a| quote_address(a) }.join(", ") if address.is_a?(Array)
+
+    address.gsub(/['"](.+?)['"]\s+(<.+?>)/) do
+      "\"#{quote($1, 'rfc2047')}\" #{$2}"
+    end
+  end
+
+  def rfc2047_encode(text)
+    text = text.enum_for(:each_byte).map { |ord| ord < 128 && ord != ?=.ord ? ord.chr : "=%X" % ord }.join.chomp
+
+    RFC2047_REPLACEMENTS.each { |replacement| text.gsub!(*replacement) }
+
+    "=?#{CHARSET}?Q?#{text}?="
+  end
+
+  def rfc2045_encode(text)
+    [text].pack('M').gsub("\n", "\r\n").chomp("=\r\n")
+  end
+end

data/lib/mail_builder/attachment.rb

@@ -0,0 +1,35 @@
+class MailBuilder
+  class Attachment
+
+    attr_accessor :file, :name, :type, :headers
+
+    def initialize(file, name, type, headers)
+      @file = file
+      @name = name
+      @type = type
+      @headers = headers
+
+      # If we have a File/IO object, read it. Otherwise, we'll read it lazily.
+      @body = file.read() if !file.kind_of?(Pathname) && file.respond_to?(:read)
+    end
+
+    def to_s
+      @body ||= File.open(file.to_s(), "rb") { |f| f.read() }
+
+      [@body].pack("m")
+    end
+
+    def name
+      @name
+    end
+
+    def type
+      @type ||= MIME::Types.type_for(@name.to_s).to_s
+    end
+
+    def inspect
+      "#<MailBuilder::Attachment @file=#{@file.inspect}> @name=#{@name.inspect} @type=#{@type.inspect} @headers=#{@headers.inspect}"
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,30 @@
+require "doubleshot/setup"
+
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/wscolor"
+
+require Pathname(__FILE__).dirname.parent + "lib/mail_builder"
+
+(MailBuilder.private_instance_methods - Object.private_instance_methods).each do |method|
+  MailBuilder.send(:public, method)
+end
+
+def mailer(options = {})
+  MailBuilder.new(options)
+end
+
+module MiniTest
+  module Assertions
+    def assert_nothing_raised *args
+      yield
+      assert true, "Nothing raised"
+    rescue Exception => e
+      fail "Expected nothing raised, but got #{e.class}: #{e.message}"
+    end
+  end
+
+  module Expectations
+    infect_an_assertion :assert_nothing_raised, :wont_raise
+  end
+end

data/test/mail_builder_spec.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env jruby
+
+# encoding: UTF-8
+
+require File.dirname(__FILE__) + '/helper'
+
+describe MailBuilder do
+
+  it "must encode recipients properly" do
+    mailer(:to => "bernerd@wieck.com").build_headers.strip
+      .must_equal "to: bernerd@wieck.com"
+    
+    mailer(:to => '"Bernerd" <bernerd@wieck.com>').build_headers.strip
+      .must_equal "to: \"=?utf-8?Q?Bernerd?=\" <bernerd@wieck.com>"
+  end
+
+  it "must encode multiple recipients properly" do
+    desired_to = 'to: "=?utf-8?Q?Bernerd?=" <bernerd@wieck.com>, "=?utf-8?Q?Adam?=" <adam@wieck.com>'
+    
+    mailer(:to => '"Bernerd" <bernerd@wieck.com>, "Adam" <adam@wieck.com>')
+      .build_headers.strip.must_equal desired_to
+    mailer(:to => ['"Bernerd" <bernerd@wieck.com>', '"Adam" <adam@wieck.com>'])
+      .build_headers.strip.must_equal desired_to
+  end
+
+  it "must encode all addresses" do
+    [ "from", "to", "cc", "bcc", "reply-to" ].each do |field|
+      mailer(field => '"Bernerd" <bernerd@wieck.com>').build_headers.strip
+        .must_equal "#{field}: \"=?utf-8?Q?Bernerd?=\" <bernerd@wieck.com>"
+    end
+  end
+
+  it "must rfc2045 encode properly" do
+    mailer.rfc2045_encode('<a href="http://google.com">Google</a>')
+      .must_equal '<a href=3D"http://google.com">Google</a>'
+  end
+
+  it "must rfc2047 encode properly" do
+    mailer.rfc2047_encode("This + is = a _ test * subject")
+      .must_equal "=?utf-8?Q?This_+_is_=3D_a_=5F_test_*_subject?="
+      
+    mailer.rfc2047_encode("\303\244\303\244\303\244\303\266\303\266\303\266")
+      .must_equal "=?utf-8?Q?=C3=A4=C3=A4=C3=A4=C3=B6=C3=B6=C3=B6?="
+  end
+
+  it "mailer must not error on build if empty" do
+    -> { mailer.to_s }.wont_raise
+  end
+
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: mail_builder19
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease:
+platform: java
+authors:
+- Bernerd Schaefer
+- Sam Smoot
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: doubleshot
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+description: |
+  MailBuilder is a simple library for building RFC compliant MIME emails.
+email: ssmoot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- test/helper.rb
+- test/mail_builder_spec.rb
+- Doubleshot
+- MIT-LICENSE
+- README.md
+- lib/mail_builder/attachment.rb
+- lib/mail_builder.rb
+homepage: https://github.com/sam/mail_builder
+licenses:
+- MIT-LICENSE
+post_install_message:
+rdoc_options:
+- --line-numbers
+- --main
+- README.textile
+- --title
+- mail_builder19 Documentation
+- lib
+- README.textile
+require_paths:
+- lib
+- target
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: MailBuilder is a simple library for building RFC compliant MIME emails.
+test_files:
+- test/helper.rb
+- test/mail_builder_spec.rb