domain_name_validator 0.2

data/ChangeLog.md

@@ -0,0 +1,15 @@
+0.2 (2013-06-24)
+----------------
+
+First version built and deployed as a gem on a real project, for general
+evaluation and testing purposes.
+
+* Added more RSpec tests for improved test coverage.
+* Enhanced documentation.
+
+
+0.1 (2013-06-18)
+----------------
+
+Initial working version of the code, with minimal RSpec tests. Released on
+GitHub for review, but not yet published as a gem to the Ruby community.

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    domain_name_validator (0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  domain_name_validator!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2013 David Keener
+
+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,66 @@
+domain_name_validator
+=====================
+
+Ever needed to validate a domain name? This gem will validate any domain name
+represented in ASCII or UTF-8.
+
+Domain names provide a unique, memorizable name to represent numerically
+addressable Internet resources. They also provide a level of abstraction that
+allows the underlying Internet address to be changed while still referencing
+a resource by its domain name. The domain name space is managed by the 
+Internet Corporation for Assigned Names and Numbers (ICANN).
+
+The right-most label of a domain name is referred to as the top-level domain, or
+TLD. A limited set of top-level domain names, and two-character country codes,
+have been standardized. The Internet Assigned Numbers Authority (IANA)
+maintains an annotated list of top-level domains, as well as a list of
+"special use," or reserved, top-level domain names.
+
+* http://www.iana.org/domains/root/db/
+* http://www.iana.org/assignments/special-use-domain-names/special-use-domain-names.xml
+
+Domain names follow some very detailed rules:
+
+1. The maximum length of a domain name is 253 characters.
+
+2. A domain name is divided into "labels" separated by periods. The maximum
+   number of labels is 127.
+
+3. The maximum length of any label within a domain name is 63 characters.
+
+4. No label, including TLDs, can begin or end with a dash.
+
+5. Top-level domain names cannot be all numeric.
+
+6. The right-most label must be either a recognized TLD or a 2-letter country
+   code. The only exception is for international domain names, for which
+   TLD checking is currently bypassed.
+
+
+Internationalized Domain Names
+------------------------------
+
+What about internationalized domain names? ICANN approved the Internationalized
+Domain Name (IDNA) system in 2003. This standard allows for Unicode domain
+names to be encoded into ASCII using Punycode. Essentially, a label may contain
+"xn--" as a prefix, followed by the Punycode representation of a Unicode string,
+resulting in domain names such as xn--kbenhavn-54.eu. Note that there are also
+some approved Unicode TLDs.
+
+The process of rendering an internationalized domain name in ASCII via 
+Punycode is called normalization. This gem will validate a normalized domain
+name, but not a Unicode domain name. Note, however, that it currently does not
+validate normalized TLDs against ICANN's list of valid TLDs.
+
+It's also unclear whether the "xn--" prefix should count against the label
+size limit of 63 characters. In the absence of specific guidelines, and because
+I've never actually seen an overly long label, I have chosen to apply the limit
+irregardless of the presence of the "xn--" prefix within a label.
+
+YOUR SUPPORT
+------------
+
+Please help me make this gem as useful as possible for its admittedly limited
+purpose. If ICANN's rules change, a clearer rules interpretation becomes
+available, or new valid TLDs are added, please help out by notifying me of
+potentially useful changes, or by submitting a pull request via GitHub.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+# or....
+# require 'bundler/gem_tasks'

data/domain_name_validator.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "domain_name_validator/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "domain_name_validator"
+  gem.version     = DomainNameValidator::VERSION
+  gem.date        = '2013-06-17'
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ["David Keener"]
+  gem.email       = ["dkeener@keenertech.com"]
+  gem.homepage    = "http://www.keenertech.com"
+  gem.summary     = %q{Domain Name Validator}
+  gem.description = %q{Checks the validity of domain names.}
+ 
+  gem.add_development_dependency "rspec"
+
+  gem.rubyforge_project = "domain_name_validator"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  #gem.rdoc_options = ["--charset=UTF-8"]
+  #gem.extra_rdoc_files = %w[README.rdoc LICENSE Changelog.rdoc]
+
+  gem.require_paths = ["lib"]
+end

data/lib/domain_name_validator/validator.rb

@@ -0,0 +1,49 @@
+# The purpose of this class is to provide a simple capability for validating
+# domain names represented in ASCII or UTF-8, a feature that seems to be
+# missing from other more wide-ranging domain-related gems.
+
+class DomainNameValidator
+
+  MAX_DOMAIN_LENGTH = 253
+  MAX_LABEL_LENGTH = 63
+  MAX_LEVELS = 127
+  MIN_LEVELS = 2
+
+  ERR_MAX_DOMAIN_SIZE = 'Maximum domain length of 253 exceeded'
+  ERR_MAX_LABEL_SIZE = 'Maximum domain label length of 63 exceeded'
+  ERR_MAX_LEVEL_SIZE = 'Maximum domain level limit of 127 exceeded'
+  ERR_MIN_LEVEL_SIZE = 'Minimum domain level limit of 2 not achieved'
+  ERR_LABEL_DASH_BEGIN = 'No domain label may begin with a dash'
+  ERR_LABEL_DASH_END = 'No domain label may end with a dash'
+  ERR_TOP_NUMERICAL = 'The top-level domain (the extension) cannot be numerical'
+  ERR_ILLEGAL_CHARS = 'Domain label contains an illegal character'
+
+  # Validates the proper formatting of a normalized domain name, i.e. - a
+  # domain that is represented in ASCII. Thus, international domain names are
+  # supported and validated, if they have undergone the required IDN
+  # conversion to ASCII. The validation rules are:
+  #
+  # 1. The maximum length of a domain name is 253 characters.
+  # 2. A domain name is divided into "labels" separated by periods. The maximum
+  #    number of labels (including the top-level domain as a label) is 127.
+  # 3. The maximum length of any label within a domain name is 63 characters.
+  # 4. No label, including top-level domains, can begin or end with a dash.
+  # 5. Top-level names cannot be all numeric.
+
+  def validate(dn, errs = [])
+    errs << ERR_MAX_DOMAIN_SIZE if dn.size > MAX_DOMAIN_LENGTH
+    parts = dn.split('.')
+    errs << ERR_MAX_LEVEL_SIZE if parts.size > MAX_LEVELS
+    errs << ERR_MIN_LEVEL_SIZE if parts.size < MIN_LEVELS
+    parts.each do |p|
+      errs << ERR_MAX_LABEL_SIZE if p.size > MAX_LABEL_LENGTH
+      errs << ERR_LABEL_DASH_BEGIN if p[0] == '-'
+      errs << ERR_LABEL_DASH_END if p[-1] == '-'
+      errs << ERR_ILLEGAL_CHARS unless p.match(/^[a-z0-9\-\_]+$/)
+    end
+    errs << ERR_TOP_NUMERICAL if parts.last.match(/^[0-9]+$/)
+
+    errs.size == 0   # TRUE if valid, FALSE otherwise
+  end
+
+end

data/lib/domain_name_validator/version.rb

@@ -0,0 +1,3 @@
+class DomainNameValidator
+  VERSION = "0.2"
+end

data/lib/domain_name_validator.rb

@@ -0,0 +1,5 @@
+require 'domain_name_validator/validator'
+require 'domain_name_validator/version'
+
+class DomainNameValidator
+end

data/spec/domain_name_validator_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe DomainNameValidator do
+
+  before(:each) do
+    @validator = DomainNameValidator.new
+  end
+
+  describe 'Basic Validation' do
+
+    it 'should pass a valid domain name' do
+      response = @validator.validate('keenertech.com')
+      response.should be == true
+    end
+
+    it 'should fail when it finds a numeric top-level extension' do
+      response = @validator.validate('keenertech.123')
+      response.should be == false
+    end
+
+    it 'should fail when the domain name max size is exceeded' do
+      domain = "a"*250 + ".com"    # 254 chars; max is 253
+      response = @validator.validate(domain)
+      response.should be == false
+    end
+
+    it 'should fail when the max number of levels is exceeded' do
+      domain = "a."*127 + "com"    # 128 levels; max is 127
+      response = @validator.validate(domain)
+      response.should be == false
+    end
+
+    it 'should fail when a label exceeds the max label length' do
+      domain = "a"*64 + "b.c.com"    # 64 chars; max is 63 for a label
+      response = @validator.validate(domain)
+      response.should be == false
+    end
+
+    it 'should fail when a label begins with a dash' do
+      domain = "a.-b.c.com"
+      response = @validator.validate(domain)
+      response.should be == false
+    end
+
+    it 'should fail when a TLD begins with a dash' do
+      domain = "a.b.c.-com"
+      response = @validator.validate(domain)
+      response.should be == false
+    end
+  end
+
+  describe 'Internationalized (normalized) domain names' do
+
+    it 'should fail when a TLD begins with a dash' do
+      domain = "xn--kbenhavn-54.eu"
+      response = @validator.validate(domain)
+      response.should be == true
+    end
+
+  end
+
+  # TODO: (2013/06/24) TLD checking will be added soon....
+
+  describe 'TLD Checking' do
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib domain_name_validator]))
+        
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: domain_name_validator
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
+platform: ruby
+authors:
+- David Keener
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &30848232 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *30848232
+description: Checks the validity of domain names.
+email:
+- dkeener@keenertech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ChangeLog.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- domain_name_validator.gemspec
+- lib/domain_name_validator.rb
+- lib/domain_name_validator/validator.rb
+- lib/domain_name_validator/version.rb
+- spec/domain_name_validator_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.keenertech.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: domain_name_validator
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Domain Name Validator
+test_files: []