grape 1.0.0 → 1.0.1

data/lib/grape/middleware/formatter.rb

@@ -45,7 +45,7 @@ module Grape
           Rack::Response.new(bodymap, status, headers)
         end
       rescue Grape::Exceptions::InvalidFormatter => e
-        throw :error, status: 500, message: e.message
+        throw :error, status: 500, message: e.message, backtrace: e.backtrace, original_exception: e
       end
 
       def fetch_formatter(headers, options)
@@ -110,7 +110,7 @@ module Grape
           rescue Grape::Exceptions::Base => e
             raise e
           rescue StandardError => e
-            throw :error, status: 400, message: e.message
+            throw :error, status: 400, message: e.message, backtrace: e.backtrace, original_exception: e
           end
         else
           env[Grape::Env::API_REQUEST_BODY] = body

data/lib/grape/validations/params_scope.rb

@@ -46,7 +46,11 @@ module Grape
         parent.should_validate?(parameters)
       end
 
-      def meets_dependency?(params)
+      def meets_dependency?(params, request_params)
+        if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)
+          return false
+        end
+
         return true unless @dependent_on
 
         params = params.with_indifferent_access
@@ -111,10 +115,15 @@ module Grape
 
       # Adds a parameter declaration to our list of validations.
       # @param attrs [Array] (see Grape::DSL::Parameters#requires)
-      def push_declared_params(attrs)
+      def push_declared_params(attrs, **opts)
         if lateral?
           @parent.push_declared_params(attrs)
         else
+          if opts && opts[:as]
+            @api.route_setting(:aliased_params, @api.route_setting(:aliased_params) || [])
+            @api.route_setting(:aliased_params) << { attrs.first => opts[:as] }
+          end
+
           @declared_params.concat attrs
         end
       end

data/lib/grape/validations/validators/as.rb

@@ -0,0 +1,15 @@
+module Grape
+  module Validations
+    class AsValidator < Base
+      def initialize(attrs, options, required, scope, opts = {})
+        @alias = options
+        super
+      end
+
+      def validate_param!(attr_name, params)
+        params[@alias] = params[attr_name]
+        params.delete(attr_name)
+      end
+    end
+  end
+end

data/lib/grape/validations/validators/base.rb

@@ -39,7 +39,7 @@ module Grape
         array_errors = []
         attributes.each do |resource_params, attr_name|
           next unless @required || (resource_params.respond_to?(:key?) && resource_params.key?(attr_name))
-          next unless @scope.meets_dependency?(resource_params)
+          next unless @scope.meets_dependency?(resource_params, params)
 
           begin
             validate_param!(attr_name, resource_params)

data/lib/grape/validations/validators/values.rb

@@ -32,7 +32,7 @@ module Grape
           unless check_excepts(param_array)
 
         raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:values) \
-          unless check_values(param_array)
+          unless check_values(param_array, attr_name)
 
         raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:values) \
           if @proc && !param_array.all? { |param| @proc.call(param) }
@@ -40,10 +40,15 @@ module Grape
 
       private
 
-      def check_values(param_array)
+      def check_values(param_array, attr_name)
         values = @values.is_a?(Proc) && @values.arity.zero? ? @values.call : @values
         return true if values.nil?
-        return param_array.all? { |param| values.call(param) } if values.is_a? Proc
+        begin
+          return param_array.all? { |param| values.call(param) } if values.is_a? Proc
+        rescue StandardError => e
+          warn "Error '#{e}' raised while validating attribute '#{attr_name}'"
+          return false
+        end
         param_array.all? { |param| values.include?(param) }
       end
 

data/lib/grape/version.rb

@@ -1,4 +1,4 @@
 module Grape
   # The current version of Grape.
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/spec/grape/api/inherited_helpers_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe Grape::API::Helpers do
+  let(:user) { 'Miguel Caneo' }
+  let(:id)   { '42' }
+
+  module InheritedHelpersSpec
+    class SuperClass < Grape::API
+      helpers do
+        params(:superclass_params) { requires :id, type: String }
+
+        def current_user
+          params[:user]
+        end
+      end
+    end
+
+    class OverriddenSubClass < SuperClass
+      params { use :superclass_params }
+
+      helpers do
+        def current_user
+          "#{params[:user]} with id"
+        end
+      end
+
+      get 'resource' do
+        "#{current_user}: #{params['id']}"
+      end
+    end
+
+    class SubClass < SuperClass
+      params { use :superclass_params }
+
+      get 'resource' do
+        "#{current_user}: #{params['id']}"
+      end
+    end
+
+    class Example < SubClass
+      params { use :superclass_params }
+
+      get 'resource' do
+        "#{current_user}: #{params['id']}"
+      end
+    end
+  end
+
+  context 'non overriding subclass' do
+    subject { InheritedHelpersSpec::SubClass }
+
+    def app
+      subject
+    end
+
+    context 'given expected params' do
+      it 'inherits helpers from a superclass' do
+        get '/resource', id: id, user: user
+        expect(last_response.body).to eq("#{user}: #{id}")
+      end
+    end
+
+    context 'with lack of expected params' do
+      it 'returns missing error' do
+        get '/resource'
+        expect(last_response.body).to eq('id is missing')
+      end
+    end
+  end
+
+  context 'overriding subclass' do
+    subject { InheritedHelpersSpec::OverriddenSubClass }
+
+    def app
+      subject
+    end
+
+    context 'given expected params' do
+      it 'overrides helpers from a superclass' do
+        get '/resource', id: id, user: user
+        expect(last_response.body).to eq("#{user} with id: #{id}")
+      end
+    end
+
+    context 'with lack of expected params' do
+      it 'returns missing error' do
+        get '/resource'
+        expect(last_response.body).to eq('id is missing')
+      end
+    end
+  end
+
+  context 'example subclass' do
+    subject { InheritedHelpersSpec::Example }
+
+    def app
+      subject
+    end
+
+    context 'given expected params' do
+      it 'inherits helpers from a superclass' do
+        get '/resource', id: id, user: user
+        expect(last_response.body).to eq("#{user}: #{id}")
+      end
+    end
+
+    context 'with lack of expected params' do
+      it 'returns missing error' do
+        get '/resource'
+        expect(last_response.body).to eq('id is missing')
+      end
+    end
+  end
+end

data/spec/grape/api_spec.rb

@@ -1996,7 +1996,7 @@ XML
       before :each do
         module ApiSpec
           class CustomErrorFormatter
-            def self.call(message, _backtrace, _options, _env)
+            def self.call(message, _backtrace, _options, _env, _original_exception)
               "message: #{message} @backtrace"
             end
           end
@@ -2018,7 +2018,7 @@ XML
         before :each do
           module ApiSpec
             class CustomErrorFormatter
-              def self.call(message, _backtrace, _option, _env)
+              def self.call(message, _backtrace, _option, _env, _original_exception)
                 "message: #{message} @backtrace"
               end
             end

data/spec/grape/dsl/helpers_spec.rb

@@ -24,6 +24,12 @@ module Grape
       end
     end
 
+    class Base < Grape::API
+      helpers BooleanParam
+    end
+
+    class Child < Base; end
+
     describe Helpers do
       subject { Class.new(HelpersSpec::Dummy) }
       let(:proc) do
@@ -74,6 +80,19 @@ module Grape
             expect(subject.first_mod::Boolean).to eq Virtus::Attribute::Boolean
           end
         end
+
+        context 'in child classes' do
+          it 'is available' do
+            klass = Child
+            expect do
+              klass.instance_eval do
+                params do
+                  use :requires_toggle_prm
+                end
+              end
+            end.to_not raise_exception
+          end
+        end
       end
     end
   end

data/spec/grape/dsl/parameters_spec.rb

@@ -15,7 +15,7 @@ module Grape
           @validate_attributes
         end
 
-        def push_declared_params(*args)
+        def push_declared_params(args, **_opts)
           @push_declared_params = args
         end
 
@@ -84,7 +84,7 @@ module Grape
           subject.requires :id, type: Integer, desc: 'Identity.'
 
           expect(subject.validate_attributes_reader).to eq([[:id], { type: Integer, desc: 'Identity.', presence: { value: true, message: nil } }])
-          expect(subject.push_declared_params_reader).to eq([[:id]])
+          expect(subject.push_declared_params_reader).to eq([:id])
         end
       end
 
@@ -93,7 +93,7 @@ module Grape
           subject.optional :id, type: Integer, desc: 'Identity.'
 
           expect(subject.validate_attributes_reader).to eq([[:id], { type: Integer, desc: 'Identity.' }])
-          expect(subject.push_declared_params_reader).to eq([[:id]])
+          expect(subject.push_declared_params_reader).to eq([:id])
         end
       end
 
@@ -102,7 +102,7 @@ module Grape
           subject.with(type: Integer) { subject.optional :id, desc: 'Identity.' }
 
           expect(subject.validate_attributes_reader).to eq([[:id], { type: Integer, desc: 'Identity.' }])
-          expect(subject.push_declared_params_reader).to eq([[:id]])
+          expect(subject.push_declared_params_reader).to eq([:id])
         end
       end
 

data/spec/grape/middleware/exception_spec.rb

@@ -50,147 +50,241 @@ describe Grape::Middleware::Error do
     end
   end
 
-  attr_reader :app
+  def app
+    subject
+  end
 
-  it 'does not trap errors by default' do
-    @app ||= Rack::Builder.app do
-      use Spec::Support::EndpointFaker
-      use Grape::Middleware::Error
-      run ExceptionSpec::ExceptionApp
+  context 'with defaults' do
+    subject do
+      Rack::Builder.app do
+        use Spec::Support::EndpointFaker
+        use Grape::Middleware::Error
+        run ExceptionSpec::ExceptionApp
+      end
+    end
+    it 'does not trap errors by default' do
+      expect { get '/' }.to raise_error(RuntimeError, 'rain!')
     end
-    expect { get '/' }.to raise_error(RuntimeError, 'rain!')
   end
 
-  context 'with rescue_all set to true' do
-    it 'sets the message appropriately' do
-      @app ||= Rack::Builder.app do
+  context 'with rescue_all' do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true
         run ExceptionSpec::ExceptionApp
       end
+    end
+    it 'sets the message appropriately' do
       get '/'
       expect(last_response.body).to eq('rain!')
     end
-
     it 'defaults to a 500 status' do
-      @app ||= Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error, rescue_all: true
-        run ExceptionSpec::ExceptionApp
-      end
       get '/'
       expect(last_response.status).to eq(500)
     end
+  end
 
-    it 'is possible to specify a different default status code' do
-      @app ||= Rack::Builder.app do
+  context do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, default_status: 500
         run ExceptionSpec::ExceptionApp
       end
+    end
+    it 'is possible to specify a different default status code' do
       get '/'
       expect(last_response.status).to eq(500)
     end
+  end
 
-    it 'is possible to return errors in json format' do
-      @app ||= Rack::Builder.app do
+  context do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :json
         run ExceptionSpec::ExceptionApp
       end
+    end
+    it 'is possible to return errors in json format' do
       get '/'
       expect(last_response.body).to eq('{"error":"rain!"}')
     end
+  end
 
-    it 'is possible to return hash errors in json format' do
-      @app ||= Rack::Builder.app do
+  context do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :json
         run ExceptionSpec::ErrorHashApp
       end
+    end
+    it 'is possible to return hash errors in json format' do
       get '/'
       expect(['{"error":"rain!","detail":"missing widget"}',
               '{"detail":"missing widget","error":"rain!"}']).to include(last_response.body)
     end
+  end
 
-    it 'is possible to return errors in jsonapi format' do
-      @app ||= Rack::Builder.app do
+  context do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :jsonapi
         run ExceptionSpec::ExceptionApp
       end
+    end
+    it 'is possible to return errors in jsonapi format' do
       get '/'
       expect(last_response.body).to eq('{"error":"rain!"}')
     end
+  end
 
-    it 'is possible to return hash errors in jsonapi format' do
-      @app ||= Rack::Builder.app do
+  context do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :jsonapi
         run ExceptionSpec::ErrorHashApp
       end
+    end
+
+    it 'is possible to return hash errors in jsonapi format' do
       get '/'
       expect(['{"error":"rain!","detail":"missing widget"}',
               '{"detail":"missing widget","error":"rain!"}']).to include(last_response.body)
     end
+  end
 
-    it 'is possible to return errors in xml format' do
-      @app ||= Rack::Builder.app do
+  context do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :xml
         run ExceptionSpec::ExceptionApp
       end
+    end
+    it 'is possible to return errors in xml format' do
       get '/'
       expect(last_response.body).to eq("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <message>rain!</message>\n</error>\n")
     end
+  end
 
-    it 'is possible to return hash errors in xml format' do
-      @app ||= Rack::Builder.app do
+  context do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :xml
         run ExceptionSpec::ErrorHashApp
       end
+    end
+    it 'is possible to return hash errors in xml format' do
       get '/'
       expect(["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <detail>missing widget</detail>\n  <error>rain!</error>\n</error>\n",
               "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <error>rain!</error>\n  <detail>missing widget</detail>\n</error>\n"]).to include(last_response.body)
     end
+  end
 
-    it 'is possible to specify a custom formatter' do
-      @app ||= Rack::Builder.app do
+  context do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error, rescue_all: true,
-                                      format: :custom,
-                                      error_formatters: {
-                                        custom: lambda do |message, _backtrace, _options, _env|
-                                          { custom_formatter: message }.inspect
-                                        end
-                                      }
+        use Grape::Middleware::Error,
+            rescue_all: true,
+            format: :custom,
+            error_formatters: {
+              custom: lambda do |message, _backtrace, _options, _env, _original_exception|
+                { custom_formatter: message }.inspect
+              end
+            }
         run ExceptionSpec::ExceptionApp
       end
+    end
+    it 'is possible to specify a custom formatter' do
       get '/'
       expect(last_response.body).to eq('{:custom_formatter=>"rain!"}')
     end
+  end
 
-    it 'does not trap regular error! codes' do
-      @app ||= Rack::Builder.app do
+  context do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error
         run ExceptionSpec::AccessDeniedApp
       end
+    end
+    it 'does not trap regular error! codes' do
       get '/'
       expect(last_response.status).to eq(401)
     end
+  end
 
-    it 'responds to custom Grape exceptions appropriately' do
-      @app ||= Rack::Builder.app do
+  context do
+    subject do
+      Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: false
         run ExceptionSpec::CustomErrorApp
       end
-
+    end
+    it 'responds to custom Grape exceptions appropriately' do
       get '/'
       expect(last_response.status).to eq(400)
       expect(last_response.body).to eq('failed validation')
     end
   end
+
+  context 'with rescue_options :backtrace and :exception set to true' do
+    subject do
+      Rack::Builder.app do
+        use Spec::Support::EndpointFaker
+        use Grape::Middleware::Error,
+            rescue_all: true,
+            format: :json,
+            rescue_options: { backtrace: true, original_exception: true }
+        run ExceptionSpec::ExceptionApp
+      end
+    end
+    it 'is possible to return the backtrace and the original exception in json format' do
+      get '/'
+      expect(last_response.body).to include('error', 'rain!', 'backtrace', 'original_exception', 'RuntimeError')
+    end
+  end
+
+  context do
+    subject do
+      Rack::Builder.app do
+        use Spec::Support::EndpointFaker
+        use Grape::Middleware::Error,
+            rescue_all: true,
+            format: :xml,
+            rescue_options: { backtrace: true, original_exception: true }
+        run ExceptionSpec::ExceptionApp
+      end
+    end
+    it 'is possible to return the backtrace and the original exception in xml format' do
+      get '/'
+      expect(last_response.body).to include('error', 'rain!', 'backtrace', 'original-exception', 'RuntimeError')
+    end
+  end
+
+  context do
+    subject do
+      Rack::Builder.app do
+        use Spec::Support::EndpointFaker
+        use Grape::Middleware::Error,
+            rescue_all: true,
+            format: :txt,
+            rescue_options: { backtrace: true, original_exception: true }
+        run ExceptionSpec::ExceptionApp
+      end
+    end
+    it 'is possible to return the backtrace and the original exception in txt format' do
+      get '/'
+      expect(last_response.body).to include('error', 'rain!', 'backtrace', 'original exception', 'RuntimeError')
+    end
+  end
 end