interpol 0.4.3 → 0.5.0

data/README.md

@@ -231,6 +231,21 @@ Interpol.default_configuration do |config|
     example.data["current_url"] = Rack::Request.new(request_env).url
   end
 
+  # Sets a callback that will be used to determine which example
+  # to return from the stub app. If you provide an endpoint name,
+  # the block will apply only to requests to that endpoint.
+  # If no name is provided, the block will set the default selector
+  # logic. By default, if this config is not set, interpol will use
+  # the first example.
+  #
+  # Used by Interpol::StubApp.
+  config.select_example_response('some-endpoint') do |endpoint_def, request_env|
+    endpoint_def.examples[3]
+  end
+  config.select_example_response do |endpoint_def, request_env|
+    endpoint_def.examples.first
+  end
+
   # Determines what to do when Interpol::Sinatra::RequestParamsParser
   # detects invalid path or query parameters based on their schema
   # definitions. This block will be eval'd in the context of your

data/lib/interpol/configuration.rb

@@ -20,7 +20,7 @@ module Interpol
   private
 
     def find_definitions_for(endpoint, version, message_type)
-      endpoint.find_definition(version, message_type) { [] }
+      endpoint.find_definitions(version, message_type) { [] }
     end
 
     def with_endpoint_matching(method, path)
@@ -141,6 +141,19 @@ module Interpol
       filter_example_data_blocks << block
     end
 
+    def select_example_response(endpoint_name = nil, &block)
+      if endpoint_name
+        named_example_selectors[endpoint_name] = block
+      else
+        named_example_selectors.default = block
+      end
+    end
+
+    def example_response_for(endpoint_def, env)
+      selector = named_example_selectors[endpoint_def.endpoint_name]
+      selector.call(endpoint_def, env)
+    end
+
     def self.default
       @default ||= Configuration.new
     end
@@ -187,6 +200,10 @@ module Interpol
                  'Content-Length' => json.bytesize }, [json]]
     end
 
+    def named_example_selectors
+      @named_example_selectors ||= {}
+    end
+
     def register_default_callbacks
       request_version do
         raise ConfigurationError, "request_version has not been configured"
@@ -229,6 +246,10 @@ module Interpol
       on_invalid_sinatra_request_params do |error|
         halt 400, JSON.dump(:error => error.message)
       end
+
+      select_example_response do |endpoint_def, _|
+        endpoint_def.examples.first
+      end
     end
   end
 end

data/lib/interpol/endpoint.rb

@@ -52,23 +52,20 @@ module Interpol
     end
 
     def find_definition!(version, message_type)
-      find_definition(version, message_type) do
+      defs = find_definitions(version, message_type) do
         message = "No definition found for #{name} endpoint for version #{version}"
         message << " and message_type #{message_type}"
         raise NoEndpointDefinitionFoundError.new(message)
       end
-    end
 
-    def find_definition(version, message_type, &block)
-      @definitions_hash.fetch([message_type, version], &block)
-    end
+      return defs.first if defs.size == 1
 
-    def find_example_for!(version, message_type)
-      find_definition!(version, message_type).first.examples.first
+      raise MultipleEndpointDefinitionsFoundError, "#{defs.size} endpoint definitions " +
+        "were found for #{name} / #{version} / #{message_type}"
     end
 
-    def find_example_status_code_for!(version)
-      find_definition!(version, 'response').first.example_status_code
+    def find_definitions(version, message_type, &block)
+      @definitions_hash.fetch([message_type, version], &block)
     end
 
     def available_request_versions

data/lib/interpol/errors.rb

@@ -32,6 +32,10 @@ module Interpol
   # endpoint definition for the request.
   class NoEndpointDefinitionFoundError < Error; end
 
+  # Error raised when multiple endpoint definitions are found
+  # for a given criteria.
+  class MultipleEndpointDefinitionsFoundError < Error; end
+
   # Raised when an invalid status code is found during validate_codes!
   class StatusCodeMatcherArgumentError < ArgumentError; end
 end

data/lib/interpol/stub_app.rb

@@ -44,24 +44,25 @@ module Interpol
 
       def endpoint_definition(endpoint)
         lambda do
-          example, version = settings.
-                             stub_app_builder.
-                             example_and_version_for(endpoint, self)
+          endpoint_def = settings.stub_app_builder.endpoint_def_for(endpoint, self)
+          example = settings.stub_app_builder.example_for(endpoint_def, self)
           example.validate! if settings.perform_validations?
-          status endpoint.find_example_status_code_for!(version)
+          status endpoint_def.example_status_code
           JSON.dump(example.data)
         end
       end
 
-      def example_and_version_for(endpoint, app)
+      def endpoint_def_for(endpoint, app)
         version = config.response_version_for(app.request.env, endpoint)
-        example = endpoint.find_example_for!(version, 'response')
+        endpoint_def = endpoint.find_definition!(version, 'response')
       rescue NoEndpointDefinitionFoundError
-        config.sinatra_request_version_unavailable(app, version,
-                                                   endpoint.available_response_versions)
-      else
-        example = example.apply_filters(config.filter_example_data_blocks, app.request.env)
-        return example, version
+        config.sinatra_request_version_unavailable \
+          app, version, endpoint.available_response_versions
+      end
+
+      def example_for(endpoint_def, app)
+        example = config.example_response_for(endpoint_def, app.request.env)
+        example.apply_filters(config.filter_example_data_blocks, app.request.env)
       end
     end
   end

data/lib/interpol/version.rb

@@ -1,3 +1,3 @@
 module Interpol
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interpol
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack