system_mail 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Igor Bochkariov
+
+MIT License
+
+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,55 @@
+[![Build Status](https://travis-ci.org/ujifgc/system_mail.png)](https://travis-ci.org/ujifgc/system_mail)
+[![Code Climate](https://codeclimate.com/github/ujifgc/system_mail.png)](https://codeclimate.com/github/ujifgc/system_mail)
+
+## Introduction
+
+SystemMail is a Ruby library built to compose and deliver internet mail using
+operating system utilities.
+
+SystemMail features:
+
+* tiny memory footprint even with big attachments
+* blazing-fast gem loading and message composing
+* alternating message body format: text, enriched, HTML
+* rich capabilities in attaching files
+* ability to combine HTML message with file attachments
+
+Operating system commands used to do the job are:
+
+* `sendmail -t < temp` or alternative sends the message to Mail Transfer Agent
+* `base64 file >> temp` encodes binary files to textual form
+* `file --mime-type --mime-encoding -b file` detects Content-Type and charset
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'system_mail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install system_mail
+
+## Usage
+
+    mail = SystemMail.new(
+      from: 'user@example.com',
+      to: ['user1@gmail.com', 'user2@gmail.com'],
+      subject: 'test проверочный subject',
+      files: ['Gemfile', 'Gemfile.lock'],
+      text: 'big small норм',
+      html: File.read('test.html')
+    )
+    mail.deliver
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new :test do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/lib/system_mail/message.rb

@@ -0,0 +1,251 @@
+require 'base64'
+require 'shellwords'
+require 'system_mail/storage'
+
+module SystemMail
+  ##
+  # Manages compiling an email message from various attributes and files.
+  #
+  class Message
+    BASE64_SIZE = 76
+    UTF8_SIZE = 998
+    SETTINGS = {
+      :sendmail => '/usr/sbin/sendmail -t',
+      :base64 => 'base64',
+      :file => 'file --mime-type --mime-encoding -b',
+      :storage => ENV['TMP'] || '/tmp',
+    }.freeze
+
+    ##
+    # Creates new message. Available options:
+    #
+    # - :text, String, Textual part of the message
+    # - :enriched, String, Enriched alternative of the message (RFC 1896)
+    # - :html, String, HTML alternative of the message
+    # - :from, String, 'From:' header for the message
+    # - :to, String or Array of Strings, 'To:' header, if Arrey, it gets joined by ', '
+    # - :subject, String, Subject of the message, it gets encoded automatically
+    # - :files, File or String of file path or Array of them, Attachments of the message
+    #
+    # Options :text, :enriched and :html are interchangeable.
+    # Option :to is required.
+    #
+    # Examples:
+    #
+    #   mail = Message.new(
+    #     :from        => 'user@example.com',
+    #     :to          => 'user@gmail.com',
+    #     :subject     => 'test subject',
+    #     :text        => 'big small normal',
+    #     :html        => File.read('test.html'),
+    #     :attachments => [File.open('Gemfile'), 'attachment.zip'],
+    #   )
+    #
+    def initialize(options={})
+      @body = {}
+      @to = []
+      @mutex = Mutex.new
+      %W(text enriched html from to subject attachments).each do |option|
+        name = option.to_sym
+        send(name, options[name])
+      end
+    end
+
+    ##
+    # Delivers the message using sendmail.
+    #
+    # Example:
+    #
+    #   mail.deliver #=> nil
+    #
+    def deliver
+      validate
+      with_storage do
+        write_headers
+        write_message
+        send_message
+      end
+    end
+
+    def settings
+      @settings ||= SETTINGS.dup
+    end
+
+    private
+
+    def text(input)
+      @body['text'] = input
+    end
+
+    def enriched(input)
+      @body['enriched'] = input
+    end
+
+    def html(input)
+      @body['html'] = input
+    end
+
+    def from(input)
+      @from = input
+    end
+
+    def to(input)
+      @to += Array(input)
+    end
+
+    def subject(input)
+      @subject = input
+    end
+
+    def attachments(input)
+      input && input.each{ |file| add_file(*file) }
+    end
+
+    def add_file(name, path = nil)
+      path ||= name
+      name = File.basename(name)
+      files[name] = path
+    end
+
+    def files
+      @files ||= {}
+    end
+
+    def with_storage
+      @mutex.synchronize do
+        @storage = Storage.new settings[:storage]
+        yield
+        @storage.clear
+        @storage = nil
+      end
+    end
+
+    def write_message
+      if files.any?
+        multipart :mixed do |boundary|
+          write_part boundary
+          write_body
+          files.each_pair do |name, path|
+            write_part boundary
+            write_file name, path
+          end
+        end
+      else
+        write_body
+      end
+    end
+
+    def write_body
+      case @body.length
+      when 0
+        nil
+      when 1
+        data, type = @body.first
+        write_content data, "text/#{type}"
+      else
+        multipart :alternative do |boundary|
+          %w[text enriched html].each do |type|
+            data = @body[type] || next
+            write_part boundary
+            write_content data, "text/#{type}"
+          end
+        end
+      end
+    end
+
+    def write_content(data, content_type)
+      if data.bytesize < UTF8_SIZE || !data.lines.any?{ |line| line.bytesize > UTF8_SIZE }
+        write_8bit_data data, content_type
+      else
+        write_base64_data data, content_type
+      end
+    end
+
+    def multipart(type)
+      boundary = new_boundary(type)
+      @storage.puts "Content-Type: multipart/#{type}; boundary=\"#{boundary}\""
+      yield boundary
+      write_part boundary, :end
+    end
+
+    def write_headers
+      @storage.puts "From: #{@from}"  if @from
+      @storage.puts "To: #{@to.join(', ')}"
+      @storage.puts "Subject: #{encode_subject}"
+    end
+
+    def write_part(boundary, type = :begin)
+      @storage.puts
+      @storage.puts "--#{boundary}#{type == :end ? '--' : ''}"
+    end
+
+    def write_base64_data(data, content_type)
+      @storage.puts "Content-Type: #{content_type}; charset=#{data.encoding}"
+      @storage.puts "Content-Transfer-Encoding: base64"
+      @storage.puts
+      Base64.strict_encode64(data).each_slice(BASE64_SIZE) do |line|
+        @storage.puts line
+      end
+    end
+
+    def write_8bit_data(data, content_type)
+      @storage.puts "Content-Type: #{content_type}; charset=#{data.encoding}"
+      @storage.puts "Content-Transfer-Encoding: 8bit"
+      @storage.puts
+      @storage.puts data
+    end
+
+    def write_file(name, file)
+      path = case file
+      when String
+        fail Errno::ENOENT, file  unless File.file?(file)
+        fail Errno::EACCES, file  unless File.readable?(file)
+        file
+      when File
+        file.path
+      else
+        fail ArgumentError, 'attachment must be File or String of file path'
+      end
+      write_base64_file name, path
+    end
+
+    def write_base64_file(name, path)
+      @storage.puts "Content-Type: #{read_mime(path)}"
+      @storage.puts "Content-Transfer-Encoding: base64"
+      @storage.puts "Content-Disposition: attachment; filename=\"#{name}\""
+      @storage.puts
+      @storage.capture do |message_path|
+        `#{settings[:base64]} '#{path.shellescape}' >> #{message_path}`
+      end
+    end
+
+    def send_message
+      if @storage.file?
+        @storage.capture do |message_path|
+          `#{settings[:sendmail]} < #{message_path}`
+        end
+      else
+        IO.popen(settings[:sendmail]) do |io|
+          io.write(@storage.read)
+        end
+      end
+    end
+
+    def read_mime(file_path)
+      `#{settings[:file]} '#{file_path.shellescape}'`.strip
+    end
+
+    def validate
+      fail ArgumentError, "Header 'To:' is empty" if @to.empty?
+      warn 'Message body is empty' if @body.empty?
+    end
+
+    def new_boundary(type)
+      rand(36**6).to_s(36).rjust(20,type.to_s)
+    end
+
+    def encode_subject
+      @subject.ascii_only? ? @subject : "=?UTF-8?B?#{Base64.strict_encode64 @subject}?="
+    end
+  end
+end

data/lib/system_mail/storage.rb

@@ -0,0 +1,59 @@
+require 'tempfile'
+require 'fileutils'
+
+module SystemMail
+  ##
+  # A class to store string data either in StringIO or in Tempfile.
+  #
+  class Storage
+    def initialize(path = nil)
+      @tmpdir = path || Dir.tmpdir
+      @io = StringIO.new
+    end
+
+    def puts(data = nil)
+      @io.puts(data)
+    end
+
+    def read
+      if file?
+        capture do |file_path|
+          File.read file_path
+        end
+      else
+        @io.string.dup
+      end
+    end
+
+    def capture
+      ensure_tempfile
+      @io.close
+      yield @io.path
+      @io.open
+    end
+
+    def file?
+      @io.kind_of?(Tempfile)
+    end
+
+    def clear
+      @io.close
+      @io.unlink if file?
+    end
+
+    private
+
+    def ensure_tempfile
+      return if file?
+      tempfile = create_tempfile
+      tempfile.puts @io.string if @io.size > 0
+      @io = tempfile
+    end
+
+    def create_tempfile
+      temp_directory = File.join(@tmpdir, 'system_mail')
+      FileUtils.mkdir_p(temp_directory)
+      Tempfile.new('storage', temp_directory, :mode => IO::APPEND)
+    end
+  end
+end

data/lib/system_mail/version.rb

@@ -0,0 +1,3 @@
+module SystemMail
+  VERSION = "0.0.2"
+end

data/lib/system_mail.rb

@@ -0,0 +1,17 @@
+require 'system_mail/version'
+require 'system_mail/message'
+
+module SystemMail
+  def self.new(options = {}, &block)
+    message = Message.new(options)
+    message.instance_eval(&block) if block_given?
+    message
+  end
+
+  def self.email(options = {}, &block)
+    message = SystemMail.new(options, &block)
+    message.deliver
+  end
+end
+
+Mail = SystemMail

data/system_mail.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'system_mail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "system_mail"
+  spec.version       = SystemMail::VERSION
+  spec.authors       = ["Igor Bochkariov"]
+  spec.email         = ["ujifgc@gmail.com"]
+  spec.description   = 'A Ruby library built to compose and deliver internet mail using operating system utilities.'
+  spec.summary       = 'SystemMail is a blazing-fast Ruby Mail alternative with tiny memory footprint.'
+  spec.homepage      = "https://github.com/ujifgc/system_mail"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/fixtures/test.html

@@ -0,0 +1 @@
+<small>small</small> <big>big</big> нормал

data/test/minitest_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'system_mail'

data/test/system_mail/system_mail-storage_test.rb

@@ -0,0 +1,53 @@
+#coding:utf-8
+require 'minitest_helper'
+
+describe SystemMail::Storage do
+  before do
+    SystemMail::Storage.class_eval{ attr_accessor :io }
+    @fixture_path = File.expand_path('../fixtures/test.html', File.dirname(__FILE__))
+    @fixture = File.read @fixture_path
+    @s = SystemMail::Storage.new
+  end
+
+  after do
+    @s.clear
+  end
+
+  it 'should properly initialize' do
+    assert_kind_of StringIO, @s.io
+  end
+
+  it 'should properly write strings' do
+    2.times do
+      @s.puts 'line1'
+      @s.puts 'а также линия'
+      @s.puts
+    end
+    assert_equal "line1\nа также линия\n\n"*2, @s.io.string
+    assert_kind_of StringIO, @s.io
+  end
+
+  it 'should properly write and append files with commandline' do
+    2.times do
+      @s.capture do |path|
+        `cat '#{@fixture_path}' >> '#{path}'`
+      end
+    end
+    assert_equal @fixture*2, File.read(@s.io.path)
+    assert_kind_of Tempfile, @s.io
+    assert_match /system_mail(.*)storage/, @s.io.path
+  end
+
+  it 'should properly mix strings and files' do
+    2.times do
+      @s.puts 'line1'
+      @s.puts 'а также линия'
+      @s.puts
+      @s.capture do |path|
+        File.open(path, 'a') { |f| f.write @fixture }
+      end
+    end
+    assert_equal ("line1\nа также линия\n\n"+@fixture)*2, File.read(@s.io.path)
+    assert_kind_of Tempfile, @s.io
+  end
+end

data/test/system_mail/system_mail_test.rb

@@ -0,0 +1 @@
+require 'minitest_helper'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: system_mail
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Igor Bochkariov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby library built to compose and deliver internet mail using operating
+  system utilities.
+email:
+- ujifgc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/system_mail.rb
+- lib/system_mail/message.rb
+- lib/system_mail/storage.rb
+- lib/system_mail/version.rb
+- system_mail.gemspec
+- test/fixtures/test.html
+- test/minitest_helper.rb
+- test/system_mail/system_mail-storage_test.rb
+- test/system_mail/system_mail_test.rb
+homepage: https://github.com/ujifgc/system_mail
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: SystemMail is a blazing-fast Ruby Mail alternative with tiny memory footprint.
+test_files:
+- test/fixtures/test.html
+- test/minitest_helper.rb
+- test/system_mail/system_mail-storage_test.rb
+- test/system_mail/system_mail_test.rb
+has_rdoc: