mirage-on-thin 3.0.8

data/features/client/clear.feature

@@ -0,0 +1,78 @@
+Feature: Clearing Templates
+
+  The client can be used to clear responses and tracked request data from Mirage.
+
+  Like when calling Mirage's own interface directly, clearing a template also clears any associated request data
+
+  Background:
+    Given the following require statements are needed:
+    """
+    require 'rubygems'
+    require 'mirage/client'
+    """
+
+    And a template for 'greeting' has been set with a value of 'Hello'
+
+    And I send GET to '/responses/greeting' with parameters:
+      | message | hello there |
+    And a template for 'leaving' has been set with a value of 'Goodbye'
+
+    And I send GET to '/responses/greeting' with parameters:
+      | message | I'm going |
+
+
+  Scenario: Clearing a template
+    Given I run
+    """
+    Mirage::Client.new.templates(1).delete
+    """
+    When GET is sent to '/responses/greeting'
+    Then a 404 should be returned
+    When GET is sent to '/requests/1'
+    Then a 404 should be returned
+
+    When GET is sent to '/responses/leaving'
+    Then a 200 should be returned
+    When GET is sent to '/requests/2'
+    Then a 200 should be returned
+
+
+  Scenario: Clearing a request
+    Given I run
+    """
+    Mirage::Client.new.requests(1).delete
+    """
+    When GET is sent to '/requests/1'
+    Then a 404 should be returned
+    When GET is sent to '/responses/greeting'
+    Then a 200 should be returned
+
+
+  Scenario: Clearing everything
+    When I run
+    """
+    Mirage::Client.new.templates.delete_all
+    """
+    And GET is sent to '/responses/greeting'
+    Then a 404 should be returned
+
+    When GET is sent to '/requests/1'
+    Then a 404 should be returned
+
+    And GET is sent to '/responses/leaving'
+    Then a 404 should be returned
+
+    When GET is sent to '/requests/2'
+    Then a 404 should be returned
+
+
+  Scenario: Clearing all request data
+    When I run
+    """
+    Mirage::Client.new.requests.delete_all
+    """
+    When GET is sent to '/requests/1'
+    Then a 404 should be returned
+
+    When GET is sent to '/requests/2'
+    Then a 404 should be returned

data/features/client/configure.feature

@@ -0,0 +1,72 @@
+Feature: Configuring Templates
+
+  If you find yourself setting the same basic http settings for templates, the client can be configured to preset these.
+
+  Background:
+    Given the following require statements are needed:
+    """
+    require 'rubygems'
+    require 'rspec/expectations'
+    require 'mirage/client'
+    """
+
+  Scenario: configuring the client on instance
+    Given I run
+    """
+    client = Mirage::Client.new do
+      http_method :post
+      status 202
+      default true
+      delay 2
+      content_type "text/xml"
+    end
+
+    client.put('greeting','hello')
+    """
+    When POST is sent to '/responses/greeting/for/someone'
+    Then 'hello' should be returned
+    And a 202 should be returned
+    Then it should take at least '2' seconds
+    And the response 'content-type' should be 'text/xml'
+
+  Scenario: Configuring a client after it has been created
+    Given I run
+    """
+    client = Mirage::Client.new
+    client.configure do
+      http_method :post
+      status 202
+      default false
+      delay 2
+      content_type "text/xml"
+    end
+
+    client.put('greeting','hello')
+    """
+    When POST is sent to '/responses/greeting'
+    Then 'hello' should be returned
+    And a 202 should be returned
+    Then it should take at least '2' seconds
+    And the response 'content-type' should be 'text/xml'
+
+  Scenario: resetting defaults
+    Given I run
+    """
+    client = Mirage::Client.new
+    client.configure do
+      http_method :post
+      status 202
+      default true
+      delay 2
+      content_type "text/xml"
+    end
+
+    client.reset
+    client.put('greeting','hello')
+    """
+    When GET is sent to '/responses/greeting'
+    Then 'hello' should be returned
+
+
+
+

data/features/client/model.feature

@@ -0,0 +1,95 @@
+Feature: Template Models
+
+  Use Models to for an object oriented approach to defining Templates.
+
+  The Mirage client provides the Mirage::Template::Model module that can be used to define your own model classes.
+
+  Having extended this module you must provide a 'body' method to customise the body of the response
+
+  The Model module provides class level methods for:
+
+  * Defaulting characteristics such as HTTP status code and Content-type
+
+  * Defining instance level methods that can set and get values.
+
+  Instances of classes that extend this module will also have all of the standard methods of a Mirage Template and hence you can also set your request requirements directly on them too.
+
+  Any defaults set using methods provided  can be overridden after instances are created and when the client is used to add them as Templates to Mirage. See below for examples.
+
+
+  Background:
+    Given the following require statements are needed:
+    """
+    require 'rubygems'
+    require 'mirage/client'
+    """
+
+
+  Scenario: Defining a Model
+    Given I run
+    """
+      class UserProfile
+        extend Mirage::Template::Model
+
+        endpoint '/users'
+        http_method :get
+        status 202
+        content_type 'text/html'
+
+        def body
+          "Joe Blogs"
+        end
+      end
+
+      Mirage::Client.new.put UserProfile.new
+    """
+    When GET is sent to '/responses/users'
+    Then 'Joe Blogs' should be returned
+    And a 202 should be returned
+    And the content-type should be 'text/html'
+
+
+  Scenario: Defining builder methods
+    Given I run
+    """
+      class UserProfile
+        extend Mirage::Template::Model
+        endpoint '/users'
+
+        builder_methods :firstname, :surname
+
+        def body
+          "#{firstname} #{surname}"
+        end
+      end
+
+      Mirage::Client.new.put UserProfile.new.firstname('Joe').surname('Blogs')
+    """
+    When GET is sent to '/responses/users'
+    Then 'Joe Blogs' should be returned
+
+  Scenario: Overriding model defaults
+    Given I run
+    """
+      class UserProfile
+        extend Mirage::Template::Model
+        endpoint '/users'
+
+        builder_methods :firstname, :surname
+        status '200'
+
+        def body
+          "Joe Blogs"
+        end
+      end
+
+      Mirage::Client.new.put '/profiles', UserProfile.new do
+        status 202
+      end
+    """
+    When GET is sent to '/responses/profiles'
+    Then 'Joe Blogs' should be returned
+    And a 202 should be returned
+
+
+

data/features/client/preview_responses.feature

@@ -0,0 +1,33 @@
+Feature: Inspecting Templates
+
+  The client can be used to retrieve a template stored on Mirage.
+
+  Background:
+    Given the following require statements are needed:
+    """
+    require 'rubygems'
+    require 'rspec/expectations'
+    require 'mirage/client'
+    """
+
+  Scenario: retrieving a Template
+    Given a template for 'greeting' has been set with a value of 'Hello'
+
+    When I run
+    """
+      Mirage::Client.new.templates(1).body.should == 'Hello'
+    """
+
+    When GET is sent to '/requests/1'
+    Then a 404 should be returned
+
+  Scenario: retrieving a Template that does not exist
+    Given I run
+    """
+    begin
+      Mirage::Client.new.templates(2).should == 'this should not have happened'
+      fail("Error should have been thrown")
+    rescue Exception => e
+      e.is_a?(Mirage::TemplateNotFound).should == true
+    end
+    """

data/features/client/prime.feature

@@ -0,0 +1,32 @@
+Feature: Priming Mirage
+
+  The client can be used to prime Mirage with Templates found in the templates directory that was configured when Mirage was started.
+
+  Background:
+    Given the following require statements are needed:
+    """
+    require 'rubygems'
+    require 'rspec/expectations'
+    require 'mirage/client'
+    """
+
+  Scenario: Priming Mirage
+    Given Mirage is not running
+    And I run 'mirage start'
+
+    When the file 'mirage/default_greetings.rb' contains:
+    """
+    prime do |mirage|
+      mirage.put('greeting', 'hello')
+      mirage.put('leaving', 'goodbye')
+    end
+    """
+    And I run
+    """
+    Mirage::Client.new.prime
+    """
+    And GET is sent to '/responses/greeting'
+    Then 'hello' should be returned
+
+    When GET is sent to '/responses/leaving'
+    Then 'goodbye' should be returned

data/features/client/put.feature

@@ -0,0 +1,111 @@
+Feature: Adding Templates
+
+  The Mirage client provides methods for setting Templates.
+
+  The client will escape all data for you so your free to just get on with using Mirage :)
+
+  Body, Header, and Parameter requirements can be specified as either a String or Regexp
+
+  Background:
+    Given the following require statements are needed:
+    """
+    require 'rubygems'
+    require 'rspec/expectations'
+    require 'mirage/client'
+    """
+
+
+  Scenario: Setting a Template on Mirage
+    Given I run
+    """
+    Mirage::Client.new.put('greeting','hello')
+    """
+    When GET is sent to '/responses/greeting'
+    Then 'hello' should be returned
+
+  Scenario: Setting the required HTTP method
+    Given I run
+    """
+    Mirage::Client.new.put('greeting', 'Hello Leon') do
+      http_method 'POST'
+    end
+    """
+    When GET is sent to '/responses/greeting'
+    Then a 404 should be returned
+    When POST is sent to '/responses/greeting'
+    Then 'Hello Leon' should be returned
+
+
+  Scenario: Setting a requirement on body content
+    Given I run
+    """
+    Mirage::Client.new.put('greeting', 'Hello Leon') do
+      http_method 'POST'
+      required_body_content << /leon/
+    end
+    """
+    When POST is sent to '/responses/greeting'
+    Then a 404 should be returned
+    When I send POST to '/responses/greeting' with request entity
+    """
+     <greetingRequest>
+      <name>leon</name>
+     </greetingRequest>
+    """
+    Then 'Hello Leon' should be returned
+
+  Scenario: Setting a requirement on requests parameters
+    Given I run
+    """
+    Mirage::Client.new.put('greeting', 'Hello Leon') do
+      http_method 'POST'
+      required_parameters[:name] = /leon/
+    end
+    """
+    When POST is sent to '/responses/greeting'
+    Then a 404 should be returned
+    When I send POST to '/responses/greeting' with parameters:
+      | name | leon |
+
+    Then 'Hello Leon' should be returned
+
+  Scenario: setting a response as default
+    Given I run
+    """
+    Mirage.start.clear
+
+    Mirage::Client.new.put('greeting', 'default greeting') do
+      default true
+    end
+    """
+    When GET is sent to '/responses/greeting/for/joel'
+    Then 'default greeting' should be returned
+
+
+  Scenario: Setting the content type
+    Given I run
+    """
+    Mirage::Client.new.put('greeting', '<xml></xml>') do
+      content_type 'text/xml'
+    end
+    """
+    When GET is sent to '/responses/greeting'
+    And the response 'content-type' should be 'text/xml'
+
+
+  Scenario: Setting the HTTP status code
+    Given I run
+    """
+    Mirage::Client.new.put('greeting', 'hello'){status 203}
+    """
+    When GET is sent to '/responses/greeting'
+    Then a 203 should be returned
+
+
+  Scenario: Setting a delay
+    Given I run
+    """
+    Mirage::Client.new.put('greeting', 'hello'){delay 2}
+    """
+    When GET is sent to '/responses/greeting'
+    Then it should take at least '2' seconds

data/features/client/readme.md

@@ -0,0 +1,3 @@
+Mirage has a client implemented in Ruby. It's fully functional and includes a command line interface for controlling the Mirage server direct from your test suite.
+
+

data/features/client/requests.feature

@@ -0,0 +1,20 @@
+Feature: Retrieving tracked requests
+
+  Requests made to the Mirage Server can be retrieved using the Mirage client
+
+  Background:
+    Given the following require statements are needed:
+    """
+    require 'rubygems'
+    require 'mirage/client'
+    """
+
+  Scenario: Retrieving request data
+    Given a template for 'greeting' has been set with a value of 'Hello'
+
+    When I send GET to '/responses/greeting' with parameters:
+      | name | leon  |
+    Then I run
+    """
+       Mirage::Client.new.requests(1).parameters.should == {'name' => 'leon'}
+    """