grape 0.3.0 → 0.7.0

data/spec/grape/endpoint_spec.rb

@@ -2,22 +2,25 @@ require 'spec_helper'
 
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
-  def app; subject end
+
+  def app
+    subject
+  end
 
   describe '#initialize' do
     it 'takes a settings stack, options, and a block' do
-      p = Proc.new {}
+      p = proc {}
       expect {
         Grape::Endpoint.new(Grape::Util::HashStack.new, {
-          :path => '/',
-          :method => :get
+          path: '/',
+          method: :get
         }, &p)
       }.not_to raise_error
     end
   end
 
   it 'sets itself in the env upon call' do
-    subject.get('/'){ "Hello world." }
+    subject.get('/') { "Hello world." }
     get '/'
     last_request.env['api.endpoint'].should be_kind_of(Grape::Endpoint)
   end
@@ -61,9 +64,15 @@ describe Grape::Endpoint do
       }
     end
     it 'includes additional request headers' do
-      get '/headers', nil, { "HTTP_X_GRAPE_CLIENT" => "1" }
+      get '/headers', nil, "HTTP_X_GRAPE_CLIENT" => "1"
       JSON.parse(last_response.body)["X-Grape-Client"].should == "1"
     end
+    it 'includes headers passed as symbols' do
+      env = Rack::MockRequest.env_for("/headers")
+      env["HTTP_SYMBOL_HEADER".to_sym] = "Goliath passes symbols"
+      body = subject.call(env)[2].body.first
+      JSON.parse(body)["Symbol-Header"].should == "Goliath passes symbols"
+    end
   end
 
   describe '#cookies' do
@@ -71,10 +80,10 @@ describe Grape::Endpoint do
       subject.get('/get/cookies') do
         cookies['my-awesome-cookie1'] = 'is cool'
         cookies['my-awesome-cookie2'] = {
-            :value => 'is cool too',
-            :domain => 'my.example.com',
-            :path => '/',
-            :secure => true,
+            value: 'is cool too',
+            domain: 'my.example.com',
+            path: '/',
+            secure: true,
         }
         cookies[:cookie3] = 'symbol'
         cookies['cookie4'] = 'secret code here'
@@ -87,7 +96,7 @@ describe Grape::Endpoint do
         "cookie4=secret+code+here",
         "my-awesome-cookie1=is+cool",
         "my-awesome-cookie2=is+cool+too; domain=my.example.com; path=/; secure"
-      ]
+     ]
     end
 
     it 'sets browser cookies and does not set response cookies' do
@@ -121,18 +130,18 @@ describe Grape::Endpoint do
         end
         sum
       end
-      get('/test', {}, 'HTTP_COOKIE' => 'delete_this_cookie=1; and_this=2')
+      get '/test', {}, 'HTTP_COOKIE' => 'delete_this_cookie=1; and_this=2'
       last_response.body.should == '3'
       cookies = Hash[last_response.headers['Set-Cookie'].split("\n").map do |set_cookie|
         cookie = CookieJar::Cookie.from_set_cookie 'http://localhost/test', set_cookie
-        [ cookie.name, cookie ]
+        [cookie.name, cookie]
       end]
       cookies.size.should == 2
-      [ "and_this", "delete_this_cookie" ].each do |cookie_name|
+      ["and_this", "delete_this_cookie"].each do |cookie_name|
         cookie = cookies[cookie_name]
         cookie.should_not be_nil
         cookie.value.should == "deleted"
-        cookie.expired?.should be_true
+        cookie.expired?.should be true
       end
     end
 
@@ -141,7 +150,7 @@ describe Grape::Endpoint do
         sum = 0
         cookies.each do |name, val|
           sum += val.to_i
-          cookies.delete name, { :path => '/test' }
+          cookies.delete name, path: '/test'
         end
         sum
       end
@@ -149,15 +158,15 @@ describe Grape::Endpoint do
       last_response.body.should == '3'
       cookies = Hash[last_response.headers['Set-Cookie'].split("\n").map do |set_cookie|
         cookie = CookieJar::Cookie.from_set_cookie 'http://localhost/test', set_cookie
-        [ cookie.name, cookie ]
+        [cookie.name, cookie]
       end]
       cookies.size.should == 2
-      [ "and_this", "delete_this_cookie" ].each do |cookie_name|
+      ["and_this", "delete_this_cookie"].each do |cookie_name|
         cookie = cookies[cookie_name]
         cookie.should_not be_nil
         cookie.value.should == "deleted"
         cookie.path.should == "/test"
-        cookie.expired?.should be_true
+        cookie.expired?.should be true
       end
     end
   end
@@ -167,14 +176,16 @@ describe Grape::Endpoint do
       subject.params do
         requires :first
         optional :second
+        optional :third, default: 'third-default'
+        optional :nested, type: Hash do
+          optional :fourth
+        end
       end
-
-
     end
 
     it 'has as many keys as there are declared params' do
       subject.get '/declared' do
-        declared(params).keys.size.should == 2
+        declared(params).keys.size.should == 4
         ""
       end
 
@@ -182,6 +193,46 @@ describe Grape::Endpoint do
       last_response.status.should == 200
     end
 
+    it 'has a optional param with default value all the time' do
+      subject.get '/declared' do
+        params[:third].should == 'third-default'
+        ""
+      end
+
+      get '/declared?first=one'
+      last_response.status.should == 200
+    end
+
+    it 'builds nested params' do
+      subject.get '/declared' do
+        declared(params)[:nested].keys.size.should == 1
+        ""
+      end
+
+      get '/declared?first=present&nested[fourth]=1'
+      last_response.status.should == 200
+    end
+
+    it 'builds nested params when given array' do
+      subject.get '/dummy' do
+      end
+      subject.params do
+        requires :first
+        optional :second
+        optional :third, default: 'third-default'
+        optional :nested, type: Array do
+          optional :fourth
+        end
+      end
+      subject.get '/declared' do
+        declared(params)[:nested].size.should == 2
+        ""
+      end
+
+      get '/declared?first=present&nested[][fourth]=1&nested[][fourth]=2'
+      last_response.status.should == 200
+    end
+
     it 'filters out any additional params that are given' do
       subject.get '/declared' do
         declared(params).key?(:other).should == false
@@ -194,7 +245,7 @@ describe Grape::Endpoint do
 
     it 'stringifies if that option is passed' do
       subject.get '/declared' do
-        declared(params, :stringify => true)["first"].should == "one"
+        declared(params, stringify: true)["first"].should == "one"
         ""
       end
 
@@ -204,7 +255,7 @@ describe Grape::Endpoint do
 
     it 'does not include missing attributes if that option is passed' do
       subject.get '/declared' do
-        declared(params, :include_missing => false)[:second].should == nil
+        error! 400, "expected nil" if declared(params, include_missing: false)[:second]
         ""
       end
 
@@ -213,6 +264,55 @@ describe Grape::Endpoint do
     end
   end
 
+  describe '#declared; call from child namespace' do
+    before do
+      subject.format :json
+      subject.namespace :something do
+        params do
+          requires :id, type: Integer
+        end
+        resource ':id' do
+          params do
+            requires :foo
+            optional :bar
+          end
+          get do
+            {
+              params: params,
+              declared_params: declared(params)
+            }
+          end
+          params do
+            requires :happy
+            optional :days
+          end
+          get '/test' do
+            {
+              params: params,
+              declared_params: declared(params, include_parent_namespaces: false)
+            }
+          end
+        end
+      end
+    end
+
+    it 'should include params defined in the parent namespace' do
+      get '/something/123', foo: 'test', extra: 'hello'
+      expect(last_response.status).to eq 200
+      json = JSON.parse(last_response.body, symbolize_names: true)
+      expect(json[:params][:id]).to eq 123
+      expect(json[:declared_params].keys).to match_array [:foo, :bar, :id]
+    end
+
+    it 'does not include params defined in the parent namespace with include_parent_namespaces: false' do
+      get '/something/123/test', happy: 'test', extra: 'hello'
+      expect(last_response.status).to eq 200
+      json = JSON.parse(last_response.body, symbolize_names: true)
+      expect(json[:params][:id]).to eq 123
+      expect(json[:declared_params].keys).to match_array [:happy, :days]
+    end
+  end
+
   describe '#params' do
     it 'is available to the caller' do
       subject.get('/hey') do
@@ -242,37 +342,64 @@ describe Grape::Endpoint do
 
     context 'with special requirements' do
       it 'parses email param with provided requirements for params' do
-        subject.get('/:person_email', :requirements => { :person_email => /.*/ }) do
-        params[:person_email]
+        subject.get('/:person_email', requirements: { person_email: /.*/ }) do
+          params[:person_email]
         end
 
-        get '/rodzyn@grape.com'
-        last_response.body.should == 'rodzyn@grape.com'
+        get '/someone@example.com'
+        last_response.body.should == 'someone@example.com'
 
-        get 'rodzyn@grape.com.pl'
-        last_response.body.should == 'rodzyn@grape.com.pl'
+        get 'someone@example.com.pl'
+        last_response.body.should == 'someone@example.com.pl'
       end
 
       it 'parses many params with provided regexps' do
-        subject.get('/:person_email/test/:number',
-          :requirements => {
-            :person_email => /rodzyn@(.*).com/,
-            :number => /[0-9]/ }) do
-        params[:person_email] << params[:number]
+        subject.get('/:person_email/test/:number', requirements: { person_email: /someone@(.*).com/, number: /[0-9]/ }) do
+          params[:person_email] << params[:number]
         end
 
-        get '/rodzyn@grape.com/test/1'
-        last_response.body.should == 'rodzyn@grape.com1'
+        get '/someone@example.com/test/1'
+        last_response.body.should == 'someone@example.com1'
 
-        get '/rodzyn@testing.wrong/test/1'
+        get '/someone@testing.wrong/test/1'
         last_response.status.should == 404
 
-        get 'rodzyn@test.com/test/wrong_number'
+        get 'someone@test.com/test/wrong_number'
         last_response.status.should == 404
 
-        get 'rodzyn@test.com/wrong_middle/1'
+        get 'someone@test.com/wrong_middle/1'
         last_response.status.should == 404
       end
+
+      context 'namespace requirements' do
+        before :each do
+          subject.namespace :outer, requirements: { person_email: /abc@(.*).com/ } do
+            get('/:person_email') do
+              params[:person_email]
+            end
+
+            namespace :inner, requirements: { number: /[0-9]/, person_email: /someone@(.*).com/ }do
+              get '/:person_email/test/:number' do
+                params[:person_email] << params[:number]
+              end
+            end
+          end
+        end
+        it "parse email param with provided requirements for params" do
+          get '/outer/abc@example.com'
+          last_response.body.should == 'abc@example.com'
+        end
+
+        it "should override outer namespace's requirements" do
+          get '/outer/inner/someone@testing.wrong/test/1'
+          last_response.status.should == 404
+
+          get '/outer/inner/someone@testing.com/test/1'
+          last_response.status.should == 200
+          last_response.body.should == 'someone@testing.com1'
+        end
+
+      end
     end
 
     context 'from body parameters' do
@@ -286,31 +413,33 @@ describe Grape::Endpoint do
       end
 
       it 'converts JSON bodies to params' do
-        post '/request_body', MultiJson.dump(:user => 'Bobby T.'), {'CONTENT_TYPE' => 'application/json'}
+        post '/request_body', MultiJson.dump(user: 'Bobby T.'), 'CONTENT_TYPE' => 'application/json'
         last_response.body.should == 'Bobby T.'
       end
 
       it 'does not convert empty JSON bodies to params' do
-        put '/request_body', '', {'CONTENT_TYPE' => 'application/json'}
+        put '/request_body', '', 'CONTENT_TYPE' => 'application/json'
         last_response.body.should == ''
       end
 
       it 'converts XML bodies to params' do
-        post '/request_body', '<user>Bobby T.</user>', {'CONTENT_TYPE' => 'application/xml'}
+        post '/request_body', '<user>Bobby T.</user>', 'CONTENT_TYPE' => 'application/xml'
         last_response.body.should == 'Bobby T.'
       end
 
       it 'converts XML bodies to params' do
-        put '/request_body', '<user>Bobby T.</user>', {'CONTENT_TYPE' => 'application/xml'}
+        put '/request_body', '<user>Bobby T.</user>', 'CONTENT_TYPE' => 'application/xml'
         last_response.body.should == 'Bobby T.'
       end
 
       it 'does not include parameters not defined by the body' do
         subject.post '/omitted_params' do
-          params[:version].should == nil
-          params[:user].should == 'Bob'
+          error! 400, "expected nil" if params[:version]
+          params[:user]
         end
-        post '/omitted_params', MultiJson.dump(:user => 'Bob'), {'CONTENT_TYPE' => 'application/json'}
+        post '/omitted_params', MultiJson.dump(user: 'Bob'), 'CONTENT_TYPE' => 'application/json'
+        last_response.status.should == 201
+        last_response.body.should == "Bob"
       end
     end
 
@@ -320,11 +449,70 @@ describe Grape::Endpoint do
       subject.put '/request_body' do
         params[:user]
       end
-      put '/request_body', '<user>Bobby T.</user>', {'CONTENT_TYPE' => 'application/xml'}
+      put '/request_body', '<user>Bobby T.</user>', 'CONTENT_TYPE' => 'application/xml'
       last_response.status.should == 406
       last_response.body.should == '{"error":"The requested content-type \'application/xml\' is not supported."}'
     end
 
+    context 'content type with params' do
+      before do
+        subject.format :json
+        subject.content_type :json, 'application/json; charset=utf-8'
+
+        subject.post do
+          params[:data]
+        end
+        post '/', MultiJson.dump(data: { some: 'payload' }), 'CONTENT_TYPE' => 'application/json'
+      end
+
+      it "should not response with 406 for same type without params" do
+        last_response.status.should_not be 406
+      end
+
+      it "should response with given content type in headers" do
+        last_response.headers['Content-Type'].should eq 'application/json; charset=utf-8'
+      end
+
+    end
+
+    context 'precedence' do
+
+      before do
+        subject.format :json
+        subject.namespace '/:id' do
+          get do
+            {
+              params: params[:id]
+            }
+          end
+          post do
+            {
+              params: params[:id]
+            }
+          end
+          put do
+            {
+              params: params[:id]
+            }
+          end
+        end
+      end
+
+      it 'route string params have higher precedence than body params' do
+        post '/123', { id: 456 }.to_json
+        expect(JSON.parse(last_response.body)['params']).to eq '123'
+        put '/123', { id: 456 }.to_json
+        expect(JSON.parse(last_response.body)['params']).to eq '123'
+      end
+
+      it 'route string params have higher precedence than URL params' do
+        get '/123?id=456'
+        expect(JSON.parse(last_response.body)['params']).to eq '123'
+        post '/123?id=456'
+        expect(JSON.parse(last_response.body)['params']).to eq '123'
+      end
+    end
+
   end
 
   describe '#error!' do
@@ -335,7 +523,7 @@ describe Grape::Endpoint do
       end
 
       get '/hey'
-      last_response.status.should == 403
+      last_response.status.should == 500
       last_response.body.should == "This is not valid."
     end
 
@@ -351,13 +539,23 @@ describe Grape::Endpoint do
 
     it 'accepts an object and render it in format' do
       subject.get '/hey' do
-        error!({'dude' => 'rad'}, 403)
+        error!({ 'dude' => 'rad' }, 403)
       end
 
       get '/hey.json'
       last_response.status.should == 403
       last_response.body.should == '{"dude":"rad"}'
     end
+
+    it 'can specifiy headers' do
+      subject.get '/hey' do
+        error!({ 'dude' => 'rad' }, 403, 'X-Custom' => 'value')
+      end
+
+      get '/hey.json'
+      last_response.status.should == 403
+      last_response.headers['X-Custom'].should == 'value'
+    end
   end
 
   describe '#redirect' do
@@ -382,7 +580,7 @@ describe Grape::Endpoint do
 
     it 'support permanent redirect' do
       subject.get('/hey') do
-        redirect "/ha", :permanent => true
+        redirect "/ha", permanent: true
       end
       get '/hey'
       last_response.status.should eq 301
@@ -396,10 +594,10 @@ describe Grape::Endpoint do
       params[:text]
     end
 
-    post '/new', :text => 'abc'
+    post '/new', text: 'abc'
     last_response.body.should == 'abc'
 
-    post '/new', :text => 'def'
+    post '/new', text: 'def'
     last_response.body.should == 'def'
   end
 
@@ -433,7 +631,7 @@ describe Grape::Endpoint do
   describe '.generate_api_method' do
     it 'raises NameError if the method name is already in use' do
       expect {
-        Grape::Endpoint.generate_api_method("version", &proc{})
+        Grape::Endpoint.generate_api_method("version", &proc {})
       }.to raise_error(NameError)
     end
     it 'raises ArgumentError if a block is not given' do
@@ -442,15 +640,15 @@ describe Grape::Endpoint do
       }.to raise_error(ArgumentError)
     end
     it 'returns a Proc' do
-      Grape::Endpoint.generate_api_method("GET test for a proc", &proc{}).should be_a Proc
+      Grape::Endpoint.generate_api_method("GET test for a proc", &proc {}).should be_a Proc
     end
   end
 
   context 'filters' do
     describe 'before filters' do
       it 'runs the before filter if set' do
-        subject.before{ env['before_test'] = "OK" }
-        subject.get('/before_test'){ env['before_test'] }
+        subject.before { env['before_test'] = "OK" }
+        subject.get('/before_test') { env['before_test'] }
 
         get '/before_test'
         last_response.body.should == "OK"
@@ -459,15 +657,15 @@ describe Grape::Endpoint do
 
     describe 'after filters' do
       it 'overrides the response body if it sets it' do
-        subject.after{ body "after" }
-        subject.get('/after_test'){ "during" }
+        subject.after { body "after" }
+        subject.get('/after_test') { "during" }
         get '/after_test'
         last_response.body.should == 'after'
       end
 
       it 'does not override the response body with its return' do
-        subject.after{ "after" }
-        subject.get('/after_test'){ "body" }
+        subject.after { "after" }
+        subject.get('/after_test') { "body" }
         get '/after_test'
         last_response.body.should == "body"
       end
@@ -479,7 +677,7 @@ describe Grape::Endpoint do
 
     verbs.each do |verb|
       it 'allows for the anchoring option with a #{verb.upcase} method' do
-        subject.send(verb, '/example', :anchor => true) do
+        subject.send(verb, '/example', anchor: true) do
           verb
         end
         send(verb, '/example/and/some/more')
@@ -495,7 +693,7 @@ describe Grape::Endpoint do
       end
 
       it 'responds to /example/and/some/more for the non-anchored #{verb.upcase} method' do
-        subject.send(verb, '/example', :anchor => false) do
+        subject.send(verb, '/example', anchor: false) do
           verb
         end
         send(verb, '/example/and/some/more')
@@ -513,9 +711,9 @@ describe Grape::Endpoint do
       get '/url'
       last_response.body.should == "http://example.org/url"
     end
-    [ 'v1', :v1 ].each do |version|
+    ['v1', :v1].each do |version|
       it 'should include version #{version}' do
-        subject.version version, :using => :path
+        subject.version version, using: :path
         subject.get('/url') do
           request.url
         end
@@ -524,7 +722,7 @@ describe Grape::Endpoint do
       end
     end
     it 'should include prefix' do
-      subject.version 'v1', :using => :path
+      subject.version 'v1', using: :path
       subject.prefix 'api'
       subject.get('/url') do
         request.url
@@ -534,4 +732,23 @@ describe Grape::Endpoint do
     end
   end
 
+  context 'version headers' do
+    before do
+      # NOTE: a 404 is returned instead of the 406 if cascade: false is not set.
+      subject.version 'v1', using: :header, vendor: 'ohanapi', cascade: false
+      subject.get '/test' do
+        "Hello!"
+      end
+    end
+
+    it 'result in a 406 response if they are invalid' do
+      get '/test', {}, 'HTTP_ACCEPT' => 'application/vnd.ohanapi.v1+json'
+      last_response.status.should == 406
+    end
+
+    it 'result in a 406 response if they cannot be parsed by rack-accept' do
+      get '/test', {}, 'HTTP_ACCEPT' => 'application/vnd.ohanapi.v1+json; version=1'
+      last_response.status.should == 406
+    end
+  end
 end