mail-x_smtpapi 1.0.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c8f40288af6ce36eda5971ed93ede0bdb8cf077
+  data.tar.gz: 7f79cd1c3ab012ae3ddee78820d42e1e6b5500c8
+SHA512:
+  metadata.gz: 0be1d7588bd5278f3f042744254d2dc939a22df7c537d2ecdb1ce1de722aee27e6a30b102e8da8407d4b2137cabc7f89df3bccba07a42bd2c30cad1cca777a3c
+  data.tar.gz: f553f34ef34eedf8da1e84604b2f0023bc6e11618c2572540184f8af5cbd9311d10eef25a7fef173537d0a7f51184d0a4b7c4d49f6846316952d2cb88f245ee9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mail-x_smtpapi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kickstarter, Inc
+
+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,43 @@
+# Mail::X::Smtpapi
+
+Integrates a custom X-SMTPAPI field into the [Mail](https://github.com/mikel/mail) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mail-x_smtpapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mail-x_smtpapi
+
+## Usage
+
+Write into the SMTPAPI header from anywhere with access to the `mail` object.
+
+### Example: Rails Mailer
+
+(TODO)
+
+### Example: Template Helper
+
+(TODO)
+
+### Example: Mail Interceptor
+
+(TODO)
+
+## Contributing
+
+1. Fork it ( https://github.com/kickstarter/mail-x_smtpapi/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/mail/x_smtpapi.rb

@@ -0,0 +1,24 @@
+require_relative '../mail_x_smtpapi/field'
+require 'mail'
+
+module Mail
+  class Message
+    def smtpapi
+      header.smtpapi
+    end
+  end
+
+  class Header
+    def smtpapi
+      name = MailXSMTPAPI::Field::FIELD_NAME
+      self.fields << Field.new(name) unless self[name]
+      self[name]
+    end
+  end
+end
+
+MailXSMTPAPI::Field::FIELD_NAME.tap do |name|
+  Mail::Field::FIELDS_MAP[name]     = MailXSMTPAPI::Field
+  Mail::Field::FIELD_NAME_MAP[name] = MailXSMTPAPI::Field::CAPITALIZED_FIELD
+  Mail::Header::LIMITED_FIELDS      << name
+end

data/lib/mail_x_smtpapi.rb

@@ -0,0 +1,5 @@
+# library
+require 'mail_x_smtpapi/field'
+
+# integration
+require 'mail/x_smtpapi'

data/lib/mail_x_smtpapi/accessors.rb

@@ -0,0 +1,58 @@
+module MailXSMTPAPI
+
+  module Recipients
+    def to
+      value['to'] ||= []
+    end
+
+    def to=(val)
+      val = [val] unless val.is_a? Array
+      to.replace val
+    end
+  end
+
+  module Substitutions
+    def substitutions
+      value['sub'] ||= {}
+    end
+
+    def substitutions=(val)
+      raise ArgumentError unless val.is_a? Hash
+      substitutions.replace(val)
+    end
+
+    def merge_substitutions(name, val)
+      substitutions[name] ||= []
+      val = [val] unless val.is_a? Array
+      substitutions[name].concat val.map(&:to_s)
+    end
+  end
+
+  module UniqueArguments
+    def unique_args
+      value['unique_args'] ||= {}
+    end
+
+    def unique_args=(val)
+      raise ArgumentError unless val.is_a? Hash
+      unique_args.replace(val)
+    end
+  end
+
+  module Category
+    def category
+      value['category']
+    end
+
+    def category=(val)
+      value['category'] = val
+    end
+  end
+
+  module Filters
+    def filters
+      value['filters'] ||= {}
+    end
+  end
+
+end

data/lib/mail_x_smtpapi/field.rb

@@ -0,0 +1,39 @@
+require 'mail'
+require_relative 'accessors'
+
+module MailXSMTPAPI
+  class Field < ::Mail::StructuredField
+    FIELD_NAME = 'x-smtpapi'
+    CAPITALIZED_FIELD = 'X-SMTPAPI'
+
+    # Accessors
+    include Recipients
+    include Substitutions
+    include UniqueArguments
+    include Category
+    include Filters
+
+    def initialize(value = nil, charset = 'utf-8')
+      super(FIELD_NAME, value || {}, charset)
+    end
+
+    # emits JSON with extra spaces inserted for line wrapping.
+    def encoded
+      if empty?
+        ''
+      else
+        "#{CAPITALIZED_FIELD}: #{JSON.generate(value).gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3')}\r\n"
+      end
+    end
+
+    # the decoded version is good for interacting with the header in code
+    # see: Mail::StructuredField#default
+    def decoded
+      value
+    end
+
+    def empty?
+      value.values.all?{|v| !v || v.empty? }
+    end
+  end
+end

data/lib/mail_x_smtpapi/version.rb

@@ -0,0 +1,3 @@
+module MailXSMTPAPI
+  VERSION = '1.0.0.alpha'
+end

data/mail-x_smtpapi.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mail_x_smtpapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mail-x_smtpapi"
+  spec.version       = MailXSMTPAPI::VERSION
+  spec.authors       = ["Lance Ivy"]
+  spec.email         = ["lance@kickstarter.com"]
+  spec.summary       = %q{Adds SendGrid X-SMTPAPI header support to Mail}
+  spec.homepage      = "https://github.com/kickstarter/mail-x_smtpapi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "mail", "> 2.6.0"
+end

data/test/mail_accessors_test.rb

@@ -0,0 +1,39 @@
+require_relative 'test_helper'
+
+class MailXSMTPAPI::AccessorsTest < MiniTest::Unit::TestCase
+
+  def test_to
+    subject.to = 'a@example.com'
+    assert_equal ['a@example.com'], subject.to
+    subject.to << 'b@example.com'
+    assert_equal ['a@example.com', 'b@example.com'], subject.to
+  end
+
+  def test_substitutions
+    subject.substitutions['foo'] = ['bar']
+    assert_equal ['bar'], subject.substitutions['foo']
+
+    subject.merge_substitutions('foo', ['baz', 'qux'])
+    assert_equal ['bar', 'baz', 'qux'], subject.substitutions['foo']
+  end
+
+  def test_unique_args
+    subject.unique_args['foo'] = 'bar'
+    assert_equal 'bar', subject.unique_args['foo']
+
+    subject.unique_args = {'hello' => 'world'}
+    refute subject.unique_args['foo']
+    assert_equal 'world', subject.unique_args['hello']
+  end
+
+  def test_category
+    subject.category = 'password_reset'
+    assert_equal 'password_reset', subject.category
+  end
+
+  private
+
+  def subject
+    @subject ||= MailXSMTPAPI::Field.new
+  end
+end

data/test/mail_integration_test.rb

@@ -0,0 +1,47 @@
+require_relative 'test_helper'
+
+class MailIntegrationTest < MiniTest::Unit::TestCase
+
+  def test_smtpapi_accessor
+    assert subject.smtpapi
+    assert subject.smtpapi.empty?
+
+    subject.smtpapi.value['to'] = 'c@example.com'
+    refute subject.smtpapi.empty?
+
+    assert_equal 'c@example.com', subject.smtpapi.value['to']
+  end
+
+  def test_hash_reader
+    assert_equal subject.smtpapi, subject['x-smtpapi']
+    assert_equal subject.smtpapi, subject['X_SMTPAPI']
+  end
+
+  def test_hash_writer
+    subject['x-smtpapi'] = {'to' => 'c@example.com'}
+    assert_equal 'c@example.com', subject.smtpapi.value['to']
+  end
+
+  def test_limited_field
+    subject['x-smtpapi'] = {'to' => 'c@example.com'}
+    subject['x-smtpapi'] = {'to' => 'd@example.com'}
+
+    refute subject['x-smtpapi'].is_a?(Array)
+    assert_equal 'd@example.com', subject['x-smtpapi'].value['to']
+  end
+
+  def test_field_name
+    assert_equal 'X-SMTPAPI', subject.smtpapi.name
+  end
+
+  private
+
+  def subject
+    @subject ||= ::Mail.new do
+      to 'a@example.com'
+      reply_to 'b@example.com'
+      date Time.now
+    end
+  end
+
+end

data/test/mail_x_smtpapi_field_test.rb

@@ -0,0 +1,38 @@
+require_relative 'test_helper'
+
+class MailXSMTPAPI::FieldTest < MiniTest::Unit::TestCase
+  def test_encoded_with_blank_values
+    assert_equal '', subject.new.encoded
+  end
+
+  def test_encoded_has_field_name
+    f = subject.new({'to' => ['a@example.com', 'b@example.com']})
+    assert f.encoded.match(/^X-SMTPAPI: /), f.encoded
+  end
+
+  def test_encoded_has_spaces_in_json
+    f = subject.new({'to' => ['a@example.com', 'b@example.com']})
+    assert f.encoded.include?('{"to": ["a@example.com", "b@example.com"]}')
+  end
+
+  def test_encoded_ends_with_crlf
+    f = subject.new({'to' => ['a@example.com', 'b@example.com']})
+    assert f.encoded.match(/\r\n$/)
+  end
+
+  def test_decoded
+    h = {'to' => ['a@example.com']}
+    assert_equal h, subject.new(h).decoded
+  end
+
+  def test_empty?
+    refute subject.new({'to' => ['a@example.com']}).empty?
+    assert subject.new({'to' => []}).empty?
+  end
+
+  private
+
+  def subject
+    MailXSMTPAPI::Field
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, :test)
+
+require 'minitest/autorun'
+
+require 'mail/x_smtpapi'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: mail-x_smtpapi
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha
+platform: ruby
+authors:
+- Lance Ivy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+description: 
+email:
+- lance@kickstarter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mail/x_smtpapi.rb
+- lib/mail_x_smtpapi.rb
+- lib/mail_x_smtpapi/accessors.rb
+- lib/mail_x_smtpapi/field.rb
+- lib/mail_x_smtpapi/version.rb
+- mail-x_smtpapi.gemspec
+- test/mail_accessors_test.rb
+- test/mail_integration_test.rb
+- test/mail_x_smtpapi_field_test.rb
+- test/test_helper.rb
+homepage: https://github.com/kickstarter/mail-x_smtpapi
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adds SendGrid X-SMTPAPI header support to Mail
+test_files:
+- test/mail_accessors_test.rb
+- test/mail_integration_test.rb
+- test/mail_x_smtpapi_field_test.rb
+- test/test_helper.rb