mailsafe 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95e24ee796ff9c2f23aa366db6de505e63da5a1d
-  data.tar.gz: 498a064060077b814f47b880e694e021fdd03ccb
+  metadata.gz: 047172ca62085b8affb85a38a9ffa18123dc8589
+  data.tar.gz: a07b0d33e190716d9d4076f90dc41ea9fa08726d
 SHA512:
-  metadata.gz: 6893733905424132968b26449321d94ac3f5ab3dce01e67f89fa2190b7302939b5a5a6b8d2d7f914e4b18d13e6fb24dd9a094f238dfccdffeb8c042aac40b374
-  data.tar.gz: d2c3c5f796ade3d98353feb26efec2839544c3844c0ba7bcfea9044a22fb166f7586b08387e087fdbed80c2c8dd380dd24294816c0c20bc6c0460210ade27e66
+  metadata.gz: c494132d2bd2f9ba140c836a689f713b51b01cb4a78fad6e4169c8ccaa52c6944bddf0b9decf32327eeb190bb355c12c04e23f07b1de16faf33442a4da1d094e
+  data.tar.gz: 2924839ee61347f45107c12dd5af6e651deb196011144fc5d18b7d40726a7ffbec67fe133d8da534272be97c11b62b270e213203e43180d73a15eca75bbe97b5

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -1,6 +1,7 @@
+[![Code Climate](https://codeclimate.com/github/stemps/mailsafe.png)](https://codeclimate.com/github/stemps/mailsafe)
 # Mailsafe
 
-TODO: Write a gem description
+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.
 
 ## Installation
 
@@ -12,13 +13,38 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install mailsafe
+You can re-route all emails to your developer email account by adding this your _development.rb_ file
 
-## Usage
+```ruby
+Mailsafe.setup do |config|
+  config.override_receiver = "developer@devco.com"
+end
+```
+
+The email subjects will be delivered to your account and prefixed with the original receiver in square brackets.
+
+
+You can send emails to the intended recipients but only to a whitelist of receipient domains (e.g. helpful for a staging environment where you want to send emails to your company's and your client's domain)
+
+```ruby
+Mailsafe.setup do |config|
+  config.allowed_domain = "devco.com, clientco.com"
+end
+```
+
+If you are running multiple environments with _mailsafe_ it can help to know which environment an email came from. You can have _mailsafe_ prefix the subject line with _[environment name]_ 
+
+```ruby
+config.prefix_email_subject_with_rails_env = true
+```
+
+
+## Caveat
+
+In order to filter (as in not send) emails I had to monkey patch the Mail#deliver method. If this makes you feel uneasy, better try out a different solution.
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/lib/mailsafe.rb

@@ -14,8 +14,9 @@ module Mailsafe
   mattr_accessor :prefix_email_subject_with_rails_env
   @@prefix_email_subject_with_rails_env = false
 
-  # specify a domain that is allowed to receive emails all emails to other domains are dropped. 
-  # If empty, all emails are allowed to all domains
+  # specify one or more domains (comma separated) that are allowed to receive emails all emails
+  # to other domains are dropped.  If empty, all emails are allowed to all
+  # domains
   mattr_accessor :allowed_domain
   @@allowed_domain = nil
 

data/lib/mailsafe/receipient_whitelist.rb

@@ -1,3 +1,5 @@
+require 'mailsafe/receipient_whitelist'
+
 module Mailsafe
   class ReceipientWhitelist
     def self.filter_receipient_domain(message)
@@ -13,9 +15,15 @@ module Mailsafe
       end
     end
 
-    def self.email_has_domain?(email, domain)
-      email_domain = email.split("@").second
-      email_domain.downcase == domain.downcase
+    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

data/lib/mailsafe/version.rb

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

data/mailsafe.gemspec

@@ -21,4 +21,5 @@ 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 "rails", "~> 4.1.5"
 end

data/spec/receipient_whitelist_spec.rb

@@ -0,0 +1,61 @@
+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

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailsafe
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Simon Stemplinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-30 00:00:00.000000000 Z
+date: 2014-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.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
 email:
 - simon@simon-stemplinger.com
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,6 +86,8 @@ files:
 - lib/mailsafe/reroute_interceptor.rb
 - lib/mailsafe/version.rb
 - mailsafe.gemspec
+- spec/receipient_whitelist_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/stemps/mailsafe
 licenses:
 - MIT
@@ -91,9 +108,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Safe emailing for Rails - do not send emails to real users from development
   or staging environments.
-test_files: []
+test_files:
+- spec/receipient_whitelist_spec.rb
+- spec/spec_helper.rb