mimic 0.1.0 → 0.2.0

data/README.md

@@ -8,17 +8,13 @@ There are already some good tools, like [FakeWeb](http://fakeweb.rubyforge.org/)
 
 Mimic aims to make it possible to test your networking code without actually hitting the real services by starting up a real web server and responding to HTTP requests. This lets you test your application against canned responses in an as-close-to-the-real-thing-as-possible way.
 
-Also, because Mimic starts responds to real HTTP requests, it can be used when testing non-Ruby applications too (like an iPhone application).
-
-## How does it work?
-
-Mimic's API is designed to be simple yet expressive. You simply register the host that you want to fake and then register any number of requests and responses. Mimic will then start an HTTP server (using Rack and WEBRick) on the specified port and add an entry to your hosts file (OSX and Linux only) for that host.
+Also, because Mimic responds to real HTTP requests, it can be used when testing non-Ruby applications too.
 
 ## Examples
 
 Registering to a single request stub:
 
-    Mimic.mimic("www.example.com", 10090).get("/some/path").returning("hello world")
+    Mimic.mimic.get("/some/path").returning("hello world")
     
 And the result, using RestClient:
   
@@ -26,18 +22,31 @@ And the result, using RestClient:
   
 Registering multiple request stubs; note that you can stub the same path with different HTTP methods separately.
 
-    Mimic.mimic("www.example.com", 10090) do
+    Mimic.mimic do
       get("/some/path").returning("Hello World", 200)
       get("/some/other/path").returning("Redirecting...", 301, {"Location" => "somewhere else"})
       post("/some/path").returning("Created!", 201)
     end
     
-## Caveats
-
-* Because the server is not started on port 80, you need a way of configuring your application under test to use a different port at runtime.
+You can even use Rack middlewares, e.g. to handle common testing scenarios such as authentication:
+
+    Mimic.mimic do
+      use Rack::Auth::Basic do |user, pass|
+        user == 'theuser' and pass == 'thepass'
+      end
+      
+      get("/some/path")
+    end
+    
+Finally, because Mimic is built on top of Sinatra for the core request handling, you can create your stubbed requests like you would in any Sinatra app:
 
-* Mimic uses the Ghost gem to modify the hosts file and is therefore dependent on support for this gem. In addition, Ghost currently requires sudo privileges to run which means entering your password. I'm happy to hear any suggestions for working around this.
+    Mimic.mimic do
+      get "/some/path" do
+        [200, {}, "hello world"]
+      end
+    end
 
 ## License
 
 As usual, the code is released under the MIT license which is included in the repository.
+

data/Rakefile

@@ -27,7 +27,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "mimic"
-  s.version           = "0.1.0"
+  s.version           = "0.2.0"
   s.summary           = "A Ruby gem for faking external web services for testing"
   s.author            = "Luke Redpath"
   s.email             = "luke@lukeredpath.co.uk"
@@ -43,12 +43,13 @@ spec = Gem::Specification.new do |s|
 
   # If you want to depend on other gems, add them here, along with any
   # relevant versions
-  s.add_dependency("ghost", "~> 0.2.5")
-  s.add_dependency("rack", "~> 1.2.1")
+  s.add_dependency("rack")
+  s.add_dependency("sinatra")
 
   # If your tests use any gems, include them here
   s.add_development_dependency("rspec")
   s.add_development_dependency("cucumber")
+  s.add_development_dependency("mocha")
 end
 
 # This task actually builds the gem. We also regenerate a static

data/lib/mimic.rb

@@ -7,23 +7,17 @@ require 'logger'
 module Mimic
   MIMIC_DEFAULT_PORT = 11988
   
-  def self.mimic(hostname, port = MIMIC_DEFAULT_PORT, &block)
-    FakeHost.new(hostname).tap do |host|
-      registry.register_host(host)
+  def self.mimic(options = {}, &block)
+    options = {:hostname => 'localhost', :port => MIMIC_DEFAULT_PORT}.merge(options)
+    
+    FakeHost.new(options[:hostname]).tap do |host|
       host.instance_eval(&block) if block_given?
-      Server.instance.serve(host, port)
+      Server.instance.serve(host, options[:port])
     end
   end
   
   def self.cleanup!
     Mimic::Server.instance.shutdown
-    registry.unregister_all_hosts
-  end
-
-  private
-  
-  def self.registry
-    @registry ||= Registry.new
   end
 
   class Server
@@ -34,12 +28,11 @@ module Mimic
     end
 
     def serve(host_app, port)
-      webrick_logger = logger
       @thread = Thread.fork do
         Rack::Handler::WEBrick.run(host_app, 
           :Port      => port, 
-          :Logger    => webrick_logger, 
-          :AccessLog => webrick_logger
+          :Logger    => logger, 
+          :AccessLog => logger
           
         ) { |server| @server = server }
       end
@@ -52,24 +45,4 @@ module Mimic
       end
     end
   end
-  
-  class Registry
-    def initialize
-      @hosts = []
-    end
-    
-    def register_host(host)
-      @hosts << host
-      Host.add(host.hostname)
-    end
-    
-    def unregister_host(host)
-      @hosts.delete(host)
-      Host.delete(host.hostname)
-    end
-    
-    def unregister_all_hosts
-      @hosts.each { |host| unregister_host(host) }
-    end
-  end
 end

data/lib/mimic/fake_host.rb

@@ -1,11 +1,17 @@
+require 'sinatra/base'
+
 module Mimic
   class FakeHost
     attr_reader :hostname
     
-    def initialize(hostname, unhandled_response_strategy = NotFoundResponseStrategy.new)
+    def initialize(hostname)
       @hostname = hostname
-      @stubs = {}
-      @unhandled_response_strategy = unhandled_response_strategy
+      @stubs = []
+      @app = Class.new(Sinatra::Base)
+      
+      @app.not_found do
+        [404, {}, ""]
+      end
     end
     
     def get(path)
@@ -29,35 +35,32 @@ module Mimic
     end
     
     def call(env)
-      handler_for_call(env).call(env)
+      @stubs.each(&:build)
+      @app.call(env)
     end
     
-    def terminate
-      Mimic.terminate(@hostname)
+    def method_missing(method, *args, &block)
+      @app.send(method, *args, &block)
     end
     
     private
     
-    def request(method, path)
-      stubbed_request = StubbedRequest.new(method, path)
-      @stubs[stubbed_request.key] = stubbed_request
-    end
-    
-    def handler_for_call(env)
-      (@stubs[request_key(env)] || @unhandled_response_strategy)
-    end
-    
-    def request_key(env)
-      request = Rack::Request.new(env)
-      StubbedRequest.key(request.request_method, request.path)
+    def request(method, path, &block)
+      if block_given?
+        @app.send(method.downcase, path, &block)
+      else
+        @stubs << StubbedRequest.new(@app, method, path)
+        @stubs.last
+      end
     end
     
     class StubbedRequest
-      def initialize(method, path)
+      def initialize(app, method, path)
         @method, @path = method, path
         @code = 200
         @headers = {}
         @body = ""
+        @app = app
       end
       
       def returning(body, code = 200, headers = {})
@@ -68,22 +71,9 @@ module Mimic
         end
       end
       
-      def call(env)
-        [@code, @headers, @body]
-      end
-      
-      def key
-        self.class.key(@method, @path)
-      end
-      
-      def self.key(method, path)
-        "#{method} #{path}"
-      end
-    end
-    
-    class NotFoundResponseStrategy
-      def call(env)
-        [404, {}, ""]
+      def build
+        response = [@code, @headers, @body]
+        @app.send(@method.downcase, @path) { response }
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mimic
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Luke Redpath
@@ -19,35 +19,31 @@ date: 2010-08-19 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ghost
+  name: rack
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 29
+        hash: 3
         segments: 
         - 0
-        - 2
-        - 5
-        version: 0.2.5
+        version: "0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rack
+  name: sinatra
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 29
+        hash: 3
         segments: 
-        - 1
-        - 2
-        - 1
-        version: 1.2.1
+        - 0
+        version: "0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -78,6 +74,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: 
 email: luke@lukeredpath.co.uk
 executables: []