mimic 0.3.0 → 0.4.0

data/CHANGES

@@ -0,0 +1,19 @@
+## 0.4.0
+
+* Mimic can now be run in it's own process and configured externally using a REST API.
+* Mimic can be run using the Daemons gem safely (pass :fork => false to disable built-in forking).
+* All existing stubs can be cleared.
+
+## 0.3.0
+
+* All verb methods (get, post etc.) can take blocks
+
+## 0.2.0
+
+* Added support for using Rack middleware
+* Removed host file modification feature
+* Refactor code top build on top of Sinatra::Base
+
+## 0.1.0
+
+* Initial release

data/README.md

@@ -18,7 +18,7 @@ Registering to a single request stub:
     
 And the result, using RestClient:
   
-    $ RestClient.get("http://www.example.com:10090/some/path") # => 200 | hello world
+    $ RestClient.get("http://www.example.com:11988/some/path") # => 200 | hello world
   
 Registering multiple request stubs; note that you can stub the same path with different HTTP methods separately.
 
@@ -46,6 +46,37 @@ Finally, because Mimic is built on top of Sinatra for the core request handling,
       end
     end
 
+## Using Mimic with non-Ruby processes
+
+Mimic has a built-in REST API that lets you configure your request stubs over HTTP. This makes it possible to use Mimic from other processes that can perform HTTP requests.
+
+First of all, you'll need to run Mimic as a daemon. You can do this with a simple Ruby script:
+
+    #!/usr/bin/env ruby
+    Mimic.daemonize({:port => 11988, :remote_configuration_path => '/api'})
+    
+Give the script executable permissions and then start it:
+
+    $ your_mimic_script.rb start (or run)
+    
+The remote configuration path is where the API endpoints will be mounted - this is configurable as you will not be able this path or any paths below it in your stubs, so choose one that doesn't conflict with the paths you need to stub.
+
+The API supports both JSON and Plist payloads, defaulting to JSON. Set the request Content-Type header to application/plist for Plist requests.
+
+For the following Mimic configuration (using the Ruby DSL):
+
+    Mimic.mimic.get("/some/path").returning("hello world")
+    
+The equivalent stub can be configured using the REST API as follows:
+
+    $ curl -d'{"path":"/some/path", "body":"hello world"}' http://localhost:11988/api/get
+    
+Likewise, a POST request to the same path could be stubbed like so:
+
+    $ curl -d'{"path":"/some/path", "body":"hello world"}' http://localhost:11988/api/post
+
+The end-point of the API is the HTTP verb you are stubbing, the path, response body, code and headers are specified in the POST data (a hash in JSON or Plist format). See the HTTP API Cucumber features for more examples.
+
 ## Contributors
 
 * [James Fairbairn](http://github.com/jfairbairn)

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'cucumber'
 require 'cucumber/rake/task'
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
 
 desc "Run all Cucumber features"
 Cucumber::Rake::Task.new(:features) do |t|
@@ -9,12 +9,11 @@ Cucumber::Rake::Task.new(:features) do |t|
 end
 
 desc "Run all specs"
-Spec::Rake::SpecTask.new('specs') do |t|
-  t.spec_files = FileList['spec/**/*.rb']
+RSpec::Core::RakeTask.new(:spec) do |t|
 end
 
-task :default => :specs
-task :all => [:specs, :features]
+task :default => :spec
+task :all => [:spec, :features]
 
 require "rake/gempackagetask"
 require "rake/rdoctask"
@@ -28,7 +27,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "mimic"
-  s.version           = "0.3.0"
+  s.version           = "0.4.0"
   s.summary           = "A Ruby gem for faking external web services for testing"
   s.authors           = "Luke Redpath"
   s.email             = "luke@lukeredpath.co.uk"
@@ -39,18 +38,21 @@ spec = Gem::Specification.new do |s|
   s.rdoc_options      = %w(--main README.md)
 
   # Add any extra files to include in the gem
-  s.files             = %w(LICENSE Rakefile README.md) + Dir.glob("{spec,lib/**/*}")
+  s.files             = %w(LICENSE CHANGES Rakefile README.md) + Dir.glob("{spec,lib/**/*}")
   s.require_paths     = ["lib"]
 
   # If you want to depend on other gems, add them here, along with any
   # relevant versions
   s.add_dependency("rack")
   s.add_dependency("sinatra")
+  s.add_dependency("json")
+  s.add_dependency("plist")
 
   # If your tests use any gems, include them here
-  s.add_development_dependency("rspec")
+  s.add_development_dependency("rspec", "~> 2.4.0")
   s.add_development_dependency("cucumber")
   s.add_development_dependency("mocha")
+  s.add_development_dependency("rest-client")
 end
 
 # This task actually builds the gem. We also regenerate a static
@@ -85,6 +87,11 @@ task :clean => [:clobber_rdoc, :clobber_package] do
 end
 
 task 'Release if all specs pass'
-task :release => [:specs, :features, :package] do
+task :release => [:clean, :bundle, :spec, :features, :package] do
   system("gem push pkg/#{spec.name}-#{spec.version}.gem")
 end
+
+desc 'Install all gem dependencies'
+task :bundle => :gemspec do
+  system("bundle")
+end

data/lib/mimic.rb

@@ -5,19 +5,37 @@ require 'logger'
 
 module Mimic
   MIMIC_DEFAULT_PORT = 11988
-  
+
+  MIMIC_DEFAULT_OPTIONS = {
+    :hostname => 'localhost',
+    :port => MIMIC_DEFAULT_PORT,
+    :remote_configuration_path => nil,
+    :fork => true
+  }
+
   def self.mimic(options = {}, &block)
-    options = {:hostname => 'localhost', :port => MIMIC_DEFAULT_PORT}.merge(options)
-    
-    FakeHost.new(options[:hostname]).tap do |host|
+    options = MIMIC_DEFAULT_OPTIONS.merge(options)
+
+    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])
+      Server.instance.serve(host, options[:port], options[:fork])
     end
+    add_host(host)
   end
-  
+
   def self.cleanup!
     Mimic::Server.instance.shutdown
   end
+  
+  def self.reset_all!
+    @hosts.each { |h| h.clear }
+  end
+  
+  private
+  
+  def self.add_host(host)
+    host.tap { |h| (@hosts ||= []) << h }
+  end
 
   class Server
     include Singleton
@@ -26,28 +44,40 @@ module Mimic
       @logger ||= Logger.new(StringIO.new)
     end
 
-    def serve(host_app, port)
-      @thread = Thread.fork do
-        Rack::Handler::WEBrick.run(host_app, 
-          :Port      => port, 
-          :Logger    => logger, 
-          :AccessLog => logger
-          
-        ) { |server| @server = server }
+    def serve(host_app, port, should_fork)
+      if should_fork
+        @thread = Thread.fork do
+          start_service(host_app, port)
+        end
+
+        wait_for_service(host_app.hostname, port)
+        
+      else
+        start_service(host_app, port)
       end
-      
-      wait_for_service(host_app.hostname, port)
     end
-    
-    def shutdown
-      if @thread
-        Thread.kill(@thread) 
-        @server.shutdown
+
+    def start_service(host_app, port)
+      Rack::Handler::WEBrick.run(host_app.url_map, {
+        :Port       => port,
+        :Logger     => logger,
+        :AccessLog  => logger,
+
+      }) do |server|
+        @server = server
+
+        trap("TERM") { @server.shutdown }
+        trap("INT")  { @server.shutdown }
       end
     end
-    
+
+    def shutdown
+      Thread.kill(@thread) if @thread
+      @server.shutdown if @server
+    end
+
     # courtesy of http://is.gd/eoYho
-    
+
     def listening?(host, port)
       begin
         socket = TCPSocket.new(host, port)

data/lib/mimic/api.rb

@@ -0,0 +1,91 @@
+require 'json'
+require 'plist'
+
+module Mimic
+  class API < Sinatra::Base
+    class << self
+      attr_accessor :host
+    end
+    
+    def host
+      self.class.host
+    end
+    
+    %w{get post put delete head}.each do |verb|
+      post "/#{verb}" do
+        api_request = APIRequest.from_request(request, verb)
+        api_request.setup_stubs_on(host)
+        [201, {}, api_request.to_s]
+      end
+    end
+    
+    post "/multi" do
+      api_request = APIRequest.from_request(request)
+      api_request.setup_stubs_on(host)
+      [201, {}, api_request.to_s]
+    end
+    
+    post "/clear" do
+      self.host.clear
+      [200, {}, ""]
+    end
+    
+    private
+    
+    class APIRequest
+      def initialize(data, method = nil)
+        @data = data
+        @method = (method || "GET")
+      end
+      
+      def to_s
+        @data.inspect
+      end
+      
+      def self.from_request(request, method = nil)
+        case request.content_type
+          when /json/
+            data = JSON.parse(request.body.string)
+          when /plist/
+            data = Plist.parse_xml(request.body.string)
+          else
+            data = JSON.parse(request.body.string)
+        end
+        new(data, method)
+      end
+      
+      def setup_stubs_on(host)
+        (@data["stubs"] || [@data]).each do |stub_data|
+          Stub.new(stub_data, stub_data['method'] || @method).on(host)
+        end
+      end
+      
+      class Stub
+        def initialize(data, method = nil)
+          @data = data
+          @method = method
+        end
+        
+        def on(host)
+          host.send(@method.downcase.to_sym, path).returning(body, code, headers)
+        end
+
+        def path
+          @data['path'] || '/'
+        end
+
+        def body
+          @data['body'] || ''
+        end
+
+        def code
+          @data['code'] || 200
+        end
+
+        def headers
+          @data['headers'] || {}
+        end
+      end
+    end
+  end
+end

data/lib/mimic/fake_host.rb

@@ -1,17 +1,21 @@
 require 'sinatra/base'
+require 'mimic/api'
 
 module Mimic
   class FakeHost
-    attr_reader :hostname
+    attr_reader :hostname, :url_map
     
-    def initialize(hostname)
+    def initialize(hostname, remote_configuration_path = nil)
       @hostname = hostname
       @stubs = []
       @app = Class.new(Sinatra::Base)
-      
+      @remote_configuration_path = remote_configuration_path
+
       @app.not_found do
         [404, {}, ""]
       end
+      
+      build_url_map!
     end
     
     def get(path, &block)
@@ -34,17 +38,27 @@ module Mimic
       request("HEAD", path, &block)
     end
     
+    def import(path)
+      if File.exists?(path)
+        instance_eval(File.read(path))
+      end
+    end
+    
     def call(env)
       @stubs.each(&:build)
       @app.call(env)
     end
     
-    def method_missing(method, *args, &block)
-      @app.send(method, *args, &block)
+    def clear
+      @stubs.clear
     end
     
     private
     
+    def method_missing(method, *args, &block)
+      @app.send(method, *args, &block)
+    end
+    
     def request(method, path, &block)
       if block_given?
         @app.send(method.downcase, path, &block)
@@ -54,6 +68,17 @@ module Mimic
       end
     end
     
+    def build_url_map!
+      routes = {'/' => self}
+      
+      if @remote_configuration_path
+        API.host = self
+        routes[@remote_configuration_path] = API
+      end
+
+      @url_map = Rack::URLMap.new(routes)
+    end
+    
     class StubbedRequest
       def initialize(app, method, path)
         @method, @path = method, path

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mimic
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Luke Redpath
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-20 00:00:00 +01:00
+date: 2011-01-13 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: json
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -58,10 +58,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: cucumber
+  name: plist
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -72,12 +72,28 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: rspec
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -87,7 +103,35 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
 description: 
 email: luke@lukeredpath.co.uk
 executables: []
@@ -98,8 +142,10 @@ extra_rdoc_files:
 - README.md
 files: 
 - LICENSE
+- CHANGES
 - Rakefile
 - README.md
+- lib/mimic/api.rb
 - lib/mimic/fake_host.rb
 - lib/mimic.rb
 has_rdoc: true
@@ -133,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: A Ruby gem for faking external web services for testing