validates_hostname 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b93ae9e0bcc94ecaf79a327d3120bab167699f8
+  data.tar.gz: bf5b1a9a2ab5bcf9791a26fe9dfff850395ca208
+SHA512:
+  metadata.gz: 991c1be00d6f1b489451c342e3f885cb850b4555026d79f6d46d6aefffbc493e45046548bb03bc3b66bdf3f4c2b1be860e2e7cbd5f5359b19be51fbc6a3a45e3
+  data.tar.gz: 3d1ef718057891a9594f4b72b410bf2fa8a0cb64166809838a13c8179c1046bac82fe5f0d8f8ccb9ebae36c3b140f625384a9bd0625242b71fece4a3e5edeee8

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+* 1.0.0 [2011-01-12]
+* Initial commit

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sean Huber (shuber@huberry.com)
+ 
+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.rdoc

@@ -0,0 +1,205 @@
+= ValidatesHostname
+
+* Source: https://github.com/KimNorgaard/validates_hostname
+* Bugs:   https://github.com/KimNorgaard/validates_hostname/issues
+
+== Description
+
+Extension to ActiveRecord::Base for validating hostnames and domain names.
+
+
+== Features
+
+* Adds validation for hostnames to ActiveModel
+
+* Supports I18n for the error messages
+
+== Installation
+
+As plugin (from master)
+
+  rails plugin install git://github.com/KimNorgaard/validates_hostname.git
+
+As gem
+
+  # in Gemfile
+  gem 'validates_hostname', '-> 1.0.0'
+  
+  # Run bundler
+  $ bundle install
+
+
+== Validations performed
+
+* maximum length of hostname is 255 characters
+
+* maximum length of each hostname label is 63 characters
+
+* characters allowed in hostname labels are a-z, A-Z, 0-9 and hyphen
+
+* labels do not begin or end with a hyphen
+
+* labels do not consist of numeric values only
+
+
+== Options
+
+* option to allow for underscores in hostname labels
+
+* option to require that the last label is a valid TLD (ie. require that the name is a FQDN)
+
+* option to allow numeric values in the first label of the hostname (exception: the hostname cannot consist of a single numeric label)
+
+* option to specify a list of valid TLDs
+
+* options to allow for wildcard hostname in first label (for use with DNS)
+
+See also http://www.zytrax.com/books/dns/apa/names.html
+
+
+== How to use
+
+Simple usage
+
+  class Record < ActiveRecord::Base
+    validates :name, :hostname => true
+  end
+
+With options
+
+  class Record < ActiveRecord::Base
+    validates :name, :hostname => { OPTIONS }
+  end
+
+
+== Options and their defaults:
+
+* :allow_underscore => false
+
+* :require_valid_tld => false
+
+* :valid_tlds => Array of allowed TLDs (can only be used with :require_fqdn => true)
+
+* :allow_numeric_hostname => false
+
+
+== Examples
+
+Without options
+
+  class Record < ActiveRecord::Base
+    validates :host, :hostname => true
+  end
+
+  >> @record = Record.new :name => 'horse'
+  >> @record.save
+  => true
+
+  >> @record2 = Record.new :name => '_horse'
+  >> @record2.save
+  => false
+
+With :allow_underscore
+
+  class Record < ActiveRecord::Base
+    validates :name, :hostname => { :allow_underscore => true }
+  end
+
+  >> @record3 = Record.new :name => '_horse'
+  >> @record3.save
+  => true
+
+With :require_valid_tld
+
+  class Record < ActiveRecord::Base
+    validates :name, :hostname => { :require_valid_tld => true }
+  end
+
+  >> @record4 = Record.new :name => 'horse'
+  >> @record4.save
+  => false
+
+  >> @record5 = Record.new :name => 'horse.com'
+  >> @record5.save
+  => true
+
+With :valid_tlds
+
+  class Record < ActiveRecord::Base
+    validates :name, :hostname => { :require_valid_tld, :valid_tlds => %w(com org net) }
+  end
+
+  >> @record6 = Record.new :name => 'horse.info'
+  >> @record6.save
+  => false
+
+With :allow_numeric_hostname
+
+  class Record < ActiveRecord::Base
+    validates :name, :hostname => { :allow_numeric_hostname => false }
+  end
+
+  >> @record7 = Record.new :name => '123.info'
+  >> @record7.save
+  => false
+
+With :allow_wildcard_hostname
+
+  class Record < ActiveRecord::Base
+    validates :name, :hostname => { :allow_wildcard_hostname => true }
+  end
+
+  >> @record8 = Record.new :name => '*.123.info'
+  >> @record8.save
+  => true
+
+
+== Extra validators
+
+A few extra validators are included.
+
+=== domainname
+
+* sets require_valid_tld       => true
+
+* sets allow_numeric_hostname  => true
+
+* returns error if there is only one label and this label is numeric
+
+=== fqdn
+
+* sets require_valid_tld       => true
+
+=== wildcard
+
+* sets allow_wildcard_hostname => true
+
+
+== Error messages
+
+Using the I18n system to define new defaults:
+
+  en:
+    errors:
+      messages:
+        invalid_label_length: "label must be between 1 and 63 characters long"
+        label_begins_or_ends_with_hyphen: "label begins or ends with a hyphen"
+        hostname_label_is_numeric: "unqualified hostname part cannot consist of numeric values only"
+        single_numeric_hostname_label: "hostnames cannot consist of a single numeric label"
+        label_contains_invalid_characters: "label contains invalid characters (valid characters: [%{valid_chars}])"
+        invalid_hostname_length: "hostname must be between 1 and 255 characters long"
+        tld_is_invalid: "tld of hostname is invalid"
+
+The %{valid_chars} signifies the range of valid characters allowed in labels.
+
+It is highly recommended you use the I18n system for error messages.
+
+
+== Maintainers
+
+*  {Kim Nørgaard}[<jasen@jasen.dk>]
+
+
+== License
+
+Copyright (c) 2009-2011 Kim Norgaard, released under the MIT license

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'rspec/core/rake_task'
+require './lib/validates_hostname/version'
+
+GEM_NAME = "validates_hostname"
+GEM_VERSION = PAK::ValidatesHostname::VERSION
+ 
+spec = Gem::Specification.new do |s|
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.rubyforge_project = "validates_hostname"
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc", "MIT-LICENSE"]
+  s.summary = %q{Checks for valid hostnames}
+  s.description = %q{Extension to ActiveRecord::Base for validating hostnames}
+  s.author = "Kim Norgaard"
+  s.email = "jasen@jasen.dk"
+  s.homepage = "https://github.com/KimNorgaard/validates_hostname"
+  s.require_path = 'lib'
+  s.files = %w(validates_hostname.gemspec MIT-LICENSE CHANGELOG.rdoc README.rdoc Rakefile) + Dir.glob("{lib,spec}/**/*")
+end
+
+desc 'Test the validates_as_hostname gem/plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true 
+end
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+end
+
+desc 'Generate documentation for plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidatesHostname'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  sh %{gem install pkg/#{GEM_NAME}-#{GEM_VERSION}}
+end
+
+desc "Create a gemspec file"
+task :make_spec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+ 

data/lib/validates_hostname.rb

@@ -0,0 +1,176 @@
+require 'active_support/concern'
+require 'active_model'
+
+module PAK
+  module ValidatesHostname
+    autoload :VERSION, 'validates_hostname/version'
+
+    # List from IANA: http://www.iana.org/domains/root/db/
+    ALLOWED_TLDS = %w(
+      ac ad ae aero af ag ai al am an ao aq ar arpa as asia at au aw ax az 
+      ba bb bd be bf bg bh bi biz bj bl bm bn bo br bs bt bv bw by bz 
+      ca cat cc cd cf cg ch ci ck cl cm cn co com coop cr cu cv cx cy cz 
+      de dj dk dm do dz 
+      ec edu ee eg eh er es et eu 
+      fi fj fk fm fo fr 
+      ga gb gd ge gf gg gh gi gl gm gn gov gp gq gr gs gt gu gw gy 
+      hk hm hn hr ht hu 
+      id ie il im in info int io iq ir is it 
+      je jm jo jobs jp 
+      ke kg kh ki km kn kp kr kw ky kz 
+      la lb lc li lk lr ls lt lu lv ly 
+      ma mc md me mf mg mh mil mk ml mm mn mo mobi mp mq mr ms mt mu museum 
+      mv mw mx my mz 
+      na name nc ne net nf ng ni nl no np nr nu nz 
+      om org 
+      pa pe pf pg ph pk pl pm pn pr pro ps pt pw py 
+      qa 
+      re ro rs ru rw 
+      sa sb sc sd se sg sh si sj sk sl sm sn so sr st su sv sy sz 
+      tc td tel tf tg th tj tk tl tm tn to tp tr travel tt tv tw tz 
+      ua ug uk um us uy uz 
+      va vc ve vg vi vn vu 
+      wf ws 
+      ye yt yu 
+      za zm zw
+    )
+    
+    DEFAULT_ERROR_MSG = {
+      :invalid_hostname_length            => 'hostname must be between 1 and 255 characters long',
+      :invalid_label_length               => 'label must be between 1 and 63 characters long',
+      :label_begins_or_ends_with_hyphen   => 'label begins or ends with hyphen',
+      :label_contains_invalid_characters  => "label contains invalid characters (valid characters: [%{valid_chars}])",
+      :hostname_label_is_numeric          => 'unqualified hostname part cannot consist of numeric values only',
+      :hostname_is_not_fqdn               => 'hostname is not a fully qualified domain name',
+      :single_numeric_hostname_label      => 'hostnames cannot consist of a single numeric label'
+    }.freeze
+    
+    class HostnameValidator < ActiveModel::EachValidator
+      def initialize(options)
+        opts = {
+          :allow_underscore        => false,
+          :require_valid_tld       => false,
+          :valid_tlds              => ALLOWED_TLDS,
+          :allow_numeric_hostname  => false,
+          :allow_wildcard_hostname => false
+        }.merge(options)
+        super(opts)
+      end
+      
+      def validate_each(record, attribute, value)
+        value ||= ''
+        # maximum hostname length: 255 characters
+        add_error(record, attribute, :invalid_hostname_length) unless value.length.between?(1, 255)
+        
+        # split each hostname into labels and do various checks
+        if value.is_a?(String)
+          labels = value.split '.'
+          labels.each_with_index do |label, index|
+            # CHECK 1: hostname label cannot be longer than 63 characters
+            add_error(record, attribute, :invalid_label_length) unless value.length.between?(1, 63)
+
+            # CHECK 2: hostname label cannot begin or end with hyphen
+            add_error(record, attribute, :label_begins_or_ends_with_hyphen) if label =~ /^[-]/i or label =~ /[-]$/
+
+            # Take care of wildcard first label
+            next if options[:allow_wildcard_hostname] and label == '*' and index == 0
+
+            # CHECK 3: hostname can only contain characters: 
+            #          a-z, 0-9, hyphen, optional underscore, optional asterisk
+            valid_chars = 'a-z0-9\-'
+            valid_chars << '_' if options[:allow_underscore] == true
+            add_error(record, attribute, :label_contains_invalid_characters, :valid_chars => valid_chars) unless label =~ /^[#{valid_chars}]+$/i
+          end
+
+          # CHECK 4: the unqualified hostname portion cannot consist of 
+          #          numeric values only
+          if options[:allow_numeric_hostname] == false
+            is_numeric_only = (
+              (
+                Integer(labels[0]) rescue false
+              ) ? true : false
+            )
+            add_error(record, attribute, :hostname_label_is_numeric) if is_numeric_only
+          end
+
+          # CHECK 5: in order to be fully qualified, the full hostname's
+          #          TLD must be valid
+          if options[:require_valid_tld] == true
+            has_tld = options[:valid_tlds].select {
+              |tld| tld =~ /^#{Regexp.escape(labels.last || '')}$/i
+            }.empty? ? false : true
+            add_error(record, attribute, :hostname_is_not_fqdn) unless has_tld
+          end
+        end
+      end
+      
+      def add_error(record, attr_name, message, *interpolators)
+        args = {
+          :default => [DEFAULT_ERROR_MSG[message], options[:message]],
+          :scope   => [:errors, :messages]
+        }.merge(interpolators.last.is_a?(Hash) ? interpolators.pop : {})
+        record.errors.add(attr_name, I18n.t( message, args ))
+      end
+    end
+
+    class DomainnameValidator < HostnameValidator
+      def initialize(options)
+        opts = {
+          :require_valid_tld       => true,
+          :allow_numeric_hostname  => true
+        }.merge(options)
+        super(opts)
+      end
+      
+      def validate_each(record, attribute, value)
+        super
+        
+        if value.is_a?(String)
+          labels = value.split '.'
+          labels.each do |label|
+            # CHECK 1: if there is only one label it cannot be numeric even
+            #          though numeric hostnames are allowed
+            if options[:allow_numeric_hostname] == true
+              is_numeric_only = (
+                (
+                  Integer(labels[0]) rescue false
+                ) ? true : false
+              )
+              if is_numeric_only and labels.size == 1
+                add_error(record, attribute, :single_numeric_hostname_label)
+              end
+            end
+          end
+        end
+      end
+      
+      def add_error(record, attr_name, message, *interpolators)
+        args = {
+          :default => [DEFAULT_ERROR_MSG[message], options[:message]],
+          :scope   => [:errors, :messages]
+        }.merge(interpolators.last.is_a?(Hash) ? interpolators.pop : {})
+        record.errors.add(attr_name, I18n.t( message, args ))
+      end      
+    end
+
+    class FqdnValidator < HostnameValidator
+      def initialize(options)
+        opts = {
+          :require_valid_tld       => true,
+        }.merge(options)
+        super(opts)
+      end
+    end
+
+    class WildcardValidator < HostnameValidator
+      def initialize(options)
+        opts = {
+          :allow_wildcard_hostname => true,
+        }.merge(options)
+        super(opts)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, PAK::ValidatesHostname)

data/lib/validates_hostname/version.rb

@@ -0,0 +1,5 @@
+module PAK
+  module ValidatesHostname
+    VERSION = '1.0.1'
+  end
+end

data/validates_hostname.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "validates_hostname/version"
+
+Gem::Specification.new do |s|
+  s.name                      = 'validates_hostname'
+  s.version                   = PAK::ValidatesHostname::VERSION
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors                   = ["Kim Nørgaard"]
+  s.description               = 'Extension to ActiveRecord::Base for validating hostnames'
+  s.summary                   = 'Checks for valid hostnames'
+  s.email                     = 'jasen@jasen.dk'
+  s.extra_rdoc_files          = ["README.rdoc", "CHANGELOG.rdoc", "MIT-LICENSE"]
+  s.files                     = ["validates_hostname.gemspec", "MIT-LICENSE", "CHANGELOG.rdoc", "README.rdoc", "Rakefile", "lib/validates_hostname", "lib/validates_hostname/version.rb", "lib/validates_hostname.rb"]
+  s.homepage                  = %q{https://github.com/KimNorgaard/validates_hostname}
+  s.licenses                  = 'MIT'
+  s.require_paths             = ["lib"]
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: validates_hostname
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Kim Nørgaard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-07 00:00:00.000000000 Z
+dependencies: []
+description: Extension to ActiveRecord::Base for validating hostnames
+email: jasen@jasen.dk
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG.rdoc
+- MIT-LICENSE
+files:
+- validates_hostname.gemspec
+- MIT-LICENSE
+- CHANGELOG.rdoc
+- README.rdoc
+- Rakefile
+- lib/validates_hostname/version.rb
+- lib/validates_hostname.rb
+homepage: https://github.com/KimNorgaard/validates_hostname
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Checks for valid hostnames
+test_files: []