whoisxmlapi 0.0.16 → 0.0.17

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTRhNzY0ZjZkNTliYzBmNzJlYzM3NjE5N2YxODE1N2VmZWE2Y2QzZA==
-  data.tar.gz: !binary |-
-    NmQxYWY5OTg0NzFjMDcwNmY2NGJhYWJlOWNhZDFiNzU2MTBlNzQ5Nw==
+SHA256:
+  metadata.gz: 2ee7bacb19ead9fff1009409330c4b224e496f0c40311d2a00b4fed487b9fe51
+  data.tar.gz: 0b5df1d17fb4995116bd156fc6c06687515dc902034e8d41e002cdd6c66cd016
 SHA512:
-  metadata.gz: !binary |-
-    M2U5YzM1NWIzZjI1MWFhOWVkNTZjZGIzMDM0MTgxMTAyMWI3YzM4NjljNjA0
-    NjJjNWEyM2JlZThiMjEyNTkxYzQyNzJlYzVkYmJjNmE2MTBlYzQxM2JlNGM0
-    Zjg5YWI3ZmY0M2U3NDY3NDAyYmYwOTVmZTIwOGVlZjAxOWRhYmI=
-  data.tar.gz: !binary |-
-    OWJmN2FiYzVlNWM0ODI2ODlmMWYwNzJlMGM2NGJhZTNjZjQ0YTk1NTRiMzFk
-    NGM0ZDNiZjMyYTE2N2UwMzMxNTk0MDI0M2JjNGQ5ZDIxNzkyMzM4YmJjYjQx
-    MmEyNGJkMDMyNTU2NjhmMGRiNmMyZjNjMTE1MjEzNDA2ZTJhMmE=
+  metadata.gz: 7bf58edcfa9453db455c1ad5ff1a5a82efddf33bd195bbdd5421f65503944198222f6289590e655a17db98e0dbfabff72581738f7e65c51ec23d9238d2c7088f
+  data.tar.gz: fbcf7db8ecee37bce1f36a9f2ae0f4c1293f6bf5b97dd86cf0ecbf748f83f2aff9909bc15aef8f7f06df7fdf0d8368f73568e0b24d12f69b1299ab891fd049fb

data/lib/whoisxmlapi.rb

@@ -32,6 +32,14 @@ module WhoisXMLAPI
   def self.password=(pass)
     @password = pass
   end
+  
+  def self.api_key
+    @api_key
+  end
+  
+  def self.api_key=(key)
+    @api_key = key
+  end
 
   def self.cache_length=(leng)
     @cache_length = leng

data/lib/whoisxmlapi/client.rb

@@ -4,7 +4,9 @@ require 'json'
 require 'public_suffix'
 
 module WhoisXMLAPI
+
   class Client
+
     def whois(domain)
       unless PublicSuffix.valid?(domain)
         res = WhoisXMLAPI::BadDomain.new
@@ -24,15 +26,15 @@ module WhoisXMLAPI
         return res
       else
         xquery = {
+            :apiKey => WhoisXMLAPI.api_key,
             :domainName => domain,
-            :outputFormat => 'json', # TODO: make into a config setting. see the JSON.parse line below for the rest of this change
-            :userName => WhoisXMLAPI.username,
-            :password => WhoisXMLAPI.password
+            :outputFormat => 'JSON'
         }
+
         begin
           r = HTTParty.get("#{WhoisXMLAPI.domain}/whoisserver/WhoisService", :query => xquery, :timeout => 120)
         rescue Exception => e
-          WhoisXMLAPI.logger.info("Error getting Whois info: #{e}")
+          WhoisXMLAPI.logger.info("Error getting Whois info for #{domain}: #{e}")
           res = WhoisXMLAPI::Unavailable.new
           res.parse(domain)
           return res
@@ -46,8 +48,15 @@ module WhoisXMLAPI
           end
         end
 
-        # TODO: with the above outputFormat change, use a Parser plugin instead of this
-        presponse = JSON.parse(r.parsed_response)
+        # WhoisXML and HTTParty are sometimes returning a Hash and not a JSON string as requested,
+        # which is causing an error of "no implicit conversion of Hash into String" when we call JSON.parse.
+        # Logger message is to monitor whether WhoisXML and/or HTTParty will still return a string on occasion.
+        if r.parsed_response.is_a?(String)
+          WhoisXMLAPI.logger.debug "WhoisXML Whois method passed back parsed_response as a String instead of a Hash for #{domain}."
+          presponse = JSON.parse(r.parsed_response)
+        else
+          presponse = r.parsed_response
+        end
 
         if (200..299).include? r.code.to_i and not presponse.key? 'ErrorMessage'
            res.parse(presponse['WhoisRecord'])
@@ -62,7 +71,9 @@ module WhoisXMLAPI
       end
     end
 
+
     def rwhois(entity_name)
+      # entity_name is really the domain being passed in for Rwhois not the actual entity name
       return nil if entity_name.nil?
       query = WhoisXMLAPI::RWhoisResult.where(:entity_name => entity_name)
       if WhoisXMLAPI.cache
@@ -71,23 +82,28 @@ module WhoisXMLAPI
       res = query.first
 
       if res
-        Rails.logger.debug "WhoisXMLAPI rwhois - have cached rwhois data for #{entity_name}"
+        WhoisXMLAPI.logger.debug "WhoisXMLAPI rwhois - using cached rwhois data for #{entity_name}"
       else
-        Rails.logger.debug "WhoisXMLAPI rwhois - no cached rwhois data for #{entity_name}"
+        WhoisXMLAPI.logger.debug "WhoisXMLAPI rwhois - no cached rwhois data for #{entity_name}"
         res = WhoisXMLAPI::RWhoisResult.create(:entity_name => entity_name)
-        rquery = {
-            :term1 => entity_name,
-            :search_type => 'current',
-            :mode => WhoisXMLAPI.rwhois_mode,
-            :username => WhoisXMLAPI.username,
-            :password => WhoisXMLAPI.password
+
+        params_basic = {
+          basicSearchTerms: {
+            :include => [entity_name], # must be an array of strings!
+            :search_type => "current"
+          },
+          :mode => WhoisXMLAPI.rwhois_mode,
+          :apiKey => WhoisXMLAPI.api_key,
         }
-        r = HTTParty.get("#{WhoisXMLAPI.domain}/reverse-whois-api/search.php", :query => rquery, :timeout => 120)
+
+        r = create_and_send_rwhois_request(params_basic)
+
         if WhoisXMLAPI.callbacks[:rwhois]
           WhoisXMLAPI.callbacks[:rwhois].each do |cb|
             cb.call
           end
         end
+
         if r && r.parsed_response && r.parsed_response['domains']
           res.domains = r.parsed_response['domains']
           res.save
@@ -96,19 +112,24 @@ module WhoisXMLAPI
           domain_sld = domain.sld
           Rails.logger.debug "WhoisXMLAPI rwhois - no domains found for domain #{entity_name}, trying #{domain_sld}"
           res = WhoisXMLAPI::RWhoisResult.create(:entity_name => domain_sld)
-          rquery = {
-              :term1 => domain_sld,
-              :search_type => 'current',
+
+          params_basic = {
+            basicSearchTerms: {
+              :include => [domain_sld], #must be an array of strings!
+              :search_type => "current"
+            },
               :mode => WhoisXMLAPI.rwhois_mode,
-              :username => WhoisXMLAPI.username,
-              :password => WhoisXMLAPI.password
+              :apiKey => WhoisXMLAPI.api_key,
           }
-          r = HTTParty.get("#{WhoisXMLAPI.domain}/reverse-whois-api/search.php", :query => rquery, :timeout => 120)
+
+          r = create_and_send_rwhois_request(params_basic)
+
           if WhoisXMLAPI.callbacks[:rwhois]
             WhoisXMLAPI.callbacks[:rwhois].each do |cb|
               cb.call
             end
           end
+
           if r && r.parsed_response && r.parsed_response['domains']
             res.domains = r.parsed_response['domains']
             res.save
@@ -117,37 +138,79 @@ module WhoisXMLAPI
             res.save
           end
         else
-          Rails.logger.debug "WhoisXMLAPI rwhois - no domains found for #{entity_name}!"
+          WhoisXMLAPI.logger.debug "WhoisXMLAPI rwhois - no domains found for #{entity_name}!"
           res.domains = []
           res.save
         end
       end
       res
     end
-    
+
+
     def exists?(domain)
       xquery = {
           :cmd => 'GET_DN_AVAILABILITY',
           :domainName => domain,
-          :outputFormat => 'json',
-          :userName => WhoisXMLAPI.username,
-          :password => WhoisXMLAPI.password
+          :outputFormat => 'JSON',
+          :apiKey => WhoisXMLAPI.api_key
       }
       r = HTTParty.get("#{WhoisXMLAPI.domain}/whoisserver/WhoisService", :query => xquery, :timeout => 120)
 
-      resp = JSON.parse(r.parsed_response)
+      # WhoisXML and HTTParty are sometimes returning a Hash and not a JSON string as requested,
+      # which is causing an error of "no implicit conversion of Hash into String" when we call JSON.parse.
+      # Logger message is to monitor whether WhoisXML and/or HTTParty will still return a string on occasion.
+      if r.parsed_response.is_a?(String)
+        Rails.logger.debug "WhoisXML passed back parsed_response as a String instead of a Hash for #{domain}. Exists? method"
+        resp = JSON.parse(r.parsed_response)
+      else
+        resp = r.parsed_response
+      end
+
       resp["DomainInfo"]["domainAvailability"] == "UNAVAILABLE"
     end
 
+
     def account_balance
       aquery = {
           :servicetype => 'accountbalance',
           :output_format => 'JSON',
-          :username => WhoisXMLAPI.username,
-          :password => WhoisXMLAPI.password
+          :apiKey => WhoisXMLAPI.api_key
       }
       r = HTTParty.get("#{WhoisXMLAPI.domain}/accountServices.php", :query => aquery, :timeout => 120)
-      JSON.parse(r.parsed_response)
+
+      # WhoisXML and HTTParty are sometimes returning a Hash and not a JSON string as requested,
+      # which is causing an error of "no implicit conversion of Hash into String" when we call JSON.parse.
+      # Logger message is to monitor whether WhoisXML and/or HTTParty will still return a string on occasion.
+      if r.parsed_response.is_a?(String)
+        Rails.logger.debug "WhoisXML passed back parsed_response as a String instead of a Hash. Account_balance method"
+        JSON.parse(r.parsed_response)
+      else
+        r.parsed_response
+      end
+
+    end
+
+
+    ####################################################################################################
+    private
+    ####################################################################################################
+
+
+    def self.create_and_send_rwhois_request(params_basic)
+      uri = URI.parse('https://reverse-whois-api.whoisxmlapi.com/api/v2')
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.add_field('Content-Type', 'application/json')
+      request.add_field('Accept', 'application/json')
+      request.body = params_basic.to_json
+      r = http.request(request)
+      # used for debugging
+      # puts JSON.parse(r.body).to_yaml
+      return r
     end
-  end
-end
+
+  end  # of class Client
+
+end # of module WhoisXMLAPI

data/lib/whoisxmlapi/version.rb

@@ -1,3 +1,3 @@
 module WhoisXMLAPI
-  VERSION = "0.0.16"
+  VERSION = "0.0.17"
 end

data/whoisxmlapi.gemspec

@@ -6,8 +6,8 @@ require 'whoisxmlapi/version'
 Gem::Specification.new do |spec|
   spec.name          = "whoisxmlapi"
   spec.version       = WhoisXMLAPI::VERSION
-  spec.authors       = ["Christopher Maujean", "David Hillard"]
-  spec.email         = ["dhillard@brandle.net"]
+  spec.authors       = ["Christopher Maujean", "David Hillard", "Matt Appel", "Chip Roberson"]
+  spec.email         = ["cmaujean@brandle.net", "dhillard@brandle.net", "mappel@brandle.net", "chip@brandle.net"]
   spec.description   = %q{Gem for accessing the Whois XML API via JSON, with caching}
   spec.summary       = %q{whoisxmlapi.com access}
   spec.homepage      = "http://brandle.net/"

metadata

@@ -1,108 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: whoisxmlapi
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Christopher Maujean
 - David Hillard
+- Matt Appel
+- Chip Roberson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2018-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Gem for accessing the Whois XML API via JSON, with caching
 email:
+- cmaujean@brandle.net
 - dhillard@brandle.net
+- mappel@brandle.net
+- chip@brandle.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -129,17 +134,17 @@ 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.4.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: whoisxmlapi.com access