sinatra-param 1.3.1 → 1.4.0

data/lib/sinatra/param.rb

@@ -27,7 +27,8 @@ module Sinatra
           raise exception
         end
 
-        error = "Invalid Parameter: #{name}"
+        error = exception.to_s
+
         if content_type and content_type.match(mime_type(:json))
           error = {message: error, errors: {name => exception.message}}.to_json
         end
@@ -50,7 +51,30 @@ module Sinatra
           raise exception
         end
 
-        error = "Parameters #{names.join(', ')} are mutually exclusive"
+        error = "Invalid parameters [#{names.join(', ')}]"
+        if content_type and content_type.match(mime_type(:json))
+          error = {message: error, errors: {names => exception.message}}.to_json
+        end
+
+        halt 400, error
+      end
+    end
+
+    def any_of(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      names = args.collect(&:to_s)
+
+      return unless names.length >= 2
+
+      begin
+        validate_any_of!(params, names, options)
+      rescue InvalidParameterError => exception
+        if options[:raise] or (settings.raise_sinatra_param_exceptions rescue false)
+          exception.param, exception.options = names, options
+          raise exception
+        end
+
+        error = "Invalid parameters [#{names.join(', ')}]"
         if content_type and content_type.match(mime_type(:json))
           error = {message: error, errors: {names => exception.message}}.to_json
         end
@@ -87,13 +111,13 @@ module Sinatra
           raise InvalidParameterError, "Parameter is required" if value && param.nil?
         when :blank
           raise InvalidParameterError, "Parameter cannot be blank" if !value && case param
-              when String
-                !(/\S/ === param)
-              when Array, Hash
-                param.empty?
-              else
-                param.nil?
-            end
+          when String
+            !(/\S/ === param)
+          when Array, Hash
+            param.empty?
+          else
+            param.nil?
+          end
         when :format
           raise InvalidParameterError, "Parameter must be a string if using the format validation" unless param.kind_of?(String)
           raise InvalidParameterError, "Parameter must match format #{value}" unless param =~ value
@@ -101,11 +125,11 @@ module Sinatra
           raise InvalidParameterError, "Parameter must be #{value}" unless param === value
         when :in, :within, :range
           raise InvalidParameterError, "Parameter must be within #{value}" unless param.nil? || case value
-              when Range
-                value.include?(param)
-              else
-                Array(value).include?(param)
-              end
+          when Range
+            value.include?(param)
+          else
+            Array(value).include?(param)
+          end
         when :min
           raise InvalidParameterError, "Parameter cannot be less than #{value}" unless param.nil? || value <= param
         when :max
@@ -119,7 +143,11 @@ module Sinatra
     end
 
     def validate_one_of!(params, names, options)
-      raise InvalidParameterError, "Parameters #{names.join(', ')} are mutually exclusive" if names.count{|name| present?(params[name])} > 1
+      raise InvalidParameterError, "Only one of [#{names.join(', ')}] is allowed" if names.count{|name| present?(params[name])} > 1
+    end
+
+    def validate_any_of!(params, names, options)
+      raise InvalidParameterError, "One of parameters [#{names.join(', ')}] is required" if names.count{|name| present?(params[name])} < 1
     end
 
     # ActiveSupport #present? and #blank? without patching Object

data/lib/sinatra/param/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Param
-    VERSION = '1.3.1'
+    VERSION = '1.4.0'
   end
 end

data/spec/dummy/app.rb

@@ -185,7 +185,7 @@ class App < Sinatra::Base
     params.to_json
   end
 
-  get '/choice/1' do
+  get '/one_of/1' do
     param :a, String
     param :b, String
     param :c, String
@@ -197,7 +197,7 @@ class App < Sinatra::Base
     }.to_json
   end
 
-  get '/choice/2' do
+  get '/one_of/2' do
     param :a, String
     param :b, String
     param :c, String
@@ -209,7 +209,7 @@ class App < Sinatra::Base
     }.to_json
   end
 
-  get '/choice/3' do
+  get '/one_of/3' do
     param :a, String
     param :b, String
     param :c, String
@@ -221,12 +221,24 @@ class App < Sinatra::Base
     }.to_json
   end
 
+  get '/any_of' do
+    param :a, String
+    param :b, String
+    param :c, String
+
+    any_of :a, :b, :c
+
+    {
+      message: 'OK'
+    }.to_json
+  end
+
   get '/raise/validation/required' do
     param :arg, String, required: true, raise: true
     params.to_json
   end
 
-  get '/raise/choice/3' do
+  get '/raise/one_of/3' do
     param :a, String
     param :b, String
     param :c, String
@@ -237,4 +249,16 @@ class App < Sinatra::Base
       message: 'OK'
     }.to_json
   end
+
+  get '/raise/any_of' do
+    param :a, String
+    param :b, String
+    param :c, String
+
+    any_of :a, :b, :c, raise: true
+
+    {
+      message: 'OK'
+    }.to_json
+  end
 end

data/spec/parameter_exclusivity_spec.rb

@@ -10,9 +10,9 @@ describe 'Parameter Sets' do
       ]
 
       params.each do |param|
-        get('/choice/3', param) do |response|
+        get('/one_of/3', param) do |response|
           expect(response.status).to eql 400
-          expect(JSON.parse(response.body)['message']).to match(/mutually exclusive/)
+          expect(JSON.parse(response.body)['message']).to match(/^Invalid parameters/)
         end
       end
     end
@@ -20,9 +20,9 @@ describe 'Parameter Sets' do
     it 'returns 400 on requests that contain more than one mutually exclusive parameter' do
       params = {a: 1, b: 2}
 
-      get('/choice/2', params) do |response|
+      get('/one_of/2', params) do |response|
         expect(response.status).to eql 400
-        expect(JSON.parse(response.body)['message']).to match(/mutually exclusive/)
+        expect(JSON.parse(response.body)['message']).to match(/^Invalid parameters/)
       end
     end
 
@@ -35,7 +35,7 @@ describe 'Parameter Sets' do
 
       (1..3).each do |n|
         params.each do |param|
-          get("/choice/#{n}", param) do |response|
+          get("/one_of/#{n}", param) do |response|
             expect(response.status).to eql 200
             expect(JSON.parse(response.body)['message']).to match(/OK/)
           end
@@ -45,7 +45,7 @@ describe 'Parameter Sets' do
 
     it 'returns successfully for requests that have no parameter' do
       (1..3).each do |n|
-        get("/choice/#{n}") do |response|
+        get("/one_of/#{n}") do |response|
           expect(response.status).to eql 200
           expect(JSON.parse(response.body)['message']).to match(/OK/)
         end

data/spec/parameter_inclusivity_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Parameter Sets' do
+  describe 'any_of' do
+    it 'returns 400 on requests that contain fewer than one required parameter' do
+      get('/any_of', {}) do |response|
+        expect(response.status).to eql 400
+        expect(JSON.parse(response.body)['message']).to match(/Invalid parameters/)
+      end
+    end
+
+    it 'returns successfully for requests that have at least one parameter' do
+      params = [
+        {a: 1},
+        {b: 2},
+        {c: 3},
+        {a: 1, b: 2},
+        {b: 2, c: 3},
+        {a: 1, b: 2, c: 3}
+      ]
+
+      params.each do |param|
+        get("/any_of", param) do |response|
+          expect(response.status).to eql 200
+          expect(JSON.parse(response.body)['message']).to match(/OK/)
+        end
+      end
+    end
+  end
+end

data/spec/parameter_raise_spec.rb

@@ -12,7 +12,14 @@ describe 'Exception' do
   it 'should raise error when more than one parameter is specified' do
     params = {a: 1, b: 2, c: 3}
     expect {
-      get('/raise/choice/3', params)
+      get('/raise/one_of/3', params)
+    }.to raise_error
+  end
+
+  it 'should raise error when no parameters are specified' do
+    params = {}
+    expect {
+      get('/raise/any_of', params)
     }.to raise_error
   end
 end

data/spec/parameter_transformations_spec.rb

@@ -35,7 +35,7 @@ describe 'Parameter Transformations' do
     it 'skips transformations when the value is nil' do
       get('/transform/required') do |response|
         expect(response.status).to eql 400
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: order')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter is required")
       end
     end
   end

data/spec/parameter_type_coercion_spec.rb

@@ -21,7 +21,7 @@ describe 'Parameter Types' do
     it 'returns 400 on requests when integer is invalid' do
       get('/coerce/integer', arg: '123abc') do |response|
         expect(response.status).to eql 400
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("'123abc' is not a valid Integer")
       end
     end
   end
@@ -37,7 +37,7 @@ describe 'Parameter Types' do
     it 'returns 400 on requests when float is invalid' do
       get('/coerce/float', arg: '123abc') do |response|
         expect(response.status).to eql 400
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("'123abc' is not a valid Float")
       end
     end
   end
@@ -53,7 +53,7 @@ describe 'Parameter Types' do
     it 'returns 400 on requests when time is invalid' do
       get('/coerce/time', arg: '123abc') do |response|
         expect(response.status).to eql 400
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("'123abc' is not a valid Time")
       end
     end
   end
@@ -69,7 +69,7 @@ describe 'Parameter Types' do
     it 'returns 400 on requests when date is invalid' do
       get('/coerce/date', arg: 'abc') do |response|
         expect(response.status).to eql 400
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("'abc' is not a valid Date")
       end
     end
   end
@@ -85,7 +85,7 @@ describe 'Parameter Types' do
     it 'returns 400 on requests when datetime is invalid' do
       get('/coerce/datetime', arg: 'abc') do |response|
         expect(response.status).to eql 400
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("'abc' is not a valid DateTime")
       end
     end
   end

data/spec/parameter_validations_spec.rb

@@ -5,7 +5,7 @@ describe 'Parameter Validations' do
     it 'returns 400 on requests without required fields' do
       get('/validation/required') do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter is required")
       end
     end
 
@@ -20,28 +20,28 @@ describe 'Parameter Validations' do
     it 'returns 400 on requests when string is blank' do
       get('/validation/blank/string', arg: '') do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter cannot be blank")
       end
     end
 
     it 'returns 400 on requests when array is blank' do
       get('/validation/blank/array', arg: '') do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter cannot be blank")
       end
     end
 
     it 'returns 400 on requests when hash is blank' do
       get('/validation/blank/hash', arg: '') do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter cannot be blank")
       end
     end
 
     it 'returns 400 on requests when hash is blank' do
       get('/validation/blank/other', arg: '') do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter cannot be blank")
       end
     end
 
@@ -76,7 +76,7 @@ describe 'Parameter Validations' do
     it 'returns 400 on requests when value is other than defined' do
       get('/validation/is', arg: 'bar') do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter must be foo")
       end
     end
 
@@ -91,7 +91,7 @@ describe 'Parameter Validations' do
     it 'returns 400 on requests with a value not in the set' do
       get('/validation/in', arg: 'MISC') do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter must be within [\"ASC\", \"DESC\"]")
       end
     end
 
@@ -106,7 +106,7 @@ describe 'Parameter Validations' do
     it 'returns 400 on requests with a value outside the range' do
       get('/validation/within', arg: 20) do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter must be within 1..10")
       end
     end
 
@@ -121,7 +121,7 @@ describe 'Parameter Validations' do
     it 'returns 400 on requests with a value outside the range' do
       get('/validation/range', arg: 20) do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter must be within 1..10")
       end
     end
 
@@ -136,7 +136,7 @@ describe 'Parameter Validations' do
     it 'returns 400 on requests with a value smaller than min' do
       get('/validation/min', arg: 5) do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter cannot be less than 12")
       end
     end
 
@@ -151,7 +151,7 @@ describe 'Parameter Validations' do
     it 'returns 400 on requests with a value larger than max' do
       get('/validation/max', arg: 100) do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter cannot be greater than 20")
       end
     end
 
@@ -166,7 +166,7 @@ describe 'Parameter Validations' do
     it 'returns 400 on requests with a string shorter than min_length' do
       get('/validation/min_length', arg: 'hi') do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter cannot have length less than 5")
       end
     end
 
@@ -181,7 +181,7 @@ describe 'Parameter Validations' do
     it 'returns 400 on requests with a string longer than max_length' do
       get('/validation/max_length', arg: 'reallylongstringlongerthanmax') do |response|
         expect(response.status).to eq(400)
-        expect(JSON.parse(response.body)['message']).to eq('Invalid Parameter: arg')
+        expect(JSON.parse(response.body)['message']).to eq("Parameter cannot have length greater than 10")
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-param
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Mattt Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -141,9 +141,11 @@ files:
 - ./Rakefile
 - ./README.md
 - ./sinatra-param-1.3.0.gem
+- ./sinatra-param-1.3.1.gem
 - ./sinatra-param.gemspec
 - spec/dummy/app.rb
 - spec/parameter_exclusivity_spec.rb
+- spec/parameter_inclusivity_spec.rb
 - spec/parameter_raise_spec.rb
 - spec/parameter_spec.rb
 - spec/parameter_transformations_spec.rb
@@ -177,6 +179,7 @@ summary: Parameter Validation & Type Coercion for Sinatra.
 test_files:
 - spec/dummy/app.rb
 - spec/parameter_exclusivity_spec.rb
+- spec/parameter_inclusivity_spec.rb
 - spec/parameter_raise_spec.rb
 - spec/parameter_spec.rb
 - spec/parameter_transformations_spec.rb