name_checker 0.0.1

data/spec/fixtures/vcr_cassettes/twitter/unavailable.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.twitter.com/1/users/show.json?screen_name=m
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Ratelimit-Limit:
+      - '150'
+      X-Ratelimit-Remaining:
+      - '135'
+      X-Ratelimit-Reset:
+      - '1337090175'
+      X-Ratelimit-Class:
+      - api
+      Content-Type:
+      - application/json;charset=utf-8
+      Last-Modified:
+      - Tue, 15 May 2012 13:47:05 GMT
+      Expires:
+      - Tue, 31 Mar 1981 05:00:00 GMT
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-cache, no-store, must-revalidate, pre-check=0, post-check=0
+      Set-Cookie:
+      - guest_id="v1:133708962582792815";Expires=Thu, 15-May-14 13:47:05 GMT;Path=/;Domain=.twitter.com
+      - k=46.7.124.72.ff16c3e05efca4d7; path=/; expires=Tue, 22-May-2012 13:47:05
+        UTC; domain=.api.twitter.com; httponly
+      Status:
+      - 200 OK
+      X-Transaction:
+      - b566d4d13fd85283
+      X-Frame-Options:
+      - SAMEORIGIN
+      Date:
+      - Tue, 15 May 2012 13:47:05 GMT
+      Content-Length:
+      - '2020'
+      Server:
+      - tfe
+    body:
+      encoding: US-ASCII
+      string: ! '{"id":7998822,"id_str":"7998822","name":"Mark Douglass","screen_name":"m","location":"Bad
+        Kreuznach, Germany","description":"Sorry if I don''t reply to @mentions -
+        they are 99.9% incorrect and I''ve basically stopped checking them. \r\nPS:
+        Not interested in selling @m or @md - sorry!","url":"http:\/\/friendfeed.com\/mdoug","protected":false,"followers_count":17377,"friends_count":1480,"listed_count":195,"created_at":"Mon
+        Aug 06 18:15:01 +0000 2007","favourites_count":5149,"utc_offset":3600,"time_zone":"Berlin","geo_enabled":true,"verified":false,"statuses_count":3577,"lang":"en","status":{"created_at":"Sat
+        May 12 12:34:07 +0000 2012","id":201289149536419840,"id_str":"201289149536419840","text":"I
+        was just awarded the \"TV Elite\" badge at http:\/\/t.co\/zAAbEZ39","source":"\u003ca
+        href=\"http:\/\/gomiso.com\" rel=\"nofollow\"\u003eMiso\u003c\/a\u003e","truncated":false,"in_reply_to_status_id":null,"in_reply_to_status_id_str":null,"in_reply_to_user_id":null,"in_reply_to_user_id_str":null,"in_reply_to_screen_name":null,"geo":null,"coordinates":null,"place":null,"contributors":null,"retweet_count":0,"favorited":false,"retweeted":false,"possibly_sensitive":false},"contributors_enabled":false,"is_translator":false,"profile_background_color":"E4F2F5","profile_background_image_url":"http:\/\/a0.twimg.com\/profile_background_images\/3055488\/2364_body2.jpg","profile_background_image_url_https":"https:\/\/si0.twimg.com\/profile_background_images\/3055488\/2364_body2.jpg","profile_background_tile":false,"profile_image_url":"http:\/\/a0.twimg.com\/profile_images\/1702184506\/m_normal.jpg","profile_image_url_https":"https:\/\/si0.twimg.com\/profile_images\/1702184506\/m_normal.jpg","profile_link_color":"2D506C","profile_sidebar_border_color":"6386A3","profile_sidebar_fill_color":"E4F2F5","profile_text_color":"0A2817","profile_use_background_image":true,"show_all_inline_media":false,"default_profile":false,"default_profile_image":false,"following":null,"follow_request_sent":null,"notifications":null}'
+    http_version: 
+  recorded_at: Tue, 15 May 2012 13:47:05 GMT
+recorded_with: VCR 2.1.1

data/spec/name_checker/availability_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe NameChecker::Availability do
+  describe "available?" do
+    it "should return true if available" do
+      availability = klass.new('net', true)
+      availability.should be_available
+    end
+
+    it "should return false otherwise" do
+      availability = klass.new('net', false)
+      availability.should_not be_available
+    end
+  end
+
+  describe "unavailable?" do
+    it "should return true if unavailable" do
+      availability = klass.new('net', false)
+      availability.should be_unavailable
+    end
+
+    it "should return false otherwise" do
+      availability = klass.new('net', true)
+      availability.should_not be_unavailable
+    end
+  end
+
+  describe "unknown?" do
+    it "should return true if unknown" do
+      availability = klass.new('net', nil)
+      availability.should be_unknown
+    end
+
+    it "should return false otherwise" do
+      availability = klass.new('net', true)
+      availability.should_not be_unknown
+    end
+  end
+end

data/spec/name_checker/facebook_checker_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe NameChecker::FacebookChecker, "check" do
+  let(:fixtures_dir) { "facebook" }
+  subject { NameChecker::FacebookChecker }
+
+  def fixture_path(name)
+    "#{fixtures_dir}/#{name}"
+  end
+
+  it "should return negative if the name is too short" do
+    VCR.use_cassette(fixture_path("short")) do
+      availability = subject.check("jsda")
+      availability.should be_unavailable
+      availability.service.should == "facebook"
+    end
+  end
+
+  it "should return positive the name is available" do
+    VCR.use_cassette(fixture_path("available")) do
+      availability = subject.check("sdfjksdh")
+      availability.should be_available
+    end
+  end
+
+  it "should return negtive if the name is taken" do
+    VCR.use_cassette(fixture_path("unavailable")) do
+      availability = subject.check("davidtuite")
+      availability.should be_unavailable
+    end
+  end
+
+  it "should non choke on weird chars" do
+    VCR.use_cassette(fixture_path("weird_chars")) do
+      availability = subject.check("rememberly")
+      availability.should be_unavailable
+    end
+  end
+
+  context "server returns 500 response" do
+    let(:response) { stub(code: 500, headers: {}) }
+    before { subject.stub(:get) { response } }
+
+    it "should return unknown if there is an error" do
+      availability = subject.check("dsjfh")
+      availability.should be_unknown
+    end
+
+    it "should log the error if there is a server error" do
+      Logging.logger.should_receive(:warn)
+      subject.check("kdfjss")
+    end
+  end
+end

data/spec/name_checker/net_checker_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe NameChecker::NetChecker do
+  subject { NameChecker::NetChecker }
+
+  describe "check" do
+    let(:host_name) { "apple" }
+    let(:tld) { ".com" }
+
+    # NOTE: This test assumes there is a ROBO_WHOIS_API_KEY
+    # set in spec/shec_helper.rb
+    it "should hit the RoboWhoisChecker if there is an api key" do
+      NameChecker::RoboWhoisChecker.should_receive(:check)
+        .with(host_name + tld)
+      subject.check(host_name, tld)
+    end
+
+    it "should hit the WhoisChecker if there is no api key" do
+      NameChecker.configuration.stub(:robo_whois_api_key) { nil }
+
+      NameChecker::WhoisChecker.should_receive(:check)
+        .with(host_name + tld)
+      subject.check(host_name, tld)
+    end
+  end
+end

data/spec/name_checker/robo_whois_checker_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe NameChecker::RoboWhoisChecker, "check" do
+  let(:fixtures_dir) { "robo_whois" }
+  subject { NameChecker::RoboWhoisChecker }
+
+  def fixture_path(name)
+    "#{fixtures_dir}/#{name}"
+  end
+
+  it "should raise an error if there is no api key"
+
+  it "should tell if the domain is unavailable" do
+    VCR.use_cassette(fixture_path("unavailable")) do
+      availability = subject.check("apple.com")
+      availability.should be_unavailable
+      availability.service.should == 'robo_whois'
+    end
+  end
+
+  it "should tell if the domain is available" do
+    available_domain = "fwekjfkewfhwefhhfjcjksdjklka.com"
+    VCR.use_cassette(fixture_path("available")) do
+      availability = subject.check(available_domain)
+      availability.should be_available
+    end
+  end
+
+  it "should log if the remaining credits are below 50" do
+    VCR.use_cassette(fixture_path("credits")) do
+      Logging.logger.should_receive(:warn)
+      availability = subject.check("apple.ly")
+    end
+  end
+
+  it "should not log if the remaining credits are above 50" do
+    VCR.use_cassette(fixture_path("unavailable")) do
+      Logging.logger.should_not_receive(:warn)
+      availability = subject.check("apple.com")
+    end
+  end
+
+  # NOTE: These don't hit the network
+  context "server returns non-200 status" do
+    let(:host) { "apple.com" }
+    let(:response) { stub(headers: {}, code: 500) }
+    before { subject.stub(:get) { response } }
+
+    it "should log" do
+      Logging.logger.should_receive(:warn)
+      subject.check(host)
+    end
+
+    it "should return 'unknown' availability" do
+      availability = subject.check(host)
+      availability.should be_unknown
+    end
+  end
+end

data/spec/name_checker/twitter_checker_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe NameChecker::TwitterChecker, "check" do
+  let(:fixtures_dir) { "twitter" }
+  subject { NameChecker::TwitterChecker }
+
+  def fixture_path(name)
+    "#{fixtures_dir}/#{name}"
+  end
+
+  it "should return positive the name is available" do
+    VCR.use_cassette(fixture_path("available")) do
+      availability = subject.check("sdfjksdh")
+      availability.should be_available
+    end
+  end
+
+  it "should return negative if the name is too long" do
+    VCR.use_cassette(fixture_path("long")) do
+      long_name = "sjkhdfkjsdhkjfhksjdfhkjsdsjhfkjhs"
+      availability = subject.check(long_name)
+      availability.should be_unavailable
+    end
+  end
+
+  it "should return negtive if the name is taken" do
+    VCR.use_cassette(fixture_path("unavailable")) do
+      availability = subject.check("m")
+      availability.should be_unavailable
+    end
+  end
+
+  describe "rate limit handling" do
+    it "should log if the ratelimit-remaining if it is below 20" do
+      VCR.use_cassette(fixture_path("rate_limit")) do
+        Logging.logger.should_receive(:warn)
+        subject.check("m")
+      end
+    end
+
+    it "should not log if the ratelimit-remaining if it is above 20" do
+      VCR.use_cassette(fixture_path("unavailable")) do
+        Logging.logger.should_not_receive(:warn)
+        subject.check("m")
+      end
+    end
+  end
+
+  context "server returns 500 response" do
+    let(:response) { stub(code: 500, headers: {}) }
+    before { subject.stub(:get) { response } }
+
+    it "should return unknown if there is an error" do
+      availability = subject.check("dsjfh")
+      availability.should be_unknown
+    end
+
+    it "should log the error if there is a server error" do
+      # Rails.logger.should_receive(:warn)
+      subject.check("kdfj")
+    end
+  end
+
+  context "user has been suspenved" do
+    it "should return negative" do
+      VCR.use_cassette(fixture_path("suspended")) do
+        availability = subject.check("apple")
+        availability.should be_unavailable
+      end
+    end
+  end
+end

data/spec/name_checker/whois_checker.rb

@@ -0,0 +1,10 @@
+module NameChecker
+  class WhoisChecker
+    @service_name = :whois
+    def self.check(host, options = {})
+      # INFO: http://bit.ly/KYpzaj
+      res = Whois.available?(host)
+      Availability.new(@service_name, res)
+    end
+  end
+end

data/spec/name_checker/whois_checker_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe NameChecker::WhoisChecker do
+  let(:fixtures_dir) { "whois" }
+  subject { NameChecker::WhoisChecker }
+
+  def fixture_path(name)
+    "#{fixtures_dir}/#{name}"
+  end
+
+  it "should tell if the domain is available" do
+    VCR.use_cassette(fixture_path('available')) do
+      availability = subject.check("dsjfdfjdjfd.com")
+      availability.should be_available
+      availability.service.should == 'whois'
+    end
+  end
+
+  it "should tell if the domain is unavailable" do
+    VCR.use_cassette(fixture_path("unavailable")) do
+      availability = subject.check("apple.com")
+      availability.should be_unavailable
+    end
+  end
+
+  it "should tell if the whois doesn't work" do
+    Whois.stub(:available?) { nil }
+    VCR.use_cassette(fixture_path("unknown")) do
+      availability = subject.check("apple.com")
+      availability.should be_unknown
+    end
+  end
+end

data/spec/name_checker_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe NameChecker do
+  describe "check" do
+    let(:text) { "hello" }
+    subject { NameChecker }
+
+    it "should check the twitter service" do
+      NameChecker::TwitterChecker.should_receive(:check).with(text)
+      subject.check(text, 'twitter')
+    end
+
+    it "shoud check the facebook service" do
+      NameChecker::FacebookChecker.should_receive(:check).with(text)
+      subject.check(text, 'facebook')
+    end
+
+    it "shoud check the robo whois service" do
+      service_name = 'com'
+      NameChecker::NetChecker.should_receive(:check).with(text, service_name)
+      subject.check(text, service_name)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require "name_checker"
+require 'vcr'
+
+unless defined?(SPEC_ROOT)
+  SPEC_ROOT = File.expand_path("../", __FILE__)
+end
+
+# Add your robo whois api key here if you have one:
+ROBO_WHOIS_API_KEY = nil
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(SPEC_ROOT, "support/**/*.rb")].each { |f| require f }
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock # or :fakeweb
+  c.ignore_hosts '127.0.0.1', 'localhost'
+
+  if ROBO_WHOIS_API_KEY 
+    c.filter_sensitive_data('<ROBO_WHOIS_API_KEY>') { ROBO_WHOIS_API_KEY }
+  end
+end
+
+NameChecker.configure do |config|
+  config.robo_whois_api_key = ROBO_WHOIS_API_KEY if ROBO_WHOIS_API_KEY
+end

data/spec/support/helpers.rb

@@ -0,0 +1,12 @@
+module RSpecSupportSpecHelpers
+  # Gets the currently described class.
+  # Conversely to +subject+, it returns the class
+  # instead of an instance.
+  def klass
+    described_class
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpecSupportSpecHelpers
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: name_checker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Tuite
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70168530643800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70168530643800
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70168530642960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70168530642960
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70168530642080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70168530642080
+- !ruby/object:Gem::Dependency
+  name: whois
+  requirement: &70168530640740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70168530640740
+description: ! '    NameChecker is a Ruby library for checking the availability of
+  a word across various TLDs and social networks. It was created to power http://domiy.com.
+
+'
+email:
+- dtuite@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/name_checker.rb
+- lib/name_checker/availability.rb
+- lib/name_checker/configuration.rb
+- lib/name_checker/facebook_checker.rb
+- lib/name_checker/logging.rb
+- lib/name_checker/net_checker.rb
+- lib/name_checker/railties.rb
+- lib/name_checker/robo_whois_checker.rb
+- lib/name_checker/twitter_checker.rb
+- lib/name_checker/version.rb
+- name_checker.gemspec
+- spec/fixtures/vcr_cassettes/facebook/available.yml
+- spec/fixtures/vcr_cassettes/facebook/unavailable.yml
+- spec/fixtures/vcr_cassettes/facebook/weird_chars.yml
+- spec/fixtures/vcr_cassettes/robo_whois/available.yml
+- spec/fixtures/vcr_cassettes/robo_whois/credits.yml
+- spec/fixtures/vcr_cassettes/robo_whois/unavailable.yml
+- spec/fixtures/vcr_cassettes/twitter/available.yml
+- spec/fixtures/vcr_cassettes/twitter/rate_limit.yml
+- spec/fixtures/vcr_cassettes/twitter/suspended.yml
+- spec/fixtures/vcr_cassettes/twitter/unavailable.yml
+- spec/name_checker/availability_spec.rb
+- spec/name_checker/facebook_checker_spec.rb
+- spec/name_checker/net_checker_spec.rb
+- spec/name_checker/robo_whois_checker_spec.rb
+- spec/name_checker/twitter_checker_spec.rb
+- spec/name_checker/whois_checker.rb
+- spec/name_checker/whois_checker_spec.rb
+- spec/name_checker_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Check the availability of a name on various services.
+test_files:
+- spec/fixtures/vcr_cassettes/facebook/available.yml
+- spec/fixtures/vcr_cassettes/facebook/unavailable.yml
+- spec/fixtures/vcr_cassettes/facebook/weird_chars.yml
+- spec/fixtures/vcr_cassettes/robo_whois/available.yml
+- spec/fixtures/vcr_cassettes/robo_whois/credits.yml
+- spec/fixtures/vcr_cassettes/robo_whois/unavailable.yml
+- spec/fixtures/vcr_cassettes/twitter/available.yml
+- spec/fixtures/vcr_cassettes/twitter/rate_limit.yml
+- spec/fixtures/vcr_cassettes/twitter/suspended.yml
+- spec/fixtures/vcr_cassettes/twitter/unavailable.yml
+- spec/name_checker/availability_spec.rb
+- spec/name_checker/facebook_checker_spec.rb
+- spec/name_checker/net_checker_spec.rb
+- spec/name_checker/robo_whois_checker_spec.rb
+- spec/name_checker/twitter_checker_spec.rb
+- spec/name_checker/whois_checker.rb
+- spec/name_checker/whois_checker_spec.rb
+- spec/name_checker_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb