scenario_server 0.0.1

data/lib/scenarios/scenario_db.rb

@@ -0,0 +1,283 @@
+#!/usr/env ruby
+require 'fileutils'
+require 'sequel'
+require 'sequel/extensions/pretty_table'
+
+class ScenarioDB
+
+  attr_accessor :db, :db_file, :scenarios, :routes, :testdata
+
+  def initialize(options={})
+    if options[:db_file]
+      self.db_file = options[:db_file]
+    else
+      self.db_file = File.dirname(File.expand_path(__FILE__)) + '/data/scenario_db.sqlite3'
+    end
+
+    handle_cli_options(options)
+  end
+
+  def handle_cli_options(options)
+    if options[:setup]
+
+      configure_database
+      puts 'database setup complete.'
+    end
+
+    if !options[:add_scenario].nil? && options[:add_scenario].length == 1
+      configure_database
+
+      add_scenario(options[:add_scenario][0])
+      if self.scenarios.count > 0
+        Sequel::PrettyTable.print(self.scenarios)
+      else
+        puts 'No records to display.'
+      end
+    end
+
+    if !options[:delete_scenario].nil?
+      configure_database
+
+      delete_scenario(options[:delete_scenario])
+      if self.db[:scenarios].count > 0
+        Sequel::PrettyTable.print(self.db[:scenarios])
+      else
+        puts 'No records to display.'
+      end
+    end
+
+    if !options[:add_route].nil? && options[:add_route].length == 4
+      configure_database
+
+      add_route_for_scenario(options[:add_route][0], options[:add_route][1], options[:add_route][2], options[:add_route][3])
+      if self.routes.count > 0
+        Sequel::PrettyTable.print(self.routes)
+      else
+        puts 'No records to display.'
+      end
+    end
+
+    if !options[:delete_route].nil?
+      configure_database
+
+      delete_route(options[:delete_route])
+      if self.db[:routes].count > 0
+        Sequel::PrettyTable.print(self.routes)
+      else
+        puts 'No records to display.'
+      end
+    end
+
+    if !options[:add_testdata].nil? && options[:add_testdata].length == 3
+      configure_database
+
+      add_testdata_for_scenario(options[:add_testdata][0], options[:add_testdata][1], options[:add_testdata][2])
+      if self.testdata.count > 0
+        Sequel::PrettyTable.print(self.testdata)
+      else
+        puts 'No records to display.'
+      end
+    end
+
+    if !options[:delete_testdata].nil?
+      configure_database
+
+      delete_route(options[:delete_testdata])
+      if self.testdata.count > 0
+        Sequel::PrettyTable.print(self.testdata)
+      else
+        puts 'No records to display.'
+      end
+    end
+
+    if options[:scenarios]
+      configure_database
+
+      if self.scenarios.count > 0
+        Sequel::PrettyTable.print(self.scenarios)
+      else
+        puts 'No records to display.'
+      end
+    end
+
+    if options[:routes]
+      configure_database
+
+      if self.routes.count > 0
+        Sequel::PrettyTable.print(self.routes)
+      else
+        puts 'No records to display.'
+      end
+    end
+
+    if options[:testdata]
+      configure_database
+
+      if self.testdata.count > 0
+        Sequel::PrettyTable.print(self.testdata)
+      else
+        puts 'No records to display.'
+      end
+    end
+  end
+
+  def configure_database
+    setup_database
+    open_database
+    create_scenarios_table
+    create_routes_table
+    create_testdata_table
+  end
+
+  def setup_database
+    # Create an empty database file
+    if !File.exists?(self.db_file)
+      puts self.db_file
+      File.open(self.db_file, 'w'){}
+    end
+  end
+
+  def open_database
+    # Open the database
+    self.db ||= Sequel.sqlite(self.db_file)
+    self.scenarios ||= self.db[:scenarios]
+    self.routes ||= self.db[:routes]
+    self.testdata ||= self.db[:testdata]
+  end
+
+  #scenarios
+
+  def create_scenarios_table
+    # Create Scenarios table
+    if !self.db.table_exists?(:scenarios)
+#      puts "Creating the scenarios table"
+      self.db.create_table :scenarios do
+        primary_key :id
+        String :name
+        DateTime :created_at
+        DateTime :updated_at
+      end
+    end
+  end
+
+  def add_scenario(name)
+    if self.scenarios.where(:name => name).to_a.count == 0
+      now = DateTime.now
+      self.scenarios.insert(:name => name, :created_at => now, :updated_at => now)
+    end
+  end
+
+  def delete_scenario(scenario_id)
+    self.scenarios.filter(:id => scenario_id).delete
+  end
+
+  def reset_scenarios
+    self.scenarios.delete
+    create_scenarios_table
+  end
+
+  def get_ordered_scenarios
+    return self.scenarios.order(:name).select(:id, :name).to_a
+  end
+
+  def get_scenario_names
+    return self.scenarios.map(:name)
+  end
+
+  def delete_scenario_for_id(scenario_id)
+    self.scenarios.filter(:id => scenario_id).delete
+  end
+
+  def get_scenario_for_id(scenario_id)
+    return self.scenarios.where(:id => scenario_id).first
+  end
+
+  def get_last_scenario_id
+    return self.scenarios.reverse_order(:id).first[:id]
+  end
+
+#routes
+
+  def create_routes_table
+    # Create the routes table
+    if !self.db.table_exists?(:routes)
+#      puts "Creating the routes table"
+      self.db.create_table :routes do
+        primary_key :id
+        foreign_key :scenario_id, :scenarios, :on_delete => :cascade, :on_update => :cascade
+        String :route_type
+        String :path
+        String :fixture
+        DateTime :created_at
+        DateTime :updated_at
+      end
+    end
+  end
+
+  def add_route_for_scenario(route_type, path, fixture, scenario_id)
+    now = DateTime.now
+    if self.routes.where(:scenario_id => scenario_id, route_type=> route_type, path=> path).to_a.count == 0
+      self.routes.insert(:scenario_id => scenario_id, :route_type=>route_type, :path => path, :fixture => fixture, :created_at => now, :updated_at => now)
+    end
+#    puts "<scenario_id: #{scenario_id} #{}route_type} #Path: #{path} fixture: #{fixture}>"
+  end
+
+  def delete_route(route_id)
+    self.routes.filter(:id => route_id).delete
+  end
+
+  def get_routes_for_scenario(scenario_id)
+    return self.routes.filter(:scenario_id=>scenario_id).select(:id, :scenario_id,:route_type,:path,:fixture).to_a
+  end
+
+  def get_fixture_from_routes(route_type, path, scenario_name)
+
+    self.routes.left_outer_join(:scenarios, :id=>:scenario_id).where(:route_type=>route_type,
+                                                                          :path=>path,
+                                                                          :name=>scenario_name).map(:fixture).first
+
+
+    #TODO instead of returning first fixture, add checks to avoid duplicate insertions
+  end
+
+  def get_route(route_id)
+    return self.routes.where(:id => route_id).first
+  end
+
+  def get_last_routes_id
+    return self.routes.reverse_order(:id).first[:id]
+  end
+
+
+  #testdata
+
+  def create_testdata_table
+    # Create the testdata table
+    if !self.db.table_exists?(:testdata)
+#      puts 'Creating the testdata table'
+      self.db.create_table :testdata do
+        primary_key :id
+        foreign_key :scenario_id, :scenarios, :on_delete => :cascade, :on_update => :cascade
+        String :name
+        String :value
+        DateTime :created_at
+        DateTime :updated_at
+      end
+    end
+  end
+
+  def add_testdata_for_scenario(name, value, scenario_id)
+    now = DateTime.now
+    self.testdata.insert(:name=>name, :value=>value,  :scenario_id => scenario_id, :created_at => now, :updated_at => now)
+#    puts "<#Name: #{name} value: #{value} scenario_id: #{scenario_id}>"
+  end
+
+  def delete_testdata_for_scenario(testdata_id)
+    self.testdata.filter(:id=>testdata_id).delete
+  end
+
+  def get_last_testdata_id
+    return self.testdata.reverse_order(:id).first[:id]
+  end
+
+end

data/lib/scenarios/version.rb

@@ -0,0 +1,3 @@
+module Scenarios
+  VERSION = "0.0.1"
+end

data/lib/scenarios.rb

@@ -0,0 +1,5 @@
+require "scenarios/version"
+
+module Scenarios
+  # Your code goes here...
+end

data/scenarios.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scenarios/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scenario_server"
+  spec.version       = Scenarios::VERSION
+  spec.authors       = ["Vaibhav Bhatia"]
+  spec.email         = ["vaikings@gmail.com"]
+  spec.summary       = %q{Scenarios is a sinatra server which returns mock json fixtures for routes in the current scenario}
+  spec.description   = %q{This gem is useful for development where a mock rest api server is required and with frank UI test automation.}
+  spec.homepage      = 'https://bitbucket.org/vaikings/scenarios'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "sinatra", "~> 1.4"
+  spec.add_runtime_dependency "sinatra-contrib", "~> 1.4"
+  spec.add_runtime_dependency "sequel", "4.7"
+
+  spec.add_development_dependency "sqlite3" , "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+  spec.add_development_dependency "rspec", "~> 2.0"
+  spec.add_development_dependency "json_spec", "~> 1.1"
+  
+end

data/spec/app_spec.rb

@@ -0,0 +1,149 @@
+require './spec/spec_helper'
+require './lib/scenarios/application/app'
+require './lib/scenarios/scenario_db'
+
+
+describe "scenario api" do
+
+  attr_accessor :scenario_db
+
+  before(:all) do
+    options = {:db_file=>File.dirname(File.expand_path(__FILE__)) + '/../lib/scenarios/data/scenario_testdb.sqlite3'}
+    self.scenario_db = ScenarioDB.new(options)
+    self.scenario_db.configure_database()
+
+  end
+
+  def app
+    ScenarioServer
+  end
+
+  before(:each) do
+    reset_scenario
+  end
+
+  it "GET /scenario" do
+    get '/scenario'
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq("default")
+  end
+
+  it "PUT /scenario/:name" do
+    put '/scenario/test'
+
+    expect(last_response.status).to eq(400)
+    expect(scenario).to eq("default")
+  end
+
+  it "PUT /scenario/:name" do
+    self.scenario_db.add_scenario('test')
+
+    put '/scenario/test'
+
+    expect(last_response.status).to eq(200)
+    expect(scenario).to eq("test")
+  end
+
+  it "DELETE /scenario" do
+    delete "/scenario"
+
+    expect(last_response.status).to eq(200)
+    expect(scenario).to eq("default")
+  end
+
+end
+
+describe "scenarios and routes REST api" do
+
+  def app
+    ScenarioServer
+  end
+
+  attr_accessor :scenario_db
+
+  before(:all) do
+    options = {:db_file=>File.dirname(File.expand_path(__FILE__)) + '/../lib/scenarios/data/scenario_testdb.sqlite3'}
+    self.scenario_db = ScenarioDB.new(options)
+    self.scenario_db.configure_database()
+
+  end
+
+  before(:each) do
+    self.scenario_db.reset_scenarios
+    scenario_id = self.scenario_db.add_scenario("default")
+    route_id = self.scenario_db.add_route_for_scenario('GET', '/hello', {"hello"=>"world"}.to_json, scenario_id)
+  end
+
+  #specs
+
+  it 'GET /scenarios' do
+    get '/scenarios'
+    expect(last_response.status).to eq(200)
+    file_data = parse_json(load_json('all_scenarios.json'))
+
+    last_response.body.should be_json_eql(load_json('all_scenarios.json')).excluding("id")
+  end
+
+  it 'GET /scenarios/{scenario_id}' do
+    last_scenario_id = self.scenario_db.get_last_scenario_id
+
+    get '/scenarios/'+last_scenario_id.to_s
+
+    expect(last_response.status).to eq(200)
+    last_response.body.should be_json_eql(load_json("default_scenario.json")).excluding("id")
+  end
+
+  it "POST /scenarios/new" do
+    post '/scenarios/new',"default",{}
+
+    expect(last_response.status).to eq(200)
+    last_response.body.should have_json_path("url")
+
+  end
+
+  it 'DELETE /scenarios/:scenario_id' do
+    last_scenario_id = self.scenario_db.get_last_scenario_id
+
+    delete '/scenarios/'+last_scenario_id.to_s
+    expect(last_response.status).to eq(200)
+  end
+
+  it 'POST /scenarios/:scenario_id/routes/new' do
+    last_scenario_id = self.scenario_db.get_last_scenario_id
+
+    content = '{"path":"/v1/mystyle","fixture":"{\"json\":\"body\"}","route_type":"GET" }'
+    path = '/scenarios/'+last_scenario_id.to_s + '/routes/new'
+    post path, content, {}
+
+    expect(last_response.status).to eq(200)
+    last_response.body.should have_json_path('url')
+  end
+
+  it 'GET /scenarios/:scenario_id/routes' do
+    last_scenario_id = self.scenario_db.get_last_scenario_id
+
+    get '/scenarios/'+last_scenario_id.to_s+'/routes'
+
+    expect(last_response.status).to eq(200)
+    last_response.body.should have_json_path('routes')
+  end
+
+  it 'DELETE /scenarios/:scenario_id/routes/:route_id' do
+    last_scenario_id = self.scenario_db.get_last_scenario_id
+    last_route_id = self.scenario_db.get_last_routes_id
+
+    delete '/scenarios/'+last_scenario_id.to_s+'/routes/'+last_route_id.to_s
+    expect(last_response.status).to eq(200)
+
+  end
+
+  it 'GET /scenarios/:scenario_id/routes/:route_id' do
+    last_scenario_id = self.scenario_db.get_last_scenario_id
+    last_route_id = self.scenario_db.get_last_routes_id
+
+    get '/scenarios/'+last_scenario_id.to_s+'/routes/'+last_route_id.to_s
+    expect(last_response.status).to eq(200)
+  end
+
+end 

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+ENV["RACK_ENV"] = "test"
+
+require 'rspec'
+require 'rspec/expectations'
+require 'rack/test'
+require 'json_spec'
+
+JsonSpec.directory ="./fixtures/"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  #include Rack::Test::Methods by default
+  config.include Rack::Test::Methods
+  config.include JsonSpec::Helpers
+end
+
+
+# helper methods
+
+def scenario
+  get '/scenario'
+  last_response.body
+end
+
+def reset_scenario
+  delete "/scenario"
+  expect(last_response.status).to eq(200)
+end
+
+def set_scenario(name)
+  put "/scenario/#{name}"
+  expect(last_response.status).to eq(200)
+end