grape 1.5.0 → 1.6.0

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

@@ -13,6 +13,7 @@ module Grape
                'Use the except validator instead.' if @excepts
 
           raise ArgumentError, 'proc must be a Proc' if @proc && !@proc.is_a?(Proc)
+
           warn '[DEPRECATION] The values validator proc option is deprecated. ' \
                'The lambda expression can now be assigned directly to values.' if @proc
         else
@@ -51,6 +52,7 @@ module Grape
       def check_values(param_array, attr_name)
         values = @values.is_a?(Proc) && @values.arity.zero? ? @values.call : @values
         return true if values.nil?
+
         begin
           return param_array.all? { |param| values.call(param) } if values.is_a? Proc
         rescue StandardError => e
@@ -63,6 +65,7 @@ module Grape
       def check_excepts(param_array)
         excepts = @excepts.is_a?(Proc) ? @excepts.call : @excepts
         return true if excepts.nil?
+
         param_array.none? { |param| excepts.include?(param) }
       end
 

data/lib/grape/version.rb

@@ -2,5 +2,5 @@
 
 module Grape
   # The current version of Grape.
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/lib/grape.rb

@@ -12,6 +12,7 @@ require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/array/wrap'
+require 'active_support/core_ext/array/conversions'
 require 'active_support/core_ext/hash/deep_merge'
 require 'active_support/core_ext/hash/reverse_merge'
 require 'active_support/core_ext/hash/except'
@@ -21,7 +22,7 @@ require 'active_support/dependencies/autoload'
 require 'active_support/notifications'
 require 'i18n'
 
-I18n.load_path << File.expand_path('../grape/locale/en.yml', __FILE__)
+I18n.load_path << File.expand_path('grape/locale/en.yml', __dir__)
 
 module Grape
   extend ::ActiveSupport::Autoload
@@ -75,6 +76,7 @@ module Grape
       autoload :InvalidVersionHeader
       autoload :MethodNotAllowed
       autoload :InvalidResponse
+      autoload :EmptyMessageBody
     end
   end
 

data/spec/grape/api/custom_validations_spec.rb

@@ -10,6 +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.new(params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long")
           end
         end

data/spec/grape/api/routes_with_requirements_spec.rb

@@ -11,7 +11,7 @@ describe Grape::Endpoint do
 
   context 'get' do
     it 'routes to a namespace param with dots' do
-      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^\/]+} } do
+      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^/]+} } do
         get '/' do
           params[:ns_with_dots]
         end
@@ -23,8 +23,8 @@ describe Grape::Endpoint do
     end
 
     it 'routes to a path with multiple params with dots' do
-      subject.get ':id_with_dots/:another_id_with_dots', requirements: { id_with_dots: %r{[^\/]+},
-                                                                         another_id_with_dots: %r{[^\/]+} } do
+      subject.get ':id_with_dots/:another_id_with_dots', requirements: { id_with_dots: %r{[^/]+},
+                                                                         another_id_with_dots: %r{[^/]+} } do
         "#{params[:id_with_dots]}/#{params[:another_id_with_dots]}"
       end
 
@@ -34,9 +34,9 @@ describe Grape::Endpoint do
     end
 
     it 'routes to namespace and path params with dots, with overridden requirements' do
-      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^\/]+} } do
-        get ':another_id_with_dots',     requirements: { ns_with_dots: %r{[^\/]+},
-                                                         another_id_with_dots: %r{[^\/]+} } do
+      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^/]+} } do
+        get ':another_id_with_dots',     requirements: { ns_with_dots: %r{[^/]+},
+                                                         another_id_with_dots: %r{[^/]+} } do
           "#{params[:ns_with_dots]}/#{params[:another_id_with_dots]}"
         end
       end
@@ -47,8 +47,8 @@ describe Grape::Endpoint do
     end
 
     it 'routes to namespace and path params with dots, with merged requirements' do
-      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^\/]+} } do
-        get ':another_id_with_dots',     requirements: { another_id_with_dots: %r{[^\/]+} } do
+      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^/]+} } do
+        get ':another_id_with_dots',     requirements: { another_id_with_dots: %r{[^/]+} } do
           "#{params[:ns_with_dots]}/#{params[:another_id_with_dots]}"
         end
       end

data/spec/grape/api_remount_spec.rb

@@ -340,19 +340,24 @@ describe Grape::API do
       context 'when the configuration is read within a namespace' do
         before do
           a_remounted_api.namespace 'api' do
+            params do
+              requires configuration[:required_param]
+            end
             get "/#{configuration[:path]}" do
               '10 votes'
             end
           end
-          root_api.mount a_remounted_api, with: { path: 'votes' }
-          root_api.mount a_remounted_api, with: { path: 'scores' }
+          root_api.mount a_remounted_api, with: { path: 'votes', required_param: 'param_key' }
+          root_api.mount a_remounted_api, with: { path: 'scores', required_param: 'param_key' }
         end
 
         it 'will use the dynamic configuration on all routes' do
-          get 'api/votes'
+          get 'api/votes', param_key: 'a'
           expect(last_response.body).to eql '10 votes'
-          get 'api/scores'
+          get 'api/scores', param_key: 'a'
           expect(last_response.body).to eql '10 votes'
+          get 'api/votes'
+          expect(last_response.status).to eq 400
         end
       end
 

data/spec/grape/api_spec.rb

@@ -610,6 +610,7 @@ describe Grape::API do
       subject.namespace :example do
         before do
           raise 'before filter ran twice' if already_run
+
           already_run = true
           header 'X-Custom-Header', 'foo'
         end
@@ -650,12 +651,12 @@ describe Grape::API do
 
         put '/example'
         expect(last_response.status).to eql 405
-        expect(last_response.body).to eq <<-XML
-<?xml version="1.0" encoding="UTF-8"?>
-<error>
-  <message>405 Not Allowed</message>
-</error>
-XML
+        expect(last_response.body).to eq <<~XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <error>
+            <message>405 Not Allowed</message>
+          </error>
+        XML
       end
     end
 
@@ -749,6 +750,47 @@ XML
       end
     end
 
+    describe 'when a resource routes by POST, GET, PATCH, PUT, and DELETE' do
+      before do
+        subject.namespace :example do
+          get do
+            'example'
+          end
+
+          patch do
+            'example'
+          end
+
+          post do
+            'example'
+          end
+
+          delete do
+            'example'
+          end
+
+          put do
+            'example'
+          end
+        end
+        options '/example'
+      end
+
+      describe 'it adds an OPTIONS route for namespaced endpoints that' do
+        it 'returns a 204' do
+          expect(last_response.status).to eql 204
+        end
+
+        it 'has an empty body' do
+          expect(last_response.body).to be_blank
+        end
+
+        it 'has an Allow header' do
+          expect(last_response.headers['Allow']).to eql 'OPTIONS, GET, PATCH, POST, DELETE, PUT, HEAD'
+        end
+      end
+    end
+
     describe 'adds an OPTIONS route for namespaced endpoints that' do
       before do
         subject.before { header 'X-Custom-Header', 'foo' }
@@ -2106,7 +2148,9 @@ XML
     context 'custom errors' do
       before do
         class ConnectionError < RuntimeError; end
+
         class DatabaseError < RuntimeError; end
+
         class CommunicationError < StandardError; end
       end
 
@@ -2262,6 +2306,7 @@ XML
       module ApiSpec
         module APIErrors
           class ParentError < StandardError; end
+
           class ChildError < ParentError; end
         end
       end
@@ -3119,10 +3164,10 @@ XML
       subject.get 'method'
 
       expect(subject.routes.map(&:params)).to eq [{
-        'group1'         => { required: true, type: 'Array' },
+        'group1' => { required: true, type: 'Array' },
         'group1[param1]' => { required: false, desc: 'group1 param1 desc' },
         'group1[param2]' => { required: true, desc: 'group1 param2 desc' },
-        'group2'         => { required: true, type: 'Array' },
+        'group2' => { required: true, type: 'Array' },
         'group2[param1]' => { required: false, desc: 'group2 param1 desc' },
         'group2[param2]' => { required: true, desc: 'group2 param2 desc' }
       }]
@@ -3335,8 +3380,8 @@ XML
           mount app
         end
         expect(subject.routes.size).to eq(2)
-        expect(subject.routes.first.path).to match(%r{\/cool\/awesome})
-        expect(subject.routes.last.path).to match(%r{\/cool\/sauce})
+        expect(subject.routes.first.path).to match(%r{/cool/awesome})
+        expect(subject.routes.last.path).to match(%r{/cool/sauce})
       end
 
       it 'mounts on a path' do
@@ -3358,7 +3403,7 @@ XML
         APP2.get '/nice' do
           'play'
         end
-        # note that the reverse won't work, mount from outside-in
+        # NOTE: that the reverse won't work, mount from outside-in
         APP3 = subject
         APP3.mount APP1 => '/app1'
         APP1.mount APP2 => '/app2'
@@ -3549,6 +3594,7 @@ XML
             def self.included(base)
               base.extend(ClassMethods)
             end
+
             module ClassMethods
               def my_method
                 @test = true
@@ -3793,12 +3839,12 @@ XML
         end
         get '/example'
         expect(last_response.status).to eq(500)
-        expect(last_response.body).to eq <<-XML
-<?xml version="1.0" encoding="UTF-8"?>
-<error>
-  <message>cannot convert String to xml</message>
-</error>
-XML
+        expect(last_response.body).to eq <<~XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <error>
+            <message>cannot convert String to xml</message>
+          </error>
+        XML
       end
       it 'hash' do
         subject.get '/example' do
@@ -3809,13 +3855,13 @@ XML
         end
         get '/example'
         expect(last_response.status).to eq(200)
-        expect(last_response.body).to eq <<-XML
-<?xml version="1.0" encoding="UTF-8"?>
-<hash>
-  <example1>example1</example1>
-  <example2>example2</example2>
-</hash>
-XML
+        expect(last_response.body).to eq <<~XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <hash>
+            <example1>example1</example1>
+            <example2>example2</example2>
+          </hash>
+        XML
       end
       it 'array' do
         subject.get '/example' do
@@ -3823,13 +3869,13 @@ XML
         end
         get '/example'
         expect(last_response.status).to eq(200)
-        expect(last_response.body).to eq <<-XML
-<?xml version="1.0" encoding="UTF-8"?>
-<strings type="array">
-  <string>example1</string>
-  <string>example2</string>
-</strings>
-XML
+        expect(last_response.body).to eq <<~XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <strings type="array">
+            <string>example1</string>
+            <string>example2</string>
+          </strings>
+        XML
       end
       it 'raised :error from middleware' do
         middleware = Class.new(Grape::Middleware::Base) do
@@ -3842,12 +3888,12 @@ XML
         end
         get '/'
         expect(last_response.status).to eq(42)
-        expect(last_response.body).to eq <<-XML
-<?xml version="1.0" encoding="UTF-8"?>
-<error>
-  <message>Unauthorized</message>
-</error>
-XML
+        expect(last_response.body).to eq <<~XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <error>
+            <message>Unauthorized</message>
+          </error>
+        XML
       end
     end
   end
@@ -4040,6 +4086,49 @@ XML
     end
   end
 
+  describe '.inherited' do
+    context 'overriding within class' do
+      let(:root_api) do
+        Class.new(Grape::API) do
+          @bar = 'Hello, world'
+
+          def self.inherited(child_api)
+            super
+            child_api.instance_variable_set(:@foo, @bar.dup)
+          end
+        end
+      end
+
+      let(:child_api) { Class.new(root_api) }
+
+      it 'allows overriding the hook' do
+        expect(child_api.instance_variable_get(:@foo)).to eq('Hello, world')
+      end
+    end
+
+    context 'overriding via composition' do
+      module Inherited
+        def inherited(api)
+          super
+          api.instance_variable_set(:@foo, @bar.dup)
+        end
+      end
+
+      let(:root_api) do
+        Class.new(Grape::API) do
+          @bar = 'Hello, world'
+          extend Inherited
+        end
+      end
+
+      let(:child_api) { Class.new(root_api) }
+
+      it 'allows overriding the hook' do
+        expect(child_api.instance_variable_get(:@foo)).to eq('Hello, world')
+      end
+    end
+  end
+
   describe 'const_missing' do
     subject(:grape_api) { Class.new(Grape::API) }
     let(:mounted) do
@@ -4056,4 +4145,81 @@ XML
       expect { get '/const/missing' }.to raise_error(NameError).with_message(/SomeRandomConstant/)
     end
   end
+
+  describe 'custom route helpers on nested APIs' do
+    let(:shared_api_module) do
+      Module.new do
+        # rubocop:disable Style/ExplicitBlockArgument because this causes
+        #   the underlying issue in this form
+        def uniqe_id_route
+          params do
+            use :unique_id
+          end
+          route_param(:id) do
+            yield
+          end
+        end
+        # rubocop:enable Style/ExplicitBlockArgument
+      end
+    end
+    let(:shared_api_definitions) do
+      Module.new do
+        extend ActiveSupport::Concern
+
+        included do
+          helpers do
+            params :unique_id do
+              requires :id, type: String,
+                            allow_blank: false,
+                            regexp: /\d+-\d+/
+            end
+          end
+        end
+      end
+    end
+    let(:orders_root) do
+      shared = shared_api_definitions
+      find = orders_find_endpoint
+      Class.new(Grape::API) do
+        include shared
+
+        namespace(:orders) do
+          mount find
+        end
+      end
+    end
+    let(:orders_find_endpoint) do
+      shared = shared_api_definitions
+      Class.new(Grape::API) do
+        include shared
+
+        uniqe_id_route do
+          desc 'Fetch a single order' do
+            detail 'While specifying the order id on the route'
+          end
+          get { params[:id] }
+        end
+      end
+    end
+    subject(:grape_api) do
+      Class.new(Grape::API) do
+        version 'v1', using: :path
+      end
+    end
+
+    before do
+      Grape::API::Instance.extend(shared_api_module)
+      subject.mount orders_root
+    end
+
+    it 'returns an error when the id is bad' do
+      get '/v1/orders/abc'
+      expect(last_response.body).to be_eql('id is invalid')
+    end
+
+    it 'returns the given id when it is valid' do
+      get '/v1/orders/1-2'
+      expect(last_response.body).to be_eql('1-2')
+    end
+  end
 end

data/spec/grape/dsl/callbacks_spec.rb

@@ -12,7 +12,7 @@ module Grape
 
     describe Callbacks do
       subject { Class.new(CallbacksSpec::Dummy) }
-      let(:proc) { ->() {} }
+      let(:proc) { -> {} }
 
       describe '.before' do
         it 'adds a block to "before"' do

data/spec/grape/dsl/middleware_spec.rb

@@ -12,7 +12,7 @@ module Grape
 
     describe Middleware do
       subject { Class.new(MiddlewareSpec::Dummy) }
-      let(:proc) { ->() {} }
+      let(:proc) { -> {} }
       let(:foo_middleware) { Class.new }
       let(:bar_middleware) { Class.new }
 

data/spec/grape/dsl/parameters_spec.rb

@@ -40,6 +40,7 @@ module Grape
 
         def extract_message_option(attrs)
           return nil unless attrs.is_a?(Array)
+
           opts = attrs.last.is_a?(Hash) ? attrs.pop : {}
           opts.key?(:message) && !opts[:message].nil? ? opts.delete(:message) : nil
         end

data/spec/grape/dsl/routing_spec.rb

@@ -12,7 +12,7 @@ module Grape
 
     describe Routing do
       subject { Class.new(RoutingSpec::Dummy) }
-      let(:proc) { ->() {} }
+      let(:proc) { -> {} }
       let(:options) { { a: :b } }
       let(:path) { '/dummy' }