weasel_diesel 1.0.0

data/spec/hello_world_controller.rb

@@ -0,0 +1,5 @@
+class HelloWorldController < SinatraServiceController
+  def list
+    "Hello #{params[:name]}"
+  end
+end

data/spec/hello_world_service.rb

@@ -0,0 +1,20 @@
+describe_service "hello_world.xml" 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://ps3.yourgame.com/hello_world.xml?name=Matt</code>"
+ end
+
+end

data/spec/json_response_description_spec.rb

@@ -0,0 +1,124 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe "WeaselDiesel JSON response description" do
+
+# JSON response example
+=begin
+  { vouchers: [ 
+  { 
+    id : 1, 
+    redeemed : false,
+    created_at : 123123123123, 
+    option: {
+      id : 1231,
+      price: 123.32
+    }
+  }, 
+  { 
+    id : 2, 
+    redeemed : true,
+    created_at : 123123123123, 
+    option: {
+      id : 1233,
+      price: 1.32
+    }
+  }, 
+] }
+=end
+
+  before :all do
+    @timestamp = Time.now.to_i
+    @service =  describe_service "json_list" do |service|
+      service.formats  :json
+      service.response do |response|
+        response.array :vouchers do |node|
+          node.key :id
+          node.type :Voucher
+          node.string :name, :mock => "test"
+          node.integer :id, :doc => "Identifier"
+          node.boolean :redeemed
+          node.datetime :created_at, :mock => @timestamp
+          node.object :option do |option|
+            option.integer :id
+            option.integer :deal_id, :mock => 1
+            option.float :price
+          end
+        end
+      end
+    end
+    @response  = @service.response
+    @root_node = @response.nodes.find{|n| n.name == :vouchers}
+
+  end
+
+  it "should handle the json root node" do
+    @root_node.should_not be_nil
+  end
+
+  it "should handle a node property list" do
+    props = @root_node.properties
+    props.should_not be_empty
+    {:id => :integer, :redeemed => :boolean, :created_at => :datetime}.each do |key, type|
+      prop = props.find{|prop| prop.name == key}
+      prop.should_not be_nil
+      prop.type.should == type
+    end
+  end
+
+  it "should handle a nested object with properties" do
+    @root_node.objects.should_not be_nil
+    option = @root_node.objects.find{|o| o.name == :option}
+    option.should_not be_nil
+    {:id => :integer, :deal_id => :integer, :price => :float}.each do |key, type|
+      prop = option.properties.find{|prop| prop.name == key}
+      if prop.nil?
+        puts option.properties.inspect
+        puts [key, type].inspect
+      end
+      prop.should_not be_nil
+      prop.type.should == type
+    end
+  end
+
+  it "should allow some meta attributes" do
+    atts = @root_node.meta_attributes
+    atts.should_not be_nil
+    {:key => :id, :type => :Voucher}.each do |type, value|
+      meta = atts.find{|att| att.type == type}
+      puts [type, atts].inspect if meta.nil?
+      meta.should_not be_nil
+      meta.value.should == value
+    end
+    @root_node.key.should == :id
+    @root_node.type.should == :Voucher
+  end
+
+  it "should handle mocked values properly" do
+    created_at = @root_node.properties.find{|prop| prop.name == :created_at}
+    created_at.opts[:mock].should == @timestamp
+    option = @root_node.objects.find{|prop| prop.name == :option}
+    deal_id = option.properties.find{|prop| prop.name == :deal_id}
+    deal_id.opts[:mock].should == 1
+    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,225 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+require File.expand_path("../lib/json_response_verification", File.dirname(__FILE__))
+
+WeaselDiesel.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, :null => true
+          user.datetime :created_at
+          user.object :creds do |creds|
+            creds.integer :id
+            creds.float   :price
+            creds.boolean :enabled
+          end
+        end
+      end
+    end
+
+    @third_service = describe_service "with_array" do |service|
+      service.response do |response|
+        response.array :users do |node|
+          node.integer :id
+          node.string  :name
+          node.boolean :admin, :doc => "true if the user is an admin"
+          node.string  :state, :doc => "test", :null => true
+          node.datetime :last_login_at
+        end
+      end
+    end
+
+    @forth_service = describe_service "with_nested_array" do |service|
+      service.response do |response|
+        response.array :users do |node|
+          node.integer :id
+          node.string  :name
+          node.boolean :admin, :doc => "true if the user is an admin"
+          node.string  :state, :doc => "test"
+          node.array :pets do |pet|
+            pet.integer :id
+            pet.string :name
+          end
+        end
+      end
+    end
+
+    @optional_prop_service = describe_service "opt_prop_service" do |service|
+      service.response do |response|
+        response.object do |obj|
+          obj.string  :email,     :null => true
+          obj.integer :city_id,   :null => true
+          obj.string  :full_name, :null => true
+        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
+
+  def valid_array_response
+    {"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"
+      }]
+    }
+  end
+
+  def valid_nested_array_response
+    {"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"}]
+      }]
+    }
+  end
+
+
+  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
+
+  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 integer 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 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
+    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")
+    valid, errors = @service.validate_hash_response(response)
+    valid.should be_false
+    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
+  end
+
+  it "should validate nil attributes if marked as nullable" do
+    response = valid_response(false)
+    response["name"] = nil
+    valid, errors = @second_service.validate_hash_response(response)
+    valid.should be_true
+  end
+
+
+  it "should validate array items" do
+    valid, errors = @third_service.validate_hash_response(valid_array_response)
+    valid.should be_true
+    errors.should be_empty
+  end
+
+  it "should validate an empty array" do
+    response = valid_array_response
+    response["users"] = []
+    valid, errors = @third_service.validate_hash_response(response)
+    valid.should be_true
+  end
+
+  it "should catch error in an array item" do
+    response = valid_array_response
+    response["users"][1]["id"] = 'test'
+    valid, errors = @third_service.validate_hash_response(response)
+    valid.should be_false
+    errors.should_not be_empty
+  end
+
+  it "should validate nested arrays" do
+    valid, errors = @forth_service.validate_hash_response(valid_nested_array_response)
+    valid.should be_true
+  end
+
+
+  it "should respect optional properties" do
+    valid, errors = @optional_prop_service.validate_hash_response({})
+    valid.should be_true
+  end
+
+
+end

data/spec/params_verification_spec.rb

@@ -0,0 +1,102 @@
+require_relative "spec_helper"
+
+describe ParamsVerification do
+  
+  before :all do
+    @service = WSList.all.find{|s| s.url == 'services/test.xml'}
+    @service.should_not be_nil
+    @valid_params = {'framework' => 'RSpec', 'version' => '1.02', 'user' => {'id' => '123'}}
+  end
+  
+  it "should validate valid params" do
+    params = @valid_params.dup
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should_not raise_exception
+  end
+  
+  it "should return the params" do
+    params = @valid_params.dup
+    returned_params = ParamsVerification.validate!(params, @service.defined_params)
+    returned_params.should be_an_instance_of(Hash)
+    returned_params.keys.size.should >= 3
+  end
+  
+  it "should set the default value for an optional param" do
+    params = @valid_params.dup
+    params['timestamp'].should be_nil
+    returned_params = ParamsVerification.validate!(params, @service.defined_params)
+    returned_params['timestamp'].should_not be_nil
+  end
+
+  it "should set the default value for a namespace optional param" do
+    params = {'framework' => 'RSpec', 'version' => '1.02', 'user' => {'id' => '123'}}
+    params['user']['mailing_list'].should be_nil
+    returned_params = ParamsVerification.validate!(params, @service.defined_params)
+    returned_params['user']['mailing_list'].should be_true
+  end
+  
+  it "should raise an exception when a required param is missing" do
+    params = @valid_params.dup
+    params.delete('framework')
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::MissingParam)
+  end
+
+  it "should cast a comma delimited string into an array when param marked as an array" do
+    service = WSList.all.find{|s| s.url == "services/array_param.xml"}
+    service.should_not be_nil
+    params = {'seq' => "a,b,c,d,e,g"}
+    validated = ParamsVerification.validate!(params, service.defined_params)
+    validated['seq'].should == %W{a b c d e g}
+  end
+
+  it "should not raise an exception if a req array param doesn't contain a comma" do
+    service = WSList.all.find{|s| s.url == "services/array_param.xml"}
+    params = {'seq' => "a b c d e g"}
+    lambda{ ParamsVerification.validate!(params, service.defined_params) }.should_not raise_exception(ParamsVerification::InvalidParamType)
+  end
+  
+  it "should raise an exception when a param is of the wrong type" do
+    params = @valid_params.dup
+    params['user']['id'] = 'abc'
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamType)
+  end
+  
+  it "should raise an exception when a param is under the minvalue" do
+    params = @valid_params.dup
+    params['num'] = 1
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamType)
+  end
+  
+  it "should raise an exception when a param isn't in the param option list" do
+    params = @valid_params.dup
+    params['alpha'] = 'z'
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamValue)
+  end
+
+  it "should raise an exception when a nested optional param isn't in the param option list" do
+    params = @valid_params.dup
+    params['user']['sex'] = 'large'
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamType)
+    # other service
+    params = {'preference' => {'region_code' => 'us', 'language_code' => 'de'}}
+    service = WSList.all.find{|s| s.url == 'preferences.xml'}
+    service.should_not be_nil
+    lambda{ ParamsVerification.validate!(params, service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamValue)
+  end
+
+  it "should raise an exception when a required param is present but doesn't match the limited set of options" do
+    service = describe_service "search" do |service|
+      service.params { |p| p.string :by, :options => ['name', 'code', 'last_four'], :required => true }
+    end
+    params = {'by' => 'foo'}
+    lambda{ ParamsVerification.validate!(params, service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamValue)
+  end
+
+  
+  it "should validate that no params are passed when accept_no_params! is set on a service" do
+    service = WSList.all.find{|s| s.url == "services/test_no_params.xml"}
+    service.should_not be_nil
+    params = @valid_params.dup
+    lambda{ ParamsVerification.validate!(params, service.defined_params) }.should raise_exception
+  end
+  
+end