mimic 0.4.1 → 0.4.2

data/CHANGES

@@ -1,3 +1,7 @@
+## 0.4.2
+
+* Remove unnecessary signal traps.
+
 ## 0.4.1
 
 * Fixed bug where stubs wouldn't actually be cleared correctly.

data/README.md

@@ -1,8 +1,6 @@
 # What is Mimic?
 Mimic is a testing tool that lets you set create a fake stand-in for an external web service to be used when writing integration/end-to-end tests for applications or libraries that access these services.
 
-Note: this is still very early in its development; don't let the existence of this README fool you into thinking its ready for prime-time!
-
 ## Why not stub?
 There are already some good tools, like [FakeWeb](http://fakeweb.rubyforge.org/) which let you stub requests at a low-level which is fine for unit and functional tests but when exercising our code through integration or end-to-end tests we want to exercise as much of the stack as possible.
 

data/Rakefile

@@ -27,7 +27,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "mimic"
-  s.version           = "0.4.1"
+  s.version           = "0.4.2"
   s.summary           = "A Ruby gem for faking external web services for testing"
   s.authors           = "Luke Redpath"
   s.email             = "luke@lukeredpath.co.uk"

data/lib/mimic.rb

@@ -18,7 +18,7 @@ module Mimic
 
     host = FakeHost.new(options[:hostname], options[:remote_configuration_path]).tap do |host|
       host.instance_eval(&block) if block_given?
-      Server.instance.serve(host, options[:port], options[:fork])
+      Server.instance.serve(host, options)
     end
     add_host(host)
   end
@@ -44,30 +44,32 @@ module Mimic
       @logger ||= Logger.new(StringIO.new)
     end
 
-    def serve(host_app, port, should_fork)
-      if should_fork
+    def serve(app, options)
+      if options[:fork]
         @thread = Thread.fork do
-          start_service(host_app, port)
+          start_service(app, options)
         end
 
-        wait_for_service(host_app.hostname, port)
-        
+        wait_for_service(app.hostname, options[:port])
+
       else
-        start_service(host_app, port)
+        start_service(app, options)
       end
     end
 
-    def start_service(host_app, port)
-      Rack::Handler::WEBrick.run(host_app.url_map, {
-        :Port       => port,
+    def start_service(app, options)
+      Rack::Handler::WEBrick.run(app.url_map, {
+        :Port       => options[:port],
         :Logger     => logger,
         :AccessLog  => logger,
 
       }) do |server|
         @server = server
 
-        trap("TERM") { @server.shutdown }
-        trap("INT")  { @server.shutdown }
+        old = trap('EXIT') do
+          old.call if old
+          @server.shutdown
+        end
       end
     end
 

data/lib/mimic/api.rb

@@ -31,6 +31,14 @@ module Mimic
       [200, {}, "Cleared stubs: #{response_body}"]
     end
     
+    get "/ping" do
+      [200, {}, "OK"]
+    end
+    
+    get "/debug" do
+      [200, {}, self.host.inspect]
+    end
+    
     private
     
     class APIRequest
@@ -68,7 +76,13 @@ module Mimic
         end
         
         def on(host)
-          host.send(@method.downcase.to_sym, path).returning(body, code, headers)
+          stub = host.send(@method.downcase.to_sym, path).returning(body, code, headers)
+          stub.with_query_parameters(params)
+          stub.echo_request!(echo_format)
+        end
+        
+        def echo_format
+          @data['echo'].to_sym rescue nil
         end
 
         def path
@@ -86,6 +100,10 @@ module Mimic
         def headers
           @data['headers'] || {}
         end
+        
+        def params
+          @data['params'] || {}
+        end
       end
     end
   end

data/lib/mimic/fake_host.rb

@@ -8,6 +8,7 @@ module Mimic
     def initialize(hostname, remote_configuration_path = nil)
       @hostname = hostname
       @remote_configuration_path = remote_configuration_path
+      @imports = []
       clear      
       build_url_map!
     end
@@ -34,7 +35,10 @@ module Mimic
     
     def import(path)
       if File.exists?(path)
+        @imports << path unless @imports.include?(path)
         instance_eval(File.read(path))
+      else
+        raise "Could not locate file for stub import: #{path}"
       end
     end
     
@@ -49,6 +53,10 @@ module Mimic
       @app.not_found do
         [404, {}, ""]
       end
+      @app.helpers do
+        include Helpers
+      end
+      @imports.each { |file| import(file) }
     end
     
     def inspect
@@ -81,11 +89,59 @@ module Mimic
       @url_map = Rack::URLMap.new(routes)
     end
     
+    module Helpers
+      def echo_request!(format)
+        RequestEcho.new(request).response_as(format)
+      end
+    end
+    
+    class RequestEcho
+      def initialize(request)
+        @request = request
+      end
+      
+      def response_as(format)
+        content_type = case format
+        when :json, :plist
+          "application/#{format.to_s.downcase}"
+        else
+          "text/plain"
+        end
+        [200, {"Content-Type" => content_type}, to_s(format)]
+      end
+      
+      def to_s(format)
+        case format
+          when :json
+            to_hash.to_json
+          when :plist
+            to_hash.to_plist
+          when :text
+            to_hash.inspect
+        end
+      end
+      
+      def to_hash
+        {"echo" => {
+          "params" => @request.params,
+          "env"    => env_without_rack_env,
+          "body"   => @request.body.read
+        }}
+      end
+      
+      private
+      
+      def env_without_rack_env
+        Hash[*@request.env.select { |key, value| key !~ /^rack/i }.flatten]
+      end
+    end
+    
     class StubbedRequest
       def initialize(app, method, path)
         @method, @path = method, path
         @code = 200
         @headers = {}
+        @params = {}
         @body = ""
         @app = app
       end
@@ -98,9 +154,43 @@ module Mimic
         end
       end
       
+      def with_query_parameters(params)
+        tap do
+          @params = params
+        end
+      end
+      
+      def echo_request!(format = :json)
+        @echo_request_format = format
+      end
+      
+      def matches?(request)
+        if @params.any?
+          request.params == @params
+        else
+          true
+        end
+      end
+      
+      def matched_response
+        [@code, @headers, @body]
+      end
+      
+      def unmatched_response
+        [404, "", {}]
+      end
+      
+      def response_for_request(request)
+        if @echo_request_format
+          @body = RequestEcho.new(request).to_s(@echo_request_format)
+        end
+        
+        matches?(request) ? matched_response : unmatched_response
+      end
+      
       def build
-        response = [@code, @headers, @body]
-        @app.send(@method.downcase, @path) { response }
+        stub = self
+        @app.send(@method.downcase, @path) { stub.response_for_request(request) }
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mimic
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Luke Redpath
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 +00:00
+date: 2011-04-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency