weasel_diesel 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76695321f4c49f270788ffc3743ed2ca1668c774
-  data.tar.gz: 567a24d4bac5544bb3d7d89df0fea271afa273b0
+  metadata.gz: 66a37bea5e3454ee526eb9281ae4e98ce75945db
+  data.tar.gz: 29e993efacc6873959b347b4141e93f1cbb85738
 SHA512:
-  metadata.gz: 9fc1388dc4e52f7ec91b518f26319d85e4b14f92bf586f036cc53e920ee9017cbffeda361b4b0c786aa06d5fde37f79ba01df0fabbc2ae4e68c4be4688277377
-  data.tar.gz: be2eb8217e849bb8b4bdd9b2fe818d4c1ca7928750da35271f707f797636ec8a18722e51c2c83962e10660cb55c45aa6ef7603fa443d89488024c77875af0af5
+  metadata.gz: a04322e780856bf69f40e3311cfd3fdd00c4bbabb492b30b8822e99537dac179a7d1929040c3710313df8aa753803415a5465387fe58789a3287f3187477f31d
+  data.tar.gz: 473aa3828ff0474ecafad534d986353d67b415fbdcbb9b358ddc461146538ae396e4523882db54ef9705954dd2c605c40db7385976c9ac3ca9235b417eb96e16

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
   - jruby

data/CHANGELOG.md

@@ -3,10 +3,16 @@
 All changes can be seen on GitHub and git tags are used to isolate each
 release.
 
-1.2.2:
+## 1.3.0
+* Move documentation generation from wd_sinatra into Weasel-Diesel.
+* Drop support for Ruby 1.8.7.
+* Fix rspec deprecation: `expect { }.not_to raise_error(SpecificErrorClass)`
+* DSL now only extends the top level main object.
+
+## 1.2.2:
 * Added support for anonymous top level arrays.
 
-*1.2.1*:
+## 1.2.1:
 
 * Modified the way an empty string param is cast/verified. If a param is
 passed as an empty string but the param isn't specified as a string, the
@@ -15,8 +21,7 @@ an integer param, the cast params will look like that: `{'id' => nil}`,
 however if `name` is a string param and `{'name' => ''}` is passed, the
 value won't be nullified.
 
-
-**1.2.0**: 
+## 1.2.0:
 
 * All service urls are now stored with a prepended slash (if not defined
   with one). `WDList.find(<verb>, <url>)` will automatically find the

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in weasel_diesel.gemspec
 gemspec

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2012 Matt Aimonetti
+MIT: http://mattaimonetti.mit-license.org
+
+Copyright (c) 2013 Matt Aimonetti
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,7 +2,7 @@
 
 [![CI Build Status](https://secure.travis-ci.org/mattetti/Weasel-Diesel.png?branch=master)](http://travis-ci.org/mattetti/Weasel-Diesel)
 
-Weasel Diesel is a DSL to describe and document your web API. 
+Weasel Diesel is a DSL to describe and document your web API.
 
 To get you going quickly, see the [generator for sinatra apps](https://github.com/mattetti/wd-sinatra).
 The wd_sinatra gem allows you to generate the structure for a sinatra app using Weasel Diesel and with lots of goodies.
@@ -34,8 +34,8 @@ describe_service "/hello_world" do |service|
 
   # DOCUMENTATION
   service.documentation do |doc|
-  	doc.overall "This service provides a simple hello world implementation example."
-  	doc.example "<code>curl -I 'http://localhost:9292/hello_world?name=Matt'</code>"
+    doc.overall "This service provides a simple hello world implementation example."
+    doc.example "<code>curl -I 'http://localhost:9292/hello_world?name=Matt'</code>"
  end
 
   # ACTION/IMPLEMENTATION (specific to the sinatra app example, can
@@ -55,34 +55,34 @@ Or a more complex example using XML:
     describe_service "/wsdsl/test.xml" do |service|
       service.formats  :xml, :json
       service.http_verb :get
-      
+
       # INPUT
       service.params do |p|
         p.string :framework, :in => SpecOptions, :null => false, :required => true
-       
-        p.datetime :timestamp, 
-                   :default => Time.now, 
+
+        p.datetime :timestamp,
+                   :default => Time.now,
                    :doc => "The test framework used, could be one of the two following: #{SpecOptions.join(", ")}."
 
         p.string   :alpha,     :in      => ['a', 'b', 'c']
-        p.string   :version,   
+        p.string   :version,
                    :null    => false,
                    :doc => "The version of the framework to use."
-                   
+
         p.integer  :num,      :minvalue => 42
         p.namespace :user do |user|
           user.integer :id, :required => :true
         end
       end
-      
+
       # OUTPUT
-      # the response contains a list of player creation ratings each object in the list 
+      # the response contains a list of player creation ratings each object in the list
       service.response do |response|
         response.element(:name => "player_creation_ratings") do |e|
           e.attribute  :id          => :integer, :doc => "id doc"
           e.attribute  :is_accepted => :boolean, :doc => "is accepted doc"
           e.attribute  :name        => :string,  :doc => "name doc"
-          
+
           e.array :name => 'player_creation_rating', :type => 'PlayerCreationRating' do |a|
             a.attribute :comments  => :string,  :doc => "comments doc"
             a.attribute :player_id => :integer, :doc => "player_id doc"
@@ -91,14 +91,14 @@ Or a more complex example using XML:
           end
         end
       end
-      
+
       # DOCUMENTATION
       service.documentation do |doc|
         # doc.overall <markdown description text>
         doc.overall <<-DOC
          This is a test service used to test the framework.
         DOC
-        
+
         # doc.example <markdown text>
         doc.example <<-DOC
     The most common way to use this service looks like that:
@@ -178,7 +178,7 @@ This is particuliarly frequent when using Rails for instance.
 
 ```ruby
 service.params do |param|
-    param.string :framework, 
+    param.string :framework,
       :in => ['RSpec', 'Bacon'],
       :required => true,
       :doc => "The test framework used, could be one of the two following: #{WeaselDieselSpecOptions.join(", ")}."
@@ -240,26 +240,26 @@ end
 
 Consider the following JSON response:
 
-``` 
-    { people: [ 
-      { 
-        id : 1, 
+```
+    { people: [
+      {
+        id : 1,
         online : false,
-        created_at : 123123123123, 
+        created_at : 123123123123,
         team : {
           id : 1231,
           score : 123.32
         }
-      }, 
-      { 
-        id : 2, 
+      },
+      {
+        id : 2,
         online : true,
-        created_at : 123123123123, 
+        created_at : 123123123123,
         team: {
           id : 1233,
           score : 1.32
         }
-      }, 
+      },
     ] }
 ```
 
@@ -287,7 +287,7 @@ Nodes/elements can also use some meta-attributes including:
 * `key` : refers to an attribute name that is key to this object
 * `type` : refers to the type of object described, valuable when using JSON across OO based apps.
 
-JSON response validation can be done using an optional module as shown in 
+JSON response validation can be done using an optional module as shown in
 (spec/json_response_verification_spec.rb)[https://github.com/mattetti/Weasel-Diesel/blob/master/spec/json_response_verification_spec.rb].
 The goal of this module is to help automate API testing by
 validating the data structure of the returned object.
@@ -312,7 +312,7 @@ end
 ```
 
 Actual output:
-``` 
+```
  {"name": "Example"}
 ```
 
@@ -328,42 +328,20 @@ describe_service "example" do |service|
 end
 ```
 
+## Documentation generation
 
-## Test Suite & Dependencies
-
-The test suite requires Ruby 1.9.* along with `RSpec`, `Rack`, and `Sinatra` gems.
-
-## Usage with Ruby 1.8
-
-This library prioritizes Ruby 1.9, but 1.8 support was added 
-via the backports library and some tweaks. 
-
-However, because Ruby 1.8 hashes do not preserve insert order, the following syntax
-**will not work**:
-
-``` ruby
-    service.response do |response|
-      response.element(:name => "player_creation_ratings") do |e|
-        e.attribute  :id          => :integer, :doc => "id doc"
-        e.attribute  :is_accepted => :boolean, :doc => "is accepted doc"
-        e.attribute  :name        => :string,  :doc => "name doc"
-      end
-    end
+```bash
+    $ weasel_diesel generate_doc <SOURCE_PATH> <DESTINATION_PATH>
 ```
 
-Instead, this alternate syntax must be used:
+To generate documentation for the APIs you created in the api folder. The
+source path is the location of your ruby files. The destination is optional,
+'doc' is the default.
 
-``` ruby
-    service.response do |response|
-      response.element(:name => "player_creation_ratings") do |e|
-        e.integer  :id, :doc => "id doc"
-        e.boolean  :is_accepted, :doc => "is accepted doc"
-        e.string   :name, :doc => "name doc"
-      end
-    end
-```
 
-The end results are identical.
+## Test Suite & Dependencies
+
+The test suite requires `rspec`, `rack`, and `sinatra` gems.
 
 ## Copyright
 

data/bin/weasel_diesel

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require_relative "../lib/weasel_diesel/cli"
+
+WeaselDiesel::CLI.start

data/lib/framework_ext/sinatra_controller.rb

@@ -1,5 +1,5 @@
 require 'forwardable'
-require File.expand_path('./../params_verification', File.dirname(__FILE__))
+require_relative '../params_verification'
 
 # Base code shared by all service controllers
 # This allows us to share code between controllers
@@ -10,44 +10,44 @@ require File.expand_path('./../params_verification', File.dirname(__FILE__))
 # @author Matt Aimonetti
 class SinatraServiceController
   extend Forwardable
-  
+
   # The service controller might be loaded outside of a Sinatra App
   # in this case, we don't need to load the helpers
   if Object.const_defined?(:Sinatra)
-    include Sinatra::Helpers 
+    include Sinatra::Helpers
   end
-  
+
   class AuthenticationFailed < StandardError; end
-  
+
   # @return [WeaselDiesel] The service served by this controller
   # @api public
   attr_reader :service
-  
+
   # @return [Sinatra::Application]
   # @api public
   attr_reader :app
-  
+
   # @return [Hash]
   # @api public
   attr_reader :env
-  
+
   # @return [Sinatra::Request]
   # @see http://rubydoc.info/github/sinatra/sinatra/Sinatra/Request
   # @api public
   attr_reader :request
-  
+
   # @return [Sinatra::Response]
   # @see http://rubydoc.info/github/sinatra/sinatra/Sinatra/Response
   # @api public
   attr_reader :response
-  
+
   # @return [Hash]
   # @api public
   attr_accessor :params
-  
+
   # @param [Sinatra::Application] app The Sinatra app used as a reference and to access request params
   # @param [WeaselDiesel] service The service served by this controller
-  # @raise [ParamError, NoParamsDefined, MissingParam, UnexpectedParam, InvalidParamType, InvalidParamValue] 
+  # @raise [ParamError, NoParamsDefined, MissingParam, UnexpectedParam, InvalidParamType, InvalidParamValue]
   #   If the params don't validate one of the {ParamsVerification} errors will be raised.
   # @api public
   def initialize(app, service)
@@ -56,10 +56,10 @@ class SinatraServiceController
     @request  = app.request
     @response = app.response
     @service  = service
-   
+
     # raises an exception if the params are not valid
-    # otherwise update the app params with potentially new params (using default values)   
-    # note that if a type if mentioned for a params, the object will be cast to this object type 
+    # otherwise update the app params with potentially new params (using default values)
+    # note that if a type if mentioned for a params, the object will be cast to this object type
     @params = app.params = ParamsVerification.validate!(app.params, service.defined_params)
 
     # Authentication check
@@ -67,7 +67,7 @@ class SinatraServiceController
       raise AuthenticationFailed unless logged_in?
     end
   end
-  
+
 
   # Forwarding some methods to the underlying app object
   def_delegators :app, :settings, :halt, :compile_template, :session
@@ -76,5 +76,5 @@ class SinatraServiceController
   def logged_in?
     !session[:player_id].nil?
   end
-    
+
 end

data/lib/response.rb

@@ -24,7 +24,7 @@ class WeaselDiesel
     # Lists all top level simple elements and array elements.
     #
     # @return [Array<WeaselDiesel::Response::Element, WeaselDiesel::Response::Array>]
-    def nodes 
+    def nodes
       elements + arrays
     end
 
@@ -153,6 +153,7 @@ class WeaselDiesel
         @type       = type
         @attributes = []
         @meta_attributes = []
+        @elements   = []
         @vectors    = []
         @key        = nil
         # we don't need to initialize the nested elements, by default they should be nil
@@ -164,7 +165,7 @@ class WeaselDiesel
       # @option opts [String, Symbol] attribute_name The name of the attribute, the value being the type
       # @option opts [String, Symbol] :doc The attribute documentation
       # @option opts [String, Symbol] :mock An optional mock value used by service related tools
-      # 
+      #
       # @example Creation of a response attribute called 'best_lap_time'
       #   service.response do |response|
       #    response.element(:name => "my_stats", :type => 'Leaderboard') do |e|
@@ -174,13 +175,13 @@ class WeaselDiesel
       #
       # @return [Array<WeaselDiesel::Response::Attribute>]
       # @api public
-      def attribute(opts, extra_opts={})
-        raise ArgumentError unless opts.is_a?(Hash) && extra_opts.is_a?(Hash)
-        new_attribute = Attribute.new(opts, extra_opts)
+      def attribute(opts)
+        raise ArgumentError unless opts.is_a?(Hash)
+        new_attribute = Attribute.new(opts)
         @attributes << new_attribute
         # document the attribute if description available
         # we might want to have a placeholder message when a response attribute isn't defined
-        if opts.merge!(extra_opts).has_key?(:doc)
+        if opts.has_key?(:doc)
           @doc.attribute(new_attribute.name, opts[:doc])
         end
         @attributes
@@ -191,7 +192,7 @@ class WeaselDiesel
       # @param [Hash] opts An element's attribute options
       # @option opts [String, Symbol] attribute_name The name of the attribute, the value being the type
       # @option opts [String, Symbol] :mock An optional mock value used by service related tools
-      # 
+      #
       # @example Creation of a response attribute called 'best_lap_time'
       #   service.response do |response|
       #    response.element(:name => "my_stats", :type => 'Leaderboard') do |e|
@@ -212,12 +213,12 @@ class WeaselDiesel
       # Defines an array aka vector of elements.
       #
       # @param [String, Symbol] name The name of the array element.
-      # @param [String, Symbol] type Optional type information, useful to store the represented 
+      # @param [String, Symbol] type Optional type information, useful to store the represented
       #        object types for instance.
       #
       # @param [Proc] &block
       #   A block to execute against the newly created array.
-      # 
+      #
       # @example Defining an element array called 'player_creation_rating'
       #   element.array 'player_creation_rating', 'PlayerCreationRating' do |a|
       #     a.attribute :comments  => :string
@@ -227,7 +228,7 @@ class WeaselDiesel
       #   end
       # @yield [Vector] the newly created array/vector instance
       # @see Element#initialize
-      # 
+      #
       # @return [Array<WeaselDiesel::Response::Vector>]
       # @api public
       def array(name, type=nil)
@@ -299,7 +300,7 @@ class WeaselDiesel
       # @param [Symbol, String] name the name of the attribute.
       # @param [Hash] opts the attribute options.
       def string(name=nil, opts={})
-        attribute({name => :string}, opts)
+        attribute({name => :string}.merge(opts))
       end
 
       # Shortcut to create a string attribute
@@ -307,7 +308,7 @@ class WeaselDiesel
       # @param [Symbol, String] name the name of the attribute.
       # @param [Hash] opts the attribute options.
       def integer(name=nil, opts={})
-        attribute({name => :integer}, opts)
+        attribute({name => :integer}.merge(opts))
       end
 
       # Shortcut to create a string attribute
@@ -315,7 +316,7 @@ class WeaselDiesel
       # @param [Symbol, String] name the name of the attribute.
       # @param [Hash] opts the attribute options.
       def float(name=nil, opts={})
-        attribute({name => :float}, opts)
+        attribute({name => :float}.merge(opts))
       end
 
       # Shortcut to create a string attribute
@@ -323,7 +324,7 @@ class WeaselDiesel
       # @param [Symbol, String] name the name of the attribute.
       # @param [Hash] opts the attribute options.
       def boolean(name=nil, opts={})
-        attribute({name => :boolean}, opts)
+        attribute({name => :boolean}.merge(opts))
       end
 
       # Shortcut to create a string attribute
@@ -331,20 +332,21 @@ class WeaselDiesel
       # @param [Symbol, String] name the name of the attribute.
       # @param [Hash] opts the attribute options.
       def datetime(name=nil, opts={})
-        attribute({name => :datetime}, opts)
+        attribute({name => :datetime}.merge(opts))
       end
 
       # Converts an element into a hash representation
       #
+      # @param [Boolean] root_node true if this node has no parents.
       # @return [Hash] the element attributes formated in a hash
-      def to_hash
+      def to_hash(root_node=true)
         attrs = {}
         attributes.each{ |attr| attrs[attr.name] = attr.type }
-        elements.each{ |el| attrs[el.name] = el.to_hash } if elements
+        (vectors + elements).each{ |el| attrs[el.name] = el.to_hash(false) }
         if self.class == Vector
-          name ? {name => [attrs]} : [attrs]
+          (root_node && name) ? {name => [attrs]} : [attrs]
         else
-          name ? {name => attrs} : attrs
+          (root_node && name) ? {name => attrs} : attrs
         end
       end
 
@@ -429,17 +431,14 @@ class WeaselDiesel
         # name, type, doc, type
         #
         # @param [Hash, Array] o_params
-        # @param [Hash] o_extra_params A hash with extra params passed, needed to support Ruby 1.8 :(
         #
         # @api public
-        def initialize(o_params, o_extra_params={})
+        def initialize(o_params)
           params = o_params.dup
-          extra_params = o_extra_params.dup
           if params.is_a?(Hash)
             @name, @type = params.shift
             @doc  = params.delete(:doc) if params.has_key?(:doc)
-            @doc  ||= extra_params.delete(:doc) if extra_params.has_key?(:doc)
-            @opts = params.merge!(extra_params)
+            @opts = params
           elsif params.is_a?(Array)
             @name = params.shift
             @type = params.shift

data/lib/weasel_diesel.rb

@@ -1,9 +1,9 @@
-require File.expand_path('inflection', File.dirname(__FILE__))
-require File.expand_path('params', File.dirname(__FILE__))
-require File.expand_path('response', File.dirname(__FILE__))
-require File.expand_path('documentation', File.dirname(__FILE__))
-require File.expand_path('ws_list', File.dirname(__FILE__))
-require File.expand_path('kernel_ext', File.dirname(__FILE__))
+require_relative 'inflection'
+require_relative 'params'
+require_relative 'response'
+require_relative 'documentation'
+require_relative 'ws_list'
+require 'weasel_diesel/dsl'
 
 # WeaselDiesel offers a web service DSL to define web services,
 # their params, http verbs, formats expected as well as the documentation
@@ -386,6 +386,12 @@ class WeaselDiesel
     end
   end
 
+  # Left for generators to implement. It's empty because WD itself isn't concerned
+  # with implementation, but needs it defined so doc generation can read WD web
+  # service definitions.
+  def implementation(&block)
+  end
+
   SERVICE_ROOT_REGEXP = /(.*?)[\/\(\.]/
   SERVICE_ACTION_REGEXP = /[\/\(\.]([a-z0-9_]+)[\/\(\.\?]/i
   SERVICE_RESTFUL_SHOW_REGEXP = /\/:[a-z0-9_]+\.\w{3}$/
@@ -422,6 +428,4 @@ class WeaselDiesel
     end
   end
 
-
-
 end

data/lib/weasel_diesel/cli.rb

@@ -0,0 +1,60 @@
+require "thor"
+require_relative "../weasel_diesel"
+
+class WeaselDiesel
+  class CLI < Thor
+    include Thor::Actions
+    namespace :weasel_diesel
+
+    desc "generate_doc SOURCE_PATH DESTINATION_PATH", "Generate HTML documentation for WeaselDiesel web services"
+    def generate_doc(source_path, destination_path="doc")
+      api_files = Dir.glob(File.join(destination_root, source_path, "**", "*.rb"))
+      if api_files.empty?
+        puts "No ruby files in source_path: #{File.join(destination_root, source_path)}"
+        return
+      end
+      api_files.each do |api|
+        require api
+      end
+
+      require 'fileutils'
+      destination = File.join(destination_root, destination_path)
+      FileUtils.mkdir_p(destination) unless File.exist?(destination)
+      File.open("#{destination}/index.html", "w"){|f| f << doc_template.result(binding)}
+      puts "Documentation available there: #{destination}/index.html"
+      `open #{destination}/index.html` if RUBY_PLATFORM =~ /darwin/ && !ENV['DONT_OPEN']
+    end
+
+    private
+
+    def response_element_html(el)
+      response_element_template.result(binding)
+    end
+
+    def input_params_html(required, optional)
+      input_params_template.result(binding)
+    end
+
+    def input_params_template
+      file = resources.join '_input_params.erb'
+      ERB.new File.read(file)
+    end
+
+    def response_element_template
+      file = resources.join '_response_element.erb'
+      ERB.new File.read(file)
+    end
+
+    def doc_template
+      file = resources.join 'template.erb'
+      ERB.new File.read(file)
+    end
+
+    def resources
+      require 'pathname'
+      @resources ||= Pathname.new(File.join(File.dirname(__FILE__), 'doc_generator'))
+    end
+
+  end
+
+end

data/lib/weasel_diesel/doc_generator/_input_params.erb

@@ -0,0 +1,36 @@
+<table class="table table-striped table-responsive">
+  <tdbody>
+    <% [["required", required], ["optional", optional]].each do |label, rules| %>
+      <% unless rules.empty? %>
+          <% rules.each do |rule| %>
+          <tr>
+            <td>
+              <strong><%= rule.name %></strong>
+              <br />
+              <em><%= label %></em>
+            </td>
+            <td>
+              <p>
+                <strong><%= rule.options[:type] || 'string' %></strong>
+
+                <% if desc = rule.doc %>
+                  - <%= desc %>
+                <% end %>
+              </p>
+
+              <% if options = rule.options[:options] %>
+                <strong>Options:</strong> <%= options.join(', ') %>
+                <br />
+              <% end %>
+
+              <% if default = rule.options[:default] %>
+                <strong>Default:</strong> <%= default %>
+                <br />
+              <% end %>
+            </td>
+          </tr>
+          <% end %>
+      <% end %>
+    <% end %>
+  </tdbody>
+</table>

data/lib/weasel_diesel/doc_generator/_response_element.erb

@@ -0,0 +1,49 @@
+<table class="table table-striped table-responsive">
+  <tdbody>
+    <% if el.name %>
+      <tr>
+        <td colspan="2">
+          <strong><%= el.name %></strong>
+          <% if false && el.is_a?(WeaselDiesel::Response::Vector) %>
+            <span class="response-array">(Array, these are the properties of each array item)</span>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+    <% el.properties.each do |prop| %>
+      <tr>
+        <td>
+          <strong><%= prop.name %></strong>
+          <br />
+          <em>
+            <% if false && prop.opts && prop.opts.respond_to?(:[]) && prop.opts[:null] %>
+              required
+            <% else %>
+              optional
+            <% end %>
+          </em>
+        </td>
+        <td>
+          <p>
+            <strong><%= prop.type %></strong>
+            <% unless true && prop.doc.nil? or prop.doc.empty? %>
+              - <%= prop.doc %>
+            <% end %>
+          </p>
+        </td>
+      </tr>
+    <% end %>
+
+    <% if false && el.arrays %>
+      <% el.arrays.each do |e| %>
+        <%= response_element_html(e) %>
+      <% end %>
+    <% end %>
+
+    <% if false && el.elements %>
+      <% el.elements.each do |e| %>
+        <%= response_element_html(e) %>
+      <% end %>
+    <% end %>
+  </tdbody>
+</table>

data/lib/weasel_diesel/doc_generator/template.erb

@@ -0,0 +1,120 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>API Documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <!-- Bootstrap -->
+    <link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css">
+    <!-- Optional theme -->
+    <link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap-theme.min.css">
+
+    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+    <!--[if lt IE 9]>
+      <script src="../../assets/js/html5shiv.js"></script>
+      <script src="../../assets/js/respond.min.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="container">
+      <div class="navbar navbar-default">
+        <div class="navbar-header">
+          <a class="navbar-brand" href="#">API Documentation</a>
+        </div>
+        <div class="navbar-collapse collapse">
+          <ul class="nav navbar-nav">
+            <li class="active"><a href="index.html">Home</a></li>
+          </ul>
+        </div>
+      </div>
+
+      <div class="row">
+        <div class="sidebar col-md-3 well">
+          <h5>Resources</h5>
+          <ul>
+            <% WSList.all.sort{|a,b| a.url <=> b.url}.each do |api| %>
+              <li><a href="#<%= "raw-#{api.verb}-#{api.url}" %>"><%= api.verb.upcase %> <%= api.url %></a></li>
+            <% end %>
+          </ul>
+        </div>
+        <div class="content col-md-9">
+          <div class="jumbotron">
+            <h1>API Documentation</h1>
+            <p>Resources are listed on the sidebar to the left.</p>
+          </div>
+
+          <% WSList.all.each do |api| %>
+            <div id="<%= "raw-#{api.verb}-#{api.url}" %>">
+              <div class="overall">
+                <h2><%= api.verb.upcase %> <%= '[SSL]' if api.ssl %> <%= api.url %></h2>
+                <% if api.auth_required %>
+                  <span class='label label-danger'>Authentication required</span>
+                <% end %>
+
+                <% if api.doc.desc %>
+                  <p>
+                    <%= "#{api.doc.desc}" %>
+                  </p>
+                <% end %>
+              </div>
+
+              <div class="parameters">
+                <h3>Parameters</h3>
+                <% if api.required_rules.any? || api.optional_rules.any? %>
+                  <%= input_params_html(api.required_rules, api.optional_rules) %>
+                <% end %>
+
+                <ul class="list-unstyled">
+                <% api.params.namespaced_params.each do |params| %>
+                  <li>
+                    <strong><%= params.space_name.name %></strong>
+                    <em>
+                      (<%= params.space_name.null ? 'optional' : 'required' %>)
+                    </em>
+                    <%= input_params_html(params.list_required, params.list_optional) %>
+                  </li>
+                <% end %>
+                </ul>
+              </div>
+
+              <div class="example-request">
+                <h3>Example Request</h3>
+                <% api.doc.examples.each do |example| %>
+                  <pre class="example"><%= example %></pre>
+                <% end %>
+              </div>
+
+              <div class="response">
+                <% if api.response.nodes.any? %>
+                  <h3>Response</h3>
+                  <% if api.response.arrays %>
+                    <span class="response-array">(Array, these are the properties of each array item)</span>
+                  <% end %>
+
+                  <% api.response.arrays.each do |array| %>
+                    <%= response_element_html(array) %>
+                  <% end %>
+                  <% api.response.elements.each do |el| %>
+                    <%= response_element_html(el) %>
+                  <% end %>
+                <% end %>
+                <h4>Example</h4>
+                <pre><%= JSON.pretty_generate(JSON.parse(api.response.to_json)) %></pre>
+              </div>
+
+          </div>
+          <hr>
+        <% end %>
+
+        <footer>
+          <p>&copy; <%= Time.now.year %></p>
+        </footer>
+        </div>
+      </div>
+    </div>
+
+    <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
+    <script src="https://code.jquery.com/jquery.js"></script>
+    <!-- Include all compiled plugins (below), or include individual files as needed -->
+    <script src="https://netdna.bootstrapcdn.com/bootstrap/3.0.0/js/bootstrap.min.js"></script>
+  </body>
+</html>

data/lib/weasel_diesel/dsl.rb

@@ -0,0 +1,34 @@
+# Extending the top level module to add some helpers
+#
+# @api public
+class WeaselDiesel
+  module DSL
+    private
+
+    # Base DSL method called to describe a service
+    #
+    # @param [String] url The url of the service to add.
+    # @yield [WeaselDiesel] The newly created service.
+    # @return [Array] The services already defined
+    # @example Describing a basic service
+    #   describe_service "hello-world.xml" do |service|
+    #     # describe the service
+    #   end
+    #
+    # @api public
+    def describe_service(url, &block)
+      service = WeaselDiesel.new(url)
+      yield service
+
+      service.sync_input_param_doc
+      WSList.add(service)
+
+      service
+    end
+
+  end
+end
+
+# Extend the main object with the DSL methods. This allows top-level calls
+# without polluting the object inheritance tree.
+self.extend WeaselDiesel::DSL

data/lib/weasel_diesel/version.rb

@@ -1,3 +1,3 @@
 class WeaselDiesel
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/spec/hello_world_service.rb

@@ -7,14 +7,14 @@ describe_service "hello_world.xml" do |service|
 
   service.response do |response|
     response.element(:name => "greeting") do |e|
-	    e.attribute "message" => :string, :doc => "The greeting message sent back."
-	  end
+      e.attribute "message" => :string, :doc => "The greeting message sent back."
+    end
   end
 
   service.documentation do |doc|
-  	doc.overall "This service provides a simple hello world implementation example."
-  	doc.params :name, "The name of the person to greet."
-  	doc.example "<code>http://ps3.yourgame.com/hello_world.xml?name=Matt</code>"
+    doc.overall "This service provides a simple hello world implementation example."
+    doc.params :name, "The name of the person to greet."
+    doc.example "<code>http://ps3.yourgame.com/hello_world.xml?name=Matt</code>"
  end
 
 end

data/spec/json_response_description_spec.rb

@@ -1,34 +1,34 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative 'spec_helper'
 
 describe "WeaselDiesel JSON response description" do
 
 # JSON response example
 =begin
-  { vouchers: [ 
-  { 
-    id : 1, 
+  { vouchers: [
+  {
+    id : 1,
     redeemed : false,
-    created_at : 123123123123, 
+    created_at : 123123123123,
     option: {
       id : 1231,
       price: 123.32
     }
-  }, 
-  { 
-    id : 2, 
+  },
+  {
+    id : 2,
     redeemed : true,
-    created_at : 123123123123, 
+    created_at : 123123123123,
     option: {
       id : 1233,
       price: 1.32
     }
-  }, 
+  },
 ] }
 =end
 
   before :all do
     @timestamp = Time.now.to_i
-    @service =  describe_service "json_list" do |service|
+    @service = describe_service "json_list" do |service|
       service.formats  :json
       service.response do |response|
         response.array :vouchers do |node|
@@ -104,7 +104,7 @@ describe "WeaselDiesel JSON response description" do
   end
 
   it "should allow an anonymous object at the root of the response" do
-    service =  describe_service "json_anonymous_obj" do |service|
+    service = describe_service "json_anonymous_obj" do |service|
       service.formats  :json
       service.response do |response|
         response.object do |obj|
@@ -120,7 +120,7 @@ describe "WeaselDiesel JSON response description" do
     obj.properties.find{|prop| prop.name == :id}.should_not be_nil
     obj.properties.find{|prop| prop.name == :foo}.should_not be_nil
   end
-  
+
 end
 
 
@@ -134,7 +134,7 @@ describe "WeaselDiesel simple JSON object response description" do
 
   before :all do
     @timestamp = Time.now.to_i
-    @service =  describe_service "json_obj" do |service|
+    @service = describe_service "json_obj" do |service|
       service.formats  :json
       service.response do |response|
         response.object :organization do |node|
@@ -165,7 +165,7 @@ describe "WeaselDiesel anonymous JSON object response description" do
 
   before :all do
     @timestamp = Time.now.to_i
-    @service =  describe_service "anon_json_obj" do |service|
+    @service = describe_service "anon_json_obj" do |service|
       service.formats  :json
       service.response do |response|
         response.object do |node|

data/spec/json_response_verification_spec.rb

@@ -1,5 +1,5 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
-require File.expand_path("../lib/json_response_verification", File.dirname(__FILE__))
+require_relative 'spec_helper'
+require_relative '../lib/json_response_verification'
 
 WeaselDiesel.send(:include, JSONResponseVerification)
 

data/spec/params_verification_spec.rb

@@ -70,7 +70,7 @@ describe ParamsVerification do
     params['timestamp'] = Time.now.iso8601
     lambda { ParamsVerification.validate!(params, @service.defined_params) }.should_not raise_error
     params['timestamp'] = Time.now.getutc.iso8601
-    lambda { ParamsVerification.validate!(params, @service.defined_params) }.should_not raise_error(ParamsVerification::InvalidParamType)
+    lambda { ParamsVerification.validate!(params, @service.defined_params) }.should_not raise_error
   end
 
   it "should set the default value for a namespace optional param" do
@@ -111,7 +111,7 @@ describe ParamsVerification do
   it "should not raise an exception if a req array param doesn't contain a comma" do
     service = WSList.find(:post, "/services/array_param.xml")
     params = {'seq' => "a b c d e g"}
-    lambda{ ParamsVerification.validate!(params, service.defined_params) }.should_not raise_exception(ParamsVerification::InvalidParamType)
+    lambda{ ParamsVerification.validate!(params, service.defined_params) }.should_not raise_exception
   end
 
   it "should raise an exception when a param is of the wrong type" do

data/spec/spec_helper.rb

@@ -1,9 +1,3 @@
-if RUBY_VERSION =~ /1.8/
-  require 'rubygems'
-  require 'backports'
-  require 'json'
-end
-
 require 'rspec'
 require 'rack/test'
 require 'sinatra'
@@ -16,5 +10,6 @@ require_relative "../lib/framework_ext/sinatra_controller"
 ENV["RACK_ENV"] = 'test'
 
 RSpec.configure do |conf|
+  conf.include WeaselDiesel::DSL
   conf.include Rack::Test::Methods
 end

data/spec/test_services.rb

@@ -7,8 +7,8 @@ describe_service "services/test.xml" do |service|
   service.http_verb :get
 
   service.params do |p|
-    p.string :framework, 
-      :in => WeaselDieselSpecOptions, 
+    p.string :framework,
+      :in => WeaselDieselSpecOptions,
       :required => true,
       :doc => "The test framework used, could be one of the two following: #{WeaselDieselSpecOptions.join(", ")}."
 
@@ -38,7 +38,6 @@ describe_service "services/test.xml" do |service|
   # the response contains a list of player creation ratings each object in the list
 
 =begin
-  #Format not supported by Ruby 1.8 due to hash insertion order not being maintained.
   service.response do |response|
     response.element(:name => "player_creation_ratings") do |e|
       e.attribute  :id          => :integer, :doc => "id doc"

data/spec/wd_controller_dispatch_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative 'spec_helper'
 
 describe "WeaselDiesel #controller_dispatch" do
 

data/spec/wd_documentation_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative 'spec_helper'
 
 describe WeaselDiesel::Documentation do
 
@@ -77,7 +77,9 @@ The most common way to use this service looks like that:
   it "should have a json representation of an response element" do
     json = @service.response.elements.first.to_json
     loaded_json = JSON.load(json)
-    loaded_json[@service.response.elements.first.doc.name].should_not be_empty
+    loaded_json.has_key?(@service.response.elements.first.name).should be_true
+    loaded_json[@service.response.elements.first.name].should_not be_empty
+    loaded_json[@service.response.elements.first.name].has_key?("player_creation_rating").should be_true
   end
 
   it "should have documentation for a response element attribute" do

data/spec/wd_params_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative 'spec_helper'
 
 describe WeaselDiesel::Params do
 
@@ -69,7 +69,7 @@ describe WeaselDiesel::Params do
 
     it "should have options" do
       @rule.options[:type].should == :string
-      @rule.options[:in].should ==  WeaselDieselSpecOptions
+      @rule.options[:in].should == WeaselDieselSpecOptions
       @rule.options[:null].should be_false
     end
   end

data/spec/wd_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative 'spec_helper'
 
 describe WeaselDiesel do
 

data/spec/ws_list_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative 'spec_helper'
 
 describe WSList do
 

data/spec/wsdsl_sinatra_ext_spec.rb

@@ -1,6 +1,6 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative 'spec_helper'
 require 'sinatra'
-require File.expand_path("./../lib/framework_ext/sinatra.rb", File.dirname(__FILE__))
+require_relative '../lib/framework_ext/sinatra'
 WeaselDiesel.send(:include, WeaselDieselSinatraExtension)
 
 describe "Hello World example" do

data/weasel_diesel.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/mattetti/Weasel-Diesel"
   s.summary     = %q{Web Service DSL}
   s.description = %q{Ruby DSL describing Web Services without implementation details.}
+  s.license     = 'MIT'
 
   s.rubyforge_project = "wsdsl"
 
@@ -18,14 +19,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency('thor')
+
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"
   s.add_development_dependency "rack-test"
   s.add_development_dependency "yard"
   s.add_development_dependency "sinatra"
-   s.add_development_dependency "rake"
-  if RUBY_VERSION =~ /1.8/
-    s.add_runtime_dependency "backports"
-    s.add_runtime_dependency "json"
-  end
+  s.add_development_dependency "rake"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: weasel_diesel
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Matt Aimonetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -83,7 +97,8 @@ dependencies:
 description: Ruby DSL describing Web Services without implementation details.
 email:
 - mattaimonetti@gmail.com
-executables: []
+executables:
+- weasel_diesel
 extensions: []
 extra_rdoc_files: []
 files:
@@ -94,16 +109,21 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/weasel_diesel
 - lib/documentation.rb
 - lib/framework_ext/sinatra.rb
 - lib/framework_ext/sinatra_controller.rb
 - lib/inflection.rb
 - lib/json_response_verification.rb
-- lib/kernel_ext.rb
 - lib/params.rb
 - lib/params_verification.rb
 - lib/response.rb
 - lib/weasel_diesel.rb
+- lib/weasel_diesel/cli.rb
+- lib/weasel_diesel/doc_generator/_input_params.erb
+- lib/weasel_diesel/doc_generator/_response_element.erb
+- lib/weasel_diesel/doc_generator/template.erb
+- lib/weasel_diesel/dsl.rb
 - lib/weasel_diesel/version.rb
 - lib/ws_list.rb
 - spec/hello_world_controller.rb
@@ -122,7 +142,8 @@ files:
 - spec/wsdsl_sinatra_ext_spec.rb
 - weasel_diesel.gemspec
 homepage: https://github.com/mattetti/Weasel-Diesel
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -140,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: wsdsl
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: Web Service DSL

data/lib/kernel_ext.rb

@@ -1,27 +0,0 @@
-# Extending the top level module to add some helpers
-#
-# @api public
-module Kernel
-
-  # Base DSL method called to describe a service
-  #
-  # @param [String] url The url of the service to add.
-  # @yield [WeaselDiesel] The newly created service.
-  # @return [Array] The services already defined
-  # @example Describing a basic service
-  #   describe_service "hello-world.xml" do |service|
-  #     # describe the service
-  #   end
-  #
-  # @api public
-  def describe_service(url, &block)
-    service = WeaselDiesel.new(url)
-    yield service
-
-    service.sync_input_param_doc
-    WSList.add(service)
-
-    service
-  end
-
-end