sinatra-chiro 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzYwZmYwNTJjMDNmMzhkMDAxNzVmYzkxYTE0MTM4ZjYyMDcxZDFjZQ==
+  data.tar.gz: !binary |-
+    MDdiNzJhMzQyMDAxNTkyZmY1MzUzNDJmZWI3ZmE0YjFkN2I2MGJlOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDFlNDliMTIzOGE3MjYxMTQzYjRjYzZiODY5NzZmZGVlNTY1YjJmMTg3YzU5
+    YmQ2ZTVmZGI1MTczYjhmYTc5OTlkOGU4ZGRhZDA1MWFjMjE0ZWY0M2I3MjI0
+    MDE2YjA5MDZlYmE2YTAwMTRjZDI1OTc1NGQ5OTQ4ZmU5MWViNjA=
+  data.tar.gz: !binary |-
+    MTE4OTI4YmQ2ZmZiYzY3MDczZTBhNDM0NjI0ODUxOTgxMzI0NDAwNmM5ZmMx
+    ZGQ2YjVkOWIzNzY3Mjg1MGI1MWI1NGUyNTk1MDIxZWExMDQ1ZmNmZTUyNWNm
+    OGEwYTQyM2MwZWU4YjYzMzZiYTdkZmRjYmU4NzgyY2MwZmMwNDk=

data/Gemfile

@@ -0,0 +1,11 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chiro.gemspec
+gemspec
+
+group :development do
+  gem "guard", "~> 1.6.2"
+  gem 'rb-inotify', '~> 0.9'
+  gem "guard-rspec", "~> 2.5.0"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2013 Richard Nienaber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+chiro
+=============
+
+Chiro is a DSL for your sinatra application which generates readable documentation and validates the parameters used in your API. 
+
+The generated documentation includes details of all required parameters for a given route, and can optionally include an example response and possible errors which may occur.
+
+This information can then be viewed for a specific route by including "help" as a query string parameter in the relevent URL, or the documentation for all routes can be viewed by using the path /routes.
+
+
+## Implementation
+
+In your server file, every request must be contained within an `endpoint` block. This block must also contain any parameters used by the request in order for them to be documented and validated. Below is a simple example demonstrating the declaration of an endpoint.
+
+```ruby
+app_description "Greeter Application"
+
+endpoint 'Greeter', 'greets the user by name' do
+  named_param(:name, 'name of the user', :type => String)
+  query_param(:greeting, 'how the user wants to be greeted', :type => String, :optional => false)
+  get '/greet/:name' do
+    "#{params[:greeting]}, #{params[:name]}"
+  end
+end
+```
+
+The application must first be named using `app_description`, as shown above, then any endpoints must be declared  in the format:  
+
+    endpoint 'Name of feature', 'description of feature'
+
+
+## Declaring Parameters
+
+If a parameter received via a request has not been declared, or has been declared improperly, a validation error will arise. There are three types of parameters which can be declared in the endpoint:
+
+Query Parameters are found within the query string (eg. /greeter?greeting=hello)
+
+    query_param(:greeting, 'how the user wants to be greeted', :type => String, :optional => true)
+    
+Named Parameters are found between forward slashes in the path (eg. /person/:height)
+
+    named_param(:height, 'the height of the person', :type => Float)
+    
+Form parameters, which are obtained using a post request.
+
+    form(:birthday, 'the date of birth of the user', :type => Date, :optional => false) 
+
+The first two arguments should be the name of the parameter, and a brief description. 
+
+The `:type` argument can be one of `String`, `Fixnum`, `Float`, `Date`, `Time`, `DateTime`, `:boolean`, `Array` or the regular expression for matching. If a value for `:type` is not given, it will default to `String` and will be validated as such.
+
+If `:optional` is false, a validation error will be raised when the parameter has not been given. The value of `:optional` defaults to false for named parameters, and true for query and form parameters. 
+
+If your application assigns a default value to parameters, the optional argument `:default` can be used to tell this to Chiro. For example:
+
+```ruby
+query_param(:greeting, 'how the user wants to be greeted', :type => String, :optional => true, :default => 'hello')
+get '/greet/:name' do
+  greeting = params[:greeting] || 'Hello'
+  "#{greeting}"
+end
+```
+
+
+## Regular Expressions
+
+To customise the validation process to validate a parameter according to a regular expression, you substitute the regular expression as the value of the `:type` argument. It is also useful to add to the declaration a `:comment` argument to explain the expression, and `:type_description`, which updates the type in the documentation.
+
+For example, you might want a `:gender` parameter which only accepts "male" or "female", and would want it to be validated accordingly.
+
+```
+query_param(:gender, 'gender parameter of regexp type', :type => /^male$|^female$/, :type_description => "male|female", :comment => 'Must be "male" or "female"')
+```
+
+
+## Possible Errors
+
+It is also possible for your generated documentation to include details of possible errors which may occur. These can be declared within the endpoint in a similar way to parameters, but with a description and a status code. For example:
+
+```ruby
+possible_error('invalid_request_error', 400, 'Invalid request errors arise when your request has invalid parameters')
+```
+
+
+## Responses
+
+Example responses can also be included this way by including `response` within the endpoint with a hash of all given parameters as the argument. 
+
+```
+    response({:string => 'Richard', :date => '1981-01-01', :time => '12:00:00', :fixnum => 24, :float => 1.2, :array => [1,2,3,4,5]})
+```
+
+This would return the following example response to the documentation:
+
+```
+{
+  string: Richard
+  date: 1981-01-01
+  time: 12:00:00
+  fixnum: 24
+  float: 1.2
+  array: [1, 2, 3, 4, 5]
+}
+              
+```
+
+
+## Validation
+
+If any validation errors occur when your application is run, a response status code 403 will be returned along with a JSON object containing all errors, for example:
+
+```json
+{
+  "validation_errors":[
+    "name parameter must be a string of only letters", 
+    "date parameter must be a string in the format: yyyy-mm-dd"
+  ]
+}
+```

data/lib/sinatra/chiro/document.rb

@@ -0,0 +1,25 @@
+module Sinatra
+  module Chiro
+    class Documentation
+
+      attr_reader :endpoints
+
+      def initialize(endpoints)
+        @endpoints = endpoints
+      end
+
+      def document(env)
+        _, path = env['sinatra.route'].split
+        endpoint = endpoints.select { |d| d.path == path}.flatten.first
+        raise "Path #{path} doesn't have any docs" unless endpoint
+        [[endpoints[0].appname, [endpoint]]]
+      end
+
+      def routes
+        [endpoints[0].appname, endpoints]
+      end
+    end
+  end
+end
+
+

data/lib/sinatra/chiro/endpoint.rb

@@ -0,0 +1,39 @@
+class Endpoint
+  attr_reader :appname, :description, :verb, :path, :named_params, :query_params, :forms, :possible_errors, :response, :title
+
+  def initialize(opts)
+    @appname = opts[:appname]
+    @description = opts[:description]
+    @title = opts[:title]
+    @verb = opts[:verb]
+    @path = opts[:path]
+    @named_params = opts[:named_params]
+    @query_params = opts[:query_params]
+    @perform_validation = opts[:perform_validation]
+    @response = opts[:response]
+    @forms = opts[:forms]
+    @possible_errors = opts[:possible_errors]
+  end
+
+
+  def route
+    "#{verb}: #{path}"
+  end
+
+  def validate?
+    @perform_validation
+  end
+
+  def to_json(*a)
+    {:title => title,
+     :description => description,
+     :verb => verb,
+     :path => path,
+     :named_params => named_params,
+     :query_params => query_params,
+     :forms => forms,
+     :possible_errors => possible_errors,
+     :response => response,
+     }.to_json
+  end
+end

data/lib/sinatra/chiro/monkey_patch.rb

@@ -0,0 +1,33 @@
+module Sinatra
+  class Base
+    #we monkey patch here because at this point we know the name of the route
+    alias_method :old_route_eval, :route_eval
+    def route_eval
+      show_help if params.has_key? "help"
+      validate_parameters if self.class.respond_to?(:validator)
+
+      old_route_eval { yield }
+    end
+
+    def validate_parameters
+      error = self.class.validator.validate(params, env)
+      if error == "not found"
+        status 404
+        throw :halt, "Path not found"
+      elsif error!= nil
+        status 403
+        throw :halt, "#{error}"
+      end
+    end
+
+    def show_help
+      if self.class.respond_to?(:validator)
+        status 200
+        erb_file = settings.erb_file
+        views = settings.views_location
+        throw :halt, "#{erb(erb_file, {:views => views}, :endpoint => self.class.documentation.document(env)) }"
+      end
+    end
+  end
+end
+

data/lib/sinatra/chiro/parameters/array.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/base'
+
+module Sinatra
+  module Chiro
+    module Parameters
+      class ArrayValidator < Base
+        def validate(given)
+          "#{name} parameter must be an Array of Strings" if !given[name].is_a? Array
+        end
+      end
+    end
+  end
+end
+

data/lib/sinatra/chiro/parameters/base.rb

@@ -0,0 +1,44 @@
+module Sinatra
+  module Chiro
+    module Parameters
+      class Base
+        attr_reader :options
+        def initialize(opts={})
+          @options = opts
+        end
+
+        def name
+          @options[:name]
+        end
+
+        def name_display
+          @options[:name].to_s
+        end
+
+        def description
+          @options[:description]
+        end
+
+        def comment
+          nil
+        end
+
+        def type_description
+          @options[:type]
+        end
+
+        def type
+          @options[:type]
+        end
+
+        def default
+          @options[:default]
+        end
+
+        def optional
+          @options[:optional]
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/chiro/parameters/boolean.rb

@@ -0,0 +1,18 @@
+module Sinatra
+  module Chiro
+    module Parameters
+      class BooleanValidator < Base
+        def validate(given)
+          if given[name] != "true" && given[name] != "false"
+            "#{name_display} parameter must be true or false"
+          end
+        end
+
+        def comment
+          "Must be true or false"
+        end
+      end
+    end
+  end
+end
+

data/lib/sinatra/chiro/parameters/date.rb

@@ -0,0 +1,22 @@
+module Sinatra
+  module Chiro
+    module Parameters
+      class DateValidator < Base
+        def validate(given)
+          Date.parse(given.to_s)
+
+          if given[name] !~ /^\d{4}-\d{2}-\d{2}$/
+            "#{name_display} parameter must be a string in the format: yyyy-mm-dd"
+          end
+        rescue ArgumentError
+          "#{name_display} parameter invalid"
+        end
+
+        def comment
+          'Must be expressed according to ISO 8601 (ie. YYYY-MM-DD)'
+        end
+      end
+    end
+  end
+end
+

data/lib/sinatra/chiro/parameters/datetime.rb

@@ -0,0 +1,21 @@
+module Sinatra
+  module Chiro
+    module Parameters
+      class DateTimeValidator < Base
+        def validate(given)
+          DateTime.parse(given.to_s)
+
+          if given[name] !~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$/
+            "#{name_display} parameter must be a string in the format: yyyy-mm-ddThh:mm:ss"
+          end
+        rescue ArgumentError
+          "#{name_display} parameter invalid"
+        end
+        def comment
+          'Must be expressed according to ISO 8601 (ie. YYYY-MM-DDThh:mm:ss)'
+        end
+      end
+    end
+  end
+end
+

data/lib/sinatra/chiro/parameters/fixnum.rb

@@ -0,0 +1,11 @@
+module Sinatra
+  module Chiro
+    module Parameters
+      class FixnumValidator < Base
+        def validate(given)
+          "#{name_display} parameter must be an integer" if given[name] !~/^\s*\d+\s*$/
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/chiro/parameters/float.rb

@@ -0,0 +1,11 @@
+module Sinatra
+  module Chiro
+    module Parameters
+      class FloatValidator < Base
+        def validate(given)
+          "#{name_display} parameter must be a Float" if given[name]!~/^\s*[+-]?((\d+_?)*\d+(\.(\d+_?)*\d+)?|\.(\d+_?)*\d+)(\s*|([eE][+-]?(\d+_?)*\d+)\s*)$/
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/chiro/parameters/parameter_factory.rb

@@ -0,0 +1,26 @@
+module Sinatra
+  module Chiro
+    module Parameters
+      class ParameterFactory
+        def self.validator_from_type(options)
+          validator = case options[:type].to_s
+                        when 'String' then StringValidator
+                        when 'Fixnum' then FixnumValidator
+                        when 'Float' then FloatValidator
+                        when 'Date' then DateValidator
+                        when 'DateTime' then DateTimeValidator
+                        when 'Time' then TimeValidator
+                        when 'boolean' then BooleanValidator
+                        when '[String]' then ArrayValidator
+                        else
+                          if options[:type].is_a? Regexp
+                            RegexpValidator
+                          end
+                      end
+          validator.new(options)
+        end
+      end
+    end
+  end
+end
+

data/lib/sinatra/chiro/parameters/regexp.rb

@@ -0,0 +1,22 @@
+module Sinatra
+  module Chiro
+    module Parameters
+      class RegexpValidator < Base
+
+        def validate(given)
+          "#{name_display} parameter should match regexp: #{options[:type]}" if given[name] !~ options[:type]
+        end
+
+        def type_description
+          super || "Regexp"
+        end
+
+        def comment
+          "#{options[:comment]}"
+        end
+
+      end
+    end
+  end
+end
+

data/lib/sinatra/chiro/parameters/string.rb

@@ -0,0 +1,16 @@
+module Sinatra
+  module Chiro
+    module Parameters
+      class StringValidator < Base
+        def validate(given)
+          if given[name_display] !~/^[a-zA-Z]*$/
+            "#{name_display} parameter must be a string of only letters"
+          elsif given[name_display].empty?
+            "#{name_display} parameter must not be empty"
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/sinatra/chiro/parameters/time.rb

@@ -0,0 +1,22 @@
+module Sinatra
+  module Chiro
+    module Parameters
+      class TimeValidator < Base
+        def validate(given)
+          Time.parse(given.to_s)
+
+          if given[name] !~ /^\d{2}:\d{2}:\d{2}$/
+            "#{name_display} parameter must be a string in the format: hh:mm:ss"
+          end
+        rescue ArgumentError
+          "#{name_display} parameter invalid"
+        end
+
+        def comment
+          'Must be expressed according to ISO 8601 (ie. hh:mm:ss)'
+        end
+      end
+    end
+  end
+end
+

data/lib/sinatra/chiro/validate.rb

@@ -0,0 +1,47 @@
+require 'time'
+
+module Sinatra
+  module Chiro
+    class Validation
+      attr_reader :endpoints
+
+      def initialize(endpoints)
+        @endpoints = endpoints
+      end
+
+      def validate(params, env)
+        _, path = env['sinatra.route'].split
+
+        endpoint = endpoints.select { |d| d.path == path }.flatten.first
+        return if endpoint.nil?
+
+        all_given = params.dup
+        all_given.delete('captures')
+        all_given.delete('splat')
+
+        all_params = endpoint.named_params + endpoint.query_params + endpoint.forms
+
+        allowed_params = []
+        errors = []
+
+        all_params.each do |parameter|
+          unless all_given[parameter.name_display].nil?
+            errors << parameter.validate(all_given)
+          end
+          if !parameter.optional
+            errors << "must include a #{parameter.name_display} parameter" if all_given[parameter.name_display].nil?
+          end
+          allowed_params << parameter.name_display
+        end
+
+        all_given.map { |k, _| k.to_s}.each do |param|
+          errors << "#{param} is not a valid parameter" if !allowed_params.include?(param)
+        end
+
+        if !errors.compact.empty? then
+          JSON.dump ({:validation_errors => errors.compact})
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/chiro.rb

@@ -0,0 +1,118 @@
+require 'sinatra/chiro/endpoint'
+require 'sinatra/chiro/document'
+require 'sinatra/chiro/validate'
+require 'sinatra/chiro/monkey_patch'
+Dir[File.dirname(__FILE__) + '/chiro/parameters/*.rb'].sort.each { |f| require f}
+
+CHIRO_APPS = []
+module Sinatra
+  module Chiro
+    def endpoints
+      @endpoints ||= []
+    end
+
+    def validator
+      @validator ||= Validation.new(endpoints)
+    end
+
+    def documentation
+      @documentation ||= Documentation.new(endpoints)
+    end
+
+    def app_description(description)
+      @app_description = description
+    end
+
+    def endpoint(title=nil, description=nil, opts={})
+      opts[:title] ||= title
+      opts[:description] ||= description
+      opts[:perform_validation] ||= true
+      @named_params = []
+      @query_params = []
+      @forms = []
+      @possible_errors = []
+      @response = nil
+      @appname = @app_description || self.name
+
+      yield
+
+      opts[:verb] = @verb || :GET
+      opts[:named_params] = @named_params
+      opts[:query_params] = @query_params
+      opts[:forms] = @forms
+      opts[:possible_errors] = @possible_errors
+      opts[:response] = @response
+      opts[:path] = @path
+      opts[:appname] = @appname
+      endpoints << Endpoint.new(opts)
+    end
+
+    def named_param(name, description, opts={})
+      opts.merge!(:name => name, :description => description, :optional => false)
+      Chiro.remove_unknown_param_keys(opts)
+      Chiro.set_param_defaults(opts)
+      @named_params << Parameters::ParameterFactory.validator_from_type(opts)
+    end
+
+    def form(name, description, opts={})
+      opts.merge!(:name => name, :description => description)
+      Chiro.remove_unknown_param_keys(opts)
+      Chiro.set_param_defaults(opts)
+      @forms << Parameters::ParameterFactory.validator_from_type(opts)
+    end
+
+    def query_param(name, description, opts={})
+      opts.merge!(:name => name, :description => description)
+      Chiro.set_param_defaults(opts)
+      @query_params << Parameters::ParameterFactory.validator_from_type(opts)
+    end
+
+    def possible_error(name, code, description)
+      @possible_errors << {:name => name, :code => code, :description => description}
+    end
+
+    def get(path, opts = {}, &block)
+      @path = path
+      @verb = :GET
+      super
+    end
+
+    def post(path, opts = {}, &block)
+      @path = path
+      @verb = :POST
+      super
+    end
+
+    def response(result)
+      @response = result
+    end
+
+    def self.registered(app)
+      CHIRO_APPS << app
+
+      app.set :erb_file, :help
+      app.set :views_location, File.join(File.dirname(__FILE__), '..', 'views')
+
+      app.get '/routes' do
+        routes = CHIRO_APPS.select { |a| a.respond_to?(:documentation) }.map { |a| a.documentation.routes }
+        erb_file = settings.erb_file
+        views = settings.views_location
+        erb(erb_file, {:views => views}, :endpoint => routes)
+      end
+    end
+
+    private
+    def self.remove_unknown_param_keys(opts)
+      known_options = [:name, :description, :default, :type, :optional, :validator, :comment, :type_description]
+      opts.delete_if { |k| !k.is_a?(Symbol) || !known_options.include?(k)}
+    end
+
+    def self.set_param_defaults(opts)
+      opts[:type] ||= String
+      opts[:optional] ||= true if opts[:optional].nil?
+    end
+
+  end
+
+  register Sinatra::Chiro
+end

data/lib/sinatra/chiro_version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Chiro
+    VERSION = '0.0.2'
+  end
+end

data/lib/views/help.erb

@@ -0,0 +1,259 @@
+
+
+<!DOCTYPE html>
+<!--[if lt IE 7]>
+<html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
+<!--[if IE 7]>
+<html class="no-js lt-ie9 lt-ie8"> <![endif]-->
+<!--[if IE 8]>
+<html class="no-js lt-ie9"> <![endif]-->
+<!--[if gt IE 8]><!-->
+<html class="no-js"> <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <title>Documentation</title>
+  <meta name="description" content="">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link href="//netdna.bootstrapcdn.com/bootstrap/3.0.0-rc1/css/bootstrap.min.css" rel="stylesheet">
+  <style>
+      .scrollspy-example {
+          overflow: auto;
+          position: relative;
+          height: auto;
+      }
+
+      thead {
+          background-color: #D3EDFB;
+      }
+
+      .container {
+          padding-top: 0;
+          margin-left: 15px;
+          height: 100%
+      }
+
+      body {
+          color: #54606c;
+      }
+
+      .hero-unit {
+          padding: 30px;
+          border-bottom: solid thin #DDDDDD;
+      }
+
+      p {
+          color: #73C3ED;
+          font-size: 16px;
+          padding-left: 15px;
+      }
+
+      h1 {
+        padding-top: 30px;
+      }
+
+      h2 {
+          padding-left: 15px;
+      }
+
+      .table {
+          font-size: 14px;
+      }
+
+      pre {
+          height: auto;
+          max-height: 200px;
+          line-height: 10px;
+          overflow: auto;
+          background-color: #F9F9F9
+      }
+
+      .sidebar {
+          border-left: solid thin #DDDDDD;
+          padding: 50px 0 0 0;
+      }
+
+      .nav-pills {
+          overflow: auto;
+          height: 100%;
+      }
+
+      li {
+          color: #54606c;
+          padding: 0 20px 0 20px;
+          width: 100%;
+          text-align: left
+      }
+
+      a {
+          color: #54606c;
+      }
+
+      .nav-pills>li>a:hover {
+          color: white;
+          background-color: #D3EDFB;
+      }
+
+      .nav-pills>li.active>a:hover {
+          color: #54606c;
+          background-color: #D3EDFB;
+      }
+
+      .nav-pills>li.active>a {
+          color: #54606c;
+          background-color: #D3EDFB;
+      }
+  </style>
+</head>
+
+
+<body data-spy="scroll" data-target="#navbarExample" data-offset="50" class="scrollspy-example">
+
+<div class="container">
+  <div class="col-lg-9">
+    <% endpoint.each do |endpoints| %>
+        <h1 id="<%= endpoints[0].downcase.tr(" ", "_") %>"><%= endpoints[0] %></h1>
+        <% endpoints[1].each do |endpoint| %>
+        <div class="hero-unit" id="<%= endpoint.title.downcase.tr(" ", "_") %>">
+
+          <h2><%= endpoint.title %></h2>
+          <p><%= endpoint.description %></p>
+          <h3><%= endpoint.route %></h3>
+
+          <% if !endpoint.query_params.empty? %>
+              <h4>Query String Parameters:</h4>
+              <table class='table table-striped table-bordered table-condensed'>
+                <thead>
+                <tr>
+                  <th>Name</th>
+                  <th>Description</th>
+                  <th>Type</th>
+                  <th>Optional</th>
+                  <th>Comment</th>
+                </tr>
+                </thead>
+                <% endpoint.query_params.each do |p| %>
+                    <tbody>
+                    <td><%= p.name %></td>
+                    <td><%= p.description %></td>
+                    <td><%= p.type_description %></td>
+                    <td><%= p.optional %></td>
+                    <td><%= p.comment %></td>
+                    </tbody>
+                <% end %>
+              </table>
+          <% end %>
+
+          <% if !endpoint.named_params.empty? %>
+              <h4>Named Parameters:</h4>
+              <table class='table table-striped table-bordered table-condensed'>
+                <thead>
+                <tr>
+                  <th>Name</th>
+                  <th>Description</th>
+                  <th>Type</th>
+                  <th>Optional</th>
+                  <th>Comment</th>
+                </tr>
+                </thead>
+                <% endpoint.named_params.each do |p| %>
+                    <tbody>
+                    <td><%= p.name %></td>
+                    <td><%= p.description %></td>
+                    <td><%= p.type_description %></td>
+                    <td><%= p.optional %></td>
+                    <td><%= p.comment %></td>
+                    </tbody>
+                <% end %>
+              </table>
+          <% end %>
+
+          <% if !endpoint.forms.empty? %>
+              <h4>Form Parameters:</h4>
+              <table class='table table-striped table-bordered table-condensed'>
+                <thead>
+                <tr>
+                  <th>Name</th>
+                  <th>Description</th>
+                  <th>Type</th>
+                  <th>Optional</th>
+                  <th>Comment</th>
+                </tr>
+                </thead>
+                <% endpoint.forms.each do |p| %>
+                    <tbody>
+                    <td><%= p.name %></td>
+                    <td><%= p.description %></td>
+                    <td><%= p.type_description %></td>
+                    <td><%= p.optional %></td>
+                    <td><%= p.comment %></td>
+                    </tbody>
+                <% end %>
+              </table>
+          <% end %>
+
+          <% if !endpoint.possible_errors.empty? %>
+              <h4>Possible Errors:</h4>
+              <table class='table table-striped table-bordered table-condensed'>
+                <thead>
+                <tr>
+                  <th>Name</th>
+                  <th>Code</th>
+                  <th>Description</th>
+                </tr>
+                </thead>
+                <% endpoint.possible_errors.each do |p| %>
+                    <tbody>
+                    <td><%= p[:name] %></td>
+                    <td><%= p[:code] %></td>
+                    <td><%= p[:description] %></td>
+                    </tbody>
+                <% end %>
+              </table>
+          <% end %>
+
+          <% if !endpoint.response.nil? %>
+              <h4>Response:</h4>
+              <pre>
+                {
+                <% endpoint.response.each do |k, v| %>
+                    <%= "#{k}: #{v}" %>
+                <% end %>
+                }
+              </pre>
+          <% end %>
+        </div>
+    <% end %>
+    <% end %>
+  </div>
+
+  <div class="row">
+    <div class="col-lg-3">
+      <div id="navbarExample">
+        <div class="col-lg-3">
+          <ul type=none class="nav nav-pills sidebar affix">
+            <% endpoint.each do |endpoints| %>
+            <li class="">
+              <a href='#<%= endpoints[0].downcase.tr(" ", "_")%>'><%=endpoints[0]%></a>
+              <ul class = "nav nav-pills">
+            <% endpoints[1].each do |endpoint| %>
+                <li class="">
+                  <a href='#<%= endpoint.title.downcase.tr(" ", "_") %>'><%= endpoint.title %></a>
+                </li>
+            <% end %>
+              </ul>
+            </li>
+            <% end %>
+          </ul>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+
+<script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
+<script src="//netdna.bootstrapcdn.com/bootstrap/3.0.0-rc1/js/bootstrap.min.js"></script>
+</body>
+</html>
+
+

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-chiro
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Richard Nienaber
+- Scott Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Documents and validates sinatra api requests
+email:
+- rjnienaber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/sinatra/chiro.rb
+- lib/sinatra/chiro/document.rb
+- lib/sinatra/chiro/endpoint.rb
+- lib/sinatra/chiro/monkey_patch.rb
+- lib/sinatra/chiro/parameters/array.rb
+- lib/sinatra/chiro/parameters/base.rb
+- lib/sinatra/chiro/parameters/boolean.rb
+- lib/sinatra/chiro/parameters/date.rb
+- lib/sinatra/chiro/parameters/datetime.rb
+- lib/sinatra/chiro/parameters/fixnum.rb
+- lib/sinatra/chiro/parameters/float.rb
+- lib/sinatra/chiro/parameters/parameter_factory.rb
+- lib/sinatra/chiro/parameters/regexp.rb
+- lib/sinatra/chiro/parameters/string.rb
+- lib/sinatra/chiro/parameters/time.rb
+- lib/sinatra/chiro/validate.rb
+- lib/sinatra/chiro_version.rb
+- lib/views/help.erb
+homepage: https://github.com/rjnienaber/chiro
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: An easy way to produce self-documenting sinatra apis
+test_files: []