public_suffix_service 0.9.0 → 0.9.1

data/.gitignore

@@ -1,5 +1,4 @@
 .bundle
-.idea
 .yardoc
 pkg/*
 yardoc

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ruby-head
+  - ree
+  - jruby
+  - rbx
+  - rbx-2.0
+notifications:
+  recipients:
+    - weppos@weppos.net

data/.yardopts

@@ -1,2 +1,2 @@
 --readme README.rdoc
---title 'Public Suffix Service API Documentation'
+--title 'Ruby Public Suffix API Documentation'

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 
 
+## Release 0.9.1
+
+* CHANGED: Renamed PublicSuffixService::RuleList to PublicSuffixService::List.
+
+* CHANGED: Renamed PublicSuffixService::List#list to PublicSuffixService::List#rules.
+
+* CHANGED: Renamed PublicSuffixService to PublicSuffix.
+
+* CHANGED: Updated definitions.
+
+
 ## Release 0.9.0
 
 * CHANGED: Minimum Ruby version increased to Ruby 1.8.7.

data/Gemfile.lock

@@ -1,18 +1,20 @@
 PATH
   remote: .
   specs:
-    public_suffix_service (0.8.3)
+    public_suffix_service (0.9.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    rr (1.0.2)
-    yard (0.7.1)
+    mocha (0.9.12)
+    rake (0.9.2)
+    yard (0.7.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  mocha
   public_suffix_service!
-  rr
+  rake
   yard

data/README.md

@@ -1,144 +1,17 @@
-# Public Suffix Service
+# Public Suffix List - Ruby implementation
 
-*Public Suffix Service* is a Ruby domain name parser based on the [Public Suffix List](http://publicsuffix.org).
+*Public Suffix* (formerly *Public Suffix Service*) is a Ruby domain name parser based on the [Public Suffix List](http://publicsuffix.org).
 
 
-## What is the Public Suffix List?
+## Important
 
-The *Public Suffix Service* is a cross-vendor initiative to provide an accurate list of domain name suffixes.
+The `public_suffix_list` gem is now known as `public_suffix`.
+Please update your applications to use the new gem.
 
-The Public Suffix Service is an initiative of the Mozilla Project, but is maintained as a community resource. It is available for use in any software, but was originally created to meet the needs of browser manufacturers.
-
-A "public suffix" is one under which Internet users can directly register names. Some examples of public suffixes are ".com", ".co.uk" and "pvt.k12.wy.us". The Public Suffix List is a list of all known public suffixes.
-
-Source: http://publicsuffix.org
-
-
-## Why the Public Suffix List is better than any available Regular Expression parser?
-
-Previously, browsers used an algorithm which basically only denied setting wide-ranging cookies for top-level domains with no dots (e.g. com or org). However, this did not work for top-level domains where only third-level registrations are allowed (e.g. co.uk). In these cases, websites could set a cookie for co.uk which will be passed onto every website registered under co.uk.
-
-Clearly, this was a security risk as it allowed websites other than the one setting the cookie to read it, and therefore potentially extract sensitive information.
-
-Since there is 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), the only method is to create a list of all top-level domains and the level at which domains can be registered. This is the aim of the effective TLD list.
-
-As well as being used to prevent cookies from being set where they shouldn't be, the list can also potentially be used for other applications where the registry controlled and privately controlled parts of a domain name need to be known, for example when grouping by top-level domains.
-
-Source: https://wiki.mozilla.org/Public_Suffix_List
-
-Not convinced yet? Check out a real world example:
-http://stackoverflow.com/questions/288810/get-the-subdomain-from-a-url
-
-
-## Requirements
-
-* Ruby >= 1.8.7
-
-Public Suffix Service >= 0.9.0 requires Ruby 1.8.7 or newer.
-For older versions of Ruby, see the CHANGELOG.rdoc file.
-
-Successfully tested with the following interpreters
-
-* Ruby 1.8.7 / 1.9.2
-* MacRuby
-* Ruby Enterprise Edition
-
-
-## Installation
-
-The best way to install Public Suffix Service is via [RubyGems](http://www.rubygems.org).
-
-    $ gem install public_suffix_service
-
-You might need administrator privileges on your system to install the Gem.
-
-
-## Basic Usage
-
-Example domain without subdomains.
-
-    domain = PublicSuffixService.parse("google.com")
-    # => #<PublicSuffixService::Domain>
-    domain.tld
-    # => "com"
-    domain.sld
-    # => "google"
-    domain.trd
-    # => nil
-    domain.domain
-    # => "google.com"
-    domain.subdomain
-    # => nil
-
-Example domain with subdomains.
-
-    domain = PublicSuffixService.parse("www.google.com")
-    # => #<PublicSuffixService::Domain>
-    domain.tld
-    # => "com"
-    domain.sld
-    # => "google"
-    domain.trd
-    # => "www"
-    domain.domain
-    # => "google.com"
-    domain.subdomain
-    # => "google.com"
-
-Simple validation example.
-
-    PublicSuffixService.valid?("google.com")
-    # => true
-
-    PublicSuffixService.valid?("www.google.com")
-    # => true
-
-    PublicSuffixService.valid?("x.yz")
-    # => false
-
-## Fully Qualified Domain Names
-
-This library automatically recognizes Fully Qualified Domain Names. A FQDN is a domain name that end with a trailing dot.
-
-    # Parse a standard domain name
-    domain = PublicSuffixService.parse("www.google.com")
-    # => #<PublicSuffixService::Domain>
-    domain.tld
-    # => "com"
-
-    # Parse a fully qualified domain name
-    domain = PublicSuffixService.parse("www.google.com.")
-    # => #<PublicSuffixService::Domain>
-    domain.tld
-    # => "com"
-
-
-## Credits
-
-* **Author:** [Simone Carletti](http://www.simonecarletti.com/)
-
-
-## FeedBack and Bug reports
-
-If you use this library and find yourself missing any functionality I have missed, please [let me know](mailto:weppos@weppos.net).
-
-Bug reports and Feature suggestions [are welcomed](http://github.com/weppos/public_suffix_service/issues).
-
-
-## More
-
-* [Homepage](http://www.simonecarletti.com/code/public_suffix_service)
-* [Repository](http://github.com/weppos/public_suffix_service)
-* [API Documentation](http://www.simonecarletti.com/code/public_suffix_service/api/) (RDoc)
-* [Introducing the Public Suffix List library for Ruby](http://www.simonecarletti.com/blog/2010/06/public-suffix-list-library-for-ruby/)
-
-
-## Changelog
-
-See the CHANGELOG.md file for details.
+    $ gem install public_suffix
 
 
 ## License
 
-Copyright (c) 2009-2011 Simone Carletti,
-*Public Suffix Service* is released under the MIT license.
+*Public Suffix* is copyright (c) 2009-2011 Simone Carletti.
+This is Free Software distributed under the MIT license.

data/Rakefile

@@ -1,18 +1,15 @@
 require 'rubygems'
+require 'rubygems/package_task'
 require 'bundler'
 require 'rake/testtask'
-require 'rubygems/package_task'
-require 'yard'
-require 'yard/rake/yardoc_task'
-
 
 $:.unshift(File.dirname(__FILE__) + "/lib")
-require 'public_suffix_service'
+require 'public_suffix'
 
 
 # Common package properties
-PKG_NAME    = ENV['PKG_NAME']    || PublicSuffixService::GEM
-PKG_VERSION = ENV['PKG_VERSION'] || PublicSuffixService::VERSION
+PKG_NAME    = ENV['PKG_NAME']    || PublicSuffix::GEM
+PKG_VERSION = ENV['PKG_VERSION'] || PublicSuffix::VERSION
 RUBYFORGE_PROJECT = nil
 
 if ENV['SNAPSHOT'].to_i == 1
@@ -20,15 +17,8 @@ if ENV['SNAPSHOT'].to_i == 1
 end
 
 
-# Run all the tests in the /test folder
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/**/*_test.rb"]
-  t.verbose = true
-end
-
 # Run test by default.
-task :default => ["test"]
+task :default => :test
 
 
 # This builds the actual gem. For details of what all these options
@@ -40,13 +30,13 @@ spec = Gem::Specification.new do |s|
   s.name              = PKG_NAME
   s.version           = PKG_VERSION
   s.summary           = "Domain name parser based in the Public Suffix List."
-  s.description       = "PublicSuffixService can parse and decompose a domain name into top level domain, domain and subdomains."
+  s.description       = "PublicSuffixService gem is now known as PublicSuffix."
 
   s.required_ruby_version = ">= 1.8.7"
 
   s.author            = "Simone Carletti"
   s.email             = "weppos@weppos.net"
-  s.homepage          = "http://www.simonecarletti.com/code/public_suffix_service"
+  s.homepage          = "http://www.simonecarletti.com/code/public_suffix"
 
   # Add any extra files to include in the gem (like your README)
   s.files             = `git ls-files`.split("\n")
@@ -58,14 +48,11 @@ spec = Gem::Specification.new do |s|
   # s.add_dependency("some_other_gem", "~> 0.1.0")
 
   # If your tests use any gems, include them here
-  s.add_development_dependency("rr")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("mocha")
   s.add_development_dependency("yard")
 end
 
-# This task actually builds the gem. We also regenerate a static
-# .gemspec file, which is useful if something (i.e. GitHub) will
-# be automatically building a gem for this project. If you're not
-# using GitHub, edit as appropriate.
 Gem::PackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
@@ -88,18 +75,23 @@ desc "Package the library and generates the gemspec"
 task :package => [:gemspec]
 
 
+# Run all the tests in the /test folder
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = !!ENV["VERBOSE"]
+  t.warning = !!ENV["WARNING"]
+end
+
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+
 YARD::Rake::YardocTask.new(:yardoc) do |y|
   y.options = ["--output-dir", "yardoc"]
 end
 
 namespace :yardoc do
-  desc "Publish YARD documentation to the site"
-  task :publish => ["yardoc:clobber", "yardoc"] do
-    ENV["username"] || raise(ArgumentError, "Missing ssh username")
-    sh "rsync -avz --delete yardoc/ #{ENV["username"]}@code:/var/www/apps/code/#{PKG_NAME}/api"
-  end
-
-  desc "Remove YARD products"
   task :clobber do
     rm_r "yardoc" rescue nil
   end
@@ -110,7 +102,7 @@ task :clobber => "yardoc:clobber"
 
 desc "Open an irb session preloaded with this library"
 task :console do
-  sh "irb -rubygems -I lib -r public_suffix_service.rb"
+  sh "irb -rubygems -I lib -r public_suffix.rb"
 end
 
 
@@ -123,7 +115,7 @@ task :download_definitions do
 
   DEFINITION_URL = "http://mxr.mozilla.org/mozilla-central/source/netwerk/dns/effective_tld_names.dat?raw=1"
 
-  File.open("lib/public_suffix_service/definitions.txt", "w+") do |f|
+  File.open("lib/public_suffix/definitions.txt", "w+") do |f|
     response = Net::HTTP.get_response(URI.parse(DEFINITION_URL))
     f.write(response.body)
   end

data/lib/public_suffix.rb

@@ -0,0 +1,134 @@
+#--
+# Public Suffix
+#
+# Domain name parser based on the Public Suffix List.
+#
+# Copyright (c) 2009-2011 Simone Carletti <weppos@weppos.net>
+#++
+
+
+require 'public_suffix/domain'
+require 'public_suffix/version'
+require 'public_suffix/errors'
+require 'public_suffix/rule'
+require 'public_suffix/list'
+
+
+module PublicSuffix
+
+  NAME            = "Public Suffix"
+  GEM             = "public_suffix_service"
+  AUTHORS         = ["Simone Carletti <weppos@weppos.net>"]
+
+
+  # Backwards compatibility
+  autoload :RuleList, 'public_suffix/rule_list'
+
+
+  # Parses +domain+ and returns the
+  # {PublicSuffix::Domain} instance.
+  #
+  # Parsing uses the default {PublicSuffix::List}.
+  #
+  # @param  [String, #to_s] domain
+  #   The domain name or fully qualified domain name to parse.
+  #
+  # @return [PublicSuffix::Domain]
+  #
+  # @example Parse a valid domain
+  #   PublicSuffix.parse("google.com")
+  #   # => #<PublicSuffix::Domain ...>
+  # 
+  # @example Parse a valid subdomain
+  #   PublicSuffix.parse("www.google.com")
+  #   # => #<PublicSuffix::Domain ...>
+  # 
+  # @example Parse a fully qualified domain
+  #   PublicSuffix.parse("google.com.")
+  #   # => #<PublicSuffix::Domain ...>
+  # 
+  # @example Parse a fully qualified domain (subdomain)
+  #   PublicSuffix.parse("www.google.com.")
+  #   # => #<PublicSuffix::Domain ...>
+  #
+  # @example Parse an invalid domain
+  #   PublicSuffix.parse("x.yz")
+  #   # => PublicSuffix::DomainInvalid
+  #
+  # @example Parse an URL (not supported, only domains)
+  #   PublicSuffix.parse("http://www.google.com")
+  #   # => PublicSuffix::DomainInvalid
+  #
+  # @raise [PublicSuffix::Error]
+  #   If domain is not a valid domain.
+  # @raise [PublicSuffix::DomainNotAllowed]
+  #   If a rule for +domain+ is found, but the rule
+  #   doesn't allow +domain+.
+  #
+  def self.parse(domain)
+    rule = List.default.find(domain)
+    if rule.nil?
+      raise DomainInvalid, "`#{domain}' is not a valid domain"
+    end
+    if !rule.allow?(domain)
+      raise DomainNotAllowed, "`#{domain}' is not allowed according to Registry policy"
+    end
+
+    left, right = rule.decompose(domain)
+
+    parts = left.split(".")
+    # If we have 0 parts left, there is just a tld and no domain or subdomain
+    # If we have 1 part  left, there is just a tld, domain and not subdomain
+    # If we have 2 parts left, the last part is the domain, the other parts (combined) are the subdomain
+    tld = right
+    sld = parts.empty? ? nil : parts.pop
+    trd = parts.empty? ? nil : parts.join(".")
+
+    Domain.new(tld, sld, trd)
+  end
+
+  # Checks whether +domain+ is assigned and allowed,
+  # without actually parsing it.
+  #
+  # This method doesn't care whether domain is a domain or subdomain.
+  # The validation is performed using the default {PublicSuffix::List}.
+  #
+  # @param  [String, #to_s] domain
+  #   The domain name or fully qualified domain name to validate.
+  #
+  # @return [Boolean]
+  #
+  # @example Validate a valid domain
+  #   PublicSuffix.valid?("example.com")
+  #   # => true
+  #
+  # @example Validate a valid subdomain
+  #   PublicSuffix.valid?("www.example.com")
+  #   # => true
+  #
+  # @example Validate a not-assigned domain
+  #   PublicSuffix.valid?("example.zip")
+  #   # => false
+  #
+  # @example Validate a not-allowed domain
+  #   PublicSuffix.valid?("example.do")
+  #   # => false
+  #   PublicSuffix.valid?("www.example.do")
+  #   # => true
+  # 
+  # @example Validate a fully qualified domain
+  #   PublicSuffix.valid?("google.com.")
+  #   # => true
+  #   PublicSuffix.valid?("www.google.com.")
+  #   # => true
+  #
+  # @example Check an URL (which is not a valid domain)
+  #   PublicSuffix.valid?("http://www.example.com")
+  #   # => false
+  #
+  def self.valid?(domain)
+    rule = List.default.find(domain)
+    !rule.nil? && rule.allow?(domain)
+  end
+
+end