Project

whoxy

0.0
No commit activity in last 3 years
No release in over 3 years
Basic Faraday driven ruby gem for interacting with the Whoxy API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.13
>= 0
~> 10.0
~> 3.0

Runtime

< 0.11.0, > 0.9.0
 Project Readme

Whoxy

Interact with the Whoxy API for retrieving WHOIS data on domains.

Build Status

Installation

Add this line to your application's Gemfile:

gem 'whoxy'

And then execute:

$ bundle

Or install it yourself as:

$ gem install whoxy

Usage

Simply require the service, configure your key, then start looking up domains.

require 'whoxy'

Whoxy.configure do |config|
  config.key = ENV['WHOXY_KEY']
  # specify your own faraday connection (except for host)
  # config.connection do |conn|
  # ...
  # end
end

whois = Whoxy::Client.new
whois.lookup("google.com")
#=> Hash

URI Handling

Rather than force you to remember to take off sub-domains or URI schemes, the lookup command can handle that for you.

# ✓ returns Whoxy API results for 'ofdomain.com'
whois.lookup("subdomain.ofdomain.com")

# ✓ returns Whoxy API results for 'google.com'
whois.lookup("http://google.com")

# ✓ returns Whoxy API results for 'bar.com'
whois.lookup("mailto:foo@bar.com")

# ✓ returns Whoxy API results for 'bar.com'
whois.lookup("foo@bar.com")
#=> raises ArgumentError

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ormtech/whoxy.

License

The gem is available as open source under the terms of the MIT License.