Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 2.16 KB

README.md

File metadata and controls

83 lines (53 loc) · 2.16 KB
Raw

NameChecker Build Status

NameChecker makes it easy to check the availability of a word across various top-level domains and social networks.

It powers checking at namedar.com.

Installation

Add this line to your application's Gemfile:

gem 'name_checker'

And then execute:

$ bundle

Or install it yourself as:

$ gem install name_checker

API

availability = NameChecker.check(<WORD>, <SERVICE>)

Usage

availability = NameChecker.check("banana", "twitter")
availability.text
#=> "banana"
availability.available?
#=> false

# NOTE: It is important to include the period at the start 
# of the TLD when checking hosts.
availability = NameChecker.check("availabledomain", ".net")
availability.text
#=> "availabledomain.net"
availability.available?
#=> true

Supported Social Networks

  • Facebook
  • Twitter

Supported Top-level Domains

See the documentation of the Ruby-Whois Gem.

Checking Domain Availability

Domain availability checking can occur either with the Whois Gem (default) or via the RoboWhois API.

To use the RoboWhois service, simply configure NameChecker with an API key.

NameChecker.config do |config|
  config.robo_whois_api_key = 'jdsfldsjflkj'
end

All domain availability requests will then route through RoboWhois.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Running the Specs

You will need to add a RoboWhois Api Key to spec/spec_helper.rb to be able to run all of the specs. Set it up like this:

# Add your robo whois api key here:
ROBO_WHOIS_API_KEY = 'YOUR_KEY'

You can still run the specs without an API key. However, all specs related to the RoboWhoisChecker will fail.