em-resolv-replace 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mike Perham
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,32 @@
+= em-resolv-replace
+
+EventMachine-aware DNS lookup for Ruby.
+
+Ruby's stock DNS resolution, by default, blocks the entire Ruby VM from processing while
+the lookup is happening, because it calls out to the native libc resolver code.  A slow 
+DNS server can cause your entire Ruby process to grind to a halt.  Ruby comes with a pure
+Ruby replacement that is not loaded by default:
+
+    require 'resolv'
+    require 'resolv-replace'
+
+'resolv' is the pure Ruby DNS resolver.  'resolv-replace' monkeypatches the various Ruby
+Socket objects to use resolv.  This gem monkeypatches the monkeypatch so that the Socket
+classes will use an EventMachine-aware resolver, em-dns-resolver.
+
+== Usage
+
+Just require em-resolv-replace when initializing your application:
+
+    require 'em-resolv-replace'
+
+The code will use the EM-aware resolver if EventMachine is running.
+
+== Credits
+
+em-dns-resolver.rb is taken from the em-dns project, with a connection bugfix applied by myself,
+and was written by Aman Gupta and Stephan Maka.
+
+== Author
+
+Mike Perham, @mperham, mperham AT gmail.com, http://github.com/mperham

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "em-resolv-replace"
+    gem.summary = %Q{EventMachine-aware DNS lookup for Ruby}
+    gem.email = "mperham@gmail.com"
+    gem.homepage = "http://github.com/mperham/em-resolv-replace"
+    gem.authors = ["Mike Perham"]
+    gem.add_development_dependency "shoulda", ">= 2.10.3"
+    gem.add_development_dependency "mocha", ">= 0.9.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "em-resolv-replace #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/em-dns-resolver.rb

@@ -0,0 +1,162 @@
+require 'eventmachine'
+require 'resolv'
+
+module EventMachine
+  module DnsResolver
+    ##
+    # Global interface
+    ##
+
+    def self.resolve(hostname)
+      Request.new(socket, hostname)
+    end
+
+    def self.socket
+      if defined?(@socket) && @socket.connected?
+        @socket
+      else
+        @socket = DnsSocket.open
+      end
+    end
+
+    def self.nameserver=(ns)
+      @nameserver = ns
+    end
+    def self.nameserver
+      unless defined?(@nameserver)
+        IO::readlines('/etc/resolv.conf').each do |line|
+          if line =~ /^nameserver (.+)$/
+            @nameserver = $1.split(/\s+/).first
+          end
+        end
+      end
+      @nameserver
+    end
+
+    ##
+    # Socket stuff
+    ##
+
+    class RequestIdAlreadyUsed < RuntimeError
+    end
+
+    class DnsSocket < EM::Connection
+      def self.open
+        EM::open_datagram_socket('0.0.0.0', 0, self)
+      end
+      def post_init
+        @requests = {}
+        @connected = true
+        EM.add_periodic_timer(0.1, &method(:tick))
+      end
+      # Periodically called each second to fire request retries
+      def tick
+        @requests.each do |id,req|
+          req.tick
+        end
+      end
+      def register_request(id, req)
+        if @requests.has_key?(id)
+          raise RequestIdAlreadyUsed
+        else
+          @requests[id] = req
+        end
+      end
+      def send_packet(pkt)
+        send_datagram(pkt, nameserver, 53)
+      end
+      def nameserver=(ns)
+        @nameserver = ns
+      end
+      def nameserver
+        @nameserver ||= DnsResolver.nameserver
+      end
+      # Decodes the packet, looks for the request and passes the
+      # response over to the requester
+      def receive_data(data)
+        msg = nil
+        begin
+          msg = Resolv::DNS::Message.decode data
+        rescue
+        else
+          req = @requests[msg.id]
+          if req
+            @requests.delete(msg.id)
+            req.receive_answer(msg)
+          end
+        end
+      end
+      def connected?; @connected; end
+      def unbind
+        @connected = false
+      end
+    end
+
+    ##
+    # Request
+    ##
+
+    class Request
+      include Deferrable
+      attr_accessor :retry_interval
+      attr_accessor :max_tries
+      def initialize(socket, hostname)
+        @socket = socket
+        @hostname = hostname
+        @tries = 0
+        @last_send = Time.at(0)
+        @retry_interval = 3
+        @max_tries = 5
+        EM.next_tick { tick }
+      end
+      def tick
+        # Break early if nothing to do
+        return if @last_send + @retry_interval > Time.now
+
+        if @tries < @max_tries
+          send
+        else
+          fail 'retries exceeded'
+        end
+      end
+      # Called by DnsSocket#receive_data
+      def receive_answer(msg)
+        addrs = []
+        msg.each_answer do |name,ttl,data|
+          if data.kind_of?(Resolv::DNS::Resource::IN::A) ||
+              data.kind_of?(Resolv::DNS::Resource::IN::AAAA)
+            addrs << data.address.to_s
+          end
+        end
+        if addrs.empty?
+          fail "rcode=#{msg.rcode}"
+        else
+          succeed addrs
+        end
+      end
+      private
+      def send
+        @socket.send_packet(packet.encode)
+        @tries += 1
+        @last_send = Time.now
+      end
+      def id
+        begin
+          @id = rand(65535)
+          @socket.register_request(@id, self)
+        rescue RequestIdAlreadyUsed
+          retry
+        end unless defined?(@id)
+
+        @id
+      end
+      def packet
+        msg = Resolv::DNS::Message.new
+        msg.id = id
+        msg.rd = 1
+        msg.add_question @hostname, Resolv::DNS::Resource::IN::A
+        msg
+      end
+    end
+  end
+end

data/lib/em-resolv-replace.rb

@@ -0,0 +1,41 @@
+# Standard libc DNS resolution
+require 'resolv'
+# Override with pure Ruby DNS resolution
+require 'resolv-replace'
+
+require 'em-dns-resolver'
+require 'fiber'
+
+# Now override the override with EM-aware functions
+class Resolv
+  
+  alias :orig_getaddress :getaddress
+  
+  def getaddress(host)
+    EM.reactor_running? ? em_getaddress(host)[0] : orig_getaddress(host)
+  end
+
+  alias :orig_getaddresses :getaddresses
+
+  def getaddresses(host)
+    EM.reactor_running? ? em_getaddress(host) : orig_getaddresses(host)
+  end
+
+  private
+
+  def em_getaddress(host)
+    fiber = Fiber.current
+    df = EM::DnsResolver.resolve(host)
+    df.callback do |a|
+      fiber.resume(a)
+    end
+    df.errback do |*a|
+      fiber.resume(ResolvError.new(a.inspect))
+    end
+    result = Fiber.yield
+    if result.is_a?(StandardError)
+      raise result
+    end
+    result
+  end
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+require 'em-resolv-replace'
+
+class Test::Unit::TestCase
+end

data/test/test_em-resolv-replace.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+class TestEmResolvReplace < Test::Unit::TestCase
+
+  IPv4 = /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/
+
+  should "resolve address without eventmachine" do
+    Resolv.any_instance.expects(:em_getaddress).times(0)
+
+    assert_match IPv4, Resolv.getaddress('www.google.com')
+  end
+  
+  should "resolve address with eventmachine" do
+    Resolv.any_instance.expects(:orig_getaddress).times(0)
+
+    EM.run do
+      Fiber.new do
+        assert_match IPv4, Resolv.getaddress('www.google.com')
+        EM.stop
+      end.resume
+    end
+  end
+
+  should "resolve addresses without eventmachine" do
+    Resolv.any_instance.expects(:em_getaddress).times(0)
+
+    results = Resolv.getaddresses('www.google.com')
+    assert_match IPv4, results.first
+  end
+  
+  should "resolve addresses with eventmachine" do
+    Resolv.any_instance.expects(:orig_getaddresses).times(0)
+
+    EM.run do
+      Fiber.new do
+        results = Resolv.getaddresses('www.google.com')
+        assert_match IPv4, results.first
+        EM.stop
+      end.resume
+    end
+  end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: em-resolv-replace
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Mike Perham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-10 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.10.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+description: 
+email: mperham@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/em-dns-resolver.rb
+- lib/em-resolv-replace.rb
+- test/helper.rb
+- test/test_em-resolv-replace.rb
+has_rdoc: true
+homepage: http://github.com/mperham/em-resolv-replace
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: EventMachine-aware DNS lookup for Ruby
+test_files: 
+- test/helper.rb
+- test/test_em-resolv-replace.rb