rest-assured 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+bundle_bin
+*.db
+.sass-cache

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rest-assured.gemspec
+gemspec
+
+gem 'cucumber'
+gem 'database_cleaner'
+gem 'rspec'
+gem 'shoulda-matchers'
+gem 'rack-test'
+gem 'capybara'
+gem 'capybara-firebug'
+gem RUBY_VERSION =~ /^1\.8/ ? 'ruby-debug' : 'ruby-debug19'
+gem 'awesome_print'
+gem 'interactive_editor'
+gem 'launchy'
+#gem 'akephalos', git: 'https://github.com/Nerian/akephalos.git'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011, Artem Avetisyan, British Broadcasting Corporation
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,78 @@
+# REST assured
+
+## Overview
+
+A tool for stubbing/mocking external http based services that app under test is talking to. This is useful for blackbox testing or in cases where it is not possible to access application objects directly from test code.
+There are three main use cases:
+
+* stubbing out external data sources with predefined data, so that test code has known data to assert against
+* setting expectations on messages to external services (currently not yet implemented)
+* mimic different responses from external services during development. For that purpose there is web UI
+
+## Usage
+
+You are going to need ruby >= 1.8.7. Install gem and run:
+
+    sudo gem install rest-assured # omit sudo if using rvm
+    rest-assured &
+
+Or clone from github and run:
+
+    git clone git@github.com:BBC/rest-assured.git
+    ./rest-assured/bin/rest-assured &
+
+This starts an instance of rest-assured on port 4578 (changable with --port option) and creates rest-assured.db (changable with --database option) in the current directory. You can now access it via REST or web interfaces on http://localhost:4578
+
+### Doubles
+
+Double is a stub/mock of a particular external call. There is the following rest API for setting up doubles:
+
+* `POST '/doubles', { request_fullpath: path, content: content, method: method }`
+  Creates double with the following parameters:
+
+  - __request_fullpath__ - e.g., `/some/api/object`, or with parameters in query string (useful for doubling GETs) - `/some/other/api/object?a=2&b=c`. Mandatory.
+  - __content__ - whatever you want this double to respond with. Mandatory.
+  - __method__ - one of http the following http verbs: GET, POST, PUT, DELETE. Optional. GET is default.
+
+  Example (using ruby RestClient):
+  
+    RestClient.post 'http://localhost:4578:/doubles', { request_fullpath: '/api/v2/products?type=fresh', method: 'GET', content: 'this is list of products' }
+
+  Now GETting http://localhost:4578/api/v2/products?type=fresh (in browser for instance) should return "this is list of products".
+
+  If there is more than one double for the same request\_fullpath and method, the last created one gets served. In UI you can manually control which double is 'active' (gets served).
+
+* `DELETE '/doubles/all'`
+  Deletes all doubles.
+
+### Redirects
+
+It is sometimes desirable to only double certain calls while letting others through to the 'real' services. Meet Redirects. Kind of "rewrite rules" for requests that didn't match any double. Here is the resp API for managing redirects:
+
+* `POST '/redirects', { pattern: pattern, to: uri }` Creates redirect with the following parameters:
+
+  - __pattern__ - regex (perl5 style) tested against request fullpath. Mandatory
+  - __to__ - url base e.g., `https://myserver:8787/api`. Mandatory
+
+  Example (using ruby RestClient):
+
+    RestClient.post 'http://localhost:4578/redirects', { pattern: '^/auth', to: 'https://myserver.com/api' }
+
+  Now request (any method) to http://localhost:4578/auth/services/1 will get redirected to https://myserver.com/api/auth/services/1. Provided of course there is no double matched for that fullpath and method.
+  Much like rewrite rules, redirects are evaluated in order (of creation). In UI you can manually rearrange the order.
+
+### Storage
+
+By default when you start rest-assured it creates (unless already exists) sqlite database and stores it into file in the current directory. This is good for using it for development - when you want doubles/redirects to persist across restarts - but may not be so desirable for using with tests, where you want each test run to start from blank slate. For that reason, you can specify `--database :memory:` so that database is kept in memory.
+
+## TODO
+
+* Implement expectations
+* Support headers (extends previous point)
+* Ruby client library
+* Support methods in UI (at the moment it is always GET)
+* Don't allow to double internal routes. Just in case
+
+## Author
+
+[Artem Avetisyan](https://github.com/artemave)

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'sinatra/activerecord/rake'

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require "irb"
+require 'bundler/setup'
+
+$:.push File.expand_path('../../lib', __FILE__)
+
+require 'rest-assured/config'
+AppConfig[:database] = ENV['FRS_DB'] || File.expand_path('../../db/development.db', __FILE__)
+
+require 'rest-assured'
+
+IRB.start(__FILE__)

data/bin/rest-assured

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+$:.push File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'optparse'
+require 'rest-assured/config'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: rest-assured [options]"
+
+  opts.on('-d', '--database FILENAME', "Path to database file. Defaults to ./rest-assured.db. There is a special value ':memory:' for in memory database.") do |fname|
+    AppConfig[:database] = fname
+  end
+
+  opts.on('-p', '--port PORT', Integer, "Server port. Defaults to 4578") do |port|
+    AppConfig[:port] = port
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+require 'rest-assured'
+
+RestAssured::Application.run!

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: --tags ~@long
+long: --tags @long
+wip: --tags @wip

data/db/migrate/20110620161740_add_fixtures.rb

@@ -0,0 +1,12 @@
+class AddFixtures < ActiveRecord::Migration
+  def self.up
+    create_table :fixtures do |t|
+      t.string  :url
+      t.text    :content 
+    end
+  end
+
+  def self.down
+    drop_table :fixtures 
+  end
+end

data/db/migrate/20110625155332_add_redirects_table.rb

@@ -0,0 +1,12 @@
+class AddRedirectsTable < ActiveRecord::Migration
+  def self.up
+    create_table :redirects do |t|
+      t.string :pattern
+      t.string :to
+    end
+  end
+
+  def self.down
+    drop_table :redirects
+  end
+end

data/db/migrate/20110709150645_add_description_to_fixtures.rb

@@ -0,0 +1,9 @@
+class AddDescriptionToFixtures < ActiveRecord::Migration
+  def self.up
+    add_column :fixtures, :description, :text
+  end
+
+  def self.down
+    remove_column :fixtures, :description
+  end
+end

data/db/migrate/20110807222522_add_active_bit_to_fixtures.rb

@@ -0,0 +1,9 @@
+class AddActiveBitToFixtures < ActiveRecord::Migration
+  def self.up
+    add_column :fixtures, :active, :boolean, :default => true
+  end
+
+  def self.down
+    remove_column :fixtures, :active
+  end
+end

data/db/migrate/20110818155555_add_position_to_redirects.rb

@@ -0,0 +1,9 @@
+class AddPositionToRedirects < ActiveRecord::Migration
+  def self.up
+    add_column :redirects, :position, :integer
+  end
+
+  def self.down
+    remove_column :redirects, :position
+  end
+end

data/db/migrate/20110823132023_add_method_to_fixtures.rb

@@ -0,0 +1,9 @@
+class AddMethodToFixtures < ActiveRecord::Migration
+  def self.up
+    add_column :fixtures, :method, :string
+  end
+
+  def self.down
+    remove_column :fixtures, :method
+  end
+end

data/db/migrate/20110912162948_rename_url_to_fullpath.rb

@@ -0,0 +1,9 @@
+class RenameUrlToFullpath < ActiveRecord::Migration
+  def self.up
+    rename_column :fixtures, :url, :fullpath
+  end
+
+  def self.down
+    rename_column :fixtures, :fullpath, :url
+  end
+end

data/db/migrate/20110912163705_rename_fixtures_to_doubles.rb

@@ -0,0 +1,9 @@
+class RenameFixturesToDoubles < ActiveRecord::Migration
+  def self.up
+    rename_table :fixtures, :doubles
+  end
+
+  def self.down
+    rename_table :doubles, :fixtures
+  end
+end

data/features/doubles_via_api.feature

@@ -0,0 +1,50 @@
+Feature: use doubles via api
+  In order to use double data in integration tests
+  As a developer
+  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 and "<method>" as request method
+    Then there should be 1 double with "<fullpath>" as fullpath, "<content>" as response content and "<result_method>" as request method
+
+    Examples:
+      | fullpath           | content      | method | result_method |
+      | /api/something     | created      | POST   | POST          |
+      | /api/sss           | changed      | PUT    | PUT           |
+      | /api/asdfsf        | removed      | DELETE | DELETE        |
+      | /api/some          | text content | GET    | GET           |
+      | /api/some?a=3&b=dd | more content |        | GET           |
+
+  Scenario Outline: request fullpath that matches double
+    Given there is double with "<fullpath>" as fullpath, "<content>" as response content and "<method>" as request method
+    When I "<method>" "<fullpath>"
+    Then I should get "<content>" in response content
+
+    Examples:
+      | fullpath           | content      | method |
+      | /api/something     | created      | POST   |
+      | /api/sss           | changed      | PUT    |
+      | /api/asdfsf        | removed      | DELETE |
+      | /api/some?a=3&b=dd | more content | GET    |
+
+  # current rule: last added double gets picked
+  Scenario Outline: request fullpath that matches multiple doubles
+    Given there is double with "<fullpath>" as fullpath and "<content>" as response content
+    And there is double with "<fullpath>" as fullpath and "<content2>" as response content
+    When I "GET" "<fullpath>"
+    Then I should get "<content2>" in response content
+
+    Examples:
+      | fullpath           | content      | content2        |
+      | /api/something     | test content | another content |
+      | /api/some?a=3&b=dd | more content | some text       |
+
+  Scenario: request fullpath that does not match any double
+    Given there are no doubles
+    When I "GET" "/api/something"
+    Then I should get 404 in response status
+
+  Scenario: clear doubles
+    Given there are some doubles
+    When I delete all doubles
+    Then there should be no doubles

data/features/doubles_via_ui.feature

@@ -0,0 +1,66 @@
+@ui
+Feature: manage doubles via ui
+  In order to use double data in development
+  As a developer
+  I want to have a manual interface for managing doubles
+
+  Scenario: view existing doubles
+    Given the following doubles exist:
+      | fullpath       | description  | content      |
+      | /url1/aaa | twitter      | test content |
+      | /url2/bbb | geo location | more content |
+      | /u/b?c=1  | wikipedia    | article      |
+    When I visit "doubles" page
+    Then I should see that I am on "doubles" page
+    And I should see existing doubles:
+      | fullpath       | description  |
+      | /url1/aaa | twitter      |
+      | /url2/bbb | geo location |
+      | /u/b?c=1  | wikipedia    |
+
+  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      |
+      | /url2/bb?a=b5 | google api  | test content |
+    And I save it
+    Then I should see "Double created"
+    And I should see existing doubles:
+      | fullpath           | description |
+      | /url2/bb?a=b5 | google api  |
+
+  @javascript
+  Scenario: choose active double
+    Given there are two doubles for the same fullpath
+    When I visit "doubles" page
+    And I make first double active
+    Then first double should be served
+    When I make second double active
+    Then second double should be served
+
+  Scenario: edit double
+    Given the following doubles exist:
+      | fullpath       | description  | content      |
+      | /url1/aaa | twitter      | test content |
+    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 that I am on "doubles" page
+    And I should see existing doubles:
+      | fullpath       | description  |
+      | /url1/aaa | google       |
+
+  @javascript
+  Scenario: delete double
+    Given the following doubles exist:
+      | fullpath        | description | content       |
+      | /url1/aaa  | twitter     | test content  |
+      | /url/cc/bb | google      | other content |
+    And I visit "doubles" page
+    And I choose to delete double with fullpath "/url1/aaa"
+    Then I should be asked to confirm delete
+    And I should see "Double deleted"
+    And I should not see "/url1/aaa"
+    And I should see "/url/cc/bb"

data/features/persistence.feature

@@ -0,0 +1,24 @@
+Feature: Persistence
+  In order to persist fixtrures/redirects between service restarts
+  As a developer
+  I want to be able to specify persistent storage
+
+  Scenario: default storage
+    Given I start service without --database option
+    And I register "/api/something" as fullpath and "content" as response content
+    And I restart service without --database option
+    When I request "/api/something"
+    Then I should get 404 in response status
+
+  Scenario Outline: specify storage
+    Given I start service with --database "<db>" option
+    And I register "/api/something" as fullpath and "content" as response content
+    And I restart service with --database "<db2>" option
+    When I request "/api/something"
+    Then I should get <status> in response status
+
+    Examples:
+      | db               | db2              | status |
+      | database.db      | database.db      | 200    |
+      | /tmp/database.db | /tmp/database.db | 200    |
+      | database.db      | database2.db     | 404    |

data/features/redirect_rules_via_api.feature

@@ -0,0 +1,29 @@
+Feature: manage redirect rules
+  In order to be able to mock only part of api
+  As a developer
+  I want to redirect to real api if there are no doubles for requested fullpath
+
+  Background:
+    Given there are no redirect rules
+    And there are no doubles
+
+  Scenario: no redirect rules
+    When I request "/api/something"
+    Then I should get 404
+
+  Scenario: add redirect rule
+    When I register redirect with pattern "^/api" and uri "http://real.api.co.uk"
+    And I request "/api/something"
+    Then it should redirect to "http://real.api.co.uk/api/something"
+
+  Scenario: add second redirect that match the same request
+    When I register redirect with pattern "/api/something" and uri "http://real.api.co.uk"
+    And I register redirect with pattern "/api/some.*" and uri "http://real.com"
+    And I request "/api/something"
+    Then it should redirect to "http://real.api.co.uk/api/something"
+
+  Scenario: add second redirect that does not match the same request
+    When I register redirect with pattern "/api/something" and uri "http://real.api.co.uk"
+    And I register redirect with pattern "/api/some" and uri "http://real.com"
+    And I request "/api/someth"
+    Then it should redirect to "http://real.com/api/someth"