grape 1.0.0 → 1.6.0

data/spec/integration/eager_load/eager_load_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'grape'
+
+describe Grape do
+  it 'eager_load!' do
+    require 'grape/eager_load'
+    expect { Grape.eager_load! }.to_not raise_error
+  end
+
+  it 'compile!' do
+    expect { Class.new(Grape::API).compile! }.to_not raise_error
+  end
+end

data/spec/integration/multi_json/json_spec.rb

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

data/spec/integration/multi_xml/xml_spec.rb

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

data/spec/shared/versioning_examples.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 shared_examples_for 'versioning' do
   it 'sets the API version' do
     subject.format :txt
@@ -5,7 +7,7 @@ shared_examples_for 'versioning' do
     subject.get :hello do
       "Version: #{request.env['api.version']}"
     end
-    versioned_get '/hello', 'v1', macro_options
+    versioned_get '/hello', 'v1', **macro_options
     expect(last_response.body).to eql 'Version: v1'
   end
 
@@ -16,7 +18,7 @@ shared_examples_for 'versioning' do
     subject.get :hello do
       "Version: #{request.env['api.version']}"
     end
-    versioned_get '/hello', 'v1', macro_options.merge(prefix: 'api')
+    versioned_get '/hello', 'v1', **macro_options.merge(prefix: 'api')
     expect(last_response.body).to eql 'Version: v1'
   end
 
@@ -32,14 +34,14 @@ shared_examples_for 'versioning' do
       end
     end
 
-    versioned_get '/awesome', 'v1', macro_options
+    versioned_get '/awesome', 'v1', **macro_options
     expect(last_response.status).to eql 404
 
-    versioned_get '/awesome', 'v2', macro_options
+    versioned_get '/awesome', 'v2', **macro_options
     expect(last_response.status).to eql 200
-    versioned_get '/legacy', 'v1', macro_options
+    versioned_get '/legacy', 'v1', **macro_options
     expect(last_response.status).to eql 200
-    versioned_get '/legacy', 'v2', macro_options
+    versioned_get '/legacy', 'v2', **macro_options
     expect(last_response.status).to eql 404
   end
 
@@ -49,11 +51,11 @@ shared_examples_for 'versioning' do
       'I exist'
     end
 
-    versioned_get '/awesome', 'v1', macro_options
+    versioned_get '/awesome', 'v1', **macro_options
     expect(last_response.status).to eql 200
-    versioned_get '/awesome', 'v2', macro_options
+    versioned_get '/awesome', 'v2', **macro_options
     expect(last_response.status).to eql 200
-    versioned_get '/awesome', 'v3', macro_options
+    versioned_get '/awesome', 'v3', **macro_options
     expect(last_response.status).to eql 404
   end
 
@@ -68,14 +70,14 @@ shared_examples_for 'versioning' do
 
         subject.version 'v1', macro_options do
           get 'version' do
-            'version ' + request.env['api.version']
+            "version #{request.env['api.version']}"
           end
         end
 
-        versioned_get '/version', 'v2', macro_options
+        versioned_get '/version', 'v2', **macro_options
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('v2')
-        versioned_get '/version', 'v1', macro_options
+        versioned_get '/version', 'v1', **macro_options
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('version v1')
       end
@@ -92,15 +94,15 @@ shared_examples_for 'versioning' do
 
         subject.version 'v1', macro_options do
           get 'version' do
-            'version ' + request.env['api.version']
+            "version #{request.env['api.version']}"
           end
         end
 
-        versioned_get '/version', 'v1', macro_options.merge(prefix: subject.prefix)
+        versioned_get '/version', 'v1', **macro_options.merge(prefix: subject.prefix)
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('version v1')
 
-        versioned_get '/version', 'v2', macro_options.merge(prefix: subject.prefix)
+        versioned_get '/version', 'v2', **macro_options.merge(prefix: subject.prefix)
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('v2')
       end
@@ -129,11 +131,11 @@ shared_examples_for 'versioning' do
         end
       end
 
-      versioned_get '/version', 'v1', macro_options.merge(prefix: subject.prefix)
+      versioned_get '/version', 'v1', **macro_options.merge(prefix: subject.prefix)
       expect(last_response.status).to eq(200)
       expect(last_response.body).to eq('v1-version')
 
-      versioned_get '/version', 'v2', macro_options.merge(prefix: subject.prefix)
+      versioned_get '/version', 'v2', **macro_options.merge(prefix: subject.prefix)
       expect(last_response.status).to eq(200)
       expect(last_response.body).to eq('v2-version')
     end
@@ -146,7 +148,65 @@ shared_examples_for 'versioning' do
     subject.get :api_version_with_version_param do
       params[:version]
     end
-    versioned_get '/api_version_with_version_param?version=1', 'v1', macro_options
+    versioned_get '/api_version_with_version_param?version=1', 'v1', **macro_options
     expect(last_response.body).to eql '1'
   end
+
+  context 'with catch-all' do
+    let(:options) { macro_options }
+    let(:v1) do
+      klass = Class.new(Grape::API)
+      klass.version 'v1', options
+      klass.get 'version' do
+        'v1'
+      end
+      klass
+    end
+    let(:v2) do
+      klass = Class.new(Grape::API)
+      klass.version 'v2', options
+      klass.get 'version' do
+        'v2'
+      end
+      klass
+    end
+    before do
+      subject.format :txt
+
+      subject.mount v1
+      subject.mount v2
+
+      subject.route :any, '*path' do
+        params[:path]
+      end
+    end
+
+    context 'v1' do
+      it 'finds endpoint' do
+        versioned_get '/version', 'v1', **macro_options
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('v1')
+      end
+
+      it 'finds catch all' do
+        versioned_get '/whatever', 'v1', **macro_options
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to end_with 'whatever'
+      end
+    end
+
+    context 'v2' do
+      it 'finds endpoint' do
+        versioned_get '/version', 'v2', **macro_options
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('v2')
+      end
+
+      it 'finds catch all' do
+        versioned_get '/whatever', 'v2', **macro_options
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to end_with 'whatever'
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
@@ -8,18 +10,27 @@ require 'rubygems'
 require 'bundler'
 Bundler.require :default, :test
 
-Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each do |file|
   require file
 end
 
-I18n.enforce_available_locales = false
+eager_load!
+
+# The default value for this setting is true in a standard Rails app,
+# so it should be set to true here as well to reflect that.
+I18n.enforce_available_locales = true
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods
   config.include Spec::Support::Helpers
   config.raise_errors_for_deprecations!
+  config.filter_run_when_matching :focus
+  config.warnings = true
 
   config.before(:each) { Grape::Util::InheritableSetting.reset_global! }
+
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
 end
 
 require 'coveralls'

data/spec/support/basic_auth_encode_helpers.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Spec
   module Support
     module Helpers
       def encode_basic_auth(username, password)
-        'Basic ' + Base64.encode64("#{username}:#{password}")
+        "Basic #{Base64.encode64("#{username}:#{password}")}"
       end
     end
   end

data/spec/support/chunks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Chunks
+  def read_chunks(body)
+    buffer = []
+    body.each { |chunk| buffer << chunk }
+
+    buffer
+  end
+end
+
+RSpec.configure do |config|
+  config.include Chunks
+end

data/spec/support/content_type_helpers.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Spec
   module Support
     module Helpers
-      %w(put patch post delete).each do |method|
+      %w[put patch post delete].each do |method|
         define_method :"#{method}_with_json" do |uri, params = {}, env = {}, &block|
           params = params.to_json
           env['CONTENT_TYPE'] ||= 'application/json'

data/spec/support/eager_load.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Grape uses autoload https://api.rubyonrails.org/classes/ActiveSupport/Autoload.html.
+# When a class/module get added to the list, ActiveSupport doesn't check whether it really exists.
+# This method loads all classes/modules defined via autoload to be sure only existing
+# classes/modules were listed.
+def eager_load!(scope = Grape)
+  # get modules
+  scope.constants.each do |const_name|
+    const = scope.const_get(const_name)
+
+    next unless const.respond_to?(:eager_load!)
+
+    const.eager_load!
+
+    # check its modules, they might need to be loaded as well.
+    eager_load!(const)
+  end
+end

data/spec/support/endpoint_faker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spec
   module Support
     class EndpointFaker

data/spec/support/file_streamer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class FileStreamer
   def initialize(file_path)
     @file_path = file_path

data/spec/support/integer_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spec
   module Support
     module Helpers

data/spec/support/versioned_helpers.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # Versioning
 module Spec
   module Support
     module Helpers
       # Returns the path with options[:version] prefixed if options[:using] is :path.
       # Returns normal path otherwise.
-      def versioned_path(options = {})
+      def versioned_path(**options)
         case options[:using]
         when :path
           File.join('/', options[:prefix] || '', options[:version], options[:path])
@@ -19,7 +21,7 @@ module Spec
         end
       end
 
-      def versioned_headers(options)
+      def versioned_headers(**options)
         case options[:using]
         when :path
           {}  # no-op
@@ -41,13 +43,11 @@ module Spec
         end
       end
 
-      def versioned_get(path, version_name, version_options = {})
-        path    = versioned_path(version_options.merge(version: version_name, path: path))
-        headers = versioned_headers(version_options.merge(version: version_name))
+      def versioned_get(path, version_name, **version_options)
+        path = versioned_path(**version_options.merge(version: version_name, path: path))
+        headers = versioned_headers(**version_options.merge(version: version_name))
         params = {}
-        if version_options[:using] == :param
-          params = { version_options[:parameter] => version_name }
-        end
+        params = { version_options[:parameter] => version_name } if version_options[:using] == :param
         get path, params, headers
       end
     end