docheck 1.0.1 → 1.1.0

data/README.rdoc

@@ -1,5 +1,5 @@
 = Docheck
-  Docheck is a tool to check domain name availability. By default, It will return all available and registered domains.
+  Domain name availability checker. By default, It will return all available and registered domains.
 
 
 == Requirements
@@ -16,17 +16,17 @@
 == Usage
 From the command line:
 
-  docheck google
+  docheck -n google
 
 From the Ruby file or IRB.
 
   require 'rubygems'
   require 'docheck'
 
-  # Docheck only have two methods: print and fetch
-  Docheck.new('github').print
+  # Docheck only have two instance methods: print and fetch
+  Docheck::Application.new('github').print
   # or
-  Docheck.new('github').fetch
+  Docheck::Application.new('github').fetch
 
 
 == Author
@@ -36,4 +36,4 @@ Author:: {Kunto Aji Kristianto}[http://www.railsmine.net/] <kunto.aji.kr@gmail.c
 
 == License
 
-Copyright (c) 2009-2010 Simone Carletti, Whois is released under the MIT license.
+Copyright (c) 2010 Kunto Aji Kristianto, Docheck is released under the MIT license.

data/bin/docheck

@@ -7,4 +7,27 @@ rescue LoadError
   require File.expand_path('../../lib/docheck.rb', __FILE__)
 end
 
-ARGV.size > 0 ? Docheck.new(ARGV.first).print : puts("Usage: docheck yourdomain. Example: docheck google")
+require 'optparse'
+
+begin
+  OptionParser.new do |opts|
+    opts.banner = "Usage: docheck [basename]. Example: docheck google"
+
+    opts.on("-v", "--version", "Show version") do
+      puts "Docheck #{Docheck::VERSION}"
+    end
+
+    opts.on("-n", "--name NAME", "Execute domain name checker") do |name|
+      Docheck::Application.new(name).print
+    end
+
+    opts.on_tail("-h", "--help", "Show help") do
+      puts opts
+      exit
+    end
+  end.parse!
+rescue OptionParser::InvalidOption
+  puts "Invalid option"
+rescue OptionParser::MissingArgument
+  puts "Missing argument"
+end

data/docheck.gemspec

@@ -1,14 +1,17 @@
+require File.expand_path('../version.rb', __FILE__)
+
 Gem::Specification.new do |spec|
   spec.authors = 'Kunto Aji Kristianto'
   spec.add_dependency('whois', '~> 1.3.8')
+  spec.add_development_dependency('shoulda')
   spec.description = <<-EOF
-    Docheck is domain name availability checker.
+    Domain name availability checker.
   EOF
   spec.email = 'kunto.aji.kr@gmail.com'
   spec.executables << 'docheck'
-  spec.extra_rdoc_files = ['README.rdoc', 'LICENSE', 'VERSION']
+  spec.extra_rdoc_files = ['README.rdoc', 'LICENSE']
   spec.files = ['.gitignore', 'docheck.gemspec', 'LICENSE',
-    'README.rdoc', 'VERSION', 'bin/docheck', 'lib/docheck.rb',
+    'README.rdoc', 'version.rb', 'bin/docheck', 'lib/docheck.rb',
     'test/docheck_test.rb', 'test/helper.rb']
   spec.has_rdoc = true
   spec.homepage = 'http://github.com/kuntoaji/docheck'
@@ -18,5 +21,5 @@ Gem::Specification.new do |spec|
   spec.requirements << 'ruby-whois, v1.3.8 or greater'
   spec.summary = 'Domain name availability checker.'
   spec.test_files = ['test/docheck_test.rb', 'test/helper.rb'] 
-  spec.version = '1.0.1'
+  spec.version = Docheck::VERSION
 end

data/lib/docheck.rb

@@ -4,66 +4,67 @@
 # Copyright:: Copyright (c) 2010 Kunto Aji Kristianto
 # License::   Distributes under MIT license
 
+require File.expand_path('../../version.rb', __FILE__)
 require 'whois'
 
-class Docheck
+module Docheck
+  class Application
 
-  # DNS name of the generic top-level domain
-  TLD = %w{aero asia biz cat com coop edu gov info
-  int jobs mil mobi museum name net org pro tel travel}
+    # DNS name of the generic top-level domain
+    # http://en.wikipedia.org/wiki/List_of_Internet_top-level_domains
+    TLD = %w[aero asia biz cat com coop edu gov info
+    int jobs mil mobi museum name net org pro tel travel]
 
-  # Public instance method to return available domains or
-  # registered domains
-  attr_reader :available_domains, :registered_domains
+    attr_reader :available_domains, :registered_domains
 
-  # base_name is sld (Second Level Domain) and
-  # converted to lower case.
-  def initialize(base_name)
-    @base_name = base_name.downcase
-    @available_domains = []
-    @registered_domains = []
-  end
+    # base_name is sld (Second Level Domain) and
+    # converted to lower case.
+    def initialize(base_name)
+      @base_name = base_name.to_s.downcase
+      @available_domains = []
+      @registered_domains = []
+    end
 
-  # Print the result to STDOUT.
-  # Used by docheck executable.
-  def print
-    result = fetch
-    
-    puts "\nDocheck Result\n"
-    puts "--------------\n"
-    puts "Available Domains:"
-    result.first.map{|domain_name| puts "- #{domain_name}"}
-    puts "\n"
-    puts "Registered Domains:"
-    result.last.map{|domain_name| puts "- #{domain_name}"}
-  end
+    # Print the fetch result.
+    def print
+      result = fetch
+      
+      puts "\nDocheck Result\n"
+      puts "--------------\n"
+      puts "Available Domains:"
+      result.first.map{|domain_name| puts "- #{domain_name}"}
+      puts "\n"
+      puts "Registered Domains:"
+      result.last.map{|domain_name| puts "- #{domain_name}"}
+    end
 
-  # Responsible to check domain's availability
-  # and return the result as array. 
-  #
-  # The first element of array will return all
-  # available domains as array.
-  #
-  # The last element of array will return all
-  # registered domains as array.
-  def fetch
-    TLD.each do |tld|
-      domain_name = "#{@base_name}.#{tld}"
-      begin
-        whois_domain = Whois.whois(domain_name)
+    # Check domain name availability
+    # and return the result as array. 
+    #
+    # The first element of array will return all
+    # available domains as array.
+    #
+    # The last element of array will return all
+    # registered domains as array.
+    def fetch
+      TLD.each do |tld|
+        domain_name = "#{@base_name}.#{tld}"
+        begin
+          whois_domain = Whois.whois(domain_name)
 
-        if whois_domain.available?
-          @available_domains << domain_name
-        elsif whois_domain.registered?
-          @registered_domains << domain_name
+          if whois_domain.available?
+            @available_domains << domain_name
+          elsif whois_domain.registered?
+            @registered_domains << domain_name
+          end
+        rescue Timeout::Error
+          next
+        rescue
+          next
         end
-      rescue Timeout::Error
-        next
-      rescue
-        next
       end
-    end
 
-    return [@available_domains, @registered_domains]
+      return [@available_domains, @registered_domains]
+    end
   end
 end

data/test/docheck_test.rb

@@ -7,19 +7,46 @@ class TestDocheck < Test::Unit::TestCase
     end
   end
 
+  context "Docheck command" do
+    setup do
+      @docheck_bin = File.expand_path("../../bin/docheck", __FILE__)
+    end
+
+    should "shows version" do
+      assert_equal "Docheck #{Docheck::VERSION}\n", `ruby #{@docheck_bin} -v`
+      assert_equal "Docheck #{Docheck::VERSION}\n", `ruby #{@docheck_bin} --version`
+    end
+
+    should "executes domain name checker correctly" do
+      assert `ruby #{@docheck_bin} -n railsmine`
+      assert `ruby #{@docheck_bin} --name railsmine`
+    end
+
+    should "prints 'Invalid option'" do
+      assert_equal "Invalid option\n", `ruby #{@docheck_bin} -f`
+      assert_equal "Invalid option\n", `ruby #{@docheck_bin} --foo`
+      assert_equal "Invalid option\n", `ruby #{@docheck_bin} --foo bar`
+    end
+
+    should "prints 'Missing argument'" do
+      assert_equal "Missing argument\n", `ruby #{@docheck_bin} -n`
+      assert_equal "Missing argument\n", `ruby #{@docheck_bin} --name`
+    end
+  end
+
   context "A Docheck instance" do
     setup do
-      @docheck = Docheck.new('railsmine')
+      @docheck = Docheck::Application.new('railsmine')
     end
 
-    should "respond to all its public instance method" do
+    should "responds to all its public instance method" do
       assert @docheck.respond_to?(:fetch)
       assert @docheck.respond_to?(:print)
       assert @docheck.respond_to?(:available_domains)
       assert @docheck.respond_to?(:registered_domains)
     end
 
-    should "return all availability and registered domain" do
+    should "returns all availability and registered domain" do
       result = @docheck.fetch
       assert result.is_a?(Array)
       assert result.first.is_a?(Array)
@@ -31,7 +58,7 @@ class TestDocheck < Test::Unit::TestCase
       assert_not_nil result
     end
 
-    should "run #print successfully" do
+    should "runs #print successfully" do
       assert @docheck.print 
     end
   end

data/version.rb

@@ -0,0 +1,3 @@
+module Docheck
+  VERSION = '1.1.0'
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: docheck
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Kunto Aji Kristianto
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-14 00:00:00 +07:00
+date: 2010-11-17 00:00:00 +07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,21 @@ dependencies:
         version: 1.3.8
   type: :runtime
   version_requirements: *id001
-description: "    Docheck is domain name availability checker.\n"
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: "    Domain name availability checker.\n"
 email: kunto.aji.kr@gmail.com
 executables: 
 - docheck
@@ -43,13 +57,12 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 - LICENSE
-- VERSION
 files: 
 - .gitignore
 - docheck.gemspec
 - LICENSE
 - README.rdoc
-- VERSION
+- version.rb
 - bin/docheck
 - lib/docheck.rb
 - test/docheck_test.rb

data/VERSION

@@ -1 +0,0 @@
-1.0.1