holoserve 0.1.1 → 0.2.0

data/README.rdoc

@@ -7,12 +7,13 @@ run faster and be independent from other API and network problems.
 == Concept
 
 HoloServe runs a rack application server, that matches any incoming request to a list of request profiles defined in
-the server layout. If a match is found, the defined static response is returned. The name of the matched
-request/response pair is saved in a request history. If no match is found, a 404 is returned and the
-request data is stored in the bucket for unhandeled requests. These informations can be used to extend the server layout
-with missing request handlers.
+the server layout. If a match is found, the defined static response is returned. The response is defined by a default
+and the current server situation.
+The name of the matched request/response pair is saved in a request history. If no match is found, a 404 is returned and
+the request data is stored in the bucket for unhandeled requests. These informations can be used to extend the server
+layout with missing request handlers.
 
-Layouts, history and bucket can be accessed via control routes, which are described below.
+The layout, situation, history and bucket can be accessed via control routes, which are described below.
 
 == Installation
 
@@ -26,43 +27,40 @@ To start up an empty Holoserve instance, type...
 
   holoserve
 
-To load and select a server layout during start up, you can provide some parameters.
+To load a server layout and define a situation during start up, use these parameters.
 
-  holoserve -f layouts.yml -l backend
+  holoserve -l layouts.yml -s backend_without_users
 
 == Control routes
 
 If you're using Ruby, you can control Holoserve via the
 {Holoserve Connector}[https://github.com/skrill/holoserve-connector] gem.
 
-=== POST /_control/layouts
+=== POST /_control/layout.:format
 
-It should receive a parameter named <tt>file</tt> that contains an uploaded YML file with the server layouts. See
-{YML server layouts file format}[rdoc-label:YML-server-layouts-file-format] below.
+It should receive a parameter named <tt>file</tt> that contains a file with the server layout. The format of the file
+should fit the specified format. The format can be <tt>yaml</tt> or <tt>json</tt>. See
+{Layout file format}[rdoc-label:Layout-file-format] below.
 
-=== DELETE /_control/layouts
+=== GET /_control/layout.:format
 
-Removes all server layouts.
+Returns the server layout in the requested format.
 
-=== GET /_control/layouts/ids
+=== DELETE /_control/layout
 
-Returns the list of ids of all server layouts.
+Removes the server layout.
 
-==== Response example
-
-  [ "one", "two" ]
+=== PUT /_control/situation/:name
 
-=== PUT /_control/layouts/:id/current
+Sets the current situation.
 
-Makes the layout with id <tt>:id</tt> the currently active one.
+=== GET /_control/situation
 
-=== GET /_control/layouts/current
-
-Returns the id of the current layout.
+Returns the name of the current situation.
 
 ==== Response example
 
-  one
+  backend_without_users
 
 === GET /_control/bucket/requests
 
@@ -106,40 +104,42 @@ Returns a list of all names of pairs that has been triggered.
 
 Removes all entries from the history.
 
-== YML server layouts file format
-
-The server layouts file should have the following format.
-
-  one:
-    -
-      name: "test_received"
-      request:
-        method: "POST"
-        path: "/test"
-        headers:
-          HTTP_USER_AGENT: "Ruby"
-          HTTP_AUTHORIZATION: "OAuth oauth_token=12345"
-        body:
-          "test=value"
-        parameters:
-          test: "value"
-        oauth:
-          oauth_token: "12345"
-      response:
+== Layout file format
+
+The server layout file should have the following format.
+
+  -
+    name: "test_received"
+    request:
+      method: "POST"
+      path: "/test"
+      headers:
+        HTTP_USER_AGENT: "Ruby"
+        HTTP_AUTHORIZATION: "OAuth oauth_token=12345"
+      body:
+        "test=value"
+      parameters:
+        test: "value"
+      oauth:
+        oauth_token: "12345"
+    responses:
+      default:
         status: 200
+      one:
         body:
           "ok"
-    -
-      request:
-        method: "GET"
-        path: "/test"
-      response:
+  -
+    request:
+      method: "GET"
+      path: "/test"
+    responses:
+      default:
         status: 200
         body:
           "ok too"
 
-This example would define a server layout named <tt>one</tt> that has two request/response pairs. The first pair would
-have the name <tt>test_received</tt> and would match a <tt>POST</tt> request to the path <tt>/test</tt>.
+This example would define a server layout that has two request/response pairs. The first pair would have the name
+<tt>test_received</tt> and would match a <tt>POST</tt> request to the path <tt>/test</tt>.
 
 Notice, that the given request attributes are the _minimal_ values that have to match the incomong one. An incoming
 request may has much more attributes (see bucket example above). If a request is matched, the corresponding pair name is
@@ -148,3 +148,6 @@ placed in the history.
 As the sections <tt>headers</tt> and <tt>body</tt> are raw values from the request, the sections <tt>parameters</tt> and
 <tt>oauth</tt> contain high-level values. The <tt>parameters</tt> hash is taken from the request body or the query and
 the hash containing the OAuth values is parsed from a fitting <tt>HTTP_AUTHORIZATION</tt> header.
+
+The response is defined in the <tt>responses</tt> section of each pair. The server will response a merge of default
+response and the response defined by the current situation.

data/Rakefile

@@ -27,6 +27,13 @@ begin
 rescue LoadError
 end
 
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError
+end
+
 begin
   require 'rdoc'
   require 'rdoc/task'

data/bin/holoserve

@@ -14,11 +14,11 @@ OptionParser.new do |parser|
   parser.on("-p", "--port PORT", Integer, "The port holoserve should listen to.") do |value|
     options[:port] = value
   end
-  parser.on("-f", "--layouts-file FILE", "Load the specified layouts file on startup.") do |value|
-    options[:layouts_filename] = value
+  parser.on("-l", "--layout-file FILE", "Load the specified layout file on startup.") do |value|
+    options[:layout_filename] = value
   end
-  parser.on("-l", "--layout LAYOUT", "Selects the specified layout as the current one.") do |value|
-    options[:layout] = value
+  parser.on("-s", "--situation SITUATION", "Sets the situation.") do |value|
+    options[:situation] = value
   end
   parser.on_tail("-h", "--help", "Shows the help message.") do
     puts parser

data/lib/holoserve/configuration.rb

@@ -2,47 +2,44 @@ require 'yaml'
 
 class Holoserve::Configuration
 
+  class InvalidFormatError < StandardError; end
+
   attr_reader :logger
 
-  attr_reader :layouts
-  attr_reader :layout_id
+  attr_reader :layout
+  attr_reader :situation
 
   def initialize(logger)
     @logger = logger
   end
 
-  def layouts=(hash)
-    @layouts = Holoserve::Tool::Hash::KeySymbolizer.new(hash).hash
-  end
-
-  def layout_id=(value)
-    @layout_id = value.to_sym
-    logger.info "made '#{value}' the current layout"
+  def layout=(hash_or_array)
+    @layout = Holoserve::Tool::Hash::KeySymbolizer.new(hash_or_array).hash
   end
 
-  def clear_layouts!
-    self.layouts = nil
+  def situation=(value)
+    @situation = value.to_sym
+    logger.info "made '#{value}' the current situation"
   end
 
-  def layout_ids
-    self.layouts ? self.layouts.keys : [ ]
+  def clear_layout!
+    self.layout = nil
   end
 
-  def layout_id?(id)
-    self.layout_ids.include? id.to_sym
-  end
-
-  def layout
-    self.layouts ? self.layouts[self.layout_id] : nil
+  def load_layout_from_yaml_file(file)
+    self.layout = YAML::load_file file
+    logger.info "loaded layouts from yaml file #{file.path}"
+  rescue Psych::SyntaxError => error
+    self.clear_layout!
+    raise InvalidFormatError, error.to_s
   end
 
-  def load_layouts_from_yml_file(file)
-    self.layouts = YAML::load_file file
-    logger.info "loaded layouts from file #{file.path}"
-    logger.info "available layout(s): #{self.layout_ids.join(", ")}"
-  rescue Psych::SyntaxError => error
-    self.clear_layouts!
-    raise error
+  def load_layout_from_json_file(file)
+    self.layout = JSON.parse File.read(file)
+    logger.info "loaded layouts from json file #{file.path}"
+  rescue JSON::ParserError => error
+    self.clear_layout!
+    raise InvalidFormatError, error.to_s
   end
 
 end

data/lib/holoserve/interface/control.rb

@@ -4,35 +4,47 @@ require 'json'
 
 class Holoserve::Interface::Control < Sinatra::Base
 
-  post "/_control/layouts" do
+  mime_type :yaml, "application/x-yaml"
+  mime_type :json, "application/json"
+
+  post "/_control/layout.:format" do |format|
     begin
-      configuration.load_layouts_from_yml_file params["file"][:tempfile]
-      respond_json_acknowledgement
-    rescue Psych::SyntaxError => error
+      if format == "yaml"
+        configuration.load_layout_from_yaml_file params["file"][:tempfile]
+        respond_json_acknowledgement
+      elsif format == "json"
+        configuration.load_layout_from_json_file params["file"][:tempfile]
+        respond_json_acknowledgement
+      else
+        not_acceptable
+      end
+    rescue Holoserve::Configuration::InvalidFormatError => error
       error 400, error.inspect
     end
   end
 
-  delete "/_control/layouts" do
-    configuration.clear_layouts!
-    respond_json_acknowledgement
+  get "/_control/layout.:format" do |format|
+    if format == "yaml"
+      respond_yaml configuration.layout
+    elsif format == "json"
+      respond_json configuration.layout
+    else
+      not_acceptable
+    end
   end
 
-  get "/_control/layouts/ids" do
-    respond_json configuration.layout_ids
+  delete "/_control/layout" do
+    configuration.clear_layout!
+    respond_json_acknowledgement
   end
 
-  put "/_control/layouts/:id/current" do |id|
-    if configuration.layout_id?(id)
-      configuration.layout_id = id
-      respond_json_acknowledgement
-    else
-      not_found
-    end
+  put "/_control/situation/:name" do |situation|
+    configuration.situation = situation
+    respond_json_acknowledgement
   end
 
-  get "/_control/layouts/current" do
-    configuration.layout_id.to_s
+  get "/_control/situation" do
+    configuration.situation.to_s
   end
 
   get "/_control/bucket/requests" do
@@ -55,10 +67,19 @@ class Holoserve::Interface::Control < Sinatra::Base
   end
 
   def respond_json(object)
-    content_type "application/json"
+    content_type :json
     JSON.dump object
   end
 
+  def respond_yaml(object)
+    content_type :yaml
+    object.to_yaml
+  end
+
+  def not_acceptable
+    [ 406, { }, [ "format not acceptable" ] ]
+  end
+
   def bucket
     Holoserve.instance.bucket
   end

data/lib/holoserve/interface/fake.rb

@@ -10,7 +10,14 @@ class Holoserve::Interface::Fake
         history.pair_names << name
         logger.info "received handled request with name '#{name}'"
       end
-      Holoserve::Response::Composer.new(pair[:response]).response_array
+      responses = pair[:responses]
+      response = Holoserve::Tool::Merger.new(responses[:default] || { }, responses[configuration.situation.to_sym] || { }).result
+      if response.empty?
+        logger.warn "received request #{pair[:name]} with undefined response"
+        not_found
+      else
+        Holoserve::Response::Composer.new(response).response_array
+      end
     else
       bucket.requests << request
       logger.error "received unhandled request\n" + request.pretty_inspect

data/lib/holoserve/request/matcher.rb

@@ -45,7 +45,7 @@ class Holoserve::Request::Matcher
   def match_parameters?
     match = true
     (@request_subset[:parameters] || { }).each do |key, value|
-      match &&= @request[:parameters][key] == value
+      match &&= @request[:parameters].is_a?(Hash) && (@request[:parameters][key] == value)
     end
     match
   end
@@ -53,7 +53,7 @@ class Holoserve::Request::Matcher
   def match_oauth?
     match = true
     (@request_subset[:oauth] || { }).each do |key, value|
-      match &&= @request[:oauth][key] == value
+      match &&= @request[:oauth].is_a?(Hash) && (@request[:oauth][key] == value)
     end
     match
   end

data/lib/holoserve/runner.rb

@@ -7,8 +7,8 @@ class Holoserve::Runner
 
   def initialize(options = { })
     @port = options[:port] || 4250
-    @layouts_filename = options[:layouts_filename]
-    @layout = options[:layout]
+    @layout_filename = options[:layout_filename]
+    @situation = options[:situation]
 
     @rackup_options = Unicorn::Configurator::RACKUP
     @rackup_options[:port] = @port
@@ -20,8 +20,8 @@ class Holoserve::Runner
 
   def start
     @unicorn.start
-    upload_layouts if @layouts_filename
-    set_layout if @layout
+    upload_layout if @layout_filename
+    set_situation if @situation
   end
 
   def join
@@ -42,18 +42,22 @@ class Holoserve::Runner
 
   private
 
-  def upload_layouts
+  def upload_layout
+    format = File.extname(@layout_filename).sub(/^\./, "")
+    raise ArgumentError, "file extension indicates wrong format '#{format}' (choose yaml or json)" unless [ "yaml", "json" ].include?(format)
     Holoserve::Tool::Uploader.new(
-      @layouts_filename,
+      @layout_filename,
       :post,
-      "http://localhost:#{port}/_control/layouts",
+      "http://localhost:#{port}/_control/layout.#{format}",
       :expected_status_code => 200
     ).upload
     nil
   end
 
-  def set_layout
-    Transport::JSON.request :put, "http://localhost:#{port}/_control/layouts/#{@layout}/current", :expected_status_code => 200
+  def set_situation
+    Transport::JSON.request :put,
+                            "http://localhost:#{port}/_control/situation/#{@situation}",
+                            :expected_status_code => 200
     nil
   end
 

data/lib/holoserve/tool/hash/key_symbolizer.rb

@@ -1,12 +1,18 @@
 
 class Holoserve::Tool::Hash::KeySymbolizer
 
-  def initialize(hash)
-    @hash = hash
+  def initialize(hash_or_array)
+    @hash_or_array = hash_or_array
   end
 
   def hash
-    symbolize_keys @hash
+    if @hash_or_array.is_a?(Hash)
+      symbolize_keys @hash_or_array
+    elsif @hash_or_array.is_a?(Array)
+      symbolize_keys_of_all @hash_or_array
+    else
+      @hash_or_array
+    end
   end
 
   private
@@ -27,6 +33,7 @@ class Holoserve::Tool::Hash::KeySymbolizer
   end
 
   def symbolize_keys_of_all(array)
+    return nil unless array.is_a?(Array)
     array.map do |item|
       if item.is_a?(Hash)
         symbolize_keys item

data/lib/holoserve/tool/merger.rb

@@ -0,0 +1,51 @@
+
+class Holoserve::Tool::Merger
+
+  def initialize(hash_or_array_one, hash_or_array_two)
+    @hash_or_array_one, @hash_or_array_two = hash_or_array_one, hash_or_array_two
+  end
+
+  def result
+    if @hash_or_array_one.is_a?(Hash) && @hash_or_array_two.is_a?(Hash)
+      merged_hash
+    elsif @hash_or_array_one.is_a?(Array) && @hash_or_array_two.is_a?(Array)
+      merged_array
+    else
+      @hash_or_array_two
+    end
+  end
+
+  private
+
+  def merged_hash
+    result = { }
+    (@hash_or_array_one.keys + @hash_or_array_two.keys).uniq.each do |key|
+      value_one, value_two = @hash_or_array_one[key],@hash_or_array_two[key]
+      result[key] = if values_mergeable?(value_one, value_two)
+        self.class.new(value_one, value_two).result
+      else
+        value_two || value_one
+      end
+    end
+    result
+  end
+
+  def merged_array
+    result = Array.new [ @hash_or_array_one.length, @hash_or_array_two.length ].max
+    result.each_index do |index|
+      value_one, value_two = @hash_or_array_one[index], @hash_or_array_two[index]
+      result[index] = if values_mergeable?(value_one, value_two)
+        self.class.new(value_one, value_two).result
+      else
+        value_two || value_one
+      end
+    end
+    result
+  end
+
+  def values_mergeable?(value_one, value_two)
+    (value_one.is_a?(Hash) && value_two.is_a?(Hash)) ||
+      (value_one.is_a?(Array) && value_two.is_a?(Array))
+  end
+
+end

data/lib/holoserve/tool.rb

@@ -2,6 +2,7 @@
 module Holoserve::Tool
 
   autoload :Hash, File.join(File.dirname(__FILE__), "tool", "hash")
+  autoload :Merger, File.join(File.dirname(__FILE__), "tool", "merger")
   autoload :Uploader, File.join(File.dirname(__FILE__), "tool", "uploader")
 
 end

data/spec/helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "holoserve"))

data/spec/lib/holoserve/tool/merger_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "helper"))
+
+describe Holoserve::Tool::Merger do
+
+  subject { described_class.new argument_one, argument_two }
+
+  describe "result" do
+
+    context "of two hashes" do
+
+      let(:argument_one) { { :test => "value" } }
+      let(:argument_two) { { :test => "another value" } }
+
+      it "should merge nested values" do
+        subject.result.should == { :test => "another value" }
+      end
+
+    end
+
+    context "of two nested hashes" do
+
+      let(:argument_one) { { :test => { :regular =>"value", :nested => "value" } } }
+      let(:argument_two) { { :test => { :nested => "another value" } } }
+
+      it "should merge nested values" do
+        subject.result.should == { :test => { :regular => "value", :nested => "another value" } }
+      end
+
+    end
+
+    context "of two arrays" do
+
+      let(:argument_one) { [ { :test => "value" }, { :regular => "value", :another_test => "value" } ] }
+      let(:argument_two) { [ { :test => "another value" }, { :another_test => "another value" } ] }
+
+      it "should merge all nested hashes" do
+        subject.result.should == [
+          { :test => "another value" },
+          { :regular => "value", :another_test => "another value" }
+        ]
+      end
+
+    end
+
+    context "of two arrays with different lengths" do
+
+      let(:argument_one) { [ { :test => "value" } ] }
+      let(:argument_two) { [ { :test => "another value" }, { :another_test => "another value" } ] }
+
+      it "should merge all nested hashes" do
+        subject.result.should == [
+          { :test => "another value" },
+          { :another_test => "another value" }
+        ]
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: holoserve
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-19 00:00:00.000000000 Z
+date: 2012-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70292202591440 !ruby/object:Gem::Requirement
+  requirement: &70247827043580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292202591440
+  version_requirements: *70247827043580
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70292202590900 !ruby/object:Gem::Requirement
+  requirement: &70247827042840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292202590900
+  version_requirements: *70247827042840
 - !ruby/object:Gem::Dependency
   name: unicorn
-  requirement: &70292202590400 !ruby/object:Gem::Requirement
+  requirement: &70247827042360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292202590400
+  version_requirements: *70247827042360
 - !ruby/object:Gem::Dependency
   name: transport
-  requirement: &70292202589740 !ruby/object:Gem::Requirement
+  requirement: &70247827041740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292202589740
+  version_requirements: *70247827041740
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70292202589060 !ruby/object:Gem::Requirement
+  requirement: &70247827041200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70292202589060
+  version_requirements: *70247827041200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70292202588380 !ruby/object:Gem::Requirement
+  requirement: &70247827040660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70292202588380
+  version_requirements: *70247827040660
 - !ruby/object:Gem::Dependency
   name: transport
-  requirement: &70292202587840 !ruby/object:Gem::Requirement
+  requirement: &70247827040180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70292202587840
+  version_requirements: *70247827040180
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70292202587300 !ruby/object:Gem::Requirement
+  requirement: &70247827039660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70292202587300
+  version_requirements: *70247827039660
 description: This tool can be used to fake webservice APIs for testing proposals.
 email: philipp.bruell@skrill.com
 executables:
@@ -127,9 +127,12 @@ files:
 - lib/holoserve/runner.rb
 - lib/holoserve/tool/hash/key_symbolizer.rb
 - lib/holoserve/tool/hash.rb
+- lib/holoserve/tool/merger.rb
 - lib/holoserve/tool/uploader.rb
 - lib/holoserve/tool.rb
 - lib/holoserve.rb
+- spec/helper.rb
+- spec/lib/holoserve/tool/merger_spec.rb
 homepage: http://github.com/skrill/holoserve
 licenses: []
 post_install_message: 
@@ -144,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1129492518361910852
+      hash: 460979945885990413
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,4 +160,5 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Tool to fake HTTP APIs.
-test_files: []
+test_files:
+- spec/lib/holoserve/tool/merger_spec.rb