kch-dominion 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2010 Caio Chassot
+
+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,41 @@
+# Dominion
+
+Dominion is a library to extract information from a domain name.
+
+We're basically interested in two particulars:
+
+* _The de facto TLD_: this is the part of the domain a NIC would be responsible
+  for. It may be an honest-to-god TLD, or a ccTLD, and more importantly, a ccSLD.
+
+* _The base domain_: That is the domain that is registered with the NIC, clear of
+  any subdomains.
+
+To resolve this we rely on the Mozilla Foundation's Public Suffix List, which can
+be found at <http://publicsuffix.org/list/>.
+
+See <http://publicsuffix.org/> to learn more.
+
+A copy of the list file is provided with this library in `var/tlds.dat`, and loaded
+automatically when you `require 'dominion'`.
+
+
+# Usage
+
+    require 'dominion'
+
+    d = Dominion::DomainName.new(".name")
+    d.tld?  # => true
+    d.tld   # => "name"
+    d.base  # => "name"
+
+    d = Dominion::DomainName.new("foo.bar.co.uk")
+    d.tld?  # => false
+    d.tld   # => "co.uk"
+    d.base  # => "bar.co.uk"
+
+
+# Colophon
+
+Copyright © 2010 Caio Chassot  
+Released under the MIT license  
+<http://github.com/kch/dominion>  

data/lib/dominion.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), "dominion/domain_suffix_rule")
+require File.join(File.dirname(__FILE__), "dominion/domain_name")
+
+Dominion::DomainName.load_rules_from_file(File.join(File.dirname(__FILE__), '../var/tlds.dat'))

data/lib/dominion/domain_name.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+module Dominion
+  class DomainName
+    attr_reader :labels, :rule
+
+    # returns the current rule list or takes a new rule list; rules must be DomainSuffixRule instances.
+    def self.rules(rules = nil)
+      @rules = rules if rules
+      @rules
+    end
+
+    # takes the path to a rule file in the format defined in http://publicsuffix.org/format/
+    def self.load_rules_from_file(path)
+      rules open(path).lines.reject { |s| s =~ %r[\A\s*(//.*)?\Z\n?] }.map { |s| DomainSuffixRule.new(s) }.sort << DomainSuffixRule.new("*")
+    end
+
+    # takes a domain string as argument; i.e. the hostname part of a URL
+    def initialize(s)
+      raise "No DomainSuffixRule rules loaded" unless self.class.rules
+      @labels = s.strip.gsub(/\A\.|\.\z/, '').split(".").reverse
+      @rule   = self.class.rules.find { |rule| rule =~ self } or raise "Domain #{s.inspect} didn't match any rule."
+    end
+
+    # is this a TLD, ccTLD, ccSLD, etc.?
+    def tld?
+      labels.length == rule.length
+    end
+
+    # returns the TLD part of the domain
+    def tld
+      domain(0)
+    end
+
+    # returns the base domain; i.e. the registered domain
+    def base
+      domain(1)
+    end
+
+    # return the domain with the specified number of extra labels over the TLD. Used internally.
+    def domain(non_tld_label_count = 1)
+      labels[0, rule.length + non_tld_label_count].reverse.join(".")
+    end
+
+  end
+end

data/lib/dominion/domain_suffix_rule.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+module Dominion
+  class DomainSuffixRule
+    attr_reader :labels, :exception, :length
+
+    def initialize(s)
+      @string    = s.strip.gsub(/\A\.|\.\z/, '')
+      @labels    = @string.split(/\A!|\./).reverse
+      @exception = @labels.last.empty? and @labels.pop
+      @length    = @labels.length - (@exception ? 1 : 0)
+    end
+
+    # match against a domain name. the domain must be an instance of DomainName
+    def =~(domain)
+      labels.zip(domain.labels).all? { |r, d| ["*", d].include? r }
+    end
+
+    def inspect
+      @string
+    end
+
+
+    protected
+
+    # these are used internally for sorting a list of rules so that the first match is the correct match
+    # according to the algorithm defined in http://publicsuffix.org/format/
+
+    def comparable
+      [@exception ? 0 : 1, -@length, @string]
+    end
+
+    def <=> other
+      comparable <=> other.comparable
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: kch-dominion
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Caio Chassot
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-17 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dev@caiochassot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.markdown
+- lib/dominion/domain_name.rb
+- lib/dominion/domain_suffix_rule.rb
+- lib/dominion.rb
+has_rdoc: true
+homepage: http://github.com/kch/dominion
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Extract TLD information from a domain name.
+test_files: []
+