mock-server 0.1

data/README.markdown

@@ -0,0 +1,45 @@
+# MockServer #
+
+A quick way of mocking an external web service you want to consume.
+
+## Usage ##
+
+You're writing a feature that needs to connect to an external web service
+(anything served by HTTP). You wonder how to test that. Your options
+are to stub methods in Net::HTTP and equivalents, but by doing that you
+are tying yourself to an implementation detail. The ideal thing to do
+is to lay out an environment where your code can still run, connect to
+a web server, send out requests and get responses back. Enter MockServer.
+
+    class RSSFeedTest < Test::Unit::TestCase
+      extend MockServer::Methods
+
+      mock_server {
+        get "/feed.xml" do
+          <<-EOS
+          <?xml version="1.0"?>
+          <rss version="2.0">
+            <channel>
+              <title>A mock website</title>
+              <link>http://example.com/</link>
+            </channel>
+          </rss>
+          EOS
+        end
+      }
+
+      def test_rss_feed
+        # YourAwesomeComponent should connect to http://localhost:4000.
+        # (you *are* putting those URLs in an environment-aware config file, right?)
+
+        posts = YourAwesomeComponent.load_posts
+
+        assert_equal "A mock website", post.first.channel.title
+      end
+    end
+
+Yes, things happening inside the `mock_server` call are just a regular Sinatra application. w00t!
+
+## License ##
+
+MIT.

data/lib/mock_server.rb

@@ -0,0 +1,65 @@
+require "sinatra/base"
+require "logger"
+
+class MockServer
+  class App < Sinatra::Base
+    use Rack::ShowExceptions
+  end
+
+  def initialize(port = 4000, &block)
+    @port = port
+
+    @app = Class.new(Sinatra::Base)
+    @app.class_eval(&block)
+  end
+
+  def start
+    Thread.new do
+      with_quiet_logger do |logger|
+        Rack::Handler::WEBrick.run(@app, :Port => @port, :Logger => logger, :AccessLog => [])
+      end
+    end
+
+    wait_for_service("0.0.0.0", @port)
+
+    self
+  end
+
+  module Methods
+    def mock_server(*args, &block)
+      @server = MockServer.new(*args, &block).start
+    end
+  end
+
+protected
+  def with_quiet_logger
+    io = File.open("/dev/null", "w")
+    yield(::Logger.new(io))
+  ensure
+    io.close
+  end
+
+  def listening?(host, port)
+    begin
+      socket = TCPSocket.new(host, port)
+      socket.close unless socket.nil?
+      true
+    rescue Errno::ECONNREFUSED,
+      Errno::EBADF,           # Windows
+      Errno::EADDRNOTAVAIL    # Windows
+      false
+    end
+  end
+
+  def wait_for_service(host, port, timeout = 5)
+    start_time = Time.now
+
+    until listening?(host, port)
+      if timeout && (Time.now > (start_time + timeout))
+        raise SocketError.new("Socket did not open within #{timeout} seconds")
+      end
+    end
+
+    true
+  end
+end

data/test/mock_server_test.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "mock_server"))
+
+require "test/unit"
+require "ruby-debug"
+require "open-uri"
+
+class MockServerTest < Test::Unit::TestCase
+  @@server = MockServer.new do
+    get "/" do
+      "Hello"
+    end
+  end
+
+  def setup
+    @@server.start
+  end
+
+  def test_server
+    assert_equal "Hello", open("http://localhost:4000").read
+  end
+end
+
+class MockServerMethodsTest < Test::Unit::TestCase
+  extend MockServer::Methods
+
+  mock_server(4001) {
+    get "/" do
+      "Goodbye"
+    end
+  }
+
+  def test_server
+    assert_equal "Goodbye", open("http://localhost:4001").read
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: mock-server
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Damian Janowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-06 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+- djanowski@dimaion.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mock_server.rb
+- README.markdown
+- test/mock_server_test.rb
+has_rdoc: true
+homepage: http://github.com/djanowski/mock-server
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: A quick way of mocking an external web service you want to consume.
+test_files: []
+