grape 1.0.0 → 1.6.0

data/spec/grape/entity_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'grape_entity'
 
@@ -114,7 +116,7 @@ describe Grape::Entity do
       expect(last_response.body).to eq('Auto-detect!')
     end
 
-    it 'does not run autodetection for Entity when explicitely provided' do
+    it 'does not run autodetection for Entity when explicitly provided' do
       entity = Class.new(Grape::Entity)
       some_array = []
 
@@ -169,7 +171,7 @@ describe Grape::Entity do
       expect(inner_body).to eql(root: { abc: 'def' })
     end
 
-    [:json, :serializable_hash].each do |format|
+    %i[json serializable_hash].each do |format|
       it "presents with #{format}" do
         entity = Class.new(Grape::Entity)
         entity.root 'examples', 'example'
@@ -179,6 +181,7 @@ describe Grape::Entity do
         subject.get '/example' do
           c = Class.new do
             attr_reader :id
+
             def initialize(id)
               @id = id
             end
@@ -200,6 +203,7 @@ describe Grape::Entity do
         subject.get '/examples' do
           c = Class.new do
             attr_reader :id
+
             def initialize(id)
               @id = id
             end
@@ -224,6 +228,7 @@ describe Grape::Entity do
       subject.get '/example' do
         c = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -233,14 +238,14 @@ describe Grape::Entity do
       get '/example'
       expect(last_response.status).to eq(200)
       expect(last_response.headers['Content-type']).to eq('application/xml')
-      expect(last_response.body).to eq <<-XML
-<?xml version="1.0" encoding="UTF-8"?>
-<hash>
-  <example>
-    <name>johnnyiller</name>
-  </example>
-</hash>
-XML
+      expect(last_response.body).to eq <<~XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <hash>
+          <example>
+            <name>johnnyiller</name>
+          </example>
+        </hash>
+      XML
     end
 
     it 'presents with json' do
@@ -253,6 +258,7 @@ XML
       subject.get '/example' do
         c = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -282,6 +288,7 @@ XML
       subject.get '/example' do
         c = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -300,6 +307,7 @@ XML
       it 'present with multiple entities using optional symbol' do
         user = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -318,7 +326,7 @@ XML
         end
         get '/example'
         expect_response_json = {
-          'page'  => 1,
+          'page' => 1,
           'user1' => { 'name' => 'user1' },
           'user2' => { 'name' => 'user2' }
         }

data/spec/grape/exceptions/base_spec.rb

@@ -0,0 +1,67 @@
+# 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) }
+
+    let(:key) { :invalid_formatter }
+    let(:attributes) { { klass: String, to_format: 'xml' } }
+
+    after do
+      I18n.enforce_available_locales = true
+      I18n.available_locales = %i[en]
+      I18n.locale = :en
+      I18n.default_locale = :en
+      I18n.reload!
+    end
+
+    context 'when I18n enforces available locales' do
+      before { I18n.enforce_available_locales = true }
+
+      context 'when the fallback locale is available' do
+        before do
+          I18n.available_locales = %i[de en]
+          I18n.default_locale = :de
+        end
+
+        it 'returns the translated message' do
+          expect(subject).to eq('cannot convert String to xml')
+        end
+      end
+
+      context 'when the fallback locale is not available' do
+        before do
+          I18n.available_locales = %i[de jp]
+          I18n.locale = :de
+          I18n.default_locale = :de
+        end
+
+        it 'returns the translation string' do
+          expect(subject).to eq("grape.errors.messages.#{key}")
+        end
+      end
+    end
+
+    context 'when I18n does not enforce available locales' do
+      before { I18n.enforce_available_locales = false }
+
+      context 'when the fallback locale is available' do
+        before { I18n.available_locales = %i[de en] }
+
+        it 'returns the translated message' do
+          expect(subject).to eq('cannot convert String to xml')
+        end
+      end
+
+      context 'when the fallback locale is not available' do
+        before { I18n.available_locales = %i[de jp] }
+
+        it 'returns the translated message' do
+          expect(subject).to eq('cannot convert String to xml')
+        end
+      end
+    end
+  end
+end

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

data/spec/grape/exceptions/invalid_accept_header_spec.rb

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

data/spec/grape/exceptions/invalid_formatter_spec.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Exceptions::InvalidFormatter do

data/spec/grape/exceptions/invalid_response_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::Exceptions::InvalidResponse do
+  describe '#message' do
+    let(:error) { described_class.new }
+
+    it 'contains the problem in the message' do
+      expect(error.message).to include('Invalid response')
+    end
+  end
+end

data/spec/grape/exceptions/invalid_versioner_option_spec.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Exceptions::InvalidVersionerOption do

data/spec/grape/exceptions/missing_mime_type_spec.rb

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

data/spec/grape/exceptions/missing_option_spec.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Exceptions::MissingOption do

data/spec/grape/exceptions/unknown_options_spec.rb

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Exceptions::UnknownOptions do
   describe '#message' do
     let(:error) do
-      described_class.new([:a, :b])
+      described_class.new(%i[a b])
     end
 
     it 'contains the problem in the message' do

data/spec/grape/exceptions/unknown_validator_spec.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Exceptions::UnknownValidator do

data/spec/grape/exceptions/validation_errors_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'ostruct'
 
@@ -43,6 +45,15 @@ describe Grape::Exceptions::ValidationErrors do
         expect(subject).to contain_exactly('id is missing', 'name is missing')
       end
     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 }
+
+      it 'returns an array with an error full message' do
+        expect(subject.first).to eq('admin_field Can not set admin-only field')
+      end
+    end
   end
 
   context 'api' do
@@ -68,10 +79,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,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 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 { Grape::Exceptions::Validation.new(message: 'presence') }.to raise_error(ArgumentError, /missing keyword:.+?params/)
   end
   context 'when message is a symbol' do
     it 'stores message_key' do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Extensions::Hash::ParamBuilder do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Extensions::Hashie::Mash::ParamBuilder do

data/spec/grape/integration/global_namespace_function_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # see https://github.com/ruby-grape/grape/issues/1348
 
 require 'spec_helper'

data/spec/grape/integration/rack_sendfile_spec.rb

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

data/spec/grape/integration/rack_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rack do
@@ -19,16 +21,32 @@ 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
+    def app
+      @main_app ||= Class.new(Grape::API) do
+        get 'ping'
+      end
+    end
+
+    let!(:base) do
+      app_to_mount = app
+      Class.new(Grape::API) do
+        namespace 'namespace' do
+          mount app_to_mount
+        end
+      end
+    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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::API do

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

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

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Auth::DSL do
   subject { Class.new(Grape::API) }
 
-  let(:block) { ->() {} }
+  let(:block) { -> {} }
   let(:settings) do
     {
       opaque: 'secret',
@@ -15,15 +17,15 @@ describe Grape::Middleware::Auth::DSL do
 
   describe '.auth' do
     it 'stets auth parameters' do
-      expect(subject).to receive(:use).with(Grape::Middleware::Auth::Base, settings)
+      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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 require 'base64'
@@ -34,7 +36,7 @@ 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

data/spec/grape/middleware/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Base do
@@ -114,6 +116,14 @@ describe Grape::Middleware::Base do
     end
   end
 
+  describe '#context' do
+    subject { Grape::Middleware::Base.new(blank_app) }
+    it 'allows access to response context' do
+      subject.call(Grape::Env::API_ENDPOINT => { header: 'some header' })
+      expect(subject.context).to eq(header: 'some header')
+    end
+  end
+
   context 'options' do
     it 'persists options passed at initialization' do
       expect(Grape::Middleware::Base.new(blank_app, abc: true).options[:abc]).to be true

data/spec/grape/middleware/error_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'grape-entity'
 
@@ -14,8 +16,7 @@ describe Grape::Middleware::Error do
 
     class ErrApp
       class << self
-        attr_accessor :error
-        attr_accessor :format
+        attr_accessor :error, :format
 
         def call(_env)
           throw :error, error
@@ -28,7 +29,7 @@ describe Grape::Middleware::Error do
     opts = options
     Rack::Builder.app do
       use Spec::Support::EndpointFaker
-      use Grape::Middleware::Error, opts
+      use Grape::Middleware::Error, **opts
       run ErrorSpec::ErrApp
     end
   end