mirage 2.0.0.alpha3 → 2.0.0.alpha4

data/Gemfile

@@ -1,11 +1,10 @@
 source :rubygems
 
-gem 'rack', '~> 1.1.0'
 gem 'sinatra'
 gem 'childprocess', '~> 0.1'
 
 group :development do
-  gem 'rake', '0.9.0'
+  gem 'rake'
   gem 'cucumber'
   gem 'gherkin', '2.3.9'
   gem 'rspec'

data/VERSION

@@ -1 +1 @@
-2.0.0.alpha3
+2.0.0.alpha4

data/bin/mirage

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 $LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../lib")
-require 'mirage'
+require 'mirage/client'
 require 'childprocess'
 include Mirage::Util
 RUBY_CMD = RUBY_PLATFORM == 'java' ? 'jruby' : 'ruby'

data/features/client/clear.feature

@@ -5,7 +5,7 @@ Feature: The client can be used for clearing responses from Mirage
     """
     require 'rubygems'
     require 'rspec'
-    require 'mirage'
+    require 'mirage/client'
     """
     
     And I send PUT to 'http://localhost:7001/mirage/templates/greeting' with request entity

data/features/client/mirage_client.feature

@@ -10,7 +10,7 @@ Feature: Interacting with Mirage is done via HTTP using  REST style URLs and the
     """
     require 'rubygems'
     require 'rspec'
-    require 'mirage'
+    require 'mirage/client'
     """
 
 

data/features/client/{set.feature → put.feature}

@@ -8,14 +8,14 @@ Feature: the Mirage client provides methods for setting responses and loading de
     """
     require 'rubygems'
     require 'rspec'
-    require 'mirage'
+    require 'mirage/client'
     """
 
 
   Scenario: Setting a basic response
     Given I run
     """
-    Mirage::Client.new.set('greeting','hello')
+    Mirage::Client.new.put('greeting','hello')
     """
     When I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then 'hello' should be returned
@@ -23,7 +23,7 @@ Feature: the Mirage client provides methods for setting responses and loading de
   Scenario: Setting the method that a response should be returned on
     Given I run
     """
-    Mirage::Client.new.set('greeting', 'Hello Leon') do |response|
+    Mirage::Client.new.put('greeting', 'Hello Leon') do |response|
       response.method = 'POST'
     end
     """
@@ -36,7 +36,7 @@ Feature: the Mirage client provides methods for setting responses and loading de
   Scenario Outline: Setting a response with a pattern
     Given I run
     """
-    Mirage::Client.new.set('greeting', 'Hello Leon') do |response|
+    Mirage::Client.new.put('greeting', 'Hello Leon') do |response|
       response.method = 'POST'
       response.pattern = <pattern>
     end
@@ -55,11 +55,22 @@ Feature: the Mirage client provides methods for setting responses and loading de
     | /.*?>leon<\\/name>/ |
     | 'leon'              |
 
+  Scenario: setting a response as default
+    Given I run
+    """
+    Mirage::Client.new.put('greeting', 'default greeting') do |response|
+      response.default = true
+    end
+    """
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting/for/joel'
+    Then 'default greeting' should be returned
+
+
 
   Scenario: Setting the content type
     Given I run
     """
-    Mirage::Client.new.set('greeting', '<xml></xml>') do |response|
+    Mirage::Client.new.put('greeting', '<xml></xml>') do |response|
       response.content_type = 'text/xml'
     end
     """
@@ -73,8 +84,8 @@ Feature: the Mirage client provides methods for setting responses and loading de
     When the file 'responses/default_greetings.rb' contains:
     """
     Mirage.prime do |mirage|
-      mirage.set('greeting', 'hello')
-      mirage.set('leaving', 'goodbye')
+      mirage.put('greeting', 'hello')
+      mirage.put('leaving', 'goodbye')
     end
     """
     And I run
@@ -95,7 +106,7 @@ Feature: the Mirage client provides methods for setting responses and loading de
     And I run
     """
     puts Dir.pwd
-    Mirage::Client.new.set('greeting', File.open('scratch/response_file')) do |response|
+    Mirage::Client.new.put('greeting', File.open('scratch/response_file')) do |response|
       response.method = 'POST'
     end
     """
@@ -122,13 +133,11 @@ Feature: the Mirage client provides methods for setting responses and loading de
       e.is_a?(Mirage::InternalServerException).should == true
     end
     """
-#
-#
 
   Scenario: Setting a file as a response
     Given I run
     """
-    Mirage::Client.new.set('download', File.open('README.md'))
+    Mirage::Client.new.put('download', File.open('README.md'))
     """
     When I send GET to 'http://localhost:7001/mirage/responses/download'
     Then the response should be the same as the content of 'README.md'

data/features/client/{track.feature → request.feature}

@@ -5,7 +5,7 @@ Feature: Requests made to the Mirage Server can be tracked using the Mirage clie
     """
     require 'rubygems'
     require 'rspec'
-    require 'mirage'
+    require 'mirage/client'
     """
 
   Scenario: The MockServer returns a response
@@ -18,5 +18,5 @@ Feature: Requests made to the Mirage Server can be tracked using the Mirage clie
       | name | leon  |
     Then I run
     """
-       Mirage::Client.new.track(1).should == 'name=leon'
+       Mirage::Client.new.request(1).should == 'name=leon'
     """

data/features/client/{peek.feature → response.feature}

@@ -5,25 +5,25 @@ Feature: the client can be used for peeking at responses hosted on Mirage.
     """
     require 'rubygems'
     require 'rspec'
-    require 'mirage'
+    require 'mirage/client'
     """
 
-#  Scenario: peeking a response
-#    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello'
-#
-#    When I run
-#    """
-#      Mirage::Client.new.peek(1).should == 'Hello'
-#    """
-#
-#    When I send GET to 'http://localhost:7001/mirage/requests/1'
-#    Then a 404 should be returned
+  Scenario: peeking a response
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello'
+
+    When I run
+    """
+      Mirage::Client.new.response(1).should == 'Hello'
+    """
+
+    When I send GET to 'http://localhost:7001/mirage/requests/1'
+    Then a 404 should be returned
 
   Scenario: getting a response that does not exist
     Given I run
     """
     begin
-      Mirage::Client.new.peek(2).should == 'this should not have happened'
+      Mirage::Client.new.response(2).should == 'this should not have happened'
       fail("Error should have been thrown")
     rescue Exception => e
     puts e

data/features/client/save_and_revert.feature

@@ -6,7 +6,7 @@ Feature: The Mirage client can be used to snaphsot and rollback the Mirage serve
     """
     require 'rubygems'
     require 'rspec'
-    require 'mirage'
+    require 'mirage/client'
     """
     And I send PUT to 'http://localhost:7001/mirage/templates/greeting' with request entity
     """

data/features/server/prime.feature

@@ -12,8 +12,8 @@ Feature: Mirage can be primed with a set of responses.
     Given the file 'responses/default_greetings.rb' contains:
     """
     Mirage.prime do |mirage|
-      mirage.set('greeting', 'hello')
-      mirage.set('leaving', 'goodbye')
+      mirage.put('greeting', 'hello')
+      mirage.put('leaving', 'goodbye')
     end
     """
     And I run 'mirage start'
@@ -27,7 +27,7 @@ Feature: Mirage can be primed with a set of responses.
     Given the file './custom_responses_location/default_greetings.rb' contains:
     """
     Mirage.prime do |mirage|
-      mirage.set('greeting', 'hello')
+      mirage.put('greeting', 'hello')
     end
     """
     And I run 'mirage start -d ./custom_responses_location'
@@ -39,7 +39,7 @@ Feature: Mirage can be primed with a set of responses.
     Given the file '/tmp/responses/default_greetings.rb' contains:
     """
     Mirage.prime do |mirage|
-      mirage.set('greeting', 'hello')
+      mirage.put('greeting', 'hello')
     end
     """
     And I run 'mirage start -d /tmp/responses'
@@ -52,7 +52,7 @@ Feature: Mirage can be primed with a set of responses.
     Given the file 'responses/default_greetings.rb' contains:
     """
     Mirage.prime do |mirage|
-      mirage.set('greeting', 'hello')
+      mirage.put('greeting', 'hello')
     end
     """
     And I run 'mirage start'

data/features/server/requests/delete.feature

@@ -0,0 +1,46 @@
+Feature: Request data can be deleted. 
+
+  Background: The MockServer has already got a response for greeting and leaving on it.
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello'
+    And I send GET to 'http://localhost:7001/mirage/responses/greeting'
+
+    And I send PUT to 'http://localhost:7001/mirage/templates/leaving' with body 'Goodbye'
+    And I send GET to 'http://localhost:7001/mirage/responses/leaving'
+
+    
+  Scenario: Deleting all requests
+    And I send DELETE to 'http://localhost:7001/mirage/requests'
+
+    When I send GET to 'http://localhost:7001/mirage/requests/1'
+    Then a 404 should be returned
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting'
+    Then a 200 should be returned
+    When I send GET to 'http://localhost:7001/mirage/templates/1'
+    Then a 200 should be returned
+
+
+    When I send GET to 'http://localhost:7001/mirage/requests/2'
+    Then a 404 should be returned
+    When I send GET to 'http://localhost:7001/mirage/responses/leaving'
+    Then a 200 should be returned
+    When I send GET to 'http://localhost:7001/mirage/templates/2'
+    Then a 200 should be returned
+
+
+  Scenario: Deleting a stored request for a prticular response
+    And I send DELETE to 'http://localhost:7001/mirage/requests/1'
+
+    When I send GET to 'http://localhost:7001/mirage/requests/1'
+    Then a 404 should be returned
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting'
+    Then a 200 should be returned
+    When I send GET to 'http://localhost:7001/mirage/templates/1'
+    Then a 200 should be returned
+
+
+    When I send GET to 'http://localhost:7001/mirage/requests/2'
+    Then a 200 should be returned
+    When I send GET to 'http://localhost:7001/mirage/responses/leaving'
+    Then a 200 should be returned
+    When I send GET to 'http://localhost:7001/mirage/templates/2'
+    Then a 200 should be returned

data/features/server/requests/get.feature

@@ -0,0 +1,32 @@
+Feature: After a response has been served from Mirage, the content of the request that triggered it can be retrieved. This is useful
+  for testing that the correct information was sent to the endpoint.
+
+  On putting a respons template on to Mirage, a unique id is returned which can be used to look up the last request made to get that response.
+
+  If the request body contains content this is stored. Otherwise it is the query string that is stored.
+
+  Background: A template has already be put on Mirage
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello' and headers:
+      | X-mirage-method | POST |
+
+
+  Scenario: Getting request data when the data was in the body.
+    Given I send POST to 'http://localhost:7001/mirage/responses/greeting' with request entity
+    """
+    Hello Mirage
+    """
+    When I send GET to 'http://localhost:7001/mirage/requests/1'
+    Then 'Hello Mirage' should be returned
+
+
+  Scenario: Getting request data when the data was in the query string.
+    Given I send POST to 'http://localhost:7001/mirage/responses/greeting' with parameters:
+      | surname   | Davis |
+      | firstname | Leon  |
+    When I send GET to 'http://localhost:7001/mirage/requests/1'
+    Then 'surname=Davis&firstname=Leon' should be returned
+
+
+  Scenario: Getting request data for a template that has not been served yet.
+    Given I send GET to 'http://localhost:7001/mirage/requests/1'
+    Then a 404 should be returned

data/features/server/templates/delete.feature

@@ -0,0 +1,47 @@
+Feature: Templates can be deleted, doing so means that the coresponding response is no longer hosted and it 
+  also deletes any associated request data.
+
+
+  Background: The MockServer has already got a response for greeting and leaving on it.
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello'
+    And I send GET to 'http://localhost:7001/mirage/responses/greeting'
+
+    And I send PUT to 'http://localhost:7001/mirage/templates/leaving' with body 'Goodbye'
+    And I send GET to 'http://localhost:7001/mirage/responses/leaving'
+
+
+  Scenario: Deleting all templates
+    Given I send DELETE to 'http://localhost:7001/mirage/templates'
+
+    When I send GET to 'http://localhost:7001/mirage/requests/1'
+    Then a 404 should be returned
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting'
+    Then a 404 should be returned
+    When I send GET to 'http://localhost:7001/mirage/templates/1'
+    Then a 404 should be returned
+
+    When I send GET to 'http://localhost:7001/mirage/requests/2'
+    Then a 404 should be returned
+    When I send GET to 'http://localhost:7001/mirage/responses/leaving'
+    Then a 404 should be returned
+    When I send GET to 'http://localhost:7001/mirage/templates/2'
+    Then a 404 should be returned
+
+
+  Scenario: Deleting a particular template
+    Given I send DELETE to 'http://localhost:7001/mirage/templates/1'
+
+    When I send GET to 'http://localhost:7001/mirage/templates/1'
+    Then a 404 should be returned
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting'
+    Then a 404 should be returned
+    When I send GET to 'http://localhost:7001/mirage/requests/1'
+    Then a 404 should be returned
+
+    When I send GET to 'http://localhost:7001/mirage/requests/2'
+    Then a 200 should be returned
+    When I send GET to 'http://localhost:7001/mirage/responses/leaving'
+    Then a 200 should be returned
+    When I send GET to 'http://localhost:7001/mirage/templates/2'
+    Then a 200 should be returned
+    

data/features/server/{set.feature → templates/put/put.feature}

@@ -1,32 +1,32 @@
-Feature: Mirage can be configured with responses to be returned with the correct end point is hit.
-  On setting a response, a unique id is retuned. This is a key that can be used to manage the response. E.g. clearing or peek at it.
-
-  Usage:
-  HTTP METHOD: PUT -> /mirage/responses/your/response
-  Content type -> application/json
-
-  content:
-  response (mandatatory) = your response
-  pattern (optional) = criteria for when a response should be returned. see set_with_a_pattern.feature
-  delay (optional) = the amount of time in seconds that mirage should wait for before responding (defaults to 0)
-  method (optional) = http method that this response applies to. (defaults to get if not supplied)
-  default (optional) = set whether the reponse can act as a default response, see set_default_response.feature (defaults to false)
+Feature: Mirage can be configured with templates that are returned when addressed from ${mirage_url}/responses
+  On setting a template, a unique id is retuned. This is a key that can be used to manage the template. 
+  
+  Templates can be configured to respond to either, GET, POST, PUT, or DELETE. If you put more than one template to the same address
+  but configure them to respond to different HTTP methods, then they are held as seperate resources and are assigned different ids.
+
+  Templates can have following attributes configured by setting the following HTTP headers:
+  X-mirage-pattern (optional) = criteria for when a response should be returned. see put_with_pattern.feature
+  X-mirage-delay (optional) = the amount of time in seconds that mirage should wait for before responding (defaults to 0)
+  X-mirage-method (optional) = http method that this response applies to. Can be set to GET, POST, PUT or DELETE. Templates are configured to respond to GET requests by default
+  X-mirage-default (optional) = set whether the reponse can act as a default response, see put_as_default.feature (defaults to false)
   content-type (optional) = Set the content type to be returned
 
 
-  Scenario: Setting a response without any selection criteria
+  Scenario: A template without any selection criteria
     Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello'
 
     When I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then 'Hello' should be returned
+    
 
-  Scenario: A response hosted on a longer url
+  Scenario: A template put under a deeper address
     Given I send PUT to 'http://localhost:7001/mirage/templates/say/hello/to/me' with body 'Hello to me'
 
     When I send GET to 'http://localhost:7001/mirage/responses/say/hello/to/me'
     Then 'Hello to me' should be returned
+    
 
-  Scenario: Content type is set
+  Scenario: Setting the content-type header
     Given I send PUT to 'http://localhost:7001/mirage/templates/say/hello/to/me' with body '<xml></xml>' and headers:
     |content-type|text/xml|
 
@@ -35,23 +35,33 @@ Feature: Mirage can be configured with responses to be returned with the correct
     And the response 'content-type' should be 'text/xml'
 
 
-  Scenario: The same endpoint is set more than once
+  Scenario: Putting a template to the same resource
     Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello'
     Then '1' should be returned
 
     Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hi'
     Then '1' should be returned
+    
+    
 
 
-  Scenario Outline: Response set to respond to different http methods
+  Scenario Outline: Templates is configured to respond to different http methods
     Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'GET' and headers:
       | X-mirage-method | GET |
+    And '1' should be returned
+    
     Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'POST' and headers:
       | X-mirage-method | POST |
+    And '2' should be returned
+    
     Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'DELETE' and headers:
       | X-mirage-method | DELETE |
+    And '3' should be returned
+    
     Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'PUT' and headers:
       | X-mirage-method | PUT |
+    And '4' should be returned
+    
     When I send <method> to 'http://localhost:7001/mirage/responses/greeting'
     Then '<method>' should be returned
   Examples:
@@ -62,6 +72,6 @@ Feature: Mirage can be configured with responses to be returned with the correct
     | DELETE |
 
 
-  Scenario: Getting a response that does not exist
+  Scenario: Getting a response for a template resources that does not exist
     When I send GET to 'http://localhost:7001/mirage/responses/response_that_does_not_exist'
     Then a 404 should be returned