public-suffix-list 0.0.1

data/README.rdoc

@@ -0,0 +1,55 @@
+= Public Suffix List
+
+* http://github.com/toddsundsted/Public-Suffix-List
+
+== Description
+
+The Public Suffix List (http://publicsuffix.org/) is "a cross-vendor
+initiative to provide an accurate list of domain name suffixes". Such
+a list is necessary because "there was and remains no algorithmic
+method of finding the highest level at which a domain may be
+registered for a particular top-level domain (the policies differ with
+each registry)...". Public Suffix List is also a small Ruby library
+designed to make the Public Suffix List (http://publicsuffix.org/)
+easier to use.
+
+== Features
+
+* Transparent download of the TLD data file
+* Optional caching of parsed data
+* Tiny API
+
+== Synopsis
+
+  PublicSuffixList.new.tld("foobar.com") # downloads the latest data file and returns "com"
+
+== Requirements
+
+None that I am aware of.
+
+== Install
+
+  sudo gem install public-suffix-list
+
+== License
+
+Copyright (c) 2010 Todd Sundsted
+
+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/lib/public_suffix_list.rb

@@ -0,0 +1,64 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__))
+
+require 'open-uri'
+require "public_suffix_list/parser.rb"
+
+class PublicSuffixList
+
+  VERSION = "0.0.1"
+
+  def self.config
+    @@config ||= Config.new
+  end
+
+  def self.configure(&block)
+    yield config
+  end
+  
+  class Config
+
+    attr_accessor :effective_tld_names_url
+
+    def initialize
+      @effective_tld_names_url = "http://mxr.mozilla.org/mozilla-central/source/netwerk/dns/src/effective_tld_names.dat?raw=1"
+    end
+
+  end
+
+  def initialize(url = self.class.config.effective_tld_names_url)
+    @rules = Parser.parse(open(url))
+  end
+
+  def split(domain)
+    domain = domain.split(".")
+    result = best(match(domain.dup, @rules))
+    [domain.dup.reverse.drop(result.size + 1).reverse.join("."), domain.dup.reverse.drop(result.size).first, result.reverse.join('.')]
+  end
+
+  def tld(domain)
+    best(match(domain.split("."), @rules)).reverse.join(".")
+  end
+
+  private
+
+  def match(domain, rules)
+    return [] if domain.empty? or rules.empty?
+    set = []
+    first = domain.pop
+    [[first, first], ["!#{first}", "!#{first}"], ["*", first]].each do |a, b|
+      if rules[a]
+        set << [b]
+        match(domain, rules[a]).each { |result| set << [first] + result }
+      end
+    end
+    set
+  end
+
+  def best(results)
+    return [] if results.empty?
+    result = results.find { |r| r.last[0] == ?! } || results.sort { |a, b| a.size <=> b.size }.last
+    result = result[0..result.size - 2] if result.last[0] == ?!
+    result
+  end
+
+end

data/lib/public_suffix_list/parser.rb

@@ -0,0 +1,21 @@
+class PublicSuffixList
+
+  module Parser
+
+    def self.parse(lines)
+      lines.inject({}) do |a, line|
+        line.strip!
+        unless line =~ %r{//} or line.empty?
+          t = a
+          line.split(".").reverse.each do |p|
+            t[p] = {} unless t[p]
+            t = t[p]
+          end
+        end
+        a
+      end
+    end
+
+  end
+
+end

data/spec/public_suffix_list.spec

@@ -0,0 +1,21 @@
+require 'lib/public_suffix_list'
+
+def cookie_calculation(public_suffix_list, domain)
+  s, d, t = public_suffix_list.split(domain)
+  s.empty? and d ? "Cookies may be set for #{domain}." : "Cookies may not be set for #{domain}."
+end
+
+describe PublicSuffixList do
+  it "should act as described at http://publicsuffix.org/format/" do
+    public_suffix_list = PublicSuffixList.new("spec/test.dat")
+    cookie_calculation(public_suffix_list, "foo.com").should == "Cookies may be set for foo.com."
+    cookie_calculation(public_suffix_list, "foo.bar.jp").should == "Cookies may be set for foo.bar.jp."
+    cookie_calculation(public_suffix_list, "bar.jp").should == "Cookies may not be set for bar.jp."
+    cookie_calculation(public_suffix_list, "foo.bar.hokkaido.jp").should == "Cookies may be set for foo.bar.hokkaido.jp."
+    cookie_calculation(public_suffix_list, "bar.hokkaido.jp").should == "Cookies may not be set for bar.hokkaido.jp."
+    cookie_calculation(public_suffix_list, "foo.bar.tokyo.jp").should == "Cookies may be set for foo.bar.tokyo.jp."
+    cookie_calculation(public_suffix_list, "bar.tokyo.jp").should == "Cookies may not be set for bar.tokyo.jp."
+    cookie_calculation(public_suffix_list, "pref.hokkaido.jp").should == "Cookies may be set for pref.hokkaido.jp."
+    cookie_calculation(public_suffix_list, "metro.tokyo.jp").should == "Cookies may be set for metro.tokyo.jp."
+  end
+end

data/spec/test.dat

@@ -0,0 +1,6 @@
+com
+*.jp
+*.hokkaido.jp
+*.tokyo.jp
+!pref.hokkaido.jp
+!metro.tokyo.jp 

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: public-suffix-list
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Todd Sundsted
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-09 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: The Public Suffix List (http://publicsuffix.org/) is "a cross-vendor initiative to provide an accurate list of domain name suffixes". Such a list is necessary because "there was and remains no algorithmic method of finding the highest level at which a domain may be registered for a particular top-level domain (the policies differ with each registry)...". Public Suffix List is also a small Ruby library designed to make the Public Suffix List (http://publicsuffix.org/) easier to use.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- lib/public_suffix_list.rb
+- lib/public_suffix_list/parser.rb
+- spec/public_suffix_list.spec
+- spec/test.dat
+has_rdoc: true
+homepage: http://github.com/toddsundsted/Public-Suffix-List
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Public Suffix List is a small Ruby library designed to make the Public Suffix List (http://publicsuffix.org/) easier to use.
+test_files: []
+