mirage 0.1.6 → 0.1.7

data/features/checking_for_requests.feature

@@ -1,5 +1,5 @@
 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 endpint that the MockServer is stubbing,
+  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.
 
@@ -21,7 +21,7 @@ Feature: After a response has been served from Mirage, the content of the reques
     """
     Hello MockServer
     """
-    When I hit 'http://localhost:7001/mirage/check/1'
+    When I hit 'http://localhost:7001/mirage/check_request/1'
     Then 'Hello MockServer' should be returned
 
 
@@ -29,12 +29,12 @@ Feature: After a response has been served from Mirage, the content of the reques
     Given I hit 'http://localhost:7001/mirage/get/greeting' with parameters:
       | surname   | Davis |
       | firstname | Leon  |
-    When I hit 'http://localhost:7001/mirage/check/1'
+    When I hit 'http://localhost:7001/mirage/check_request/1'
     Then 'surname=Davis&firstname=Leon' should be returned
 
 
   Scenario: Querying a response that has not been served yet
-    Given I hit 'http://localhost:7001/mirage/check/1'
+    Given I hit 'http://localhost:7001/mirage/check_request/1'
     Then a 404 should be returned
 
 
@@ -44,7 +44,7 @@ Feature: After a response has been served from Mirage, the content of the reques
     Hello
     """
     And I hit 'http://localhost:7001/mirage/peek/1'
-    When I hit 'http://localhost:7001/mirage/check/1'
+    When I hit 'http://localhost:7001/mirage/check_request/1'
     Then 'Hello' should be returned
 
 
@@ -66,9 +66,9 @@ Feature: After a response has been served from Mirage, the content of the reques
     """
     My name is Leon
     """
-    And I hit 'http://localhost:7001/mirage/check/1'
+    And I hit 'http://localhost:7001/mirage/check_request/1'
     Then 'My name is Joel' should be returned
-    And I hit 'http://localhost:7001/mirage/check/3'
+    And I hit 'http://localhost:7001/mirage/check_request/3'
     Then 'My name is Leon' should be returned
 
 

data/features/client/checking_for_requests.feature

@@ -16,5 +16,5 @@ Feature: Requests made to the Mirage Server can be tracked using the Mirage clie
       | name | leon  |
     Then I run
     """
-       Mirage::Client.new.check(1).should == 'name=leon'
+       Mirage::Client.new.check_request(1).should == 'name=leon'
     """

data/features/client/getting_responses.feature

@@ -17,6 +17,22 @@ Feature: the Mirage client provides a method for getting responses
     Mirage::Client.new.get('greeting').should == 'hello'
     """
 
+  Scenario: getting a response with parameters
+    Given I run
+    """
+    Mirage::Client.new.get('greeting', :firstname => 'leon', :surname => 'davis').should == 'hello'
+    """
+    And I hit 'http://localhost:7001/mirage/check_request/1'
+    Then 'firstname=leon&surname=davis' should be returned
+
+  Scenario: getting a response with a request body
+    Given I run
+    """
+    Mirage::Client.new.get('greeting','<greetingRequest></greetingRequest>').should == 'hello'
+    """
+    And I hit 'http://localhost:7001/mirage/check_request/1'
+    Then '<greetingRequest></greetingRequest>' should be returned
+
   Scenario: getting a response that does not exist
     Given I run
     """

data/features/client/setting_responses.feature

@@ -12,7 +12,7 @@ Feature: the Mirage client provides methods for setting responses and loading de
   Scenario: Setting a basic response
     Given I run
     """
-    Mirage::Client.new.set('greeting',:response => 'hello')
+    Mirage::Client.new.set('greeting','hello')
     """
     When I hit 'http://localhost:7001/mirage/get/greeting'
     Then 'hello' should be returned
@@ -20,7 +20,7 @@ Feature: the Mirage client provides methods for setting responses and loading de
   Scenario: Setting a response with a pattern
     Given I run
     """
-    Mirage::Client.new.set('greeting', :response => 'Hello Leon', :pattern => '.*?>leon</name>')
+    Mirage::Client.new.set('greeting', 'Hello Leon', :pattern => '.*?>leon</name>')
     """
     When I hit 'http://localhost:7001/mirage/get/greeting'
     Then a 404 should be returned
@@ -39,8 +39,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', :response => 'hello')
-      mirage.set('leaving', :response => 'goodbye')
+      mirage.set('greeting', 'hello')
+      mirage.set('leaving', 'goodbye')
     end
     """
     And I run
@@ -73,19 +73,7 @@ Feature: the Mirage client provides methods for setting responses and loading de
   Scenario: Setting a file as a response
     Given I run
     """
-    Mirage::Client.new.set('download', :file => File.open('features/resources/test.zip'))
+    Mirage::Client.new.set('download', File.open('features/resources/test.zip'))
     """
     When I hit 'http://localhost:7001/mirage/get/download'
     Then the response should be a file the same as 'features/resources/test.zip'
-
-
-  Scenario: A response or file is not supplied
-    Given I run
-    """
-      begin
-        Mirage::Client.new.set('download',{})
-        fail("Error should have been thrown")
-      rescue Exception => e
-        e.is_a?(Mirage::InternalServerException).should == true
-      end
-    """

data/features/client/snapshotting.feature

@@ -12,10 +12,10 @@ Feature: The Mirage client can be used to snaphsot and rollback the Mirage serve
       | response | The default greeting |
 
 
-  Scenario: Taking a snapshot and rolling it back
+  Scenario: saving and reverting
     Given I run
     """
-    Mirage::Client.new.snapshot
+    Mirage::Client.new.save
     """
     And I hit 'http://localhost:7001/mirage/set/leaving' with parameters:
       | response | Goodye |
@@ -25,7 +25,7 @@ Feature: The Mirage client can be used to snaphsot and rollback the Mirage serve
 
     When I run
     """
-    Mirage::Client.new.rollback
+    Mirage::Client.new.revert
     """
     And I hit 'http://localhost:7001/mirage/get/leaving'
     Then a 404 should be returned

data/features/file_hosting.feature

@@ -2,7 +2,7 @@ Feature: Mirage can also be used to host files.
 
   Scenario: A file is set as a response
     Given I hit 'http://localhost:7001/mirage/set/some/location/download' with parameters:
-      | file | features/resources/test.zip |
+      | response | features/resources/test.zip |
 
     When I hit 'http://localhost:7001/mirage/get/some/location/download'
     Then the response should be a file the same as 'features/resources/test.zip'

data/features/peeking_at_response.feature

@@ -12,7 +12,7 @@ Feature: If you want to see the content of a particular response without trigger
 
   Scenario: Peeking a file based response
     Given I hit 'http://localhost:7001/mirage/set/download' with parameters:
-      | file | features/resources/test.zip |
+      | response | features/resources/test.zip |
     When I hit 'http://localhost:7001/mirage/peek/1'
     Then the response should be a file the same as 'features/resources/test.zip'
 

data/features/priming.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', :response => 'hello')
-      mirage.set('leaving', :response => 'goodbye')
+      mirage.set('greeting', 'hello')
+      mirage.set('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', :response => 'hello')
+      mirage.set('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', :response => 'hello')
+      mirage.set('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', :response => 'hello')
+      mirage.set('greeting', 'hello')
     end
     """
     And I run 'mirage start'

data/features/{snapshotting.feature → save.feature}

@@ -1,22 +1,22 @@
 Feature: Having set up the Mirage with a number of defaults, your tests may continue to change its state.
   Clearing and resetting all of your responses, potentially hundreds of times, can be time expensive.
 
-  Mirage provides the ability to take a snapshot of its current state and to roll it back to that state.
+  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 |
 
 
-  Scenario: Taking a snapshot and rolling it back
-    Given  I hit 'http://localhost:7001/mirage/snapshot'
+  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/rollback'
+    And I hit 'http://localhost:7001/mirage/revert'
 
     When I hit 'http://localhost:7001/mirage/get/leaving'
     Then a 404 should be returned

data/features/step_definitions/my_steps.rb

@@ -94,8 +94,8 @@ When /^I (hit|get|post to) '(http:\/\/localhost:7001\/mirage\/(.*?))' with param
   parameters = {}
   table.raw.each do |row|
     parameter, value = row[0].to_sym, row[1]
-    value = (parameter == :file ? File.open(value) : value)
-    parameters[parameter.to_sym]=value
+    value = File.exists?(value) ? File.open(value) : value
+    parameters[parameter]=value
   end
 
   @response = hit_mirage(url, parameters)

data/features/support/env.rb

@@ -22,7 +22,8 @@ module Web
 
   def hit_mirage(url, parameters={})
     start_time = Time.now
-    response = (parameters.include?(:file) ? http_post(url, parameters) : http_get(url, parameters))
+    file = parameters.values.find{|value| value.is_a?(File)}
+    response = (file ? http_post(url, parameters) : http_get(url, parameters))
     @response_time = Time.now - start_time
     response
   end

data/features/web_user_interface.feature

@@ -20,15 +20,6 @@ Feature: Mirage's home page allows you to see what response are currently being
     When  I click 'peek_response_1'
     Then I should see 'hello'
 
-  Scenario: Using the home page to check if a request has been made
-    Given I hit 'http://localhost:7001/mirage/get/greeting' with request body:
-    """
-    Yo!
-    """
-    Given I goto 'http://localhost:7001/mirage'
-    When  I click 'check_response_1'
-    Then I should see 'Yo!'
-
   Scenario: Using the home page to check if a request has been made
     Given I hit 'http://localhost:7001/mirage/get/greeting' with request body:
     """

data/lib/mirage/client.rb

@@ -40,20 +40,22 @@ module Mirage
     #   Mirage::Client.new.get('greeting', :param1 => 'value1', param2=>'value2')
     #
     #   Getting a response, passing a content in the body of the request
-    #   Mirage::Client.new.get('greeting', :body => 'content')
+    #   Mirage::Client.new.get('greeting',  'content')
 
-    def get endpoint, params={}
-      response(http_get("#{@url}/get/#{endpoint}", params))
+    def get endpoint, body_or_params={}
+      body_or_params = {:body => body_or_params} if body_or_params.is_a?(String)
+      response(http_get("#{@url}/get/#{endpoint}", body_or_params))
     end
 
     # Set a text or file based response, to be hosted at a given end point optionally with a given pattern and delay
-    # Client.set(endpoint, params) => unique id that can be used to call back to the server
+    # Client.set(endpoint, response, params) => unique id that can be used to call back to the server
     #
     #  Examples:
-    #  Client.set('greeting', :response => 'hello':)
-    #  Client.set('greeting', :response => 'hello', :pattern => 'regex or plain text':)
-    #  Client.set('greeting', :response => 'hello', :delay => 5) # number of seconds
-    def set endpoint, params
+    #  Client.set('greeting', 'hello':)
+    #  Client.set('greeting', 'hello', :pattern => 'regex or plain text':)
+    #  Client.set('greeting', 'hello', :delay => 5) # number of seconds
+    def set endpoint, response, params={}
+      params[:response] = response
       response(http_post("#{@url}/set/#{endpoint}", params))
     end
 
@@ -93,21 +95,21 @@ module Mirage
     # request did not have any content in its body then what ever was in the request query string is returned instead
     #
     #   Example:
-    #   Client.new.check(response_id) => Tracked request as a String
-    def check response_id
-      response(http_get("#{@url}/check/#{response_id}"))
+    #   Client.new.check_request(response_id) => Tracked request as a String
+    def check_request response_id
+      response(http_get("#{@url}/check_request/#{response_id}"))
     end
 
-    # Snapshot the state of the Mirage server so that it can be rolled back to that exact state at a later time.
-    def snapshot
-      http_post("#{@url}/snapshot").code == 200
+    # Save the state of the Mirage server so that it can be reverted back to that exact state at a later time.
+    def save
+      http_post("#{@url}/save").code == 200
     end
 
 
-    # Roll the state of Mirage back to that stored in the snapshot
+    # Revert the state of Mirage back to the state that was last saved
     # If there is no snapshot to rollback to, nothing happens
-    def rollback
-      http_post("#{@url}/rollback").code == 200
+    def revert
+      http_post("#{@url}/revert").code == 200
     end
 
 

data/lib/mirage/core.rb

@@ -93,7 +93,7 @@ module Mirage
       name = args.join('/')
       is_default = request['default'] == 'true'
 
-      response = MockResponse.new(name, (request[:file]||response_value), pattern, delay.to_f, is_default)
+      response = MockResponse.new(name, response_value, pattern, delay.to_f, is_default)
 
       stored_responses = RESPONSES[name]||={}
 
@@ -147,15 +147,15 @@ module Mirage
       end
     end
 
-    def check id
+    def check_request id
       REQUESTS[id.to_i] || respond("Nothing stored for: #{id}", 404)
     end
 
-    def snapshot
+    def save
       SNAPSHOT.clear and SNAPSHOT.replace(RESPONSES.deep_clone)
     end
 
-    def rollback
+    def revert
       RESPONSES.clear and RESPONSES.replace(SNAPSHOT.deep_clone)
     end
 

data/lib/view/mirage/index.xhtml

@@ -15,7 +15,7 @@
 <?r unless @responses.empty? ?>
 <table border="1" width='100%'>
     <?r @responses.each do |key, response| ?>
-        <tr><td><a id='peek_response_#{response.response_id}' href="/mirage/peek/#{response.response_id}">#{key}</a></td><td><a id='check_response_#{response.response_id}' href="/mirage/check/#{response.response_id}">check</a></td></tr>
+        <tr><td><a id='peek_response_#{response.response_id}' href="/mirage/peek/#{response.response_id}">#{key}</a></td><td><a id='check_response_#{response.response_id}' href="/mirage/check_request/#{response.response_id}">check</a></td></tr>
     <?r end ?>
 </table>
 <?r end ?>

data/mirage.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'mirage'
-  s.version = '0.1.6'
+  s.version = '0.1.7'
   s.authors = ["Leon Davis"]
   s.homepage = 'https://github.com/lashd/mirage'
   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.'
@@ -14,7 +14,9 @@ Thanks you for installing mirage-#{s.version}.
 
 Run Mirage with:
 
-mirage start
+mirage start                                   
+
+For more information go to: https://github.com/lashd/mirage/wiki
 ===============================================================================
 }
   

metadata

@@ -2,7 +2,7 @@
 name: mirage
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Leon Davis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-27 00:00:00 +00:00
+date: 2011-03-28 00:00:00 +01:00
 default_executable: mirage
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,7 +101,6 @@ extra_rdoc_files: []
 files: 
 - .rvmrc
 - Gemfile
-- Gemfile.lock
 - README.md
 - bin/mirage
 - features/checking_for_requests.feature
@@ -121,10 +120,10 @@ files:
 - features/priming.feature
 - features/resources/test.zip
 - features/response_templates.feature
+- features/save.feature
 - features/setting_responses.feature
 - features/setting_responses_with_a_delay.feature
 - features/setting_responses_with_pattern_matching.feature
-- features/snapshotting.feature
 - features/step_definitions/my_steps.rb
 - features/support/env.rb
 - features/web_user_interface.feature
@@ -145,9 +144,10 @@ licenses: []
 
 post_install_message: "\n\
   ===============================================================================\n\
-  Thanks you for installing mirage-0.1.6.   \n\n\
+  Thanks you for installing mirage-0.1.7.   \n\n\
   Run Mirage with:\n\n\
-  mirage start\n\
+  mirage start                                   \n\n\
+  For more information go to: https://github.com/lashd/mirage/wiki\n\
   ===============================================================================\n"
 rdoc_options: []
 
@@ -171,7 +171,7 @@ rubyforge_project:
 rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
-summary: mirage-0.1.6
+summary: mirage-0.1.7
 test_files: 
 - features/checking_for_requests.feature
 - features/clearing_requests_and_responses.feature
@@ -190,10 +190,10 @@ test_files:
 - features/priming.feature
 - features/resources/test.zip
 - features/response_templates.feature
+- features/save.feature
 - features/setting_responses.feature
 - features/setting_responses_with_a_delay.feature
 - features/setting_responses_with_pattern_matching.feature
-- features/snapshotting.feature
 - features/step_definitions/my_steps.rb
 - features/support/env.rb
 - features/web_user_interface.feature

data/Gemfile.lock

@@ -1,50 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mirage (0.1.6)
-      mechanize (>= 1.0.0)
-      rack (~> 1.1.0)
-      ramaze (>= 2011.01.30)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    builder (3.0.0)
-    cucumber (0.10.2)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.2)
-      gherkin (>= 2.3.5)
-      json (>= 1.4.6)
-      term-ansicolor (>= 1.0.5)
-    diff-lcs (1.1.2)
-    gherkin (2.3.5)
-      json (>= 1.4.6)
-    innate (2011.01)
-      rack (>= 1.1.0)
-    json (1.5.1)
-    mechanize (1.0.0)
-      nokogiri (>= 1.2.1)
-    nokogiri (1.4.4)
-    rack (1.1.2)
-    rake (0.8.7)
-    ramaze (2011.01.30)
-      innate (>= 2010.03)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    term-ansicolor (1.0.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  cucumber
-  mirage!
-  rake
-  rspec