interpol 0.10.1 → 0.10.2

data/Gemfile

@@ -13,6 +13,8 @@ gem 'compass_twitter_bootstrap', :git => 'git://github.com/vwall/compass-twitter
 
 gem 'json', :platform => 'ruby_18'
 
-gem 'cane', '~> 2.0', :platform => 'ruby_19'
+gem 'cane', '~> 2.6', :platform => 'ruby_19'
+
+# 1.6 won't install on JRuby or 1.8.7 :(.
+gem 'nokogiri', '~> 1.5.10'
 
-gem 'rspec-fire', :git => 'git://github.com/xaviershay/rspec-fire.git'

data/README.md

@@ -2,6 +2,7 @@
 ![Interpol Logo](https://github.com/seomoz/interpol/blob/assets/interpol-logo.png?raw=true)
 
 [![Build Status](https://secure.travis-ci.org/seomoz/interpol.png)](http://travis-ci.org/seomoz/interpol)
+[![Code Climate](https://codeclimate.com/github/seomoz/interpol.png)](https://codeclimate.com/github/seomoz/interpol)
 
 Interpol is a toolkit for policing your HTTP JSON interface. To use it,
 define the endpoints of your HTTP API in simple YAML files.
@@ -156,7 +157,7 @@ Interpol.default_configuration do |config|
   # Needed by Interpol::StubApp and Interpol::ResponseSchemaValidator.
   config.response_version '1.0'
 
-  # Determines which versioned response endpoint definition Interpol uses
+  # Determines which versioned request endpoint definition Interpol uses
   # for a request. You can also use a block form, which yields
   # the rack env hash and the endpoint object as arguments.
   # This is useful when you need to extract the version from a

data/lib/interpol.rb

@@ -1,6 +1,8 @@
 require "interpol/configuration"
 require "interpol/version"
 
+# The Interpol namespace. Provides only the default configuration.
+# Each of the tools is self-contained and should be required independently.
 module Interpol
   extend self
 

data/lib/interpol/configuration.rb

@@ -5,6 +5,8 @@ require 'yaml'
 require 'uri'
 
 module Interpol
+  # Meant to be extended onto an array, to provide custom
+  # finder methods for interpol endpoint definitions.
   module DefinitionFinder
     include HashFetcher
     NoDefinitionFound = Class.new

data/lib/interpol/documentation.rb

@@ -1,6 +1,7 @@
 require 'nokogiri'
 
 module Interpol
+  # Renders HTML documentation for an interpol endpoint.
   module Documentation
     extend self
 

data/lib/interpol/documentation_app.rb

@@ -4,6 +4,7 @@ require 'sinatra/base'
 require 'nokogiri'
 
 module Interpol
+  # Provides the interpol documentation app.
   module DocumentationApp
     extend self
 
@@ -61,6 +62,7 @@ module Interpol
 
   private
 
+    # Helper methods for the documentation app.
     module Helpers
       def interpol_config
         self.class.interpol_config

data/lib/interpol/endpoint.rb

@@ -1,6 +1,7 @@
-require 'json-schema'
-require 'interpol/errors'
 require 'forwardable'
+require 'interpol/errors'
+require 'json'
+require 'json-schema'
 require 'set'
 
 module JSON
@@ -51,6 +52,8 @@ module JSON
 end
 
 module Interpol
+  # Provides a helper method for fetching an item from a hash.
+  # Deals with differences on different ruby interpretters.
   module HashFetcher
     # Unfortunately, on JRuby 1.9, the error raised from Hash#fetch when
     # the key is not found does not include the key itself :(. So we work
@@ -145,7 +148,7 @@ module Interpol
           end
         end.join('\/')
 
-        /\A#{regex_string}\z/
+        /\A#{regex_string}\/?\z/
       end
     end
 
@@ -214,7 +217,7 @@ module Interpol
 
     def validate_data!(data)
       errors = ::JSON::Validator.fully_validate_schema(schema)
-      raise ValidationError.new(errors, nil, description) if errors.any?
+      raise ValidationError.new(errors, schema, description) if errors.any?
       errors = ::JSON::Validator.fully_validate(schema, data)
       raise ValidationError.new(errors, data, description) if errors.any?
     end

data/lib/interpol/sinatra/request_params_parser.rb

@@ -122,6 +122,7 @@ module Interpol
         end
       end
 
+      # Contains methods that override sinatra methods.
       module SinatraOverriddes
         extend Forwardable
         def_delegators :settings, :request_params_parser

data/lib/interpol/stub_app.rb

@@ -3,6 +3,7 @@ require 'sinatra/base'
 require 'json'
 
 module Interpol
+  # Public: Builds an interpol stub app.
   module StubApp
     extend self
 

data/lib/interpol/test_helper.rb

@@ -4,6 +4,7 @@ require 'interpol/request_params_parser'
 
 module Interpol
   module TestHelper
+    # Defines methods that are used by both the RSpec and Test::Unit mixins.
     module Common
       def define_interpol_example_tests(&block)
         config = Configuration.default.customized_duplicate(&block)
@@ -57,6 +58,7 @@ module Interpol
       end
     end
 
+    # An RSpec mixin for defining interpol example tests.
     module RSpec
       include Common
 
@@ -65,6 +67,7 @@ module Interpol
       end
     end
 
+    # A Test::Unit mixin for defining interpol example tests.
     module TestUnit
       include Common
 

data/lib/interpol/version.rb

@@ -1,4 +1,4 @@
 module Interpol
-  VERSION = "0.10.1"
+  VERSION = "0.10.2"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interpol
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -43,22 +43,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.1.1
     none: false
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-    none: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-    none: false
 - !ruby/object:Gem::Dependency
   name: rspec
   prerelease: false
@@ -82,14 +66,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.2'
     none: false
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.2'
     none: false
 - !ruby/object:Gem::Dependency
   name: simplecov