jdx-sinatra-param 0.0.1

data/spec/parameter_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'Parameter' do
+  it 'only sets parameters present in request or with a default value' do
+    get('/', a: 'a', b: 'b') do |response|
+      response_body = JSON.parse(response.body)
+      expect(response_body).to be_member('a')
+      expect(response_body).to be_member('b')
+      expect(response_body).to be_member('c')
+      expect(response_body).to_not be_member('d')
+    end
+  end
+
+  it 'stringifies parameters' do
+    get('/keys/stringify', q: 'test') do |response|
+      expect(response.body).to eq 'TEST'
+    end
+  end
+end

data/spec/parameter_transformations_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'Parameter Transformations' do
+  describe 'default' do
+    it 'sets a default value when none is given' do
+      get('/default') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['sort']).to eql 'title'
+      end
+    end
+
+    it 'sets a default value from an empty hash' do
+      get('/default/hash') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['attributes']).to eql Hash.new
+      end
+    end
+
+    it 'sets a default value from a proc' do
+      get('/default/proc') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['year']).to eql 2014
+      end
+    end
+  end
+
+  describe 'transform' do
+    it 'transforms the input using to_proc' do
+      get('/transform', order: 'asc') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['order']).to eql 'ASC'
+      end
+    end
+
+    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("Parameter is required")
+      end
+    end
+  end
+end

data/spec/parameter_type_coercion_spec.rb

@@ -0,0 +1,202 @@
+require 'spec_helper'
+
+describe 'Parameter Types' do
+  describe 'String' do
+    it 'coerces strings' do
+      get('/coerce/string', arg: '1234') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['arg']).to eq('1234')
+      end
+    end
+  end
+
+  describe 'Integer' do
+    it 'coerces integers' do
+      get('/coerce/integer', arg: '1234') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['arg']).to eq(1234)
+      end
+    end
+
+    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("'123abc' is not a valid Integer")
+      end
+    end
+  end
+
+  describe 'Float' do
+    it 'coerces floats' do
+      get('/coerce/float', arg: '1234') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['arg']).to eq(1234.0)
+      end
+    end
+
+    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("'123abc' is not a valid Float")
+      end
+    end
+  end
+
+  describe 'Time' do
+    it 'coerces time' do
+      get('/coerce/time', arg: '20130117') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['arg']).to match(/2013-01-17 00:00:00/)
+      end
+    end
+
+    it 'returns 400 on requests when time is invalid' do
+      get('/coerce/time', arg: 'noon') do |response|
+        expect(response.status).to eql 400
+        expect(JSON.parse(response.body)['message']).to eq("'noon' is not a valid Time")
+      end
+    end
+  end
+
+  describe 'Date' do
+    it 'coerces date' do
+      get('/coerce/date', arg: '20130117') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['arg']).to eq('2013-01-17')
+      end
+    end
+
+    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("'abc' is not a valid Date")
+      end
+    end
+  end
+
+  describe 'DateTime' do
+    it 'coerces datetimes' do
+      get('/coerce/datetime', arg: '20130117') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['arg']).to eq('2013-01-17T00:00:00+00:00')
+      end
+    end
+
+    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("'abc' is not a valid DateTime")
+      end
+    end
+  end
+
+  describe 'Array' do
+    it 'coerces arrays' do
+      get('/coerce/array', arg: '1,2,3,4,5') do |response|
+        expect(response.status).to eql 200
+        parsed_body = JSON.parse(response.body)
+        expect(parsed_body['arg']).to be_an(Array)
+        expect(parsed_body['arg']).to eq(%w(1 2 3 4 5))
+      end
+    end
+
+    it 'coerces arrays of size 1' do
+      get('/coerce/array', arg: '1') do |response|
+        expect(response.status).to eql 200
+        parsed_body = JSON.parse(response.body)
+        expect(parsed_body['arg']).to be_an(Array)
+        expect(parsed_body['arg']).to eq(%w(1))
+      end
+    end
+
+    it 'coerces arrays with arg[] style' do
+      get('/coerce/array', 'arg[]' => ['1','2','3','4','5']) do |response|
+        expect(response.status).to eql 200
+        parsed_body = JSON.parse(response.body)
+        expect(parsed_body['arg']).to be_an(Array)
+        expect(parsed_body['arg']).to eq(%w(1 2 3 4 5))
+      end
+    end
+  end
+
+  describe 'Hash' do
+    it 'coerces hashes' do
+      get('/coerce/hash', arg: 'a:b,c:d') do |response|
+        expect(response.status).to eql 200
+        parsed_body = JSON.parse(response.body)
+        expect(parsed_body['arg']).to be_an(Hash)
+        expect(parsed_body['arg']).to eq({ 'a' => 'b', 'c' => 'd'})
+      end
+    end
+  end
+
+  describe 'Boolean' do
+    it 'coerces truthy booleans to true' do
+      %w(1 true t yes y).each do |bool|
+        get('/coerce/boolean', arg: bool) do |response|
+          expect(response.status).to eql 200
+          expect(JSON.parse(response.body)['arg']).to be true
+        end
+      end
+    end
+
+    it 'coerces falsey booleans to false' do
+      %w(0 false f no n).each do |bool|
+        get('/coerce/boolean', arg: bool) do |response|
+          expect(response.status).to eql 200
+          expect(JSON.parse(response.body)['arg']).to be false
+          expect(JSON.parse(response.body)['arg']).to_not be_nil
+        end
+      end
+    end
+
+    it 'coerces truthy booleans to true when default is false' do
+      %w(1 true t yes y).each do |bool|
+        get('/default/boolean/false', arg: bool) do |response|
+          expect(response.status).to eql 200
+          expect(JSON.parse(response.body)['arg']).to be true
+        end
+      end
+    end
+
+    it 'coerces falsey booleans to false when default is true' do
+      %w(0 false f no n).each do |bool|
+        get('/default/boolean/true', arg: bool) do |response|
+          expect(response.status).to eql 200
+          expect(JSON.parse(response.body)['arg']).to be false
+          expect(JSON.parse(response.body)['arg']).to_not be_nil
+        end
+      end
+    end
+
+    it 'coerces default booleans to true when default is true and its not provided' do
+      get('/default/boolean/true') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['arg']).to be true
+        expect(JSON.parse(response.body)['arg']).to_not be_nil
+      end
+    end
+
+    it 'coerces default booleans to false when default is false and its not provided' do
+      get('/default/boolean/false') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['arg']).to be false
+        expect(JSON.parse(response.body)['arg']).to_not be_nil
+      end
+    end
+
+    it 'returns 400 on requests when true is not a truthy value' do
+      get('/default/boolean/true', arg: 'abc') do |response|
+        expect(response.status).to eql 400
+        expect(JSON.parse(response.body)['message']).to eq("'abc' is not a valid boolean")
+      end
+    end
+
+    it 'returns 400 on requests when false is not a falsey value' do
+      get('/default/boolean/false', arg: 'abc') do |response|
+        expect(response.status).to eql 400
+        expect(JSON.parse(response.body)['message']).to eq("'abc' is not a valid boolean")
+      end
+    end
+  end
+end

data/spec/parameter_validations_spec.rb

@@ -0,0 +1,216 @@
+require 'spec_helper'
+
+describe 'Parameter Validations' do
+  describe 'required' 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("Parameter is required")
+      end
+    end
+
+    it 'returns 200 on requests when required field present' do
+      get('/validation/required', arg: 'foo') do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
+  describe 'blank' 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("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("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("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("Parameter cannot be blank")
+      end
+    end
+
+    it 'returns 200 on request when blank is true' do
+      get('/validation/nonblank/string', arg: '') do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
+  describe 'format' do
+    it 'returns 200 on requests when value matches the param regex' do
+      get('/validation/format/hello', arg: 'hello world') do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+
+    it 'returns 400 on requests when value does not match the param regex' do
+      get('/validation/format/hello', arg: 'world') do |response|
+        expect(response.status).to eq(400)
+      end
+    end
+
+    it 'returns 400 on requests when value is not a string' do
+      get('/validation/format/9000', arg: 9000) do |response|
+        expect(response.status).to eq(400)
+      end
+    end
+  end
+
+  describe 'is' 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("Parameter must be foo")
+      end
+    end
+
+    it 'returns 200 on requests with a value is other than defined' do
+      get('/validation/is', arg: 'foo') do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
+  describe 'in' 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("Parameter must be within [\"ASC\", \"DESC\"]")
+      end
+    end
+
+    it 'returns 200 on requests with a value in the set' do
+      get('/validation/in', arg: 'ASC') do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
+  describe 'within' 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("Parameter must be within 1..10")
+      end
+    end
+
+    it 'returns 200 on requests with a value within the range' do
+      get('/validation/within', arg: 5) do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
+  describe 'range' 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("Parameter must be within 1..10")
+      end
+    end
+
+    it 'returns 200 on requests within the range' do
+      get('/validation/range', arg: 10) do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
+  describe 'min' 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("Parameter cannot be less than 12")
+      end
+    end
+
+    it 'returns 200 on requests with a value larger than min' do
+      get('/validation/min', arg: 200) do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
+  describe 'max' 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("Parameter cannot be greater than 20")
+      end
+    end
+
+    it 'returns 200 on requests with a value smaller than max' do
+      get('/validation/max', arg: 2) do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
+  describe 'min_length' 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("Parameter cannot have length less than 5")
+      end
+    end
+
+    it 'returns 200 on requests with a string longer than min_length' do
+      get('/validation/max_length', arg: 'longer') do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
+  describe 'max_length' 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("Parameter cannot have length greater than 10")
+      end
+    end
+
+    it 'returns 200 on requests with a string shorter than max_length' do
+      get('/validation/max_length', arg: 'short') do |response|
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+
+  context 'content-type header' do
+    it 'returns application/json for JSON APIs' do
+      get('/validation/max_length', arg: 'reallylongstringlongerthanmax') do |response|
+        expect(response.headers['Content-Type']).to eq('application/json')
+      end
+    end
+
+    it 'returns text/plain for non-JSON APIs' do
+      get('/xml', arg: 'reallylongstringlongerthanmax') do |response|
+        expect(response.headers['Content-Type']).to include('text/plain')
+      end
+    end
+  end
+
+  context 'custom message ' do
+    it 'returns a custom message when configured' do
+      get('/custommessage') do |response|
+        expect(JSON.parse(response.body)['message']).to eq("'a' must be less than 10")
+      end
+    end
+  end
+end