mirage 1.3.6 → 2.0.0.alpha1

data/features/server/logging.feature

@@ -2,6 +2,5 @@ Feature: Output from Mirage is stored in mirage.log.
   This file is located at the root from which mirage is started.
 
   Scenario: response is set.
-    Given I post to 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello |
-    Then mirage.log should contain '/mirage/set/greeting?response=Hello'
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello'
+    Then mirage.log should contain '/mirage/templates/greeting'

data/features/server/peek.feature

@@ -1,25 +1,27 @@
 Feature: If you want to see the content of a particular response without triggering then it can be peeked instead.
   To do this, the responses unique id is required to identify it
+    
 
-
+  #TODO should return headers as well
   Scenario: Peeking a text based response
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/xml' with body '<xml></xml>' and headers:
+      | content-type | text/xml |
 
-    When I hit 'http://localhost:7001/mirage/peek/1'
-    Then 'Hello' should be returned
+    When I send GET to 'http://localhost:7001/mirage/templates/1'
+    Then '<xml></xml>' should be returned
+    And the response 'content-type' should be 'text/xml'
 
 
   Scenario: Peeking a file based response
-    Given I hit 'http://localhost:7001/mirage/set/download' with parameters:
-      | response | README.md |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/some/location/download' with file: README.md and headers:
+      | X-mirage-file | true |
 
-    When I hit 'http://localhost:7001/mirage/peek/1'
-    Then the response should be a file the same as 'README.md'
+    When I send GET to 'http://localhost:7001/mirage/templates/1'
+    Then the response should be the same as the content of 'README.md'
 
 
   Scenario: Peeking a response that does not exist
-    When I hit 'http://localhost:7001/mirage/peek/1'
+    When I send GET to 'http://localhost:7001/mirage/templates/1'
     Then a 404 should be returned
 
 

data/features/server/prime.feature

@@ -17,9 +17,9 @@ Feature: Mirage can be primed with a set of responses.
     end
     """
     And I run 'mirage start'
-    When I hit 'http://localhost:7001/mirage/get/greeting'
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then 'hello' should be returned
-    When I hit 'http://localhost:7001/mirage/get/leaving'
+    When I send GET to 'http://localhost:7001/mirage/responses/leaving'
     Then 'goodbye' should be returned
 
 
@@ -31,7 +31,7 @@ Feature: Mirage can be primed with a set of responses.
     end
     """
     And I run 'mirage start -d ./custom_responses_location'
-    When I hit 'http://localhost:7001/mirage/get/greeting'
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then 'hello' should be returned
 
 
@@ -43,8 +43,8 @@ Feature: Mirage can be primed with a set of responses.
     end
     """
     And I run 'mirage start -d /tmp/responses'
-    When I hit 'http://localhost:7001/mirage/primes'
-    And I hit 'http://localhost:7001/mirage/get/greeting'
+    When I send PUT to 'http://localhost:7001/mirage/defaults'
+    And I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then 'hello' should be returned
 
 
@@ -56,14 +56,16 @@ Feature: Mirage can be primed with a set of responses.
     end
     """
     And I run 'mirage start'
-    And I hit 'http://localhost:7001/mirage/clear'
-    And I hit 'http://localhost:7001/mirage/set/a_new_response' with parameters:
-      | response | new response |
-
-    When I hit 'http://localhost:7001/mirage/prime'
-    When I hit 'http://localhost:7001/mirage/get/greeting'
+    And I send DELETE to 'http://localhost:7001/mirage/templates'
+    And I send PUT to 'http://localhost:7001/mirage/templates/a_new_response' with request entity
+      """
+      new response
+      """
+
+    When I send PUT to 'http://localhost:7001/mirage/defaults'
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then 'hello' should be returned
-    When I hit 'http://localhost:7001/mirage/get/a_new_response'
+    When I send GET to 'http://localhost:7001/mirage/responses/a_new_response'
     Then a 404 should be returned
 
 
@@ -82,7 +84,7 @@ Feature: Mirage can be primed with a set of responses.
     """
     A file with a mistake in it
     """
-    And I hit 'http://localhost:7001/mirage/prime'
+    And I send PUT to 'http://localhost:7001/mirage/defaults'
     Then a 500 should be returned
 
 

data/features/server/response_templates.feature

@@ -7,10 +7,9 @@ Feature: Parts of a response can be substitued for values found in the request b
 
 
   Scenario: A response template populated from matches found in the request body using a regex
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello ${<firstname>(.*?)</firstname>} ${<surname>(.*?)</surname>}, how are you? |
-
-    When I hit 'http://localhost:7001/mirage/get/greeting' with request body:
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello ${<firstname>(.*?)</firstname>} ${<surname>(.*?)</surname>}, how are you?' and headers:
+      | X-mirage-method | POST |
+    When I send POST to 'http://localhost:7001/mirage/responses/greeting' with request entity
     """
     <grettingRequest>
       <firstname>Leon</firstname>
@@ -21,27 +20,21 @@ Feature: Parts of a response can be substitued for values found in the request b
 
 
   Scenario: A response template populated from match found in the query string using a request parameter name
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello ${name}, how are you? |
-
-    When I hit 'http://localhost:7001/mirage/get/greeting' with parameters:
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello ${name}, how are you?'
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting' with parameters:
       | name | Leon |
     Then 'Hello Leon, how are you?' should be returned
 
 
   Scenario: Response template populated from match found in the query string using a regex
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello ${name=([L\|l]eon)}, how are you? |
-
-    When I hit 'http://localhost:7001/mirage/get/greeting' with parameters:
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello ${name=([L\|l]eon)}, how are you?'
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting' with parameters:
       | parameter | value |
       | name      | Leon  |
     Then 'Hello Leon, how are you?' should be returned
 
 
   Scenario: No match is found in either the request body or query string
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello ${<name>(.*?)</name>}, how are you? |
-
-    When  I hit 'http://localhost:7001/mirage/get/greeting'
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello ${<name>(.*?)</name>}, how are you?'
+    When  I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then 'Hello ${<name>(.*?)</name>}, how are you?' should be returned

data/features/server/save_and_revert.feature

@@ -4,22 +4,19 @@ Feature: Having set up the Mirage with a number of defaults, your tests may cont
   Mirage provides the ability to save of its current state and to revert it back to that state.
 
   Background: The MockServer has been setup with some default responses
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | The default greeting |
-
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'The default greeting'
 
+    
   Scenario: Saving Mirage and reverting it
-    Given  I hit 'http://localhost:7001/mirage/save'
-    And I hit 'http://localhost:7001/mirage/set/leaving' with parameters:
-      | response | Goodye |
-
-    And I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Changed |
-
-    And I hit 'http://localhost:7001/mirage/revert'
-
-    When I hit 'http://localhost:7001/mirage/get/leaving'
+    And I send PUT to 'http://localhost:7001/mirage/backup'
+    
+    Given I send PUT to 'http://localhost:7001/mirage/templates/leaving' with body 'Goodbye'
+    And I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Changed'
+    
+    And I send PUT to 'http://localhost:7001/mirage'
+
+    When I send GET to 'http://localhost:7001/mirage/responses/leaving'
     Then a 404 should be returned
 
-    When I hit 'http://localhost:7001/mirage/get/greeting'
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting'
     Then 'The default greeting' should be returned

data/features/server/set.feature

@@ -1,40 +1,67 @@
-Feature: Mirage can be configured with endpoints that when request returned defined responses.
+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:
-  ${mirage_url}/set/your/end/point?response=your_response
+  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)
+  content-type = Set the content type to be returned
 
 
   Scenario: Setting a response without any selection criteria
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello, how are you? |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello'
 
-    When I hit 'http://localhost:7001/mirage/get/greeting'
-    Then 'Hello, how are you?' should be returned
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting'
+    Then 'Hello' should be returned
 
   Scenario: A response hosted on a longer url
-    Given I hit 'http://localhost:7001/mirage/set/say/hello/to/me' with parameters:
-      | response | Hello to me |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/say/hello/to/me' with body 'Hello to me'
 
-    When I hit 'http://localhost:7001/mirage/get/say/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
+    Given I send PUT to 'http://localhost:7001/mirage/templates/say/hello/to/me' with body '<xml></xml>' and headers:
+    |content-type|text/xml|
+
+    When I send GET to 'http://localhost:7001/mirage/responses/say/hello/to/me'
+    Then '<xml></xml>' should be returned
+    And the response 'content-type' should be 'text/xml'
+
 
   Scenario: The same endpoint is set more than once
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello'
     Then '1' should be returned
 
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hi |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hi'
     Then '1' should be returned
 
 
-  Scenario: A response is not supplied
-    Given I hit 'http://localhost:7001/mirage/set/greeting'
-    Then a 500 should be returned
+  Scenario Outline: Response set 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 |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'POST' and headers:
+      | X-mirage-method | POST |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'DELETE' and headers:
+      | X-mirage-method | DELETE |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'PUT' and headers:
+      | X-mirage-method | PUT |
+    When I send <method> to 'http://localhost:7001/mirage/responses/greeting'
+    Then '<method>' should be returned
+  Examples:
+    | method |
+    | GET    |
+    | POST   |
+    | PUT    |
+    | DELETE |
 
 
   Scenario: Getting a response that does not exist
-    When I hit 'http://localhost:7001/mirage/get/response_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

data/features/server/set_default_response.feature

@@ -12,37 +12,31 @@ Feature: Mirage can respond with a 'default' response when a when the response r
   Root responses can cause unexpected behaviour and so in order to qualify as a default reponse a client must knowingly mark it as one.
 
   Scenario: A default response is returned
-    Given I hit 'http://localhost:7001/mirage/set/level0/level1' with parameters:
-      | response | another level |
-    And I hit 'http://localhost:7001/mirage/set/level1' with parameters:
-      | response      | level 1 |
-      | default | true    |
-
-    When I hit 'http://localhost:7001/mirage/get/level1/level2'
+    Given I send PUT to 'http://localhost:7001/mirage/templates/level0/level1' with body 'another level'
+    Given I send PUT to 'http://localhost:7001/mirage/templates/level1' with body 'level 1' and headers:
+      | X-mirage-default | true |
+    
+    When I send GET to 'http://localhost:7001/mirage/responses/level1/level2'
     Then 'level 1' should be returned
 
 
   Scenario: More than one potential default response exists
-    Given I hit 'http://localhost:7001/mirage/set/level1' with parameters:
-      | response      | level 1 |
-      | default | true    |
-    And I hit 'http://localhost:7001/mirage/set/level1/level2' with parameters:
-      | response      | level 2 |
-      | default | true    |
-    And I hit 'http://localhost:7001/mirage/set/level1/level2/level3' with parameters:
-      | response | level 3 |
-    And I hit 'http://localhost:7001/mirage/set/level1/level2/level3/level4' with parameters:
-      | pattern | a pattern that wont be matched |
-    And I hit 'http://localhost:7001/mirage/set/level1/level2/level3/level4/level5' with parameters:
-      | response      | level 5 |
-      | default | true    |
-
-    When I hit 'http://localhost:7001/mirage/get/level1/level2/level3/level4'
+    Given I send PUT to 'http://localhost:7001/mirage/templates/level1' with body 'level 1' and headers:
+      | X-mirage-default | true |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/level1/level2' with body 'level 2' and headers:
+      | X-mirage-default | true |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/level1/level2/level3' with body 'level 3' and headers:
+      | X-mirage-default | false |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/level1/level2/level3/level4' with body 'level 4' and headers:
+      | X-mirage-pattern | a pattern that wont be matched |
+    Given I send PUT to 'http://localhost:7001/mirage/templates/leve11/level2/level3/level4/level5' with body 'level 5' and headers:
+      | X-mirage-default | true |
+
+    When I send GET to 'http://localhost:7001/mirage/responses/level1/level2/level3/level4'
     Then 'level 2' should be returned
 
 
   Scenario: There isnt a default response
-    Given I hit 'http://localhost:7001/mirage/set/level1' with parameters:
-      | response | level 1 |
-    When I hit 'http://localhost:7001/mirage/get/level1/level2'
+    Given I send PUT to 'http://localhost:7001/mirage/templates/level1' with body 'level 1'
+    When I send GET to 'http://localhost:7001/mirage/responses/level1/level2'
     Then a 404 should be returned

data/features/server/set_with_a_delay.feature

@@ -2,9 +2,7 @@ Feature: Its possible introduce a delay before responding to a client with a par
   conditions by making your application wait before receiving a response.
 
   Scenario: Response with a delay
-    Given I hit 'http://localhost:7001/mirage/set/an_appology' with parameters:
-      | response | Sorry it took me so long! |
-      | delay    | 4.2                         |
-
-    When I hit 'http://localhost:7001/mirage/get/an_appology'
+    Given I send PUT to 'http://localhost:7001/mirage/templates/an_appology' with body 'Sorry' and headers:
+    | X-mirage-delay | 4.2 |
+    When I send GET to 'http://localhost:7001/mirage/responses/an_appology'
     Then it should take at least '4.2' seconds

data/features/server/set_with_a_pattern.feature

@@ -4,15 +4,15 @@ Feature: Mirage can be configured to return particular responses conditionally b
   Patterns can be either plain text or a regular expression
 
   Background: There is already a default response for 'greeting'
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello Stranger. |
-
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello Stranger' and headers:
+      | X-mirage-method | POST |
 
   Scenario: A plain text pattern found in the request body
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello Leon, how are you? |
-      | pattern  | <name>leon</name>        |
-    When I hit 'http://localhost:7001/mirage/get/greeting' with request body:
+
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello Leon, how are you?' and headers:
+      | X-mirage-pattern | <name>leon</name> |
+      | X-mirage-method  | POST              |
+    When I send POST to 'http://localhost:7001/mirage/responses/greeting' with request entity
     """
      <greetingRequest>
       <name>leon</name>
@@ -22,11 +22,10 @@ Feature: Mirage can be configured to return particular responses conditionally b
 
 
   Scenario: A regex based pattern found in the request body
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello Leon, how are you? |
-      | pattern  | .*?leon<\/name>          |
-
-    When I hit 'http://localhost:7001/mirage/get/greeting' with request body:
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello Leon, how are you?' and headers:
+      | X-mirage-pattern | .*?leon<\/name> |
+      | X-mirage-method  | POST            |
+    When I send POST to 'http://localhost:7001/mirage/responses/greeting' with request entity
     """
      <greetingRequest>
       <name>leon</name>
@@ -36,37 +35,33 @@ Feature: Mirage can be configured to return particular responses conditionally b
 
 
   Scenario: A plain text pattern found in the query string
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello Leon, how are you? |
-      | pattern  | leon                     |
-
-    When I hit 'http://localhost:7001/mirage/get/greeting' with parameters:
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello Leon, how are you?' and headers:
+      | X-mirage-pattern | leon |
+      | X-mirage-method  | POST |
+    When I send POST to 'http://localhost:7001/mirage/responses/greeting' with parameters:
       | name | leon |
-
     Then 'Hello Leon, how are you?' should be returned
 
 
   Scenario:  A regex based pattern found in the query string
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello Leon, how are you? |
-      | pattern  | name=[L\|l]eon           |
-
-    When I hit 'http://localhost:7001/mirage/get/greeting' with parameters:
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello Leon, how are you?' and headers:
+      | X-mirage-pattern | name=[L\|l]eon |
+      | X-mirage-method  | POST           |
+    When I send POST to 'http://localhost:7001/mirage/responses/greeting' with parameters:
       | name | leon |
 
     Then 'Hello Leon, how are you?' should be returned
 
 
   Scenario: The pattern is not matched
-    Given I hit 'http://localhost:7001/mirage/set/greeting' with parameters:
-      | response | Hello Leon, how are you? |
-      | pattern  | .*?leon<\/name>          |
-
-    When I hit 'http://localhost:7001/mirage/get/greeting' with request body:
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello Leon, how are you?' and headers:
+      | X-mirage-pattern | .*?leon<\/name> |
+      | X-mirage-method  | POST            |
+    When I send POST to 'http://localhost:7001/mirage/responses/greeting' with request entity
     """
      <greetingRequest>
       <name>jim</name>
      </greetingRequest>
     """
 
-    Then 'Hello Stranger.' should be returned
+    Then 'Hello Stranger' should be returned

data/features/server/track_requests.feature

@@ -0,0 +1,71 @@
+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 setting a response, a unique id is returned which can be used to look up the last request made to get that response.
+
+  If the the response is reset then the same id is returned in order to make it easier to keep track of.
+
+  Responses hosted on the same endpoint but with a pattern are considered unique and so get their own ID.
+
+  If the request body contains content this is stored. Otherwise it is the query string that is stored.
+
+  If a response is 'peeked' this does not count as a request that should be stored.
+
+  Background: There is a response already on Mirage
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello' and headers:
+      | X-mirage-method | POST |
+
+
+  Scenario: Tracking a response that was triggered by a request that had content 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: Tracking a response that was triggered by a request with a 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: Tracking a response that has not been served yet
+    Given I send GET to 'http://localhost:7001/mirage/requests/1'
+    Then a 404 should be returned
+
+
+
+  Scenario: A response is peeked at
+    Given I send POST to 'http://localhost:7001/mirage/responses/greeting' with request entity
+    """
+    Hello
+    """
+    And I send GET to 'http://localhost:7001/mirage/templates/1'
+    When I send GET to 'http://localhost:7001/mirage/requests/1'
+    Then 'Hello' should be returned
+
+
+  Scenario: A default response and one for the same endpoint with a pattern are set
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello who ever you are'
+    Then '2' should be returned
+
+    Given I send PUT to 'http://localhost:7001/mirage/templates/greeting' with body 'Hello' and headers:
+      | X-mirage-pattern | Leon |
+    Then '3' should be returned
+
+    When I send GET to 'http://localhost:7001/mirage/responses/greeting' with parameters:
+      | name | Joel |
+    And I send GET to 'http://localhost:7001/mirage/responses/greeting' with parameters:
+      | name | Leon |
+
+    And I send GET to 'http://localhost:7001/mirage/requests/2'
+    Then 'name=Joel' should be returned
+
+    And I send GET to 'http://localhost:7001/mirage/requests/3'
+    Then 'name=Leon' should be returned
+
+