grape 1.5.3 → 1.6.0

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

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' }
 

data/spec/grape/endpoint/declared_spec.rb

@@ -598,4 +598,251 @@ describe Grape::Endpoint do
       expect(json.key?(:artist_id)).not_to be_truthy
     end
   end
+
+  describe 'parameter renaming' do
+    context 'with a deeply nested parameter structure' do
+      let(:params) do
+        {
+          i_a: 'a',
+          i_b: {
+            i_c: 'c',
+            i_d: {
+              i_e: {
+                i_f: 'f',
+                i_g: 'g',
+                i_h: [
+                  {
+                    i_ha: 'ha1',
+                    i_hb: {
+                      i_hc: 'c'
+                    }
+                  },
+                  {
+                    i_ha: 'ha2',
+                    i_hb: {
+                      i_hc: 'c'
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        }
+      end
+      let(:declared) do
+        {
+          o_a: 'a',
+          o_b: {
+            o_c: 'c',
+            o_d: {
+              o_e: {
+                o_f: 'f',
+                o_g: 'g',
+                o_h: [
+                  {
+                    o_ha: 'ha1',
+                    o_hb: {
+                      o_hc: 'c'
+                    }
+                  },
+                  {
+                    o_ha: 'ha2',
+                    o_hb: {
+                      o_hc: 'c'
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        }
+      end
+      let(:params_keys) do
+        [
+          'i_a',
+          'i_b',
+          'i_b[i_c]',
+          'i_b[i_d]',
+          'i_b[i_d][i_e]',
+          'i_b[i_d][i_e][i_f]',
+          'i_b[i_d][i_e][i_g]',
+          'i_b[i_d][i_e][i_h]',
+          'i_b[i_d][i_e][i_h][i_ha]',
+          'i_b[i_d][i_e][i_h][i_hb]',
+          'i_b[i_d][i_e][i_h][i_hb][i_hc]'
+        ]
+      end
+
+      before do
+        subject.format :json
+        subject.params do
+          optional :i_a, type: String, as: :o_a
+          optional :i_b, type: Hash, as: :o_b do
+            optional :i_c, type: String, as: :o_c
+            optional :i_d, type: Hash, as: :o_d do
+              optional :i_e, type: Hash, as: :o_e do
+                optional :i_f, type: String, as: :o_f
+                optional :i_g, type: String, as: :o_g
+                optional :i_h, type: Array, as: :o_h do
+                  optional :i_ha, type: String, as: :o_ha
+                  optional :i_hb, type: Hash, as: :o_hb do
+                    optional :i_hc, type: String, as: :o_hc
+                  end
+                end
+              end
+            end
+          end
+        end
+        subject.post '/test' do
+          declared(params, include_missing: false)
+        end
+        subject.post '/test/no-mod' do
+          before = params.to_h
+          declared(params, include_missing: false)
+          after = params.to_h
+          { before: before, after: after }
+        end
+      end
+
+      it 'generates the correct parameter names for documentation' do
+        expect(subject.routes.first.params.keys).to match(params_keys)
+      end
+
+      it 'maps the renamed parameter correctly' do
+        post '/test', **params
+        expect(JSON.parse(last_response.body, symbolize_names: true)).to \
+          match(declared)
+      end
+
+      it 'maps no parameters when none are given' do
+        post '/test'
+        expect(JSON.parse(last_response.body)).to match({})
+      end
+
+      it 'does not modify the request params' do
+        post '/test/no-mod', **params
+        result = JSON.parse(last_response.body, symbolize_names: true)
+        expect(result[:before]).to match(result[:after])
+      end
+    end
+
+    context 'with a renamed root parameter' do
+      before do
+        subject.format :json
+        subject.params do
+          optional :email_address, type: String, regexp: /.+@.+/, as: :email
+        end
+        subject.post '/test' do
+          declared(params, include_missing: false)
+        end
+      end
+
+      it 'generates the correct parameter names for documentation' do
+        expect(subject.routes.first.params.keys).to match(%w[email_address])
+      end
+
+      it 'maps the renamed parameter correctly (original name)' do
+        post '/test', email_address: 'test@example.com'
+        expect(JSON.parse(last_response.body)).to \
+          match('email' => 'test@example.com')
+      end
+
+      it 'validates the renamed parameter correctly (original name)' do
+        post '/test', email_address: 'bad[at]example.com'
+        expect(JSON.parse(last_response.body)).to \
+          match('error' => 'email_address is invalid')
+      end
+
+      it 'ignores the renamed parameter (as name)' do
+        post '/test', email: 'test@example.com'
+        expect(JSON.parse(last_response.body)).to match({})
+      end
+    end
+
+    context 'with a renamed hash with nested parameters' do
+      before do
+        subject.format :json
+        subject.params do
+          optional :address, type: Hash, as: :address_attributes do
+            optional :street, type: String, values: ['Street 1', 'Street 2'],
+                              default: 'Street 1'
+            optional :city, type: String
+          end
+        end
+        subject.post '/test' do
+          declared(params, include_missing: false)
+        end
+      end
+
+      it 'generates the correct parameter names for documentation' do
+        expect(subject.routes.first.params.keys).to \
+          match(%w[address address[street] address[city]])
+      end
+
+      it 'maps the renamed parameter correctly (original name)' do
+        post '/test', address: { city: 'Berlin', street: 'Street 2', t: 't' }
+        expect(JSON.parse(last_response.body)).to \
+          match('address_attributes' => { 'city' => 'Berlin',
+                                          'street' => 'Street 2' })
+      end
+
+      it 'validates the renamed parameter correctly (original name)' do
+        post '/test', address: { street: 'unknown' }
+        expect(JSON.parse(last_response.body)).to \
+          match('error' => 'address[street] does not have a valid value')
+      end
+
+      it 'ignores the renamed parameter (as name)' do
+        post '/test', address_attributes: { city: 'Berlin', unknown: '1' }
+        expect(JSON.parse(last_response.body)).to match({})
+      end
+    end
+
+    context 'with a renamed hash with nested renamed parameter' do
+      before do
+        subject.format :json
+        subject.params do
+          optional :user, type: Hash, as: :user_attributes do
+            optional :email_address, type: String, regexp: /.+@.+/, as: :email
+          end
+        end
+        subject.post '/test' do
+          declared(params, include_missing: false)
+        end
+      end
+
+      it 'generates the correct parameter names for documentation' do
+        expect(subject.routes.first.params.keys).to \
+          match(%w[user user[email_address]])
+      end
+
+      it 'maps the renamed parameter correctly (original name)' do
+        post '/test', user: { email_address: 'test@example.com' }
+        expect(JSON.parse(last_response.body)).to \
+          match('user_attributes' => { 'email' => 'test@example.com' })
+      end
+
+      it 'validates the renamed parameter correctly (original name)' do
+        post '/test', user: { email_address: 'bad[at]example.com' }
+        expect(JSON.parse(last_response.body)).to \
+          match('error' => 'user[email_address] is invalid')
+      end
+
+      it 'ignores the renamed parameter (as name, 1)' do
+        post '/test', user: { email: 'test@example.com' }
+        expect(JSON.parse(last_response.body)).to \
+          match({ 'user_attributes' => {} })
+      end
+
+      it 'ignores the renamed parameter (as name, 2)' do
+        post '/test', user_attributes: { email_address: 'test@example.com' }
+        expect(JSON.parse(last_response.body)).to match({})
+      end
+
+      it 'ignores the renamed parameter (as name, 3)' do
+        post '/test', user_attributes: { email: 'test@example.com' }
+        expect(JSON.parse(last_response.body)).to match({})
+      end
+    end
+  end
 end

data/spec/grape/endpoint_spec.rb

@@ -150,7 +150,7 @@ describe Grape::Endpoint do
     end
     it 'includes headers passed as symbols' do
       env = Rack::MockRequest.env_for('/headers')
-      env['HTTP_SYMBOL_HEADER'.to_sym] = 'Goliath passes symbols'
+      env[:HTTP_SYMBOL_HEADER] = 'Goliath passes symbols'
       body = read_chunks(subject.call(env)[2]).join
       expect(JSON.parse(body)['Symbol-Header']).to eq('Goliath passes symbols')
     end
@@ -212,10 +212,10 @@ describe Grape::Endpoint do
       end
       get '/test', {}, 'HTTP_COOKIE' => 'delete_this_cookie=1; and_this=2'
       expect(last_response.body).to eq('3')
-      cookies = Hash[last_response.headers['Set-Cookie'].split("\n").map do |set_cookie|
+      cookies = last_response.headers['Set-Cookie'].split("\n").map do |set_cookie|
         cookie = CookieJar::Cookie.from_set_cookie 'http://localhost/test', set_cookie
         [cookie.name, cookie]
-      end]
+      end.to_h
       expect(cookies.size).to eq(2)
       %w[and_this delete_this_cookie].each do |cookie_name|
         cookie = cookies[cookie_name]
@@ -236,10 +236,10 @@ describe Grape::Endpoint do
       end
       get('/test', {}, 'HTTP_COOKIE' => 'delete_this_cookie=1; and_this=2')
       expect(last_response.body).to eq('3')
-      cookies = Hash[last_response.headers['Set-Cookie'].split("\n").map do |set_cookie|
+      cookies = last_response.headers['Set-Cookie'].split("\n").map do |set_cookie|
         cookie = CookieJar::Cookie.from_set_cookie 'http://localhost/test', set_cookie
         [cookie.name, cookie]
-      end]
+      end.to_h
       expect(cookies.size).to eq(2)
       %w[and_this delete_this_cookie].each do |cookie_name|
         cookie = cookies[cookie_name]

data/spec/grape/entity_spec.rb

@@ -238,14 +238,14 @@ describe Grape::Entity do
       get '/example'
       expect(last_response.status).to eq(200)
       expect(last_response.headers['Content-type']).to eq('application/xml')
-      expect(last_response.body).to eq <<-XML
-<?xml version="1.0" encoding="UTF-8"?>
-<hash>
-  <example>
-    <name>johnnyiller</name>
-  </example>
-</hash>
-XML
+      expect(last_response.body).to eq <<~XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <hash>
+          <example>
+            <name>johnnyiller</name>
+          </example>
+        </hash>
+      XML
     end
 
     it 'presents with json' do
@@ -326,7 +326,7 @@ XML
         end
         get '/example'
         expect_response_json = {
-          'page'  => 1,
+          'page' => 1,
           'user1' => { 'name' => 'user1' },
           'user2' => { 'name' => 'user2' }
         }

data/spec/grape/middleware/auth/dsl_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe Grape::Middleware::Auth::DSL do
   subject { Class.new(Grape::API) }
 
-  let(:block) { ->() {} }
+  let(:block) { -> {} }
   let(:settings) do
     {
       opaque: 'secret',

data/spec/grape/middleware/error_spec.rb

@@ -16,8 +16,7 @@ describe Grape::Middleware::Error do
 
     class ErrApp
       class << self
-        attr_accessor :error
-        attr_accessor :format
+        attr_accessor :error, :format
 
         def call(_env)
           throw :error, error

data/spec/grape/middleware/formatter_spec.rb

@@ -20,7 +20,7 @@ describe Grape::Middleware::Formatter do
       let(:body) { ['foo'] }
       it 'calls #to_json since default format is json' do
         body.instance_eval do
-          def to_json
+          def to_json(*_args)
             '"bar"'
           end
         end
@@ -33,7 +33,7 @@ describe Grape::Middleware::Formatter do
       let(:body) { { 'foos' => [{ 'bar' => 'baz' }] } }
       it 'calls #to_json if the content type is jsonapi' do
         body.instance_eval do
-          def to_json
+          def to_json(*_args)
             '{"foos":[{"bar":"baz"}] }'
           end
         end

data/spec/grape/middleware/stack_spec.rb

@@ -5,7 +5,9 @@ require 'spec_helper'
 describe Grape::Middleware::Stack do
   module StackSpec
     class FooMiddleware; end
+
     class BarMiddleware; end
+
     class BlockMiddleware
       attr_reader :block
 
@@ -15,7 +17,7 @@ describe Grape::Middleware::Stack do
     end
   end
 
-  let(:proc) { ->() {} }
+  let(:proc) { -> {} }
   let(:others) { [[:use, StackSpec::BarMiddleware], [:insert_before, StackSpec::BarMiddleware, StackSpec::BlockMiddleware, proc]] }
 
   subject { Grape::Middleware::Stack.new }