wsdsl 0.2.1 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/response.rb

@@ -9,22 +9,30 @@ class WSDSL
     # @api public
     attr_reader :elements
 
+    # The list of all the arays inside the response
+    #
+    # @return [Array<WSDSL::Response::Array>]
+    attr_reader :arrays
+
     def initialize
       @elements = []
+      @arrays  = []
     end
 
-    alias :nodes :elements
+    def nodes 
+      elements + arrays
+    end
 
-    # Shortcut to automatically create a typed node.
-    # Very useful when describing a JSON response.
+    # Shortcut to automatically create a node of array type.
+    # Useful when describing a JSON response.
     #
     # @param [String, Symbol] name the name of the element.
     # @param [Hash] opts the element options.
-    # @see Element#array
-    def array(name, opts={})
-      el = element(opts.merge(:name => name))
-      yield el if block_given?
-      el
+    # @see Vector#initialize
+    def array(name, type=nil)
+      vector = Vector.new(name, type)
+      yield(vector) if block_given?
+      @arrays << vector
     end
 
     # Defines a new element and yields the content of an optional block
@@ -170,27 +178,27 @@ class WSDSL
 
       # Defines an array aka vector of elements.
       #
-      # @param [Hash] opts A hash representing the array information, usually a name and a type.
-      # @option opts [String, Symbol] :name The name of the defined array
-      # @option opts [String, Symbol] :type The class name of the element inside the array
+      # @param [String, Symbol] name The name of the array element.
+      # @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 :name => 'player_creation_rating', :type => 'PlayerCreationRating' do |a|
+      #   element.array 'player_creation_rating', 'PlayerCreationRating' do |a|
       #     a.attribute :comments  => :string
       #     a.attribute :player_id => :integer
       #     a.attribute :rating    => :integer
       #     a.attribute :username  => :string
       #   end
       # @yield [Vector] the newly created array/vector instance
-      # @see Vector#initialize
+      # @see Element#initialize
       # 
-      # @return [Array<WSDSL::Response::Element::Vector>]
+      # @return [Array<WSDSL::Response::Vector>]
       # @api public
-      def array(opts)
-        vector = Vector.new(opts)
+      def array(name, type=nil)
+        vector = Vector.new(name, type)
         yield(vector) if block_given?
         @vectors << vector
       end
@@ -198,8 +206,8 @@ class WSDSL
       # Returns the arrays/vectors contained in the response.
       # This is an alias to access @vectors
       # @see @vectors
-      # 
-      # @return [Array<WSDSL::Response::Element::Vector>]
+      #
+      # @return [Array<WSDSL::Response::Vector>]
       # @api public
       def arrays
         @vectors
@@ -220,9 +228,9 @@ class WSDSL
       #
       # @return [Array<WSDSL::Response::Element>]
       # @api public
-      def element(opts={}, &block)
+      def element(opts={})
         el = Element.new(opts[:name], opts[:type])
-        block.call(el) if block_given?
+        yield(el) if block_given?
         @elements ||= []
         @elements << el
         el
@@ -300,7 +308,8 @@ class WSDSL
         if name
           meta_attribute({name => type}.merge(opts))
         else
-          meta_attributes.find{|att| att.type == type}
+          # with a fallback to the @type ivar
+          meta_attributes.find{|att| att.type == type} || @type
         end
       end
 
@@ -359,79 +368,12 @@ class WSDSL
       class MetaAttribute < Attribute
       end
 
-      # Array of objects inside an element
-      # @api public
-      class Vector
-
-        # @api public
-        attr_reader :name
-
-        # @api public
-        attr_reader :obj_type
-
-        # @api public
-        attr_accessor :attributes
-
-        # A vector can have nested elements.
-        # This value is nil by default.
-        #
-        # @return [NilClass, Array<WSDSL::Response::Element>]
-        # @see #element
-        # @api public
-        attr_reader :elements
-
-        # Initialize a Vector object, think about it as an array of objects of a certain type.
-        # It is recommended to passthe type argument as a string so the constant doesn't need to be resolved.
-        # In other words, if you say you are creating a vector of Foo objects, the Foo class doesn't need to be 
-        # loaded yet. That makes service parsing easier and avoids dependency challenges.
-        #
-        # @param [Hash] opts A hash representing the vector information, usually a name and a type, both as strings
-        # @option opts [String] :name The array's name
-        # @option opts [Symbol, String] :type The type of the objects inside the array
-        #
-        # @example
-        #   Vector.new(:name => 'player_creation_rating', :type => 'PlayerCreationRating')
-        #
-        # @api public
-        def initialize(opts)
-          @name       = opts[:name]
-          @obj_type   = opts[:type]
-          @attributes = []
-        end
-
-        # Sets a vector attribute
-        #
-        # @param (see Attribute#initialize)
-        # @api public
-        def attribute(opts)
-          raise ArgumentError unless opts.is_a?(Hash)
-          @attributes << Attribute.new(opts)
-        end
-
-        # Defines a new element and yields the content of an optional block
-        # Each new element is then stored in the elements array.
-        #
-        # @param [Hash] opts Options used to define the element
-        # @option opts [String, Symbol] :name The element name
-        # @option opts [String, Symbol] :type The optional type
-        #
-        # @yield [WSDSL::Response::Element] the newly created element
-        # @example create an element called 'my_stats'.
-        #   service.response do |response|
-        #    response.element(:name => "my_stats", :type => 'Leaderboard')
-        #   end
-        #
-        # @return [Array<WSDSL::Response::Element>]
-        # @api public
-        def element(opts={})
-          el = Element.new(opts[:name], opts[:type])
-          yield(el) if block_given?
-          @elements ||= []
-          @elements << el
-        end
-
-      end # of Vector
     end # of Element
 
+    # Array of objects
+    # @api public
+    class Vector < Element
+    end # of Vector
+
   end # of Response
 end

data/lib/ws_list.rb

@@ -34,7 +34,7 @@ module WSList
   # @return [WSDSL] The found service.
   #
   # @api public
-  def self.named(name)
+  def named(name)
     service = all.find{|service| service.name == name}
     if service.nil?
       raise UnknownService, "Service named #{name} isn't available"
@@ -42,6 +42,16 @@ module WSList
       service
     end
   end
+
+  # Returns a service based on its url
+  #
+  # @param [String] url The url of the service you are looking for.
+  # @return [Nil, WSDSL] The found service.
+  #
+  # @api public
+   def [](url)
+    @list.find{|service| service.url == url}
+  end
   
   
 end

data/lib/wsdsl.rb

@@ -25,9 +25,11 @@ require File.expand_path('ws_list', File.dirname(__FILE__))
 #    |             |_ Namespaced params (array containing nested optional and required rules)
 #    |__ response (instance of WSDSL::Response)
 #    |      |_ elements (array of elements with each element having a name, type, attributes and vectors
-#    |            |  |_ attributes (array of WSDSL::Response::Attribute, each attribute has a name, a type, a doc and some extra options)
-#    |            |_ vectors (array of WSDSL::Response::Vector), each vector has a name, obj_type, & an array of attributes
-#    |                 |_ attributes (array of WSDSL::Response::Attribute, each attribute has a name, a type and a doc)
+#    |      |      |  |_ attributes (array of WSDSL::Response::Attribute, each attribute has a name, a type, a doc and some extra options)
+#    |      |      |_ vectors (array of WSDSL::Response::Vector), each vector has a name, obj_type, & an array of attributes
+#    |      |           |_ attributes (array of WSDSL::Response::Attribute, each attribute has a name, a type and a doc)
+#    |      |_ arrays (like elements but represent an array of objects)
+#    |
 #    |__ doc (instance of WSDSL::Documentation)
 #       |  |  | |_ overal) description
 #       |  |  |_ examples (array of examples as strings)
@@ -123,14 +125,16 @@ class WSDSL
     @defined_params      = WSDSL::Params.new
     @doc                 = WSDSL::Documentation.new
     @response            = WSDSL::Response.new
-    @name                = extract_service_root_name(url)
-    if WSDSL.use_pluralized_controllers
-      base_name = ExtlibCopy::Inflection.pluralize(ExtlibCopy::Inflection.singular(name))
-      @controller_name     = "#{ExtlibCopy.classify(base_name)}Controller"
-    else
-      @controller_name     = "#{ExtlibCopy.classify(name)}Controller"
+    if WSDSL.use_controller_dispatch
+      @name                = extract_service_root_name(url)
+      if WSDSL.use_pluralized_controllers
+        base_name = ExtlibCopy::Inflection.pluralize(ExtlibCopy::Inflection.singular(name))
+        @controller_name     = "#{ExtlibCopy.classify(base_name)}Controller"
+      else
+        @controller_name     = "#{ExtlibCopy.classify(name)}Controller"
+      end
+      @action              = extract_service_action(url)
     end
-    @action              = extract_service_action(url)
     @verb                = :get
     @formats             = []
     @version             = '0.1'
@@ -159,6 +163,27 @@ class WSDSL
     @pluralized_controllers = val
   end
 
+  # Checks the WSDSL flag to see if controller are used to dispatch requests.
+  # This allows apps to use this DSL but route to controller/actions.
+  #
+  # @return [Boolean] The updated value, default to false
+  # @api public
+  # @since 0.3.0
+  def self.use_controller_dispatch
+    @controller_dispatch
+  end
+
+  # 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
+  def self.use_controller_dispatch=(val)
+    @controller_dispatch = val
+  end
+
   # Offers a way to dispatch the service at runtime
   # Basically, it dispatches the request to the defined controller/action
   # The full request cycle looks like that:
@@ -196,7 +221,14 @@ class WSDSL
     end
   end
   alias :param :params
-  
+ 
+  # Returns true if the DSL defined any params
+  #
+  # @return [Boolean]
+  def params?
+    !(required_rules.empty? && optional_rules.empty? && nested_params.empty?)
+  end
+
   # Returns an array of required param rules
   #
   # @return [Array<WSDSL::Params::Rule>] Only the required param rules

data/spec/test_services.rb

@@ -32,7 +32,7 @@ describe_service "services/test.xml" do |service|
       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|
+      e.array :player_creation_rating, 'PlayerCreationRating' do |a|
         a.attribute :comments  => :string,  :doc => "comments doc"
         a.attribute :player_id => :integer, :doc => "player_id doc"
         a.attribute :rating    => :integer, :doc => "rating doc"

data/spec/wsdsl_spec.rb

@@ -35,68 +35,84 @@ describe WSDSL do
   it "should have direct access to the nested params" do
     @service.nested_params.should == @service.params.namespaced_params
   end
-  
-  it "should set the controller accordingly" do
-    @service.controller_name.should_not be_nil
-    @service.controller_name.should == 'ServicesController'
-    service = WSDSL.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
-    @service.action.should_not be_nil
-    @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
+ 
+  describe "With controller dispatch on" do
+    before :all do
+      @original_services = WSList.all.dup
+      WSList.all.clear
+      WSDSL.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
+      WSDSL.use_controller_dispatch = false
+      WSList.all.replace @original_services
+    end
 
-  it "should have a default action" do
-    service = WSDSL.new('spec_test.xml')
-    service.action.should == 'list'
-  end
+    it "should set the controller accordingly" do
+      @c_service.controller_name.should_not be_nil
+      @c_service.controller_name.should == 'ServicesController'
+      service = WSDSL.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 route to show when an id is the last passed param" do
-    service = WSDSL.new("players/:id.xml")
-    service.action.should == 'show'
-  end
+    it "should have a default action" do
+      service = WSDSL.new('spec_test.xml')
+      service.action.should == 'list'
+    end
 
-  it "should support some extra attributes" do
-    service = WSDSL.new("players/:id.xml")
-    service.extra[:custom_name] = 'fooBar'
-    service.extra[:custom_name].should == 'fooBar'
-  end
+    it "should route to show when an id is the last passed param" do
+      service = WSDSL.new("players/:id.xml")
+      service.action.should == 'show'
+    end
 
-  it "should respect the global controller pluralization flag" do
-    WSDSL.use_pluralized_controllers = true
-    service = WSDSL.new("player/:id.xml")
-    service.controller_name.should == "PlayersController"
-    service = WSDSL.new("players/:id.xml")
-    service.controller_name.should == "PlayersController"
-    WSDSL.use_pluralized_controllers = false
-    service = WSDSL.new("player/:id.xml")
-    service.controller_name.should == "PlayerController"
-  end
+    it "should support some extra attributes" do
+      service = WSDSL.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
+      WSDSL.use_pluralized_controllers = true
+      service = WSDSL.new("player/:id.xml")
+      service.controller_name.should == "PlayersController"
+      service = WSDSL.new("players/:id.xml")
+      service.controller_name.should == "PlayersController"
+      WSDSL.use_pluralized_controllers = false
+      service = WSDSL.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"
+    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 WSDSL::Params do
     
     before(:all) do
@@ -203,8 +219,8 @@ The most common way to use this service looks like that:
     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.obj_type.should == "PlayerCreationRating"
+      element.arrays.first.name.should == :player_creation_rating
+      element.arrays.first.type.should == "PlayerCreationRating"
       element.arrays.first.attributes.should_not be_empty
     end
     

data/wsdsl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wsdsl}
-  s.version = "0.2.1"
+  s.version = "0.3.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-02}
+  s.date = %q{2011-09-09}
   s.description = %q{A Ruby DSL describing Web Services without implementation details.}
   s.email = %q{mattaimonetti@gmail.com}
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wsdsl
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-02 00:00:00.000000000Z
+date: 2011-09-09 00:00:00.000000000Z
 dependencies: []
 description: A Ruby DSL describing Web Services without implementation details.
 email: mattaimonetti@gmail.com