em-whois 0.1.1

data/.rspec

@@ -0,0 +1 @@
+-I.

data/Gemfile

@@ -0,0 +1,8 @@
+source :gemcutter
+
+gem 'em-synchrony'
+gem 'whois', '= 2.5.0'    # Locked to specific version as internals of whois gem are overridden
+
+group :development do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    em-synchrony (1.0.0)
+      eventmachine (>= 1.0.0.beta.1)
+    eventmachine (1.0.0.beta.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    whois (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  em-synchrony
+  rspec
+  whois (= 2.5.0)

data/README.md

@@ -0,0 +1,34 @@
+# em-whois
+
+This is a container for the synchronous WHOIS gem which replaces socket communications
+with the EventMachine equivalent.  The result is a gem permitting asynchronous WHOIS
+lookups.
+
+`em-whois` is EventMachine-aware, meaning that it'll use asynchronous sockets when called
+inside the reactor, and fallback to original sockets outside the reactor context.
+
+
+## Examples
+
+Simple example to grab whois info within the EventMachine loop:
+
+```ruby
+EM.synchrony do  
+  
+  # Async domain availability lookup via WHOIS info
+  whois = Whois.whois(ARGV[0] || "github.com")
+  puts whois.properties[:available?] ? "Domain Available" : "Domain Taken"
+
+  EM.stop
+end
+```
+
+
+## TODO
+
+* More elegant approach to reading from the EM::Synchrony::TcpSocket in Whois::Server::Adapters::Base#ask_the_socket
+
+
+## License & Notes
+
+The MIT License - Copyright (c) 2012 [Mike Jarema](http://mikejarema.com)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 1

data/examples/async_whois.rb

@@ -0,0 +1,24 @@
+$: << File.dirname(__FILE__) + '/../lib'
+require 'em-whois'
+
+# Asynchronous WHOIS lookup -- em-whois should opt to use EM-based TcpSocket
+
+EM.synchrony do  
+  
+  # EM pulse
+  EM.add_periodic_timer(0.1) do
+    STDERR.print "."
+  end
+
+  # Async WHOIS lookup
+  domain = ARGV[0] || "github.com"
+  
+  r = Whois.whois(domain)
+  
+  puts "\r#{domain}\n#{"-" * domain.length}"
+  [:available?, :status, :expires_on].each do |k|
+    puts "#{k}: #{r.properties[k]}"
+  end
+
+  EM.stop
+end

data/examples/sync_whois.rb

@@ -0,0 +1,13 @@
+$: << File.dirname(__FILE__) + '/../lib'
+require 'em-whois'
+
+# Synchronous WHOIS lookup -- em-whois should opt to use original TcpSocket
+
+domain = ARGV[0] || "github.com"
+
+r = Whois.whois(domain)
+
+puts "\r#{domain}\n#{"-" * domain.length}"
+[:available?, :status, :expires_on].each do |k|
+  puts "#{k}: #{r.properties[k]}"
+end

data/lib/em-whois.rb

@@ -0,0 +1,52 @@
+require 'whois'
+require 'em-synchrony'
+
+module Whois
+  class Server
+    module Adapters
+      class Base
+        private
+
+          # This method handles the lowest connection
+          # to the WHOIS server.
+          #
+          # This is for internal use only!
+          #
+          # @api internal
+          
+          alias :orig_ask_the_socket :ask_the_socket
+
+          def ask_the_socket(*args)
+            defined?(EM) && EM.reactor_running? ? em_ask_the_socket(*args) : orig_ask_the_socket(*args)
+          end # ask_the_socket
+
+          def em_ask_the_socket(query, *args)
+            client = EventMachine::Synchrony::TCPSocket.new(*args)
+            client.write("#{query}\r\n")    # I could use put(foo) and forget the \n
+                                            # but write/read is more symmetric than puts/read
+                                            # and I really want to use read instead of gets.
+
+            response = ""
+
+            # Synchrony TCPSocket behaves a little differently, seems to require
+            # polling until an IO exception is thrown.
+            # TODO: There's gotta be a more elegant way to achieve this.
+            while true do
+              begin
+                response += client.read
+              rescue IOError => e
+                break
+              end
+            end
+
+            response
+
+          ensure
+            client.close if client          # If != client something went wrong.
+          
+          end # em_ask_the_socket
+
+      end
+    end
+  end
+end

data/spec/em-whois_spec.rb

@@ -0,0 +1,49 @@
+require "spec/helper/all"
+
+describe "Asynchronous WHOIS" do
+
+  it "should not use synchronous socket methods" do
+    
+    EM.synchrony do
+      Whois::Server::Adapters::Base.any_instance.should_not_receive(:orig_ask_the_socket)
+
+      whois = Whois.whois("google.com")
+      whois.should_not be_available # Sanity check
+
+      whois = Whois.whois("#{rand(Time.now.to_i)}-alskdjflkasjd.com")
+      whois.should be_available # Sanity check
+
+      EM.stop
+    end
+
+  end
+
+  it "should match synchronous WHOIS results" do
+    async_whois = nil
+    sync_whois = nil
+
+    EM.synchrony do
+      async_whois = Whois.whois("github.com")
+      EM.stop
+    end
+
+    sync_whois = Whois.whois("github.com")
+
+    async_whois.properties.should == sync_whois.properties
+  end
+
+end
+
+describe "Synchronous WHOIS" do
+
+  it "should not use asynchronous socket methods" do
+    Whois::Server::Adapters::Base.any_instance.should_not_receive(:em_ask_the_socket)
+
+    whois = Whois.whois("google.com")
+    whois.should_not be_available # Sanity check
+
+    whois = Whois.whois("#{rand(Time.now.to_i)}-alskdjflkasjd.com")
+    whois.should be_available # Sanity check
+  end
+
+end

data/spec/helper/all.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'rspec'
+require 'pp'
+
+require 'lib/em-whois'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: em-whois
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Jarema
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &70096718694400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70096718694400
+- !ruby/object:Gem::Dependency
+  name: whois
+  requirement: &70096718692400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70096718692400
+- !ruby/object:Gem::Dependency
+  name: em-synchrony
+  requirement: &70096718675440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70096718675440
+description: Wrapper around whois gem providing asynchronous WHOIS queries via EventMachine
+email: mike@jarema.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- VERSION.yml
+- README.md
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- examples/async_whois.rb
+- examples/sync_whois.rb
+- lib/em-whois.rb
+- spec/em-whois_spec.rb
+- spec/helper/all.rb
+homepage: http://github.com/mikejarema/em-whois
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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.11
+signing_key: 
+specification_version: 3
+summary: Query WHOIS servers using native EventMachine connection classes.
+test_files: []