grape 1.3.3 → 1.6.2

data/spec/grape/dsl/callbacks_spec.rb

@@ -12,7 +12,8 @@ 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/headers_spec.rb

@@ -12,21 +12,51 @@ module Grape
     describe Headers do
       subject { HeadersSpec::Dummy.new }
 
-      describe '#header' do
-        describe 'set' do
+      let(:header_data) do
+        { 'First Key' => 'First Value',
+          'Second Key' => 'Second Value' }
+      end
+
+      context 'when headers are set' do
+        describe '#header' do
           before do
-            subject.header 'Name', 'Value'
+            header_data.each { |k, v| subject.header(k, v) }
+          end
+
+          describe 'get' do
+            it 'returns a specifc value' do
+              expect(subject.header['First Key']).to eq 'First Value'
+              expect(subject.header['Second Key']).to eq 'Second Value'
+            end
+
+            it 'returns all set headers' do
+              expect(subject.header).to eq header_data
+              expect(subject.headers).to eq header_data
+            end
           end
 
-          it 'returns value' do
-            expect(subject.header['Name']).to eq 'Value'
-            expect(subject.header('Name')).to eq 'Value'
+          describe 'set' do
+            it 'returns value' do
+              expect(subject.header('Third Key', 'Third Value'))
+              expect(subject.header['Third Key']).to eq 'Third Value'
+            end
+          end
+
+          describe 'delete' do
+            it 'deletes a header key-value pair' do
+              expect(subject.header('First Key')).to eq header_data['First Key']
+              expect(subject.header).not_to have_key('First Key')
+            end
           end
         end
+      end
 
-        it 'returns nil' do
-          expect(subject.header['Name']).to be nil
-          expect(subject.header('Name')).to be nil
+      context 'when no headers are set' do
+        describe '#header' do
+          it 'returns nil' do
+            expect(subject.header['First Key']).to be nil
+            expect(subject.header('First Key')).to be nil
+          end
         end
       end
     end

data/spec/grape/dsl/helpers_spec.rb

@@ -34,6 +34,7 @@ module Grape
 
     describe Helpers do
       subject { Class.new(HelpersSpec::Dummy) }
+
       let(:proc) do
         lambda do |*|
           def test
@@ -54,7 +55,7 @@ module Grape
         it 'uses provided modules' do
           mod = Module.new
 
-          expect(subject).to receive(:namespace_stackable).with(:helpers, kind_of(Grape::DSL::Helpers::BaseHelper)).and_call_original.exactly(2).times
+          expect(subject).to receive(:namespace_stackable).with(:helpers, kind_of(Grape::DSL::Helpers::BaseHelper)).and_call_original.twice
           expect(subject).to receive(:namespace_stackable).with(:helpers).and_call_original
           subject.helpers(mod, &proc)
 
@@ -92,7 +93,7 @@ module Grape
                   use :requires_toggle_prm
                 end
               end
-            end.to_not raise_exception
+            end.not_to raise_exception
           end
         end
       end

data/spec/grape/dsl/inside_route_spec.rb

@@ -43,6 +43,7 @@ describe Grape::Endpoint do
       before do
         catch(:error) { subject.error! 'Not Found', 404 }
       end
+
       it 'sets status' do
         expect(subject.status).to eq 404
       end
@@ -53,6 +54,7 @@ describe Grape::Endpoint do
         subject.namespace_inheritable(:default_error_status, 500)
         catch(:error) { subject.error! 'Unknown' }
       end
+
       it 'sets status to default_error_status' do
         expect(subject.status).to eq 500
       end
@@ -136,7 +138,7 @@ describe Grape::Endpoint do
     end
 
     it 'accepts unknown Integer status codes' do
-      expect { subject.status 210 }.to_not raise_error
+      expect { subject.status 210 }.not_to raise_error
     end
 
     it 'raises error if status is not a integer or symbol' do
@@ -203,80 +205,229 @@ describe Grape::Endpoint do
   end
 
   describe '#file' do
+    before do
+      allow(subject).to receive(:warn)
+    end
+
     describe 'set' do
       context 'as file path' do
         let(:file_path) { '/some/file/path' }
 
-        let(:file_response) do
-          file_body = Grape::ServeFile::FileBody.new(file_path)
-          Grape::ServeFile::FileResponse.new(file_body)
-        end
+        it 'emits a warning that this method is deprecated' do
+          expect(subject).to receive(:warn).with(/Use sendfile or stream/)
 
-        before do
           subject.file file_path
         end
 
-        it 'returns value wrapped in FileResponse' do
-          expect(subject.file).to eq file_response
+        it 'forwards the call to sendfile' do
+          expect(subject).to receive(:sendfile).with(file_path)
+
+          subject.file file_path
         end
       end
 
       context 'as object (backward compatibility)' do
-        let(:file_object) { Class.new }
+        let(:file_object) { double('StreamerObject', each: nil) }
+
+        it 'emits a warning that this method is deprecated' do
+          expect(subject).to receive(:warn).with(/Use stream to use a Stream object/)
+
+          subject.file file_object
+        end
+
+        it 'forwards the call to stream' do
+          expect(subject).to receive(:stream).with(file_object)
+
+          subject.file file_object
+        end
+      end
+    end
+
+    describe 'get' do
+      it 'emits a warning that this method is deprecated' do
+        expect(subject).to receive(:warn).with(/Use sendfile or stream/)
+
+        subject.file
+      end
+
+      it 'fowards call to sendfile' do
+        expect(subject).to receive(:sendfile)
+
+        subject.file
+      end
+    end
+  end
+
+  describe '#sendfile' do
+    describe 'set' do
+      context 'as file path' do
+        let(:file_path) { '/some/file/path' }
 
         let(:file_response) do
-          Grape::ServeFile::FileResponse.new(file_object)
+          file_body = Grape::ServeStream::FileBody.new(file_path)
+          Grape::ServeStream::StreamResponse.new(file_body)
         end
 
         before do
-          subject.file file_object
+          subject.header 'Cache-Control', 'cache'
+          subject.header 'Content-Length', 123
+          subject.header 'Transfer-Encoding', 'base64'
+        end
+
+        it 'sends no deprecation warnings' do
+          expect(subject).not_to receive(:warn)
+
+          subject.sendfile file_path
+        end
+
+        it 'returns value wrapped in StreamResponse' do
+          subject.sendfile file_path
+
+          expect(subject.sendfile).to eq file_response
+        end
+
+        it 'does not change the Cache-Control header' do
+          subject.sendfile file_path
+
+          expect(subject.header['Cache-Control']).to eq 'cache'
+        end
+
+        it 'does not change the Content-Length header' do
+          subject.sendfile file_path
+
+          expect(subject.header['Content-Length']).to eq 123
         end
 
-        it 'returns value wrapped in FileResponse' do
-          expect(subject.file).to eq file_response
+        it 'does not change the Transfer-Encoding header' do
+          subject.sendfile file_path
+
+          expect(subject.header['Transfer-Encoding']).to eq 'base64'
+        end
+      end
+
+      context 'as object' do
+        let(:file_object) { double('StreamerObject', each: nil) }
+
+        it 'raises an error that only a file path is supported' do
+          expect { subject.sendfile file_object }.to raise_error(ArgumentError, /Argument must be a file path/)
         end
       end
     end
 
     it 'returns default' do
-      expect(subject.file).to be nil
+      expect(subject.sendfile).to be nil
     end
   end
 
   describe '#stream' do
     describe 'set' do
-      let(:file_object) { Class.new }
+      context 'as a file path' do
+        let(:file_path) { '/some/file/path' }
 
-      before do
-        subject.header 'Cache-Control', 'cache'
-        subject.header 'Content-Length', 123
-        subject.header 'Transfer-Encoding', 'base64'
-        subject.stream file_object
-      end
+        let(:file_response) do
+          file_body = Grape::ServeStream::FileBody.new(file_path)
+          Grape::ServeStream::StreamResponse.new(file_body)
+        end
 
-      it 'returns value wrapped in FileResponse' do
-        expect(subject.stream).to eq Grape::ServeFile::FileResponse.new(file_object)
-      end
+        before do
+          subject.header 'Cache-Control', 'cache'
+          subject.header 'Content-Length', 123
+          subject.header 'Transfer-Encoding', 'base64'
+        end
 
-      it 'also sets result of file to value wrapped in FileResponse' do
-        expect(subject.file).to eq Grape::ServeFile::FileResponse.new(file_object)
-      end
+        it 'emits no deprecation warnings' do
+          expect(subject).not_to receive(:warn)
+
+          subject.stream file_path
+        end
+
+        it 'returns file body wrapped in StreamResponse' do
+          subject.stream file_path
+
+          expect(subject.stream).to eq file_response
+        end
+
+        it 'sets Cache-Control header to no-cache' do
+          subject.stream file_path
+
+          expect(subject.header['Cache-Control']).to eq 'no-cache'
+        end
+
+        it 'does not change Cache-Control header' do
+          subject.stream
+
+          expect(subject.header['Cache-Control']).to eq 'cache'
+        end
+
+        it 'sets Content-Length header to nil' do
+          subject.stream file_path
+
+          expect(subject.header['Content-Length']).to eq nil
+        end
 
-      it 'sets Cache-Control header to no-cache' do
-        expect(subject.header['Cache-Control']).to eq 'no-cache'
+        it 'sets Transfer-Encoding header to nil' do
+          subject.stream file_path
+
+          expect(subject.header['Transfer-Encoding']).to eq nil
+        end
       end
 
-      it 'sets Content-Length header to nil' do
-        expect(subject.header['Content-Length']).to eq nil
+      context 'as a stream object' do
+        let(:stream_object) { double('StreamerObject', each: nil) }
+
+        let(:stream_response) do
+          Grape::ServeStream::StreamResponse.new(stream_object)
+        end
+
+        before do
+          subject.header 'Cache-Control', 'cache'
+          subject.header 'Content-Length', 123
+          subject.header 'Transfer-Encoding', 'base64'
+        end
+
+        it 'emits no deprecation warnings' do
+          expect(subject).not_to receive(:warn)
+
+          subject.stream stream_object
+        end
+
+        it 'returns value wrapped in StreamResponse' do
+          subject.stream stream_object
+
+          expect(subject.stream).to eq stream_response
+        end
+
+        it 'sets Cache-Control header to no-cache' do
+          subject.stream stream_object
+
+          expect(subject.header['Cache-Control']).to eq 'no-cache'
+        end
+
+        it 'sets Content-Length header to nil' do
+          subject.stream stream_object
+
+          expect(subject.header['Content-Length']).to eq nil
+        end
+
+        it 'sets Transfer-Encoding header to nil' do
+          subject.stream stream_object
+
+          expect(subject.header['Transfer-Encoding']).to eq nil
+        end
       end
 
-      it 'sets Transfer-Encoding header to nil' do
-        expect(subject.header['Transfer-Encoding']).to eq nil
+      context 'as a non-stream object' do
+        let(:non_stream_object) { double('NonStreamerObject') }
+
+        it 'raises an error that the object must implement :each' do
+          expect { subject.stream non_stream_object }.to raise_error(ArgumentError, /:each/)
+        end
       end
     end
 
     it 'returns default' do
-      expect(subject.file).to be nil
+      expect(subject.stream).to be nil
+      expect(subject.header['Cache-Control']).to eq nil
     end
   end
 

data/spec/grape/dsl/logger_spec.rb

@@ -2,27 +2,25 @@
 
 require 'spec_helper'
 
-module Grape
-  module DSL
-    module LoggerSpec
-      class Dummy
-        extend Grape::DSL::Logger
-      end
+describe Grape::DSL::Logger do
+  subject { Class.new(dummy_logger) }
+
+  let(:dummy_logger) do
+    Class.new do
+      extend Grape::DSL::Logger
     end
-    describe Logger do
-      subject { Class.new(LoggerSpec::Dummy) }
-      let(:logger) { double(:logger) }
+  end
 
-      describe '.logger' do
-        it 'sets a logger' do
-          subject.logger logger
-          expect(subject.logger).to eq logger
-        end
+  let(:logger) { instance_double(::Logger) }
+
+  describe '.logger' do
+    it 'sets a logger' do
+      subject.logger logger
+      expect(subject.logger).to eq logger
+    end
 
-        it 'returns a logger' do
-          expect(subject.logger(logger)).to eq logger
-        end
-      end
+    it 'returns a logger' do
+      expect(subject.logger(logger)).to eq logger
     end
   end
 end

data/spec/grape/dsl/middleware_spec.rb

@@ -12,7 +12,8 @@ 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
@@ -54,6 +55,7 @@ module Grape
           allow_message_expectations_on_nil
           allow(subject.api).to receive(:namespace_stackable).with(:named_params)
         end
+
         let(:options) { { option: 'value' } }
         let(:named_params) { { params_group: proc {} } }
 

data/spec/grape/dsl/request_response_spec.rb

@@ -20,6 +20,7 @@ module Grape
 
     describe RequestResponse do
       subject { Class.new(RequestResponseSpec::Dummy) }
+
       let(:c_type) { 'application/json' }
       let(:format) { 'txt' }
 

data/spec/grape/dsl/routing_spec.rb

@@ -12,7 +12,8 @@ module Grape
 
     describe Routing do
       subject { Class.new(RoutingSpec::Dummy) }
-      let(:proc) { ->() {} }
+
+      let(:proc) { -> {} }
       let(:options) { { a: :b } }
       let(:path) { '/dummy' }
 
@@ -109,7 +110,7 @@ module Grape
         it 'does not duplicate identical endpoints' do
           subject.route(:any)
           expect { subject.route(:any) }
-            .to_not change(subject.endpoints, :count)
+            .not_to change(subject.endpoints, :count)
         end
 
         it 'generates correct endpoint options' do
@@ -233,21 +234,23 @@ module Grape
             allow(subject).to receive(:prepare_routes).and_return(routes)
             subject.routes
           end
-          it 'it does not call prepare_routes again' do
-            expect(subject).to_not receive(:prepare_routes)
+
+          it 'does not call prepare_routes again' do
+            expect(subject).not_to receive(:prepare_routes)
             expect(subject.routes).to eq routes
           end
         end
       end
 
       describe '.route_param' do
+        let!(:options) { { requirements: regex } }
+        let(:regex) { /(.*)/ }
+
         it 'calls #namespace with given params' do
           expect(subject).to receive(:namespace).with(':foo', {}).and_yield
           subject.route_param('foo', {}, &proc {})
         end
 
-        let(: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
@@ -258,7 +261,7 @@ module Grape
         it 'does not modify options parameter' do
           allow(subject).to receive(:namespace)
           expect { subject.route_param('foo', options, &proc {}) }
-            .to_not change { options }
+            .not_to change { options }
         end
       end