interpol 0.0.5 → 0.0.6

data/Gemfile

@@ -4,8 +4,12 @@ source 'https://rubygems.org'
 gemspec
 
 group :extras do
-  gem 'debugger' if RUBY_ENGINE == 'ruby' && RUBY_VERSION == '1.9.3'
+  gem 'debugger' if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ruby' && RUBY_VERSION == '1.9.3'
 end
 
-gem 'json-jruby', platform: 'jruby'
-gem 'compass_twitter_bootstrap', git: 'git://github.com/vwall/compass-twitter-bootstrap.git'
+gem 'json-jruby', :platform => 'jruby'
+gem 'compass_twitter_bootstrap', :git => 'git://github.com/vwall/compass-twitter-bootstrap.git'
+
+gem 'json', :platform => 'ruby_18'
+
+gem 'sinatra', '>= 1.3.2', '< 2.0.0'

data/README.md

@@ -1,4 +1,5 @@
 # Interpol
+![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)
 

data/Rakefile

@@ -7,7 +7,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.ruby_opts  = "-Ispec -rsimplecov_setup"
 end
 
-if RUBY_ENGINE == 'ruby' # MRI only
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ruby' # MRI only
   require 'cane/rake_task'
 
   desc "Run cane to check quality metrics"
@@ -20,7 +20,7 @@ else
   task(:quality) { } # no-op
 end
 
-task default: [:spec, :quality]
+task :default => [:spec, :quality]
 
 desc "Watch Documentation App Compass Files"
 task :compass_watch do

data/lib/interpol/configuration.rb

@@ -1,6 +1,7 @@
 require 'interpol/endpoint'
 require 'interpol/errors'
 require 'yaml'
+require 'interpol/configuration_ruby_18_extensions'  if RUBY_VERSION.to_f < 1.9
 
 module Interpol
   module DefinitionFinder
@@ -88,15 +89,21 @@ module Interpol
 
   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
+    # 1.9 version
+    include Module.new {
+      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
+    }
+
+    # Needed to override deserialized_hash_from for Ruby 1.8
+    include Interpol::ConfigurationRuby18Extensions  if RUBY_VERSION.to_f < 1.9
 
     def yaml_content_for(file)
       File.read(file).gsub(/\A---\n/, "---\n" + endpoint_merge_keys + "\n\n")
@@ -115,14 +122,14 @@ module Interpol
 
       validate_if do |env, status, headers, body|
         headers['Content-Type'].to_s.include?('json') &&
-        (200..299).cover?(status) && status != 204 # No Content
+        status >= 200 && status <= 299 && 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)
+        halt 406, JSON.dump(:error => message)
       end
     end
   end

data/lib/interpol/configuration_ruby_18_extensions.rb

@@ -0,0 +1,27 @@
+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

data/lib/interpol/documentation.rb

@@ -32,20 +32,38 @@ module Interpol
 
       def schema_description(doc, schema)
         return unless schema.has_key?('description')
-        doc.h3(class: "description") { doc.text(schema['description']) }
+        doc.h3(:class => "description") { doc.text(schema['description']) }
+      end
+
+      def render_properties_and_items(doc, schema)
+        render_properties(doc, Array(schema['properties']))
+        render_items(doc, schema['items'])
       end
 
       def schema_definition(doc, schema)
-        doc.div(class: "schema-definition") do
+        doc.div(:class => "schema-definition") do
           schema_description(doc, schema)
-          render_properties(doc, Array(schema['properties']))
+          render_properties_and_items(doc, schema)
         end
       end
 
+      def render_items(doc, items)
+        # No support for tuple-typing, just basic array typing
+        return  if items.nil?
+        doc.dl(:class => "items") do
+          doc.dt(:class => "name") { doc.text("(array contains #{items['type']}s)") }
+          if items.has_key?('description')
+            doc.dd { doc.text(items['description']) }
+          end
+          render_properties_and_items(doc, items)
+        end
+
+      end
+
       def render_properties(doc, properties)
         return if properties.none?
 
-        doc.dl(class: "properties") do
+        doc.dl(:class => "properties") do
           properties.each do |name, property|
             property_definition(doc, name, property)
           end
@@ -53,13 +71,13 @@ module Interpol
       end
 
       def property_definition(doc, name, property)
-        doc.dt(class: "name") { doc.text(property_title name, property) }
+        doc.dt(:class => "name") { doc.text(property_title name, property) }  if name
 
         if property.has_key?('description')
           doc.dd { doc.text(property['description']) }
         end
 
-        render_properties(doc, Array(property['properties']))
+        render_properties_and_items(doc, property)
       end
 
       def property_title(name, property)

data/lib/interpol/documentation_app.rb

@@ -15,7 +15,7 @@ module Interpol
     def render_static_page(&block)
       require 'rack/mock'
       app = build(&block)
-      status, headers, body = app.call(Rack::MockRequest.env_for "/", method: "GET")
+      status, headers, body = app.call(Rack::MockRequest.env_for "/", :method => "GET")
       AssetInliner.new(body.join, app.public_folder).standalone_page
     end
 
@@ -36,13 +36,13 @@ module Interpol
 
       def inline_stylesheets
         @doc.css("link[rel=stylesheet]").map do |link|
-          inline_asset link, "style", link['href'], type: "text/css"
+          inline_asset link, "style", link['href'], :type => "text/css"
         end
       end
 
       def inline_javascript
         @doc.css("script[src]").each do |script|
-          inline_asset script, "script", script['src'], type: "text/javascript"
+          inline_asset script, "script", script['src'], :type => "text/javascript"
         end
       end
 
@@ -77,6 +77,15 @@ module Interpol
       def title
         interpol_config.documentation_title
       end
+
+      def url_path(*path_parts)
+        [ path_prefix, path_parts ].join("/").squeeze('/')
+      end
+      alias_method :u, :url_path
+
+      def path_prefix
+        request.env['SCRIPT_NAME']
+      end
     end
 
     # Private: Builds a stub sinatra app for the given interpol
@@ -93,7 +102,8 @@ module Interpol
           helpers Helpers
 
           get('/') do
-            erb :layout, locals: { endpoints: endpoints, current_endpoint: current_endpoint }
+            erb :layout, :locals => { :endpoints => endpoints,
+                                      :current_endpoint => current_endpoint }
           end
         end
       end

data/lib/interpol/documentation_app/public/stylesheets/screen.css

@@ -4227,6 +4227,6 @@ a.thumbnail:hover {
   visibility: hidden;
 }
 
-dl.properties {
+dl.properties, dl.items {
   margin-left: 25px;
 }

data/lib/interpol/documentation_app/sass/screen.scss

@@ -1,7 +1,7 @@
 @import "compass/reset";
 @import "compass_twitter_bootstrap";
 
-dl.properties {
+dl.properties, dl.items {
   margin-left: 25px;
 }
 

data/lib/interpol/documentation_app/views/layout.erb

@@ -8,7 +8,7 @@
     <meta name="author" content="">
 
     <!-- The styles -->
-    <link href="/stylesheets/screen.css" rel="stylesheet">
+    <link href="<%= u '/stylesheets/screen.css' %>" rel="stylesheet">
     <style type="text/css">
       body {
         padding-top: 60px;
@@ -56,7 +56,7 @@
         </div><!--/span-->
 
         <% endpoints.each do |endpoint| %>
-          <%= erb :endpoint, locals: { endpoint: endpoint, visible: (endpoint == current_endpoint) } %>
+          <%= erb :endpoint, :locals => { :endpoint => endpoint, :visible => (endpoint == current_endpoint) } %>
         <% end %>
       </div><!--/row-->
       <hr>
@@ -70,8 +70,8 @@
     <!-- The javascript
     ================================================== -->
     <!-- Placed at the end of the document so the pages load faster -->
-    <script src="/javascripts/jquery.1.7.2.min.js"></script>
-    <script src="/javascripts/interpol.js"></script>
+    <script src="<%= u '/javascripts/jquery.1.7.2.min.js' %>"></script>
+    <script src="<%= u '/javascripts/interpol.js' %>"></script>
   </body>
 </html>
 

data/lib/interpol/stub_app.rb

@@ -34,9 +34,9 @@ module Interpol
         @app = Sinatra.new do
           set            :interpol_config, config
           helpers        Helpers
-          not_found      { JSON.dump(error: "The requested resource could not be found") }
+          not_found      { JSON.dump(:error => "The requested resource could not be found") }
           before         { content_type "application/json;charset=utf-8" }
-          get('/__ping') { JSON.dump(message: "Interpol stub app running.") }
+          get('/__ping') { JSON.dump(:message => "Interpol stub app running.") }
         end
       end
 

data/lib/interpol/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interpol
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,25 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-17 00:00:00.000000000 Z
+date: 2012-05-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: &2152129140 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.3.2
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *2152129140
 - !ruby/object:Gem::Dependency
   name: json-schema
-  requirement: &2152127380 !ruby/object:Gem::Requirement
+  requirement: &2156420460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -35,10 +21,10 @@ dependencies:
         version: 1.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *2152127380
+  version_requirements: *2156420460
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2152126360 !ruby/object:Gem::Requirement
+  requirement: &2156419960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +32,10 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2152126360
+  version_requirements: *2156419960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152125580 !ruby/object:Gem::Requirement
+  requirement: &2156419120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,10 +43,10 @@ dependencies:
         version: '2.9'
   type: :development
   prerelease: false
-  version_requirements: *2152125580
+  version_requirements: *2156419120
 - !ruby/object:Gem::Dependency
   name: rspec-fire
-  requirement: &2152125020 !ruby/object:Gem::Requirement
+  requirement: &2156418120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +54,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *2152125020
+  version_requirements: *2156418120
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2152124120 !ruby/object:Gem::Requirement
+  requirement: &2156417400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -79,10 +65,10 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *2152124120
+  version_requirements: *2156417400
 - !ruby/object:Gem::Dependency
   name: cane
-  requirement: &2152123560 !ruby/object:Gem::Requirement
+  requirement: &2156416760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,10 +76,10 @@ dependencies:
         version: '1.2'
   type: :development
   prerelease: false
-  version_requirements: *2152123560
+  version_requirements: *2156416760
 - !ruby/object:Gem::Dependency
   name: tailor
-  requirement: &2152122640 !ruby/object:Gem::Requirement
+  requirement: &2156415980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152122640
+  version_requirements: *2156415980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152122040 !ruby/object:Gem::Requirement
+  requirement: &2156415020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -112,10 +98,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *2152122040
+  version_requirements: *2156415020
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2152121500 !ruby/object:Gem::Requirement
+  requirement: &2156413800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -123,7 +109,7 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *2152121500
+  version_requirements: *2156413800
 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:
@@ -133,10 +119,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- License
+- LICENSE
 - Gemfile
 - Rakefile
 - 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