playerconnect-wsdsl 0.3.4 → 0.3.5

data/.rvmrc_example

@@ -1,15 +1,9 @@
 gemset_name=wsdsl
 ruby_version=1.9.2-p290
-rubygems_version=1.8.5
-# specify multiple gems with spaces ex: ('foo 1.2.3' 'bar 5.6.7')
-gems=('jeweler 1.6.4' 'rspec 2.6.0' 'yard 0.7.2' 'rack-test 0.5.7' 'sinatra 1.2.0')
-
-export GIT_SSL_NO_VERIFY=true
+rubygems_version=1.8.10
+bundler_version=1.0.21
 
 rvm use $ruby_version@$gemset_name --create --install
 [ $(gem -v) = $rubygems_version ] || rvm rubygems $rubygems_version
-for g in "${gems[@]}"; do
-  read n v <<< $(echo $g | awk '{print $1 " " $2}')
-  gem list ${n} -v${v} -i >> /dev/null
-  [ $? -eq 0 ] || gem install ${n} -v${v} --no-ri --no-rdoc
-done
+gem list bundler -v${bundler_version} -i >/dev/null
+[ $? -eq 0 ] || gem install bundler -v${bundler_version} --no-ri --no-rdoc

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'jeweler', '1.6.4'
+gem 'rspec', '2.7.0'
+gem 'yard', '0.7.2'
+gem 'rack-test', '0.5.7'
+gem 'sinatra', '1.2.0'

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.3.5)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    sinatra (1.2.0)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    tilt (1.3.3)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (= 1.6.4)
+  rack-test (= 0.5.7)
+  rspec (= 2.7.0)
+  sinatra (= 1.2.0)
+  yard (= 0.7.2)

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.4"
+  gem.version = File.read('VERSION').chomp
   # 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.4
+0.3.5

data/lib/params.rb

@@ -24,6 +24,8 @@ class WSDSL
       # @option options [Symbol] :default The default value of the param.
       # @option options [Symbol] :minvalue The minimum acceptable value.
       # @option options [Symbol] :maxvalue The maximim acceptable value.
+      # @option options [Symbol] :minlength The minimum acceptable string length.
+      # @option options [Symbol] :maxlength The maximum acceptable string length.
       # @api public
       attr_reader :options
 
@@ -36,6 +38,8 @@ class WSDSL
       # @option opts [Symbol] :default The default value of the param.
       # @option opts [Symbol] :minvalue The minimum acceptable value.
       # @option opts [Symbol] :maxvalue The maximim acceptable value.
+      # @option opts [Symbol] :minlength The minimum acceptable string length.
+      # @option opts [Symbol] :maxlength The maximum acceptable string length.
       # @api public
       def initialize(name, opts = {})
         @name    = name

data/lib/params_verification.rb

@@ -128,14 +128,7 @@ 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]
-    #end
 
     # Checks presence
     if !(namespaced_params || params).keys.include?(param_name)
@@ -147,44 +140,10 @@ module ParamsVerification
       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]
+    # run the common set of rules used for any non nil value
+    params = self.run_when_not_nil(rule, params, namespace)
 
-      if rule.options[:type]
-        # Force the cast so we can compare properly
-        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
-
-      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]}"
-      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
 
@@ -213,49 +172,101 @@ module ParamsVerification
     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
+
+  # Validate non nil values. They may have been optional if left blank, but
+  # when they are nil they are validated.
+  #
+  #
+  # @param [WSDSL::Params::Rule] rule The required rule to check against.
+  # @param [Hash] params The request params.
+  # @param [String] namespace Optional param namespace to check the rule against.
+  #
+  # @return [Hash]
+  #   A hash representing the potentially modified params after going through the filter.
   #
   # @api private
-  def self.run_optional_rule(rule, params, namespace=nil)
+  def self.run_when_not_nil(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)
 
-    if param_value.nil? && rule.options[:default]
+    # checks type
+    if rule.options[:type]
+      verify_cast(param_name, param_value, rule.options[:type])
+      param_value = type_cast_value(rule.options[:type], param_value)
+      # update the params hash with the type cast value
       if namespace
         params[namespace] ||= {}
-        params[namespace][param_name] = param_value = rule.options[:default]
+        params[namespace][param_name] = param_value
       else
-        params[param_name] = param_value = rule.options[:default]
+        params[param_name] = param_value
       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?
+    # checks the value against a whitelist style 'in'/'options' list
+    if rule.options[:options] || rule.options[:in]
+      choices = rule.options[:options] || rule.options[:in]
+      validate_inclusion_of(param_name, param_value, choices)
+    end
+
+    # enforce a minimum numeric value
+    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
+
+    # enforce a maximum numeric value
+    if rule.options[:maxvalue]
+      max = rule.options[:maxvalue]
+      raise InvalidParamValue, "Value for parameter '#{param_name}' is higher than the max accepted value (#{max})." if param_value.to_i > max
+    end
+
+    # enforce a minimum string length
+    if rule.options[:minlength]
+      min = rule.options[:minlength]
+      raise InvalidParamValue, "Length of parameter '#{param_name}' is shorter than the min accepted value (#{min})." if param_value.to_s.length < min
+    end
+    
+    # enforce a maximum string length
+    if rule.options[:maxlength]
+      max = rule.options[:maxlength]
+      raise InvalidParamValue, "Length of parameter '#{param_name}' is longer than the max accepted value (#{max})." if param_value.to_s.length > max
+    end
+
+    # Return the modified params
+    params
+  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
+    namespace = namespace.to_sym if namespace
+    param_value, namespaced_params = extract_param_values(params, param_name, namespace)
+
+    # Use a default value if one is available and the submitted param value is nil
+    if param_value.nil? && rule.options[:default]
+      param_value = rule.options[:default]
       if namespace
         params[namespace] ||= {}
-        params[namespace][param_name] = param_value = type_cast_value(rule.options[:type], param_value)
+        params[namespace][param_name] = param_value
       else
-        params[param_name] = param_value = type_cast_value(rule.options[:type], param_value)
+        params[param_name] = param_value
       end
     end
 
-    choices = rule.options[:options] || rule.options[:in]
-
-    validate_inclusion_of(param_name, param_value, choices)
-
-    if rule.options[:minvalue] && param_value
-      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
+    # run the common set of rules used for any non nil value
+    params = self.run_when_not_nil(rule, params, namespace) if param_value
 
     params
   end
 
+
   def self.unexpected_params?(params, param_names)
     # Raise an exception unless no unexpected params were found
     unexpected_keys = (params.keys - param_names)

data/playerconnect-wsdsl.gemspec

@@ -4,20 +4,22 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{playerconnect-wsdsl}
-  s.version = "0.3.4"
+  s.name = "playerconnect-wsdsl"
+  s.version = "0.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  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.authors = ["Team SDOD"]
+  s.date = "2011-11-03"
+  s.description = "A Ruby DSL describing Web Services without implementation details."
+  s.email = "sdod"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"
   ]
   s.files = [
     ".rvmrc_example",
+    "Gemfile",
+    "Gemfile.lock",
     "LICENSE",
     "README.md",
     "Rakefile",
@@ -42,19 +44,34 @@ Gem::Specification.new do |s|
     "spec/wsdsl_spec.rb",
     "wsdsl.gemspec"
   ]
-  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}
+  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"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jeweler>, ["= 1.6.4"])
+      s.add_runtime_dependency(%q<rspec>, ["= 2.7.0"])
+      s.add_runtime_dependency(%q<yard>, ["= 0.7.2"])
+      s.add_runtime_dependency(%q<rack-test>, ["= 0.5.7"])
+      s.add_runtime_dependency(%q<sinatra>, ["= 1.2.0"])
     else
+      s.add_dependency(%q<jeweler>, ["= 1.6.4"])
+      s.add_dependency(%q<rspec>, ["= 2.7.0"])
+      s.add_dependency(%q<yard>, ["= 0.7.2"])
+      s.add_dependency(%q<rack-test>, ["= 0.5.7"])
+      s.add_dependency(%q<sinatra>, ["= 1.2.0"])
     end
   else
+    s.add_dependency(%q<jeweler>, ["= 1.6.4"])
+    s.add_dependency(%q<rspec>, ["= 2.7.0"])
+    s.add_dependency(%q<yard>, ["= 0.7.2"])
+    s.add_dependency(%q<rack-test>, ["= 0.5.7"])
+    s.add_dependency(%q<sinatra>, ["= 1.2.0"])
   end
 end
 

data/spec/params_verification_spec.rb

@@ -26,8 +26,8 @@ describe ParamsVerification do
   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(",")
+    returned_params[:user][:groups].should be == @valid_params['user']['groups'].split(",")
+    returned_params[:user][:skills].should be == @valid_params['user']['skills'].split(",")
   end
 
   it "should not duplicate params in the root level" do
@@ -76,7 +76,7 @@ describe ParamsVerification do
     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}
+    validated[:seq].should be == %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
@@ -97,6 +97,24 @@ describe ParamsVerification do
     lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamValue)
   end
 
+  it "should raise an exception when a param is over the maxvalue" do
+    params = @valid_params.dup
+    params['num'] = 10_000
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamValue)
+  end
+
+  it "should raise an exception when a param is under the minlength" do
+    params = @valid_params.dup
+    params['name'] ='bob'
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamValue)
+  end
+
+  it "should raise an exception when a param is over the maxlength" do
+    params = @valid_params.dup
+    params['name'] ='AreTheseGardensMyMother?AmIPartOfYouBoth?'
+    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'

data/spec/test_services.rb

@@ -10,7 +10,8 @@ describe_service "services/test.xml" do |service|
     p.datetime :timestamp, :default => Time.now
     p.string   :alpha,     :in      => ['a', 'b', 'c']
     p.string   :version,   :null    => false
-    p.integer  :num,      :minvalue => 42
+    p.integer  :num,      :minvalue => 42, :maxvalue => 1000
+    p.string   :name,  :minlength => 5, :maxlength => 25
 
   end
 

data/spec/wsdsl_spec.rb

@@ -135,7 +135,7 @@ describe WSDSL do
       describe_service("projects.xml") { |s| }
       service = WSList.all.find{|s| s.url == "projects.xml"}
       service.controller_dispatch("application").
-        should == ["application", "projects"]
+        should be == ["application", "projects"]
     end
 
     it "should be able to dispatch namespaced controller" do
@@ -150,10 +150,10 @@ describe WSDSL do
       end
 
       service = WSList.all.find{|s| s.url == "project/:project_id/tasks.xml"}
-      service.controller_dispatch("application").should == ["application", "project"]
+      service.controller_dispatch("application").should be == ["application", "project"]
 
       service = WSList.all.find{|s| s.url == "project/:project_id/task/:task_id/items.xml"}
-      service.controller_dispatch("application").should == ["application", "project"]
+      service.controller_dispatch("application").should be == ["application", "project"]
     end
 
     it "should raise exception when controller class is not found" do
@@ -188,7 +188,7 @@ describe WSDSL do
 
     it "should have a list of optional param rules" do
       @sparams.list_optional.should be_an_instance_of(Array)
-      @sparams.list_optional.length.should be == 4
+      @sparams.list_optional.length.should be == 5
     end
     
     it "should have a list of namespaced param rules" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playerconnect-wsdsl
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,63 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-02 00:00:00.000000000Z
-dependencies: []
+date: 2011-11-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2161773700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161773700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2161773220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161773220
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2161772740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161772740
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2161772260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161772260
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &2161771760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161771760
 description: A Ruby DSL describing Web Services without implementation details.
 email: sdod
 executables: []
@@ -20,6 +75,8 @@ extra_rdoc_files:
 - README.md
 files:
 - .rvmrc_example
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -64,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Web Service DSL