scenario_server 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32223f4ed5f4ad3533cbe09c0ca063bc7be5b742
-  data.tar.gz: 4eda56538b588ac35b3ae8e34ea1a406929fdd56
+  metadata.gz: a2d129f756b4fd46d7b76c1e9c4da719f8b54d60
+  data.tar.gz: 86ccf9bc6aef34399203dd7b4d4b509e1a78d5fb
 SHA512:
-  metadata.gz: ffe3f0ee56ee992479356a51f179b802c71490878cf3ff74bc85c250651ad4ac1a67b057a0a49db14d18c5a49755329f09394ab08c5e08947c901512eea607ae
-  data.tar.gz: 84097547730134d05eeb210b75f08bb607dddefab908ecf044a6223da07dcb59c3d6059be414ee41c019c13943e5ab72055e56bfe77634273d9a1042d8ce0550
+  metadata.gz: 67f361fc85f467f9ca87090dee26eaccc747a14b54b639c7a7ea406612403805338226f5a4698c4b90258c90a27869d65b714dd491485f39e4053515b299ac85
+  data.tar.gz: 8bb363a05b863f1cbf27a2341a0382600ed80e8a97a075ea2a2ed372708eabb28db66bbb75ac7c3e949a14a10ff91079188debd23ae2229ebcc27288ad0657ab

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scenario_server (0.0.5)
+    scenario_server (0.1.1)
       daemons (~> 1.1)
       sequel (= 4.7)
       sinatra (~> 1.4)
@@ -11,29 +11,29 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    backports (3.6.0)
+    backports (3.6.4)
     daemons (1.1.9)
     diff-lcs (1.2.5)
-    json_spec (1.1.1)
+    json_spec (1.1.4)
       multi_json (~> 1.0)
-      rspec (~> 2.0)
-    multi_json (1.8.4)
-    rack (1.5.2)
-    rack-protection (1.5.2)
+      rspec (>= 2.0, < 4.0)
+    multi_json (1.10.1)
+    rack (1.6.0)
+    rack-protection (1.5.3)
       rack
-    rack-test (0.6.2)
+    rack-test (0.6.3)
       rack (>= 1.0)
-    rake (10.1.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.5)
+    rake (10.4.2)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.5)
+    rspec-mocks (2.99.3)
     sequel (4.7.0)
-    sinatra (1.4.4)
+    sinatra (1.4.5)
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
@@ -44,7 +44,7 @@ GEM
       rack-test
       sinatra (~> 1.4.0)
       tilt (~> 1.3)
-    sqlite3 (1.3.8)
+    sqlite3 (1.3.10)
     tilt (1.4.1)
 
 PLATFORMS

data/README.md

@@ -1,59 +1,95 @@
 # Scenarios
 
-This gem is used to setup a quick local server using sinatra
+This gem can be used to setup a quick local api server.
 
-As the server is started for the first time, point your browser to http://localhost:4567/scenarios  
-Here a "default" scenario is present. You can add various routes to this scenario.
+## Installation
 
-for e.g. a sample route added would be
-GET , '/v1/season' {"temperature":"cold"}
+Add this line to your application's Gemfile:
 
-Now when you make a get request, e.g.  
-curl -i http://localhost:9000/v1/season
-you will receive the json fixture added for that route.  
+    gem 'scenario_server'
 
-Working with Scenarios :
+Or manually install it:
 
-This server also lets you add different scenarios and lets you add a different response {"temperature":"warm"} for the same api endpoint under different scenario. e.g. march
+    $ gem install scenario_server
 
-When you make a get request and then specify header SCENE with value as your scenario name, the response under that scenario would be returned.
-e.g.
-curl -i -H "SCENE:march" http://localhost:9000/v1/season
+## Configuration
 
-If you make a get request that is not defined for a particular scenario but is defined in the default scenario, then the response from the default scenario would be returned.
+A yaml file when provided at the following location
+> ~/.scenarios/config.yml
 
-## Installation
+can be used to define the port and path of the sqlite database holding the routes.
+If this file is not provided, the db file is created wherever the ruby gem is installed.
 
-Add this line to your application's Gemfile:
+#### Config.yml
+>localport: 4567
+>localdbfile: /Users/vaibhav/.scenarios/scenarios.sqlite3
 
-    gem 'scenario_server'
+## Usage
+
+The server can be started in daemon mode by
 
-And then execute:
+    scenario_service  start
 
-    $ bundle
+or without a daemon mode
 
-Or install it yourself as:
+    scenario_service start -t
 
-    $ gem install scenario_server
+### What are Scenarios
+Scenarios is a context in which you are using your local api server. Each scenario contains one or more routes.
 
-## Usage
+e.g.
+1. Default
+  * GET , '/v1/season', 200, {"name":"summer","temperature":70}
+  * GET , '/v1/city' , 200, {"name":"Seattle"}
+1. Rainy
+  * GET , '/v1/season', 200, {"name":"rainy","temperature":50,"precipitation":5}
+1. Error
+  * GET , '/v1/season', 404, {"error":"sensors not found"}
+  * GET , '/v1/city' , 500, {"error":"server error"}
+
+Scenarios are usually broken up as:
+* For handling most common api response: 'Default' Scenario server comes with the server and this cannot be deleted.
+* For handling alternate api response e.g. 'Rainy' with precipitation information in our current example
+* For handling error responses e.g. 'error'
+
+On startup, all responses returned from the server are from default scenario.
+
+### To fetch data from routes
+
+Make a request with scenario server url and path of the route with the correct request type. Also specify header **SCENE** with your scenario name,
+This will return the fixture under that scenario, with status code and headers specified
+e.g.
 
-The server can be started in daemon mode by
+    curl -X GET -H "SCENE:rainy" http://localhost:4567/v1/season
 
-scenario_service  start
+If the header **SCENE** is not present, the current scenario set on the server would be used.
 
-or
+will return
+` {"name":"rainy","temperature":50,"precipitation":5} `
 
-without a daemon mode
+### To list all scenarios
+    curl http://localhost:4567/scenarios
+  or point the browser to http://localhost:4567/scenarios
 
-scenario_service start -T
+### To check the current scenario
+    curl http://localhost:4567/scenario
+  or point the browser to http://localhost:4567/scenario
 
-## Configuration
+### To change the current scenario from 'default' to 'rainy'
+    curl -X PUT  http://localhost:4567/scenario/rainy -d ''
+
+Note: If you are not in 'default' scenario and make a call to a route which is not defined, server will also check 'default' for that route. If present, it will return data from that route else will give a 404.
+
+### To add a new scenario 'winter'
+    curl -X POST  http://localhost:4567/scenarios/new -d 'winter'
+or point the browser to http://localhost:4567/scenarios and add name in the text box below **New scenario** and then click **submit**.
+
+### To delete scenario 'winter'
+Given that winter scenario has an id **3**
+
+      curl -X DELETE  http://localhost:4567/scenarios/3
 
-a yaml file can be provided at the following location
-~/.scenarios/config.yml
-to hold the port to be used and the path of a sqlite database.
-If this file is not provided, the db file is created inside the
-gem folder.
+### To get all routes from 'rainy' scenario
+Given that 'rainy' scenario has an id **2**
 
-Please see sample_config.yml for more info.
+      curl http://localhost:4567/scenarios/2/routes

data/lib/scenarios/application/app.rb

@@ -12,7 +12,7 @@ class ScenarioServer < Sinatra::Base
   register Sinatra::ConfigFile
   use Rack::MethodOverride
 
-	configure :production do
+  configure :production do
     puts 'Production Environment'
     config_file File.expand_path('~/.scenarios') + '/config.yml'
     set :db_file , File.dirname(File.expand_path(__FILE__)) + '/../data/scenario_db.sqlite3'
@@ -88,7 +88,7 @@ class ScenarioServer < Sinatra::Base
     selected_scenario = self.scenario_db.get_scenario_for_id(params[:scenario_id])
     routes = self.scenario_db.get_routes_for_scenario(params[:scenario_id])
     
-		if (request.env['HTTP_ACCEPT'] && request.env['HTTP_ACCEPT'].include?('text/html'))
+    if (request.env['HTTP_ACCEPT'] && request.env['HTTP_ACCEPT'].include?('text/html'))
       if params.has_key?('error')
         erb :'scenario', :locals => {'scenario'=>selected_scenario, 'routes'=>routes, 'error'=>params['error']}
       else
@@ -132,10 +132,10 @@ class ScenarioServer < Sinatra::Base
       if valid_fixture
         self.scenario_db.add_route_for_scenario(params['route_type'],
                                                 params['path'], 
-																								params['status_code'],
-																								params['headers'],
-																								params['fixture'], 
-																								params[:scenario_id])
+                                                params['status_code'],
+                                                params['headers'],
+                                                params['fixture'], 
+                                                params[:scenario_id])
         redirect('/scenarios/'+params[:scenario_id])
       else
         redirect('/scenarios/'+params[:scenario_id]+'?error=invalid%20json')
@@ -145,10 +145,10 @@ class ScenarioServer < Sinatra::Base
       json_body = JSON.parse(request.body.read)
       route_id = self.scenario_db.add_route_for_scenario(json_body['route_type'],
                                                          json_body['path'],
-																												 json_body['status_code'],
-																												 json_body['headers'], 
-																												 json_body['fixture'], 
-																												 params[:scenario_id])
+                                                         json_body['status_code'],
+                                                         json_body['headers'], 
+                                                         json_body['fixture'], 
+                                                         params[:scenario_id])
       content = {'url'=>'/scenarios/'+params[:scenario_id]+'/routes/'+route_id.to_s}.to_json
       [200, content]
     end
@@ -212,32 +212,32 @@ class ScenarioServer < Sinatra::Base
   end
 
   # route path calls
-  get '/*' do		
-		#TODO: Validate scene from the list of scenarios
-		ordered_scenarios = self.scenario_db.get_ordered_scenarios
+  get '/*' do
+    #TODO: Validate scene from the list of scenarios
+    ordered_scenarios = self.scenario_db.get_ordered_scenarios
 
 
-		#TODO: dry up the implementation 
-		#TODO: add ignore scene header 
-		current_scenario = settings.scenario 
+    #TODO: dry up the implementation 
+    #TODO: add ignore scene header 
+    current_scenario = settings.scenario 
     if (request.env['HTTP_SCENE'])
-			current_scenario = request.env['HTTP_SCENE']
-		end
+      current_scenario = request.env['HTTP_SCENE']
+    end
 
     route_type  = request.request_method.upcase
     path   = request.path.downcase
 
     status_code, header, fixture = get_fixture(route_type, path, current_scenario)
     if header.nil? || header == ""
-			header = {'Content-Type' => 'application/json'}
-		else
-			header = eval(header)			
-		end 
+      header = {'Content-Type' => 'application/json'}
+    else
+      header = eval(header)
+    end 
 
-		if fixture.nil?
+    if fixture.nil?
       404
     else
-		  status status_code
+      status status_code
       headers header
       body fixture
     end
@@ -249,10 +249,10 @@ class ScenarioServer < Sinatra::Base
     route_type  = request.request_method.upcase
     path    = request.path.downcase
 
-		current_scenario = settings.scenario 
+    current_scenario = settings.scenario 
     if (request.env['HTTP_SCENE'])
-			current_scenario = request.env['HTTP_SCENE']
-		end
+      current_scenario = request.env['HTTP_SCENE']
+    end
 
     status_code, header, fixture = get_fixture(route_type, path, current_scenario)
     if fixture.nil?
@@ -268,10 +268,10 @@ class ScenarioServer < Sinatra::Base
     route_type  = request.request_method.upcase
     path   = request.path.downcase
 
-		current_scenario = settings.scenario 
+    current_scenario = settings.scenario 
     if (request.env['HTTP_SCENE'])
-			current_scenario = request.env['HTTP_SCENE']
-		end
+      current_scenario = request.env['HTTP_SCENE']
+    end
 
     status_code, header, fixture = get_fixture(route_type, path, current_scenario)
     if fixture.nil?
@@ -289,10 +289,10 @@ class ScenarioServer < Sinatra::Base
     route_type  = request.request_method.upcase
     path    = request.path.downcase
 
-		current_scenario = settings.scenario 
+    current_scenario = settings.scenario 
     if (request.env['HTTP_SCENE'])
-			current_scenario = request.env['HTTP_SCENE']
-		end
+      current_scenario = request.env['HTTP_SCENE']
+    end
 
     status_code, header, fixture = get_fixture(route_type, path, current_scenario)
     if fixture.nil?

data/lib/scenarios/scenario_db.rb

@@ -236,9 +236,8 @@ class ScenarioDB
   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([:status_code, :headers, :fixture]).first
+    self.routes.left_outer_join(:scenarios, 
+																:id=>:scenario_id).where{Sequel.&({:route_type => route_type, :name=>scenario_name}, Sequel.ilike(:path,path))}.map([:status_code,:headers,:fixture]).first
 
   end
 

data/lib/scenarios/version.rb

@@ -1,3 +1,3 @@
 module Scenarios
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scenario_server
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Vaibhav Bhatia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-11 00:00:00.000000000 Z
+date: 2015-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra