hexillion 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f99520faee0f3b877d1f10b01ef5de61b0a0209
+  data.tar.gz: 0232be8e63dca6ac5d6974976dc2565198912658
+SHA512:
+  metadata.gz: 23421ef1f1af30223a3dc14c69b122b3861e0f7d100b83c8a0eaec766b7e32c29cb99db75536005ee9fd76188b71ec96347f4bc0e0ea72fd69f279681946c51b
+  data.tar.gz: 4c25b4a3976b1a41284f4e2daa4190bb379249b45f464b5461040451b8ffa2d2fccce43dd6b841b30571d7065d154db8fd542cafd60873b36d29232d4fce8f38

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Flippa.com Pty. Ltd.
+
+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,35 @@
+# Hexillion API Client Gem for Ruby
+
+This gem provides a basic Ruby wrapper for the
+[Hexillion Whois API](http://hexillion.com/whois/).
+It is largely based on the [Quova gem](http://github.com/d11wtq/quova/) by Chris Corbyn.
+
+## Installation
+
+    gem install hexillion
+
+## Usage
+
+The core class is `Hexillion::Client`. Create a new instance, passing in your Hexillion API
+username and password:
+
+    hex = Hexillion::Client.new(:username => 'MYUSERNAME', :password => 'MYPASSWORD')
+
+Then, use the `whois` method on the instance to query Whois records for a given domain:
+
+    hex.whois('example.com')
+
+The return value is a hash with all the Whois data returned by the API.
+
+## Resources
+
+  - [Source](https://github.com/flippa/hexillion)
+  - [Issues](https://github.com/flippa/hexillion/issues)
+
+## Disclaimer
+
+The official maintainer of this Gem, Flippa.com is no way affiliated with, nor
+representative of Hexillion.  This code is provided free of charge and shall be used
+at your own risk.
+
+Copyright (c) 2011 Flippa.com Pty. Ltd.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/hexillion.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hexillion/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Louis Simoneau"]
+  gem.email         = ["simoneau.louis@gmail.com"]
+  gem.description   = %q{Hexillion WhoIs API Client for Ruby}
+  gem.summary       = %q{Provides a simple client for the Hexillion API}
+  gem.homepage      = ''
+  
+  gem.add_dependency "rest-client", "~> 1.6.3"
+  gem.add_dependency "nokogiri",    "~> 1.5.0"
+  
+  gem.add_development_dependency "rspec", "~> 2.6"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "hexillion"
+  gem.require_paths = ['lib']
+  gem.version       = Hexillion::VERSION
+end

data/lib/hexillion.rb

@@ -0,0 +1,117 @@
+require 'date'
+require 'rest-client'
+require 'nokogiri'
+
+module Hexillion
+  class Client
+    def initialize(options)
+      response = RestClient.post "https://hexillion.com/rf/xml/1.0/auth/", :username => options[:username], :password => options[:password]
+      doc = Nokogiri::XML(response)
+      begin
+        @session_key = doc.at_css('SessionKey').content
+      rescue
+        raise "Authentication failed"
+      end
+    end
+    
+    # Query the API for a given domain
+    # 
+    # @example 
+    #   client.whois('flippa.com') # => { ... }
+    # 
+    #  
+    
+    def whois(domain)
+      response = RestClient.get "http://hexillion.com/rf/xml/1.0/whois/", :params => {:sessionkey => @session_key, :query => domain}
+      parse_xml(response.body)
+    end
+    
+    private
+    
+    def parse_xml(xml)
+      doc = Nokogiri::XML(xml)
+      records = doc.xpath(".//QueryResult[ErrorCode='Success' and FoundMatch='Yes']/WhoisRecord")
+  
+      strings = {
+        :registrant_name => "Registrant Name",
+        :registrant_person => "Registrant Person",
+        :registrant_handle => "Registrant Handle",
+        :registrant_address => "Registrant Address",
+        :registrant_city => "Registrant City",
+        :registrant_state_province => "Registrant StateProvince",
+        :registrant_postal_code => "Registrant PostalCode",
+        :registrant_country => "Registrant Country",
+        :registrant_country_code => "Registrant CountryCode",
+        :registrant_email => "Registrant Email",
+        :registrar_name => "Registrar Name",
+        :registrar_whois_server => "Registrar WhoisServer",
+        :registrar_homepage => "Registrar HomePage",
+        :admin_contact_name => "AdminContact Name",
+        :admin_contact_person => "AdminContact Person",
+        :admin_contact_handle => "AdminContact Handle",
+        :admin_contact_address => "AdminContact Address",
+        :admin_contact_state_province => "AdminContact StateProvince",
+        :admin_contact_postal_code => "AdminContact PostalCode",
+        :admin_contact_country_code => "AdminContact CountryCode",
+        :admin_contact_country => "AdminContact Country",
+        :admin_contact_email => "AdminContact Email",
+        :admin_contact_phone => "AdminContact Phone",
+        :admin_contact_fax => "AdminContact Fax",
+        :tech_contact_name => "TechContact Name",
+        :tech_contact_person => "TechContact Person",
+        :tech_contact_handle => "TechContact Handle",
+        :tech_contact_address => "TechContact Address",
+        :tech_contact_state_province => "TechContact StateProvince",
+        :tech_contact_postal_code => "TechContact PostalCode",
+        :tech_contact_country_code => "TechContact CountryCode",
+        :tech_contact_country => "TechContact Country",
+        :tech_contact_email => "TechContact Email",
+        :tech_contact_phone => "TechContact Phone",
+        :tech_contact_fax => "TechContact Fax",
+        :zone_contact_name => "ZoneContact Name",
+        :zone_contact_person => "ZoneContact Person",
+        :zone_contact_handle => "ZoneContact Handle",
+        :zone_contact_address => "ZoneContact Address",
+        :zone_contact_state_province => "ZoneContact StateProvince",
+        :zone_contact_postal_code => "ZoneContact PostalCode",
+        :zone_contact_country_code => "ZoneContact CountryCode",
+        :zone_contact_country => "ZoneContact Country",
+        :zone_contact_email => "ZoneContact Email",
+        :zone_contact_phone => "ZoneContact Phone",
+        :zone_contact_fax => "ZoneContact Fax",
+        :header_text => "HeaderText",
+        :stripped_text => "StrippedText",
+        :raw_text => "RawText"
+      }
+      
+      dates = {
+        :created_date => './CreatedDate',
+        :expires_date => './ExpiresDate',
+        :updated_date => './UpdatedDate'
+      }
+      
+      result = { :xml_response => xml }
+      
+      records.each do |record|
+        result[:nameservers] = record.css('Domain NameServer').map { |x| x.content unless x.content == '' }
+        
+        strings.each do | attr, selector |
+          nodes = record.css(selector)
+          next if nodes.empty?
+          if nodes.size == 1 || selector.include?('Email')
+            result[attr] = nodes[0].content unless nodes[0].content == ''
+          else
+            result[attr] = nodes.to_a.reject { |s| s.blank? }.join("\n")
+          end
+        end
+        
+        dates.each do | attr, selector |
+          next unless node = record.at_xpath(selector)
+          result[attr] = DateTime.parse(node.content) unless node.content == ''
+        end
+      end
+      
+      result
+    end
+  end
+end

data/lib/hexillion/version.rb

@@ -0,0 +1,3 @@
+module Hexillion
+  VERSION = "0.0.4"
+end

data/spec/client_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+AUTH_RESPONSE =  '<?xml version="1.0" encoding="utf-8" ?>
+                  <AuthResult>
+                    <ErrorCode>Success</ErrorCode>
+                    <Message>The service successfully processed your request.</Message>
+                    <SessionKey>nOIANdfjL4524ynjlssasjfDFaqe4</SessionKey>
+                  </AuthResult>'
+
+describe Hexillion::Client do
+  describe '#initialize' do
+    it "requests a session key from Hexillion and assigns it as an instance variable" do
+      RestClient
+        .should_receive(:post)
+        .with("https://hexillion.com/rf/xml/1.0/auth/", {:username => "username", :password => "password"})
+        .and_return(AUTH_RESPONSE)
+      hex = Hexillion::Client.new(:username => "username", :password => "password")
+      hex.instance_variable_get('@session_key').should == 'nOIANdfjL4524ynjlssasjfDFaqe4'
+    end
+  end
+  
+  describe "#whois" do
+    before(:each) do
+      @response = double()
+      RestClient.stub(:post) { AUTH_RESPONSE }
+      RestClient.stub(:get) { @response }
+      @response.stub(:body) { "" }
+      @hex = Hexillion::Client.new(:username => "username", :password => "password")
+    end
+    
+    it "queries the API for the provided domain" do
+      RestClient.should_receive(:get)
+      @hex.whois("example.com")
+    end
+    
+    it "concats multiline address fields" do
+      @response.stub(:body) do
+        <<-XML
+        <QueryResult><ErrorCode>Success</ErrorCode><FoundMatch>Yes</FoundMatch><WhoisRecord>
+          <Registrant>
+            <Address>48 Cambridge Street</Address>
+            <Address>Level 3</Address>
+          </Registrant>
+        </WhoisRecord></QueryResult>
+        XML
+      end
+      
+      @hex.whois("example.com")[:registrant_address].should == "48 Cambridge Street\nLevel 3"
+    end
+
+    it "provides the registrant email address" do
+      @response.stub(:body) do
+        <<-XML
+        <QueryResult><ErrorCode>Success</ErrorCode><FoundMatch>Yes</FoundMatch><WhoisRecord>
+          <Registrant>
+            <Address>48 Cambridge Street</Address>
+            <Address>Level 3</Address>
+            <Email>me@example.com</Email>
+          </Registrant>
+        </WhoisRecord></QueryResult>
+        XML
+      end
+     
+      @hex.whois("example.com")[:registrant_email].should == "me@example.com"
+    end
+
+    it "returns the first email when multiple specified" do
+      @response.stub(:body) do
+        <<-XML
+        <QueryResult><ErrorCode>Success</ErrorCode><FoundMatch>Yes</FoundMatch><WhoisRecord>
+          <AdminContact>
+            <Email>john@example.com</Email>
+            <Email>fred@example.com</Email>
+          </AdminContact>
+        </WhoisRecord></QueryResult>
+        XML
+      end
+      
+      @hex.whois("example.com")[:admin_contact_email].should == "john@example.com"
+    end
+    
+    it "makes an array of nameservers" do
+      @response.stub(:body) do
+        <<-XML        
+        <QueryResult><ErrorCode>Success</ErrorCode><FoundMatch>Yes</FoundMatch><WhoisRecord>
+          <Domain>
+            <NameServer>ns1.registrar.com</NameServer>
+            <NameServer>ns2.registrar.com</NameServer>
+            <NameServer>ns3.registrar.com</NameServer>
+          </Domain>
+        </WhoisRecord></QueryResult>
+        XML
+      end
+      
+      @hex.whois("example.com")[:nameservers].should == ['ns1.registrar.com', 'ns2.registrar.com', 'ns3.registrar.com']
+    end
+
+    it "parses date fields" do
+      @response.stub(:body) do
+        <<-XML        
+        <QueryResult><ErrorCode>Success</ErrorCode><FoundMatch>Yes</FoundMatch><WhoisRecord>
+          <CreatedDate>1999-10-04T00:00:00Z</CreatedDate>
+          <UpdatedDate>2010-11-25T00:00:00Z</UpdatedDate>
+          <ExpiresDate>2019-10-04T00:00:00Z</ExpiresDate>
+        </WhoisRecord></QueryResult>
+        XML
+      end  
+      
+      @hex.whois("example.com")[:created_date].should == DateTime::civil(1999,10,4)
+    end
+    
+    it "returns the entire xml response as :xml_response" do
+      xml = <<-XML        
+        <QueryResult><ErrorCode>Success</ErrorCode><FoundMatch>Yes</FoundMatch><WhoisRecord>
+              <CreatedDate>1999-10-04T00:00:00Z</CreatedDate>
+              <UpdatedDate>2010-11-25T00:00:00Z</UpdatedDate>
+              <ExpiresDate>2019-10-04T00:00:00Z</ExpiresDate>
+            </WhoisRecord></QueryResult>
+            XML
+            
+      @response.stub(:body) { xml }
+      
+      @hex.whois("example.com")[:xml_response].should == xml
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'bundler/setup'
+require 'hexillion'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: hexillion
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Louis Simoneau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Hexillion WhoIs API Client for Ruby
+email:
+- simoneau.louis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hexillion.gemspec
+- lib/hexillion.rb
+- lib/hexillion/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Provides a simple client for the Hexillion API
+test_files: []