email_domain_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d575d0411e6af35d7700ebf5ec9f0dd0a033ccb6
+  data.tar.gz: 3711b6e48446125d946ec9c5eb7b500d18576062
+SHA512:
+  metadata.gz: 2134efaceda88b7c0ebca822add75a008a351f4093282ee2de0ee193265d463cd4f638ea8c5d98c61e0c5338630b5f86e9521c2c86bc23b972abe234ce03cf80
+  data.tar.gz: 17af139aff1088cf8d5ecbd8b4637d2f7bdc8ef4305630a80c5708682e925163066a1889f6ef2ad75a1da288d50f600490fa8a823cf5ac8e2c5369b58e54b1b7

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 lulalala
+
+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,62 @@
+# EmailDomainValidator
+
+Email address's domain validator by checking presence of MX and A record.
+
+Extra filters are available such as caching and whitelisting.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'email_domain_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_domain_validator
+
+## Usage
+
+Validate email:
+
+    v = EmailDomainValidator.new
+    v.valid?('saki@yahoo.co.jp')
+
+Add cache filter
+
+    v.add_filter(:rails_cache, expires_in: 12.hours)
+    v.valid?('saki@yahoo.co.jp')
+    v.valid?('amy@yahoo.co.jp') # same domain will not be checked again
+
+## Filters
+
+### dummy
+
+Always returns true. Useful for testing or development purposes.
+
+    v.add_filter(:dummy)
+
+### rails_cache
+
+Use Rails' caching capability to cache lookup results. Options used in Rails caching such as :expires_in can be used here.
+
+    v.add_filter(:rails_cache, expires_in: 12.hours, race_condition_ttl: 1)
+
+### whitelist
+
+Declare a whitelist of domains which will always be considered valid.
+
+    v.add_filter(:rails_cache, ['yahoo.com.tw', 'gmail.com'])
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/email_domain_validator/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,4 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/email_domain_validator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'email_domain_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "email_domain_validator"
+  spec.version       = EmailDomainValidator::VERSION
+  spec.authors       = ["lulalala"]
+  spec.email         = ["mark@goodlife.tw"]
+  spec.summary       = %q{Validates Email address domains using MX and A records, with caching and whitelisting.}
+  spec.description   = %q{Validates Email address domains using MX and A records, with caching and whitelisting.}
+  spec.homepage      = "https://github.com/lulalala/email_domain_validator"
+  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", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", '~> 3.1'
+end

data/lib/email_domain_validator.rb

@@ -0,0 +1,41 @@
+require "email_domain_validator/version"
+require "email_domain_validator/core"
+
+class EmailDomainValidator
+  def initialize
+    @validator = Core.new
+  end
+
+  def valid?(email)
+    domain = self.class.get_domain(email)
+
+    if domain.nil? || domain.empty?
+      return false
+    end
+
+    @validator.valid?(domain)
+  end
+
+  def add_filter(filter_class, options={})
+    require_path = "email_domain_validator/#{filter_class}"
+
+    require require_path
+
+    klass = self.class.constantize(require_path)
+
+    @validator = klass.new(@validator, options)
+  end
+
+private
+
+  # @email
+  def self.get_domain(email)
+    email[/@(.*)/,1]
+  end
+
+  def self.constantize(string)
+    string.split('/').inject(Object){|o,c|
+      o.const_get(c.split('_').map{|e| e.capitalize}.join)
+    }
+  end
+end

data/lib/email_domain_validator/core.rb

@@ -0,0 +1,8 @@
+class EmailDomainValidator::Core
+  def valid?(domain)
+    Resolv::DNS.open do |dns|
+      return dns.getresources(domain, Resolv::DNS::Resource::IN::MX).size > 0 ||
+             dns.getresources(domain, Resolv::DNS::Resource::IN::A).size > 0
+    end
+  end
+end

data/lib/email_domain_validator/dummy.rb

@@ -0,0 +1,8 @@
+class EmailDomainValidator::Dummy
+  def initialize(app, options = nil)
+  end
+
+  def valid?(domain)
+    true
+  end
+end

data/lib/email_domain_validator/rails_cache.rb

@@ -0,0 +1,19 @@
+class EmailDomainValidator::RailsCache
+  def initialize(app, options = {})
+    @app = app
+    @options = options
+  end
+
+  def valid?(domain)
+    result = Rails.cache.read(self.class.cache_key(domain))
+    if result.nil?
+      result = @app.valid?(domain)
+      Rails.cache.write(self.class.cache_key(domain), result, @options)
+    end
+    result
+  end
+
+  def self.cache_key(domain)
+    [:email_domain_validator, domain]
+  end
+end

data/lib/email_domain_validator/version.rb

@@ -0,0 +1,3 @@
+class EmailDomainValidator
+  VERSION = "0.0.1"
+end

data/lib/email_domain_validator/whitelist.rb

@@ -0,0 +1,14 @@
+class EmailDomainValidator::Whitelist
+  def initialize(app, whitelist = [])
+    @app = app
+    @whitelist = whitelist
+  end
+
+  def valid?(domain)
+    if @whitelist.include?(domain)
+      true
+    else
+      @app.valid?(domain)
+    end
+  end
+end

data/spec/email_domain_validator/core_spec.rb

@@ -0,0 +1,21 @@
+require_relative '../helper'
+require 'email_domain_validator/core'
+
+RSpec.describe EmailDomainValidator::Core do
+  it 'returns true for valid domain' do
+    subject.valid?('example.com').should == true
+    subject.valid?('gmail.com').should == true
+    subject.valid?('hotmail.com').should == true
+    subject.valid?('yahoo.com').should == true
+  end
+
+  it 'returns true for domain with only A record but no MX record' do
+    subject.valid?('lulalala.com').should == true
+  end
+
+  it 'returns false for invalid domain' do
+    subject.valid?('anonymous.invalid').should == false
+    subject.valid?('gmail.comm1').should == false
+  end
+end
+

data/spec/email_domain_validator/dummy_spec.rb

@@ -0,0 +1,14 @@
+require 'helper'
+require 'email_domain_validator/dummy'
+
+describe EmailDomainValidator::Dummy do
+  let(:core){ double(:core_app) }
+  subject{ described_class.new(core) }
+
+  it 'returns true always' do
+    core.should_not_receive(:valid?)
+
+    subject.valid?('localhost').should == true
+    subject.valid?('test').should == true
+  end
+end

data/spec/email_domain_validator/rails_cache_spec.rb

@@ -0,0 +1,55 @@
+require 'helper'
+require 'email_domain_validator/rails_cache'
+
+dummy_cache = Object.new
+def dummy_cache.valid?; end
+def dummy_cache.post_check; end
+
+module Rails
+  class DummyCache
+    def read(key)
+      store[key]
+    end
+
+    def write(key, value, options)
+      store[key] = value
+    end
+
+    def store
+      @store ||= {}
+    end
+  end
+
+  def self.cache
+    @cache ||= DummyCache.new
+  end
+
+  def self.reset
+    @cache = DummyCache.new
+  end
+end
+
+describe EmailDomainValidator::RailsCache do
+  let(:core){ double(:core_app) }
+  subject{ described_class.new(core) }
+
+  before do
+    Rails.reset
+  end
+
+  it 'returns true if cached' do
+    Rails.cache.write(described_class.cache_key('localhost'), true, nil)
+
+    core.should_not_receive(:valid?)
+
+    subject.valid?('localhost').should == true
+  end
+
+  it 'caches result' do
+    core.stub(:valid?){ true }
+
+    subject.valid?('localhost')
+
+    Rails.cache.read(described_class.cache_key('localhost')).should == true
+  end
+end

data/spec/email_domain_validator/whitelist_spec.rb

@@ -0,0 +1,22 @@
+require 'helper'
+require 'email_domain_validator/whitelist'
+
+describe EmailDomainValidator::Whitelist do
+  let(:core){ double(:core_app) }
+  subject{
+    described_class.new(core, ['gmail.com', 'yahoo.com.tw'])
+  }
+
+  it 'returns true if in whitelist' do
+    core.should_not_receive(:valid?)
+
+    subject.valid?('gmail.com').should == true
+    subject.valid?('yahoo.com.tw').should == true
+  end
+
+  it 'calls inner app if not in whitelist' do
+    core.should_receive(:valid?)
+
+    subject.valid?('yahoo.co.uk')
+  end
+end

data/spec/email_domain_validator_spec.rb

@@ -0,0 +1,38 @@
+require 'helper'
+require 'email_domain_validator'
+require 'email_domain_validator/dummy'
+
+describe EmailDomainValidator do
+  it 'has version' do
+    described_class.const_get('VERSION').empty?.should == false
+  end
+
+  it 'returns false if domain cannot be extracted from provided email address' do
+    subject.valid?('not_email_address').should == false
+    subject.valid?('').should == false
+  end
+
+  describe '.get_domain' do
+    it 'fetches domain from email address' do
+      described_class.send(:get_domain, 'akira@gmail.com').should == 'gmail.com'
+      described_class.send(:get_domain, 'saki@yahoo.co.jp').should == 'yahoo.co.jp'
+      described_class.send(:get_domain, 'pants+spam@scipkr.co.jp').should == 'scipkr.co.jp'
+    end
+  end
+
+  describe '#add_filter' do
+    it 'wraps middleware with another middleware' do
+      EmailDomainValidator::Dummy.any_instance.should_receive :valid?
+
+      subject.add_filter(:dummy)
+
+      subject.valid?('test@localhost')
+    end
+  end
+
+  describe '.constantize' do
+    it 'returns middleware constant' do
+      described_class.send(:constantize, 'email_domain_validator/dummy').should == EmailDomainValidator::Dummy
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :should
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = :should
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: email_domain_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- lulalala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Validates Email address domains using MX and A records, with caching
+  and whitelisting.
+email:
+- mark@goodlife.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- email_domain_validator.gemspec
+- lib/email_domain_validator.rb
+- lib/email_domain_validator/core.rb
+- lib/email_domain_validator/dummy.rb
+- lib/email_domain_validator/rails_cache.rb
+- lib/email_domain_validator/version.rb
+- lib/email_domain_validator/whitelist.rb
+- spec/email_domain_validator/core_spec.rb
+- spec/email_domain_validator/dummy_spec.rb
+- spec/email_domain_validator/rails_cache_spec.rb
+- spec/email_domain_validator/whitelist_spec.rb
+- spec/email_domain_validator_spec.rb
+- spec/helper.rb
+homepage: https://github.com/lulalala/email_domain_validator
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Validates Email address domains using MX and A records, with caching and
+  whitelisting.
+test_files:
+- spec/email_domain_validator/core_spec.rb
+- spec/email_domain_validator/dummy_spec.rb
+- spec/email_domain_validator/rails_cache_spec.rb
+- spec/email_domain_validator/whitelist_spec.rb
+- spec/email_domain_validator_spec.rb
+- spec/helper.rb