mail-x_smtpapi-ksr 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2dc958a654b3a3c27b0c08ddbce12d514691889367ee499b3c11e5fe1764f4ba
+  data.tar.gz: 3b8ad87c7deeb1e3c357ec42c9d1d2b003cf7e7aa86870f9695c6c8fe97f0a4d
+SHA512:
+  metadata.gz: 13191e816e6f83a45426d86d0716771d73befa5347c252981e399aad5a667808965c4b90a5fcfb815f644cd58a6dc947ef13532b7747db67c32bfd0b1c761cfd
+  data.tar.gz: 3b6369a8743f6dd7466a06d8110c3e095b74c8f7aedec6ef6d95a4d000b94bbabe7629a0b6fc2bbbe03f21fa0a18b79cf6b18bb96bbb6aa8f9eefe3c11d00d80

data/.github/workflows/main.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.2'
+          - '3.3'
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# CHANGELOG
+
+## Version 1.2.0
+
+### Non-breaking changes
+
+* fixes for compatibility with mail 2.7.0 (@cainlevy)
+
+## Version 1.1.0
+
+### Non-breaking changes
+
+* add support for asm_group_id, PR #2 (@stevewilhelm)
+
+## Version 1.0.2
+
+### Non-breaking changes
+
+* add minitest dependency
+* declare dependency on ruby 2.3.1
+
+## Version 1.0.1
+
+### Non-breaking changes
+
+  * changed underlying key for sections() from 'sections' to 'section'
+
+## Version 1.0.0
+

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'irb'
+  gem 'debug'
+end
+
+# 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,79 @@
+# Mail::X::Smtpapi
+
+[![Gem Version](https://badge.fury.io/rb/mail-x_smtpapi.svg)](http://badge.fury.io/rb/mail-x_smtpapi) [![Circle CI](https://img.shields.io/circleci/project/kickstarter/mail-x_smtpapi.svg?style=shield)](https://circleci.com/gh/kickstarter/mail-x_smtpapi/tree/master) [![Code Climate](https://codeclimate.com/github/kickstarter/mail-x_smtpapi/badges/gpa.svg)](https://codeclimate.com/github/kickstarter/mail-x_smtpapi)
+
+Integrates support for SendGrid's X-SMTPAPI field into the [Mail](https://github.com/mikel/mail) gem.
+
+Please refer to [SendGrid docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html) for ideas of what you can do with the X-SMTPAPI header!
+
+## 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 X-SMTPAPI header from anywhere with access to the `mail` object.
+
+### Example: Rails Mailer
+
+Adapting the [Rails Guide example](http://guides.rubyonrails.org/v4.0.8/action_mailer_basics.html#edit-the-mailer):
+
+```ruby
+class UserMailer < ActionMailer::Base
+
+  def welcome(user)
+    @user = user
+
+    mail.smtpapi.category = 'welcome'
+    mail.smtpapi.unique_args['user_id'] = @user.id
+
+    mail(to: @user.email, subject: 'Welcome to My Awesome Site')
+  end
+
+end
+```
+
+### Example: Mail Interceptor
+
+Adapting the [Rails Guide example](http://guides.rubyonrails.org/v4.0.8/action_mailer_basics.html#intercepting-emails):
+
+```ruby
+class SandboxEmailInterceptor
+  def self.delivering_email(message)
+    message.smtpapi.unique_args['original'] = message.to
+    message.to = ['sandbox@example.com']
+  end
+end
+```
+
+### Example: Template Helper
+
+```ruby
+module MailerABHelper
+  def show_variant?(name)
+    variant = rand(2) == 0 ? 'main' : 'alternate'
+    mail.smtpapi.unique_args["#{name}_variant"] = variant
+    return variant == 'alternate'
+  end
+end
+```
+
+## 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,23 @@
+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
+end

data/lib/mail-x_smtpapi.rb

@@ -0,0 +1,2 @@
+require 'mail_x_smtpapi/version.rb'
+require 'mail/x_smtpapi.rb'

data/lib/mail_x_smtpapi/accessors.rb

@@ -0,0 +1,74 @@
+module MailXSMTPAPI
+
+  module Recipients
+    def to
+      data['to'] ||= []
+    end
+
+    def to=(val)
+      val = [val] unless val.is_a? Array
+      to.replace val
+    end
+  end
+
+  module Substitutions
+    def substitutions
+      data['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
+      data['unique_args'] ||= {}
+    end
+
+    def unique_args=(val)
+      raise ArgumentError unless val.is_a? Hash
+      unique_args.replace(val)
+    end
+  end
+
+  module Category
+    def category
+      data['category']
+    end
+
+    def category=(val)
+      data['category'] = val
+    end
+  end
+
+  module AsmGroupId
+    def asm_group_id
+      data['asm_group_id']
+    end
+
+    def asm_group_id=(val)
+      data['asm_group_id'] = val
+    end
+  end
+
+  module Filters
+    def filters
+      data['filters'] ||= {}
+    end
+  end
+
+  module Sections
+    def sections
+      data['section'] ||= {}
+    end
+  end
+
+end

data/lib/mail_x_smtpapi/field.rb

@@ -0,0 +1,51 @@
+require 'mail'
+require 'json'
+require_relative 'accessors'
+
+module MailXSMTPAPI
+  class Field < ::Mail::UnstructuredField
+    FIELD_NAME = 'x-smtpapi'
+    CAPITALIZED_FIELD = 'X-SMTPAPI'
+
+    def self.singular? = true
+
+    attr_reader :data
+
+    # Accessors
+    include Recipients
+    include Substitutions
+    include UniqueArguments
+    include Category
+    include AsmGroupId
+    include Filters
+    include Sections
+
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      self.name = CAPITALIZED_FIELD
+      @data = value || {}
+    end
+
+    def value
+      JSON.generate(data)
+    end
+
+    def encoded
+      if empty?
+        ''
+      else
+        "#{wrapped_value}\r\n"
+      end
+    end
+
+    # to take advantage of folding, decoded must return a string of
+    # JSON with extra spaces inserted for line wrapping.
+    def decoded
+      value.gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3')
+    end
+
+    def empty?
+      data.values.all?{|v| !v || v.empty? }
+    end
+  end
+end

data/lib/mail_x_smtpapi/version.rb

@@ -0,0 +1,3 @@
+module MailXSMTPAPI
+  VERSION = '1.3.0'
+end

data/mail-x_smtpapi.gemspec

@@ -0,0 +1,26 @@
+# 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-ksr"
+  spec.version       = MailXSMTPAPI::VERSION
+  spec.authors       = ["Kickstarter"]
+  spec.email         = ["devops@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", ">= 2.2.3"
+  spec.add_development_dependency "rake", "~> 13.1"
+  spec.add_development_dependency "minitest", "~> 5.21"
+
+  spec.add_dependency "mail", "~> 2.8.1"
+  spec.add_dependency "net-smtp"
+end

data/test/mail_accessors_test.rb

@@ -0,0 +1,44 @@
+require_relative 'test_helper'
+
+class MailXSMTPAPI::AccessorsTest < Minitest::Test
+
+  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
+
+  def test_asm_group_id
+    subject.asm_group_id = 123
+    assert_equal 123, subject.asm_group_id
+  end
+
+  private
+
+  def subject
+    @subject ||= MailXSMTPAPI::Field.new
+  end
+end

data/test/mail_integration_test.rb

@@ -0,0 +1,50 @@
+require_relative 'test_helper'
+
+class MailIntegrationTest < Minitest::Test
+
+  def test_smtpapi_accessor
+    assert subject.smtpapi
+    assert subject.smtpapi.empty?
+
+    subject.smtpapi.data['to'] = 'c@example.com'
+    refute subject.smtpapi.empty?
+
+    assert_equal 'c@example.com', subject.smtpapi.data['to']
+    assert_equal '{"to":"c@example.com"}', subject.smtpapi.value
+  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.data['to']
+    assert_equal '{"to":"c@example.com"}', subject.smtpapi.value
+  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'].data['to']
+    assert_equal '{"to":"d@example.com"}', subject.smtpapi.value
+  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,44 @@
+require_relative 'test_helper'
+
+class MailXSMTPAPI::FieldTest < Minitest::Test
+  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_encoded_is_folded
+    f = subject.new('to' => 100.times.map{ 'test@example.com'} )
+    max_line_length = f.encoded.split(/[\r\n]+/).map(&:length).max
+    assert max_line_length < 998, "max line length: #{max_line_length}"
+  end
+
+  def test_decoded
+    h = {'to' => ['a@example.com', 'b@example.com']}
+    assert_equal '{"to": ["a@example.com", "b@example.com"]}', 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,134 @@
+--- !ruby/object:Gem::Specification
+name: mail-x_smtpapi-ksr
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Kickstarter
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.21'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: net-smtp
+  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'
+description:
+email:
+- devops@kickstarter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- 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: '0'
+requirements: []
+rubygems_version: 3.5.23
+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