weasel_diesel 1.0.2 → 1.0.3

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+  - ree

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in weasel_diesel.gemspec
 gemspec
+
+gem "json", :platform => :jruby

data/README.md

@@ -1,5 +1,7 @@
 # Web Service DSL
 
+[![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. 
 
 To get you going quickly, see the [generator for sinatra apps](https://github.com/mattetti/wd-sinatra).
@@ -20,7 +22,7 @@ describe_service "hello_world" do |service|
   service.disable_auth # on by default
 
   # INPUT
-  service.param.string  :name, :default => 'World'
+  service.param.string  :name, :default => 'World', :doc => "The name of the person to greet."
 
   # OUTPUT
   service.response do |response|
@@ -33,7 +35,6 @@ describe_service "hello_world" do |service|
   # DOCUMENTATION
   service.documentation do |doc|
   	doc.overall "This service provides a simple hello world implementation example."
-  	doc.param :name, "The name of the person to greet."
   	doc.example "<code>curl -I 'http://localhost:9292/hello_world?name=Matt'</code>"
  end
 
@@ -59,9 +60,15 @@ Or a more complex example using XML:
       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,   :null    => false
+        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
@@ -92,10 +99,6 @@ Or a more complex example using XML:
          This is a test service used to test the framework.
         DOC
         
-        # doc.params <name>, <definition>
-        doc.params :framework, "The test framework used, could be one of the two following: #{SpecOptions.join(", ")}."
-        doc.params :version, "The version of the framework to use."
-        
         # doc.example <markdown text>
         doc.example <<-DOC
     The most common way to use this service looks like that:

data/lib/documentation.rb

@@ -119,6 +119,7 @@ class WeaselDiesel
       end
       @namespaced_params << new_ns_param
     end
+    alias :object :namespace
 
     def response
       @response ||= Documentation.new

data/lib/params.rb

@@ -24,10 +24,10 @@ class WeaselDiesel
       # @option options [Symbol] :default The default value of the param.
       # @option options [Symbol] :minvalue The minimum acceptable value.
       # @option options [Symbol] :maxvalue The maximim acceptable value.
+      # @option options [Symbol] :doc Documentation for the param.
       # @api public
       attr_reader :options
 
-
       # @param [Symbol, String] name 
       #   The param's name
       # @param [Hash] opts The rule options
@@ -36,6 +36,7 @@ class WeaselDiesel
       # @option opts [Symbol] :default The default value of the param.
       # @option opts [Symbol] :minvalue The minimum acceptable value.
       # @option opts [Symbol] :maxvalue The maximim acceptable value.
+      # @option opts [Symbol] :doc Documentation for the param.
       # @api public
       def initialize(name, opts = {})
         @name    = name
@@ -50,6 +51,14 @@ class WeaselDiesel
         @options[:space_name]
       end
 
+      # The documentation of this Rule
+      #
+      # @return [NilClass, String]
+      # api public
+      def doc
+        @options[:doc]
+      end
+
       # Converts the rule into a hash with its name and options.
       #
       # @return [Hash]
@@ -351,6 +360,7 @@ class WeaselDiesel
       yield(params) if block_given?
       namespaced_params << params unless namespaced_params.include?(params)
     end
+    alias :object :namespace
 
     # Returns the namespaced params
     #

data/lib/params_verification.rb

@@ -79,7 +79,7 @@ module ParamsVerification
     params.each_pair do |key, value|
       if value.is_a?(Hash)
         namespaced = service_params.namespaced_params.find{|np| np.space_name.to_s == key.to_s}
-        raise UnexpectedParam, "Request included unexpected parameter: #{key}" if namespaced.nil?
+        raise UnexpectedParam, "Request included unexpected parameter: #{ERB::Util.html_escape(key)}" if namespaced.nil?
         unexpected_params?(params[key], namespaced.param_names)
       end
     end
@@ -123,7 +123,7 @@ module ParamsVerification
       verify_cast(param_name, param_value, rule.options[:type])
     end
 
-    if rule.options[:options] || rule.options[:in]
+    if rule.options[:options] || rule.options[:in.inspect]
       choices = rule.options[:options] || rule.options[:in]
       if rule.options[:type]
         # Force the cast so we can compare properly

data/lib/response.rb

@@ -348,6 +348,13 @@ class WeaselDiesel
         end
       end
 
+      # Converts an element into a json representation
+      #
+      # @return [String] the element attributes formated in a json structure
+      def to_json
+        to_hash.to_json
+      end
+
       def to_html
         output = ""
         if name

data/lib/weasel_diesel.rb

@@ -408,7 +408,17 @@ module Kernel
   def describe_service(url, &block)
     service = WeaselDiesel.new(url)
     yield service
+
+    service.defined_params.list_optional.each do |rule|
+      service.doc.param(rule.name, rule.options[:doc]) if rule.options[:doc]
+    end
+
+    service.defined_params.list_required.each do |rule|
+      service.doc.param(rule.name, rule.options[:doc]) if rule.options[:doc]
+    end
+
     WSList.add(service)
+
     service
   end
 

data/lib/weasel_diesel/version.rb

@@ -1,3 +1,3 @@
 class WeaselDiesel
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/spec/test_services.rb

@@ -5,12 +5,16 @@ describe_service "services/test.xml" do |service|
   service.http_verb :get
 
   service.params do |p|
-    p.string :framework, :in => WeaselDieselSpecOptions, :null => false, :required => true
+    p.string :framework, 
+      :in => WeaselDieselSpecOptions, 
+      :null => false, 
+      :required => true,
+      :doc => "The test framework used, could be one of the two following: #{WeaselDieselSpecOptions.join(", ")}."
 
     p.datetime :timestamp, :default => Time.now
     p.string   :alpha,     :in      => ['a', 'b', 'c']
-    p.string   :version,   :null    => false
-    p.integer  :num,      :minvalue => 42
+    p.string   :version,   :null    => false, :doc => "The version of the framework to use."
+    p.integer  :num,       :minvalue => 42,            :doc => "The number to test"
 
   end
 
@@ -66,10 +70,6 @@ describe_service "services/test.xml" do |service|
      This is a test service used to test the framework.
     DOC
 
-    # doc.params <name>, <definition>
-    doc.param :framework, "The test framework used, could be one of the two following: #{WeaselDieselSpecOptions.join(", ")}."
-    doc.param :version, "The version of the framework to use."
-
     # doc.example <markdown text>
     doc.example <<-DOC
 The most common way to use this service looks like that:

data/spec/wd_controller_dispatch_spec.rb

@@ -0,0 +1,161 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe "WeaselDiesel #controller_dispatch" do
+
+  before :all do
+    @service = WSList.all.find{|s| s.url == 'services/test.xml'}
+    @service.should_not be_nil
+  end
+
+  describe "#controller_dispatch" do
+
+    class ProjectsController
+      def initialize(app, service)
+        @app = app
+        @service = service.name
+      end
+
+      def send(action)
+        [@app, @service, action]
+      end
+    end
+
+    module Projects
+      class TasksController < ProjectsController
+      end
+    end
+
+    module Projects
+      module Tasks
+        class ItemsController < ProjectsController
+        end
+      end
+    end
+
+    before :all do
+      @original_use_controller_dispatch = WeaselDiesel.use_controller_dispatch
+      WeaselDiesel.use_controller_dispatch = true
+      @original_services = WSList.all.dup
+      WSList.all.clear
+    end
+
+    after :all do
+      WeaselDiesel.use_controller_dispatch = @original_use_controller_dispatch
+      WSList.all.replace @original_services
+    end
+
+    it "should be able to dispatch controller" do
+      describe_service("projects.xml") { |s| }
+      service = WSList["projects.xml"]
+      service.controller_dispatch("application").
+        should == ["application", "projects", "list"]
+    end
+
+    it "should be able to dispatch namespaced controller" do
+      describe_service("project/:project_id/tasks.xml") do |service|
+        service.controller_name = "Projects::TasksController"
+        service.action = "list"
+      end
+
+      describe_service("project/:project_id/task/:task_id/items.xml") do |service|
+        service.controller_name = "Projects::Tasks::ItemsController"
+        service.action = "list"
+      end
+
+      service = WSList["project/:project_id/tasks.xml"]
+      service.controller_dispatch("application").should == ["application", "project", "list"]
+
+      service = WSList["project/:project_id/task/:task_id/items.xml"]
+      service.controller_dispatch("application").should == ["application", "project", "list"]
+    end
+
+    it "should raise exception when controller class is not found" do
+      describe_service("unknown.xml") do |service|
+        service.controller_name = "UnknownController"
+        service.action = "list"
+      end
+      service = WSList["unknown.xml"]
+      lambda { service.controller_dispatch("application") }.
+        should raise_error("The UnknownController class was not found")
+    end
+
+  end
+
+  describe "With controller dispatch on" do
+    before :all do
+      @original_services = WSList.all.dup
+      WSList.all.clear
+      WeaselDiesel.use_controller_dispatch = true
+      load File.expand_path('test_services.rb', File.dirname(__FILE__))
+      @c_service = WSList.all.find{|s| s.url == 'services/test.xml'}
+      @c_service.should_not be_nil
+    end
+    after :all do
+      WeaselDiesel.use_controller_dispatch = false
+      WSList.all.replace @original_services
+    end
+
+    it "should set the controller accordingly" do
+      @c_service.controller_name.should_not be_nil
+      @c_service.controller_name.should == 'ServicesController'
+      service = WeaselDiesel.new("preferences.xml")
+      service.name.should == 'preferences'
+      ExtlibCopy.classify('preferences').should == 'Preferences'
+      service.controller_name.should == 'PreferencesController'
+    end
+
+    it "should set the action accordingly" do
+      @c_service.action.should_not be_nil
+      @c_service.action.should == 'test'
+    end
+
+    it "should support restful routes based on the HTTP verb" do
+      service = WSList.all.find{|s| s.url == "services.xml"}
+      service.should_not be_nil
+      service.http_verb.should == :put
+      service.action.should_not be_nil
+      service.controller_name.should == 'ServicesController'
+      service.action.should == 'update'
+    end
+
+    it "should have a default action" do
+      service = WeaselDiesel.new('spec_test.xml')
+      service.action.should == 'list'
+    end
+
+    it "should route to show when an id is the last passed param" do
+      service = WeaselDiesel.new("players/:id.xml")
+      service.action.should == 'show'
+    end
+
+    it "should support some extra attributes" do
+      service = WeaselDiesel.new("players/:id.xml")
+      service.extra[:custom_name] = 'fooBar'
+      service.extra[:custom_name].should == 'fooBar'
+    end
+
+    it "should respect the global controller pluralization flag" do
+      WeaselDiesel.use_pluralized_controllers = true
+      service = WeaselDiesel.new("player/:id.xml")
+      service.controller_name.should == "PlayersController"
+      service = WeaselDiesel.new("players/:id.xml")
+      service.controller_name.should == "PlayersController"
+      WeaselDiesel.use_pluralized_controllers = false
+      service = WeaselDiesel.new("player/:id.xml")
+      service.controller_name.should == "PlayerController"
+    end
+
+
+    it "should let overwrite the controller name and action after initialization" do
+      describe_service "players/:id.xml" do |service|
+        service.controller_name = "CustomController"
+        service.action = "foo"
+      end
+      service = WSList.all.find{|s| s.url == "players/:id.xml"}
+      service.controller_name.should == "CustomController"
+      service.action.should == "foo"
+    end
+
+  end
+
+end

data/spec/wd_documentation_spec.rb

@@ -0,0 +1,149 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe WeaselDiesel::Documentation do
+
+  before :all do
+    @service = WSList.all.find{|s| s.url == 'services/test.xml'}
+    @service.should_not be_nil
+    @doc = @service.doc
+    @doc.should_not be_nil
+  end
+
+  it "should have an overall description" do
+    @doc.desc.strip.should == "This is a test service used to test the framework."
+  end
+
+  it "should have a list of params doc" do
+    @doc.params_doc.should be_an_instance_of(Hash)
+    @doc.params_doc.keys.sort.should == [:framework, :num, :version]
+    @doc.params_doc[:framework].should == "The test framework used, could be one of the two following: #{WeaselDieselSpecOptions.join(", ")}."
+    @doc.params_doc[:num].should == 'The number to test'
+  end
+
+  it "should allow to define namespaced params doc" do
+    service = WSList.all.find{|s| s.url == "services.xml"}
+    service.documentation do |doc|
+      doc.namespace :preference do |ns|
+        ns.param :id, "Ze id."
+      end
+    end
+    service.doc.namespaced_params.should_not be_empty
+    ns = service.doc.namespaced_params.find{|ns| ns.name == :preference}
+    ns.should_not be_nil
+    ns.params[:id].should == "Ze id."
+  end
+
+  it "should allow object to be an alias for namespace params" do
+    service = WSList.all.find{|s| s.url == "services.xml"}
+    service.documentation do |doc|
+      doc.object :preference do |ns|
+        ns.param :id, "Ze id."
+      end
+    end
+    service.doc.namespaced_params.should_not be_empty
+    ns = service.doc.namespaced_params.find{|ns| ns.name == :preference}
+    ns.should_not be_nil
+    ns.params[:id].should == "Ze id."
+  end
+
+  it "should have an optional list of examples" do
+    @doc.examples.should be_an_instance_of(Array)
+    @doc.examples.first.should == <<-DOC
+The most common way to use this service looks like that:
+    http://example.com/services/test.xml?framework=rspec&version=2.0.0
+    DOC
+  end
+
+  it "should have the service response documented" do
+    @doc.response.should_not be_nil
+  end
+
+  it "should have documentation for the response elements via the response itself" do
+    @service.response.elements.first.should_not be_nil
+    @service.response.elements.first.doc.should_not be_nil
+    @service.response.elements.first.doc.name.should == "player_creation_ratings"
+  end
+
+  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
+  end
+
+  it "should have documentation for a response element attribute" do
+    @service.response.elements.first.doc.attributes.should_not be_empty
+    @service.response.elements.first.doc.attributes[:id].should == "id doc"
+  end
+
+  it "should have documentation for a response element array" do
+    element = @service.response.elements.first
+    element.arrays.should_not be_empty
+    element.arrays.first.name.should == :player_creation_rating
+    element.arrays.first.type.should == "PlayerCreationRating"
+    element.arrays.first.attributes.should_not be_empty
+  end
+
+  it "should have documentation for the attributes of an response element array" do
+    element = @service.response.elements.first
+    array = element.arrays.first
+    attribute = array.attributes.find{|att| att.name == :comments }
+    attribute.should_not be_nil
+    attribute.name.should == :comments # just in case we change the way to find the attribute
+    attribute.doc.should == "comments doc"
+  end
+
+  it "should emit html documention for elements" do
+    @service.response.elements.first.to_html.should be_a(String)
+  end
+
+  describe "legacy param documentation" do
+
+    before :all do
+      @original_services = WSList.all.dup
+      WSList.all.clear
+      define_service
+    end
+
+    after :all do
+      WSList.all.replace @original_services
+    end
+
+    def define_service
+      describe_service "legacy_param_doc" do |service|
+        service.formats  :xml, :json
+
+        service.params do |p|
+          p.string :framework, :in => WeaselDieselSpecOptions, :null => false, :required => true
+
+          p.datetime :timestamp, :default => Time.now
+          p.string   :alpha,     :in      => ['a', 'b', 'c']
+          p.string   :version,   :null    => false
+          p.integer  :num,      :minvalue => 42
+
+        end
+
+        service.params.namespace :user do |user|
+          user.integer :id, :required => :true
+          user.string :sex, :in => %Q{female, male}
+          user.boolean :mailing_list, :default => true
+        end
+
+        service.documentation do |doc|
+          # doc.overall <markdown description text>
+          doc.overall "This is a test service used to test the framework."
+          # doc.params <name>, <definition>
+          doc.param :framework, "The test framework used, could be one of the two following: #{WeaselDieselSpecOptions.join(", ")}."
+          doc.param :version, "The version of the framework to use."
+        end
+      end
+    end
+
+    it "should have the param documented" do
+      service = WSList["legacy_param_doc"]
+      service.doc.params_doc.keys.sort.should == [:framework, :version]
+      service.doc.params_doc[service.doc.params_doc.keys.first].should_not be_nil
+    end
+
+  end
+
+end

data/spec/wd_params_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe WeaselDiesel::Params do
+
+  before :all do
+    @service = WSList.all.find{|s| s.url == 'services/test.xml'}
+    @service.should_not be_nil
+    @sparams = @service.params
+  end
+
+  it "should have the possibility to have a space name" do
+    @sparams.should respond_to(:space_name)
+    service_params = WeaselDiesel::Params.new(:space_name => 'spec_test')
+    service_params.space_name.should == 'spec_test'
+  end
+
+  it "should have a list of required param rules" do
+    @sparams.list_required.should be_an_instance_of(Array)
+    @sparams.list_required.length.should == 1
+  end
+
+  it "should have a list of optional param rules" do
+    @sparams.list_optional.should be_an_instance_of(Array)
+    @sparams.list_optional.length.should == 4
+  end
+
+  it "should have a list of namespaced param rules" do
+    @sparams.namespaced_params.should be_an_instance_of(Array)
+    @sparams.namespaced_params.length.should == 1
+    @sparams.namespaced_params.first.space_name.should == :user
+  end
+
+  it "should allow to define namespaced param" do
+    service = WSList.all.find{|s| s.url == "services.xml"}
+    service.params do |params|
+      params.namespace :preference do |ns|
+        ns.param :id, "Ze id."
+      end
+    end
+    service.params.namespaced_params.should_not be_empty
+    ns = service.params.namespaced_params.find{|ns| ns.space_name == :preference}
+    ns.should_not be_nil
+    ns.list_optional.first.name.should == "Ze id."
+  end
+
+  it "should allow object as an alias to namespaced param" do
+    service = WSList.all.find{|s| s.url == "services.xml"}
+    service.params do |params|
+      params.object :preference do |ns|
+        ns.param :id, "Ze id."
+      end
+    end
+    service.params.namespaced_params.should_not be_empty
+    ns = service.params.namespaced_params.find{|ns| ns.space_name == :preference}
+    ns.should_not be_nil
+    ns.list_optional.first.name.should == "Ze id."
+  end
+
+  describe WeaselDiesel::Params::Rule do
+    before :all do
+      @rule = @sparams.list_required.first
+      @rule.should_not be_nil
+    end
+
+    it "should have a name" do
+      @rule.name.should == :framework
+    end
+
+    it "should have options" do
+      @rule.options[:type].should == :string
+      @rule.options[:in].should ==  WeaselDieselSpecOptions
+      @rule.options[:null].should be_false
+    end
+  end
+
+end

data/spec/wd_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe WeaselDiesel do
+
+  before :all do
+    @service = WSList.all.find{|s| s.url == 'services/test.xml'}
+    @service.should_not be_nil
+  end
+
+  it "should have an url" do
+    # dummy test since that's how we found the service, but oh well
+    @service.url.should == 'services/test.xml'
+  end
+
+  it "should have some http verbs defined" do
+    @service.verb.should == :get
+  end
+
+  it "should have supported formats defined" do
+    @service.formats.should == [:xml, :json]
+  end
+
+  it "should have params info" do
+    @service.params.should be_an_instance_of(WeaselDiesel::Params)
+  end
+
+  it "should have direct access to the required params" do
+    @service.required_rules.should == @service.params.list_required
+  end
+
+  it "should have direct access to the optional params" do
+    @service.optional_rules.should == @service.params.list_optional
+  end
+
+  it "should have direct access to the nested params" do
+    @service.nested_params.should == @service.params.namespaced_params
+  end
+
+  it "should have some documentation" do
+    @service.doc.should be_an_instance_of(WeaselDiesel::Documentation)
+  end
+
+end

data/spec/wsdsl_sinatra_ext_spec.rb

@@ -4,20 +4,30 @@ require File.expand_path("./../lib/framework_ext/sinatra.rb", File.dirname(__FIL
 WeaselDiesel.send(:include, WeaselDieselSinatraExtension)
 
 describe "Hello World example" do
-    require_relative "hello_world_service"
-    require_relative "hello_world_controller"
 
-    def app
-      Sinatra::Application
+    before :all do
+      @original_use_controller_dispatch = WeaselDiesel.use_controller_dispatch
+      WeaselDiesel.use_controller_dispatch = true
+      @original_services = WSList.all.dup
+      WSList.all.clear
+      require "hello_world_service"
+      require "hello_world_controller"
+      @service = WSList.all.find{|s| s.url == 'hello_world.xml'}
+      @service.should_not be_nil
+      @service.load_sinatra_route
+    end
+
+    after :all do
+      WeaselDiesel.use_controller_dispatch = @original_use_controller_dispatch
+      WSList.all.replace @original_services
     end
 
-    before(:all) do
-      service = WSList.all.find{|s| s.url == 'hello_world.xml'}
-      service.should_not be_nil
-      service.load_sinatra_route
+    def app
+      Sinatra::Application
     end
 
     it "should dispatch the hello world service properly" do
+      @service.controller_name.should == "HelloWorldController"
       get "/hello_world.xml"
       last_response.body.should include("Hello World")
     end

data/weasel_diesel.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weasel_diesel
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-11 00:00:00.000000000 Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70245501824860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70245501824860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70245501824280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70245501824280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70245501823640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70245501823640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70245501823060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,28 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70245501823060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby DSL describing Web Services without implementation details.
 email:
 - mattaimonetti@gmail.com
@@ -63,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -86,8 +123,11 @@ files:
 - spec/preferences_service.rb
 - spec/spec_helper.rb
 - spec/test_services.rb
+- spec/wd_controller_dispatch_spec.rb
+- spec/wd_documentation_spec.rb
+- spec/wd_params_spec.rb
+- spec/wd_spec.rb
 - spec/wsdsl_sinatra_ext_spec.rb
-- spec/wsdsl_spec.rb
 - weasel_diesel.gemspec
 homepage: https://github.com/mattetti/Weasel-Diesel
 licenses: []
@@ -109,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: wsdsl
-rubygems_version: 1.8.16
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Web Service DSL
@@ -122,6 +162,9 @@ test_files:
 - spec/preferences_service.rb
 - spec/spec_helper.rb
 - spec/test_services.rb
+- spec/wd_controller_dispatch_spec.rb
+- spec/wd_documentation_spec.rb
+- spec/wd_params_spec.rb
+- spec/wd_spec.rb
 - spec/wsdsl_sinatra_ext_spec.rb
-- spec/wsdsl_spec.rb
 has_rdoc: 

data/spec/wsdsl_spec.rb

@@ -1,317 +0,0 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
-
-describe WeaselDiesel do
-
-  before :all do
-    @service = WSList.all.find{|s| s.url == 'services/test.xml'}
-    @service.should_not be_nil
-  end
-
-  it "should have an url" do
-    # dummy test since that's how we found the service, but oh well
-    @service.url.should == 'services/test.xml'
-  end
-
-  it "should have some http verbs defined" do
-    @service.verb.should == :get
-  end
-
-  it "should have supported formats defined" do
-    @service.formats.should == [:xml, :json]
-  end
-
-  it "should have params info" do
-    @service.params.should be_an_instance_of(WeaselDiesel::Params)
-  end
-
-  it "should have direct access to the required params" do
-    @service.required_rules.should == @service.params.list_required
-  end
-
-  it "should have direct access to the optional params" do
-    @service.optional_rules.should == @service.params.list_optional
-  end
-
-  it "should have direct access to the nested params" do
-    @service.nested_params.should == @service.params.namespaced_params
-  end
-
-  describe "#controller_dispatch" do
-
-    class ProjectsController
-      def initialize(app, service)
-        @app = app
-        @service = service.name
-      end
-
-      def send(action)
-        [@app, @service, action]
-      end
-    end
-
-    module Projects
-      class TasksController < ProjectsController
-      end
-    end
-
-    module Projects
-      module Tasks
-        class ItemsController < ProjectsController
-        end
-      end
-    end
-
-    before :all do
-      @original_use_controller_dispatch = WeaselDiesel.use_controller_dispatch
-      WeaselDiesel.use_controller_dispatch = true
-      @original_services = WSList.all.dup
-      WSList.all.clear
-    end
-
-    after :all do
-      WeaselDiesel.use_controller_dispatch = @original_use_controller_dispatch
-      WSList.all.replace @original_services
-    end
-
-    it "should be able to dispatch controller" do
-      describe_service("projects.xml") { |s| }
-      service = WSList["projects.xml"]
-      service.controller_dispatch("application").
-        should == ["application", "projects", "list"]
-    end
-
-    it "should be able to dispatch namespaced controller" do
-      describe_service("project/:project_id/tasks.xml") do |service|
-        service.controller_name = "Projects::TasksController"
-        service.action = "list"
-      end
-
-      describe_service("project/:project_id/task/:task_id/items.xml") do |service|
-        service.controller_name = "Projects::Tasks::ItemsController"
-        service.action = "list"
-      end
-
-      service = WSList["project/:project_id/tasks.xml"]
-      service.controller_dispatch("application").should == ["application", "project", "list"]
-
-      service = WSList["project/:project_id/task/:task_id/items.xml"]
-      service.controller_dispatch("application").should == ["application", "project", "list"]
-    end
-
-    it "should raise exception when controller class is not found" do
-      describe_service("unknown.xml") do |service|
-        service.controller_name = "UnknownController"
-        service.action = "list"
-      end
-      service = WSList["unknown.xml"]
-      lambda { service.controller_dispatch("application") }.
-        should raise_error("The UnknownController class was not found")
-    end
-
-  end
-
-  describe "With controller dispatch on" do
-    before :all do
-      @original_services = WSList.all.dup
-      WSList.all.clear
-      WeaselDiesel.use_controller_dispatch = true
-      load File.expand_path('test_services.rb', File.dirname(__FILE__))
-      @c_service = WSList.all.find{|s| s.url == 'services/test.xml'}
-      @c_service.should_not be_nil
-    end
-    after :all do
-      WeaselDiesel.use_controller_dispatch = false
-      WSList.all.replace @original_services
-    end
-
-    it "should set the controller accordingly" do
-      @c_service.controller_name.should_not be_nil
-      @c_service.controller_name.should == 'ServicesController'
-      service = WeaselDiesel.new("preferences.xml")
-      service.name.should == 'preferences'
-      ExtlibCopy.classify('preferences').should == 'Preferences'
-      service.controller_name.should == 'PreferencesController'
-    end
-
-    it "should set the action accordingly" do
-      @c_service.action.should_not be_nil
-      @c_service.action.should == 'test'
-    end
-
-    it "should support restful routes based on the HTTP verb" do
-      service = WSList.all.find{|s| s.url == "services.xml"}
-      service.should_not be_nil
-      service.http_verb.should == :put
-      service.action.should_not be_nil
-      service.controller_name.should == 'ServicesController'
-      service.action.should == 'update'
-    end
-
-    it "should have a default action" do
-      service = WeaselDiesel.new('spec_test.xml')
-      service.action.should == 'list'
-    end
-
-    it "should route to show when an id is the last passed param" do
-      service = WeaselDiesel.new("players/:id.xml")
-      service.action.should == 'show'
-    end
-
-    it "should support some extra attributes" do
-      service = WeaselDiesel.new("players/:id.xml")
-      service.extra[:custom_name] = 'fooBar'
-      service.extra[:custom_name].should == 'fooBar'
-    end
-
-    it "should respect the global controller pluralization flag" do
-      WeaselDiesel.use_pluralized_controllers = true
-      service = WeaselDiesel.new("player/:id.xml")
-      service.controller_name.should == "PlayersController"
-      service = WeaselDiesel.new("players/:id.xml")
-      service.controller_name.should == "PlayersController"
-      WeaselDiesel.use_pluralized_controllers = false
-      service = WeaselDiesel.new("player/:id.xml")
-      service.controller_name.should == "PlayerController"
-    end
-
-
-    it "should let overwrite the controller name and action after initialization" do
-      describe_service "players/:id.xml" do |service|
-        service.controller_name = "CustomController"
-        service.action = "foo"
-      end
-      service = WSList.all.find{|s| s.url == "players/:id.xml"}
-      service.controller_name.should == "CustomController"
-      service.action.should == "foo"
-    end
-
-  end
-
-
-  describe WeaselDiesel::Params do
-
-    before(:all) do
-      @sparams = @service.params
-    end
-
-    it "should have the possibility to have a space name" do
-      @sparams.should respond_to(:space_name)
-      service_params = WeaselDiesel::Params.new(:space_name => 'spec_test')
-      service_params.space_name.should == 'spec_test'
-    end
-
-    it "should have a list of required param rules" do
-      @sparams.list_required.should be_an_instance_of(Array)
-      @sparams.list_required.length.should == 1
-    end
-
-    it "should have a list of optional param rules" do
-      @sparams.list_optional.should be_an_instance_of(Array)
-      @sparams.list_optional.length.should == 4
-    end
-
-    it "should have a list of namespaced param rules" do
-      @sparams.namespaced_params.should be_an_instance_of(Array)
-      @sparams.namespaced_params.length.should == 1
-      @sparams.namespaced_params.first.space_name.should == :user
-    end
-
-    describe WeaselDiesel::Params::Rule do
-      before :all do
-        @rule = @sparams.list_required.first
-        @rule.should_not be_nil
-      end
-
-      it "should have a name" do
-        @rule.name.should == :framework
-      end
-
-      it "should have options" do
-        @rule.options[:type].should == :string
-        @rule.options[:in].should ==  WeaselDieselSpecOptions
-        @rule.options[:null].should be_false
-      end
-    end
-
-  end
-
-  it "should have some documentation" do
-    @service.doc.should be_an_instance_of(WeaselDiesel::Documentation)
-  end
-
-  describe WeaselDiesel::Documentation do
-    before(:all) do
-      @doc = @service.doc
-      @doc.should_not be_nil
-    end
-
-    it "should have an overall description" do
-      @doc.desc.strip.should == "This is a test service used to test the framework."
-    end
-
-    it "should have a list of params doc" do
-      @doc.params_doc.should be_an_instance_of(Hash)
-      @doc.params_doc.keys.sort.should == [:framework, :version]
-      @doc.params_doc[:framework].should == "The test framework used, could be one of the two following: #{WeaselDieselSpecOptions.join(", ")}."
-    end
-
-    it "should allow to define namespaced params doc" do
-      service = WSList.all.find{|s| s.url == "services.xml"}
-      service.documentation do |doc|
-        doc.namespace :preference do |ns|
-          ns.param :id, "Ze id."
-        end
-      end
-      service.doc.namespaced_params.should_not be_empty
-      ns = service.doc.namespaced_params.find{|ns| ns.name == :preference}
-      ns.should_not be_nil
-      ns.params[:id].should == "Ze id."
-    end
-
-    it "should have an optional list of examples" do
-      @doc.examples.should be_an_instance_of(Array)
-      @doc.examples.first.should == <<-DOC
-The most common way to use this service looks like that:
-    http://example.com/services/test.xml?framework=rspec&version=2.0.0
-      DOC
-    end
-
-    it "should have the service response documented" do
-      @doc.response.should_not be_nil
-    end
-
-    it "should have documentation for the response elements via the response itself" do
-      @service.response.elements.first.should_not be_nil
-      @service.response.elements.first.doc.should_not be_nil
-      @service.response.elements.first.doc.name.should == "player_creation_ratings"
-    end
-
-    it "should have documentation for a response element attribute" do
-      p @service.response.elements.first.doc.inspect
-      @service.response.elements.first.doc.attributes.should_not be_empty
-      @service.response.elements.first.doc.attributes[:id].should == "id doc"
-    end
-
-    it "should have documentation for a response element array" do
-      element = @service.response.elements.first
-      element.arrays.should_not be_empty
-      element.arrays.first.name.should == :player_creation_rating
-      element.arrays.first.type.should == "PlayerCreationRating"
-      element.arrays.first.attributes.should_not be_empty
-    end
-
-    it "should have documentation for the attributes of an response element array" do
-      element = @service.response.elements.first
-      array = element.arrays.first
-      attribute = array.attributes.find{|att| att.name == :comments }
-      attribute.should_not be_nil
-      attribute.name.should == :comments # just in case we change the way to find the attribute
-      attribute.doc.should == "comments doc"
-    end
-
-    it "should emit html documention for elements" do
-      @service.response.elements.first.to_html.should be_a(String)
-    end
-
-  end
-end