grape 0.4.1 → 0.5.0

data/lib/grape/validations.rb

@@ -19,12 +19,27 @@ module Grape
       end
 
       def validate!(params)
-        params = @scope.params(params)
+        attributes = AttributesIterator.new(self, @scope, params)
+        attributes.each do |resource_params, attr_name|
+          if @required || resource_params.has_key?(attr_name)
+            validate_param!(attr_name, resource_params)
+          end
+        end
+      end
+
+      class AttributesIterator
+        include Enumerable
+
+        def initialize(validator, scope, params)
+          @attrs = validator.attrs
+          @params = scope.params(params)
+          @params = (@params.is_a?(Array) ? @params : [@params])
+        end
 
-        (params.is_a?(Array) ? params : [params]).each do |resource_params|
-          @attrs.each do |attr_name|
-            if @required || resource_params.has_key?(attr_name)
-              validate_param!(attr_name, resource_params)
+        def each
+          @params.each do |resource_params|
+            @attrs.each do |attr_name|
+              yield resource_params, attr_name
             end
           end
         end
@@ -76,9 +91,13 @@ module Grape
 
       def initialize(api, element, parent, &block)
         @element = element
-        @parent = parent
-        @api = api
+        @parent  = parent
+        @api     = api
+        @declared_params = []
+
         instance_eval(&block)
+
+        configure_declared_params
       end
 
       def requires(*attrs)
@@ -116,7 +135,24 @@ module Grape
         name.to_s
       end
 
+    protected
+
+      def push_declared_params(attrs)
+        @declared_params.concat attrs
+      end
+
     private
+
+      # Pushes declared params to parent or settings
+      def configure_declared_params
+        if @parent
+          @parent.push_declared_params [element => @declared_params]
+        else
+          @api.settings.peek[:declared_params] ||= []
+          @api.settings[:declared_params].concat @declared_params
+        end
+      end
+
       def validates(attrs, validations)
         doc_attrs = { :required => validations.keys.include?(:presence) }
 
@@ -133,6 +169,10 @@ module Grape
           doc_attrs[:desc] = desc
         end
 
+        if default = validations[:default]
+          doc_attrs[:default] = default
+        end
+
         full_attrs = attrs.collect{ |name| { :name => name, :full_name => full_name(name)} }
         @api.document_attribute(full_attrs, doc_attrs)
 
@@ -164,10 +204,6 @@ module Grape
         end
       end
 
-      def push_declared_params(attrs)
-        @api.settings.peek[:declared_params] ||= []
-        @api.settings[:declared_params] += attrs
-      end
     end
 
     # This module is mixed into the API Class.

data/lib/grape/validations/default.rb

@@ -0,0 +1,24 @@
+module Grape
+  module Validations
+    class DefaultValidator < Validator
+      def initialize(attrs, options, required, scope)
+        @default = options
+        super
+      end
+
+      def validate_param!(attr_name, params)
+        params[attr_name] = @default unless params.has_key?(attr_name)
+      end
+
+      def validate!(params)
+        params = AttributesIterator.new(self, @scope, params)
+        params.each do |resource_params, attr_name|
+          if resource_params[attr_name].nil?
+            validate_param!(attr_name, resource_params)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/grape/version.rb

@@ -1,3 +1,3 @@
 module Grape
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/spec/grape/api_spec.rb

@@ -97,6 +97,16 @@ describe Grape::API do
     # pending 'routes if any media type is allowed'
   end
 
+  describe '.version using accept_version_header' do
+    it_should_behave_like 'versioning' do
+      let(:macro_options) do
+        {
+          :using  => :accept_version_header
+        }
+      end
+    end
+  end
+
   describe '.represent' do
     it 'requires a :with option' do
       expect{ subject.represent Object, {} }.to raise_error(Grape::Exceptions::InvalidWithOptionForRepresent)
@@ -181,6 +191,36 @@ describe Grape::API do
     end
   end
 
+  describe '.route_param' do
+    it 'adds a parameterized route segment namespace' do
+      subject.namespace :users do
+        route_param :id do
+          get do
+            params[:id]
+          end
+        end
+      end
+
+      get '/users/23'
+      last_response.body.should == '23'
+    end
+
+    it 'should be able to define requirements with a single hash' do
+      subject.namespace :users do
+        route_param :id, :requirements => /[0-9]+/ do
+          get do
+            params[:id]
+          end
+        end
+      end
+
+      get '/users/michael'
+      last_response.status.should == 404
+      get '/users/23'
+      last_response.status.should == 200
+    end
+  end
+
   describe '.route' do
     it 'allows for no path' do
       subject.namespace :votes do
@@ -245,6 +285,13 @@ describe Grape::API do
         versioned_get "/", "v1", :using => :param
       end
 
+      it 'Accept-Version header versioned APIs' do
+        subject.version 'v1', :using => :accept_version_header
+        subject.enable_root_route!
+
+        versioned_get "/", "v1", :using => :accept_version_header
+      end
+
       it 'unversioned APIs' do
         subject.enable_root_route!
 
@@ -329,6 +376,7 @@ describe Grape::API do
             send verb, '/', MultiJson.dump(object), { 'CONTENT_TYPE' => 'application/json' }
             last_response.status.should == (verb == :post ? 201 : 200)
             last_response.body.should eql MultiJson.dump(object)
+            last_request.params.should eql Hash.new
           end
           it "stores input in api.request.input" do
             subject.format :json
@@ -339,6 +387,17 @@ describe Grape::API do
             last_response.status.should == (verb == :post ? 201 : 200)
             last_response.body.should eql MultiJson.dump(object).to_json
           end
+          context "chunked transfer encoding" do
+            it "stores input in api.request.input" do
+              subject.format :json
+              subject.send(verb) do
+                env['api.request.input']
+              end
+              send verb, '/', MultiJson.dump(object), { 'CONTENT_TYPE' => 'application/json', 'HTTP_TRANSFER_ENCODING' => 'chunked', 'CONTENT_LENGTH' => nil  }
+              last_response.status.should == (verb == :post ? 201 : 200)
+              last_response.body.should eql MultiJson.dump(object).to_json
+            end
+          end
         end
       end
     end
@@ -928,6 +987,21 @@ describe Grape::API do
       last_response.status.should == 400
       last_response.body.should == 'New Error'
     end
+
+    it 'can rescue exceptions raised in the formatter' do
+      formatter = stub(:formatter)
+      formatter.stub(:call) { raise StandardError }
+      Grape::Formatter::Base.stub(:formatter_for) { formatter }
+
+      subject.rescue_from :all do |e|
+        rack_response('Formatter Error', 500)
+      end
+      subject.get('/formatter_exception') { 'Hello world' }
+
+      get '/formatter_exception'
+      last_response.status.should eql 500
+      last_response.body.should == 'Formatter Error'
+    end
   end
 
   describe '.rescue_from klass, block' do
@@ -1193,6 +1267,15 @@ describe Grape::API do
   end
 
   describe '.parser' do
+    it 'parses data in format requested by content-type' do
+      subject.format :json
+      subject.post '/data' do
+        { :x => params[:x] }
+      end
+      post "/data", '{"x":42}', { 'CONTENT_TYPE' => 'application/json' }
+      last_response.status.should == 201
+      last_response.body.should == '{"x":42}'
+    end
     context 'lambda parser' do
       before :each do
         subject.content_type :txt, "text/plain"
@@ -1240,6 +1323,42 @@ describe Grape::API do
         last_response.body.should eql 'Disallowed type attribute: "symbol"'
       end
     end
+    context "none parser class" do
+      before :each do
+        subject.parser :json, nil
+        subject.put "data" do
+          "body: #{env['api.request.body']}"
+        end
+      end
+      it "does not parse data" do
+        put '/data', 'not valid json', "CONTENT_TYPE" => "application/json"
+        last_response.status.should == 200
+        last_response.body.should == "body: not valid json"
+      end
+    end
+  end
+
+  describe '.default_format' do
+    before :each do
+      subject.format :json
+      subject.default_format :json
+    end
+    it 'returns data in default format' do
+      subject.get '/data' do
+        { :x => 42 }
+      end
+      get "/data"
+      last_response.status.should == 200
+      last_response.body.should == '{"x":42}'
+    end
+    it 'parses data in default format' do
+      subject.post '/data' do
+        { :x => params[:x] }
+      end
+      post "/data", '{"x":42}', "CONTENT_TYPE" => ""
+      last_response.status.should == 201
+      last_response.body.should == '{"x":42}'
+    end
   end
 
   describe '.default_error_status' do
@@ -1601,6 +1720,24 @@ describe Grape::API do
         last_response.body.should == 'yo'
       end
 
+      it 'applies the settings to nested mounted apis' do
+        subject.version 'v1', :using => :path
+
+        subject.namespace :cool do
+          inner_app = Class.new(Grape::API)
+          inner_app.get('/awesome') do
+            "yo"
+          end
+
+          app = Class.new(Grape::API)
+          app.mount inner_app
+          mount app
+        end
+
+        get '/v1/cool/awesome'
+        last_response.body.should == 'yo'
+      end
+
       it 'inherits rescues even when some defined by mounted' do
         subject.rescue_from :all do |e|
           rack_response("rescued from #{e.message}", 202)
@@ -1801,6 +1938,14 @@ describe Grape::API do
         get '/meaning_of_life', {}, { 'HTTP_ACCEPT' => 'text/html' }
         last_response.body.should == { :meaning_of_life => 42 }.to_json
       end
+      it 'can be overwritten with an explicit content type' do
+        subject.get '/meaning_of_life_with_content_type' do
+          content_type "text/plain"
+          { :meaning_of_life => 42 }.to_s
+        end
+        get '/meaning_of_life_with_content_type'
+        last_response.body.should == { :meaning_of_life => 42 }.to_s
+      end
       it 'raised :error from middleware' do
         middleware = Class.new(Grape::Middleware::Base) do
           def before
@@ -1952,18 +2097,33 @@ XML
   end
 
   context "cascading" do
-    it "cascades" do
-      subject.version 'v1', :using => :path, :cascade => true
-      get "/v1/hello"
-      last_response.status.should == 404
-      last_response.headers["X-Cascade"].should == "pass"
+    context "via version" do
+      it "cascades" do
+        subject.version 'v1', :using => :path, :cascade => true
+        get "/v1/hello"
+        last_response.status.should == 404
+        last_response.headers["X-Cascade"].should == "pass"
+      end
+      it "does not cascade" do
+        subject.version 'v2', :using => :path, :cascade => false
+        get "/v2/hello"
+        last_response.status.should == 404
+        last_response.headers.keys.should_not include "X-Cascade"
+      end
     end
-
-    it "does not cascade" do
-      subject.version 'v2', :using => :path, :cascade => false
-      get "/v2/hello"
-      last_response.status.should == 404
-      last_response.headers.keys.should_not include "X-Cascade"
+    context "via endpoint" do
+      it "cascades" do
+        subject.cascade true
+        get "/hello"
+        last_response.status.should == 404
+        last_response.headers["X-Cascade"].should == "pass"
+      end
+      it "does not cascade" do
+        subject.cascade false
+        get "/hello"
+        last_response.status.should == 404
+        last_response.headers.keys.should_not include "X-Cascade"
+      end
     end
   end
 end

data/spec/grape/endpoint_spec.rb

@@ -64,6 +64,12 @@ describe Grape::Endpoint do
       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] = "Goliath passes symbols"
+      body = subject.call(env)[2].body.first
+      JSON.parse(body)["Symbol-Header"].should == "Goliath passes symbols"
+    end
   end
 
   describe '#cookies' do
@@ -167,12 +173,16 @@ describe Grape::Endpoint do
       subject.params do
         requires :first
         optional :second
+        optional :third, :default => 'third-default'
+        group :nested 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
 
@@ -180,6 +190,36 @@ 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 '/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

data/spec/grape/entity_spec.rb

@@ -238,6 +238,44 @@ XML
       last_response.body.should == 'abcDef({"example":{"name":"johnnyiller"}})'
     end
 
+    context "present with multiple entities" do
+      let(:user) do
+      end
+
+      before :each do
+      end
+
+      it "present with multiple entities using optional symbol" do
+        user = Class.new do
+          attr_reader :name
+          def initialize(args)
+            @name = args[:name] || "no name set"
+          end
+        end
+        user1 = user.new({:name => 'user1'})
+        user2 = user.new({:name => 'user2'})
+
+        entity = Class.new(Grape::Entity)
+        entity.expose :name
+
+        subject.format :json
+        subject.get '/example' do
+          present :page, 1
+          present :user1, user1, :with => entity
+          present :user2, user2, :with => entity
+        end
+        get '/example'
+        expect_response_json = {
+          "page"  => 1,
+          "user1" => {"name" => "user1"},
+          "user2" => {"name" => "user2"}
+        }
+        JSON(last_response.body).should == expect_response_json
+      end
+
+    end
+
+
   end
 
 end