wsdsl 0.1.3 → 0.1.4

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/params_verification.rb

@@ -66,7 +66,10 @@ module ParamsVerification
       param.list_required.each do |rule|
         updated_params = validate_required_rule(rule, updated_params, param.space_name.to_s)
       end
-      # TODO add verification for namespaced optional rules
+      param.list_optional.each do |rule|
+        updated_params = run_optional_rule(rule, updated_params, param.space_name.to_s)
+      end
+
     end
     
     # verify nested params, only 1 level deep tho
@@ -98,22 +101,16 @@ module ParamsVerification
   def self.validate_required_rule(rule, params, namespace=nil)
     param_name  = rule.name.to_s
     
-    # Namespace check
-    if namespace == '' || namespace.nil?
-      param_value = params[param_name]
-    else
-      # puts "namespace: #{namespace} - params #{params[namespace].inspect}"
-      namespaced_params = params[namespace]
-      param_value = namespaced_params ? namespaced_params[param_name] : nil
-    end
+    param_value, namespaced_params = extract_param_values(params, param_name, namespace)
     # puts "verify #{param_name} params, current value: #{param_value}"
     
-    # Checks default
-    if param_value.nil? && rule.options && rule.options[:default]
-      param_ref = namespace.nil? ? params[param_name] : params[namespace][param_name]
-      param_ref = rule.options[:default]
+    #This is disabled since required params shouldn't have a default, otherwise, why are they required?
+    #if param_value.nil? && rule.options && rule.options[:default]
+      #param_value = rule.options[:default]
+    #end
+
     # Checks presence
-    elsif !(namespaced_params || params).keys.include?(param_name)
+    if !(namespaced_params || params).keys.include?(param_name)
       raise MissingParam, "'#{rule.name}' is missing - passed params: #{params.inspect}."
     # checks null
     elsif param_value.nil? && !rule.options[:null]
@@ -139,26 +136,65 @@ module ParamsVerification
       # puts "casting #{param_value} into type: #{rule.options[:type]}"
       params[param_name] = type_cast_value(rule.options[:type], param_value)
     end
-    
     params
   end
+
+
+  # Extract the param valie and the namespaced params
+  # based on a passed namespace and params
+  #
+  # @param [Hash] params The passed params to extract info from.
+  # @param [String] param_name The param name to find the value.
+  # @param [NilClass, String] namespace the params' namespace.
+  # @return [Arrays<Object, String>]
+  #
+  # @api private
+  def self.extract_param_values(params, param_name, namespace=nil)
+    # Namespace check
+    if namespace == '' || namespace.nil?
+      [params[param_name], nil]
+    else
+      # puts "namespace: #{namespace} - params #{params[namespace].inspect}"
+      namespaced_params = params[namespace]
+      if namespaced_params
+        [namespaced_params[param_name], namespaced_params]
+      else
+        [nil, namespaced_params]
+      end
+    end
+  end
   
-  # @todo add support for namespaces
   # @param [#WSDSL::Params::Rule] rule The optional rule
   # @param [Hash] params The request params
   # @param [String] namespace An optional namespace
   # @return [Hash] The potentially modified params
+  # 
   # @api private
   def self.run_optional_rule(rule, params, namespace=nil)
     param_name  = rule.name.to_s
-    param_value = params[param_name]
+
+    param_value, namespaced_params = extract_param_values(params, param_name, namespace)
+
     if param_value.nil? && rule.options[:default]
-      params[param_name] = rule.options[:default]
+      if namespace
+        params[namespace][param_name] = param_value = rule.options[:default]
+      else
+        params[param_name] = param_value = rule.options[:default]
+      end
     end
     
     # cast the type if a type is defined and if a range of options isn't defined since the casting should have been done already
     if rule.options[:type] && !param_value.nil?
-      params[param_name] = type_cast_value(rule.options[:type], param_value)
+      if namespace
+        params[namespace][param_name] = param_value = type_cast_value(rule.options[:type], param_value)
+      else
+        params[param_name] = param_value = type_cast_value(rule.options[:type], param_value)
+      end
+    end
+
+    choices = rule.options[:options] || rule.options[:in]
+    if choices && param_value && !choices.include?(param_value)
+      raise InvalidParamValue, "Value for parameter '#{param_name}' (#{param_value}) is not in the allowed set of values."
     end
     
     params

data/spec/params_verification_spec.rb

@@ -2,10 +2,6 @@ require_relative "spec_helper"
 
 describe ParamsVerification do
   
-  def app
-    Sinatra::Application
-  end
-  
   before :all do
     @service = WSList.all.find{|s| s.url == 'services/test.xml'}
     @service.should_not be_nil
@@ -13,20 +9,30 @@ describe ParamsVerification do
   end
   
   it "should validate valid params" do
-    lambda{ ParamsVerification.validate!(@valid_params, @service.defined_params) }.should_not raise_exception
+    params = @valid_params.dup
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should_not raise_exception
   end
   
   it "should return the params" do
-    returned_params = ParamsVerification.validate!(@valid_params, @service.defined_params)
+    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 values" do
-    @valid_params['timestamp'].should be_nil
-    returned_params = ParamsVerification.validate!(@valid_params, @service.defined_params)
+  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
@@ -49,13 +55,25 @@ describe ParamsVerification do
   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 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
-    lambda{ ParamsVerification.validate!(@valid_params, service.defined_params) }.should raise_exception
+    params = @valid_params.dup
+    lambda{ ParamsVerification.validate!(params, service.defined_params) }.should raise_exception
   end
   
 end

data/spec/preferences_service.rb

@@ -0,0 +1,10 @@
+describe_service "preferences.xml" do |service|
+  
+  service.params do |p|
+    p.namespace :preference do |pr|
+      pr.string :language_code, :options => ['en', 'fr']
+      pr.string :region_code, :options => ['europe']
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'sinatra'
 
 require_relative "../lib/wsdsl"
 require_relative 'test_services'
+require_relative 'preferences_service'
 require_relative "../lib/framework_ext/sinatra_controller"
 
 ENV["RACK_ENV"] = 'test'
@@ -11,4 +12,3 @@ ENV["RACK_ENV"] = 'test'
 RSpec.configure do |conf|
   conf.include Rack::Test::Methods
 end
-

data/spec/test_services.rb

@@ -11,6 +11,7 @@ describe_service "services/test.xml" do |service|
     p.string   :alpha,     :in      => ['a', 'b', 'c']
     p.string   :version,   :null    => false
     p.integer  :num,      :minvalue => 42
+
   end
   
   # service.param :delta, :optional => true, :type => 'float'
@@ -19,6 +20,8 @@ describe_service "services/test.xml" do |service|
   
   service.params.namespace :user do |user|
     user.integer :id, :required => :true
+    user.string :sex, :in => %Q{female, male}
+    user.boolean :mailing_list, :default => true
   end
   
   # the response contains a list of player creation ratings each object in the list 

data/wsdsl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wsdsl}
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Aimonetti"]
-  s.date = %q{2011-03-14}
+  s.date = %q{2011-03-15}
   s.description = %q{A Ruby DSL describing Web Services without implementation details.}
   s.email = %q{mattaimonetti@gmail.com}
   s.extra_rdoc_files = [
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     "spec/hello_world_controller.rb",
     "spec/hello_world_service.rb",
     "spec/params_verification_spec.rb",
+    "spec/preferences_service.rb",
     "spec/spec_helper.rb",
     "spec/test_services.rb",
     "spec/wsdsl_sinatra_ext_spec.rb",
@@ -48,6 +49,7 @@ Gem::Specification.new do |s|
     "spec/hello_world_controller.rb",
     "spec/hello_world_service.rb",
     "spec/params_verification_spec.rb",
+    "spec/preferences_service.rb",
     "spec/spec_helper.rb",
     "spec/test_services.rb",
     "spec/wsdsl_sinatra_ext_spec.rb",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Matt Aimonetti
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-14 00:00:00 -07:00
+date: 2011-03-15 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -44,6 +44,7 @@ files:
 - spec/hello_world_controller.rb
 - spec/hello_world_service.rb
 - spec/params_verification_spec.rb
+- spec/preferences_service.rb
 - spec/spec_helper.rb
 - spec/test_services.rb
 - spec/wsdsl_sinatra_ext_spec.rb
@@ -85,6 +86,7 @@ test_files:
 - spec/hello_world_controller.rb
 - spec/hello_world_service.rb
 - spec/params_verification_spec.rb
+- spec/preferences_service.rb
 - spec/spec_helper.rb
 - spec/test_services.rb
 - spec/wsdsl_sinatra_ext_spec.rb