ryodo 0.3.0 → 0.3.1

data/spec/ryodo/suffix_list_fetcher_spec.rb

@@ -1,7 +1,8 @@
 require "ryodo/suffix_list_fetcher"
 require "spec_helper"
 
-describe Ryodo::SuffixListFetcher do
+RSpec.describe Ryodo::SuffixListFetcher do
+  subject { described_class }
   let(:custom_uri) { "http://custom.suffix.list.example.com/foo-bar.dat" }
   let(:custom_storage) { "#{RYODO_TMP_ROOT}/custom-storage-path.dat" }
 
@@ -12,21 +13,21 @@ describe Ryodo::SuffixListFetcher do
   end
 
   it "#new creates a new instance with predefined vars" do
-    fetcher = described_class.new
+    fetcher = subject.new
 
     expect(fetcher.instance_variable_get("@uri")).to eq URI(Ryodo::PUBLIC_SUFFIX_DATA_URI)
     expect(fetcher.instance_variable_get("@store")).to be Ryodo::PUBLIC_SUFFIX_STORE
   end
 
   it "#new creates a new instance with custom vars" do
-    fetcher = described_class.new(custom_uri, custom_storage)
+    fetcher = subject.new(custom_uri, custom_storage)
 
     expect(fetcher.instance_variable_get("@uri")).to eq URI(custom_uri)
     expect(fetcher.instance_variable_get("@store")).to be custom_storage
   end
 
   context "data retrieval and storage" do
-    let(:fetcher) { described_class.new }
+    let(:fetcher) { subject.new }
 
     it "#fetch_data retrieves remote data" do
       first_line = /This Source Code Form is subject to the terms of the Mozilla Public/
@@ -58,11 +59,11 @@ describe Ryodo::SuffixListFetcher do
     let(:storage)     { "#{RYODO_TMP_ROOT}/suffixes.dat" }
 
     it "and returns true if successful" do
-      expect(described_class.fetch_and_save!(valid_uri, storage)).to be true
+      expect(subject.fetch_and_save!(valid_uri, storage)).to be true
     end
 
     it "and returns false if something failed" do
-      expect(described_class.fetch_and_save!(invalid_uri, storage)).to be false
+      expect(subject.fetch_and_save!(invalid_uri, storage)).to be false
     end
   end
 end

data/spec/ryodo/suffix_list_spec.rb

@@ -1,46 +1,45 @@
 require "spec_helper"
 
-describe Ryodo::SuffixList do
-  context "singleton" do
+RSpec.describe Ryodo::SuffixList do
+  subject { described_class }
 
+  context "singleton" do
     it "cannot be instanciated via #new" do
-      expect{ described_class.new }.to raise_error
+      expect { subject.new }.to raise_error
     end
 
     it "creates instance by calling the class itself" do
-      described_class.should_receive(:instance)
-      described_class.send(:"SuffixList")
+      expect(subject).to receive(:instance)
+      subject.send(:"SuffixList")
     end
 
     it "has .instance" do
-      expect(described_class.methods).to include(:instance)
+      expect(subject.methods).to include(:instance)
     end
 
     it "instance check" do
-      o1 = described_class.instance
-      o2 = described_class.instance
+      o1 = subject.instance
+      o2 = subject.instance
 
-      expect(o1).to be o2
+      expect(o1).to be(o2)
     end
   end
 
   context "methods" do
-    let(:described_instance) { described_class.instance }
+    let(:described_instance) { subject.instance }
 
     it ".reload can retrieve a fresh suffix list" do
       expect(described_instance).to receive(:load_file).and_return(true)
-      described_class.reload
+      subject.reload
     end
 
     it ".reload fails if given file doesn't exist" do
-      expect { described_class.reload("#{RYODO_TMP_ROOT}/invalid-file.dat") }.to raise_error
+      expect { subject.reload("#{RYODO_TMP_ROOT}/invalid-file.dat") }.to raise_error
     end
 
     it ".list returns an array of arrays" do
-      expect(described_class.list).to be_an(Array)
-      expect(
-        described_class.list.all? { |e| e.is_a?(Array) }
-      ).to be true
+      expect(subject.list).to be_an(Array)
+      expect(subject.list.all? { |e| e.is_a?(Array) }).to be(true)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,13 @@
-require "coveralls"
-Coveralls.wear!
+if ENV["TRAVIS"] || ENV["CI"]
+  require "codeclimate-test-reporter"
+  require "coveralls"
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    Coveralls::SimpleCov::Formatter,
+    CodeClimate::TestReporter::Formatter
+  ]
+  SimpleCov.start
+end
 
 require "fileutils"
 require "fakeweb"
@@ -9,16 +17,17 @@ require "ryodo"
 RYODO_SPEC_ROOT = File.expand_path("..", __FILE__)
 RYODO_TMP_ROOT  = File.expand_path("../../tmp/spec", __FILE__)
 
-FileUtils.mkdir_p RYODO_TMP_ROOT unless File.exists?(RYODO_TMP_ROOT)
+FileUtils.mkdir_p RYODO_TMP_ROOT unless File.exist?(RYODO_TMP_ROOT)
 
-FakeWeb.register_uri(:get,
+FakeWeb.register_uri(
+  :get,
   Ryodo::PUBLIC_SUFFIX_DATA_URI,
-  :body => File.read("#{RYODO_SPEC_ROOT}/_files/mozilla_effective_tld_names.dat")
+  body: File.read("#{RYODO_SPEC_ROOT}/_files/mozilla_effective_tld_names.dat")
 )
 
 FakeWeb.register_uri(
   :get,
   "#{Ryodo::PUBLIC_SUFFIX_DATA_URI}&invalid_file",
-  :body => "Oops!",
-  :status => [404,"Not Found"]
+  body: "Oops!",
+  status: [404, "Not Found"]
 )

data/spec/suffix_checker.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << "lib"
+require "ryodo"
+
+module SuffixChecker
+  module_function
+
+  def check_public_suffix(query, expectation)
+    query      = Ryodo.parse(query)
+    calculated = query.domain.nil? ? "NULL" : query.domain
+    result     = calculated == expectation
+    passed     = result ? "  OK" : "FAIL"
+
+    puts "#{passed} === Q: #{query.ljust(26)} | #{expectation.rjust(16)} <=> #{calculated.ljust(16)}"
+
+    result
+  end
+
+  def run!
+    results = []
+
+    # Following test data can be found at:
+    # <http://mxr.mozilla.org/mozilla-central/source/netwerk/test/unit/data/test_psl.txt?raw=1>
+
+    # NULL input.
+    results << check_public_suffix("NULL", "NULL")
+    # Mixed case.
+    results << check_public_suffix("COM", "NULL")
+    results << check_public_suffix("example.COM", "example.com")
+    results << check_public_suffix("WwW.example.COM", "example.com")
+    # Leading dot.
+    results << check_public_suffix(".com", "NULL")
+    results << check_public_suffix(".example", "NULL")
+    results << check_public_suffix(".example.com", "NULL")
+    results << check_public_suffix(".example.example", "NULL")
+    # Unlisted TLD.
+    results << check_public_suffix("example", "NULL")
+    results << check_public_suffix("example.example", "example.example")
+    results << check_public_suffix("b.example.example", "example.example")
+    results << check_public_suffix("a.b.example.example", "example.example")
+    # Listed, but non-Internet, TLD.
+    # results << check_public_suffix('local', 'NULL')
+    # results << check_public_suffix('example.local', 'NULL')
+    # results << check_public_suffix('b.example.local', 'NULL')
+    # results << check_public_suffix('a.b.example.local', 'NULL')
+    # TLD with only 1 rule.
+    results << check_public_suffix("biz", "NULL")
+    results << check_public_suffix("domain.biz", "domain.biz")
+    results << check_public_suffix("b.domain.biz", "domain.biz")
+    results << check_public_suffix("a.b.domain.biz", "domain.biz")
+    # TLD with some 2-level rules.
+    results << check_public_suffix("com", "NULL")
+    results << check_public_suffix("example.com", "example.com")
+    results << check_public_suffix("b.example.com", "example.com")
+    results << check_public_suffix("a.b.example.com", "example.com")
+    results << check_public_suffix("uk.com", "NULL")
+    results << check_public_suffix("example.uk.com", "example.uk.com")
+    results << check_public_suffix("b.example.uk.com", "example.uk.com")
+    results << check_public_suffix("a.b.example.uk.com", "example.uk.com")
+    results << check_public_suffix("test.ac", "test.ac")
+    # TLD with only 1 (wildcard) rule.
+    results << check_public_suffix("cy", "NULL")
+    results << check_public_suffix("c.cy", "NULL")
+    results << check_public_suffix("b.c.cy", "b.c.cy")
+    results << check_public_suffix("a.b.c.cy", "b.c.cy")
+    # More complex TLD.
+    results << check_public_suffix("jp", "NULL")
+    results << check_public_suffix("test.jp", "test.jp")
+    results << check_public_suffix("www.test.jp", "test.jp")
+    results << check_public_suffix("ac.jp", "NULL")
+    results << check_public_suffix("test.ac.jp", "test.ac.jp")
+    results << check_public_suffix("www.test.ac.jp", "test.ac.jp")
+    results << check_public_suffix("kyoto.jp", "NULL")
+    results << check_public_suffix("test.kyoto.jp", "test.kyoto.jp")
+    results << check_public_suffix("ide.kyoto.jp", "NULL")
+    results << check_public_suffix("b.ide.kyoto.jp", "b.ide.kyoto.jp")
+    results << check_public_suffix("a.b.ide.kyoto.jp", "b.ide.kyoto.jp")
+    results << check_public_suffix("c.kobe.jp", "NULL")
+    results << check_public_suffix("b.c.kobe.jp", "b.c.kobe.jp")
+    results << check_public_suffix("a.b.c.kobe.jp", "b.c.kobe.jp")
+    results << check_public_suffix("city.kobe.jp", "city.kobe.jp")
+    results << check_public_suffix("www.city.kobe.jp", "city.kobe.jp")
+    # TLD with a wildcard rule and exceptions.
+    results << check_public_suffix("ck", "NULL")
+    results << check_public_suffix("test.ck", "NULL")
+    results << check_public_suffix("b.test.ck", "b.test.ck")
+    results << check_public_suffix("a.b.test.ck", "b.test.ck")
+    results << check_public_suffix("www.ck", "www.ck")
+    results << check_public_suffix("www.www.ck", "www.ck")
+    # US K12.
+    results << check_public_suffix("us", "NULL")
+    results << check_public_suffix("test.us", "test.us")
+    results << check_public_suffix("www.test.us", "test.us")
+    results << check_public_suffix("ak.us", "NULL")
+    results << check_public_suffix("test.ak.us", "test.ak.us")
+    results << check_public_suffix("www.test.ak.us", "test.ak.us")
+    results << check_public_suffix("k12.ak.us", "NULL")
+    results << check_public_suffix("test.k12.ak.us", "test.k12.ak.us")
+    results << check_public_suffix("www.test.k12.ak.us", "test.k12.ak.us")
+    # IDN labels.
+    results << check_public_suffix("食狮.com.cn", "食狮.com.cn")
+    results << check_public_suffix("食狮.公司.cn", "食狮.公司.cn")
+    results << check_public_suffix("www.食狮.公司.cn", "食狮.公司.cn")
+    results << check_public_suffix("shishi.公司.cn", "shishi.公司.cn")
+    results << check_public_suffix("公司.cn", "NULL")
+    results << check_public_suffix("食狮.中国", "食狮.中国")
+    results << check_public_suffix("www.食狮.中国", "食狮.中国")
+    results << check_public_suffix("shishi.中国", "shishi.中国")
+    results << check_public_suffix("中国", "NULL")
+    # Same as above, but punycoded.
+    results << check_public_suffix('xn--85x722f.com.cn', 'xn--85x722f.com.cn')
+    # results << check_public_suffix('xn--85x722f.xn--55qx5d.cn', 'xn--85x722f.xn--55qx5d.cn')
+    # results << check_public_suffix('www.xn--85x722f.xn--55qx5d.cn', 'xn--85x722f.xn--55qx5d.cn')
+    # results << check_public_suffix('shishi.xn--55qx5d.cn', 'shishi.xn--55qx5d.cn')
+    # results << check_public_suffix('xn--55qx5d.cn', 'NULL')
+    # results << check_public_suffix('xn--85x722f.xn--fiqs8s', 'xn--85x722f.xn--fiqs8s')
+    # results << check_public_suffix('www.xn--85x722f.xn--fiqs8s', 'xn--85x722f.xn--fiqs8s')
+    # results << check_public_suffix('shishi.xn--fiqs8s', 'shishi.xn--fiqs8s')
+    results << check_public_suffix('xn--fiqs8s', 'NULL')
+
+    exit_code = results.all? ? 0 : 1
+    case exit_code
+    when 0 then puts "All okay! ✔"
+    when 1 then puts "Some checks failed! ✘"
+    end
+    exit(exit_code)
+  end
+end
+
+SuffixChecker.run!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ryodo
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Christoph Grabo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-26 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,44 +28,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
@@ -118,13 +104,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- checks/matching.rb
 - data/suffix.dat
 - lib/ryodo.rb
 - lib/ryodo/convenience.rb
@@ -143,8 +129,8 @@ files:
 - spec/_files/mozilla_effective_tld_names.dat
 - spec/ryodo/suffix_list_fetcher_spec.rb
 - spec/ryodo/suffix_list_spec.rb
-- spec/ryodo_spec.rb
 - spec/spec_helper.rb
+- spec/suffix_checker.rb
 homepage: http://github.com/asaaki/ryodo
 licenses:
 - MIT
@@ -165,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: ryōdo【領土】 りょうど — A domain name parser using public suffix list
@@ -173,6 +159,6 @@ test_files:
 - spec/_files/mozilla_effective_tld_names.dat
 - spec/ryodo/suffix_list_fetcher_spec.rb
 - spec/ryodo/suffix_list_spec.rb
-- spec/ryodo_spec.rb
 - spec/spec_helper.rb
+- spec/suffix_checker.rb
 has_rdoc: 

data/checks/matching.rb

@@ -1,107 +0,0 @@
-#!/usr/bin/env ruby
-$LOAD_PATH << "lib"
-require "ryodo"
-
-def checkPublicSuffix(query, expectation)
-  query      = Ryodo[query]
-  calculated = query.domain.nil? ? "NULL" : query.domain
-  passed     = calculated == expectation ? "  OK" : "FAIL"
-
-  puts "#{passed} === Q: #{query.ljust(26)} | #{expectation.rjust(16)} <=> #{calculated.ljust(16)}"
-end
-
-# NULL input.
-checkPublicSuffix('NULL', 'NULL')
-# Mixed case.
-checkPublicSuffix('COM', 'NULL')
-checkPublicSuffix('example.COM', 'example.com')
-checkPublicSuffix('WwW.example.COM', 'example.com')
-# Leading dot.
-checkPublicSuffix('.com', 'NULL')
-checkPublicSuffix('.example', 'NULL')
-checkPublicSuffix('.example.com', 'NULL')
-checkPublicSuffix('.example.example', 'NULL')
-# Unlisted TLD.
-checkPublicSuffix('example', 'NULL')
-checkPublicSuffix('example.example', 'example.example')
-checkPublicSuffix('b.example.example', 'example.example')
-checkPublicSuffix('a.b.example.example', 'example.example')
-# Listed, but non-Internet, TLD.
-#checkPublicSuffix('local', 'NULL')
-#checkPublicSuffix('example.local', 'NULL')
-#checkPublicSuffix('b.example.local', 'NULL')
-#checkPublicSuffix('a.b.example.local', 'NULL')
-# TLD with only 1 rule.
-checkPublicSuffix('biz', 'NULL')
-checkPublicSuffix('domain.biz', 'domain.biz')
-checkPublicSuffix('b.domain.biz', 'domain.biz')
-checkPublicSuffix('a.b.domain.biz', 'domain.biz')
-# TLD with some 2-level rules.
-checkPublicSuffix('com', 'NULL')
-checkPublicSuffix('example.com', 'example.com')
-checkPublicSuffix('b.example.com', 'example.com')
-checkPublicSuffix('a.b.example.com', 'example.com')
-checkPublicSuffix('uk.com', 'NULL')
-checkPublicSuffix('example.uk.com', 'example.uk.com')
-checkPublicSuffix('b.example.uk.com', 'example.uk.com')
-checkPublicSuffix('a.b.example.uk.com', 'example.uk.com')
-checkPublicSuffix('test.ac', 'test.ac')
-# TLD with only 1 (wildcard) rule.
-checkPublicSuffix('cy', 'NULL')
-checkPublicSuffix('c.cy', 'NULL')
-checkPublicSuffix('b.c.cy', 'b.c.cy')
-checkPublicSuffix('a.b.c.cy', 'b.c.cy')
-# More complex TLD.
-checkPublicSuffix('jp', 'NULL')
-checkPublicSuffix('test.jp', 'test.jp')
-checkPublicSuffix('www.test.jp', 'test.jp')
-checkPublicSuffix('ac.jp', 'NULL')
-checkPublicSuffix('test.ac.jp', 'test.ac.jp')
-checkPublicSuffix('www.test.ac.jp', 'test.ac.jp')
-checkPublicSuffix('kyoto.jp', 'NULL')
-checkPublicSuffix('test.kyoto.jp', 'test.kyoto.jp')
-checkPublicSuffix('ide.kyoto.jp', 'NULL')
-checkPublicSuffix('b.ide.kyoto.jp', 'b.ide.kyoto.jp')
-checkPublicSuffix('a.b.ide.kyoto.jp', 'b.ide.kyoto.jp')
-checkPublicSuffix('c.kobe.jp', 'NULL')
-checkPublicSuffix('b.c.kobe.jp', 'b.c.kobe.jp')
-checkPublicSuffix('a.b.c.kobe.jp', 'b.c.kobe.jp')
-checkPublicSuffix('city.kobe.jp', 'city.kobe.jp')
-checkPublicSuffix('www.city.kobe.jp', 'city.kobe.jp')
-# TLD with a wildcard rule and exceptions.
-checkPublicSuffix('ck', 'NULL')
-checkPublicSuffix('test.ck', 'NULL')
-checkPublicSuffix('b.test.ck', 'b.test.ck')
-checkPublicSuffix('a.b.test.ck', 'b.test.ck')
-checkPublicSuffix('www.ck', 'www.ck')
-checkPublicSuffix('www.www.ck', 'www.ck')
-# US K12.
-checkPublicSuffix('us', 'NULL')
-checkPublicSuffix('test.us', 'test.us')
-checkPublicSuffix('www.test.us', 'test.us')
-checkPublicSuffix('ak.us', 'NULL')
-checkPublicSuffix('test.ak.us', 'test.ak.us')
-checkPublicSuffix('www.test.ak.us', 'test.ak.us')
-checkPublicSuffix('k12.ak.us', 'NULL')
-checkPublicSuffix('test.k12.ak.us', 'test.k12.ak.us')
-checkPublicSuffix('www.test.k12.ak.us', 'test.k12.ak.us')
-# IDN labels.
-checkPublicSuffix('食狮.com.cn', '食狮.com.cn')
-checkPublicSuffix('食狮.公司.cn', '食狮.公司.cn')
-checkPublicSuffix('www.食狮.公司.cn', '食狮.公司.cn')
-checkPublicSuffix('shishi.公司.cn', 'shishi.公司.cn')
-checkPublicSuffix('公司.cn', 'NULL')
-checkPublicSuffix('食狮.中国', '食狮.中国')
-checkPublicSuffix('www.食狮.中国', '食狮.中国')
-checkPublicSuffix('shishi.中国', 'shishi.中国')
-checkPublicSuffix('中国', 'NULL')
-# Same as above, but punycoded.
-# checkPublicSuffix('xn--85x722f.com.cn', 'xn--85x722f.com.cn')
-# checkPublicSuffix('xn--85x722f.xn--55qx5d.cn', 'xn--85x722f.xn--55qx5d.cn')
-# checkPublicSuffix('www.xn--85x722f.xn--55qx5d.cn', 'xn--85x722f.xn--55qx5d.cn')
-# checkPublicSuffix('shishi.xn--55qx5d.cn', 'shishi.xn--55qx5d.cn')
-# checkPublicSuffix('xn--55qx5d.cn', 'NULL')
-# checkPublicSuffix('xn--85x722f.xn--fiqs8s', 'xn--85x722f.xn--fiqs8s')
-# checkPublicSuffix('www.xn--85x722f.xn--fiqs8s', 'xn--85x722f.xn--fiqs8s')
-# checkPublicSuffix('shishi.xn--fiqs8s', 'shishi.xn--fiqs8s')
-# checkPublicSuffix('xn--fiqs8s', 'NULL')