name_checker 0.0.8 → 0.0.9

data/lib/name_checker.rb

@@ -12,6 +12,17 @@ require "name_checker/whois_checker"
 require "name_checker/net_checker"
 
 module NameChecker
+  # Check the availability of a word on a specific service.
+  #
+  # If the service name matches the identifier of a social
+  # network then that network will be checked. Otherwise, 
+  # treat the service name as a top-level domain.
+  #
+  #   NameChecker.check('hello', 'twitter')
+  #
+  #   NameChecker.check('hello', 'com')
+  #
+  # Returns an instance of the <tt>Availability<tt> class.
   def self.check(text, service_name)
     # NOTE: Symbols are not good for detecting the service name.
     # Sometimes it might be 'co.uk'.

data/lib/name_checker/availability.rb

@@ -1,4 +1,9 @@
 module NameChecker
+  # Container class to represent the availability of a word on
+  # a specific service.
+  #
+  #   Availability.new('twitter', false)
+  #
   class Availability
     attr_reader :status, :service
 

data/lib/name_checker/version.rb

@@ -1,3 +1,3 @@
 module NameChecker
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: name_checker
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70282458980400 !ruby/object:Gem::Requirement
+  requirement: &70291984245360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282458980400
+  version_requirements: *70291984245360
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70282458979800 !ruby/object:Gem::Requirement
+  requirement: &70291984244700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282458979800
+  version_requirements: *70291984244700
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70282458979180 !ruby/object:Gem::Requirement
+  requirement: &70291984244080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282458979180
+  version_requirements: *70291984244080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70282458978600 !ruby/object:Gem::Requirement
+  requirement: &70291984243460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282458978600
+  version_requirements: *70291984243460
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70282458978060 !ruby/object:Gem::Requirement
+  requirement: &70291984242900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70282458978060
+  version_requirements: *70291984242900
 - !ruby/object:Gem::Dependency
   name: whois
-  requirement: &70282458977460 !ruby/object:Gem::Requirement
+  requirement: &70291984242320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70282458977460
+  version_requirements: *70291984242320
 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.