simple_mail_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 491fbcb4035815dd0a9d1b427d99c63ba3977d51
+  data.tar.gz: b02098db9e11f486d13988ed4809681f7493d187
+SHA512:
+  metadata.gz: aa5307bb25bfe318efaf1c27d7e0bbf6cdbc898f013e78f299092417d6733c5af06631b9d8c3b4666f0fffd2a0b66e62234f3f33913aaad706af0a139c01aeb2
+  data.tar.gz: 808ce9eb28006662c925251c79402604df5024b58c27688dea659efaa2b1dfa52b9c49485ad4be631b64ef2e2ac4eb3a6ca5a47bbb586e1de4b1778d9570638b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_mail_builder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rodrigo Rosenfeld Rosas
+
+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,83 @@
+# SimpleMailBuilder
+
+SimpleMailBuilder makes it easier to create simple multi-part plain text + HTML mail messages,
+following the most important rules from RFC2047 and RFC2045. Simple messages have the following
+headers: To, From and Subject. They have a text part, an HTML part and no attachments.
+
+For a more complete full-specs implementation use the well known "mail" gem.
+I created this gem because the "mail" gem will patch core classes (String mostly) and I wanted
+to avoid monkey patches in my application. Also, it adds quite some overhead and I find its code
+base is a bit complicated to understand and wanted to rely on something simpler to reason about.
+
+My application doesn't need to do anything complex with e-mails. It just has to deliver a
+simple multi-part text + HTML message with no attachments to an SMTP server and it doesn't have
+to handle edge cases, like handling chars limits in headers and so on. If you don't have
+much control over your messages, it's better to use another library for creating mail messages.
+
+All messages are creating using the UTF-8 charset to make the code simpler. All inputs are
+expected to be in UTF-8 encoding already, so if you are reading the content from some file in
+another encoding you should make sure you convert to UTF-8 before using this library.
+
+It uses a static '--MESSAGE BOUNDARY--' as the boundary by default, so if your messages could
+contain such text embedded you should take care of providing a valid boundary yourself as
+this library won't handle such edge cases.
+
+From and To addresses should be either a plain single e-mail or a Hash mapping e-mails to the
+names ({'User Name' => 'user@name.com'}). You may use the e-mail as the key too
+when you don't have a corresponding name and in that case the name would be ignored when
+generating the headers and just the e-mail would be used.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_mail_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_mail_builder
+
+## Usage
+
+```ruby
+    require 'net/smtp'
+    require 'simple_mail_builder'
+    message = SimpleMailBuilder::Message.new(
+      to: {'Recipient' => 'to@domain.com'},
+      from: 'from@domain.com', subject: 'Message subject',
+      text: "Header\n\nFirst line\nLast line",
+      html: '<h1>Header</h1><p>First line</p><p>Last line</p>'
+    ).to_s
+    Net::SMTP.start('localhost', 1025) do |smtp|
+      smtp.send_message message, 'from@domain.com', 'to@domain.com'
+    end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to
+run the tests. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags, and push the `.gem`
+file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on the
+[GitHub repo](https://github.com/rosenfeld/simple_mail_builder).
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'simple_mail_builder'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_mail_builder/encoder/base64.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'base64'
+require_relative '../encoder'
+
+module SimpleMailBuilder
+  module Encoder
+    module Base64
+      def self.encode_or_quote(text)
+        return %Q{"#{text.gsub '"', ''}"} unless ENCODED_REGEX =~ text
+        "=?UTF-8?B?#{::Base64.strict_encode64 text}?="
+      end
+    end
+  end
+end

data/lib/simple_mail_builder/encoder/quote.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../encoder'
+
+# See RFC2047 to fully understand how "B" and "Q" encondings work.
+# Basically only ASCII chars are allowed to go unencoded, although they may be encoded.
+# Exceptions are espaces (' '), which can be encoded as underscore ('_') alternatively to
+# the default encoding system described below, and the following chars that must be encoded:
+# '=', '?', '_' and tabs. Encoded chars are represented as '=XX' where XX is the hexadecimal
+# representation in the message charset with 2 digits.
+module SimpleMailBuilder
+  module Encoder
+    module Quote
+      def self.encode_if_required(text)
+        return text unless ENCODED_REGEX =~ text
+        text = text.gsub(ENCODED_REGEX){ |c| c.bytes.map{|b| '=%02X' % b }.join }.gsub /\s+/, '_'
+        "=?UTF-8?Q?#{text}?="
+      end
+    end
+  end
+end

data/lib/simple_mail_builder/encoder.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module SimpleMailBuilder
+  module Encoder
+    # a white list seems safer to me. We are allowed to encode all chars, but the purpose of
+    # Q encoding is to allow us to quickly inspect its content without decoding, so we allow
+    # the more common chars to skip the encoding.
+    # Alternatively we could replace only =, ?, _ and tabs (and newlines/control chars?),
+    # but I think a white list is simpler to implement without introducing bugs.
+    ENCODED_REGEX = %r{[^a-zA-Z0-9\.\-\+/\"\'\&\(\)\<\>!:%$#@;\[\]\*\s]}
+  end
+end

data/lib/simple_mail_builder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleMailBuilder
+  VERSION = '0.1.0'
+end

data/lib/simple_mail_builder.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'digest/md5'
+require_relative 'simple_mail_builder/version'
+require_relative 'simple_mail_builder/encoder/quote'
+require_relative 'simple_mail_builder/encoder/base64'
+
+module SimpleMailBuilder
+  class Message
+    def initialize(from: , to: , subject: , text: , html: , boundary: '--MESSAGE BOUNDARY--',
+                   date: Time.now, domain: 'local.mail')
+      from, to = [from, to].map do |address|
+        next address if String === address # otherwise we assume it's a Hash
+        address.map do |name, email|
+          name == email ? email : "#{Encoder::Base64.encode_or_quote(name)} <#{email}>"
+        end.join ", \r\n "
+      end
+      text, html = [text, html].map{|s| [s].pack('M').chomp("=\n").gsub "\n", "\r\n"}
+      message = []
+      fdate = date.strftime '%a, %d %b %Y %H:%M:%S %z'
+      message << "Date: #{fdate}"
+      message << "From: #{from}"
+      message << "To: #{to}"
+      message_id = Digest::MD5.hexdigest [fdate, to, text, html].join
+      message << "Message-ID: <#{message_id}@#{domain}>"
+      message << "Subject: #{Encoder::Quote.encode_if_required subject}"
+      message << 'Mime-Version: 1.0'
+      message << 'Content-Type: multipart/alternative;'
+      message << %Q{ boundary="#{boundary}";}
+      message << ' charset=UTF-8'
+      message << 'Content-Transfer-Encoding: 7bit'
+      message << '' << ''
+      message << "--#{boundary}"
+      message << 'Content-Type: text/plain; charset=UTF-8; format=flowed'
+      message << 'Content-Transfer-Encoding: quoted-printable'
+      message << ''
+      message << text
+      message << ''
+      message << "--#{boundary}"
+      message << 'Content-Type: text/html; charset=UTF-8'
+      message << 'Content-Transfer-Encoding: quoted-printable'
+      message << ''
+      message << html
+      message << ''
+      message << "--#{boundary}--"
+      @message = message.join "\r\n"
+    end
+
+    def to_s
+      @message
+    end
+  end
+end

data/simple_mail_builder.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# coding: utf-8
+
+require_relative 'lib/simple_mail_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_mail_builder'
+  spec.version       = SimpleMailBuilder::VERSION
+  spec.authors       = ['Rodrigo Rosenfeld Rosas']
+  spec.email         = ['rr.rosas@gmail.com']
+
+  spec.summary       = %q{Build mail messages for simple plain text + HTML multipart messages.}
+  spec.description   = %q{No monkey patches or advanced usage, low footprint.}
+  spec.homepage      = 'https://github.com/rosenfeld/simple_mail_builder'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: simple_mail_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Rosenfeld Rosas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: No monkey patches or advanced usage, low footprint.
+email:
+- rr.rosas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_mail_builder.rb
+- lib/simple_mail_builder/encoder.rb
+- lib/simple_mail_builder/encoder/base64.rb
+- lib/simple_mail_builder/encoder/quote.rb
+- lib/simple_mail_builder/version.rb
+- simple_mail_builder.gemspec
+homepage: https://github.com/rosenfeld/simple_mail_builder
+licenses:
+- MIT
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Build mail messages for simple plain text + HTML multipart messages.
+test_files: []