action_recipient 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cc0328a3fee287b6d87961ca7185415ad295417d16596243e41b430ad547237
+  data.tar.gz: e13218290718ae0b7894c952df71fcfbdfa9df4cece3ffb80dc69dbd604ba832
+SHA512:
+  metadata.gz: efd2145204838e48b8e321123bd515f06a1fce905a1b7a5c9a8cc4076150cbd5a313ec52abb878afb106a5c671732706a75b381b39bac44f70d13e7d58cfa217
+  data.tar.gz: c608b3addea71fa100485dddc29c9aaf0b885383dc32d0522ced6af87154c37766d0f893e7e291c94467fa502d7c73e46bf261e985b09cf99c118bae9a8738f1

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Koji Onishi
+
+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,37 @@
+# ActionRecipient
+
+Overwrites email recipients with ActionMailer emails to prevent accidental delivery in non-production environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_recipient'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_recipient
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 GitHub at https://github.com/[USERNAME]/action_recipient.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/action_recipient.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_recipient/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'action_recipient'
+  spec.version       = ActionRecipient::VERSION
+  spec.authors       = ['Koji Onishi']
+  spec.email         = ['fursich0@gmail.com']
+
+  spec.summary       = 'Overwrites email recipients with ActionMailer emails to prevent accidental delivery in non-production environments.'
+  spec.description   = 'Prevents accidental email delivery in non-production (typically staging) environments by replacing email addresses using ActionMailer\'s Interceptor.'
+  spec.homepage      = 'https://github.com/fursich/action_recipient'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/fursich/action_recipient'
+    # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mail', '>= 2.5.4' # to liaise with ActionMailer 4.2 or higher
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-doc'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "action_recipient"
+
+# 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(__FILE__)

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/action_recipient/configuration.rb

@@ -0,0 +1,27 @@
+module ActionRecipient
+  class << self
+    def configure &block
+      block.call config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def reset_config!
+      @config = nil
+    end
+  end
+
+  class Configuration
+    attr_writer :whitelist, :format
+
+    def whitelist
+      @whitelist ||= []
+    end
+
+    def format
+      @format ||= '%s'
+    end
+  end
+end

data/lib/action_recipient/interceptor.rb

@@ -0,0 +1,11 @@
+require_relative 'rewriter'
+
+module ActionRecipient
+  module Interceptor
+    def self.delivering_email(message)
+      ActionRecipient::Rewriter.rewrite_addresses!(message, :to)
+      ActionRecipient::Rewriter.rewrite_addresses!(message, :cc,  prefix: 'cc_')
+      ActionRecipient::Rewriter.rewrite_addresses!(message, :bcc, prefix: 'bcc_')
+    end
+  end
+end

data/lib/action_recipient/rewriter.rb

@@ -0,0 +1,34 @@
+module ActionRecipient
+  module Rewriter
+    class << self
+      def rewrite_addresses!(message, type, prefix: '')
+        address_container = message[type]&.field&.addrs
+        return unless address_container
+
+        message[type] = address_container.map { |address_object|
+          if whitelisted?(address_object.address)
+            address_object.to_s
+          else
+            rewrite(address_object.address, prefix, format)
+          end
+        }
+      end
+
+      def rewrite(email, prefix, format)
+        format % "#{prefix}#{email.gsub('@', '_at_').gsub(/[^\.\w]/, '-')}"
+      end
+
+      def whitelisted?(email)
+        whitelist.include? email
+      end
+
+      def whitelist
+        ActionRecipient.config.whitelist
+      end
+
+      def format
+        ActionRecipient.config.format
+      end
+    end
+  end
+end

data/lib/action_recipient/version.rb

@@ -0,0 +1,3 @@
+module ActionRecipient
+  VERSION = "0.1.0"
+end

data/lib/action_recipient.rb

@@ -0,0 +1,6 @@
+require "action_recipient/version"
+require "action_recipient/interceptor"
+require "action_recipient/configuration"
+
+module ActionRecipient
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: action_recipient
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koji Onishi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Prevents accidental email delivery in non-production (typically staging)
+  environments by replacing email addresses using ActionMailer's Interceptor.
+email:
+- fursich0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_recipient.gemspec
+- bin/console
+- bin/setup
+- lib/action_recipient.rb
+- lib/action_recipient/configuration.rb
+- lib/action_recipient/interceptor.rb
+- lib/action_recipient/rewriter.rb
+- lib/action_recipient/version.rb
+homepage: https://github.com/fursich/action_recipient
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fursich/action_recipient
+  source_code_uri: https://github.com/fursich/action_recipient
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Overwrites email recipients with ActionMailer emails to prevent accidental
+  delivery in non-production environments.
+test_files: []