grape 0.2.1.1 → 0.2.2

data/spec/grape/validations/coerce_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe Grape::Validations::CoerceValidator do
+  subject { Class.new(Grape::API) }
+  def app; subject end
+
+  describe 'coerce' do
+    it 'error on malformed input' do
+      subject.params { requires :int, :type => Integer }
+      subject.get '/single' do 'int works'; end
+
+      get '/single', :int => '43a' 
+      last_response.status.should == 400
+      last_response.body.should == 'invalid parameter: int'
+
+      get '/single', :int => '43'
+      last_response.status.should == 200
+      last_response.body.should == 'int works'
+    end
+
+    it 'error on malformed input (Array)' do
+      subject.params { requires :ids, :type => Array[Integer] }
+      subject.get '/array' do 'array int works'; end
+
+      get 'array', { :ids => ['1', '2', 'az'] }
+      last_response.status.should == 400
+      last_response.body.should == 'invalid parameter: ids'
+
+      get 'array', { :ids => ['1', '2', '890'] }
+      last_response.status.should == 200
+      last_response.body.should == 'array int works'
+    end
+
+    context 'complex objects' do
+      module CoerceValidatorSpec
+        class User
+          include Virtus
+          attribute :id, Integer
+          attribute :name, String
+        end
+      end
+
+      it 'error on malformed input for complex objects' do
+        subject.params { requires :user, :type => CoerceValidatorSpec::User }
+        subject.get '/user' do 'complex works'; end
+
+        get '/user', :user => "32"
+        last_response.status.should == 400
+        last_response.body.should == 'invalid parameter: user'
+
+        get '/user', :user => { :id => 32, :name => 'Bob' }
+        last_response.status.should == 200
+        last_response.body.should == 'complex works'
+      end
+    end
+
+    context 'coerces' do
+      it 'Integer' do
+        subject.params { requires :int, :coerce => Integer }
+        subject.get '/int' do params[:int].class; end
+
+        get '/int', { :int => "45" }
+        last_response.status.should == 200
+        last_response.body.should == 'Fixnum'
+      end
+
+      it 'Array of Integers' do
+        subject.params { requires :arry, :coerce => Array[Integer] }
+        subject.get '/array' do params[:arry][0].class; end
+
+        get '/array', { :arry => [ '1', '2', '3' ] }
+        last_response.status.should == 200
+        last_response.body.should == 'Fixnum'
+      end
+
+      it 'Array of Bools' do
+        subject.params { requires :arry, :coerce => Array[Virtus::Attribute::Boolean] }
+        subject.get '/array' do params[:arry][0].class; end
+
+        get 'array', { :arry => [1, 0] }
+        last_response.status.should == 200
+        last_response.body.should == 'TrueClass'
+      end
+
+      it 'Bool' do
+        subject.params { requires :bool, :coerce => Virtus::Attribute::Boolean }
+        subject.get '/bool' do params[:bool].class; end
+
+        get '/bool', { :bool => 1 }
+        last_response.status.should == 200
+        last_response.body.should == 'TrueClass'
+        
+        get '/bool', { :bool => 0 }
+        last_response.status.should == 200
+        last_response.body.should == 'FalseClass'
+
+        get '/bool', { :bool => 'false' }
+        last_response.status.should == 200
+        last_response.body.should == 'FalseClass'
+
+        get '/bool', { :bool => 'true' }
+        last_response.status.should == 200
+        last_response.body.should == 'TrueClass'
+      end
+
+      it 'file' do
+        subject.params { requires :file, :coerce => Rack::Multipart::UploadedFile }
+        subject.post '/upload' do params[:file].filename; end
+
+        post '/upload', { :file => Rack::Test::UploadedFile.new(__FILE__) }
+        last_response.status.should == 201
+        last_response.body.should == File.basename(__FILE__).to_s
+      end
+
+      it 'Nests integers' do
+        subject.params do
+          group :integers do
+            requires :int, :coerce => Integer
+          end
+        end
+        subject.get '/int' do params[:integers][:int].class; end
+
+        get '/int', { :integers => { :int => "45" } }
+        last_response.status.should == 200
+        last_response.body.should == 'Fixnum'
+      end
+    end
+  end
+end

data/spec/grape/validations/presence_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe Grape::Validations::PresenceValidator do
+
+  module ValidationsSpec
+    module PresenceValidatorSpec
+      class API < Grape::API
+        default_format :json
+
+        resource :bacons do
+          get do
+            "All the bacon"
+          end
+        end
+
+        params do
+          requires :id, :regexp => /^[0-9]+$/
+        end
+        post do
+          {:ret => params[:id]}
+        end
+        
+        params do
+          requires :name, :company
+        end
+        get do
+          "Hello"
+        end
+
+        params do
+          group :user do
+            requires :first_name, :last_name
+          end
+        end
+        get '/nested' do
+          "Nested"
+        end
+
+        params do
+          group :admin do
+            requires :admin_name
+            group :super do
+              group :user do
+                requires :first_name, :last_name
+              end
+            end
+          end
+        end
+        get '/nested_triple' do
+          "Nested triple"
+        end
+      end
+    end
+  end
+  
+  def app
+    ValidationsSpec::PresenceValidatorSpec::API
+  end
+
+  it "does not validate for any params" do
+    get("/bacons")
+    last_response.status.should == 200
+    last_response.body.should == "All the bacon"
+  end
+  
+  it 'validates id' do
+    post('/')
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: id"
+    
+    post('/', {}, 'rack.input' => StringIO.new('{"id" : "a56b"}'))
+    last_response.body.should == 'invalid parameter: id'
+    last_response.status.should == 400
+    
+    post('/', {}, 'rack.input' => StringIO.new('{"id" : 56}'))
+    last_response.body.should == '{"ret":56}'
+    last_response.status.should == 201
+  end
+  
+  it 'validates name, company' do
+    get('/')
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: name"
+    
+    get('/', :name => "Bob")
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: company"
+    
+    get('/', :name => "Bob", :company => "TestCorp")
+    last_response.status.should == 200
+    last_response.body.should == "Hello"
+  end
+
+  it 'validates nested parameters' do
+    get('/nested')
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: first_name"
+
+    get('/nested', :user => {:first_name => "Billy"})
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: last_name"
+
+    get('/nested', :user => {:first_name => "Billy", :last_name => "Bob"})
+    last_response.status.should == 200
+    last_response.body.should == "Nested"
+  end
+
+  it 'validates triple nested parameters' do
+    get('/nested_triple')
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: admin_name"
+
+    get('/nested_triple', :user => {:first_name => "Billy"})
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: admin_name"
+
+    get('/nested_triple', :admin => {:super => {:first_name => "Billy"}})
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: admin_name"
+
+    get('/nested_triple', :super => {:user => {:first_name => "Billy", :last_name => "Bob"}})
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: admin_name"
+
+    get('/nested_triple', :admin => {:super => {:user => {:first_name => "Billy"}}})
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: admin_name"
+
+    get('/nested_triple', :admin => { :admin_name => 'admin', :super => {:user => {:first_name => "Billy"}}})
+    last_response.status.should == 400
+    last_response.body.should == "missing parameter: last_name"
+
+    get('/nested_triple', :admin => { :admin_name => 'admin', :super => {:user => {:first_name => "Billy", :last_name => "Bob"}}})
+    last_response.status.should == 200
+    last_response.body.should == "Nested triple"
+  end
+
+end

data/spec/grape/validations/regexp_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Grape::Validations::RegexpValidator do
+  module ValidationsSpec
+    module RegexpValidatorSpec
+      class API < Grape::API
+        default_format :json
+        
+        params do
+          requires :name, :regexp => /^[a-z]+$/
+        end
+        get do
+          
+        end
+      end
+    end
+  end
+  
+  def app
+    ValidationsSpec::RegexpValidatorSpec::API
+  end
+  
+  it 'should refuse invalid input' do
+    get '/', :name => "invalid name"
+    last_response.status.should == 400
+  end
+  
+  it 'should accept valid input' do
+    get '/', :name => "bob"
+    last_response.status.should == 200
+  end
+  
+end

data/spec/grape/validations_spec.rb

@@ -0,0 +1,185 @@
+require 'spec_helper'
+
+describe Grape::Validations do
+  subject { Class.new(Grape::API) }
+  def app; subject end
+
+  describe 'params' do
+    context 'optional' do
+      it 'validates when params is present' do
+        subject.params { optional :a_number, :regexp => /^[0-9]+$/ }
+        subject.get '/optional' do 'optional works!'; end
+
+        get '/optional', { :a_number => 'string' }
+        last_response.status.should == 400
+        last_response.body.should == 'invalid parameter: a_number'
+
+        get '/optional', { :a_number => 45 }
+        last_response.status.should == 200
+        last_response.body.should == 'optional works!'
+      end
+
+      it "doesn't validate when param not present" do
+        subject.params { optional :a_number, :regexp => /^[0-9]+$/ }
+        subject.get '/optional' do 'optional works!'; end
+
+        get '/optional'
+        last_response.status.should == 200
+        last_response.body.should == 'optional works!'
+      end
+
+      it 'adds to declared parameters' do
+        subject.params { optional :some_param }
+        subject.settings[:declared_params].should == [:some_param]
+      end
+    end
+
+    context 'required' do
+      before do
+        subject.params { requires :key }
+        subject.get '/required' do 'required works'; end
+      end
+
+      it 'errors when param not present' do
+        get '/required'
+        last_response.status.should == 400
+        last_response.body.should == 'missing parameter: key'
+      end
+
+      it "doesn't throw a missing param when param is present" do
+        get '/required', { :key => 'cool' }
+        last_response.status.should == 200
+        last_response.body.should == 'required works'
+      end
+
+      it 'adds to declared parameters' do
+        subject.params { requires :some_param }
+        subject.settings[:declared_params].should == [:some_param]
+      end
+    end
+
+    context 'custom validation' do
+      module CustomValidations
+        class Customvalidator < Grape::Validations::Validator
+          def validate_param!(attr_name, params)
+            unless params[attr_name] == 'im custom'
+              throw :error, :status => 400, :message => "#{attr_name}: is not custom!"
+            end
+          end
+        end
+      end
+
+      context 'when using optional with a custom validator' do
+        before do
+          subject.params { optional :custom, :customvalidator => true }
+          subject.get '/optional_custom' do 'optional with custom works!'; end
+        end
+
+        it 'validates when param is present' do
+          get '/optional_custom', { :custom => 'im custom' }
+          last_response.status.should == 200
+          last_response.body.should == 'optional with custom works!'
+
+          get '/optional_custom', { :custom => 'im wrong' }
+          last_response.status.should == 400
+          last_response.body.should == 'custom: is not custom!'
+        end
+
+        it "skip validation when parameter isn't present" do
+          get '/optional_custom'
+          last_response.status.should == 200
+          last_response.body.should == 'optional with custom works!'
+        end
+
+        it 'validates with custom validator when param present and incorrect type' do
+          subject.params { optional :custom, :type => String, :customvalidator => true }
+
+          get '/optional_custom', { :custom => 123 }
+          last_response.status.should == 400
+          last_response.body.should == 'custom: is not custom!'
+        end
+      end
+
+      context 'when using requires with a custom validator' do
+        before do
+          subject.params { requires :custom, :customvalidator => true }
+          subject.get '/required_custom' do 'required with custom works!'; end
+        end
+
+        it 'validates when param is present' do
+          get '/required_custom', { :custom => 'im wrong, validate me' }
+          last_response.status.should == 400
+          last_response.body.should == 'custom: is not custom!'
+
+          get '/required_custom', { :custom => 'im custom' }
+          last_response.status.should == 200
+          last_response.body.should == 'required with custom works!'
+        end
+
+        it 'validates when param is not present' do
+          get '/required_custom'
+          last_response.status.should == 400
+          last_response.body.should == 'missing parameter: custom'
+        end
+
+        context 'nested namespaces' do
+          before do
+            subject.params { requires :custom, :customvalidator => true }
+            subject.namespace 'nested' do
+              get 'one' do 'validation failed' end
+              namespace 'nested' do
+                get 'two' do 'validation failed' end
+              end
+            end
+            subject.namespace 'peer' do
+              get 'one' do 'no validation required' end
+              namespace 'nested' do
+                get 'two' do 'no validation required' end
+              end
+            end
+
+            subject.namespace 'unrelated' do
+              params{ requires :name }
+              get 'one' do 'validation required'; end
+
+              namespace 'double' do
+                get 'two' do 'no validation required' end
+              end
+            end
+          end
+          
+          specify 'the parent namespace should use the validator' do
+            get '/nested/one', { :custom => 'im wrong, validate me'}
+            last_response.status.should == 400
+            last_response.body.should == 'custom: is not custom!'
+          end
+          
+          specify 'the nested namesapce should inherit the custom validator' do
+            get '/nested/nested/two', { :custom => 'im wrong, validate me'}
+            last_response.status.should == 400
+            last_response.body.should == 'custom: is not custom!'
+          end
+          
+          specify 'peer namesapces should not have the validator' do
+            get '/peer/one', { :custom => 'im not validated' }
+            last_response.status.should == 200
+            last_response.body.should == 'no validation required'
+          end
+
+          specify 'namespaces nested in peers should also not have the validator' do
+            get '/peer/nested/two', { :custom => 'im not validated' }
+            last_response.status.should == 200
+            last_response.body.should == 'no validation required'
+          end
+
+          specify 'when nested, specifying a route should clear out the validations for deeper nested params' do
+            get '/unrelated/one'
+            last_response.status.should == 400
+            get '/unrelated/double/two'
+            last_response.status.should == 200
+          end
+        end
+      end
+    end # end custom validation
+  end
+end