grape 1.2.5 → 1.4.0

data/spec/grape/config_spec.rb

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

data/spec/grape/dsl/callbacks_spec.rb

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

data/spec/grape/dsl/configuration_spec.rb

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

data/spec/grape/dsl/desc_spec.rb

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

data/spec/grape/dsl/headers_spec.rb

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

data/spec/grape/dsl/helpers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Grape
@@ -75,9 +77,9 @@ module Grape
         end
 
         context 'with an external file' do
-          it 'sets Boolean as a Virtus::Attribute::Boolean' do
+          it 'sets Boolean as a Grape::API::Boolean' do
             subject.helpers BooleanParam
-            expect(subject.first_mod::Boolean).to eq Virtus::Attribute::Boolean
+            expect(subject.first_mod::Boolean).to eq Grape::API::Boolean
           end
         end
 

data/spec/grape/dsl/inside_route_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Grape
@@ -201,80 +203,222 @@ 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).to_not receive(:warn)
+
+          subject.sendfile file_path
         end
 
-        it 'returns value wrapped in FileResponse' do
-          expect(subject.file).to eq file_response
+        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 '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).to_not 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 'sets Content-Length header to nil' do
+          subject.stream file_path
+
+          expect(subject.header['Content-Length']).to eq nil
+        end
+
+        it 'sets Transfer-Encoding header to nil' do
+          subject.stream file_path
 
-      it 'sets Cache-Control header to no-cache' do
-        expect(subject.header['Cache-Control']).to eq 'no-cache'
+          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).to_not 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
     end
   end
 

data/spec/grape/dsl/logger_spec.rb

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

data/spec/grape/dsl/middleware_spec.rb

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

data/spec/grape/dsl/parameters_spec.rb

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

data/spec/grape/dsl/request_response_spec.rb

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

data/spec/grape/dsl/routing_spec.rb

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

data/spec/grape/dsl/settings_spec.rb

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

data/spec/grape/dsl/validations_spec.rb

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

data/spec/grape/endpoint_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do
@@ -149,7 +151,7 @@ describe Grape::Endpoint do
     it 'includes headers passed as symbols' do
       env = Rack::MockRequest.env_for('/headers')
       env['HTTP_SYMBOL_HEADER'.to_sym] = 'Goliath passes symbols'
-      body = subject.call(env)[2].body.first
+      body = read_chunks(subject.call(env)[2]).join
       expect(JSON.parse(body)['Symbol-Header']).to eq('Goliath passes symbols')
     end
   end
@@ -294,9 +296,12 @@ describe Grape::Endpoint do
               optional :seventh
             end
           end
+          optional :nested_arr, type: Array do
+            optional :eighth
+          end
         end
-        optional :nested_arr, type: Array do
-          optional :eighth
+        optional :arr, type: Array do
+          optional :nineth
         end
       end
     end
@@ -388,7 +393,7 @@ describe Grape::Endpoint do
 
       get '/declared?first=present&nested[fourth]=1'
       expect(last_response.status).to eq(200)
-      expect(JSON.parse(last_response.body)['nested'].keys.size).to eq 3
+      expect(JSON.parse(last_response.body)['nested'].keys.size).to eq 4
     end
 
     it 'builds nested params when given array' do
@@ -419,7 +424,7 @@ describe Grape::Endpoint do
 
         get '/declared?first=present'
         expect(last_response.status).to eq(200)
-        expect(JSON.parse(last_response.body)['nested']).to be_a(Hash)
+        expect(JSON.parse(last_response.body)['nested']).to eq({})
       end
 
       it 'to be an array when include_missing is true' do
@@ -429,7 +434,17 @@ describe Grape::Endpoint do
 
         get '/declared?first=present'
         expect(last_response.status).to eq(200)
-        expect(JSON.parse(last_response.body)['nested_arr']).to be_a(Array)
+        expect(JSON.parse(last_response.body)['arr']).to be_a(Array)
+      end
+
+      it 'to be an array when nested and include_missing is true' do
+        subject.get '/declared' do
+          declared(params, include_missing: true)
+        end
+
+        get '/declared?first=present&nested[fourth]=1'
+        expect(last_response.status).to eq(200)
+        expect(JSON.parse(last_response.body)['nested']['nested_arr']).to be_a(Array)
       end
 
       it 'to be nil when include_missing is false' do

data/spec/grape/entity_spec.rb

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

data/spec/grape/exceptions/base_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Exceptions::Base do
   describe '#compose_message' do
-    subject { described_class.new.send(:compose_message, key, attributes) }
+    subject { described_class.new.send(:compose_message, key, **attributes) }
 
     let(:key) { :invalid_formatter }
     let(:attributes) { { klass: String, to_format: 'xml' } }

data/spec/grape/exceptions/body_parse_errors_spec.rb

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