interpol 0.1.0 → 0.2.0

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 
 group :extras do
   gem 'debugger' if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ruby' && RUBY_VERSION == '1.9.3'
+  gem 'ruby-debug', :platform => :mri_18
 end
 
 gem 'json-jruby', :platform => 'jruby'

data/lib/interpol/configuration.rb

@@ -33,7 +33,7 @@ module Interpol
 
   # Public: Defines interpol configuration.
   class Configuration
-    attr_reader :endpoint_definition_files, :endpoints
+    attr_reader :endpoint_definition_files, :endpoints, :filter_example_data_blocks
     attr_accessor :validation_mode, :documentation_title, :endpoint_definition_merge_key_files
 
     def initialize
@@ -41,6 +41,7 @@ module Interpol
       self.endpoint_definition_merge_key_files = []
       self.documentation_title = "API Documentation Provided by Interpol"
       register_default_callbacks
+      @filter_example_data_blocks = []
 
       yield self if block_given?
     end
@@ -85,6 +86,10 @@ module Interpol
       execution_context.instance_exec(*args, &@unavailable_request_version_block)
     end
 
+    def filter_example_data(&block)
+      filter_example_data_blocks << block
+    end
+
     def self.default
       @default ||= Configuration.new
     end

data/lib/interpol/endpoint.rb

@@ -1,6 +1,27 @@
 require 'json-schema'
 require 'interpol/errors'
 
+module JSON
+  # The JSON-schema namespace
+  class Schema
+    # Monkey patch json-schema to reject unrecognized types.
+    # It allows them because the spec says they should be allowed,
+    # but we don't want to allow them.
+    # For more info, see:
+    # - https://github.com/hoxworth/json-schema/pull/37
+    # - https://github.com/hoxworth/json-schema/pull/38
+    class TypeAttribute
+      (class << self; self; end).class_eval do
+        alias original_data_valid_for_type? data_valid_for_type?
+        def data_valid_for_type?(data, type)
+          return false unless TYPE_CLASS_MAPPINGS.has_key?(type)
+          original_data_valid_for_type?(data, type)
+        end
+      end
+    end
+  end
+end
+
 module Interpol
   module HashFetcher
     # Unfortunately, on JRuby 1.9, the error raised from Hash#fetch when
@@ -107,7 +128,8 @@ module Interpol
   # Provides the means to validate data against that version of the schema.
   class EndpointDefinition
     include HashFetcher
-    attr_reader :endpoint_name, :message_type, :version, :schema, :examples
+    attr_reader :endpoint_name, :message_type, :version, :schema,
+                :path_params, :query_params, :examples
 
     def initialize(endpoint_name, version, message_type, definition)
       @endpoint_name  = endpoint_name
@@ -115,6 +137,8 @@ module Interpol
       @status_codes   = StatusCodeMatcher.new(definition['status_codes'])
       @version        = version
       @schema         = fetch_from(definition, 'schema')
+      @path_params    = definition.fetch('path_params', {})
+      @query_params   = definition.fetch('query_params', {})
       @examples       = fetch_from(definition, 'examples').map { |e| EndpointExample.new(e, self) }
       make_schema_strict!(@schema)
     end
@@ -212,5 +236,47 @@ module Interpol
     def validate!
       definition.validate_data!(data)
     end
+
+    def apply_filters(filter_blocks, request_env)
+      deep_dup.tap do |example|
+        filter_blocks.each do |filter|
+          filter.call(example, request_env)
+        end
+      end
+    end
+
+  protected
+
+    attr_writer :data
+
+  private
+
+    def deep_dup
+      dup.tap { |d| d.data = dup_hash(d.data) }
+    end
+
+    DUPPERS = { Hash => :dup_hash, Array => :dup_array }
+
+    def dup_hash(hash)
+      duplicate = hash.dup
+      duplicate.each_pair do |k,v|
+        duplicate[k] = dup_object(v)
+      end
+      duplicate
+    end
+
+    def dup_array(array)
+      duplicate = array.dup
+      duplicate.each_with_index do |o, index|
+        duplicate[index] = dup_object(o)
+      end
+      duplicate
+    end
+
+    def dup_object(o)
+      dupper = DUPPERS[o.class]
+      return o unless dupper
+      send(dupper, o)
+    end
   end
 end

data/lib/interpol/stub_app.rb

@@ -19,9 +19,11 @@ module Interpol
       end
 
       def example_for(endpoint, version, message_type)
-        endpoint.find_example_for!(version, message_type)
+        example = endpoint.find_example_for!(version, message_type)
       rescue ArgumentError
         interpol_config.request_version_unavailable(self, version, endpoint.available_versions)
+      else
+        example.apply_filters(interpol_config.filter_example_data_blocks, request.env)
       end
     end
 

data/lib/interpol/version.rb

@@ -1,3 +1,3 @@
 module Interpol
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interpol
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000 Z
+date: 2012-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.0.8
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -218,7 +218,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -430941373413258822
+      hash: -810990702936122317
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -227,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -430941373413258822
+      hash: -810990702936122317
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24