interpol 0.0.4 → 0.0.5

data/lib/interpol/configuration.rb

@@ -26,33 +26,20 @@ module Interpol
   # Public: Defines interpol configuration.
   class Configuration
     attr_reader :endpoint_definition_files, :endpoints
-    attr_accessor :validation_mode, :documentation_title
+    attr_accessor :validation_mode, :documentation_title, :endpoint_definition_merge_key_files
 
     def initialize
-      api_version do
-        raise ConfigurationError, "api_version has not been configured"
-      end
-
-      validate_if do |env, status, headers, body|
-        headers['Content-Type'].to_s.include?('json') &&
-        (200..299).cover?(status) && status != 204 # No Content
-      end
-
-      on_unavailable_request_version do |requested, available|
-        message = "The requested API version is invalid. " +
-                  "Requested: #{requested}. " +
-                  "Available: #{available}"
-        halt 406, JSON.dump(error: message)
-      end
-
       self.endpoint_definition_files = []
+      self.endpoint_definition_merge_key_files = []
       self.documentation_title = "API Documentation Provided by Interpol"
+      register_default_callbacks
+
       yield self if block_given?
     end
 
     def endpoint_definition_files=(files)
       self.endpoints = files.map do |file|
-        Endpoint.new(YAML.load_file file)
+        Endpoint.new(deserialized_hash_from file)
       end
       @endpoint_definition_files = files
     end
@@ -98,6 +85,46 @@ module Interpol
       block ||= lambda { |c| }
       dup.tap(&block)
     end
+
+  private
+
+    def deserialized_hash_from(file)
+      YAML.load(yaml_content_for file)
+    rescue TypeError => e
+      raise ConfigurationError.new \
+        "Received an error while loading YAML from #{file}: \"" +
+        "#{e.class}: #{e.message}\" If you are using YAML merge keys " +
+        "to declare shared types, you must configure endpoint_definition_merge_key_files " +
+        "before endpoint_definition_files.", e
+    end
+
+    def yaml_content_for(file)
+      File.read(file).gsub(/\A---\n/, "---\n" + endpoint_merge_keys + "\n\n")
+    end
+
+    def endpoint_merge_keys
+      @endpoint_merge_keys ||= endpoint_definition_merge_key_files.map { |f|
+        File.read(f).gsub(/\A---\n/, '')
+      }.join("\n\n")
+    end
+
+    def register_default_callbacks
+      api_version do
+        raise ConfigurationError, "api_version has not been configured"
+      end
+
+      validate_if do |env, status, headers, body|
+        headers['Content-Type'].to_s.include?('json') &&
+        (200..299).cover?(status) && status != 204 # No Content
+      end
+
+      on_unavailable_request_version do |requested, available|
+        message = "The requested API version is invalid. " +
+                  "Requested: #{requested}. " +
+                  "Available: #{available}"
+        halt 406, JSON.dump(error: message)
+      end
+    end
   end
 end
 

data/lib/interpol/errors.rb

@@ -3,7 +3,14 @@ module Interpol
   class Error < StandardError; end
 
   # Error raised when the configuration is invalid.
-  class ConfigurationError < Error; end
+  class ConfigurationError < Error
+    attr_reader :original_error
+
+    def initialize(message=nil, original_error=nil)
+      @original_error = original_error
+      super(message)
+    end
+  end
 
   # Error raised when data fails to validate against the schema
   # for an endpoint.

data/lib/interpol/version.rb

@@ -1,3 +1,3 @@
 module Interpol
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interpol
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-09 00:00:00.000000000 Z
+date: 2012-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2152424620 !ruby/object:Gem::Requirement
+  requirement: &2152129140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152424620
+  version_requirements: *2152129140
 - !ruby/object:Gem::Dependency
   name: json-schema
-  requirement: &2152423160 !ruby/object:Gem::Requirement
+  requirement: &2152127380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -35,10 +35,10 @@ dependencies:
         version: 1.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *2152423160
+  version_requirements: *2152127380
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2152422460 !ruby/object:Gem::Requirement
+  requirement: &2152126360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,10 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2152422460
+  version_requirements: *2152126360
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152421220 !ruby/object:Gem::Requirement
+  requirement: &2152125580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,10 +57,10 @@ dependencies:
         version: '2.9'
   type: :development
   prerelease: false
-  version_requirements: *2152421220
+  version_requirements: *2152125580
 - !ruby/object:Gem::Dependency
   name: rspec-fire
-  requirement: &2152420760 !ruby/object:Gem::Requirement
+  requirement: &2152125020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *2152420760
+  version_requirements: *2152125020
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2152420260 !ruby/object:Gem::Requirement
+  requirement: &2152124120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -79,10 +79,10 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *2152420260
+  version_requirements: *2152124120
 - !ruby/object:Gem::Dependency
   name: cane
-  requirement: &2152419540 !ruby/object:Gem::Requirement
+  requirement: &2152123560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,10 +90,21 @@ dependencies:
         version: '1.2'
   type: :development
   prerelease: false
-  version_requirements: *2152419540
+  version_requirements: *2152123560
+- !ruby/object:Gem::Dependency
+  name: tailor
+  requirement: &2152122640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152122640
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152418880 !ruby/object:Gem::Requirement
+  requirement: &2152122040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,10 +112,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *2152418880
+  version_requirements: *2152122040
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2152418180 !ruby/object:Gem::Requirement
+  requirement: &2152121500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -112,7 +123,7 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *2152418180
+  version_requirements: *2152121500
 description: Interpol is a toolkit for working with API endpoint definition files,
   giving you a stub app, a schema validation middleware, and browsable documentation.
 email: