weasel_diesel 1.0.0 → 1.0.1

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/README.md

@@ -1,10 +1,10 @@
 # Web Service DSL
 
-Weasel Diesel is a simple DSL allowing developers to simply describe and
-document their web APIS. 
-The DSL is already setup on top of Sinatra in this [example
+Weasel Diesel is a DSL to describe and document your web API. 
+
+To get you going quickly, there's a Sinatra-based [example
 application](https://github.com/mattetti/sinatra-web-api-example) that
-you can simply fork and use as a base for your application.
+you can fork and use as a base for your application.
 
 DSL examples:
 
@@ -20,9 +20,9 @@ describe_service "hello_world" do |service|
   # OUTPUT
   service.response do |response|
     response.object do |obj|
-	    obj.string :message, :doc => "The greeting message sent back. Defaults to 'World'"
+      obj.string :message, :doc => "The greeting message sent back. Defaults to 'World'"
       obj.datetime :at, :doc => "The timestamp of when the message was dispatched"
-	  end
+    end
   end
 
   # DOCUMENTATION
@@ -41,30 +41,7 @@ describe_service "hello_world" do |service|
 end
 ```
 
-``` ruby
-    describe_service "hello_world" do |service|
-      service.formats    :xml
-      service.http_verb :get
-      service.disable_auth # on by default
-
-      service.param.string  :name, :default => 'World'
-
-      service.response do |response|
-        response.element(:name => "greeting") do |e|
-          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://example.com/hello_world.xml?name=Matt</code>"
-     end
-
-    end
-```
-
-Or a more complex example:
+Or a more complex example using XML:
 
 ``` ruby
     SpecOptions = ['RSpec', 'Bacon'] # usually pulled from a model
@@ -73,6 +50,7 @@ Or a more complex example:
       service.formats  :xml, :json
       service.http_verb :get
       
+      # INPUT
       service.params do |p|
         p.string :framework, :in => SpecOptions, :null => false, :required => true
        
@@ -80,18 +58,13 @@ Or a more complex example:
         p.string   :alpha,     :in      => ['a', 'b', 'c']
         p.string   :version,   :null    => false
         p.integer  :num,      :minvalue => 42
+        p.namespace :user do |user|
+          user.integer :id, :required => :true
+        end
       end
       
-      # service.param :delta, :optional => true, :type => 'float'
-      # All params are optional by default.
-      # service.param :epsilon, :type => 'string'
-      
-      service.params.namespace :user do |user|
-        user.integer :id, :required => :true
-      end
-      
+      # OUTPUT
       # 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"
@@ -107,6 +80,7 @@ Or a more complex example:
         end
       end
       
+      # DOCUMENTATION
       service.documentation do |doc|
         # doc.overall <markdown description text>
         doc.overall <<-DOC
@@ -128,11 +102,9 @@ Or a more complex example:
 
 ## JSON APIs
 
-This library was designed with XML responses in mind and JSON support
-was added later on which explains why some response methods are aliases.
 Consider the following JSON response:
 
-``` json
+``` 
     { people: [ 
       { 
         id : 1, 
@@ -153,6 +125,7 @@ Consider the following JSON response:
         }
       }, 
     ] }
+```
 
 It would be described as follows:
 
@@ -173,30 +146,46 @@ It would be described as follows:
     end
 ```
 
-Nodes/elements can also use some meta attributes. Currently the
-following meta attributes are available:
+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
-  cross OO based apps.
+* `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.
-Look at the spec/json_response_verification_spec.rb file for a complete
-example. The goal of this module is to help automate API testing by
+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.
 
-## Test suite
 
-This library comes with a test suite requiring Ruby 1.9.2
-The following gems need to be available:
-Rspec, Rack, Sinatra
+Other JSON DSL examples:
+
+```
+{"organization": {"name": "Example"}}
+```
+
+``` Ruby
+  describe_service "example" do |service|
+    service.formats  :json
+    service.response do |response|
+      response.object :organization do |node|
+        node.string :name
+      end
+    end
+  end
+```
+
+
+## Test Suite & Dependencies
 
-## RUBY 1.8 warning
+The test suite requires Ruby 1.9.* along with `RSpec`, `Rack`, and `Sinatra` gems.
 
-This library was written for Ruby 1.9 and 1.8 support was added later on
-via the backports libary and some tweaks. However, because unlike in
-ruby 1.9, the hash insert order isn't kept in 1.8 the following syntax
-isn't supported and the alternative version needs to be used:
+## 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|
@@ -208,7 +197,7 @@ isn't supported and the alternative version needs to be used:
     end
 ```
 
-Instead the following version should be used:
+Instead, this alternate syntax must be used:
 
 ``` ruby
     service.response do |response|
@@ -220,10 +209,7 @@ Instead the following version should be used:
     end
 ```
 
-Both code snippets do the exact same thing but the first version is 1.9
-only.
-
-
+The end results are identical.
 
 ## Copyright
 

data/lib/response.rb

@@ -62,12 +62,13 @@ class WeaselDiesel
       el
     end
 
-    # Defines an anonymous element
-    # Useful for JSON response description
-    #
-    # @return [WeaselDiesel::Response::Element]
-    def object
-      yield element
+    # Defines an element/object in a consistent way with
+    # the way objects are defined in nested objects.
+    # @param [Symbol, String] name the name of the element.
+    # @param [Hash] opts the options for the newly created element.
+    # @return [WeaselDiesel::Response] returns self since it yields to the used block.
+    def object(name=nil, opts={})
+      yield element(opts.merge(:name => name))
     end
 
     # Returns a response element object based on its name
@@ -361,10 +362,10 @@ class WeaselDiesel
         output << "<ul>"
         properties.each do |prop|
           output << "<li><span class='label notice'>#{prop.name}</span> of type <span class='label success'>#{prop.type}</span> #{'(Can be blank or missing) ' if prop.opts && prop.opts.respond_to?(:[]) && prop.opts[:null]} "
-          output <<  prop.doc unless prop.doc.blank?
+          output <<  prop.doc unless prop.doc.nil? or prop.doc.empty?
           output << "</li>"
         end
-        arrays.each{ |arr| output << arr.html }
+        arrays.each{ |arr| output << arr.to_html }
         elements.each {|el| output << el.to_html } if elements
         output << "</ul>"
         output << "</li>" if name

data/lib/weasel_diesel/version.rb

@@ -1,3 +1,3 @@
 class WeaselDiesel
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/json_response_description_spec.rb

@@ -122,3 +122,66 @@ describe "WeaselDiesel JSON response description" do
   end
   
 end
+
+
+
+describe "WeaselDiesel simple JSON object response description" do
+
+# JSON response example
+=begin
+  {"organization": {"name": "Example"}}
+=end
+
+  before :all do
+    @timestamp = Time.now.to_i
+    @service =  describe_service "json_obj" do |service|
+      service.formats  :json
+      service.response do |response|
+        response.object :organization do |node|
+          node.string :name
+        end
+      end
+    end
+    @response  = @service.response
+  end
+
+  it "should have a properly structured reponse" do
+    top_object = @service.response.element_named(:organization)
+    top_object.should_not be_nil
+    name_node = top_object.properties.find{|o| o.name == :name}
+    name_node.should_not be_nil
+    name_node.type.should == :string
+  end
+
+end
+
+
+describe "WeaselDiesel anonymous JSON object response description" do
+
+# JSON response example
+=begin
+  {"name": "Example"}
+=end
+
+  before :all do
+    @timestamp = Time.now.to_i
+    @service =  describe_service "anon_json_obj" do |service|
+      service.formats  :json
+      service.response do |response|
+        response.object do |node|
+          node.string :name
+        end
+      end
+    end
+    @response  = @service.response
+  end
+
+  it "should have a properly structured reponse" do
+    top_object = @service.response.elements.first
+    top_object.should_not be_nil
+    name_node = top_object.properties.find{|o| o.name == :name}
+    name_node.should_not be_nil
+    name_node.type.should == :string
+  end
+
+end

data/spec/wsdsl_spec.rb

@@ -309,6 +309,9 @@ The most common way to use this service looks like that:
       attribute.doc.should == "comments doc"
     end
 
-  end
+    it "should emit html documention for elements" do
+      @service.response.elements.first.to_html.should be_a(String)
+    end
 
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weasel_diesel
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-04 00:00:00.000000000 Z
+date: 2012-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70335708644280 !ruby/object:Gem::Requirement
+  requirement: &70204984229320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70335708644280
+  version_requirements: *70204984229320
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70335708643860 !ruby/object:Gem::Requirement
+  requirement: &70204984228900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70335708643860
+  version_requirements: *70204984228900
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70335708643440 !ruby/object:Gem::Requirement
+  requirement: &70204984228480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70335708643440
+  version_requirements: *70204984228480
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70335708659380 !ruby/object:Gem::Requirement
+  requirement: &70204984228060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70335708659380
+  version_requirements: *70204984228060
 description: Ruby DSL describing Web Services without implementation details.
 email:
 - mattaimonetti@gmail.com
@@ -62,8 +62,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: .
-  specs:
-    wsdsl (1.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    rack (1.4.1)
-    rack-protection (1.2.0)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    sinatra (1.3.2)
-      rack (~> 1.3, >= 1.3.6)
-      rack-protection (~> 1.2)
-      tilt (~> 1.3, >= 1.3.3)
-    tilt (1.3.3)
-    yard (0.7.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rack-test
-  rspec
-  sinatra
-  wsdsl!
-  yard