interpol 0.9.0 → 0.10.0

data/Gemfile

@@ -13,8 +13,6 @@ gem 'compass_twitter_bootstrap', :git => 'git://github.com/vwall/compass-twitter
 
 gem 'json', :platform => 'ruby_18'
 
-gem 'sinatra', '>= 1.3.2', '< 2.0.0'
-
 gem 'cane', '~> 2.0', :platform => 'ruby_19'
 
 gem 'rspec-fire', :git => 'git://github.com/xaviershay/rspec-fire.git'

data/lib/interpol/configuration.rb

@@ -1,7 +1,7 @@
+require 'interpol'
 require 'interpol/endpoint'
 require 'interpol/errors'
 require 'yaml'
-require 'interpol/configuration_ruby_18_extensions'  if RUBY_VERSION.to_f < 1.9
 require 'uri'
 
 module Interpol
@@ -33,8 +33,9 @@ module Interpol
 
   # Public: Defines interpol configuration.
   class Configuration
-    attr_reader :endpoint_definition_files, :endpoints, :filter_example_data_blocks
-    attr_accessor :validation_mode, :documentation_title, :endpoint_definition_merge_key_files
+    attr_reader :endpoint_definition_files, :endpoints, :filter_example_data_blocks,
+                :endpoint_definition_merge_key_files
+    attr_accessor :validation_mode, :documentation_title
 
     def initialize
       self.endpoint_definition_files = []
@@ -48,16 +49,25 @@ module Interpol
     end
 
     def endpoint_definition_files=(files)
-      self.endpoints = files.map do |file|
-        Endpoint.new(deserialized_hash_from file)
-      end
+      @endpoints = nil
       @endpoint_definition_files = files
     end
 
+    def endpoint_definition_merge_key_files=(files)
+      @endpoints = nil
+      @endpoint_definition_merge_key_files = files
+    end
+
     def endpoints=(endpoints)
       @endpoints = endpoints.extend(DefinitionFinder)
     end
 
+    def endpoints
+      @endpoints ||= @endpoint_definition_files.map do |file|
+        Endpoint.new(deserialized_hash_from(file), self)
+      end.extend(DefinitionFinder)
+    end
+
     [:request, :response].each do |type|
       class_eval <<-EOEVAL, __FILE__, __LINE__ + 1
         def #{type}_version(version = nil, &block)
@@ -156,6 +166,15 @@ module Interpol
       selector.call(endpoint_def, env)
     end
 
+    def scalars_nullable_by_default=(value)
+      @endpoints = nil
+      @scalars_nullable_by_default = value
+    end
+
+    def scalars_nullable_by_default?
+      @scalars_nullable_by_default
+    end
+
     def self.default
       @default ||= Configuration.new
     end
@@ -183,24 +202,9 @@ module Interpol
     end
 
   private
-
-    # 1.9 version
-    include Module.new {
-      BAD_ALIAS_ERROR = defined?(::Psych::BadAlias) ?
-                          ::Psych::BadAlias : TypeError
-      def deserialized_hash_from(file)
-        YAML.load(yaml_content_for file)
-      rescue BAD_ALIAS_ERROR => 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
-    }
-
-    # Needed to override deserialized_hash_from for Ruby 1.8
-    include Interpol::ConfigurationRuby18Extensions  if RUBY_VERSION.to_f < 1.9
+    def deserialized_hash_from(file)
+      YAML.load(yaml_content_for file)
+    end
 
     def yaml_content_for(file)
       File.read(file).gsub(/\A---\n/, "---\n" + endpoint_merge_keys + "\n\n")

data/lib/interpol/endpoint.rb

@@ -1,6 +1,7 @@
 require 'json-schema'
 require 'interpol/errors'
 require 'forwardable'
+require 'set'
 
 module JSON
   # The JSON-schema namespace
@@ -65,13 +66,14 @@ module Interpol
   # based on the endpoint definitions in the YAML files.
   class Endpoint
     include HashFetcher
-    attr_reader :name, :route, :method, :custom_metadata
+    attr_reader :name, :route, :method, :custom_metadata, :configuration
 
-    def initialize(endpoint_hash)
+    def initialize(endpoint_hash, configuration = Interpol.default_configuration)
       @name        = fetch_from(endpoint_hash, 'name')
       @route       = fetch_from(endpoint_hash, 'route')
       @method      = fetch_from(endpoint_hash, 'method').downcase.to_sym
 
+      @configuration   = configuration
       @custom_metadata = endpoint_hash.fetch('meta') { {} }
 
       @definitions_hash, @all_definitions = extract_definitions_from(endpoint_hash)
@@ -181,7 +183,7 @@ module Interpol
     attr_reader :endpoint, :message_type, :version, :schema,
                 :path_params, :query_params, :examples, :custom_metadata
     extend Forwardable
-    def_delegators :endpoint, :route
+    def_delegators :endpoint, :route, :configuration
 
     DEFAULT_PARAM_HASH = { 'type' => 'object', 'properties' => {} }
 
@@ -244,12 +246,14 @@ module Interpol
       end
     end
 
-    def make_schema_hash_strict!(raw_schema, modify_object=true)
+    def make_schema_hash_strict!(raw_schema, make_this_schema_strict=true)
+      conditionally_make_nullable(raw_schema) if make_this_schema_strict
+
       raw_schema.each do |key, value|
         make_schema_strict!(value, key != 'properties')
       end
 
-      return unless modify_object
+      return unless make_this_schema_strict
 
       if raw_schema.has_key?('properties')
         raw_schema['additionalProperties'] ||= false
@@ -258,9 +262,33 @@ module Interpol
       raw_schema['required'] = !raw_schema.delete('optional')
     end
 
-    def make_schema_array_strict!(raw_schema, modify_object=true)
+    def make_schema_array_strict!(raw_schema, make_nested_schemas_strict=true)
       raw_schema.each do |entry|
-        make_schema_strict!(entry, modify_object)
+        make_schema_strict!(entry, make_nested_schemas_strict)
+      end
+    end
+
+    def conditionally_make_nullable(raw_schema)
+      return unless should_be_nullable?(raw_schema)
+
+      types = Array(raw_schema['type'])
+      return if types.none? || types.include?('null')
+
+      raw_schema['type'] = (types << "null")
+    end
+
+    def should_be_nullable?(raw_schema)
+      raw_schema.fetch('nullable') do
+        configuration.scalars_nullable_by_default? && scalar?(raw_schema)
+      end
+    end
+
+    NON_SCALAR_TYPES = %w[ object array ]
+    def scalar?(raw_schema)
+      types = Array(raw_schema['type']).to_set
+
+      NON_SCALAR_TYPES.none? do |non_scalar|
+        types.include?(non_scalar)
       end
     end
 

data/lib/interpol/version.rb

@@ -1,4 +1,4 @@
 module Interpol
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interpol
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -66,14 +66,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.13'
     none: false
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.13'
     none: false
 - !ruby/object:Gem::Dependency
   name: rspec-fire
@@ -171,6 +171,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
     none: false
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    none: false
 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:
@@ -186,7 +202,6 @@ files:
 - lib/interpol/configuration/built_in_param_parsers.rb
 - lib/interpol/configuration/default_callbacks.rb
 - lib/interpol/configuration.rb
-- lib/interpol/configuration_ruby_18_extensions.rb
 - lib/interpol/documentation.rb
 - lib/interpol/documentation_app/config.rb
 - lib/interpol/documentation_app.rb

data/lib/interpol/configuration_ruby_18_extensions.rb

@@ -1,27 +0,0 @@
-module Interpol
-  module ConfigurationRuby18Extensions
-    def deserialized_hash_from(file)
-      YAML.load(yaml_content_for file).tap do |yaml|
-        if bad_class = bad_deserialized_yaml(yaml)
-          raise ConfigurationError.new \
-            "Received an error while loading YAML from #{file}: \"" +
-            "Got object of type: #{bad_class}\"\n If you are using YAML merge keys " +
-            "to declare shared types, you must configure endpoint_definition_merge_key_files " +
-            "before endpoint_definition_files."
-        end
-      end
-    end
-
-    # returns nil if the YAML has been only partially deserialized by Syck
-    # and there are YAML::Syck objects.
-    def bad_deserialized_yaml(yaml)
-      if [Hash, Array].include? yaml.class
-        yaml.map { |elem| bad_deserialized_yaml(elem) }.compact.first
-      elsif yaml.class.name =~ /YAML::Syck::/
-        yaml.class.name # Bad!
-      else
-        nil
-      end
-    end
-  end
-end