grape 1.2.5 → 1.4.0

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

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class SameAsValidator < Base
       def validate_param!(attr_name, params)
         confirmation = options_key?(:value) ? @option[:value] : @option
         return if params[attr_name] == params[confirmation]
-        raise Grape::Exceptions::Validation,
-              params: [@scope.full_name(attr_name)],
-              message: build_message
+        raise Grape::Exceptions::Validation.new(
+          params: [@scope.full_name(attr_name)],
+          message: build_message
+        )
       end
 
       private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class ValuesValidator < Base
@@ -24,17 +26,23 @@ module Grape
 
       def validate_param!(attr_name, params)
         return unless params.is_a?(Hash)
-        return unless params[attr_name] || required_for_root_scope?
 
-        param_array = params[attr_name].nil? ? [nil] : Array.wrap(params[attr_name])
+        val = params[attr_name]
+
+        return if val.nil? && !required_for_root_scope?
+
+        # don't forget that +false.blank?+ is true
+        return if val != false && val.blank? && @allow_blank
 
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: except_message \
+        param_array = val.nil? ? [nil] : Array.wrap(val)
+
+        raise validation_exception(attr_name, except_message) \
           unless check_excepts(param_array)
 
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:values) \
+        raise validation_exception(attr_name, message(:values)) \
           unless check_values(param_array, attr_name)
 
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:values) \
+        raise validation_exception(attr_name, message(:values)) \
           if @proc && !param_array.all? { |param| @proc.call(param) }
       end
 
@@ -66,6 +74,10 @@ module Grape
       def required_for_root_scope?
         @required && @scope.root?
       end
+
+      def validation_exception(attr_name, message)
+        Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message)
+      end
     end
   end
 end

data/lib/grape/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Grape
   # The current version of Grape.
-  VERSION = '1.2.5'.freeze
+  VERSION = '1.4.0'
 end

data/spec/grape/api/custom_validations_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Validations do
@@ -8,7 +10,7 @@ describe Grape::Validations do
           def validate_param!(attr_name, params)
             @option = params[:max].to_i if params.key?(:max)
             return if params[attr_name].length <= @option
-            raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long"
+            raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long")
           end
         end
       end
@@ -87,7 +89,7 @@ describe Grape::Validations do
       module CustomValidationsSpec
         class WithMessageKey < Grape::Validations::PresenceValidator
           def validate_param!(attr_name, _params)
-            raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: :presence
+            raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: :presence)
           end
         end
       end
@@ -126,7 +128,7 @@ describe Grape::Validations do
             return unless @option
             # check if user is admin or not
             # as an example get a token from request and check if it's admin or not
-            raise Grape::Exceptions::Validation, params: @attrs, message: 'Can not set Admin only field.' unless request.headers['X-Access-Token'] == 'admin'
+            raise Grape::Exceptions::Validation.new(params: @attrs, message: 'Can not set Admin only field.') unless request.headers['X-Access-Token'] == 'admin'
           end
         end
       end

data/spec/grape/api/deeply_included_options_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module DeeplyIncludedOptionsSpec

data/spec/grape/api/defines_boolean_in_params_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::API::Instance do
@@ -21,7 +23,7 @@ describe Grape::API::Instance do
       { class: 'TrueClass', value: true }.to_s
     end
 
-    it 'sets Boolean as a Virtus::Attribute::Boolean' do
+    it 'sets Boolean as a type' do
       post '/echo?message=true'
       expect(last_response.status).to eq(201)
       expect(last_response.body).to eq expected_body
@@ -29,8 +31,8 @@ describe Grape::API::Instance do
 
     context 'Params endpoint type' do
       subject { DefinesBooleanInstanceSpec::API.new.router.map['POST'].first.options[:params]['message'][:type] }
-      it 'params type is a Virtus::Attribute::Boolean' do
-        is_expected.to eq 'Virtus::Attribute::Boolean'
+      it 'params type is a boolean' do
+        is_expected.to eq 'Grape::API::Boolean'
       end
     end
   end

data/spec/grape/api/inherited_helpers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::API::Helpers do

data/spec/grape/api/instance_spec.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'shared/versioning_examples'
+
+describe Grape::API::Instance do
+  subject(:an_instance) do
+    Class.new(Grape::API::Instance) do
+      namespace :some_namespace do
+        get 'some_endpoint' do
+          'success'
+        end
+      end
+    end
+  end
+
+  let(:root_api) do
+    to_mount = an_instance
+    Class.new(Grape::API) do
+      mount to_mount
+    end
+  end
+
+  def app
+    root_api
+  end
+
+  context 'when an instance is mounted on the root' do
+    it 'can call the instance endpoint' do
+      get '/some_namespace/some_endpoint'
+      expect(last_response.body).to eq 'success'
+    end
+  end
+
+  context 'when an instance is the root' do
+    let(:root_api) do
+      to_mount = an_instance
+      Class.new(Grape::API::Instance) do
+        mount to_mount
+      end
+    end
+
+    it 'can call the instance endpoint' do
+      get '/some_namespace/some_endpoint'
+      expect(last_response.body).to eq 'success'
+    end
+  end
+
+  context 'top level setting' do
+    it 'does not inherit settings from the superclass (Grape::API::Instance)' do
+      expect(an_instance.top_level_setting.parent).to be_nil
+    end
+  end
+
+  context 'with multiple moutes' do
+    let(:first) do
+      Class.new(Grape::API::Instance) do
+        namespace(:some_namespace) do
+          route :any, '*path' do
+            error!('Not found! (1)', 404)
+          end
+        end
+      end
+    end
+    let(:second) do
+      Class.new(Grape::API::Instance) do
+        namespace(:another_namespace) do
+          route :any, '*path' do
+            error!('Not found! (2)', 404)
+          end
+        end
+      end
+    end
+    let(:root_api) do
+      first_instance = first
+      second_instance = second
+      Class.new(Grape::API) do
+        mount first_instance
+        mount first_instance
+        mount second_instance
+      end
+    end
+
+    it 'does not raise a FrozenError on first instance' do
+      expect { patch '/some_namespace/anything' }.not_to \
+        raise_error
+    end
+
+    it 'responds the correct body at the first instance' do
+      patch '/some_namespace/anything'
+      expect(last_response.body).to eq 'Not found! (1)'
+    end
+
+    it 'does not raise a FrozenError on second instance' do
+      expect { get '/another_namespace/other' }.not_to \
+        raise_error
+    end
+
+    it 'responds the correct body at the second instance' do
+      get '/another_namespace/foobar'
+      expect(last_response.body).to eq 'Not found! (2)'
+    end
+  end
+end

data/spec/grape/api/invalid_format_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do

data/spec/grape/api/namespace_parameters_in_route_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do

data/spec/grape/api/nested_helpers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::API::Helpers do

data/spec/grape/api/optional_parameters_in_route_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do

data/spec/grape/api/parameters_modification_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do
@@ -10,7 +12,7 @@ describe Grape::Endpoint do
   before do
     subject.namespace :test do
       params do
-        optional :foo, default: '-abcdef'
+        optional :foo, default: +'-abcdef'
       end
       get do
         params[:foo].slice!(0)

data/spec/grape/api/patch_method_helpers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::API::Helpers do

data/spec/grape/api/recognize_path_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::API do

data/spec/grape/api/required_parameters_in_route_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do

data/spec/grape/api/required_parameters_with_invalid_method_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do

data/spec/grape/api/routes_with_requirements_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do

data/spec/grape/api/shared_helpers_exactly_one_of_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::API::Helpers do

data/spec/grape/api/shared_helpers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::API::Helpers do

data/spec/grape/api_remount_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'shared/versioning_examples'
 

data/spec/grape/api_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'shared/versioning_examples'
 
@@ -814,6 +816,71 @@ XML
       end
     end
 
+    describe 'when hook behaviour is controlled by attributes on the route ' do
+      before do
+        subject.before do
+          error!('Access Denied', 401) unless route.options[:secret] == params[:secret]
+        end
+
+        subject.namespace 'example' do
+          before do
+            error!('Access Denied', 401) unless route.options[:namespace_secret] == params[:namespace_secret]
+          end
+
+          desc 'it gets with secret', secret: 'password'
+          get { status(params[:id] == '504' ? 200 : 404) }
+
+          desc 'it post with secret', secret: 'password', namespace_secret: 'namespace_password'
+          post {}
+        end
+      end
+
+      context 'when HTTP method is not defined' do
+        let(:response) { delete('/example') }
+
+        it 'responds with a 405 status' do
+          expect(response.status).to eql 405
+        end
+      end
+
+      context 'when HTTP method is defined with attribute' do
+        let(:response) { post('/example?secret=incorrect_password') }
+        it 'responds with the defined error in the before hook' do
+          expect(response.status).to eql 401
+        end
+      end
+
+      context 'when HTTP method is defined and the underlying before hook expectation is not met' do
+        let(:response) { post('/example?secret=password&namespace_secret=wrong_namespace_password') }
+        it 'ends up in the endpoint' do
+          expect(response.status).to eql 401
+        end
+      end
+
+      context 'when HTTP method is defined and everything is like the before hooks expect' do
+        let(:response) { post('/example?secret=password&namespace_secret=namespace_password') }
+        it 'ends up in the endpoint' do
+          expect(response.status).to eql 201
+        end
+      end
+
+      context 'when HEAD is called for the defined GET' do
+        let(:response) { head('/example?id=504') }
+
+        it 'responds with 401 because before expectations in before hooks are not met' do
+          expect(response.status).to eql 401
+        end
+      end
+
+      context 'when HEAD is called for the defined GET' do
+        let(:response) { head('/example?id=504&secret=password') }
+
+        it 'responds with 200 because before hooks are not called' do
+          expect(response.status).to eql 200
+        end
+      end
+    end
+
     context 'allows HEAD on a GET request that' do
       before do
         subject.get 'example' do
@@ -933,7 +1000,7 @@ XML
 
     it 'adds a before filter to current and child namespaces only' do
       subject.get '/' do
-        "root - #{@foo}"
+        "root - #{instance_variable_defined?(:@foo) ? @foo : nil}"
       end
       subject.namespace :blah do
         before { @foo = 'foo' }
@@ -1133,7 +1200,7 @@ XML
 
       subject.use Rack::Chunked
       subject.get('/stream') { stream test_stream }
-      get '/stream', {}, 'HTTP_VERSION' => 'HTTP/1.1'
+      get '/stream', {}, 'HTTP_VERSION' => 'HTTP/1.1', 'SERVER_PROTOCOL' => 'HTTP/1.1'
 
       expect(last_response.headers['Content-Type']).to eq('text/plain')
       expect(last_response.headers['Content-Length']).to eq(nil)
@@ -1901,9 +1968,9 @@ XML
       it 'avoids polluting global namespace' do
         env = Rack::MockRequest.env_for('/')
 
-        expect(a.call(env)[2].body).to eq(['foo'])
-        expect(b.call(env)[2].body).to eq(['bar'])
-        expect(a.call(env)[2].body).to eq(['foo'])
+        expect(read_chunks(a.call(env)[2])).to eq(['foo'])
+        expect(read_chunks(b.call(env)[2])).to eq(['bar'])
+        expect(read_chunks(a.call(env)[2])).to eq(['foo'])
       end
     end
 
@@ -1940,6 +2007,26 @@ XML
       expect { get '/unrescued' }.to raise_error(RuntimeError, 'beefcake')
     end
 
+    it 'mimics default ruby "rescue" handler' do
+      # The exception is matched to the rescue starting at the top, and matches only once
+
+      subject.rescue_from ArgumentError do |e|
+        error!(e, 402)
+      end
+      subject.rescue_from StandardError do |e|
+        error!(e, 401)
+      end
+
+      subject.get('/child_of_standard_error') { raise ArgumentError }
+      subject.get('/standard_error') { raise StandardError }
+
+      get '/child_of_standard_error'
+      expect(last_response.status).to eql 402
+
+      get '/standard_error'
+      expect(last_response.status).to eql 401
+    end
+
     context 'CustomError subclass of Grape::Exceptions::Base' do
       before do
         module ApiSpec
@@ -1958,7 +2045,7 @@ XML
           rack_response('New Error', e.status)
         end
         subject.get '/custom_error' do
-          raise ApiSpec::CustomError, status: 400, message: 'Custom Error'
+          raise ApiSpec::CustomError.new(status: 400, message: 'Custom Error')
         end
 
         get '/custom_error'
@@ -3655,12 +3742,13 @@ XML
       end
     end
     context ':serializable_hash' do
-      before(:each) do
-        class SerializableHashExample
-          def serializable_hash
-            { abc: 'def' }
-          end
+      class SerializableHashExample
+        def serializable_hash
+          { abc: 'def' }
         end
+      end
+
+      before(:each) do
         subject.format :serializable_hash
       end
       it 'instance' do