mirage 3.0.0.alpha.17 → 3.0.0

data/features/client/put.feature

@@ -1,18 +1,21 @@
-Feature: the Mirage client provides methods for setting responses and loading default responses.
-  There is no need to escape any parameters before using the client api as this is done for you.
+Feature: Adding Templates
 
-  Patterns can be either a string or regex object.
+  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 gems are required to run the Mirage client test code:
     """
     require 'rubygems'
-    require 'rspec'
+    require 'rspec/expectations'
     require 'mirage/client'
     """
 
 
-  Scenario: Setting a basic response
+  Scenario: Setting a Template on Mirage
     Given I run
     """
     Mirage::Client.new.put('greeting','hello')
@@ -20,7 +23,7 @@ Feature: the Mirage client provides methods for setting responses and loading de
     When GET is sent to '/responses/greeting'
     Then 'hello' should be returned
 
-  Scenario: Setting the method that a response should be returned on
+  Scenario: Setting the required HTTP method
     Given I run
     """
     Mirage::Client.new.put('greeting', 'Hello Leon') do
@@ -33,7 +36,7 @@ Feature: the Mirage client provides methods for setting responses and loading de
     Then 'Hello Leon' should be returned
 
 
-  Scenario: Setting a response with required body content
+  Scenario: Setting a requirement on body content
     Given I run
     """
     Mirage::Client.new.put('greeting', 'Hello Leon') do
@@ -51,7 +54,7 @@ Feature: the Mirage client provides methods for setting responses and loading de
     """
     Then 'Hello Leon' should be returned
 
-  Scenario: Setting a response with a request parameter requirement
+  Scenario: Setting a requirement on requests parameters
     Given I run
     """
     Mirage::Client.new.put('greeting', 'Hello Leon') do
@@ -89,40 +92,8 @@ Feature: the Mirage client provides methods for setting responses and loading de
     When GET is sent to '/responses/greeting'
     And the response 'content-type' should be 'text/xml'
 
-#  Scenario: Priming Mirage
-#    Given Mirage is not running
-#    And I run 'mirage start'
-#
-#    When the file 'responses/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
-
-  Scenario: Setting a file as a response
-    Given the file 'test_file.txt' contains:
-    """
-    test content
-    """
-    And I run
-    """
-    Mirage::Client.new.put('download', File.read('test_file.txt'))
-    """
-    When GET is sent to '/responses/download'
-    Then the response should be the same as the content of 'test_file.txt'
-
-  Scenario: Setting a response status code
+
+  Scenario: Setting the HTTP status code
     Given I run
     """
     Mirage::Client.new.put('greeting', 'hello'){status 203}
@@ -131,7 +102,7 @@ Feature: the Mirage client provides methods for setting responses and loading de
     Then a 203 should be returned
 
 
-  Scenario: Setting a response with a delay
+  Scenario: Setting a delay
     Given I run
     """
     Mirage::Client.new.put('greeting', 'hello'){delay 2}

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

@@ -1,4 +1,6 @@
-Feature: Requests made to the Mirage Server can be retrieved using the Mirage client
+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:

data/features/client/running.feature

@@ -1,12 +1,14 @@
 @command_line
-Feature: Use the mirage client api to check if Mirage is running either on the local machine or on a remote host.
+Feature: How to check if Mirage is running
+
+  Use the Mirage client api to check if Mirage is running either on the local machine or on a remote host.
 
 
   Background:
     Given the following gems are required to run the Mirage client test code:
     """
     require 'rubygems'
-    require 'rspec'
+    require 'rspec/expectations'
     require 'mirage/client'
     """
 

data/features/client/save_and_revert.feature

@@ -1,17 +1,19 @@
-Feature: The Mirage client can be used to snaphsot and rollback the Mirage server
+Feature: Creating snapshots
+
+  The client can be used to snapshot and rollback the Mirage server
 
 
   Background:
     Given the following gems are required to run the Mirage client test code:
     """
     require 'rubygems'
-    require 'rspec'
+    require 'rspec/expectations'
     require 'mirage/client'
     """
     And a template for 'greeting' has been set with a value of 'The default greeting'
 
 
-  Scenario: saving and reverting
+  Scenario: Creating a snapshot and rolling back
     Given I run
     """
     Mirage::Client.new.save

data/features/client/start.feature

@@ -1,5 +1,7 @@
 @command_line
-Feature: The client API can be used to start Mirage.
+Feature: Starting Mirage
+
+  The client can be used to start Mirage.
 
   Both the port and default templates directory can be specified
 

data/features/client/stop.feature

@@ -1,5 +1,7 @@
 @command_line
-Feature:The client API can be used to stop instances of Mirage running on localhost.
+Feature: Stopping Mirage
+
+  The client API can be used to stop instances of Mirage running on localhost.
 
   Background:
     Given the following require statements are needed:

data/features/commandline_interface/help.feature

@@ -6,7 +6,7 @@ Feature: Help
   Background: Mirage usage
     Given usage information:
     """
-      mirage help [TASK]  # Describe available tasks or one specific task
+      mirage help [COMMAND]  # Describe available commands or one specific command
       mirage start        # Starts mirage
       mirage stop         # Stops mirage
     """

data/features/prime.feature

@@ -1,8 +1,8 @@
 #TODO - rename responses directory to templates
 @command_line
-Feature: Preloading templates
+Feature: Preloading Templates
   Mirage can be primed with a set of templates.
-  By default, Mirage loads any .rb files found in ./responses on startup. Mirage can also be made to load responses from a directory
+  By default, Mirage loads any .rb files found in ./mirage on startup. Mirage can also be made to load responses from a directory
   of your choosing by using the -d/--defaults option
 
   Responses can be added to the responses directory and used to prime Mirage after Mirage has been started.
@@ -11,7 +11,7 @@ Feature: Preloading templates
 
 
   Scenario: Using the default responses directory
-    Given the file 'responses/default_greetings.rb' contains:
+    Given the file 'mirage/default_greetings.rb' contains:
     """
     prime do |mirage|
       mirage.templates.put('greeting', 'hello')
@@ -24,12 +24,12 @@ Feature: Preloading templates
 
   Scenario: Using a custom responses directory
     Given Mirage is not running
-    And the file '/tmp/responses/default_greetings.rb' contains:
+    And the file '/tmp/mirage/default_greetings.rb' contains:
     """
     prime do |mirage|
       mirage.templates.put('greeting', 'hello')
     end
     """
-    And I run 'mirage start --defaults /tmp/responses'
+    And I run 'mirage start --defaults /tmp/mirage'
     And GET is sent to '/responses/greeting'
     Then 'hello' should be returned

data/features/step_definitions/my_steps.rb

@@ -275,4 +275,7 @@ Then(/^the template (request|response) specification should have the following s
 end
 Then(/^the following json should be returned:$/) do |text|
   JSON.parse(text).should == JSON.parse(@response.body)
+end
+When(/^the content-type should be '(.*)'$/) do |content_type|
+  @response.content_type.should == content_type
 end

data/features/templates/preview.feature

@@ -1,5 +1,5 @@
-Feature: Retrieving
-  A Templates body can be previewed
+Feature: Previewing
+  A Template's body can be previewed
 
 
   Scenario: Preview template body

data/features/templates/put_with_substitutions.feature

@@ -1,5 +1,5 @@
 Feature: Substituting values from requests in to a template
-  Parts of a response can be substitued for values found in the request body or query string.
+  Parts of a response can be substituted for values found in the request body or query string.
   This allows dynamic content to be sent back to a client.
 
   To do this, substitution, matchers must be put in the the response value.

data/features/templates/readme.md

@@ -2,6 +2,3 @@ Templates are the descriptors pushed to Mirage to tell it what to return to a cl
 
 They can be configured to place restrictions on the requests that should be met before they are allowed to be used to generate a response.
 
-title
------
-

data/features/web_user_interface.feature

@@ -1,32 +1,44 @@
 Feature: Web interface
-  Mirage's home page allows you to see what response are currently being hosted.
-  From this page you can:
-  - Peek at a responses content
-  - Track the response to see if a request has been made to it
-
-#TODO tests needed for displaying pattern and delay values and http method
+  Note: This feature is being rewritten but the screens pretty basic so take a look:
 
-  Background: There are already a couple of responses hosted on he Mirage server
-    Given I send PUT to '/templates/greeting' with body 'hello' and headers:
-      | X-mirage-default | true |
-      | X-mirage-method  | POST |
-    And I send PUT to '/templates/leaving' with body 'goodbye'
+  The home page is served from '/' so by default is found at http://localhost:7001/
 
-  Scenario: Using the home page to see what response are being hosted
-    Given I goto ''
-    Then I should see 'greeting/*'
-    Then I should see 'leaving'
+  Mirage's home page allows you to see what response are currently being hosted.
+  From this page you can:
+  - See all currently hosted templates
+  - Preview at a Templates content
+  - View the last request to trigger a particular Template
 
-  Scenario: Using the home page to peek at a response
-    Given I goto ''
-    When  I click 'peek_response_1'
-    Then I should see 'hello'
 
-  Scenario: Using the home page to track if a request has been made
-    Given I send POST to '/responses/greeting' with request entity
-    """
-    Yo!
-    """
-    Given I goto ''
-    When  I click 'track_response_1'
-    Then I should see 'Yo!'
+#  Background: There are already a couple of responses hosted on he Mirage server
+#    Given the following template template:
+#    """
+#      {
+#         "response":{
+#            "body":"SGVsbG8="
+#         },
+#         "request":{
+#         }
+#      }
+#    """
+#    And the template is sent using PUT to '/templates/greeting'
+#
+#
+#  Scenario: Using the home page to see what response are being hosted
+#    Given I goto to the Mirage home page
+#    Then I should see 'greeting/*'
+#    Then I should see 'leaving'
+#
+#  Scenario: Using the home page to peek at a response
+#    Given I goto ''
+#    When  I click 'peek_response_1'
+#    Then I should see 'hello'
+#
+#  Scenario: Using the home page to track if a request has been made
+#    Given I send POST to '/responses/greeting' with request entity
+#    """
+#    Yo!
+#    """
+#    Given I goto ''
+#    When  I click 'track_response_1'
+#    Then I should see 'Yo!'

data/lib/mirage/client/client.rb

@@ -11,7 +11,6 @@ module Mirage
 
     def initialize options={:url => "http://localhost:7001"}, &block
       if options.is_a?(String) && options =~ URI.regexp
-        warn("Client.new(url): Deprecated usage, please use :url => url | :port => port")
         @url = options
       elsif options.kind_of?(Hash) && options[:port]
         @url = "http://localhost:#{options[:port]}"

data/lib/mirage/client/error.rb

@@ -8,10 +8,10 @@ module Mirage
     end
   end
 
-  class InternalServerException < MirageError;
+  class InternalServerException < MirageError
   end
 
-  class ResponseNotFound < ::Exception
+  class TemplateNotFound < ::Exception
   end
 
   class ClientError < ::Exception

data/lib/mirage/client/runner.rb

@@ -56,7 +56,7 @@ module Mirage
 
     desc "start", "Starts mirage"
     method_option :port, :aliases => "-p", :type => :numeric, :default => 7001, :desc => "port that mirage should be started on"
-    method_option :defaults, :aliases => "-d", :type => :string, :default => 'responses', :desc => "location to load default responses from"
+    method_option :defaults, :aliases => "-d", :type => :string, :default => 'mirage', :desc => "location to load default responses from"
     method_option :debug, :type => :boolean, :default => false, :desc => "run in debug mode"
 
     def start

data/lib/mirage/client/template.rb

@@ -19,7 +19,7 @@ module Mirage
 
       def get url
         response = backedup_get(url, :format => :json)
-        raise ResponseNotFound if response.code == 404
+        raise TemplateNotFound if response.code == 404
         response_hashie = Hashie::Mash.new response
 
         response_config = response_hashie.response

data/lib/mirage/client/templates.rb

@@ -25,7 +25,7 @@ module Mirage
       if args.first.class.is_a?(Template::Model)
         template = args.first
         template = template.clone
-        template.endpoint "#{@url}/#{template.endpoint}" unless template.endpoint.to_s.start_with?(@url)
+        template.endpoint "#{@url}/#{template.endpoint}"
       else
 
         endpoint, template = args

data/mirage.gemspec

@@ -1,34 +1,40 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = "mirage"
-  s.version = "3.0.0.alpha.17"
+  s.version = "3.0.0"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leon Davis"]
-  s.date = "2013-10-22"
+  s.date = "2013-10-27"
   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 = [
     "README.md"
   ]
   s.files = [
-    ".rvmrc",
+    ".ruby-gemset",
+    ".ruby-version",
     ".simplecov",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "HISTORY",
     "README.md",
+    "Rakefile",
     "VERSION",
     "bin/mirage",
     "features/.nav",
     "features/client/clear.feature",
     "features/client/configure.feature",
+    "features/client/model.feature",
     "features/client/preview_responses.feature",
+    "features/client/prime.feature",
     "features/client/put.feature",
+    "features/client/readme.md",
     "features/client/requests.feature",
     "features/client/running.feature",
     "features/client/save_and_revert.feature",
@@ -76,9 +82,6 @@ Gem::Specification.new do |s|
     "lib/mirage/client/templates.rb",
     "mirage.gemspec",
     "mirage_server.rb",
-    "profiles.rb",
-    "rakefile",
-    "responses/default_responses.rb",
     "server/app.rb",
     "server/binary_data_checker.rb",
     "server/extensions/hash.rb",
@@ -104,9 +107,7 @@ Gem::Specification.new do |s|
     "spec/server/mock_response_spec.rb",
     "spec/server/server_spec.rb",
     "spec/spec_helper.rb",
-    "test.html",
-    "test.rb",
-    "todo.lst",
+    "todo.list",
     "views/index.haml",
     "views/response.haml"
   ]