nz-whois 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f88f3349e53e2a1f068ebbf0cee392299f03f94d
+  data.tar.gz: 05b0d3e04e42e856235098c5308ce99ae3e18fad
+SHA512:
+  metadata.gz: d096c351f2e412950e576bc1ce6fedc68df8ec133f6045affa65cece9e2a6e6900a97648b9a3aa2332bbfba8df1d03c795a03198e5168e44128b2106965d43c1
+  data.tar.gz: 52b1d57e8919721b5506a53151b1bfb5d2de3b772fe439adf38bc92e253792e0c6d23daddc8f5b405c2f5431331ed7c343e26eca305ad50d3278606fa46b453c

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Naming/FileName:
+  Exclude:
+    - "lib/nz-whois.rb"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nz-whois.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Andrew Bromwich
+
+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.md

@@ -0,0 +1,66 @@
+# New Zealand whois scraper
+
+Since the NZ DNC block port 43 whois, instead we need to scrape their website :/
+
+_N.B. The NZ DNC rate limit requests so you'll need to be careful how much you use it. See Terms of Use below_ 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nz-whois'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+```ruby
+require 'nz-whois'
+
+whois = NZWhois.whois 'mydomain.nz'
+puts "Valid whois?: #{whois.valid_whois?}"
+ => true
+puts "Expiry: #{whois.expires_on}"
+ => "Expiry: 2018-03-13 12:02:00 +0000"
+```
+
+## NZ DNC Terms of Use
+_Sourced from https://dnc.org.nz_
+
+Terms of Use: By submitting a WHOIS query you are entering into an agreement with Domain Name Commission Ltd on the following terms and conditions, and subject to all relevant .nz Policies and procedures as found at https://dnc.org.nz/. It is prohibited to: 
+- Send high volume WHOIS queries with the effect of downloading part of or all of the .nz Register or collecting register data or records; 
+- Access the .nz Register in bulk through the WHOIS service (ie. where a user is able to access WHOIS data other than by sending individual queries to the database); 
+- Use WHOIS data to allow, enable, or otherwise support mass unsolicited commercial advertising, or mass solicitations to registrants or to undertake market research via direct mail, electronic mail, SMS, telephone or any other medium; 
+- Use WHOIS data in contravention of any applicable data and privacy laws, including the Unsolicited Electronic Messages Act 2007; 
+- Store or compile WHOIS data to build up a secondary register of information; 
+- Publish historical or non-current versions of WHOIS data; and 
+- Publish any WHOIS data in bulk. Copyright Domain Name Commission Limited (a company wholly-owned by Internet New Zealand Incorporated) which may enforce its rights against any person or entity that undertakes any prohibited activity without its written permission. The WHOIS service is provided by NZRS Limited.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abrom/nz-whois.
+
+Note that spec tests are appreciated to minimise regressions. Before submitting a PR, please ensure that:
+ 
+```bash
+$ rspec
+```
+
+and
+
+```bash
+$ rubocop
+```
+
+both succeed 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'nz-whois'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/lib/nz-whois.rb

@@ -0,0 +1,15 @@
+require 'nz-whois/gem_version'
+
+require 'nz-whois/client'
+require 'nz-whois/contact'
+require 'nz-whois/invalid_domain_error'
+require 'nz-whois/parser'
+
+#
+# Module helper shortcut for Client whois
+#
+module NZWhois
+  def self.whois(domain)
+    Client.whois domain
+  end
+end

data/lib/nz-whois/client.rb

@@ -0,0 +1,65 @@
+require 'open-uri'
+
+module NZWhois
+  #
+  # Client used to fetch NZ WHOIS data and delegate parser results
+  #
+  class Client
+    extend Forwardable
+
+    #
+    # Class helper for whois instance method
+    # @param [String] domain Domain name to fetch WHOIS data for
+    # @return Client instance
+    #
+    def self.whois(domain)
+      new.whois domain
+    end
+
+    #
+    # Fetch WHOIS data for a domain name
+    # @param [String] domain Domain name to fetch WHOIS data for
+    # @return Client instance (`self`)
+    #
+    def whois(domain)
+      raise InvalidDomainError unless domain.to_s.gsub(/\.nz\z/)
+      fetch_content domain
+      self
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @valid_whois=%<valid_whois>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        valid_whois: valid_whois?
+      )
+    end
+
+    #
+    # Returns whether the whois response is valid
+    # @return Boolean
+    #
+    def valid_whois?
+      @status == '200' && parser.valid_whois?
+    end
+
+    def_delegators :parser, :status, :registered_on, :expires_on,
+                   :last_modified_on, :delegation_requested?, :domain_signed?,
+                   :registrar, :registrant_contact, :admin_contact,
+                   :technical_contact, :name_servers
+
+    private
+
+    def fetch_content(domain)
+      open("https://dnc.org.nz/whois/search?domain_name=#{domain}") do |f|
+        @status = f.status.first
+        @content = f.read
+      end
+    end
+
+    def parser
+      @parser ||= Parser.new @content
+    end
+  end
+end

data/lib/nz-whois/contact.rb

@@ -0,0 +1,63 @@
+module NZWhois
+  #
+  # User contact for WHOIS response
+  #
+  class Contact
+    def initialize(parser, contact_type)
+      @parser = parser
+      @contact_type = contact_type
+    end
+
+    def name
+      content_for 'Name'
+    end
+
+    def address
+      content_for 'Address'
+    end
+
+    def city
+      content_for 'City'
+    end
+
+    def province
+      content_for 'Province'
+    end
+
+    def postal_code
+      content_for 'Postal Code'
+    end
+
+    def country
+      content_for 'Country'
+    end
+
+    def phone
+      content_for 'Phone'
+    end
+
+    def fax
+      content_for 'Fax'
+    end
+
+    def email
+      content_for 'Email'
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @name=%<name>s @email=%<email>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        name: name,
+        email: email
+      )
+    end
+
+    private
+
+    def content_for(field)
+      @parser.content_for "#{@contact_type} #{field}"
+    end
+  end
+end

data/lib/nz-whois/gem_version.rb

@@ -0,0 +1,3 @@
+module NZWhois
+  VERSION = '0.0.1'.freeze
+end

data/lib/nz-whois/invalid_domain_error.rb

@@ -0,0 +1,10 @@
+module NZWhois
+  #
+  # Invalid domain error used when a non `.nz` domain requested
+  #
+  class InvalidDomainError < StandardError
+    def message
+      'Only `.nz` domain names supported'
+    end
+  end
+end

data/lib/nz-whois/parser.rb

@@ -0,0 +1,97 @@
+require 'nokogiri'
+require 'date'
+
+module NZWhois
+  #
+  # WHOIS content parser
+  #
+  class Parser
+    def initialize(content)
+      @content = content
+    end
+
+    def valid_whois?
+      return @valid_whois if defined? @valid_whois
+      @valid_whois = !whois_content.nil?
+    end
+
+    def status
+      content_for 'Query Status'
+    end
+
+    def registered_on
+      nz_date_for 'Domain Date Registered'
+    end
+
+    def expires_on
+      nz_date_for 'Domain Date Billed Until'
+    end
+
+    def last_modified_on
+      nz_date_for 'Domain Date Last Modified'
+    end
+
+    def delegation_requested?
+      boolean_for? 'Domain Delegate Requested'
+    end
+
+    def domain_signed?
+      boolean_for? 'Domain Signed'
+    end
+
+    def registrar
+      Contact.new self, 'Registrar'
+    end
+
+    def registrant_contact
+      Contact.new self, 'Registrant Contact'
+    end
+
+    def admin_contact
+      Contact.new self, 'Admin Contact'
+    end
+
+    def technical_contact
+      Contact.new self, 'Technical Contact'
+    end
+
+    def name_servers
+      contents_for 'NS Name '
+    end
+
+    def content_for(description)
+      contents_for(description).first
+    end
+
+    private
+
+    def page
+      @page ||= Nokogiri::HTML @content
+    end
+
+    def whois_content
+      @whois_content ||= page.xpath("//*[@id='block-dnc-content']")
+    end
+
+    def contents_for(description)
+      return unless valid_whois?
+
+      whois_content.xpath("//td/*[text() = '#{description}']").map do |element|
+        element.ancestors('td').first.next_element.text
+      end
+    end
+
+    def nz_date_for(description)
+      date_string = content_for description
+      return unless date_string
+
+      # Add 12 hours (ie NZ) -- ignoring DST
+      Time.parse(date_string + ' GMT') + 12 * 3600
+    end
+
+    def boolean_for?(description)
+      boolean_string = content_for description
+      boolean_string == 'yes' if boolean_string
+    end
+  end
+end

data/nz-whois.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'nz-whois/gem_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nz-whois'
+  spec.version       = NZWhois::VERSION
+  spec.author        = 'abrom'
+  spec.email         = 'a.bromwich@gmail.com'
+
+  spec.summary       = 'NZ WHOIS scraper'
+  spec.description   = 'New Zealand WHOIS registry scraper'
+  spec.homepage      = 'https://github.com/abrom/nz-whois'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|docs)/})
+  end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'nokogiri', '~> 1.0', '>= 1.6.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+  spec.add_development_dependency 'webmock', '~> 3.2'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: nz-whois
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- abrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: New Zealand WHOIS registry scraper
+email: a.bromwich@gmail.com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- lib/nz-whois.rb
+- lib/nz-whois/client.rb
+- lib/nz-whois/contact.rb
+- lib/nz-whois/gem_version.rb
+- lib/nz-whois/invalid_domain_error.rb
+- lib/nz-whois/parser.rb
+- nz-whois.gemspec
+homepage: https://github.com/abrom/nz-whois
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: NZ WHOIS scraper
+test_files: []