rest-assured 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c35115ced77a2089492a155ef70c877a7f79155
-  data.tar.gz: 3d0869cf86b0874e797e40054776213c87d7c145
+  metadata.gz: 7f22fb40a5da375669712d668d450c79397ddd9a
+  data.tar.gz: ee5916c4ee0dac3b82230c24bb606c90205091ab
 SHA512:
-  metadata.gz: db3e43f69330695ba514f99c3851e78020828700aab04104e000149799941ac7d83b74ac147712a6355269c807ab5afa585f5acffae7215c9994289853fb7556
-  data.tar.gz: 0c9b77fe69ea6dbf572130f7e998557ef0a89ed2c76b1bcad92bb5f8b2fa1f08a402726185bafa82bcb5a90f83cb44ac956f4d5f77a742787c210dbfed721d3b
+  metadata.gz: 5333399d35149cd78f6fbb8a2c404a2535fcb75845a77b8352de6955bbbfe332ce429bc4ada5044c0ef8146e986e13385642c4cbbf09ec8c61f72c61ba926721
+  data.tar.gz: 5e90dbf790b43165c31efc5ae29094ae2af86e9ef5acfd3be0ba5a4a1d98fa215f62ddbeb570044375e84d68a196c3bd9945ef5f710034d309ef4ec4e0c26d19

data/README.markdown

@@ -111,6 +111,15 @@ JSON.parse(req.params).should == expected_params_hash
 JSON.parse(req.rack_env)['HTTP_ACCEPT'].should == 'text/html'
 ```
 
+If you want to simulate a delayed time to first byte to test how your application handles latency or time outs you can
+use the delay property when you create the double.
+
+```ruby
+ @double = RestAssured::Double.create(fullpath: '/slow-products', delay: 5)
+```
+
+Now, when a request is made to `http://localhost:4578/slow-products`, then the server will pause for 5 seconds before responding.
+
 Use REST api to clear doubles/redirects between tests:
 
 ```ruby
@@ -132,6 +141,7 @@ For using REST-assured from non-ruby environments.
   - __verb__ - one of http the following http verbs: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`. Optional. `GET` is default.
   - __status__ - status returned when double is requested. Optional. `200` is default.
   - __response_headers__ - key/value map of headers. Optional.
+  - __delay__ - the length of time in seconds the server should pause before sending the response.  Optional.
   
   Example:
 
@@ -173,7 +183,8 @@ For using REST-assured from non-ruby environments.
             "content": "awesome",
             "description": null,
             "status": 200,
-            "active": true
+            "active": true,
+            "delay" : 0
         }
     }
 
@@ -219,7 +230,7 @@ Here is the rest API for managing redirects:
   
 ## Running tests
 
-Tests require sqlite. Cucumber tests also need Chrome.
+Tests require postgres. Connection params are read from environment variables `DB_HOST`, `DB_PORT` and `DB_USER` (defaults are `localhost`, `5432` and `postgres`). Cucumber tests also need Chrome.
 
     $ git clone git://github.com/artemave/REST-assured.git
     $ cd rest-assured && bundle install

data/bin/rest-assured

@@ -19,7 +19,7 @@ OptionParser.new do |opts|
   end
 
   opts.on('-u', '--dbuser DBUSER', "Db username (mysql, postgresql only)") do |user|
-    user_opts[:user] = user
+    user_opts[:dbuser] = user
   end
 
   opts.on('--dbpass DBPASSWORD', 'Db password (mysql, postgresql only). Defaults to empty') do |password|

data/db/migrate/20170713000515_add_delay_to_doubles.rb

@@ -0,0 +1,9 @@
+class AddDelayToDoubles < ActiveRecord::Migration
+  def self.up
+    add_column :doubles, :delay, :integer
+  end
+
+  def self.down
+    remove_column :doubles, :delay
+  end
+end

data/features/rest_api/doubles.feature

@@ -4,19 +4,19 @@ Feature: use doubles via api
   I want to mock rest services my app is consuming from
 
   Scenario Outline: create double
-    When I create a double with "<fullpath>" as fullpath, "<content>" as response content, "<verb>" as request verb and status as "<status>"
-    Then there should be 1 double with "<fullpath>" as fullpath, "<content>" as response content, "<result_verb>" as request verb and status as "<result_status>"
+    When I create a double with "<fullpath>" as fullpath, "<content>" as response content, "<verb>" as request verb, status as "<status>" and delay as "<delay>"
+    Then there should be 1 double with "<fullpath>" as fullpath, "<content>" as response content, "<result_verb>" as request verb, status as "<result_status>" and delay as "<result_delay>"
 
     Examples:
-      | fullpath           | content      | verb   | result_verb | status | result_status |
-      | /api/something     | created      | POST   | POST        | 200    | 200           |
-      | /api/sss           | changed      | PUT    | PUT         | 201    | 201           |
-      | /api/asdfsf        | removed      | DELETE | DELETE      | 300    | 300           |
-      | /api/some          | text content | GET    | GET         | 303    | 303           |
-      | /api/some?a=3&b=dd | more content |        | GET         |        | 200           |
-      | /api/empty         |              | POST   | POST        |        | 200           |
-      | /api/file          |              | HEAD   | HEAD        |        | 200           |
-      | /api/file          |              | PATCH  | PATCH       |        | 200           |
+      | fullpath           | content      | verb   | result_verb | status | result_status | delay | result_delay |
+      | /api/something     | created      | POST   | POST        | 200    | 200           |       | 0            |
+      | /api/sss           | changed      | PUT    | PUT         | 201    | 201           | 0     | 0            |
+      | /api/asdfsf        | removed      | DELETE | DELETE      | 300    | 300           | 1     | 1            |
+      | /api/some          | text content | GET    | GET         | 303    | 303           | 2     | 2            |
+      | /api/some?a=3&b=dd | more content |        | GET         |        | 200           | 3     | 3            |
+      | /api/empty         |              | POST   | POST        |        | 200           | 4     | 4            |
+      | /api/file          |              | HEAD   | HEAD        |        | 200           | 5     | 5            |
+      | /api/file          |              | PATCH  | PATCH       |        | 200           | 6     | 6            |
 
   Scenario: view created double details
     When I create a double

data/features/ruby_api/create_double.feature

@@ -74,3 +74,22 @@ Feature: create double
     get @double.fullpath
     last_response.status == 302
     """
+
+    Scenario: specify a delay
+      When I create a double:
+    """
+    @double = RestAssured::Double.create(:fullpath => '/some/api', :delay => 4)
+    """
+      Then the following should be true:
+    """
+    start_time = Time.now
+
+    get @double.fullpath
+
+    end_time = Time.now
+
+    time_elapsed = end_time - start_time
+
+    expect(time_elapsed).to be > 3
+
+    """

data/features/step_definitions/doubles_steps.rb

@@ -4,8 +4,8 @@ Given /^there are no doubles$/ do
   RestAssured::Models::Double.destroy_all
 end
 
-When /^I create a double with "([^""]*)" as fullpath, "([^""]*)" as response content, "([^""]*)" as request verb and status as "([^""]*)"$/ do |fullpath, content, verb, status|
-  post '/doubles.json', { :fullpath => fullpath, :content => content, :verb => verb, :status => status }
+When /^I create a double with "([^""]*)" as fullpath, "([^""]*)" as response content, "([^""]*)" as request verb, status as "([^""]*)" and delay as "([^""]*)"$/ do |fullpath, content, verb, status, delay|
+  post '/doubles.json', { :fullpath => fullpath, :content => content, :verb => verb, :status => status, :delay => delay}
   last_response.should be_ok
 end
 
@@ -23,8 +23,8 @@ Then /^I should get (#{CAPTURE_A_NUMBER}) in response status$/ do |status|
   last_response.status.should == status
 end
 
-Then /^there should be (#{CAPTURE_A_NUMBER}) double with "([^""]*)" as fullpath, "([^""]*)" as response content, "([^""]*)" as request verb and status as "(#{CAPTURE_A_NUMBER})"$/ do |n, fullpath, content, verb, status|
-  RestAssured::Models::Double.where(:fullpath => fullpath, :content => content, :verb => verb, :status => status).count.should == n
+Then /^there should be (#{CAPTURE_A_NUMBER}) double with "([^""]*)" as fullpath, "([^""]*)" as response content, "([^""]*)" as request verb, status as "(#{CAPTURE_A_NUMBER})" and delay as "(#{CAPTURE_A_NUMBER})"$/ do |n, fullpath, content, verb, status, delay|
+  RestAssured::Models::Double.where(:fullpath => fullpath, :content => content, :verb => verb, :status => status, :delay => delay).count.should == n
 end
 
 Given /^there is double with "([^"]*)" as fullpath and "([^"]*)" as response content$/ do |fullpath, content|
@@ -152,7 +152,7 @@ Given /^I choose to delete double with fullpath "([^"]*)"$/ do |fullpath|
 end
 
 Then /^I should be asked to confirm delete$/ do
-  page.driver.browser.switch_to.alert.accept
+  js_confirm
 end
 
 Given /^there are the following doubles:$/ do |table|

data/features/support/env.rb

@@ -5,6 +5,7 @@ require 'rspec'
 require 'rack/test'
 require 'capybara'
 require 'capybara/cucumber'
+require 'capybara/poltergeist'
 require 'database_cleaner'
 require 'anticipate'
 require 'awesome_print'
@@ -29,11 +30,17 @@ end
 Capybara.register_driver :selenium do |app|
   Capybara::Selenium::Driver.new(app, :browser => :chrome)
 end
+Capybara.javascript_driver = ENV['FF'] ? :selenium : :poltergeist
 
 World(Capybara, Rack::Test::Methods, RackHeaderHack, WorldHelpers, Anticipate)
 
 require 'rest-assured/config'
-db_opts = { :adapter => 'sqlite' }
+db_opts = {
+  adapter: 'postgres',
+  dbhost: ENV.fetch('DB_HOST', 'localhost'),
+  dbport: ENV.fetch('DB_PORT', 5432),
+  dbuser: ENV.fetch('DB_USER', 'postgres')
+}
 RestAssured::Config.build(db_opts)
 
 require 'rest-assured'

data/features/support/world_helpers.rb

@@ -22,4 +22,10 @@ module WorldHelpers
 
     YAML.load(config_yaml)
   end
+
+  def js_confirm
+    if Capybara.current_driver == :selenium
+      page.driver.browser.switch_to.alert.accept
+    end
+  end
 end

data/features/web_ui/doubles.feature

@@ -6,28 +6,28 @@ Feature: manage doubles via ui
 
   Scenario: view existing doubles
     Given the following doubles exist:
-      | fullpath  | description  | content      | verb |
-      | /url1/aaa | twitter      | test content | GET  |
-      | /url2/bbb | geo location | more content | POST |
-      | /u/b?c=1  | wikipedia    | article      | PUT  |
+      | fullpath  | description  | content      | verb | delay |
+      | /url1/aaa | twitter      | test content | GET  | 0     |
+      | /url2/bbb | geo location | more content | POST | 1     |
+      | /u/b?c=1  | wikipedia    | article      | PUT  | 2     |
     When I visit "doubles" page
     Then I should see existing doubles:
-      | fullpath  | description  | verb |
-      | /url1/aaa | twitter      | GET  |
-      | /url2/bbb | geo location | POST |
-      | /u/b?c=1  | wikipedia    | PUT  |
+      | fullpath  | description  | verb | delay |
+      | /url1/aaa | twitter      | GET  | 0     |
+      | /url2/bbb | geo location | POST | 1     |
+      | /u/b?c=1  | wikipedia    | PUT  | 2     |
 
   Scenario: add new double
     Given I am on "doubles" page
     When I choose to create a double
     And I enter double details:
-      | fullpath      | description | content      | verb | status |
-      | /url2/bb?a=b5 | google api  | test content | POST | 200    |
+      | fullpath      | description | content      | verb | status | delay |
+      | /url2/bb?a=b5 | google api  | test content | POST | 200    | 1     |
     And I save it
     Then I should see "Double created"
     And I should see existing doubles:
-      | fullpath      | description | verb | status |
-      | /url2/bb?a=b5 | google api  | POST | 200    |
+      | fullpath      | description | verb | status | delay |
+      | /url2/bb?a=b5 | google api  | POST | 200    | 1     |
 
   @javascript
   Scenario: choose active double
@@ -40,22 +40,22 @@ Feature: manage doubles via ui
 
   Scenario: edit double
     Given the following doubles exist:
-      | fullpath  | description | content      | verb | status |
-      | /url1/aaa | twitter     | test content | POST | 404    |
+      | fullpath  | description | content      | verb | status | delay |
+      | /url1/aaa | twitter     | test content | POST | 404    | 0     |
     And I visit "doubles" page
     And I choose to edit double
     When I change "double" "description" to "google"
     And I save it
     Then I should see existing doubles:
-      | fullpath  | description | verb | status |
-      | /url1/aaa | google      | POST | 404    |
+      | fullpath  | description | verb | status | delay |
+      | /url1/aaa | google      | POST | 404    | 0     |
 
   @javascript
   Scenario: delete double
     Given the following doubles exist:
-      | fullpath        | description | content       |
-      | /url1/aaa  | twitter     | test content  |
-      | /url/cc/bb | google      | other content |
+      | fullpath   | description | content       | delay |
+      | /url1/aaa  | twitter     | test content  | 0     |
+      | /url/cc/bb | google      | other content | 1     |
     And I visit "doubles" page
     And I choose to delete double with fullpath "/url1/aaa"
     Then I should be asked to confirm delete

data/lib/rest-assured/config.rb

@@ -139,7 +139,7 @@ module RestAssured
 
                                 opts = {
                                   :adapter  => 'postgresql',
-                                  :username => AppConfig.user || 'root',
+                                  :username => AppConfig.dbuser || 'root',
                                   :database => AppConfig.database || default_database,
                                   :pool     => 20
                                 }

data/lib/rest-assured/models/double.rb

@@ -8,6 +8,7 @@ module RestAssured
 
       VERBS = %w{GET POST PUT DELETE HEAD PATCH}
       STATUSES = Net::HTTPResponse::CODE_TO_OBJ.keys.map(&:to_i)
+      MAX_DELAY = 30
 
       validates_presence_of :fullpath
       validates_inclusion_of :verb, :in => VERBS
@@ -16,6 +17,7 @@ module RestAssured
       after_initialize :set_status
       after_initialize :set_verb
       after_initialize :set_response_headers
+      after_initialize :set_delay
 
       before_save :toggle_active
       after_destroy :set_active
@@ -50,6 +52,14 @@ module RestAssured
             f.save
           end
         end
+
+      def set_delay
+          self.delay = 0 unless delay.present?
+          if self.delay > MAX_DELAY
+            puts "delay #{self.delay} exceeds maxmium.  Defaulting to #{MAX_DELAY}"
+            self.delay = MAX_DELAY
+          end
+        end
     end
   end
 end

data/lib/rest-assured/routes/double.rb

@@ -51,7 +51,7 @@ module RestAssured
           end
         rescue
           d = params['double'] ||
-            params.slice(*%w[fullpath content description verb status response_headers])
+            params.slice(*%w[fullpath content description verb status response_headers delay])
         end
 
         @double = Models::Double.create(d)

data/lib/rest-assured/routes/response.rb

@@ -24,6 +24,8 @@ module RestAssured
 
       d.requests.create!(:rack_env => env.to_json, :body => body, :params => request.params.to_json)
 
+      sleep d.delay
+
       app.headers d.response_headers
       app.body d.content
       app.status d.status

data/lib/rest-assured/version.rb

@@ -1,3 +1,3 @@
 module RestAssured
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
 end

data/spec/functional/response_spec.rb

@@ -29,7 +29,8 @@ module RestAssured
           :fullpath         => '/some/path',
           :content          => 'content',
           :response_headers => { 'ACCEPT' => 'text/html' },
-          :status           => 201
+          :status           => 201,
+          :delay          => 0
 
         allow(request).to receive(:fullpath).and_return(@double.fullpath)
       end
@@ -54,7 +55,7 @@ module RestAssured
 
       it 'records request' do
         requests = double
-        allow(Models::Double).to receive_message_chain('where.first').and_return(double(:requests => requests).as_null_object)
+        allow(Models::Double).to receive_message_chain('where.first').and_return(double(:requests => requests, :delay => 0).as_null_object)
 
         expect(requests).to receive(:create!).with(:rack_env => 'env', :body => 'body', :params => 'params')
 
@@ -96,12 +97,22 @@ module RestAssured
     # TODO change to instead exclude anything that does not respond_to?(:to_s)
     it 'excludes "rack.input" and "rack.errors" as they break with "IOError - not opened for reading:" on consequent #to_json (as they are IO and StringIO)' do
       requests = double.as_null_object
-      allow(Models::Double).to receive_message_chain('where.first').and_return(double(:requests => requests).as_null_object)
+      allow(Models::Double).to receive_message_chain('where.first').and_return(double(:requests => requests, :delay => 0).as_null_object)
 
       expect(env).to receive(:except).with('rack.input', 'rack.errors', 'rack.logger')
 
       Response.perform(rest_assured_app)
     end
 
+    it 'it sleeps for delay seconds' do
+      requests = double.as_null_object
+      allow(Models::Double).to receive_message_chain('where.first').and_return(double(:requests => requests, :delay => 10).as_null_object)
+
+      Response.stub(:sleep)
+      expect(Response).to receive(:sleep).with(10)
+
+      Response.perform(rest_assured_app)
+    end
+
   end
 end

data/spec/models/double_spec.rb

@@ -8,7 +8,8 @@ module RestAssured::Models
         :content          => 'some content',
         :verb             => 'GET',
         :status           => '303',
-        :response_headers => { 'ACCEPT' => 'text/html' }
+        :response_headers => { 'ACCEPT' => 'text/html' },
+        :delay => 5
       }
     end
 
@@ -38,6 +39,16 @@ module RestAssured::Models
       expect(f.active).to be true
     end
 
+    it "defaults delay to 0" do
+      f = Double.create valid_params.except(:delay)
+      expect(f.delay).to be 0
+    end
+
+    it "defaults delay of greater than 30 seconds to 30 seconds" do
+      f = Double.create valid_params.merge(:delay => 99)
+      expect(f.delay).to be 30
+    end
+
     describe 'when created' do
       it "toggles active double for the same fullpath and verb" do
         f1 = Double.create valid_params

data/spec/spec_helper.rb

@@ -20,7 +20,12 @@ require 'rack/test'
 require 'awesome_print'
 require 'rest-assured/config'
 
-DB_OPTS = { :adapter => 'sqlite' }
+DB_OPTS = {
+  adapter: 'postgres',
+  dbhost: ENV.fetch('DB_HOST', 'localhost'),
+  dbport: ENV.fetch('DB_PORT', 5432),
+  dbuser: ENV.fetch('DB_USER', 'postgres')
+}
 RestAssured::Config.build(DB_OPTS)
 
 require 'rest-assured'

data/views/doubles/_form.haml

@@ -18,6 +18,10 @@
     - statuses.each do |s|
       %option{:name => s, :selected => (@double.status == s)}= s
 
+%p
+  %label{:for => 'double_delay'} Delay
+  %input.wide#double_delay{:type => 'text', :name => 'double[delay]', :value => @double.delay}
+
 %p
   %label{:for => 'double_description'} Description
   %textarea.wide#double_description{:name => 'double[description]', :rows => 3}= @double.description

data/views/doubles/index.haml

@@ -7,6 +7,7 @@
       %th Description
       %th Verb
       %th Status
+      %th Delay
       %th Active?
       %th  
   %tbody
@@ -22,6 +23,7 @@
           %td= f.description
           %td= f.verb
           %td= f.status
+          %td= f.delay
           %td.label.text-center
             - if fs.size > 1
               %input.active-double-toggle{:type => 'radio', :name => group, :checked => f.active, :data => { 'double-id' => f.id }}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-assured
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Artem Avetisyan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -133,6 +133,7 @@ files:
 - db/migrate/20111021113953_add_status_to_doubles.rb
 - db/migrate/20111208155906_add_response_headers_to_doubles.rb
 - db/migrate/20120320200820_change_fullpath_to_text.rb
+- db/migrate/20170713000515_add_delay_to_doubles.rb
 - db/test.db
 - features/command_line_options.feature
 - features/rest_api/doubles.feature
@@ -229,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rest-assured
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Real stubs and spies for HTTP(S) services