playerconnect-wsdsl 0.3.3 → 0.3.4

data/Rakefile

@@ -11,7 +11,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{A Ruby DSL describing Web Services without implementation details.}
   gem.email = "sdod"
   gem.authors = ["Team SDOD"]
-  gem.version = "0.3.3"
+  gem.version = "0.3.4"
   # Include your dependencies below. Runtime dependencies are required when using your gem,
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
   #  gem.add_runtime_dependency 'jabber4r', '> 0.1'

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/lib/params_verification.rb

@@ -5,14 +5,14 @@
 #
 # @api public
 module ParamsVerification
-  
+
   class ParamError        < StandardError; end #:nodoc
   class NoParamsDefined   < ParamError; end #:nodoc
   class MissingParam      < ParamError; end #:nodoc
   class UnexpectedParam   < ParamError; end #:nodoc
   class InvalidParamType  < ParamError; end #:nodoc
   class InvalidParamValue < ParamError; end #:nodoc
-  
+
   # An array of validation regular expressions.
   # The array gets cached but can be accessed via the symbol key.
   #
@@ -27,12 +27,12 @@ module ParamsVerification
                             #:array    => /,/
                           }
   end
-  
+
   # Validation against each required WSDSL::Params::Rule
   # and returns the potentially modified params (with default values)
-  # 
+  #
   # @param [Hash] params The params to verify (incoming request params)
-  # @param [WSDSL::Params] service_params A Playco service param compatible object listing required and optional params 
+  # @param [WSDSL::Params] service_params A Playco service param compatible object listing required and optional params
   # @param [Boolean] ignore_unexpected Flag letting the validation know if unexpected params should be ignored
   #
   # @return [Hash]
@@ -40,10 +40,10 @@ module ParamsVerification
   #
   # @example Validate request params against a service's defined param rules
   #   ParamsVerification.validate!(request.params, @service.defined_params)
-  # 
+  #
   # @api public
   def self.validate!(params, service_params, ignore_unexpected=false)
-    
+
     # Verify that no garbage params are passed, if they are, an exception is raised.
     # only the first level is checked at this point
     unless ignore_unexpected
@@ -53,17 +53,17 @@ module ParamsVerification
     # Create a duplicate of the params hash that uses symbols as keys,
     # while preserving the original hash
     updated_params = symbolify_keys(params)
-    
+
     # Required param verification
     service_params.list_required.each do |rule|
       updated_params = validate_required_rule(rule, updated_params)
     end
-    
+
     # Set optional defaults if any optional
     service_params.list_optional.each do |rule|
       updated_params = run_optional_rule(rule, updated_params)
     end
-    
+
     # check the namespaced params
     service_params.namespaced_params.each do |param|
       param.list_required.each do |rule|
@@ -74,10 +74,10 @@ module ParamsVerification
       end
 
     end
-    
+
     # verify nested params, only 1 level deep tho
     params.each_pair do |key, value|
-      # We are now assuming a file param is a hash due to Rack::Mulitpart.parse_multipart 
+      # We are now assuming a file param is a hash due to Rack::Mulitpart.parse_multipart
       # turns this data into a hash, but param verification/DSL dont expect this or define this behavior and it shouldn't.
       # so special case it if its a file type and the value is a hash.
       if value.is_a?(Hash) && type_for_param(service_params, key) != :file
@@ -128,10 +128,10 @@ module ParamsVerification
   def self.validate_required_rule(rule, params, namespace=nil)
     param_name  = rule.name.to_sym
     namespace = namespace.to_sym if namespace
-    
+
     param_value, namespaced_params = extract_param_values(params, param_name, namespace)
     # puts "verify #{param_name} params, current value: #{param_value}"
-    
+
     #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]
@@ -141,36 +141,49 @@ module ParamsVerification
     if !(namespaced_params || params).keys.include?(param_name)
       raise MissingParam, "'#{rule.name}' is missing - passed params: #{params.inspect}."
     end
-    
+
     # checks null
     if param_value.nil? && !rule.options[:null]
       raise  InvalidParamValue, "Value for parameter '#{param_name}' is missing - passed params: #{params.inspect}."
     end
-    
+
     # checks type
     if 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]
         # Force the cast so we can compare properly
-        param_value = params[param_name] = type_cast_value(rule.options[:type], param_value)
+        param_value = type_cast_value(rule.options[:type], param_value)
+        if namespace
+          params[namespace][param_name] = param_value
+        else
+          params[param_name] = param_value
+        end
       end
-      raise InvalidParamValue, "Value for parameter '#{param_name}' (#{param_value}) is not in the allowed set of values." unless choices.include?(param_value)
+
+      validate_inclusion_of(param_name, param_value, choices)
+
     end
-    
+
     if 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
     end
     # Returns the updated params
-    
+
     # 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] && !(rule.options[:options] || rule.options[:in])
       # puts "casting #{param_value} into type: #{rule.options[:type]}"
-      params[param_name] = type_cast_value(rule.options[:type], param_value)
+      param_value = type_cast_value(rule.options[:type], param_value)
+      if namespace
+        params[namespace][param_name] = param_value
+      else
+        params[param_name] = param_value
+      end
     end
     params
   end
@@ -199,12 +212,12 @@ module ParamsVerification
       end
     end
   end
-  
+
   # @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_sym
@@ -220,7 +233,7 @@ module ParamsVerification
         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?
       if namespace
@@ -232,9 +245,8 @@ module ParamsVerification
     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
+
+    validate_inclusion_of(param_name, param_value, choices)
 
     if rule.options[:minvalue] && param_value
       min = rule.options[:minvalue]
@@ -243,7 +255,7 @@ module ParamsVerification
 
     params
   end
-  
+
   def self.unexpected_params?(params, param_names)
     # Raise an exception unless no unexpected params were found
     unexpected_keys = (params.keys - param_names)
@@ -251,8 +263,8 @@ module ParamsVerification
       raise UnexpectedParam, "Request included unexpected parameter(s): #{unexpected_keys.join(', ')}"
     end
   end
-  
-  
+
+
   def self.type_cast_value(type, value)
     case type
     when :integer
@@ -304,7 +316,7 @@ module ParamsVerification
       raise InvalidParamType, "Value for parameter '#{name}' (#{value}) is of the wrong type (expected #{expected_type})"
     end
   end
-  
+
   def self.type_for_param(service_params, name)
     (service_params.list_required + service_params.list_optional).each do |rule|
       if rule.name.to_s == name.to_s
@@ -312,5 +324,13 @@ module ParamsVerification
       end
     end
   end
-  
+
+  def self.validate_inclusion_of(name, value, choices)
+    return unless choices && value
+    valid = value.is_a?(Array) ? (value & choices == value) : choices.include?(value)
+    unless valid
+      raise InvalidParamValue, "Value for parameter '#{name}' (#{value}) is not in the allowed set of values."
+    end
+  end
+
 end

data/playerconnect-wsdsl.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "playerconnect-wsdsl"
-  s.version = "0.3.3"
+  s.name = %q{playerconnect-wsdsl}
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Team SDOD"]
-  s.date = "2011-10-28"
-  s.description = "A Ruby DSL describing Web Services without implementation details."
-  s.email = "sdod"
+  s.authors = [%q{Team SDOD}]
+  s.date = %q{2011-11-02}
+  s.description = %q{A Ruby DSL describing Web Services without implementation details.}
+  s.email = %q{sdod}
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"
@@ -42,11 +42,11 @@ Gem::Specification.new do |s|
     "spec/wsdsl_spec.rb",
     "wsdsl.gemspec"
   ]
-  s.homepage = "http://github.com/playerconnect/wsdsl"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
-  s.summary = "Web Service DSL"
+  s.homepage = %q{http://github.com/playerconnect/wsdsl}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Web Service DSL}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/spec/params_verification_spec.rb

@@ -1,39 +1,70 @@
 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
-  
+
+  before do
+    @valid_params = {'framework' => 'RSpec', 'version' => '1.02', 'user' => {'id' => '123', 'groups' => 'manager,developer', 'skills' => 'java,ruby'}}
+  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 return array in the params" do
+    params = @valid_params
+    returned_params = ParamsVerification.validate!(params, @service.defined_params)
+    returned_params[:user][:groups].should == @valid_params['user']['groups'].split(",")
+    returned_params[:user][:skills].should == @valid_params['user']['skills'].split(",")
+  end
+
+  it "should not duplicate params in the root level" do
+    params = @valid_params
+    returned_params = ParamsVerification.validate!(params, @service.defined_params)
+    returned_params[:groups].should be_nil
+    returned_params[:skills].should be_nil
+  end
+
+  it "should raise exception when values of required param are not in the allowed list" do
+    params = @valid_params
+    params['user']['groups'] = 'admin,root,manager'
+    lambda { ParamsVerification.validate!(params, @service.defined_params) }.
+      should raise_error(ParamsVerification::InvalidParamValue)
+  end
+
+  it "should raise exception when values of opitonal param are not in the allowed list" do
+    params = @valid_params
+    params['user']['skills'] = 'ruby,java,php'
+    lambda { ParamsVerification.validate!(params, @service.defined_params) }.
+      should raise_error(ParamsVerification::InvalidParamValue)
+  end
+
   it "should set the default value for an optional param" do
-    params = @valid_params.dup
+    params = @valid_params
     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 = {'framework' => 'RSpec', 'version' => '1.02', 'user' => {'id' => '123', 'groups' => 'admin'}}
     params[:user].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')
@@ -53,19 +84,19 @@ describe ParamsVerification do
     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::InvalidParamValue)
   end
-  
+
   it "should raise an exception when a param isn't in the param option list" do
     params = @valid_params.dup
     params['alpha'] = 'z'
@@ -75,19 +106,19 @@ describe ParamsVerification do
   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)
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamValue)
     # 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
     params = @valid_params.dup
     lambda{ ParamsVerification.validate!(params, service.defined_params) }.should raise_exception
   end
-  
+
 end

data/spec/test_services.rb

@@ -3,35 +3,37 @@ WSDSLSpecOptions = ['RSpec', 'Bacon'] # usually pulled from a model
 describe_service "services/test.xml" do |service|
   service.formats  :xml, :json
   service.http_verb :get
-  
+
   service.params do |p|
     p.string :framework, :in => WSDSLSpecOptions, :null => false, :required => true
-   
+
     p.datetime :timestamp, :default => Time.now
     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'
-  # # if the optional flag isn't passed, the param is considered required. 
+  # # if the optional flag isn't passed, the param is considered required.
   # service.param :epsilon, :type => 'string'
-  
+
   service.params.namespace :user do |user|
     user.integer :id, :required => :true
     user.string :sex, :in => %Q{female, male}
     user.boolean :mailing_list, :default => true
+    user.array :groups, :required => true, :in => %w{developer admin manager}
+    user.array :skills, :in => %w{ruby java networking}
   end
-  
-  # the response contains a list of player creation ratings each object in the list 
-  
+
+  # 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"
       e.attribute  :is_accepted => :boolean, :doc => "is accepted doc"
       e.attribute  :name        => :string,  :doc => "name doc"
-      
+
       e.array :name => 'player_creation_rating', :type => 'PlayerCreationRating' do |a|
         a.attribute :comments  => :string,  :doc => "comments doc"
         a.attribute :player_id => :integer, :doc => "player_id doc"
@@ -40,17 +42,17 @@ describe_service "services/test.xml" do |service|
       end
     end
   end
-  
+
   service.documentation do |doc|
     # doc.overall <markdown description text>
     doc.overall <<-DOC
      This is a test service used to test the framework.
     DOC
-    
+
     # doc.params <name>, <definition>
     doc.param :framework, "The test framework used, could be one of the two following: #{WSDSLSpecOptions.join(", ")}."
     doc.param :version, "The version of the framework to use."
-    
+
     # doc.example <markdown text>
     doc.example <<-DOC
 The most common way to use this service looks like that:
@@ -69,7 +71,7 @@ end
 describe_service "services.xml" do |service|
   service.formats  :xml
   service.http_verb :put
-  
+
 end
 
 describe_service "services/array_param.xml" do |s|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playerconnect-wsdsl
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-28 00:00:00.000000000Z
+date: 2011-11-02 00:00:00.000000000Z
 dependencies: []
 description: A Ruby DSL describing Web Services without implementation details.
 email: sdod
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Web Service DSL