public-suffix-list 0.0.6 → 0.1.0

data/README.rdoc

@@ -11,7 +11,17 @@ 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.
+easier to use.  Public Suffix List will transparently download the
+latest list of top-level domains, parse the list, and optionally cache
+the parsed data.
+
+The public API is as simple as I could make it.  Instantiating the
+PublicSuffixList class downloads, parses, and caches the data.  There
+are three instance methods:
+
+[*tld*(domain)] return the top-level domain name
+[*cdn*(domain)] return the canonical domain name
+[*split*(domain)] split the domain name into parts
 
 == Features
 
@@ -23,24 +33,32 @@ easier to use.
 
   require "public_suffix_list"
 
-  # downloads and parses the latest data file and returns "com"
+  # Downloads and parses the latest data file and returns "com".
   PublicSuffixList.new.tld("foobar.com")
 
-  # downloads and parses the latest data file and returns "foobar.com"
+  # Downloads and parses the latest data file and returns "foobar.com".
   PublicSuffixList.new.cdn("foobar.com")
 
-  # downloads and parses the latest data file, caches it in /tmp, returns ["abc", "xyz", "co.uk"]
+  # Downloads and parses the latest data file, caches it in /tmp,
+  # and returns ["abc", "xyz", "co.uk"].
   PublicSuffixList.new(:cache_dir => "/tmp").split("abc.xyz.co.uk")
 
-  # loads the cached data in /tmp and returns ["test", "nhs", "uk"]
-  PublicSuffixList.new(:cache_dir => "/tmp").split("test.nhs.uk")
+  # Loads the cached data in /tmp if it is less than 100 seconds old,
+  # downloads, parses, and caches it if it is older, and returns
+  # ["test", "nhs", "uk"].
+  PublicSuffixList.new(:cache_dir => "/tmp", :cache_expiry_period => 100).split("test.nhs.uk")
 
-  # you don't have to instantiate PublicSuffixList every time you use it, of course...
+  # You don't have to instantiate PublicSuffixList every time you
+  # use it, of course...
   p = PublicSuffixList.new
   p.split("fee.fi.fo.com") # => ["fee.fi", "fo", "com"]
   p.cdn("fee.fi.fo.com")   # => "fo.com", "cdn" is "canonical domain name"
   p.tld("fee.fi.fo.com")   # => "com", "tld" is "top-level domain"
 
+  # You can even use other data files, both local and remote
+  # (as long as they conform to the Public Suffix List file format).
+  PublicSuffixList.new(:url => "spec/test.dat")
+
 == Requirements
 
 None that I am aware of.

data/lib/public_suffix_list.rb

@@ -6,7 +6,7 @@ require "public_suffix_list/parser.rb"
 
 class PublicSuffixList
 
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 
   def self.config
     @@config ||= Config.new
@@ -20,12 +20,16 @@ class PublicSuffixList
 
     attr_accessor :cache_dir
     attr_accessor :cache_expiry_period
-    attr_accessor :effective_tld_names_url
+    attr_accessor :url
+
+    # effective_tld_names_url is deprecated
+    alias_method :effective_tld_names_url, :url
+    alias_method :effective_tld_names_url=, :url=
 
     def initialize
       @cache_dir = nil
       @cache_expiry_period = 30 * 24 * 60 * 60
-      @effective_tld_names_url = "http://mxr.mozilla.org/mozilla-central/source/netwerk/dns/src/effective_tld_names.dat?raw=1"
+      @url = "http://mxr.mozilla.org/mozilla-central/source/netwerk/dns/src/effective_tld_names.dat?raw=1"
     end
 
   end
@@ -72,7 +76,7 @@ class PublicSuffixList
   private
 
   def fetch
-    @rules = Parser.parse(open(@config.effective_tld_names_url))
+    @rules = Parser.parse(open(@config.url))
   end
 
   def cache
@@ -80,7 +84,7 @@ class PublicSuffixList
   end
 
   def uncache
-    rules = @cache_file[:rules] unless @cache_file.expired?
+    @rules = @cache_file[:rules] unless @cache_file.expired?
   end
 
   def match(domain, rules)

data/lib/public_suffix_list/cache_file.rb

@@ -11,7 +11,7 @@ class PublicSuffixList
     end
 
     def file
-      File.join(@config.cache_dir, URI.parse(@config.effective_tld_names_url).path.split("/").last + ".cache") if cache?
+      File.join(@config.cache_dir, URI.parse(@config.url).path.split("/").last + ".cache") if cache?
     end
 
     def exist?

data/spec/public_suffix_list.spec

@@ -2,30 +2,40 @@ require 'lib/public_suffix_list'
 
 describe PublicSuffixList do
 
-  before do
-    @public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat")
-    @public_suffix_list.cache_file.should be nil
+  it "should accept both effective_tld_names_url and url" do
+    public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat")
+    public_suffix_list.config.effective_tld_names_url.should == "spec/test.dat"
+    public_suffix_list.config.url.should == "spec/test.dat"
+    public_suffix_list = PublicSuffixList.new(:url => "spec/test.dat")
+    public_suffix_list.config.effective_tld_names_url.should == "spec/test.dat"
+    public_suffix_list.config.url.should == "spec/test.dat"
   end
 
   it "should calculate tld and cdn correctly" do
-    @public_suffix_list.cdn("foo.bar.com").should == "bar.com"
-    @public_suffix_list.tld("foo.bar.com").should == "com"
-    @public_suffix_list.cdn("foobar.com").should == "foobar.com"
-    @public_suffix_list.tld("foobar.com").should == "com"
+    public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat")
+    public_suffix_list.cache_file.should be nil
+    public_suffix_list.cdn("foo.bar.com").should == "bar.com"
+    public_suffix_list.tld("foo.bar.com").should == "com"
+    public_suffix_list.cdn("foobar.com").should == "foobar.com"
+    public_suffix_list.tld("foobar.com").should == "com"
   end
 
   it "should not assume the root name is a top level domain" do
-    @public_suffix_list.tld("com").should == "com"
-    @public_suffix_list.tld("bar.foo").should == "bar.foo"
-    @public_suffix_list.tld("baz.foo").should == "baz.foo"
-    @public_suffix_list.tld("qux.foo").should == ""
-    @public_suffix_list.tld("foo").should == ""
+    public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat")
+    public_suffix_list.cache_file.should be nil
+    public_suffix_list.tld("com").should == "com"
+    public_suffix_list.tld("bar.foo").should == "bar.foo"
+    public_suffix_list.tld("baz.foo").should == "baz.foo"
+    public_suffix_list.tld("qux.foo").should == ""
+    public_suffix_list.tld("foo").should == ""
   end
 
   it "should handle edge cases correctly" do
-    @public_suffix_list.split("").should == ["", "", ""]
-    @public_suffix_list.cdn("").should == ""
-    @public_suffix_list.tld("").should == ""
+    public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat")
+    public_suffix_list.cache_file.should be nil
+    public_suffix_list.split("").should == ["", "", ""]
+    public_suffix_list.cdn("").should == ""
+    public_suffix_list.tld("").should == ""
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: public-suffix-list
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Todd Sundsted
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-13 00:00:00 -05:00
+date: 2010-01-15 00:00:00 -05:00
 default_executable: 
 dependencies: []