wsdsl 0.4.1 → 0.4.2

data/README.md

@@ -125,7 +125,7 @@ It would be described as follows:
           node.datetime :created_at
           node.object :team do |team|
             team.integer :id
-            team.float :score
+            team.float :score, :null => true
           end
         end
       end
@@ -138,6 +138,11 @@ following meta attributes are available:
 * type (refers to the type of object described, valuable when using JSON
   cross 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
+validating the data structure of the returned object.
+
 ## Test suite
 
 This library comes with a test suite requiring Ruby 1.9.2

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/lib/json_response_verification.rb

@@ -75,18 +75,31 @@ module JSONResponseVerification
     if el_or_attr.is_a?(WSDSL::Response::Element)
       "#{el_or_attr.name || 'top level'} Node/Object/Element is missing"
     elsif type_error
-      "#{el_or_attr.name || el_or_attr.inspect} was of wrong type"
+      error = "#{el_or_attr.name || el_or_attr.inspect} was of wrong type, expected #{el_or_attr.type}"
+      if el_or_attr.name
+        error << " and the value was: #{hash[el_or_attr.name.to_s]}"
+      end
+      error
     else
       "#{el_or_attr.name || el_or_attr.inspect} is missing in #{hash.inspect}"
     end
   end
 
   def valid_hash_type?(hash, prop_template)
+    name = prop_template.name.to_s
+    attribute = hash[name]
+    # Check for nullity
+    if attribute.nil? && prop_template.opts[:null] != true
+      return false
+    end
     type = prop_template.type
     return true if type.nil?
     rule = ParamsVerification.type_validations[type.to_sym]
-    return true if rule.nil?
-    attribute = hash[prop_template.name.to_s]
+    if rule.nil?
+      puts "Don't know how to validate attributes of type #{type}" if type.to_sym != :string
+      return true
+    end
+    
     attribute.to_s =~ rule
   end
 

data/spec/json_response_verification_spec.rb

@@ -25,7 +25,7 @@ describe "JSON response verification" do
       service.response do |response|
         response.object do |user|
           user.integer :id
-          user.string :name
+          user.string :name, :null => true
           user.datetime :created_at
           user.object :creds do |creds|
             creds.integer :id
@@ -42,7 +42,7 @@ describe "JSON response verification" do
           node.integer :id
           node.string  :name
           node.boolean :admin, :doc => "true if the user is an admin"
-          node.string  :state, :doc => "test"
+          node.string  :state, :doc => "test", :null => true
           node.datetime :last_login_at
         end
       end
@@ -69,7 +69,7 @@ describe "JSON response verification" do
   def valid_response(namespaced=true)
     response = { 
       "id" => 1, 
-      "name" => "matt", 
+      "name" => "matt",
       "created_at" => "2011-09-22T16:32:46-07:00", 
       "creds" => { "id" => 42, "price" => 2010.07, "enabled" => false }
       } 
@@ -80,11 +80,13 @@ describe "JSON response verification" do
     {"users" => [
       {"id" => 1,
         "admin" => true,
+        "name" => "Heidi",
         "state" => "retired",
         "last_login_at" => "2011-09-22T22:46:35-07:00"
       },
       {"id" => 2,
         "admin" => false,
+        "name" => "Giana",
         "state" => "playing",
         "last_login_at" => "2011-09-22T22:46:35-07:00"
       }]
@@ -95,11 +97,13 @@ describe "JSON response verification" do
     {"users" => [
       {"id" => 1,
         "admin" => true,
+        "name" => "Heidi",
         "state" => "retired",
         "pets" => []
       },
       {"id" => 2,
         "admin" => false,
+        "name" => "Giana",
         "state" => "playing",
         "pets" => [{"id" => 23, "name" => "medor"}, {"id" => 34, "name" => "rex"}]
       }]
@@ -109,6 +113,7 @@ describe "JSON response verification" do
 
   it "should validate the response" do
     valid, errors = @service.validate_hash_response(valid_response)
+    errors.should == []
     valid.should be_true
     errors.should be_empty
   end
@@ -121,7 +126,7 @@ describe "JSON response verification" do
     errors.should_not be_empty
   end
 
-  it "should detect that a property type is wrong" do
+  it "should detect that a property integer type is wrong" do
      response = valid_response
      response["user"]["id"] = 'test'
      valid, errors = @service.validate_hash_response(response)
@@ -131,6 +136,28 @@ describe "JSON response verification" do
      errors.first.should match(/wrong type/)
   end
 
+  it "should detect that an integer attribute value is nil" do
+    response = valid_response
+     response["user"]["id"] = nil
+     valid, errors = @service.validate_hash_response(response)
+     valid.should be_false
+     errors.should_not be_empty
+     errors.first.should match(/id/)
+     errors.first.should match(/wrong type/)
+  end
+
+  it "should detect that a string attribute value is nil [bug]" do
+    response = valid_response
+     response["user"]["name"] = nil
+     # puts response.inspect
+     valid, errors = @service.validate_hash_response(response)
+     valid.should be_false
+     errors.should_not be_empty
+     errors.first.should match(/name/)
+     errors.first.should match(/wrong type/)
+  end
+
+
   it "should detect that a nested object is missing" do
      response = valid_response
      response["user"].delete("creds")
@@ -140,6 +167,11 @@ describe "JSON response verification" do
      errors.first.should match(/missing/)
   end
 
+  it "should validate non namespaced responses" do
+    valid, errors = @second_service.validate_hash_response(valid_response(false))
+    valid.should be_true
+  end
+
   it "should validate nil attributes if marked as nullable" do
     response = valid_response(false)
     response["name"] = nil

data/wsdsl.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wsdsl}
-  s.version = "0.4.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Matt Aimonetti}]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wsdsl
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors: