mirage 3.0.0.alpha.2 → 3.0.0.alpha.3

data/README.md

@@ -17,7 +17,29 @@ Installation
     gem install mirage 
     
 What's New?
------------ 
+-----------
+### 3.0.0 (Currently in alpha)
+------------------------------
+3.0.0 is not out yet but I am going to spend the next few days filling in the what's new section in preparation for its release.
+#### What's new in the Server:
+##### 1: Mirage uses JSON as its communucations medium
+Mirage is now configured using JSON. JSON is also used as the output format for Mirage's other operations.
+##### 2: Full Request Data now tracked
+You can now retrieve all data associated with a request that triggers a response. Previously only the the request body/query string was tracked.
+Now the full request, including HTTP headers are returned when querying '/requests/template_id'
+##### 3. Parameters and body content matchers are now specified seperately
+Now you can specify as many parameter and body matchers as you want. These can be both litteral strings or Regex's
+  
+Previously, it was only possible to specify a single matcher and this would be applied against both the querystring and the request body.
+##### 4. HTTP Header matchers
+You can now also specify matchers against HTTP headers.
+##### 5. More advanced template resolution.
+Templates are now scored to find the most appropriate template when finding a match for a particular request. Previously the first potential match was returned even
+if there was a more appropriate template.
+
+Litteral matchers are worth more in the scoring process than regex based ones for example.
+#### What's new in the Client:
+
 ### 2.4.0
 ---------
 #### What do I get?

data/VERSION

@@ -1 +1 @@
-3.0.0.alpha.2
+3.0.0.alpha.3

data/lib/mirage/client/client.rb

@@ -44,8 +44,8 @@ module Mirage
       self.class.send(:put, @url, :body => "")
     end
 
-    def put endpoint, value, &block
-      templates.put endpoint, value, &block
+    def put *args
+      templates.put *args
     end
 
     def clear

data/lib/mirage/client/template.rb

@@ -2,6 +2,7 @@ require 'ostruct'
 require 'json'
 require 'httparty'
 require 'hashie/mash'
+
 module Mirage
 
   class Template
@@ -23,6 +24,7 @@ module Mirage
         template.delay = response_config.delay
         template.content_type = response_config.content_type
         template.status = response_config.status
+        template.headers = response_config.headers
 
         template.required_parameters = request_config.parameters
         template.required_body_content = request_config.body_content
@@ -37,7 +39,7 @@ module Mirage
 
     format :json
 
-    attr_accessor :content_type, :http_method, :default, :status, :delay, :required_parameters, :required_body_content, :required_headers, :endpoint, :id, :url, :requests_url
+    attr_accessor :content_type, :http_method, :default, :status, :delay, :required_parameters, :required_body_content, :required_headers, :endpoint, :id, :url, :requests_url, :headers
     attr_reader :value
 
 
@@ -52,6 +54,7 @@ module Mirage
       @required_parameters = {}
       @required_headers = {}
       @required_body_content = []
+      @headers = {}
       @default = default_config.default
     end
 
@@ -72,15 +75,15 @@ module Mirage
               :body => Base64.encode64(@value),
               :status => status,
               :default => default,
-              :content_type => content_type
+              :content_type => content_type,
+              :headers => headers
 
           },
           :request => {
               :parameters => encode_regexs(required_parameters),
               :headers => encode_regexs(required_headers),
               :body_content => encode_regexs(required_body_content),
-              :http_method => http_method
-
+              :http_method => http_method,
           },
           :delay => delay
       }.to_json

data/lib/mirage/client/templates.rb

@@ -17,8 +17,15 @@ module Mirage
       @requests.delete_all
     end
 
-    def put endpoint, response
-      template = Mirage::Template.new  "#{@url}/#{endpoint}", response, @default_config
+    def put *args
+      if args.first.is_a?(Template)
+        template = args.first
+        template.endpoint = "#{@url}/#{template.endpoint}"
+      else
+        endpoint, response = args
+        template = Mirage::Template.new  "#{@url}/#{endpoint}", response, @default_config
+        yield template if block_given?
+      end
       yield template if block_given?
       template.create
     end

data/mirage.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mirage"
-  s.version = "3.0.0.alpha.2"
+  s.version = "3.0.0.alpha.3"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leon Davis"]
-  s.date = "2013-04-01"
+  s.date = "2013-04-21"
   s.description = "Mirage aids testing of your applications by hosting mock responses so that your applications do not have to talk to real endpoints. Its accessible via HTTP and has a RESTful interface."
   s.executables = ["mirage"]
   s.extra_rdoc_files = [

data/server/mock_response.rb

@@ -174,6 +174,10 @@ module Mirage
       MockResponse.add self
     end
 
+    def headers
+      @response_spec['headers']
+    end
+
     def default?
       @response_spec["default"]
     end

data/server/server.rb

@@ -136,11 +136,12 @@ module Mirage
         block.call Mirage::Client.new "http://localhost:#{settings.port}/mirage"
       end
 
-      def send_response(response, body='', request={}, query_string='')
-        sleep response.response_spec['delay']
-        content_type(response.response_spec['content_type'])
-        status response.response_spec['status']
-        response.value(body, request, query_string)
+      def send_response(mock_response, body='', request={}, query_string='')
+        sleep mock_response.response_spec['delay']
+        content_type(mock_response.response_spec['content_type'])
+        status mock_response.response_spec['status']
+        headers mock_response.headers
+        mock_response.value(body, request, query_string)
       end
 
       def extract_http_headers(env)

data/spec/client/cli_bridge_spec.rb

@@ -1,68 +1,63 @@
 require 'spec_helper'
 require 'mirage/client'
 
-describe Mirage::CLIBridge do
-
-
-  before :each do
-    @bridge = Object.new
-    @bridge.extend(Mirage::CLIBridge)
+describe CLIBridge do
+  def mapping port
+    {port.to_s => port_pid_mappings[port.to_s]}
   end
 
-  describe 'Windows' do
-
-    include_context :windows
-
-    it 'should find the pids of mirage instances for given ports' do
-
-      tasklist_output = "#{process_string_for_mirage(7001, 18903)}
-      #{process_string_for_mirage(7002, 18904)}
-      #{process_string_for_mirage(7003, 18905)}"
-
-      @bridge.should_receive(:`).with(/tasklist.*/).any_number_of_times.and_return(tasklist_output)
-      @bridge.mirage_process_ids([7001, 7002]).should == {"7001" => "18903", "7002" => "18904"}
-    end
-
-    it 'should find the pids of mirage instances for all ports' do
-      tasklist_output = "#{process_string_for_mirage(7001, 18903)}
-      #{process_string_for_mirage(7002, 18904)}
-      #{process_string_for_mirage(7003, 18905)}"
-
-      @bridge.should_receive(:`).with(/tasklist.*/).any_number_of_times.and_return(tasklist_output)
-      @bridge.mirage_process_ids([:all]).should == {"7001" => "18903", "7002" => "18904", "7003" => "18905"}
-    end
-
-    it 'should kill the given process id' do
-      @bridge.should_receive(:`).with(/taskkill \/F \/T \/PID 18903/)
-      @bridge.kill(18903)
-    end
+  let(:port_pid_mappings) do
+    {"7001" => "18903", "7002" => "18904", "7003" => "18905"}
   end
 
-  describe 'Linux/MacOSX' do
-
-    include_context :linux
-
-    it 'should find the pids of mirage instances for given ports' do
-      ps_aux_output = "#{process_string_for_mirage(7001, 18903)}
-      #{process_string_for_mirage(7002, 18904)}
-      #{process_string_for_mirage(7003, 18905)}"
-
-      IO.should_receive(:popen).with(/ps aux.*/).any_number_of_times.and_return(ps_aux_output)
-      @bridge.mirage_process_ids([7001, 7002]).should == {"7001" => "18903", "7002" => "18904"}
-    end
-
-    it 'should find the pids of mirage instances for all ports' do
-      ps_aux_output = "#{process_string_for_mirage(7001, 18903)}
-      #{process_string_for_mirage(7002, 18904)}
-      #{process_string_for_mirage(7003, 18905)}"
-
-      IO.should_receive(:popen).with(/ps aux.*/).any_number_of_times.and_return(ps_aux_output)
-      @bridge.mirage_process_ids([:all]).should == {"7001" => "18903", "7002" => "18904", "7003" => "18905"}
-    end
+  let(:operating_system) do
+    Hashie::Mash.new({
+                         :windows => {
+                             :kill_string => "taskkill /F /T /PID %d",
+                             :set_ps_cmd_expectation => proc{bridge.should_receive(:`).with(/tasklist.*/).any_number_of_times.and_return(tasklist_output)}
+                         },
+                         :linux => {
+                             :kill_string => "kill -9 %d",
+                             :set_ps_cmd_expectation => proc{IO.should_receive(:popen).with(/ps aux.*/).any_number_of_times.and_return(tasklist_output)}
+                         }
+                     })
+  end
 
-    it 'should kill the given process id' do
-      @bridge.should_receive(:`).with(/kill -9 18903/)
-      @bridge.kill(18903)
+  [:linux,:windows].each do |os_name|
+
+    describe os_name do
+      let(:os){operating_system[os_name]}
+      let!(:bridge) do
+        bridge = Object.new
+        bridge.extend(CLIBridge)
+      end
+
+      include_context os_name do
+
+        let(:tasklist_output) do
+          output = []
+          port_pid_mappings.each do |port, pid|
+            output << process_string_for_mirage(port, pid)
+          end
+          output.join("\n")
+        end
+
+        it 'should find the pids of mirage instances for given ports' do
+          os.set_ps_cmd_expectation.call
+          bridge.mirage_process_ids([7001, 7002]).should == mapping(7001).merge(mapping(7002))
+        end
+
+        it 'should find the pids of mirage instances for all ports' do
+          os.set_ps_cmd_expectation.call
+          bridge.mirage_process_ids([:all]).should == port_pid_mappings
+        end
+
+        it 'should kill the given process id' do
+          bridge.should_receive(:`).with(os.kill_string % 18903)
+          bridge.kill(18903)
+        end
+      end
     end
   end
+
 end

data/spec/client/client_spec.rb

@@ -2,11 +2,7 @@ require 'spec_helper'
 require 'mirage/client'
 
 describe Mirage::Client do
-  Client = Mirage::Client
-  Templates = Mirage::Templates
-  Template = Mirage::Template
-  Requests = Mirage::Requests
-  Request = Mirage::Request
+
 
   before :each do
     @response = mock('response').as_null_object
@@ -66,7 +62,7 @@ describe Mirage::Client do
       mirage.templates(1).should == mock_template
     end
 
-    it 'should put a response on mirage' do
+    it "should put a response on mirage by passing args on to template's put method "  do
       endpoint, value, block = 'greeting', 'hello', Proc.new{}
 
       templates_mock = mock('templates')
@@ -93,10 +89,6 @@ describe Mirage::Client do
     end
   end
 
-  #describe 'stop' do
-  #
-  #end
-
   describe 'save' do
     it 'should save the current template setup of mirage' do
       mirage = Client.new

data/spec/client/request_spec.rb

@@ -1,9 +1,19 @@
 require 'spec_helper'
-require 'mirage/client'
 
+describe Request do
+  let(:request_url) { "url" }
+  let(:trigger_url) { "trigger url" }
 
-describe Mirage::Request do
-  Request = Mirage::Request
+  let(:body) { "body" }
+  let(:parameters) { {"name" => "joe"} }
+  let(:headers) { {"header" => "value"} }
+
+  let(:request_json) do
+    {body: body,
+     headers: headers,
+     parameters: parameters,
+     request_url: trigger_url}
+  end
 
   it 'delete a request' do
     request_url = "url"
@@ -14,21 +24,7 @@ describe Mirage::Request do
   end
 
   it 'should load request data' do
-    request_url = "url"
-    trigger_url = "trigger url"
-
-    body = "body"
-    parameters = {"name" => "joe"}
-    headers = {"header" => "value"}
-
-    request_json = {
-        body: body,
-        headers: headers,
-        parameters: parameters,
-        request_url: trigger_url
-    }
-
-    Request.should_receive(:backedup_get).with(request_url,format: :json).and_return(request_json)
+    Request.should_receive(:backedup_get).with(request_url, format: :json).and_return(request_json)
 
     request = Request.get(request_url)
     request.headers.should == headers
@@ -37,16 +33,4 @@ describe Mirage::Request do
     request.parameters.should == parameters
   end
 
-  it 'should contain parameters' do
-
-  end
-
-  it 'should contain the request body' do
-
-  end
-
-  it 'should contain the triggering url' do
-
-  end
-
 end

data/spec/client/requests_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
-require 'mirage/client'
 
-describe 'Requests' do
+describe Requests do
   it 'should delete all request data' do
     base_url = "base_url"
-    Mirage::Requests.should_receive(:delete).with("#{base_url}/requests")
-    Mirage::Requests.new(base_url).delete_all
+    Requests.should_receive(:delete).with("#{base_url}/requests")
+    Requests.new(base_url).delete_all
   end
 end

data/spec/client/runner_spec.rb

@@ -3,7 +3,6 @@ require 'mirage/client'
 
 
 describe Mirage do
-  Runner = Mirage::Runner
 
   describe 'starting' do
     before(:each) do

data/spec/client/template_configuration_spec.rb

@@ -3,8 +3,8 @@ require 'mirage/client'
 
 
 
-describe Mirage::TemplateConfiguration do
-  TemplateConfiguration = Mirage::TemplateConfiguration
+describe TemplateConfiguration do
+
   it 'should have defaults' do
     configuration = TemplateConfiguration.new
     assert_defaults configuration

data/spec/client/template_spec.rb

@@ -3,8 +3,6 @@ require 'mirage/client'
 
 
 describe Mirage::Template do
-  Template = Mirage::Template
-  Request = Mirage::Request
 
   describe 'get' do
     it 'should load a template given its id' do
@@ -16,6 +14,7 @@ describe Mirage::Template do
       delay = 1.2
       content_type = "application/json"
       status = 201
+      headers = {'header' => 'value'}
 
 
       required_parameters = {"name" => 'joe'}
@@ -33,6 +32,7 @@ describe Mirage::Template do
               delay: delay,
               content_type: content_type,
               status: status,
+              headers: headers
           },
           request: {
               parameters: required_parameters,
@@ -55,6 +55,7 @@ describe Mirage::Template do
       template.delay.should == delay
       template.content_type.should == content_type
       template.status.should == status
+      template.headers.should == headers
 
       template.required_parameters.should  == required_parameters
       template.required_body_content.should == required_body_content
@@ -237,5 +238,12 @@ describe Mirage::Template do
       end
     end
 
+    it 'should set headers' do
+      header, value = 'header', 'value'
+      template = Template.new 'endpoint', value
+      template.headers[header] = value
+      JSON.parse(template.to_json)["response"]["headers"].should == {header => value}
+    end
+
   end
 end

data/spec/client/templates_spec.rb

@@ -2,9 +2,7 @@ require 'spec_helper'
 require 'mirage/client'
 
 describe 'templates' do
-  Templates = Mirage::Templates
-  Requests = Mirage::Requests
-  Template = Mirage::Template
+
 
   describe 'deleting' do
     it 'should delete all templates and associated request data' do
@@ -50,30 +48,60 @@ describe 'templates' do
 
   describe 'putting templates' do
 
+
     endpoint = "greeting"
     value = "hello"
 
-    before :each do
-      @base_url = "base_url"
-      @templates = Templates.new(@base_url)
 
-      @template_mock = mock('template')
-      Template.should_receive(:new).with("#{@base_url}/templates/#{endpoint}", value, @templates.default_config).and_return(@template_mock)
-      @template_mock.should_receive(:create)
-    end
 
+    context 'template as parameter' do
+      before :each do
+        @base_url = "base_url"
+        @templates = Templates.new(@base_url)
+      end
+
+      it 'should take a preconfigured template as a parameter' do
+
+        template = Template.new 'endpoint', 'value'
+        template.should_receive(:create)
+        @templates.put template
+        template.endpoint.should == "#{@base_url}/templates/endpoint"
+      end
 
-    it 'should create a template' do
-      @templates.put(endpoint, value)
+      it 'should accept a block to allow the template to be customised' do
+        block_called = false
+        template = Template.new 'endpoint', 'value'
+        template.should_receive(:create)
+        @templates.put(template) do |the_same_template|
+          block_called = true
+          the_same_template.should == template
+        end
+        block_called.should == true
+      end
     end
 
-    it 'should accept a block to allow the template to be customised' do
-      block_called = false
-      @templates.put(endpoint, value) do |template|
-        block_called = true
-        template.should == @template_mock
+    context 'endpoint and value as parameters' do
+      before :each do
+        @base_url = "base_url"
+        @templates = Templates.new(@base_url)
+
+        @template_mock = mock('template')
+        Template.should_receive(:new).with("#{@base_url}/templates/#{endpoint}", value, @templates.default_config).and_return(@template_mock)
+        @template_mock.should_receive(:create)
+      end
+
+      it 'should create a template' do
+        @templates.put(endpoint, value)
+      end
+
+      it 'should accept a block to allow the template to be customised' do
+        block_called = false
+        @templates.put(endpoint, value) do |template|
+          block_called = true
+          template.should == @template_mock
+        end
+        block_called.should == true
       end
-      block_called.should == true
     end
   end
 end

data/spec/server/mock_response_spec.rb

@@ -67,6 +67,14 @@ describe Mirage::MockResponse do
 
   describe "response values" do
 
+    it 'should return any headers set' do
+      headers = {
+          'header' => 'value'
+      }
+      response_spec = convert_keys_to_strings({:response => {:headers => headers}})
+      MockResponse.new("greeting", response_spec).headers.should == headers
+    end
+
     it 'should return the response value' do
       response_spec = convert_keys_to_strings({:response => {:body => Base64.encode64("hello")}})
       MockResponse.new("greeting", response_spec).value.should == "hello"

data/spec/server/server_spec.rb

@@ -4,10 +4,13 @@ require 'base64'
 
 describe "Mirage Server" do
   include_context :rack_test, :disable_sinatra_error_handling => true
+  before :each do
+    Mirage::MockResponse.delete_all
+  end
+
 
   describe "when adding responses" do
     before :each do
-      Mirage::MockResponse.delete_all
       @mock_response = Mirage::MockResponse.new('endpoint','value')
     end
 
@@ -87,6 +90,12 @@ describe "Mirage Server" do
         put('/mirage/templates/level1/level2', {:response => {:body => Base64.encode64("level2"), :default => true}}.to_json)
         get('/mirage/responses/level1/level2/level3').body.should == "level2"
       end
+
+      it 'should set any headers specified' do
+        headers = {header: 'value'}
+        put('/mirage/templates/greeting', {:response => {headers: headers, :body => ''}}.to_json)
+        get('/mirage/responses/greeting').headers['header'].should == 'value'
+      end
     end
 
     describe 'checking templates' do

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 ROOT_DIR = "#{File.dirname(__FILE__)}/.."
 $LOAD_PATH.unshift "#{ROOT_DIR}/lib"
 $LOAD_PATH.unshift "#{ROOT_DIR}/server"
-
 require 'simplecov' if ENV['coverage']
+require 'mirage/client'
 require 'rspec'
 require 'json'
 require 'base64'
@@ -14,6 +14,7 @@ module JsonHelpers
 end
 
 RSpec.configure do |config|
+  include Mirage
   config.include JsonHelpers
 end
 

data/test.rb

@@ -1,26 +1,27 @@
 require './lib/mirage/client'
 
-Mirage.stop
-client = Mirage.start
+
+mirage = Mirage.start
+
+#mirage.clear
+#mirage.put('some/path/greeting', 'hello') do |response|
+#  response.http_method = :post
+#end
+#
+#template = mirage.put('some/path/greeting', 'hello Michele') do |response|
+#  response.http_method = :post
+#  response.required_parameters['name']='Michele'
+#  response.required_body_content << 'stara'
+#  response.required_headers['Custom-Header']='special'
+#end
+#
+
+
+
 
 
-client.put "greeting", 'hello' do |response|
-  response.http_method = :post
-  response.delay = 1.2
-  response.required_parameters = {:name => 'leon'}
-  response.required_body_content = %w(profile)
-  response.required_headers = {:header => 'value'}
-end
 
 
-client.put "greeting/something/hello", 'hello' do |response|
-  response.http_method = :post
-  response.delay = 1.2
-  response.required_parameters = {:name => 'leon'}
-  response.required_body_content = %w(profile)
-  response.required_headers = {:header => 'value'}
-end
 
-Mirage.stop
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mirage
 version: !ruby/object:Gem::Version
-  version: 3.0.0.alpha.2
+  version: 3.0.0.alpha.3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -340,7 +340,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1338550206661450441
+      hash: -894267295153814806
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: