grape 0.12.0 → 0.14.0

data/spec/grape/api_spec.rb

@@ -537,16 +537,38 @@ describe Grape::API do
       expect(last_response.headers['Content-Type']).to eql 'text/plain'
     end
 
-    it 'adds an OPTIONS route that returns a 204, an Allow header and a X-Custom-Header' do
-      subject.before { header 'X-Custom-Header', 'foo' }
-      subject.get 'example' do
-        'example'
+    describe 'adds an OPTIONS route that' do
+      before do
+        subject.before { header 'X-Custom-Header', 'foo' }
+        subject.get 'example' do
+          'example'
+        end
+        options '/example'
+      end
+
+      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, HEAD'
+      end
+
+      it 'has a X-Custom-Header' do
+        expect(last_response.headers['X-Custom-Header']).to eql 'foo'
+      end
+
+      it 'has no Content-Type' do
+        expect(last_response.content_type).to be_nil
+      end
+
+      it 'has no Content-Length' do
+        expect(last_response.content_length).to be_nil
       end
-      options '/example'
-      expect(last_response.status).to eql 204
-      expect(last_response.body).to eql ''
-      expect(last_response.headers['Allow']).to eql 'OPTIONS, GET, HEAD'
-      expect(last_response.headers['X-Custom-Header']).to eql 'foo'
     end
 
     it 'allows HEAD on a GET request' do
@@ -640,7 +662,7 @@ describe Grape::API do
     end
 
     it 'adds a after_validation filter' do
-      subject.after_validation { @foo = "first #{params[:id] }:#{params[:id].class}"  }
+      subject.after_validation { @foo = "first #{params[:id]}:#{params[:id].class}" }
       subject.after_validation { @bar = 'second' }
       subject.params do
         requires :id, type: Integer
@@ -787,7 +809,7 @@ describe Grape::API do
 
     it 'returns raw data when content type binary' do
       image_filename = 'grape.png'
-      file = File.open(image_filename, 'rb') { |io| io.read }
+      file = File.open(image_filename, 'rb', &:read)
       subject.format :binary
       subject.get('/binary_file') { File.binread(image_filename) }
       get '/binary_file'
@@ -795,6 +817,37 @@ describe Grape::API do
       expect(last_response.body).to eq(file)
     end
 
+    it 'returns the content of the file with file' do
+      file_content = 'This is some file content'
+      test_file = Tempfile.new('test')
+      test_file.write file_content
+      test_file.rewind
+
+      subject.get('/file') { file test_file }
+      get '/file'
+      expect(last_response.headers['Content-Length']).to eq('25')
+      expect(last_response.headers['Content-Type']).to eq('text/plain')
+      expect(last_response.body).to eq(file_content)
+    end
+
+    it 'streams the content of the file with stream' do
+      test_stream = Enumerator.new do |blk|
+        blk.yield 'This is some'
+        blk.yield ' file content'
+      end
+
+      subject.use Rack::Chunked
+      subject.get('/stream') { stream test_stream }
+      get '/stream', {}, 'HTTP_VERSION' => 'HTTP/1.1'
+
+      expect(last_response.headers['Content-Type']).to eq('text/plain')
+      expect(last_response.headers['Content-Length']).to eq(nil)
+      expect(last_response.headers['Cache-Control']).to eq('no-cache')
+      expect(last_response.headers['Transfer-Encoding']).to eq('chunked')
+
+      expect(last_response.body).to eq("c\r\nThis is some\r\nd\r\n file content\r\n0\r\n\r\n")
+    end
+
     it 'sets content type for error' do
       subject.get('/error') { error!('error in plain text', 500) }
       get '/error'
@@ -1035,7 +1088,7 @@ describe Grape::API do
 
       subject.get(:hello) { 'Hello, world.' }
       get '/hello', {}, 'HTTP_AUTHORIZATION' => encode_basic_auth('allow', 'whatever')
-      expect(basic_auth_context).to be_an_instance_of(Grape::Endpoint)
+      expect(basic_auth_context).to be_a_kind_of(Grape::Endpoint)
     end
 
     it 'has access to helper methods' do
@@ -1278,21 +1331,23 @@ describe Grape::API do
 
     context 'CustomError subclass of Grape::Exceptions::Base' do
       before do
-        class CustomError < Grape::Exceptions::Base; end
+        module ApiSpec
+          class CustomError < Grape::Exceptions::Base; end
+        end
       end
 
       it 'does not re-raise exceptions of type Grape::Exceptions::Base' do
-        subject.get('/custom_exception') { fail CustomError }
+        subject.get('/custom_exception') { fail ApiSpec::CustomError }
 
         expect { get '/custom_exception' }.not_to raise_error
       end
 
       it 'rescues custom grape exceptions' do
-        subject.rescue_from CustomError do |e|
+        subject.rescue_from ApiSpec::CustomError do |e|
           rack_response('New Error', e.status)
         end
         subject.get '/custom_error' do
-          fail CustomError, status: 400, message: 'Custom Error'
+          fail ApiSpec::CustomError, status: 400, message: 'Custom Error'
         end
 
         get '/custom_error'
@@ -1404,7 +1459,7 @@ describe Grape::API do
 
   describe '.rescue_from klass, lambda' do
     it 'rescues an error with the lambda' do
-      subject.rescue_from ArgumentError, -> {
+      subject.rescue_from ArgumentError, lambda {
         rack_response('rescued with a lambda', 400)
       }
       subject.get('/rescue_lambda') { fail ArgumentError }
@@ -1415,7 +1470,7 @@ describe Grape::API do
     end
 
     it 'can execute the lambda with an argument' do
-      subject.rescue_from ArgumentError, ->(e) {
+      subject.rescue_from ArgumentError, lambda { |e|
         rack_response(e.message, 400)
       }
       subject.get('/rescue_lambda') { fail ArgumentError, 'lambda takes an argument' }
@@ -1443,21 +1498,23 @@ describe Grape::API do
 
   describe '.rescue_from klass, rescue_subclasses: boolean' do
     before do
-      module APIErrors
-        class ParentError < StandardError; end
-        class ChildError < ParentError; end
+      module ApiSpec
+        module APIErrors
+          class ParentError < StandardError; end
+          class ChildError < ParentError; end
+        end
       end
     end
 
     it 'rescues error as well as subclass errors with rescue_subclasses option set' do
-      subject.rescue_from APIErrors::ParentError, rescue_subclasses: true do |e|
+      subject.rescue_from ApiSpec::APIErrors::ParentError, rescue_subclasses: true do |e|
         rack_response("rescued from #{e.class.name}", 500)
       end
       subject.get '/caught_child' do
-        fail APIErrors::ChildError
+        fail ApiSpec::APIErrors::ChildError
       end
       subject.get '/caught_parent' do
-        fail APIErrors::ParentError
+        fail ApiSpec::APIErrors::ParentError
       end
       subject.get '/uncaught_parent' do
         fail StandardError
@@ -1471,11 +1528,11 @@ describe Grape::API do
     end
 
     it 'sets rescue_subclasses to true by default' do
-      subject.rescue_from APIErrors::ParentError do |e|
+      subject.rescue_from ApiSpec::APIErrors::ParentError do |e|
         rack_response("rescued from #{e.class.name}", 500)
       end
       subject.get '/caught_child' do
-        fail APIErrors::ChildError
+        fail ApiSpec::APIErrors::ChildError
       end
 
       get '/caught_child'
@@ -1483,13 +1540,13 @@ describe Grape::API do
     end
 
     it 'does not rescue child errors if rescue_subclasses is false' do
-      subject.rescue_from APIErrors::ParentError, rescue_subclasses: false do |e|
+      subject.rescue_from ApiSpec::APIErrors::ParentError, rescue_subclasses: false do |e|
         rack_response("rescued from #{e.class.name}", 500)
       end
       subject.get '/uncaught' do
-        fail APIErrors::ChildError
+        fail ApiSpec::APIErrors::ChildError
       end
-      expect { get '/uncaught' }.to raise_error(APIErrors::ChildError)
+      expect { get '/uncaught' }.to raise_error(ApiSpec::APIErrors::ChildError)
     end
   end
 
@@ -1541,15 +1598,17 @@ describe Grape::API do
 
     context 'class' do
       before :each do
-        class CustomErrorFormatter
-          def self.call(message, _backtrace, _options, _env)
-            "message: #{message} @backtrace"
+        module ApiSpec
+          class CustomErrorFormatter
+            def self.call(message, _backtrace, _options, _env)
+              "message: #{message} @backtrace"
+            end
           end
         end
       end
       it 'returns a custom error format' do
         subject.rescue_from :all, backtrace: true
-        subject.error_formatter :txt, CustomErrorFormatter
+        subject.error_formatter :txt, ApiSpec::CustomErrorFormatter
         subject.get '/exception' do
           fail 'rain!'
         end
@@ -1561,16 +1620,18 @@ describe Grape::API do
     describe 'with' do
       context 'class' do
         before :each do
-          class CustomErrorFormatter
-            def self.call(message, _backtrace, _option, _env)
-              "message: #{message} @backtrace"
+          module ApiSpec
+            class CustomErrorFormatter
+              def self.call(message, _backtrace, _option, _env)
+                "message: #{message} @backtrace"
+              end
             end
           end
         end
 
         it 'returns a custom error format' do
           subject.rescue_from :all, backtrace: true
-          subject.error_formatter :txt, with: CustomErrorFormatter
+          subject.error_formatter :txt, with: ApiSpec::CustomErrorFormatter
           subject.get('/exception') { fail 'rain!' }
 
           get '/exception'
@@ -1648,8 +1709,8 @@ describe Grape::API do
   describe '.formatter' do
     context 'multiple formatters' do
       before :each do
-        subject.formatter :json, ->(object, _env) { "{\"custom_formatter\":\"#{object[:some] }\"}" }
-        subject.formatter :txt, ->(object, _env) { "custom_formatter: #{object[:some] }" }
+        subject.formatter :json, ->(object, _env) { "{\"custom_formatter\":\"#{object[:some]}\"}" }
+        subject.formatter :txt, ->(object, _env) { "custom_formatter: #{object[:some]}" }
         subject.get :simple do
           { some: 'hash' }
         end
@@ -1667,7 +1728,7 @@ describe Grape::API do
       before :each do
         subject.content_type :json, 'application/json'
         subject.content_type :custom, 'application/custom'
-        subject.formatter :custom, ->(object, _env) { "{\"custom_formatter\":\"#{object[:some] }\"}" }
+        subject.formatter :custom, ->(object, _env) { "{\"custom_formatter\":\"#{object[:some]}\"}" }
         subject.get :simple do
           { some: 'hash' }
         end
@@ -1682,15 +1743,17 @@ describe Grape::API do
       end
     end
     context 'custom formatter class' do
-      module CustomFormatter
-        def self.call(object, _env)
-          "{\"custom_formatter\":\"#{object[:some] }\"}"
+      module ApiSpec
+        module CustomFormatter
+          def self.call(object, _env)
+            "{\"custom_formatter\":\"#{object[:some]}\"}"
+          end
         end
       end
       before :each do
         subject.content_type :json, 'application/json'
         subject.content_type :custom, 'application/custom'
-        subject.formatter :custom, CustomFormatter
+        subject.formatter :custom, ApiSpec::CustomFormatter
         subject.get :simple do
           { some: 'hash' }
         end
@@ -1734,15 +1797,17 @@ describe Grape::API do
       end
     end
     context 'custom parser class' do
-      module CustomParser
-        def self.call(object, _env)
-          { object.to_sym => object.to_s.reverse }
+      module ApiSpec
+        module CustomParser
+          def self.call(object, _env)
+            { object.to_sym => object.to_s.reverse }
+          end
         end
       end
       before :each do
         subject.content_type :txt, 'text/plain'
         subject.content_type :custom, 'text/custom'
-        subject.parser :custom, CustomParser
+        subject.parser :custom, ApiSpec::CustomParser
         subject.put :simple do
           params[:simple]
         end
@@ -1767,7 +1832,7 @@ describe Grape::API do
       before :each do
         subject.parser :json, nil
         subject.put 'data' do
-          "body: #{env['api.request.body'] }"
+          "body: #{env['api.request.body']}"
         end
       end
       it 'does not parse data' do
@@ -2123,6 +2188,38 @@ describe Grape::API do
         { description: 'Reverses a string.', params: { 's' => { desc: 'string to reverse', type: 'string' } } }
       ]
     end
+    it 'does not inherit param descriptions in consequent namespaces' do
+      subject.desc 'global description'
+      subject.params do
+        requires :param1
+        optional :param2
+      end
+      subject.namespace 'ns1' do
+        get do; end
+      end
+      subject.params do
+        optional :param2
+      end
+      subject.namespace 'ns2' do
+        get do; end
+      end
+      routes_doc = subject.routes.map { |route|
+        { description: route.route_description, params: route.route_params }
+      }
+      expect(routes_doc).to eq [
+        { description: 'global description',
+          params: {
+            'param1' => { required: true },
+            'param2' => { required: false }
+          }
+        },
+        { description: 'global description',
+          params: {
+            'param2' => { required: false }
+          }
+        }
+      ]
+    end
     it 'merges the parameters of the namespace with the parameters of the method' do
       subject.desc 'namespace'
       subject.params do
@@ -2749,10 +2846,10 @@ XML
       end
       it 'hash' do
         subject.get '/example' do
-          ActiveSupport::OrderedHash[
-            :example1, 'example1',
-            :example2, 'example2'
-        ]
+          {
+            example1: 'example1',
+            example2: 'example2'
+          }
         end
         get '/example'
         expect(last_response.status).to eq(200)
@@ -2817,7 +2914,7 @@ XML
     [true, false].each do |anchor|
       it "anchor=#{anchor}" do
         subject.route :any, '*path', anchor: anchor do
-          error!("Unrecognized request path: #{params[:path] } - #{env['PATH_INFO'] }#{env['SCRIPT_NAME'] }", 404)
+          error!("Unrecognized request path: #{params[:path]} - #{env['PATH_INFO']}#{env['SCRIPT_NAME']}", 404)
         end
         get '/v1/hello'
         expect(last_response.status).to eq(200)

data/spec/grape/dsl/configuration_spec.rb

@@ -70,6 +70,19 @@ module Grape
           expect(subject.namespace_setting(:description)).to eq(expected_options)
           expect(subject.route_setting(:description)).to eq(expected_options)
         end
+
+        it 'can be set with options and a block' do
+          expect(subject).to receive(:warn).with('[DEPRECATION] Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.')
+
+          desc_text = 'The description'
+          detail_text = 'more details'
+          options = { message: 'none' }
+          subject.desc desc_text, options do
+            detail detail_text
+          end
+          expect(subject.namespace_setting(:description)).to eq(description: desc_text, detail: detail_text)
+          expect(subject.route_setting(:description)).to eq(description: desc_text, detail: detail_text)
+        end
       end
     end
   end

data/spec/grape/dsl/helpers_spec.rb

@@ -6,13 +6,20 @@ module Grape
       class Dummy
         include Grape::DSL::Helpers
 
-        # rubocop:disable TrivialAccessors
         def self.mod
           namespace_stackable(:helpers).first
         end
-        # rubocop:enable TrivialAccessors
       end
     end
+
+    module BooleanParam
+      extend Grape::API::Helpers
+
+      params :requires_toggle_prm do
+        requires :toggle_prm, type: Boolean
+      end
+    end
+
     describe Helpers do
       subject { Class.new(HelpersSpec::Dummy) }
       let(:proc) do
@@ -41,6 +48,13 @@ module Grape
 
           expect(subject.mod).to eq mod
         end
+
+        context 'with an external file' do
+          it 'sets Boolean as a Virtus::Attribute::Boolean' do
+            subject.helpers BooleanParam
+            expect(subject.mod::Boolean).to eq Virtus::Attribute::Boolean
+          end
+        end
       end
     end
   end

data/spec/grape/dsl/inside_route_spec.rb

@@ -201,8 +201,43 @@ module Grape
             subject.file 'file'
           end
 
-          it 'returns value' do
-            expect(subject.file).to eq 'file'
+          it 'returns value wrapped in FileResponse' do
+            expect(subject.file).to eq Grape::Util::FileResponse.new('file')
+          end
+        end
+
+        it 'returns default' do
+          expect(subject.file).to be nil
+        end
+      end
+
+      describe '#stream' do
+        describe 'set' do
+          before do
+            subject.header 'Cache-Control', 'cache'
+            subject.header 'Content-Length', 123
+            subject.header 'Transfer-Encoding', 'base64'
+            subject.stream 'file'
+          end
+
+          it 'returns value wrapped in FileResponse' do
+            expect(subject.stream).to eq Grape::Util::FileResponse.new('file')
+          end
+
+          it 'also sets result of file to value wrapped in FileResponse' do
+            expect(subject.file).to eq Grape::Util::FileResponse.new('file')
+          end
+
+          it 'sets Cache-Control header to no-cache' do
+            expect(subject.header['Cache-Control']).to eq 'no-cache'
+          end
+
+          it 'sets Content-Length header to nil' do
+            expect(subject.header['Content-Length']).to eq nil
+          end
+
+          it 'sets Transfer-Encoding header to nil' do
+            expect(subject.header['Transfer-Encoding']).to eq nil
           end
         end
 
@@ -308,8 +343,9 @@ module Grape
       describe '#declared' do
         # see endpoint_spec.rb#declared for spec coverage
 
-        it 'returns an empty hash' do
-          expect(subject.declared({})).to eq({})
+        it 'is not available by default' do
+          expect { subject.declared({}) }.to raise_error(
+            Grape::DSL::InsideRoute::MethodNotYetAvailable)
         end
       end
     end

data/spec/grape/dsl/parameters_spec.rb

@@ -11,31 +11,25 @@ module Grape
           @validate_attributes = *args
         end
 
-        # rubocop:disable TrivialAccessors
         def validate_attributes_reader
           @validate_attributes
         end
-        # rubocop:enable TrivialAccessors
 
         def push_declared_params(*args)
           @push_declared_params = args
         end
 
-        # rubocop:disable TrivialAccessors
         def push_declared_params_reader
           @push_declared_params
         end
-        # rubocop:enable TrivialAccessors
 
         def validates(*args)
           @validates = *args
         end
 
-        # rubocop:disable TrivialAccessors
         def validates_reader
           @validates
         end
-        # rubocop:enable TrivialAccessors
       end
     end
 

data/spec/grape/dsl/routing_spec.rb

@@ -228,7 +228,7 @@ module Grape
         end
 
         let(:regex) { /(.*)/ }
-        let!(:options) {  { requirements: regex } }
+        let!(:options) { { requirements: regex } }
         it 'nests requirements option under param name' do
           expect(subject).to receive(:namespace) do |_param, options|
             expect(options[:requirements][:foo]).to eq regex

data/spec/grape/dsl/validations_spec.rb

@@ -15,9 +15,15 @@ module Grape
         before do
           subject.namespace_stackable :declared_params, ['dummy']
           subject.namespace_stackable :validations, ['dummy']
+          subject.namespace_stackable :params, ['dummy']
+          subject.route_setting :description, description: 'lol', params: ['dummy']
           subject.reset_validations!
         end
 
+        after do
+          subject.unset_route_setting :description
+        end
+
         it 'resets declared params' do
           expect(subject.namespace_stackable(:declared_params)).to eq []
         end
@@ -25,6 +31,18 @@ module Grape
         it 'resets validations' do
           expect(subject.namespace_stackable(:validations)).to eq []
         end
+
+        it 'resets params' do
+          expect(subject.namespace_stackable(:params)).to eq []
+        end
+
+        it 'resets documentation params' do
+          expect(subject.route_setting(:description)[:params]).to be_nil
+        end
+
+        it 'does not reset documentation description' do
+          expect(subject.route_setting(:description)[:description]).to eq 'lol'
+        end
       end
 
       describe '.params' do