grape 1.1.0 → 1.7.1

data/spec/grape/config_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+describe '.configure' do
+  before do
+    Grape.configure do |config|
+      config.param_builder = 42
+    end
+  end
+
+  after do
+    Grape.config.reset
+  end
+
+  it 'is configured to the new value' do
+    expect(Grape.config.param_builder).to eq 42
+  end
+end

data/spec/grape/dsl/callbacks_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 module Grape
   module DSL
@@ -10,7 +10,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/desc_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 module Grape
   module DSL
@@ -21,36 +21,62 @@ module Grape
 
         it 'can be set with a block' do
           expected_options = {
+            summary: 'summary',
             description: 'The description',
             detail: 'more details',
             params: { first: :param },
             entity: Object,
+            default: { code: 400, message: 'Invalid' },
             http_codes: [[401, 'Unauthorized', 'Entities::Error']],
             named: 'My named route',
-            headers: [XAuthToken: {
-              description: 'Valdates your identity',
-              required: true
-            },
-                      XOptionalHeader: {
-                        description: 'Not really needed',
-                        required: false
-                      }]
+            body_name: 'My body name',
+            headers: [
+              XAuthToken: {
+                description: 'Valdates your identity',
+                required: true
+              },
+              XOptionalHeader: {
+                description: 'Not really needed',
+                required: false
+              }
+            ],
+            hidden: false,
+            deprecated: false,
+            is_array: true,
+            nickname: 'nickname',
+            produces: %w[array of mime_types],
+            consumes: %w[array of mime_types],
+            tags: %w[tag1 tag2],
+            security: %w[array of security schemes]
           }
 
           subject.desc 'The description' do
+            summary 'summary'
             detail 'more details'
             params(first: :param)
             success Object
+            default code: 400, message: 'Invalid'
             failure [[401, 'Unauthorized', 'Entities::Error']]
             named 'My named route'
-            headers [XAuthToken: {
-              description: 'Valdates your identity',
-              required: true
-            },
-                     XOptionalHeader: {
-                       description: 'Not really needed',
-                       required: false
-                     }]
+            body_name 'My body name'
+            headers [
+              XAuthToken: {
+                description: 'Valdates your identity',
+                required: true
+              },
+              XOptionalHeader: {
+                description: 'Not really needed',
+                required: false
+              }
+            ]
+            hidden false
+            deprecated false
+            is_array true
+            nickname 'nickname'
+            produces %w[array of mime_types]
+            consumes %w[array of mime_types]
+            tags %w[tag1 tag2]
+            security %w[array of security schemes]
           end
 
           expect(subject.namespace_setting(:description)).to eq(expected_options)

data/spec/grape/dsl/headers_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 module Grape
   module DSL
@@ -10,21 +10,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

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 module Grape
   module DSL
@@ -32,6 +32,7 @@ module Grape
 
     describe Helpers do
       subject { Class.new(HelpersSpec::Dummy) }
+
       let(:proc) do
         lambda do |*|
           def test
@@ -52,7 +53,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)
 
@@ -75,9 +76,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
 
@@ -90,7 +91,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

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 module Grape
   module DSL
@@ -23,7 +23,7 @@ describe Grape::Endpoint do
 
   describe '#version' do
     it 'defaults to nil' do
-      expect(subject.version).to be nil
+      expect(subject.version).to be_nil
     end
 
     it 'returns env[api.version]' do
@@ -41,6 +41,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
@@ -51,6 +52,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
@@ -134,7 +136,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
@@ -163,7 +165,7 @@ describe Grape::Endpoint do
     end
 
     it 'returns default' do
-      expect(subject.content_type).to be nil
+      expect(subject.content_type).to be_nil
     end
   end
 
@@ -196,85 +198,234 @@ describe Grape::Endpoint do
     end
 
     it 'returns default' do
-      expect(subject.body).to be nil
+      expect(subject.body).to be_nil
     end
   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 be_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 be_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 be_nil
+        end
+
+        it 'sets Transfer-Encoding header to nil' do
+          subject.stream stream_object
+
+          expect(subject.header['Transfer-Encoding']).to be_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 be_nil
     end
   end
 

data/spec/grape/dsl/logger_spec.rb

@@ -1,26 +1,24 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-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

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 module Grape
   module DSL
@@ -10,7 +10,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 }
 
@@ -22,6 +23,14 @@ module Grape
         end
       end
 
+      describe '.insert' do
+        it 'adds a middleware with the right operation' do
+          expect(subject).to receive(:namespace_stackable).with(:middleware, [:insert, 0, :arg1, proc])
+
+          subject.insert 0, :arg1, &proc
+        end
+      end
+
       describe '.insert_before' do
         it 'adds a middleware with the right operation' do
           expect(subject).to receive(:namespace_stackable).with(:middleware, [:insert_before, foo_middleware, :arg1, proc])

data/spec/grape/dsl/parameters_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 module Grape
   module DSL
@@ -38,6 +38,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
@@ -52,6 +53,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 {} } }