mail_allowed 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adee71efbd21ad0aad2a00ef1a143641068e891d70f4d6b49f8d5be0206f1ac1
+  data.tar.gz: 5c422b58261eac4d0f82f28a2f942e71b4b7c4c1d9b27113eac802e06ebef989
+SHA512:
+  metadata.gz: a2ce06a9f60904593117ecb978107da1a2ce74802c729a5b9b5c1b534cb3858651af6cd9881afd87ed5fc26b45e3877cb9165e9c6f869ff1936dd219a4c19e17
+  data.tar.gz: 1bfd4b951fcb518d080025384d92b45ae54f8514a4ae89c26f4976c28ec2ce3132faf3b30c67593eba17e012c1bdb30ee1340e2a704d9f1ee6cb96ceeb78c075

data/.circleci/config.yml

@@ -0,0 +1,45 @@
+version: 2
+jobs:
+  build:
+    parallelism: 1
+    working_directory: ~/ezcater
+    docker:
+      - image: circleci/ruby:2.5.7
+    steps:
+      - checkout
+
+      # Restore bundle cache
+      - restore_cache:
+          keys:
+            - ruby-cache-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "mail_allowed.gemspec" }}
+            - ruby-cache-{{ arch }}-{{ .Branch }}-
+            - ruby-cache-
+
+      - run:
+          name: Setup Code Climate test-reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 -o ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+
+      # Bundle install dependencies
+      - run: gem install bundler -v 1.17.3 --no-document
+      - run: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+      - run: bundle clean --force
+
+      # Store bundle cache
+      - save_cache:
+          key: ruby-cache-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "mail_allowed.gemspec" }}
+          paths:
+            - vendor/bundle
+
+      # Run Rubocop
+      # - run:
+      #     name: RuboCop
+      #     command: bundle exec rubocop
+
+      - run:
+          name: rspec
+          command: |
+            ./cc-test-reporter before-build
+            bundle exec rspec --format RspecJunitFormatter --format progress
+            ./cc-test-reporter after-build -t simplecov || exit 0

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/CHANGELOG.md

@@ -0,0 +1,4 @@
+# mail_allowed
+
+## v1.0.0
+- Initial release.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Brightin, Copyright (c) 2020 ezCater
+
+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,63 @@
+# MailAllowed
+
+This gem is a renamed fork of an [existing gem](https://github.com/brightin/mail_whitelist).
+
+MailAllowed is a class you can provide as an
+[interceptor](http://guides.rubyonrails.org/action_mailer_basics.html#intercepting-emails)
+to your Rails app. It ensures only some people are able to receive mails from
+your app and provides a fallback in case nobody would receive the mail. This
+can be useful to make sure no accidental emails are sent from your staging
+environment, but your mails can still be checked.
+
+One way to use it is to set an environment variable `MAIL_ALLOWED`, check
+for its existence and use it to instantiate a `MailAllowed` so that within 
+this environment only those email addresses can have mail sent to them.
+See below for a code example.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mail_allowed'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mail_allowed
+
+## Usage
+
+Specify your allowed as an array of email addresses and register them in an
+initializer in your Rails app. Optionally specify a fallback address as second
+argument.
+
+Example Rails app initializer using `ENV` variables:
+
+```ruby
+require 'mail_allowed'
+
+if ENV.key?('MAIL_ALLOWED')
+  allowed_addresses = ENV['MAIL_ALLOWED'].split(',')
+  fallback = ENV['MAIL_ALLOWED_FALLBACK']
+  ActionMailer::Base.register_interceptor(MailAllowed.new(allowed_addresses, fallback))
+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 GitHub at https://github.com/ezcater/mail_allowed.
+
+## 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,6 @@
+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 'mail_allowed'
+
+# 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/mail_allowed.rb

@@ -0,0 +1,31 @@
+require 'mail_allowed/version'
+
+# Filter mails with a specific allowed e-mail addresses and only leaves
+# those in the 'to'.
+class MailAllowed
+  attr_reader :allowed_addresses, :fallback
+
+  # @param [Array<String>, #include?] allowed_addresses
+  # @param [String] fallback
+  def initialize(allowed_addresses, fallback = nil)
+    @allowed_addresses = allowed_addresses
+    @fallback = fallback
+  end
+
+  def delivering_email(mail)
+    mail.to = mail.to.select { |recipient| allowed?(recipient) }
+    mail.to = [fallback] unless mail.to.any?
+  end
+
+  private
+
+  def allowed?(recipient)
+    allowed_addresses.any? do |address|
+      if address.start_with?('@')
+        recipient.end_with?(address)
+      else
+        address == recipient
+      end
+    end
+  end
+end

data/lib/mail_allowed/version.rb

@@ -0,0 +1,3 @@
+class MailAllowed
+  VERSION = '1.0.0'.freeze
+end

data/mail_allowed.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_allowed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mail_allowed'
+  spec.version       = MailAllowed::VERSION
+  spec.authors       = ['ezCater Inc']
+  spec.email         = ['engineering@ezcater.com']
+
+  spec.summary       = 'Easily specify the allowed email addresses in your Rails app.'
+  spec.homepage      = 'https://www.github.com/ezcater/mail_allowed'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  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'
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "simplecov", "< 0.18.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: mail_allowed
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ezCater Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-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.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'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+description: 
+email:
+- engineering@ezcater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mail_allowed.rb
+- lib/mail_allowed/version.rb
+- mail_allowed.gemspec
+homepage: https://www.github.com/ezcater/mail_allowed
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Easily specify the allowed email addresses in your Rails app.
+test_files: []