wsdsl 0.4.3 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.5.0

data/lib/params.rb

@@ -50,6 +50,13 @@ class WSDSL
         @options[:space_name]
       end
 
+      # Converts the rule into a hash with its name and options.
+      #
+      # @return [Hash]
+      def to_hash
+        {:name => name, :options => options}
+      end
+
     end # of Rule
 
     # The namespace used if any

data/lib/response.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 class WSDSL
   # Response DSL class
   # @api public
@@ -77,6 +79,26 @@ class WSDSL
       @elements.find{|e| e.name.to_s == name.to_s}
     end
 
+
+    # Converts the object into a JSON representation
+    # @return [String] JSON representation of the response
+    def to_json(*args)
+      if nodes.size > 1
+        nodes.to_json(*args)
+      else
+        nodes.first.to_json(*args)
+      end
+    end
+
+
+    class Params
+      class Rule
+        def to_hash
+          {:name => name, :options => options}
+        end
+      end
+    end
+
     # The Response element class describing each element of a service response.
     # Instances are usually not instiated directly but via the Response#element accessor.
     #
@@ -312,6 +334,44 @@ class WSDSL
         attribute({name => :datetime}.merge(opts))
       end
 
+      # Converts an element into a hash representation
+      #
+      # @return [Hash] the element attributes formated in a hash
+      def to_hash
+        attrs = {}
+        attributes.each{ |attr| attrs[attr.name] = attr.type }
+        elements.each{ |el| attrs[el.name] = el.to_hash } if elements
+        if self.class == Vector
+          name ? {name => [attrs]} : [attrs]
+        else
+          name ? {name => attrs} : attrs
+        end
+      end
+
+      def to_html
+        output = ""
+        if name
+          output << "<li>"
+          output << "<span class='label notice'>#{name}</span> of type <span class='label success'>#{self.is_a?(Vector) ? 'Array' : 'Object'}</span>"
+        end
+        if self.is_a? Vector
+          output << "<h6>Properties of each array item:</h6>"
+        else
+          output << "<h6>Properties:</h6>"
+        end
+        output << "<ul>"
+        properties.each do |prop|
+          output << "<li><span class='label notice'>#{prop.name}</span> of type <span class='label success'>#{prop.type}</span> "
+          output <<  prop.doc unless prop.doc.blank?
+          output << "</li>"
+        end
+        arrays.each{ |arr| output << arr.html }
+        elements.each {|el| output << el.to_html } if elements
+        output << "</ul>"
+        output << "</li>" if name
+        output
+      end
+
       private
 
       # Create a meta element attribute

data/lib/wsdsl.rb

@@ -8,14 +8,14 @@ require File.expand_path('ws_list', File.dirname(__FILE__))
 # their params, http verbs, formats expected as well as the documentation
 # for all these aspects of a web service.
 #
-# This DSL is only meant to describe a web service and isn't meant to cover any type 
+# This DSL is only meant to describe a web service and isn't meant to cover any type
 # of implementation details. It is meant to be framework/tool agnostic.
 #
 # However, tools can be built around the Web Service DSL data structure to extract documentation,
 # generate routing information, verify that an incoming request is valid, generate automated tests...
 #
-# 
-# 
+#
+#
 #  WSDSL
 #    |
 #    |__ service options (name, url, SSL, auth required formats, verbs, controller name, action, version, extra)
@@ -37,71 +37,71 @@ require File.expand_path('ws_list', File.dirname(__FILE__))
 #       |_ response (instance of Documentation.new)
 #            |_ elements (array of instances of WSDSL::Documentation::ElementDoc, each element has a name and a list of attributes)
 #                  |_ attributes (Hash with the key being the attribute name and the value being the attribute's documentation)
-# 
+#
 # @since 0.0.3
 # @api public
 class WSDSL
-  
+
   # Returns the service url
   #
   # @return [String] The service url
   # @api public
   attr_reader :url
-  
+
   # List of all the service params
   #
   # @return [Array<WSDSL::Params>]
   # @api public
   attr_reader :defined_params
-  
+
   # Documentation instance containing all the service doc
   #
   # @return [WSDSL::Documentation]
   # @api public
   attr_reader :doc
-  
+
   # The HTTP verb supported
   #
   # @return [Symbol]
   # @api public
   attr_reader :verb
-  
+
   # Service's version
   #
   # @return [String]
   # @api public
   attr_reader :version
-  
+
   # Controller instance associated with the service
   #
   # @return [WSController]
   # @api public
   attr_reader :controller
-  
-  # Name of the controller action associated with the service 
+
+  # Name of the controller action associated with the service
   #
   # @return [String]
   # @api public
   attr_accessor :action
-  
+
   # Name of the controller associated with the service
   #
   # @return [String]
   # @api public
   attr_accessor :controller_name
-  
+
   # Name of the service
   #
   # @return [String]
   # @api public
   attr_reader :name
-  
+
   # Is SSL required?
   #
   # @return [Boolean]
   # @api public
   attr_reader :ssl
-  
+
   # Is authentication required?
   #
   # @return [Boolean]
@@ -109,12 +109,12 @@ class WSDSL
   attr_reader :auth_required
 
   # Extra placeholder to store data in based on developer's discretion.
-  # 
+  #
   # @return [Hash] A hash storing extra data based.
   # @api public
   # @since 0.1
   attr_reader :extra
-  
+
   # Service constructor which is usually used via {Kernel#describe_service}
   #
   # @param [String] url Service's url
@@ -142,7 +142,7 @@ class WSDSL
     @auth_required       = true
     @extra               = {}
   end
-  
+
   # Checks the WSDSL flag to see if the controller names are pluralized.
   #
   # @return [Boolean] The updated value, default to false
@@ -155,7 +155,7 @@ class WSDSL
   # Sets a WSDSL global flag so all controller names will be automatically pluralized.
   #
   # @param [Boolean] True if the controllers are pluralized, False otherwise.
-  # 
+  #
   # @return [Boolean] The updated value
   # @api public
   # @since 0.1.1
@@ -176,7 +176,7 @@ class WSDSL
   # Sets a WSDSL global flag so the controller settings can be generated
   # Setting this flag will automatically set the controller/action names.
   # @param [Boolean] True if the controllers are pluralized, False otherwise.
-  # 
+  #
   # @return [Boolean] The updated value
   # @api public
   # @since 0.1.1
@@ -194,9 +194,10 @@ class WSDSL
   # @api private
   def controller_dispatch(app)
     unless @controller
-      if Object.const_defined?(@controller_name)
-        @controller = Object.const_get(@controller_name)
-      else
+      klass = @controller_name.split("::")
+      begin
+        @controller = klass.inject(Object) { |const,k| const.const_get(k) }
+      rescue NameError => e
         raise "The #{@controller_name} class was not found"
       end
     end
@@ -204,8 +205,8 @@ class WSDSL
     # param verification could be done when the controller gets initialized.
     @controller.new(app, self).send(@action)
   end
-  
-  # Returns the defined params 
+
+  # Returns the defined params
   # for DSL use only!
   # To keep the distinction between the request params and the service params
   # using the +defined_params+ accessor is recommended.
@@ -221,7 +222,7 @@ class WSDSL
     end
   end
   alias :param :params
- 
+
   # Returns true if the DSL defined any params
   #
   # @return [Boolean]
@@ -236,7 +237,7 @@ class WSDSL
   def required_rules
     @defined_params.list_required
   end
-  
+
   # Returns an array of optional param rules
   #
   # @return [Array<WSDSL::Params::Rule>]Only the optional param rules
@@ -244,7 +245,7 @@ class WSDSL
   def optional_rules
     @defined_params.list_optional
   end
-  
+
   # Returns an array of namespaced params
   # @see WSDSL::Params#namespaced_params
   #
@@ -253,7 +254,7 @@ class WSDSL
   def nested_params
     @defined_params.namespaced_params
   end
-  
+
   # Mark that the service doesn't require authentication.
   # Note: Authentication is turned on by default
   #
@@ -262,7 +263,7 @@ class WSDSL
   def disable_auth
     @auth_required = false
   end
-  
+
   # Mark that the service requires a SSL connection
   #
   # @return [Boolean]
@@ -270,19 +271,19 @@ class WSDSL
   def enable_ssl
     @ssl = true
   end
-  
+
   # Mark the current service as not accepting any params.
-  # This is purely for expressing the developer's objective since 
+  # This is purely for expressing the developer's objective since
   # by default an error is raise if no params are defined and some
   # params are sent.
-  # 
+  #
   # @return [Nil]
   # @api public
   def accept_no_params!
     # no op operation since this is the default behavior
     # unless params get defined. Makes sense for documentation tho.
   end
-  
+
   # Returns the service response
   # @yield The service response object
   #
@@ -295,7 +296,7 @@ class WSDSL
       @response
     end
   end
-  
+
   # Sets or returns the supported formats
   # @param [String, Symbol] f_types Format type supported, such as :xml
   #
@@ -305,7 +306,7 @@ class WSDSL
     f_types.each{|f| @formats << f unless @formats.include?(f) }
     @formats
   end
-  
+
   # Sets the accepted HTTP verbs or return it if nothing is passed.
   #
   # @return [String, Symbol]
@@ -318,7 +319,7 @@ class WSDSL
     update_restful_action(@verb)
     @verb
   end
-  
+
   # Yields and returns the documentation object
   # @yield [WSDSL::Documentation]
   #
@@ -328,17 +329,39 @@ class WSDSL
     yield(doc)
   end
 
-  SERVICE_ROOT_REGEXP = /(.*?)[\/\(\.]/  
+  # Assign a route loading point to compare two routes.
+  # Using this point value, one can load routes with the more globbing
+  # routes later than short routes.
+  #
+  # @return [Integer] point value
+  def route_loading_point
+    url =~ /(.*?):(.*?)[\/\.](.*)/
+    return url.size if $1.nil?
+    # The shortest the prepend, the further the service should be loaded
+    prepend = $1.size
+    # The shortest the placeholder, the further it should be in the queue
+    place_holder = $2.size
+     # The shortest the trail, the further it should be in the queue
+    trail = $3.size
+    prepend + place_holder + trail
+  end
+
+  # Compare two services using the route loading point
+  def <=> (other)
+    route_loading_point <=> other.route_loading_point
+  end
+
+  SERVICE_ROOT_REGEXP = /(.*?)[\/\(\.]/
   SERVICE_ACTION_REGEXP = /[\/\(\.]([a-z0-9_]+)[\/\(\.\?]/i
   SERVICE_RESTFUL_SHOW_REGEXP = /\/:[a-z0-9_]+\.\w{3}$/
-  
+
   private
-  
+
   # extracts the service root name out of the url using a regexp
   def extract_service_root_name(url)
     url[SERVICE_ROOT_REGEXP, 1] || url
   end
-  
+
   # extracts the action name out of the url using a regexp
   # Defaults to the list action
   def extract_service_action(url)
@@ -348,7 +371,7 @@ class WSDSL
       url[SERVICE_ACTION_REGEXP, 1] || 'list'
     end
   end
-  
+
   # Check if we need to use a restful route in which case we need
   # to update the service action
   def update_restful_action(verb)
@@ -388,5 +411,5 @@ module Kernel
     WSList.add(service)
     service
   end
-  
+
 end

data/spec/test_services.rb

@@ -3,35 +3,35 @@ WSDSLSpecOptions = ['RSpec', 'Bacon'] # usually pulled from a model
 describe_service "services/test.xml" do |service|
   service.formats  :xml, :json
   service.http_verb :get
-  
+
   service.params do |p|
     p.string :framework, :in => WSDSLSpecOptions, :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.param :delta, :optional => true, :type => 'float'
-  # # if the optional flag isn't passed, the param is considered required. 
+  # # if the optional flag isn't passed, the param is considered required.
   # service.param :epsilon, :type => 'string'
-  
+
   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
-  
-  # 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 :player_creation_rating, 'PlayerCreationRating' do |a|
         a.attribute :comments  => :string,  :doc => "comments doc"
         a.attribute :player_id => :integer, :doc => "player_id doc"
@@ -40,17 +40,17 @@ describe_service "services/test.xml" do |service|
       end
     end
   end
-  
+
   service.documentation do |doc|
     # doc.overall <markdown description text>
     doc.overall <<-DOC
      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: #{WSDSLSpecOptions.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:
@@ -69,7 +69,7 @@ end
 describe_service "services.xml" do |service|
   service.formats  :xml
   service.http_verb :put
-  
+
 end
 
 describe_service "services/array_param.xml" do |s|

data/spec/wsdsl_spec.rb

@@ -1,25 +1,25 @@
 require File.expand_path("spec_helper", File.dirname(__FILE__))
 
 describe WSDSL 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(WSDSL::Params)
   end
@@ -27,15 +27,89 @@ describe WSDSL do
   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 = WSDSL.use_controller_dispatch
+      WSDSL.use_controller_dispatch = true
+      @original_services = WSList.all.dup
+      WSList.all.clear
+    end
+
+    after :all do
+      WSDSL.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
@@ -58,12 +132,12 @@ describe WSDSL do
       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' 
+      @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
@@ -110,21 +184,22 @@ describe WSDSL do
       service.controller_name.should == "CustomController"
       service.action.should == "foo"
     end
+
   end
 
 
   describe WSDSL::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 = WSDSL::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
@@ -134,52 +209,52 @@ describe WSDSL 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 WSDSL::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 ==  WSDSLSpecOptions
         @rule.options[:null].should be_false
       end
     end
-    
+
   end
-  
+
   it "should have some documentation" do
     @service.doc.should be_an_instance_of(WSDSL::Documentation)
   end
-  
+
   describe WSDSL::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: #{WSDSLSpecOptions.join(", ")}."
     end
-    
+
     it "should allow to define namespaced params doc" do
       service = WSList.all.find{|s| s.url == "services.xml"}
       service.documentation do |doc|
@@ -192,7 +267,7 @@ describe WSDSL do
       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
@@ -200,11 +275,11 @@ 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
@@ -215,7 +290,7 @@ The most common way to use this service looks like that:
       @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
@@ -223,7 +298,7 @@ The most common way to use this service looks like that:
       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

data/wsdsl.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{wsdsl}
-  s.version = "0.4.3"
+  s.name = "wsdsl"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Matt Aimonetti}]
-  s.date = %q{2011-09-23}
-  s.description = %q{A Ruby DSL describing Web Services without implementation details.}
-  s.email = %q{mattaimonetti@gmail.com}
+  s.authors = ["Matt Aimonetti"]
+  s.date = "2012-01-10"
+  s.description = "A Ruby DSL describing Web Services without implementation details."
+  s.email = "mattaimonetti@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"
@@ -43,11 +43,11 @@ Gem::Specification.new do |s|
     "spec/wsdsl_spec.rb",
     "wsdsl.gemspec"
   ]
-  s.homepage = %q{http://github.com/mattetti/wsdsl}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.6}
-  s.summary = %q{Web Service DSL}
+  s.homepage = "http://github.com/mattetti/wsdsl"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Web Service DSL"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wsdsl
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-23 00:00:00.000000000Z
+date: 2012-01-10 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby DSL describing Web Services without implementation details.
 email: mattaimonetti@gmail.com
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Web Service DSL