grape 0.5.0 → 0.6.0

data/lib/grape/http/request.rb

@@ -2,7 +2,7 @@ module Grape
   class Request < Rack::Request
 
     def params
-      @env['grape.request.params'] ||= begin
+      @env['grape.request.params'] = begin
         params = Hashie::Mash.new(super)
         if env['rack.routing_args']
           args = env['rack.routing_args'].dup

data/lib/grape/locale/en.yml

@@ -1,10 +1,11 @@
 en:
   grape:
     errors:
+      format: ! '%{attribute} %{message}'
       messages:
-        coerce: 'invalid parameter: %{attribute}'
-        presence: 'missing parameter: %{attribute}'
-        regexp: 'invalid parameter: %{attribute}'
+        coerce: 'is invalid'
+        presence: 'is missing'
+        regexp: 'is invalid'
         missing_vendor_option:
           problem: 'missing :vendor option.'
           summary: 'when version using header, you must specify :vendor option. '

data/lib/grape/middleware/auth/base.rb

@@ -0,0 +1,30 @@
+require 'rack/auth/basic'
+
+module Grape
+  module Middleware
+    module Auth
+      class Base < Grape::Middleware::Base
+        attr_reader :authenticator
+
+        def initialize(app, options = {}, &authenticator)
+          super(app, options)
+          @authenticator = authenticator
+        end
+
+        def base_request
+          raise NotImplementedError.new("You must implement base_request.")
+        end
+
+        def credentials
+          base_request.provided?? base_request.credentials : [nil, nil]
+        end
+
+        def before
+          unless authenticator.call(*credentials)
+            throw :error, :status => 401, :message => "API Authorization Failed."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape/middleware/auth/basic.rb

@@ -3,27 +3,10 @@ require 'rack/auth/basic'
 module Grape
   module Middleware
     module Auth
-      class Basic < Grape::Middleware::Base
-        attr_reader :authenticator
-        
-        def initialize(app, options = {}, &authenticator)
-          super(app, options)
-          @authenticator = authenticator
-        end
-        
-        def basic_request
+      class Basic < Grape::Middleware::Auth::Base
+        def base_request
           Rack::Auth::Basic::Request.new(env)
         end
-        
-        def credentials
-          basic_request.provided?? basic_request.credentials : [nil, nil]
-        end
-        
-        def before
-          unless authenticator.call(*credentials)
-            throw :error, :status => 401, :message => "API Authorization Failed."
-          end
-        end
       end
     end
   end

data/lib/grape/middleware/auth/digest.rb

@@ -3,27 +3,10 @@ require 'rack/auth/digest/md5'
 module Grape
   module Middleware
     module Auth
-      class Digest < Grape::Middleware::Base
-        attr_reader :authenticator
-        
-        def initialize(app, options = {}, &authenticator)
-          super(app, options)
-          @authenticator = authenticator
-        end
-        
-        def digest_request
+      class Digest < Grape::Middleware::Auth::Base
+        def base_request
           Rack::Auth::Digest::Request.new(env)
         end
-        
-        def credentials
-          digest_request.provided?? digest_request.credentials : [nil, nil]
-        end
-        
-        def before
-          unless authenticator.call(*credentials)
-            throw :error, :status => 401, :message => "API Authorization Failed."
-          end
-        end
       end
     end
   end

data/lib/grape/middleware/error.rb

@@ -33,7 +33,8 @@ module Grape
             raise unless is_rescuable
             handler = options[:rescue_handlers][e.class] || options[:rescue_handlers][:all]
           end
-          handler.nil? ? handle_error(e) : self.instance_exec(e, &handler)
+
+          handler.nil? ? handle_error(e) : exec_handler(e, &handler)
         end
       end
 
@@ -41,6 +42,14 @@ module Grape
         options[:rescue_all] || (options[:rescued_errors] || []).include?(klass)
       end
 
+      def exec_handler(e, &handler)
+        if handler.lambda? && handler.arity == 0
+          self.instance_exec(&handler)
+        else
+          self.instance_exec(e, &handler)
+        end
+      end
+
       def handle_error(e)
         error_response({ :message => e.message, :backtrace => e.backtrace })
       end

data/lib/grape/middleware/formatter.rb

@@ -41,7 +41,7 @@ module Grape
 
         # store read input in env['api.request.input']
         def read_body_input
-          if (request.post? || request.put? || request.patch?) &&
+          if (request.post? || request.put? || request.patch? || request.delete?) &&
             (! request.form_data? || ! request.media_type) &&
             (! request.parseable_data?) &&
             (request.content_length.to_i > 0 || request.env['HTTP_TRANSFER_ENCODING'] == 'chunked')

data/lib/grape/middleware/versioner/accept_version_header.rb

@@ -11,7 +11,7 @@ module Grape
       #
       # The following rack env variables are set:
       #
-      #    env['api.version]  => 'v1'
+      #    env['api.version']  => 'v1'
       #
       # If version does not match this route, then a 406 is raised with
       # X-Cascade header to alert Rack::Mount to attempt the next matched

data/lib/grape/middleware/versioner/header.rb

@@ -99,8 +99,8 @@ module Grape
         # of routes (see [Rack::Mount](https://github.com/josh/rack-mount) for more information). To prevent
         # this behavior, and not add the `X-Cascade` header, one can set the `:cascade` option to `false`.
         def cascade?
-          options[:version_options] && options[:version_options].has_key?(:cascade) ? 
-            !! options[:version_options][:cascade] : 
+          options[:version_options] && options[:version_options].has_key?(:cascade) ?
+            !! options[:version_options][:cascade] :
             true
         end
 

data/lib/grape/path.rb

@@ -0,0 +1,72 @@
+module Grape
+  class Path
+
+    def self.prepare(raw_path, namespace, settings)
+      Path.new(raw_path, namespace, settings).path_with_suffix
+    end
+
+    attr_reader :raw_path, :namespace, :settings
+
+    def initialize(raw_path, namespace, settings)
+      @raw_path = raw_path
+      @namespace = namespace
+      @settings = settings
+    end
+
+    def mount_path
+      split_setting(:mount_path, '/')
+    end
+
+    def root_prefix
+      split_setting(:root_prefix, '/')
+    end
+
+    def uses_path_versioning?
+      settings[:version] && settings[:version_options][:using] == :path
+    end
+
+    def has_namespace?
+      namespace && namespace.to_s =~ /^\S/ && namespace != '/'
+    end
+
+    def has_path?
+      raw_path && raw_path.to_s =~ /^\S/ && raw_path != '/'
+    end
+
+    def suffix
+      if !uses_path_versioning? || (has_namespace? || has_path?)
+        '(.:format)'
+      else
+        '(/.:format)'
+      end
+    end
+
+    def path
+      Rack::Mount::Utils.normalize_path(parts.join('/'))
+    end
+
+    def path_with_suffix
+      "#{path}#{suffix}"
+    end
+
+    def to_s
+      path_with_suffix
+    end
+
+    private
+
+    def parts
+      parts = [mount_path, root_prefix].compact
+      parts << ':version' if uses_path_versioning?
+      parts << namespace.to_s
+      parts << raw_path.to_s
+      parts.flatten.reject { |part| part == '/' }
+    end
+    
+    def split_setting(key, delimiter)
+      return if settings[key].nil?
+      settings[key].to_s.split("/")
+    end
+
+  end
+end

data/lib/grape/route.rb

@@ -18,6 +18,11 @@ module Grape
     def to_s
       "version=#{route_version}, method=#{route_method}, path=#{route_path}"
     end
-    
+
+    private
+    def to_ary
+      nil
+    end
+
   end
 end

data/lib/grape/validations.rb

@@ -89,10 +89,11 @@ module Grape
     class ParamsScope
       attr_accessor :element, :parent
 
-      def initialize(api, element, parent, &block)
-        @element = element
-        @parent  = parent
-        @api     = api
+      def initialize(opts, &block)
+        @element  = opts[:element]
+        @parent   = opts[:parent]
+        @api      = opts[:api]
+        @optional = opts[:optional] || false
         @declared_params = []
 
         instance_eval(&block)
@@ -100,7 +101,15 @@ module Grape
         configure_declared_params
       end
 
-      def requires(*attrs)
+      def should_validate?(parameters)
+        return false if @optional && params(parameters).blank?
+        return true if parent.nil?
+        parent.should_validate?(parameters)
+      end
+
+      def requires(*attrs, &block)
+        return new_scope(attrs, &block) if block_given?
+
         validations = {:presence => true}
         if attrs.last.is_a?(Hash)
           validations.merge!(attrs.pop)
@@ -110,7 +119,9 @@ module Grape
         validates(attrs, validations)
       end
 
-      def optional(*attrs)
+      def optional(*attrs, &block)
+        return new_scope(attrs, true, &block) if block_given?
+
         validations = {}
         if attrs.last.is_a?(Hash)
           validations.merge!(attrs.pop)
@@ -121,7 +132,7 @@ module Grape
       end
 
       def group(element, &block)
-        ParamsScope.new(@api, element, self, &block)
+        requires(element, &block)
       end
 
       def params(params)
@@ -143,6 +154,11 @@ module Grape
 
     private
 
+      def new_scope(attrs, optional=false, &block)
+        raise ArgumentError unless attrs.size == 1
+        ParamsScope.new(api: @api, element: attrs.first, parent: self, optional: optional, &block)
+      end
+
       # Pushes declared params to parent or settings
       def configure_declared_params
         if @parent
@@ -179,6 +195,7 @@ module Grape
         # Validate for presence before any other validators
         if validations.has_key?(:presence) && validations[:presence]
           validate('presence', validations[:presence], attrs, doc_attrs)
+          validations.delete(:presence)
         end
 
         # Before we run the rest of the validators, lets handle
@@ -214,7 +231,7 @@ module Grape
       end
 
       def params(&block)
-        ParamsScope.new(self, nil, nil, &block)
+        ParamsScope.new(api: self, &block)
       end
 
       def document_attribute(names, opts)

data/lib/grape/validations/coerce.rb

@@ -12,8 +12,7 @@ module Grape
         if valid_type?(new_value)
           params[attr_name] = new_value
         else
-          raise Grape::Exceptions::Validation, :status => 400,
-            :param => @scope.full_name(attr_name), :message_key => :coerce
+          raise Grape::Exceptions::Validation, :param => @scope.full_name(attr_name), :message_key => :coerce
         end
       end
 

data/lib/grape/validations/presence.rb

@@ -1,10 +1,14 @@
 module Grape
   module Validations
     class PresenceValidator < Validator
+      def validate!(params)
+        return unless @scope.should_validate?(params)
+        super
+      end
+
       def validate_param!(attr_name, params)
         unless params.has_key?(attr_name)
-          raise Grape::Exceptions::Validation, :status => 400,
-            :param => @scope.full_name(attr_name), :message_key => :presence
+          raise Grape::Exceptions::Validation, :param => @scope.full_name(attr_name), :message_key => :presence
         end
       end
     end

data/lib/grape/validations/regexp.rb

@@ -4,8 +4,7 @@ module Grape
     class RegexpValidator < SingleOptionValidator
       def validate_param!(attr_name, params)
         if params[attr_name] && !( params[attr_name].to_s =~ @option )
-          raise Grape::Exceptions::Validation, :status => 400,
-            :param => @scope.full_name(attr_name), :message_key => :regexp
+          raise Grape::Exceptions::Validation, :param => @scope.full_name(attr_name), :message_key => :regexp
         end
       end
     end

data/lib/grape/version.rb

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

data/spec/grape/api_spec.rb

@@ -275,7 +275,15 @@ describe Grape::API do
         subject.version 'v1', :using => :header, :vendor => 'test'
         subject.enable_root_route!
 
-        versioned_get "/", "v1", :using => :header
+        versioned_get "/", "v1", :using => :header, :vendor => 'test'
+      end
+
+      it 'header versioned APIs with multiple headers' do
+        subject.version ['v1', 'v2'], :using => :header, :vendor => 'test'
+        subject.enable_root_route!
+
+        versioned_get "/", "v1", :using => :header, :vendor => 'test'
+        versioned_get "/", "v2", :using => :header, :vendor => 'test'
       end
 
       it 'param versioned APIs' do
@@ -654,18 +662,18 @@ describe Grape::API do
     describe '.middleware' do
       it 'includes middleware arguments from settings' do
         settings = Grape::Util::HashStack.new
-        settings.stub!(:stack).and_return([{:middleware => [[ApiSpec::PhonyMiddleware, 'abc', 123]]}])
-        subject.stub!(:settings).and_return(settings)
+        settings.stub(:stack).and_return([{:middleware => [[ApiSpec::PhonyMiddleware, 'abc', 123]]}])
+        subject.stub(:settings).and_return(settings)
         subject.middleware.should eql [[ApiSpec::PhonyMiddleware, 'abc', 123]]
       end
 
       it 'includes all middleware from stacked settings' do
         settings = Grape::Util::HashStack.new
-        settings.stub!(:stack).and_return [
+        settings.stub(:stack).and_return [
           {:middleware => [[ApiSpec::PhonyMiddleware, 123],[ApiSpec::PhonyMiddleware, 'abc']]},
           {:middleware => [[ApiSpec::PhonyMiddleware, 'foo']]}
         ]
-        subject.stub!(:settings).and_return(settings)
+        subject.stub(:settings).and_return(settings)
 
         subject.middleware.should eql [
           [ApiSpec::PhonyMiddleware, 123],
@@ -989,7 +997,7 @@ describe Grape::API do
     end
 
     it 'can rescue exceptions raised in the formatter' do
-      formatter = stub(:formatter)
+      formatter = double(:formatter)
       formatter.stub(:call) { raise StandardError }
       Grape::Formatter::Base.stub(:formatter_for) { formatter }
 
@@ -1074,6 +1082,42 @@ describe Grape::API do
     end
   end
 
+  describe '.rescue_from klass, lambda' do
+    it 'rescues an error with the lambda' do
+      subject.rescue_from ArgumentError, lambda {
+        rack_response("rescued with a lambda", 400)
+      }
+      subject.get('/rescue_lambda') { raise ArgumentError }
+
+      get '/rescue_lambda'
+      last_response.status.should == 400
+      last_response.body.should == "rescued with a lambda"
+    end
+
+    it 'can execute the lambda with an argument' do
+      subject.rescue_from ArgumentError, lambda {|e|
+        rack_response(e.message, 400)
+      }
+      subject.get('/rescue_lambda') { raise ArgumentError, 'lambda takes an argument' }
+
+      get '/rescue_lambda'
+      last_response.status.should == 400
+      last_response.body.should == 'lambda takes an argument'
+    end
+  end
+
+  describe '.rescue_from klass, with: method' do
+    it 'rescues an error with the specified message' do
+      def rescue_arg_error; Rack::Response.new('rescued with a method', 400); end
+      subject.rescue_from ArgumentError, with: rescue_arg_error
+      subject.get('/rescue_method') { raise ArgumentError }
+
+      get '/rescue_method'
+      last_response.status.should == 400
+      last_response.body.should == 'rescued with a method'
+    end
+  end
+
   describe '.error_format' do
     it 'rescues all errors and return :txt' do
       subject.rescue_from :all
@@ -1139,6 +1183,27 @@ describe Grape::API do
       end
     end
 
+    describe 'with' do
+      context 'class' do
+        before :each do
+          class CustomErrorFormatter
+            def self.call(message, backtrace, option, env)
+              "message: #{message} @backtrace"
+            end
+          end
+        end
+
+        it 'returns a custom error format' do
+          subject.rescue_from :all, backtrace: true
+          subject.error_formatter :txt, with: CustomErrorFormatter
+          subject.get('/exception') { raise "rain!" }
+
+          get '/exception'
+          last_response.body.should == 'message: rain! @backtrace'
+        end
+      end
+    end
+
     it 'rescues all errors and return :json' do
       subject.rescue_from :all
       subject.format :json