domain_name_validator 0.3 → 0.4

data/ChangeLog.md

@@ -1,3 +1,14 @@
+0.4 (2013-07-17)
+----------------
+
+* By request, added rudimentary TLD checking. A TLD, the right-most label of a
+  domain name, should be either 2 or 3 characters, unless it's "aero", "arpa",
+  "museum" or begins with "xn--" (for a normalized Unicode TLD). This check
+  does not validate against a master list of TLD's, but basically just fails
+  a domain name if the TLD basically could not be valid under any
+  circumstances. This validation would, for example, reject a domain name
+  such as "test.domain".
+
 0.3 (2013-06-28)
 ----------------
 

data/Developers.md

@@ -0,0 +1,52 @@
+For Developers Only
+===================
+
+Building and testing the domain_name_validator gem is pretty easy. 
+
+Gemspec
+-------
+
+The gemspec file for the gem, domain_name_validator.gemspec, is an active
+file containing Ruby code. In other words, the gemspec file itself has code
+to figure out what files should be included in the gem, etc. Each time a
+release is done, the only thing that needs to be edited is the "gem.date"
+property.
+
+Version
+-------
+
+The version number is defined in the version.rb file, located in the lib
+directory tree. The version number should be bumped up in some fashion with
+each release. Version numbers often have 3 digits, e.g. - 1.2.3. The left-most
+number is a release, followed by a sub-release and a patch. All versions
+within a release should generally be backwards compatible. A sub-release 
+generally include significant new features, whilea patch is generally a minor
+update (often a bug fix).
+
+The gemspec file automatically picks up the version number from the version.rb
+file, so make sure you keep it updated properly.
+
+Testing the Code
+----------------
+
+Testing the code is simple. Run the following command from the top level
+of the gem's directory tree:
+
+      $ bundle exec rspec spec
+
+Creating the Gem
+----------------
+
+To create the gem file for this gem, run the following command from the top
+level of the gem's directory tree:
+
+      $ gem build domain_name_validator.gemspec
+
+Pushing to RubyGems
+-------------------
+
+Obviously, you can only do this step if you've got the appropriate privileges
+at RubyGems.org and everything is properly configured.
+
+      $ gem push domain_name_validator.gem
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    domain_name_validator (0.3)
+    domain_name_validator (0.4)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -14,7 +14,7 @@ There are other gems and libraries that parse domain names into their various
 components, or parse URLS, or properly handle Unicode domain names, etc. Use
 them; many of them are very good at their well-defined roles. But none of the
 ones that I came across were very good at simply telling me whether a domain
-names was valid.
+names was valid, or WHY it was invalid if it failed the validations.
 
 How It Works
 ------------
@@ -120,8 +120,10 @@ Road Map
 --------
 
 More types of checks will be added as they are identified. Support for
-validating top-level domains is also in the works (it's a bit more complex
-than you might imagine).
+validating top-level domains (TLD's) is also in the works (it's a bit more
+complex than you might imagine). This will also bring in the capability to
+validate effective TLD's as well, i.e. - strings that are treated as top-level
+domains by registrars around the world.
 
 Alternative Gems
 ----------------
@@ -139,7 +141,7 @@ Author
 
 David Keener
 
-He's is a long-time Rubyist, with extensive experience both in the Internet
+He's a long-time Rubyist, with extensive experience both in the Internet
 startup world and government contracting. He is one of the founders of the
 RubyNation and DevIgnition conferences. He speaks often at technical
 conferences, and blogs regularly on Internet-related subjects at
@@ -149,7 +151,8 @@ Contributors
 ------------
 
 Many thanks for the support of General Dynamics and the Department of
-Homeland Security (DHS).
+Homeland Security (DHS). And more specifically on input from Andrew Finch,
+Josh Lentz, Jonathan Quigg and Dave Roberts.
 
 YOUR SUPPORT
 ------------

data/domain_name_validator.gemspec

@@ -5,7 +5,7 @@ require "domain_name_validator/version"
 Gem::Specification.new do |gem|
   gem.name        = "domain_name_validator"
   gem.version     = DomainNameValidator::VERSION
-  gem.date        = '2013-06-28'
+  gem.date        = '2013-07-17'
   gem.platform    = Gem::Platform::RUBY
   gem.authors     = ["David Keener"]
   gem.email       = ["dkeener@keenertech.com"]

data/lib/domain_name_validator/validator.rb

@@ -7,9 +7,21 @@ class DomainNameValidator
   MAX_DOMAIN_LENGTH = 253
   MAX_LABEL_LENGTH = 63
   MAX_LEVELS = 127
+  MAX_TLD_LENGTH = 3         # Except for "aero", "arpa", and "museum"
   MIN_LEVELS = 2
+  MIN_TLD_LENGTH = 2
 
   ERRS = {
+    :bogus_tld =>
+       'Malformed TLD',
+    :illegal_chars =>
+       'Domain label contains an illegal character',
+    :illegal_start =>
+       'No domain name may start with a period',
+    :label_dash_begin =>
+       'No domain label may begin with a dash',
+    :label_dash_end =>
+       'No domain label may end with a dash',
     :max_domain_size =>
        'Maximum domain length of 253 exceeded',
     :max_label_size =>
@@ -18,16 +30,8 @@ class DomainNameValidator
        'Maximum domain level limit of 127 exceeded',
     :min_level_size =>
        'Minimum domain level limit of 2 not achieved',
-    :label_dash_begin =>
-       'No domain label may begin with a dash',
-    :label_dash_end =>
-       'No domain label may end with a dash',
     :top_numerical =>
-       'The top-level domain (the extension) cannot be numerical',
-    :illegal_chars =>
-       'Domain label contains an illegal character',
-    :illegal_start =>
-       'No domain name may start with a period'
+       'The top-level domain (TLD) cannot be numerical'
     }
 
   # Validates the proper formatting of a normalized domain name, i.e. - a
@@ -55,6 +59,14 @@ class DomainNameValidator
       errs << ERRS[:illegal_chars] unless p.match(/^[a-z0-9\-\_]+$/)
     end
     errs << ERRS[:top_numerical] if parts.last.match(/^[0-9]+$/)
+    if parts.last.size < MIN_TLD_LENGTH || parts.last.size > MAX_TLD_LENGTH
+      unless parts.last == 'arpa' ||
+             parts.last == 'aero' ||
+             parts.last == 'museum' ||
+             parts.last.match(/^xn--/)
+        errs << ERRS[:bogus_tld]   
+      end
+    end
     errs << ERRS[:illegal_start] if parts.first[0] == '.'
 
     errs.size == 0   # TRUE if valid, FALSE otherwise

data/lib/domain_name_validator/version.rb

@@ -1,3 +1,3 @@
 class DomainNameValidator
-  VERSION = "0.3"
+  VERSION = "0.4"
 end

data/spec/domain_name_validator_spec.rb

@@ -57,7 +57,7 @@ describe DomainNameValidator do
 
   describe 'Internationalized (normalized) domain names' do
 
-    it 'should pass when a normalized international domain name' do
+    it 'should pass with a normalized international domain name' do
       domain = "xn--kbenhavn-54.eu"
       response = @validator.validate(domain)
       response.should be == true
@@ -65,9 +65,44 @@ describe DomainNameValidator do
 
   end
 
-  # TODO: (2013/06/24) TLD checking will be added soon....
+  describe 'Rudimentary TLD Checking' do
+
+    it 'should fail if the TLD is too short' do
+      domain = "test.a"
+      response = @validator.validate(domain)
+      response.should be == false
+    end
+
+    it 'should fail if the TLD is too long' do
+      domain = "test.domain"
+      response = @validator.validate(domain)
+      response.should be == false
+    end
+
+    it "should succeed if the TLD is too long but equals 'aero'" do
+      domain = "test.aero"
+      response = @validator.validate(domain)
+      response.should be == true
+    end
+
+    it "should succeed if the TLD is too long but equals 'arpa'" do
+      domain = "test.arpa"
+      response = @validator.validate(domain)
+      response.should be == true
+    end
+
+    it "should succeed if the TLD is too long but equals 'museum'" do
+      domain = "test.museum"
+      response = @validator.validate(domain)
+      response.should be == true
+    end
+
+    it "should succeed if the TLD is too long but matches 'xn--'" do
+      domain = "test.xn--really-long-text"
+      response = @validator.validate(domain)
+      response.should be == true
+    end
 
-  describe 'TLD Checking' do
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: domain_name_validator
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &31251708 !ruby/object:Gem::Requirement
+  requirement: &28073220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *31251708
+  version_requirements: *28073220
 description: Checks the validity of domain names.
 email:
 - dkeener@keenertech.com
@@ -30,6 +30,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ChangeLog.md
+- Developers.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt