grape 1.1.0 → 1.7.1

data/spec/grape/exceptions/unknown_validator_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Exceptions::UnknownValidator do
   describe '#message' do

data/spec/grape/exceptions/unsupported_group_type_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+RSpec.describe Grape::Exceptions::UnsupportedGroupType do
+  subject { described_class.new }
+
+  describe '#message' do
+    subject { described_class.new.message }
+
+    it { is_expected.to include 'group type must be Array, Hash, JSON or Array[JSON]' }
+  end
+
+  describe 'deprecated Grape::Exceptions::UnsupportedGroupTypeError' do
+    subject { Grape::Exceptions::UnsupportedGroupTypeError.new }
+
+    it 'puts a deprecation warning' do
+      expect(Warning).to receive(:warn) do |message|
+        expect(message).to include('`Grape::Exceptions::UnsupportedGroupTypeError` is deprecated')
+      end
+
+      subject
+    end
+  end
+end

data/spec/grape/exceptions/validation_errors_spec.rb

@@ -1,32 +1,34 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
 require 'ostruct'
 
 describe Grape::Exceptions::ValidationErrors do
   let(:validation_message) { 'FooBar is invalid' }
-  let(:validation_error) { OpenStruct.new(params: [validation_message]) }
+  let(:validation_error) { instance_double Grape::Exceptions::Validation, params: [validation_message], message: '' }
 
   context 'initialize' do
+    subject do
+      described_class.new(errors: [validation_error], headers: headers)
+    end
+
     let(:headers) do
       {
         'A-Header-Key' => 'A-Header-Value'
       }
     end
 
-    subject do
-      described_class.new(errors: [validation_error], headers: headers)
-    end
-
-    it 'should assign headers through base class' do
+    it 'assigns headers through base class' do
       expect(subject.headers).to eq(headers)
     end
   end
 
   context 'message' do
     context 'is not repeated' do
+      subject(:message) { error.message.split(',').map(&:strip) }
+
       let(:error) do
         described_class.new(errors: [validation_error, validation_error])
       end
-      subject(:message) { error.message.split(',').map(&:strip) }
 
       it { expect(message).to include validation_message }
       it { expect(message.size).to eq 1 }
@@ -35,9 +37,10 @@ describe Grape::Exceptions::ValidationErrors do
 
   describe '#full_messages' do
     context 'with errors' do
+      subject { described_class.new(errors: [validation_error_1, validation_error_2]).full_messages }
+
       let(:validation_error_1) { Grape::Exceptions::Validation.new(params: ['id'], message: :presence) }
       let(:validation_error_2) { Grape::Exceptions::Validation.new(params: ['name'], message: :presence) }
-      subject { described_class.new(errors: [validation_error_1, validation_error_2]).full_messages }
 
       it 'returns an array with each errors full message' do
         expect(subject).to contain_exactly('id is missing', 'name is missing')
@@ -45,9 +48,10 @@ describe Grape::Exceptions::ValidationErrors do
     end
 
     context 'when attributes is an array of symbols' do
-      let(:validation_error) { Grape::Exceptions::Validation.new(params: [:admin_field], message: 'Can not set admin-only field') }
       subject { described_class.new(errors: [validation_error]).full_messages }
 
+      let(:validation_error) { Grape::Exceptions::Validation.new(params: [:admin_field], message: 'Can not set admin-only field') }
+
       it 'returns an array with an error full message' do
         expect(subject.first).to eq('admin_field Can not set admin-only field')
       end
@@ -63,7 +67,7 @@ describe Grape::Exceptions::ValidationErrors do
 
     it 'can return structured json with separate fields' do
       subject.format :json
-      subject.rescue_from Grape::Exceptions::ValidationErrors do |e|
+      subject.rescue_from described_class do |e|
         error!(e, 400)
       end
       subject.params do
@@ -77,10 +81,12 @@ describe Grape::Exceptions::ValidationErrors do
       end
       get '/exactly_one_of', beer: 'string', wine: 'anotherstring'
       expect(last_response.status).to eq(400)
-      expect(JSON.parse(last_response.body)).to eq([
-                                                     'params' => %w[beer wine],
-                                                     'messages' => ['are mutually exclusive']
-                                                   ])
+      expect(JSON.parse(last_response.body)).to eq(
+        [
+          'params' => %w[beer wine],
+          'messages' => ['are mutually exclusive']
+        ]
+      )
     end
   end
 end

data/spec/grape/exceptions/validation_spec.rb

@@ -1,17 +1,19 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Exceptions::Validation do
   it 'fails when params are missing' do
-    expect { Grape::Exceptions::Validation.new(message: 'presence') }.to raise_error(ArgumentError, 'missing keyword: params')
+    expect { described_class.new(message: 'presence') }.to raise_error(ArgumentError, /missing keyword:.+?params/)
   end
+
   context 'when message is a symbol' do
     it 'stores message_key' do
-      expect(Grape::Exceptions::Validation.new(params: ['id'], message: :presence).message_key).to eq(:presence)
+      expect(described_class.new(params: ['id'], message: :presence).message_key).to eq(:presence)
     end
   end
+
   context 'when message is a String' do
     it 'does not store the message_key' do
-      expect(Grape::Exceptions::Validation.new(params: ['id'], message: 'presence').message_key).to eq(nil)
+      expect(described_class.new(params: ['id'], message: 'presence').message_key).to be_nil
     end
   end
 end

data/spec/grape/extensions/param_builders/hash_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Extensions::Hash::ParamBuilder do
   subject { Class.new(Grape::API) }
@@ -8,10 +8,10 @@ describe Grape::Extensions::Hash::ParamBuilder do
   end
 
   describe 'in an endpoint' do
-    context '#params' do
+    describe '#params' do
       before do
         subject.params do
-          build_with Grape::Extensions::Hash::ParamBuilder
+          build_with Grape::Extensions::Hash::ParamBuilder # rubocop:disable RSpec/DescribedClass
         end
 
         subject.get do
@@ -19,7 +19,7 @@ describe Grape::Extensions::Hash::ParamBuilder do
         end
       end
 
-      it 'should be of type Hash' do
+      it 'is of type Hash' do
         get '/'
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('Hash')
@@ -29,17 +29,17 @@ describe Grape::Extensions::Hash::ParamBuilder do
 
   describe 'in an api' do
     before do
-      subject.send(:include, Grape::Extensions::Hash::ParamBuilder)
+      subject.send(:include, Grape::Extensions::Hash::ParamBuilder) # rubocop:disable RSpec/DescribedClass
     end
 
-    context '#params' do
+    describe '#params' do
       before do
         subject.get do
           params.class
         end
       end
 
-      it 'should be Hash' do
+      it 'is Hash' do
         get '/'
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('Hash')
@@ -67,7 +67,7 @@ describe Grape::Extensions::Hash::ParamBuilder do
 
     it 'symbolizes the params' do
       subject.params do
-        build_with Grape::Extensions::Hash::ParamBuilder
+        build_with Grape::Extensions::Hash::ParamBuilder # rubocop:disable RSpec/DescribedClass
         requires :a, type: String
       end
 

data/spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder do
   subject { Class.new(Grape::API) }
@@ -8,10 +8,10 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
   end
 
   describe 'in an endpoint' do
-    context '#params' do
+    describe '#params' do
       before do
         subject.params do
-          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder # rubocop:disable RSpec/DescribedClass
         end
 
         subject.get do
@@ -19,7 +19,7 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
         end
       end
 
-      it 'should be of type Hash' do
+      it 'is of type Hash' do
         get '/'
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('ActiveSupport::HashWithIndifferentAccess')
@@ -29,10 +29,10 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
 
   describe 'in an api' do
     before do
-      subject.send(:include, Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder)
+      subject.send(:include, Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder) # rubocop:disable RSpec/DescribedClass
     end
 
-    context '#params' do
+    describe '#params' do
       before do
         subject.get do
           params.class
@@ -47,7 +47,7 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
 
       it 'parses sub hash params' do
         subject.params do
-          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder # rubocop:disable RSpec/DescribedClass
 
           optional :a, type: Hash do
             optional :b, type: Hash do
@@ -68,7 +68,7 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
 
       it 'params are indifferent to symbol or string keys' do
         subject.params do
-          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder # rubocop:disable RSpec/DescribedClass
           optional :a, type: Hash do
             optional :b, type: Hash do
               optional :c, type: String
@@ -88,7 +88,7 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
 
       it 'responds to string keys' do
         subject.params do
-          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder # rubocop:disable RSpec/DescribedClass
           requires :a, type: String
         end
 

data/spec/grape/extensions/param_builders/hashie/mash_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Extensions::Hashie::Mash::ParamBuilder do
   subject { Class.new(Grape::API) }
@@ -8,10 +8,10 @@ describe Grape::Extensions::Hashie::Mash::ParamBuilder do
   end
 
   describe 'in an endpoint' do
-    context '#params' do
+    describe '#params' do
       before do
         subject.params do
-          build_with Grape::Extensions::Hashie::Mash::ParamBuilder
+          build_with Grape::Extensions::Hashie::Mash::ParamBuilder # rubocop:disable RSpec/DescribedClass
         end
 
         subject.get do
@@ -19,7 +19,7 @@ describe Grape::Extensions::Hashie::Mash::ParamBuilder do
         end
       end
 
-      it 'should be of type Hashie::Mash' do
+      it 'is of type Hashie::Mash' do
         get '/'
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('Hashie::Mash')
@@ -29,17 +29,17 @@ describe Grape::Extensions::Hashie::Mash::ParamBuilder do
 
   describe 'in an api' do
     before do
-      subject.send(:include, Grape::Extensions::Hashie::Mash::ParamBuilder)
+      subject.send(:include, Grape::Extensions::Hashie::Mash::ParamBuilder) # rubocop:disable RSpec/DescribedClass
     end
 
-    context '#params' do
+    describe '#params' do
       before do
         subject.get do
           params.class
         end
       end
 
-      it 'should be Hashie::Mash' do
+      it 'is Hashie::Mash' do
         get '/'
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('Hashie::Mash')
@@ -55,7 +55,7 @@ describe Grape::Extensions::Hashie::Mash::ParamBuilder do
         end
       end
 
-      it 'should be Hashie::Mash' do
+      it 'is Hashie::Mash' do
         get '/foo'
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('Hashie::Mash')
@@ -64,7 +64,7 @@ describe Grape::Extensions::Hashie::Mash::ParamBuilder do
 
     it 'is indifferent to key or symbol access' do
       subject.params do
-        build_with Grape::Extensions::Hashie::Mash::ParamBuilder
+        build_with Grape::Extensions::Hashie::Mash::ParamBuilder # rubocop:disable RSpec/DescribedClass
         requires :a, type: String
       end
       subject.get '/foo' do

data/spec/grape/integration/global_namespace_function_spec.rb

@@ -1,6 +1,6 @@
-# see https://github.com/ruby-grape/grape/issues/1348
+# frozen_string_literal: true
 
-require 'spec_helper'
+# see https://github.com/ruby-grape/grape/issues/1348
 
 def namespace
   raise

data/spec/grape/integration/rack_sendfile_spec.rb

@@ -1,13 +1,17 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Rack::Sendfile do
   subject do
-    send_file = file_streamer
+    content_object = file_object
     app = Class.new(Grape::API) do
       use Rack::Sendfile
       format :json
       get do
-        file send_file
+        if content_object.is_a?(String)
+          sendfile content_object
+        else
+          stream content_object
+        end
       end
     end
 
@@ -20,9 +24,9 @@ describe Rack::Sendfile do
     app.call(env)
   end
 
-  context do
-    let(:file_streamer) do
-      double(:file_streamer, to_path: '/accel/mapping/some/path')
+  context 'when calling sendfile' do
+    let(:file_object) do
+      '/accel/mapping/some/path'
     end
 
     it 'contains Sendfile headers' do
@@ -31,14 +35,14 @@ describe Rack::Sendfile do
     end
   end
 
-  context do
-    let(:file_streamer) do
-      double(:file_streamer)
+  context 'when streaming non file content' do
+    let(:file_object) do
+      double(:file_object, each: nil)
     end
 
     it 'not contains Sendfile headers' do
       headers = subject[1]
-      expect(headers).to_not include('X-Accel-Redirect')
+      expect(headers).not_to include('X-Accel-Redirect')
     end
   end
 end

data/spec/grape/integration/rack_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Rack do
   it 'correctly populates params from a Tempfile' do
@@ -19,16 +19,33 @@ describe Rack do
       }
       env = Rack::MockRequest.env_for('/', options)
 
-      unless RUBY_PLATFORM == 'java'
-        major, minor, patch = Rack.release.split('.').map(&:to_i)
-        patch ||= 0 # rack <= 1.5.2 does not specify patch version
-        pending 'Rack 1.5.3 or 1.6.1 required' unless major >= 2 || (major >= 1 && ((minor == 5 && patch >= 3) || (minor >= 6)))
-      end
-
-      expect(JSON.parse(app.call(env)[2].body.first)['params_keys']).to match_array('test')
+      expect(JSON.parse(read_chunks(app.call(env)[2]).join)['params_keys']).to match_array('test')
     ensure
       input.close
       input.unlink
     end
   end
+
+  context 'when the app is mounted' do
+    let(:ping_mount) do
+      Class.new(Grape::API) do
+        get 'ping'
+      end
+    end
+
+    let(:app) do
+      app_to_mount = ping_mount
+      app = Class.new(Grape::API) do
+        namespace 'namespace' do
+          mount app_to_mount
+        end
+      end
+      Rack::Builder.new(app)
+    end
+
+    it 'finds the app on the namespace' do
+      get '/namespace/ping'
+      expect(last_response.status).to eq 200
+    end
+  end
 end

data/spec/grape/loading_spec.rb

@@ -1,6 +1,14 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::API do
+  subject do
+    CombinedApi = combined_api
+    Class.new(Grape::API) do
+      format :json
+      mount CombinedApi => '/'
+    end
+  end
+
   let(:jobs_api) do
     Class.new(Grape::API) do
       namespace :one do
@@ -24,14 +32,6 @@ describe Grape::API do
     end
   end
 
-  subject do
-    CombinedApi = combined_api
-    Class.new(Grape::API) do
-      format :json
-      mount CombinedApi => '/'
-    end
-  end
-
   def app
     subject
   end

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

@@ -1,4 +1,5 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
 require 'base64'
 
 describe Grape::Middleware::Auth::Base do

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

@@ -1,9 +1,9 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Middleware::Auth::DSL do
   subject { Class.new(Grape::API) }
 
-  let(:block) { ->() {} }
+  let(:block) { -> {} }
   let(:settings) do
     {
       opaque: 'secret',
@@ -14,16 +14,16 @@ describe Grape::Middleware::Auth::DSL do
   end
 
   describe '.auth' do
-    it 'stets auth parameters' do
-      expect(subject).to receive(:use).with(Grape::Middleware::Auth::Base, settings)
+    it 'sets auth parameters' do
+      expect(subject.base_instance).to receive(:use).with(Grape::Middleware::Auth::Base, settings)
 
       subject.auth :http_digest, realm: settings[:realm], opaque: settings[:opaque], &settings[:proc]
       expect(subject.auth).to eq(settings)
     end
 
     it 'can be called multiple times' do
-      expect(subject).to receive(:use).with(Grape::Middleware::Auth::Base, settings)
-      expect(subject).to receive(:use).with(Grape::Middleware::Auth::Base, settings.merge(realm: 'super_secret'))
+      expect(subject.base_instance).to receive(:use).with(Grape::Middleware::Auth::Base, settings)
+      expect(subject.base_instance).to receive(:use).with(Grape::Middleware::Auth::Base, settings.merge(realm: 'super_secret'))
 
       subject.auth :http_digest, realm: settings[:realm], opaque: settings[:opaque], &settings[:proc]
       first_settings = subject.auth
@@ -36,16 +36,25 @@ describe Grape::Middleware::Auth::DSL do
   end
 
   describe '.http_basic' do
-    it 'stets auth parameters' do
+    it 'sets auth parameters' do
       subject.http_basic realm: 'my_realm', &settings[:proc]
       expect(subject.auth).to eq(realm: 'my_realm', type: :http_basic, proc: block)
     end
   end
 
   describe '.http_digest' do
-    it 'stets auth parameters' do
-      subject.http_digest realm: 'my_realm', opaque: 'my_opaque', &settings[:proc]
-      expect(subject.auth).to eq(realm: 'my_realm', type: :http_digest, proc: block, opaque: 'my_opaque')
+    context 'when realm is a hash' do
+      it 'sets auth parameters' do
+        subject.http_digest realm: { realm: 'my_realm', opaque: 'my_opaque' }, &settings[:proc]
+        expect(subject.auth).to eq(realm: { realm: 'my_realm', opaque: 'my_opaque' }, type: :http_digest, proc: block)
+      end
+    end
+
+    context 'when realm is not hash' do
+      it 'sets auth parameters' do
+        subject.http_digest realm: 'my_realm', opaque: 'my_opaque', &settings[:proc]
+        expect(subject.auth).to eq(realm: 'my_realm', type: :http_digest, proc: block, opaque: 'my_opaque')
+      end
     end
   end
 end

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

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 require 'base64'
 
@@ -34,13 +34,23 @@ describe Grape::Middleware::Auth::Strategies do
     RSpec::Matchers.define :be_challenge do
       match do |actual_response|
         actual_response.status == 401 &&
-          actual_response['WWW-Authenticate'] =~ /^Digest / &&
+          actual_response['WWW-Authenticate'].start_with?('Digest ') &&
           actual_response.body.empty?
       end
     end
 
     module StrategiesSpec
-      class Test < Grape::API
+      class PasswordHashed < Grape::API
+        http_digest(realm: { realm: 'Test Api', opaque: 'secret', passwords_hashed: true }) do |username|
+          { 'foo' => Digest::MD5.hexdigest(['foo', 'Test Api', 'bar'].join(':')) }[username]
+        end
+
+        get '/test' do
+          [{ hey: 'you' }, { there: 'bar' }, { foo: 'baz' }]
+        end
+      end
+
+      class PasswordIsNotHashed < Grape::API
         http_digest(realm: 'Test Api', opaque: 'secret') do |username|
           { 'foo' => 'bar' }[username]
         end
@@ -51,30 +61,60 @@ describe Grape::Middleware::Auth::Strategies do
       end
     end
 
-    def app
-      StrategiesSpec::Test
-    end
+    context 'when password is hashed' do
+      def app
+        StrategiesSpec::PasswordHashed
+      end
 
-    it 'is a digest authentication challenge' do
-      get '/test'
-      expect(last_response).to be_challenge
-    end
+      it 'is a digest authentication challenge' do
+        get '/test'
+        expect(last_response).to be_challenge
+      end
 
-    it 'throws a 401 if no auth is given' do
-      get '/test'
-      expect(last_response.status).to eq(401)
-    end
+      it 'throws a 401 if no auth is given' do
+        get '/test'
+        expect(last_response.status).to eq(401)
+      end
 
-    it 'authenticates if given valid creds' do
-      digest_authorize 'foo', 'bar'
-      get '/test'
-      expect(last_response.status).to eq(200)
+      it 'authenticates if given valid creds' do
+        digest_authorize 'foo', 'bar'
+        get '/test'
+        expect(last_response.status).to eq(200)
+      end
+
+      it 'throws a 401 if given invalid creds' do
+        digest_authorize 'bar', 'foo'
+        get '/test'
+        expect(last_response.status).to eq(401)
+      end
     end
 
-    it 'throws a 401 if given invalid creds' do
-      digest_authorize 'bar', 'foo'
-      get '/test'
-      expect(last_response.status).to eq(401)
+    context 'when password is not hashed' do
+      def app
+        StrategiesSpec::PasswordIsNotHashed
+      end
+
+      it 'is a digest authentication challenge' do
+        get '/test'
+        expect(last_response).to be_challenge
+      end
+
+      it 'throws a 401 if no auth is given' do
+        get '/test'
+        expect(last_response.status).to eq(401)
+      end
+
+      it 'authenticates if given valid creds' do
+        digest_authorize 'foo', 'bar'
+        get '/test'
+        expect(last_response.status).to eq(200)
+      end
+
+      it 'throws a 401 if given invalid creds' do
+        digest_authorize 'bar', 'foo'
+        get '/test'
+        expect(last_response.status).to eq(401)
+      end
     end
   end
 end