wsdsl 0.3.3 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.4.0

data/lib/json_response_verification.rb

@@ -0,0 +1,83 @@
+# include this module in WSDSL
+# to add response verification methods.
+#
+module JSONResponseVerification
+
+  # Validates a hash against the service's response description.
+  #
+  # @return [Array<TrueClass, FalseClass, Array<String>>] True/false and an array of errors.
+  def validate_hash_response(hash)
+    errors = []
+    response.nodes.each do |node|
+      if node.name
+        # Verify that the named node exists in the hash
+        unless hash.has_key?(node.name.to_s)
+          errors << json_response_error(node, hash) 
+          return [false, errors]
+        end
+      end
+      errors += validate_hash_against_template_node(hash, node)
+    end
+
+    [errors.empty?, errors]
+  end
+
+  private
+
+  # Recursively validates a hash representing a json response.
+  #
+  # @param [Hash>] hash the hash to verify.
+  # @param [WDSL::Response::Element>] node the reference element defined in the response description.
+  # @param [<TrueClass, FalseClass>] nested if the node/hash to verify is nested or not. If nested, the method expects to get the subhash 
+  #   & won't verify that the name exists since it was done a level higher.
+  # @param [Arrays<String>] errors the list of errors encountered while verifying.
+  #
+  # @return [<TrueClass, FalseClass>]
+  def validate_hash_against_template_node(hash, node, nested=false, errors=[])
+    if hash.nil?
+      errors << json_response_error(node, hash)
+      return errors
+    end
+
+    if node.name && !nested
+      if hash.has_key?(node.name.to_s)
+        subhash = hash[node.name.to_s]
+      else
+        errors << json_response_error(node, hash) unless hash.has_key?(node.name.to_s)
+      end
+    end
+
+    node.properties.each do |prop|
+      subhash ||= hash
+      errors << json_response_error(prop, subhash) unless subhash.has_key?(prop.name.to_s)
+      errors << json_response_error(prop, subhash, true) unless valid_hash_type?(subhash, prop)
+    end
+
+    node.objects.each do |obj|
+      # recursive call
+      validate_hash_against_template_node(subhash[obj.name.to_s], obj, true, errors)
+    end if node.objects
+
+    errors
+  end
+
+  def json_response_error(el_or_attr, hash, type_error=false)
+    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"
+    else
+      "#{el_or_attr.name || el_or_attr.inspect} is missing in #{hash.inspect}"
+    end
+  end
+
+  def valid_hash_type?(hash, prop_template)
+    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]
+    attribute.to_s =~ rule
+  end
+
+end

data/lib/params_verification.rb

@@ -120,6 +120,7 @@ module ParamsVerification
     elsif rule.options[:type]
       verify_cast(param_name, param_value, rule.options[:type])
     end
+
     if rule.options[:options] || rule.options[:in]
       choices = rule.options[:options] || rule.options[:in]
       if rule.options[:type]
@@ -127,9 +128,10 @@ module ParamsVerification
         param_value = params[param_name] = type_cast_value(rule.options[:type], param_value)
       end
       raise InvalidParamValue, "Value for parameter '#{param_name}' (#{param_value}) is not in the allowed set of values." unless choices.include?(param_value)
+    # You can have a "in" rule that also applies a min value since they are mutually exclusive
     elsif rule.options[:minvalue]
       min = rule.options[:minvalue]
-      raise InvalidParamValue, "Value for parameter '#{param_name}' is lower than the min accepted value (#{min})." if param_value.to_i >= min
+      raise InvalidParamValue, "Value for parameter '#{param_name}' is lower than the min accepted value (#{min})." if param_value.to_i < min
     end
     # Returns the updated params
     

data/lib/response.rb

@@ -19,6 +19,9 @@ class WSDSL
       @arrays  = []
     end
 
+    # Lists all top level simple elements and array elements.
+    #
+    # @return [Array<WSDSL::Response::Element, WSDSL::Response::Array>]
     def nodes 
       elements + arrays
     end
@@ -48,7 +51,7 @@ class WSDSL
     #    response.element(:name => "my_stats", :type => 'Leaderboard')
     #   end
     #
-    # @return [Array<WSDSL::Response::Element>]
+    # @return [WSDSL::Response::Element]
     # @api public
     def element(opts={})
       el = Element.new(opts[:name], opts[:type])
@@ -57,6 +60,14 @@ class WSDSL
       el
     end
 
+    # Defines an anonymous element
+    # Useful for JSON response description
+    #
+    # @return [WSDSL::Response::Element]
+    def object
+      yield element
+    end
+
     # Returns a response element object based on its name
     # @param [String, Symbol] The element name we want to match
     #

data/spec/json_response_description_spec.rb

@@ -102,5 +102,23 @@ describe "WSDSL JSON response description" do
     name = @root_node.properties.find{|prop| prop.name == :name}
     name.opts[:mock].should == "test"
   end
+
+  it "should allow an anonymous object at the root of the response" do
+    service =  describe_service "json_anonymous_obj" do |service|
+      service.formats  :json
+      service.response do |response|
+        response.object do |obj|
+          obj.integer :id
+          obj.string :foo
+        end
+      end
+    end
+    response = service.response
+    response.nodes.should_not be_empty
+    obj = response.nodes.first
+    obj.should_not be_nil
+    obj.properties.find{|prop| prop.name == :id}.should_not be_nil
+    obj.properties.find{|prop| prop.name == :foo}.should_not be_nil
+  end
   
 end

data/spec/json_response_verification_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+require File.expand_path("../lib/json_response_verification", File.dirname(__FILE__))
+
+WSDSL.send(:include, JSONResponseVerification)
+
+describe "JSON response verification" do
+
+  before :all do
+    @service = describe_service "json_response_verification" do |service|
+      service.response do |response|
+        response.element(:name => :user) do |user|
+          user.integer :id
+          user.string :name
+          user.datetime :created_at
+          user.object :creds do |creds|
+            creds.integer :id
+            creds.float   :price
+            creds.boolean :enabled
+          end
+        end
+      end
+    end
+
+    @second_service = describe_service "anonym_obj_json_response_verification" do |service|
+      service.response do |response|
+        response.object do |user|
+          user.integer :id
+          user.string :name
+          user.datetime :created_at
+          user.object :creds do |creds|
+            creds.integer :id
+            creds.float   :price
+            creds.boolean :enabled
+          end
+        end
+      end
+    end
+
+  end
+
+  def valid_response(namespaced=true)
+    response = { 
+      "id" => 1, 
+      "name" => "matt", 
+      "created_at" => "2011-09-22T16:32:46-07:00", 
+      "creds" => { "id" => 42, "price" => 2010.07, "enabled" => false }
+      } 
+    namespaced ? {"user" => response} : response
+  end
+
+  it "should validate the response" do
+    valid, errors = @service.validate_hash_response(valid_response)
+    valid.should be_true
+    errors.should be_empty
+  end
+
+  it "should detect that the response is missing the top level object" do
+    response = valid_response
+    response.delete("user")
+    valid, errors = @service.validate_hash_response(response)
+    valid.should be_false
+    errors.should_not be_empty
+  end
+
+  it "should detect that a property type is wrong" do
+     response = valid_response
+     response["user"]["id"] = 'test'
+     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 nested object is missing" do
+     response = valid_response
+     response["user"].delete("creds")
+     valid, errors = @service.validate_hash_response(response)
+     valid.should be_false
+     errors.should_not be_empty
+     errors.first.should match(/creds/)
+     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
+    errors.should be_empty
+  end
+
+
+end

data/wsdsl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wsdsl}
-  s.version = "0.3.3"
+  s.version = "0.4.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-12}
+  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.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "lib/framework_ext/sinatra.rb",
     "lib/framework_ext/sinatra_controller.rb",
     "lib/inflection.rb",
+    "lib/json_response_verification.rb",
     "lib/params.rb",
     "lib/params_verification.rb",
     "lib/response.rb",
@@ -33,6 +34,7 @@ Gem::Specification.new do |s|
     "spec/hello_world_controller.rb",
     "spec/hello_world_service.rb",
     "spec/json_response_description_spec.rb",
+    "spec/json_response_verification_spec.rb",
     "spec/params_verification_spec.rb",
     "spec/preferences_service.rb",
     "spec/spec_helper.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wsdsl
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-12 00:00:00.000000000Z
+date: 2011-09-23 00:00:00.000000000Z
 dependencies: []
 description: A Ruby DSL describing Web Services without implementation details.
 email: mattaimonetti@gmail.com
@@ -27,6 +27,7 @@ files:
 - lib/framework_ext/sinatra.rb
 - lib/framework_ext/sinatra_controller.rb
 - lib/inflection.rb
+- lib/json_response_verification.rb
 - lib/params.rb
 - lib/params_verification.rb
 - lib/response.rb
@@ -35,6 +36,7 @@ files:
 - spec/hello_world_controller.rb
 - spec/hello_world_service.rb
 - spec/json_response_description_spec.rb
+- spec/json_response_verification_spec.rb
 - spec/params_verification_spec.rb
 - spec/preferences_service.rb
 - spec/spec_helper.rb