mailsafe 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 047172ca62085b8affb85a38a9ffa18123dc8589
-  data.tar.gz: a07b0d33e190716d9d4076f90dc41ea9fa08726d
+  metadata.gz: 67ad0adc4f46869bab060bd9c07f998e5515fc3b
+  data.tar.gz: e99ad41b2eae6e0e9e3c248d740ca5e29db51993
 SHA512:
-  metadata.gz: c494132d2bd2f9ba140c836a689f713b51b01cb4a78fad6e4169c8ccaa52c6944bddf0b9decf32327eeb190bb355c12c04e23f07b1de16faf33442a4da1d094e
-  data.tar.gz: 2924839ee61347f45107c12dd5af6e651deb196011144fc5d18b7d40726a7ffbec67fe133d8da534272be97c11b62b270e213203e43180d73a15eca75bbe97b5
+  metadata.gz: 75f2a2260bc81b28beee198fc22e36d9382065ac915892b1c901b9a715c8b21f2fb251cb4f9dceddaa7b765e96c9afefdeb0ebcc47a0d4a8cfa03526a9a170f8
+  data.tar.gz: 49259b685320f13a7858aa35b44c7f6e4d32b4177028876624ed0537815352aa6a26367cc6c54c7e5bdb9a9f9d5f8404bd871ebc5357be69d8d99da820fc3375

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+# 0.2.0 
+
+* Filter CC and BCC addresses ([#2](https://github.com/stemps/mailsafe/issues/2))
+
+# 0.1.0
+
+* First public version

data/README.md

@@ -1,4 +1,5 @@
 [![Code Climate](https://codeclimate.com/github/stemps/mailsafe.png)](https://codeclimate.com/github/stemps/mailsafe)
+[![Build Status](https://travis-ci.org/stemps/mailsafe.svg)](https://travis-ci.org/stemps/mailsafe)
 # Mailsafe
 
 Safe emailing for Rails. Prevents you from sending emails to real customers from non-production environments. You can choose to either re-route all emails to a single developer account or allow only recipients of your own domain.

data/Rakefile

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

data/lib/mailsafe.rb

@@ -3,7 +3,7 @@ require "mailsafe/version"
 require "mailsafe/railtie"
 require "mailsafe/change_subject_interceptor"
 require "mailsafe/reroute_interceptor"
-require "mailsafe/receipient_whitelist"
+require "mailsafe/recipient_whitelist"
 
 module Mailsafe
   def self.setup

data/lib/mailsafe/recipient_whitelist.rb

@@ -0,0 +1,52 @@
+module Mailsafe
+  class RecipientWhitelist
+    def initialize(message)
+      @message = message
+      @allowed_domain_config = Mailsafe.allowed_domain
+      @allowed_domains = parse_allowed_domains
+    end
+
+    def filter_recipient_domains
+      return unless @allowed_domains.present?
+      [ :to, :cc, :bcc ].each { |rec_type| filter_receipient_type(rec_type) }
+    end
+
+    private
+
+    def filter_receipient_type(rec_type)
+      receivers = @message.send(rec_type)
+      return unless receivers
+
+      receivers.select! { |recipient| email_has_domain?(recipient) }
+      @message.send("#{rec_type}=", receivers)
+    end
+
+    def email_has_domain?(email_address)
+      email_domain = extract_domain_from_address(email_address)
+      email_domain.present? && @allowed_domains.include?(email_domain)
+    end
+
+    def extract_domain_from_address(email_address)
+      email_address.split("@")[1].try(:downcase)
+    end
+
+    def parse_allowed_domains
+      if @allowed_domain_config.present?
+        @allowed_domain_config.split(',').map(&:strip).map(&:downcase) 
+      end
+    end
+  end
+
+end
+
+# Unfortunately, monkeypatching Mail is the only way I found to actually prevent sending an email 
+require 'mail'
+
+class Mail::Message
+  def deliver_with_recipient_filter
+    Mailsafe::RecipientWhitelist.new(self).filter_recipient_domains
+    self.deliver_without_recipient_filter unless self.to.blank? || self.to.empty?
+  end
+
+  alias_method_chain :deliver, :recipient_filter
+end

data/lib/mailsafe/reroute_interceptor.rb

@@ -2,9 +2,20 @@ module Mailsafe
   class RerouteInterceptor
     def self.delivering_email(message)
       unless Mailsafe.override_receiver.blank?
-        message.subject = "[#{message.to}] #{message.subject}"
+        message.subject = "[#{receivers(message)}] #{message.subject}"
         message.to = Mailsafe.override_receiver
+        message.cc = []
+        message.bcc = []
       end
     end
+
+    private
+
+    def self.receivers(message)
+      [ :to, :cc, :bcc ].map do |rec_type|
+        recs = message.send(rec_type)
+        "#{rec_type}: #{recs.join ', '}" if recs.present?
+      end.compact.join '; '
+    end
   end
 end

data/lib/mailsafe/version.rb

@@ -1,3 +1,3 @@
 module Mailsafe
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/mailsafe.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
   spec.add_development_dependency "rails", "~> 4.1.5"
 end

data/spec/recipient_whitelist_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+module Mailsafe
+  describe RecipientWhitelist do
+
+    describe ".filter_recipient_domain" do
+      subject            { Mail.new(to: to, cc: cc, bcc: bcc) }
+      let(:to)           { ["to@gmail.com", "to@yahoo.com"] }
+      let(:cc)           { ["cc@gmail.com", "cc@yahoo.com"] }
+      let(:bcc)          { ["bcc@gmail.com", "bcc@yahoo.com"] }
+
+      context "allowed_domains configured" do
+        before do
+          Mailsafe.allowed_domain = "gmail.com" 
+          RecipientWhitelist.new(subject).filter_recipient_domains
+        end
+
+        it "filters 'to' email addresses" do
+          expect(subject.to).to eq ["to@gmail.com"]
+        end
+
+        it "filters 'cc' email addresses" do
+          expect(subject.cc).to eq ["cc@gmail.com"]
+        end
+
+        it "filters 'bcc' email addresses" do
+          expect(subject.bcc).to eq ["bcc@gmail.com"]
+        end
+      end
+
+      context "uninitialized receivers" do
+        subject { Mail.new() }
+
+        before do
+          Mailsafe.allowed_domain = "gmail.com" 
+          RecipientWhitelist.new(subject).filter_recipient_domains
+        end
+
+        it "Regression: and does not crash" do
+          expect(subject.to).to eq nil
+          expect(subject.cc).to eq nil
+          expect(subject.bcc).to eq nil
+        end
+      end
+    end
+    
+    describe "#email_has_domain" do
+      before { Mailsafe.allowed_domain = whitelist }
+      subject { RecipientWhitelist.new(double) }
+
+      context "single whitelisted domain" do
+        let(:whitelist) { "gmail.com" }
+
+        it "accepts the allowed domains" do
+          expect(subject.send(:email_has_domain?, "bert@gmail.com")).to be_truthy
+        end
+
+        it "does not accept other domains" do
+          expect(subject.send(:email_has_domain?, "bert@gmx.de")).to be_falsy 
+          expect(subject.send(:email_has_domain?, "bert@yahoo.com")).to be_falsy 
+          expect(subject.send(:email_has_domain?, "bert@ggmail.com")).to be_falsy 
+          expect(subject.send(:email_has_domain?, "bert@gmail.com.de")).to be_falsy 
+        end
+      end
+
+      context "multiple whitelisted domains" do
+        let(:whitelist) { "gmail.com, gmx.de" }
+
+        it "accepts the allowed domains" do
+          expect(subject.send(:email_has_domain?, "bert@gmail.com")).to be_truthy 
+          expect(subject.send(:email_has_domain?, "bert@gmx.de")).to be_truthy 
+        end
+
+        it "does not accept other domains" do
+          expect(subject.send(:email_has_domain?, "bert@yahoo.com")).to be_falsy 
+          expect(subject.send(:email_has_domain?, "bert@ggmail.com")).to be_falsy 
+        end
+      end
+
+      context "invalid email addresses" do
+        let(:whitelist) { "gmail.com" }
+
+        it "does not accept them" do
+          expect(subject.send(:email_has_domain?, "bert")).to be_falsy 
+        end
+      end
+
+      context "invalid whitelist" do
+        let(:whitelist) { "gmail.com, " }
+
+        it "accepts the allowed domains" do
+          expect(subject.send(:email_has_domain?, "bert@gmail.com")).to be_truthy 
+        end
+
+        it "does not accept other domains" do
+          expect(subject.send(:email_has_domain?, "bert@gmx.de")).to be_falsy 
+          expect(subject.send(:email_has_domain?, "bert@yahoo.com")).to be_falsy 
+          expect(subject.send(:email_has_domain?, "bert@ggmail.com")).to be_falsy 
+          expect(subject.send(:email_has_domain?, "bert@gmail.com.de")).to be_falsy 
+        end
+      end
+    end
+  end
+end

data/spec/reroute_interceptor_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+module Mailsafe
+  describe RerouteInterceptor do
+
+    describe ".delivering_mail" do
+      subject            { Mail.new(to: to, cc: cc, bcc: bcc, subject: mail_subject) }
+      let(:to)           { nil }
+      let(:cc)           { nil }
+      let(:bcc)          { nil }
+      let(:override_rec) { nil }
+      let(:mail_subject) { "Hi!" }
+
+      before do
+        Mailsafe.override_receiver = override_rec
+        RerouteInterceptor.delivering_email(subject) 
+      end
+
+      context "override_receiver is not set" do
+        let(:to)           { "joe@example.com" }
+        let(:cc)           { "jane@example.com" }
+        let(:bcc)          { "bob@example.com" }
+
+        # leaves the email unchanged
+        specify { expect(subject.subject).to eq mail_subject }
+        specify { expect(subject.to).to eq [to] }
+        specify { expect(subject.cc).to eq [cc] }
+        specify { expect(subject.bcc).to eq [bcc] }
+      end
+
+      context "override_receiver is set" do
+        let(:override_rec) { "override@example.com" }
+
+        context "Message without any receivers" do
+          specify { expect(subject.subject).to eq "[] Hi!" }
+          specify { expect(subject.to).to eq [override_rec] }
+          specify { expect(subject.cc).to eq [] }
+          specify { expect(subject.bcc).to eq [] }
+        end
+
+        context "message with a 'to' receiver" do
+          let(:to) { "bob@example.com" }
+
+          specify { expect(subject.subject).to eq "[to: bob@example.com] Hi!" }
+          specify { expect(subject.to).to eq [override_rec] }
+          specify { expect(subject.cc).to eq [] }
+          specify { expect(subject.bcc).to eq [] }
+        end
+
+        context "message with multiple 'to' receivers" do
+          let(:to) { ["bob@example.com", "jane@example.com"] }
+
+          specify { expect(subject.subject).to eq "[to: bob@example.com, jane@example.com] Hi!" }
+          specify { expect(subject.to).to eq [override_rec] }
+          specify { expect(subject.cc).to eq [] }
+          specify { expect(subject.bcc).to eq [] }
+        end
+
+        context "message with 'to', 'cc' and 'bcc' receivers" do
+          let(:to) { ["bob@example.com", "jane@example.com"] }
+          let(:cc) { "joe@example.com" }
+          let(:bcc) { ["mary@example.com", "alice@example.com"] }
+
+          specify { expect(subject.subject).to eq "[to: bob@example.com, jane@example.com; cc: joe@example.com; bcc: mary@example.com, alice@example.com] Hi!" }
+          specify { expect(subject.to).to eq [override_rec] }
+          specify { expect(subject.cc).to eq [] }
+          specify { expect(subject.bcc).to eq [] }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
+require 'pry'
 require 'bundler/setup'
 Bundler.setup
 
 require 'mailsafe'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: mailsafe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Simon Stemplinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.5
 description: Safe emailing for Rails
@@ -73,8 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -82,11 +97,12 @@ files:
 - lib/mailsafe.rb
 - lib/mailsafe/change_subject_interceptor.rb
 - lib/mailsafe/railtie.rb
-- lib/mailsafe/receipient_whitelist.rb
+- lib/mailsafe/recipient_whitelist.rb
 - lib/mailsafe/reroute_interceptor.rb
 - lib/mailsafe/version.rb
 - mailsafe.gemspec
-- spec/receipient_whitelist_spec.rb
+- spec/recipient_whitelist_spec.rb
+- spec/reroute_interceptor_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/stemps/mailsafe
 licenses:
@@ -98,21 +114,22 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Safe emailing for Rails - do not send emails to real users from development
   or staging environments.
 test_files:
-- spec/receipient_whitelist_spec.rb
+- spec/recipient_whitelist_spec.rb
+- spec/reroute_interceptor_spec.rb
 - spec/spec_helper.rb

data/lib/mailsafe/receipient_whitelist.rb

@@ -1,41 +0,0 @@
-require 'mailsafe/receipient_whitelist'
-
-module Mailsafe
-  class ReceipientWhitelist
-    def self.filter_receipient_domain(message)
-      allowed_domain = Mailsafe.allowed_domain
-      if allowed_domain.present?
-        receipients = []
-        message.to.each do |receipient|
-          if email_has_domain?(receipient, allowed_domain)
-            receipients << receipient 
-          end
-        end
-        message.to = receipients
-      end
-    end
-
-    def self.email_has_domain?(email, allowed_domain_config)
-      allowed_domains = allowed_domain_config.split(',').map(&:strip).map(&:downcase)
-      email_domain = email.split("@")[1]
-
-      if email_domain.present?
-        allowed_domains.include? email_domain.downcase
-      else
-        false
-      end
-    end
-  end
-end
-
-# Unfortunately, monkeypatching Mail is the only way I found to actually prevent sending an email 
-require 'mail'
-
-class Mail::Message
-  def deliver_with_recipient_filter
-    Mailsafe::ReceipientWhitelist.filter_receipient_domain(self)
-    self.deliver_without_recipient_filter unless self.to.blank? || self.to.empty?
-  end
-
-  alias_method_chain :deliver, :recipient_filter
-end

data/spec/receipient_whitelist_spec.rb

@@ -1,61 +0,0 @@
-require 'spec_helper'
-
-module Mailsafe
-  RSpec.describe ReceipientWhitelist do
-
-    describe ".email_has_domain" do
-      context "single whitelisted domain" do
-        let!(:whitelist) { "gmail.com" }
-
-        it "accepts the allowed domains" do
-          expect(ReceipientWhitelist.email_has_domain?("bert@gmail.com", whitelist)).to be_true 
-        end
-
-        it "does not accept other domains" do
-          expect(ReceipientWhitelist.email_has_domain?("bert@gmx.de", whitelist)).to be_false 
-          expect(ReceipientWhitelist.email_has_domain?("bert@yahoo.com", whitelist)).to be_false 
-          expect(ReceipientWhitelist.email_has_domain?("bert@ggmail.com", whitelist)).to be_false 
-          expect(ReceipientWhitelist.email_has_domain?("bert@gmail.com.de", whitelist)).to be_false 
-        end
-      end
-
-      context "multiple whitelisted domains" do
-        let!(:whitelist) { "gmail.com, gmx.de" }
-
-        it "accepts the allowed domains" do
-          expect(ReceipientWhitelist.email_has_domain?("bert@gmail.com", whitelist)).to be_true 
-          expect(ReceipientWhitelist.email_has_domain?("bert@gmx.de", whitelist)).to be_true 
-        end
-
-        it "does not accept other domains" do
-          expect(ReceipientWhitelist.email_has_domain?("bert@yahoo.com", whitelist)).to be_false 
-          expect(ReceipientWhitelist.email_has_domain?("bert@ggmail.com", whitelist)).to be_false 
-        end
-      end
-
-      context "invalid email addresses" do
-        let!(:whitelist) { "gmail.com" }
-
-        it "does not accept them" do
-          expect(ReceipientWhitelist.email_has_domain?("bert", whitelist)).to be_false 
-        end
-      end
-
-      context "invalid whitelist" do
-        let!(:whitelist) { "gmail.com, " }
-
-        it "accepts the allowed domains" do
-          expect(ReceipientWhitelist.email_has_domain?("bert@gmail.com", whitelist)).to be_true 
-        end
-
-        it "does not accept other domains" do
-          expect(ReceipientWhitelist.email_has_domain?("bert@gmx.de", whitelist)).to be_false 
-          expect(ReceipientWhitelist.email_has_domain?("bert@yahoo.com", whitelist)).to be_false 
-          expect(ReceipientWhitelist.email_has_domain?("bert@ggmail.com", whitelist)).to be_false 
-          expect(ReceipientWhitelist.email_has_domain?("bert@gmail.com.de", whitelist)).to be_false 
-        end
-      end
-
-    end
-  end
-end