heycarsten-email-veracity 0.3.0 → 0.3.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2008 Carsten Nielsen
+
+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.markdown

@@ -0,0 +1,67 @@
+Email Veracity
+==============
+
+A straight-forward Ruby library for checking the real-world validity of email
+addresses.
+
+
+### It Can
+
+ * Validate email addresses for proper form against a pattern.
+ * Accept and reject addresses based whitelists and blacklists of domains.
+ * Check an address' domain for MX and/or A records.
+ * Be configured for a variety of use-cases, to be as discerning or as
+   indiscriminate as you would like.
+
+
+### It Can Not
+
+ * Validate all possible permutations of addresses to the RFC 2822
+   specification.
+
+
+Using The Gem
+-------------
+
+In your project, you must require `email_veracity` after that you can try it
+out, consider the following examples:
+
+    
+    require 'email_veracity'
+    
+    address = EmailVeracity::Address.new('heycarsten@gmail.com')
+    
+    address.valid?
+    # => true
+    
+    address.domain.to_s
+    # => 'gmail.com'
+    
+    address.domain.address_servers.collect { |s| s.to_s }
+    # => ["64.233.171.83", "64.233.161.83", "209.85.171.83"]
+    
+    address = EmailVeracity::Address.new('fakey@crazy-z3d9df-domain.com')
+    
+    address.valid?
+    # => false
+    
+    address.errors
+    # => [:no_address_servers]
+    
+
+As you can see, playing with the core library is pretty fun.  The basic building
+blocks are:
+
+#### Address
+
+Responsible for parsing full email addresses and checking for pattern-based
+validity.
+
+#### Domain
+
+Contains methods to query the domain for information.
+
+#### Resolver
+
+Abstracts Resolv::DNS into a super-simple single public method, this is where
+the timeout error is raised.

data/Rakefile

@@ -1,4 +1,3 @@
-# I used Haml as a template for these tasks: Thank you Nex3!
 require 'rubygems'
 require 'rake'
 
@@ -17,8 +16,8 @@ end
 
 ### Packaging
 require 'rake/gempackagetask'
-load    'email_veracity.gemspec'
-Rake::GemPackageTask.new(EMAIL_VERACITY_GEMSPEC) do |pkg|
+load 'email_veracity.gemspec'
+Rake::GemPackageTask.new(EV_GEMSPEC) do |pkg|
   if Rake.application.top_level_tasks.include?('release')
     pkg.need_tar_gz = true
     pkg.need_tar_bz2 = true
@@ -27,59 +26,12 @@ Rake::GemPackageTask.new(EMAIL_VERACITY_GEMSPEC) do |pkg|
 end
 
 
-task :revision_file do
-  require 'lib/email_veracity'
-
-  if EmailVeracity.version[:rev] && !Rake.application.top_level_tasks.include?('release')
-    File.open('REVISION', 'w') { |f| f.puts EmailVeracity.version[:rev] }
-  elsif Rake.application.top_level_tasks.include?('release')
-    File.open('REVISION', 'w') { |f| f.puts '(release)' }
-  else
-    File.open('REVISION', 'w') { |f| f.puts '(unknown)' }
-  end
-end
-Rake::Task[:package].prerequisites.insert(0, :revision_file)
-
-# We also need to get rid of this file after packaging.
-at_exit { File.delete('REVISION') rescue nil }
-
-
 task :install => [:package] do
   sudo = RUBY_PLATFORM =~ /win32/ ? '' : 'sudo'
-  `#{sudo} gem install --no-ri pkg/email-veracity-#{File.read('VERSION').strip}`
+  `#{sudo} gem install --no-ri pkg/email-veracity-#{EV_VERSION}`
 end
 
 
-task :release => [:package] do
-  name, version = ENV['NAME'], ENV['VERSION']
-  raise "Must supply NAME and VERSION for release task." unless name && version
-  `rubyforge login`
-  `rubyforge add_release email-veracity email-veracity "#{name} (v#{version})" pkg/email-veracity-#{version}.gem`
-  `rubyforge add_file    email-veracity email-veracity "#{name} (v#{version})" pkg/email-veracity-#{version}.tar.gz`
-  `rubyforge add_file    email-veracity email-veracity "#{name} (v#{version})" pkg/email-veracity-#{version}.tar.bz2`
-  `rubyforge add_file    email-veracity email-veracity "#{name} (v#{version})" pkg/email-veracity-#{version}.zip`
-end
-
-
-
-### Documentation
-require 'rake/rdoctask'
-
-Rake::RDocTask.new do |rdoc|
-  rdoc.title    = 'Email Veracity'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include(*FileList.new('*') do |list|
-                            list.exclude(/(^|[^.a-z])[a-z]+/)
-                            list.exclude('TODO')
-                          end.to_a)
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.exclude('TODO')
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.main = 'README.rdoc'
-end
-
-
-
 ### Coverage
 require 'rcov/rcovtask'
 

data/lib/email_veracity.rb

@@ -5,7 +5,6 @@ require 'resolv'
 require 'timeout'
 require 'email_veracity/core_extensions'
 require 'email_veracity/validatability'
-require 'email_veracity/errors'
 require 'email_veracity/config'
 require 'email_veracity/server'
 require 'email_veracity/resolver'
@@ -15,42 +14,8 @@ require 'email_veracity/address'
 
 module EmailVeracity
 
-  def self.version # :nodoc:
-    return @@version if defined?(@@version)
-
-    numbers = File.read(scope('VERSION')).strip.split('.').map { |n| n.to_i }
-
-    @@version = {
-      :major => numbers[0],
-      :minor => numbers[1],
-      :teeny => numbers[2] }
-
-    @@version[:string] = [:major, :minor, :teeny].map { |comp| @@version[comp] }.compact.join('.')
-
-    if File.exists?(scope('REVISION'))
-      rev = File.read(scope('REVISION')).strip
-      rev = nil if rev !~ /[a-f0-9]+/
-    end
-
-    if rev.nil? && File.exists?(scope('.git/HEAD'))
-      rev = File.read(scope('.git/HEAD')).strip
-      if rev =~ /^ref: (.*)$/
-        rev = File.read(scope(".git/#{$1}")).strip
-      end
-    end
-
-    if rev
-      @@version[:rev] = rev
-      @@version[:string] << "." << rev[0...7]
-    end
-
-    @@version
-  end
-
-  def self.scope(file) # :nodoc:
-    File.join(File.dirname(__FILE__), '..', file)
-  end
-
-  VERSION = version[:string] unless defined?(EmailVeracity::VERSION)
+  class Error < StandardError; end
+  class MalformedEmailAddressError < Error; end
+  class DomainResourcesTimeoutError < Error; end
 
 end

data/lib/email_veracity/config.rb

@@ -8,7 +8,8 @@ module EmailVeracity
         rogers.com sympatico.ca yahoo.com telus.com sprint.com sprint.ca ],
       :blacklist => %w[ dodgeit.com mintemail.com mintemail.uni.cc
         1mintemail.mooo.com spammotel.com trashmail.net ],
-      :valid_pattern => /\A(([\d\w\+_\-\.]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})){1}\Z/i,
+      :valid_pattern =>
+        /\A(([\w]+[\w\+_\-\.]+[\+_\-\.]{0})@((?:[-a-z0-9]+\.)+[a-z]{2,})){1}\Z/i,
       :timeout => 2,
       :lookup => [:a],
       :enforce_blacklist => false,

data/test/test_helper.rb

@@ -1,15 +1,16 @@
+require 'rubygems'
 require 'test/unit'
-require 'lib/email_veracity'
+require 'mocha'
+require File.dirname(__FILE__) + '/../lib/email_veracity'
 Dir.glob('test/mocks/*.rb') { |f| require(f) }
 
 
 class Test::Unit::TestCase
 
   def domain_names
-    %w[ viarails.net  heycarsten.com  yahoo.com  gmail.com  savvica.com
-      learnhub.com  github.com  google.com  rogers.com  amd.com  adobe.com
-      unspace.ca  xerox.com  webkit.org  cooltown.net  aiderss.com
-      del.icio.us ]
+    %w[ viarails.net heycarsten.com yahoo.com gmail.com savvica.com
+      learnhub.com github.com google.com rogers.com amd.com adobe.com
+      unspace.ca xerox.com webkit.org cooltown.net aiderss.com del.icio.us ]
   end
 
   def assert_empty(array, message = nil)

data/test/unit/address_test.rb

@@ -25,20 +25,22 @@ class DefaultConfigurationAddressValidationsTest < Test::Unit::TestCase
 
   def test_a_well_formed_address_with_a_blacklisted_domain
     address = new_address('heycarsten@dodgeit.com')
-    assert address.valid?,
-      "Should be valid. @errors: #{address.errors.inspect}"
+    address.stubs(:domain).with(nil).
+      returns(stub(:errors => [:blacklisted]))
+    assert !address.valid?,"Should be valid. @errors: #{address.errors.inspect}"
   end
 
   def test_a_well_formed_address_that_does_not_exist
     address = new_address('heycarsten@i-surely-do-not-exist.nil')
-    assert !address.valid?,
-      'Should not be valid.'
+    address.stubs(:domain).with(nil).
+      returns(stub(:errors => [:no_address_servers]))
+    assert !address.valid?, 'Should not be valid.'
   end
 
   def test_a_well_formed_address_that_exists
     address = new_address('itsme@heycarsten.com')
-    assert address.valid?,
-      "Should be valid. @errors: #{address.errors.inspect}"
+    address.stubs(:domain).with(nil).returns(stub(:errors => []))
+    assert address.valid?, "Should be valid. @errors: #{address.errors.inspect}"
   end
 
   private

data/test/unit/config_test.rb

@@ -95,6 +95,10 @@ class DefaultValidAddressPatternTest < Test::Unit::TestCase
       ungültige@adresse.de
       failure@10.0.0.1
       douche@@bag.net
+      -@fail.org
+      _@fail.org
+      +_-@fail.die
+      +___--@crashburn.net
     ].each do |address|
       assert_no_match EmailVeracity::Config[:valid_pattern],
         address,

data/test/unit/core_extensions_test.rb

@@ -5,9 +5,11 @@ class ArrayExtensionsTest < Test::Unit::TestCase
 
   def test_reject_blank_items
     array = [[], {}, '', nil, '    ', 'good times!']
-    assert_equal ['good times!'], array.reject_blank_items, 'Should reject all blank and empty objects.'
+    assert_equal ['good times!'], array.reject_blank_items,
+      'Should reject all blank and empty objects.'
     array = [{:neat => 'o'}, ['cool'], 1, 's']
-    assert_equal array, array.reject_blank_items, 'Should not reject any filled or not-blank objects.'
+    assert_equal array, array.reject_blank_items,
+      'Should not reject any filled or not-blank objects.'
   end
 
   def test_contains_single_item

data/test/unit/domain_test.rb

@@ -31,23 +31,49 @@ class DomainTest < Test::Unit::TestCase
     assert_respond_to domain, :to_s, 'Should have a to_s method.'
   end
 
-  def test_a_valid_domain_for_servers
-    domain = new_domain('gmail.com')
-    assert_not_empty domain.exchange_servers, 'Should contain mail servers.'
+  def test_a_valid_domain_for_address_servers
+    domain_name = 'gmail.com'
+    domain = new_domain(domain_name)
+    EmailVeracity::Resolver.expects(:get_servers_for).
+      with(domain_name.strip, :a).returns(["mail.#{domain_name}"])
     assert_not_empty domain.address_servers, 'Should contain address servers.'
   end
 
-  def test_a_valid_domain_with_whitespace_for_servers
-    domain = new_domain('  learnhub.com  ')
+  def test_a_valid_domain_for_exchange_servers
+    domain_name = 'gmail.com'
+    domain = new_domain(domain_name)
+    EmailVeracity::Resolver.expects(:get_servers_for).
+      with(domain_name.strip, :mx).returns(["mail.#{domain_name}"])
     assert_not_empty domain.exchange_servers, 'Should contain mail servers.'
+  end
+
+  def test_a_valid_domain_with_whitespace_for_address_servers
+    domain_with_whitespace = '  learnhub.com  '
+    domain = new_domain(domain_with_whitespace)
+    EmailVeracity::Resolver.expects(:get_servers_for).
+      with(domain_with_whitespace.strip, :a).returns(%w(mail.learnhub.com))
     assert_not_empty domain.address_servers, 'Should contain address servers.'
   end
 
-  def test_an_invalid_domain_for_servers
+  def test_a_valid_domain_with_whitespace_for_exchange_servers
+    domain_with_whitespace = '  learnhub.com  '
+    domain = new_domain(domain_with_whitespace)
+    EmailVeracity::Resolver.expects(:get_servers_for).
+      with(domain_with_whitespace.strip, :mx).returns(%w(mail.learnhub.com))
+    assert_not_empty domain.exchange_servers, 'Should contain address servers.'
+  end
+
+  def test_an_invalid_domain_for_address_servers
     domain = new_domain('i-surely-do-not.exist')
-    assert_empty domain.exchange_servers, 'Should not contain exchange servers.'
+    domain.expects(:servers_in).with(:a).returns([])
     assert_empty domain.address_servers, 'Should not contain address servers.'
   end
+  
+  def test_an_invalid_domain_for_exchange_servers
+    domain = new_domain('i-surely-do-not.exist')
+    domain.expects(:servers_in).with(:mx).returns([])
+    assert_empty domain.exchange_servers, 'Should not contain exchange servers.'
+  end
 
   def test_a_blank_domain_for_servers
     domain = new_domain('')
@@ -62,6 +88,8 @@ class DomainTest < Test::Unit::TestCase
 
   def test_for_errors_on_an_invalid_domain
     domain = new_domain('i-surely-do-not.exist')
+    domain.expects(:address_servers).returns([])
+    domain.expects(:exchange_servers).returns([])
     assert_not_empty domain.errors, 'Should have errors.'
   end
 

data/test/unit/resolver_test.rb

@@ -4,22 +4,26 @@ require File.dirname(__FILE__) + '/../test_helper'
 class ResolverTest < Test::Unit::TestCase
 
   def test_consecutive_queries
-    EmailVeracity::Config[:timeout] = 60
+    domain_names.each do |domain_name|
+      EmailVeracity::Resolver.stubs(:get_resources_for).
+        with(domain_name, kind_of(Symbol)).returns(["mail.#{domain_name}"])
+    end
     assert_nothing_raised do
       domain_names.each do |domain|
-        assert_instance_of Array,
-          EmailVeracity::Resolver.get_servers_for(domain),
+        assert_instance_of Array, EmailVeracity::Resolver.get_servers_for(domain),
           'Should return an array of servers'
       end
     end
   end
 
   def test_timing_out_while_resolving_a_domain
-    EmailVeracity::Config[:timeout] = 0.001
+    domain = 'learnhub.com'
+    timeout_exception = Timeout::Error.new('The connection has timed out')
+    EmailVeracity::Resolver.stubs(:get_resources_for).
+      with(domain, kind_of(Symbol)).raises(timeout_exception)
     assert_raise EmailVeracity::DomainResourcesTimeoutError, 'Should time out' do
-      EmailVeracity::Resolver.get_servers_for('learnhub.com')
+      EmailVeracity::Resolver.get_servers_for(domain)
     end
-    EmailVeracity::Config[:timeout] = 2
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: heycarsten-email-veracity
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Carsten Nielsen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-06 00:00:00 -07:00
+date: 2008-10-27 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -19,32 +19,26 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - lib/email_veracity/address.rb
 - lib/email_veracity/config.rb
 - lib/email_veracity/core_extensions.rb
 - lib/email_veracity/domain.rb
-- lib/email_veracity/errors.rb
 - lib/email_veracity/resolver.rb
 - lib/email_veracity/server.rb
 - lib/email_veracity/validatability.rb
 - lib/email_veracity.rb
-- README.rdoc
-- VERSION
+- README.markdown
+- LICENSE
 - Rakefile
 - init.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/heycarsten/email-veracity
 post_install_message: 
-rdoc_options: 
-- --title
-- Email Veracity
-- --main
-- README.rdoc
-- --line-numbers
-- --inline-source
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -61,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: email-veracity
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2

data/README.rdoc

@@ -1,72 +0,0 @@
-= Email Veracity
-
-A straight-forward Ruby library for checking the real-world validity of email
-addresses.
-
-
-=== It Can
-
-* Validate email addresses for proper form against a pattern.
-* Accept and reject addresses based whitelists and blacklists of domains.
-* Check an address' domain for MX and/or A records.
-* Be configured for a variety of use-cases, to be as discerning or as
-  indiscriminate as you would like.
-
-
-=== It Can Not
-
-* Validate all possible permutations of addresses to the RFC 2822
-  specification.
-
-
-== Using The Gem
-
-In your project, you must require +email_veracity+ after that you can try it
-out, consider the following examples:
-
-
- require 'email_veracity'
- 
- address = EmailVeracity::Address.new('heycarsten@gmail.com')
- 
- address.valid?
- # => true
- 
- address.domain.to_s
- # => 'gmail.com'
- 
- address.domain.address_servers.collect { |s| s.to_s }
- # => ["64.233.171.83", "64.233.161.83", "209.85.171.83"]
- 
- address = EmailVeracity::Address.new('fakey@crazy-z3d9df-domain.com')
- 
- address.valid?
- # => false
- 
- address.errors
- # => [:no_address_servers]
-
-
-As you can see, playing with the core library is pretty fun.  The basic building
-blocks are:
-
-==== Address
-
-Responsible for parsing full email addresses and checking for pattern-based
-validity.
-
-==== Domain
-
-Contains methods to query the domain for information.
-
-==== Resolver
-
-Abstracts Resolv::DNS into a super-simple single public method, this is where
-the timeout error is raised.
-
-
-== Running The Tests
-
-A few of the tests will fail if you don't have a live connection to the
-internet, this is obviously not cool and it's high on my list of TODOs. [See
-TODO]

data/VERSION

@@ -1 +0,0 @@
-0.3.0

data/lib/email_veracity/errors.rb

@@ -1,9 +0,0 @@
-module EmailVeracity
-
-
-  class Error < StandardError; end
-  class MalformedEmailAddressError < Error; end
-  class DomainResourcesTimeoutError < Error; end
-
-
-end