grape 1.2.3 → 1.2.4

data/lib/grape/validations/params_scope.rb

@@ -36,6 +36,10 @@ module Grape
         configure_declared_params
       end
 
+      def configuration
+        @api.configuration.evaluate
+      end
+
       # @return [Boolean] whether or not this entire scope needs to be
       #   validated
       def should_validate?(parameters)
@@ -52,6 +56,7 @@ module Grape
 
         return true unless @dependent_on
         return params.any? { |param| meets_dependency?(param, request_params) } if params.is_a?(Array)
+        return false unless params.respond_to?(:with_indifferent_access)
         params = params.with_indifferent_access
 
         @dependent_on.each do |dependency|
@@ -119,8 +124,8 @@ module Grape
           @parent.push_declared_params(attrs, opts)
         else
           if opts && opts[:as]
-            @api.route_setting(:aliased_params, @api.route_setting(:aliased_params) || [])
-            @api.route_setting(:aliased_params) << { attrs.first => opts[:as] }
+            @api.route_setting(:renamed_params, @api.route_setting(:renamed_params) || [])
+            @api.route_setting(:renamed_params) << { attrs.first => opts[:as] }
             attrs = [opts[:as]]
           end
 

data/lib/grape/validations/validators/as.rb

@@ -2,12 +2,12 @@ module Grape
   module Validations
     class AsValidator < Base
       def initialize(attrs, options, required, scope, opts = {})
-        @alias = options
+        @renamed_options = options
         super
       end
 
       def validate_param!(attr_name, params)
-        params[@alias] = params[attr_name]
+        params[@renamed_options] = params[attr_name]
       end
     end
   end

data/lib/grape/version.rb

@@ -1,4 +1,4 @@
 module Grape
   # The current version of Grape.
-  VERSION = '1.2.3'.freeze
+  VERSION = '1.2.4'.freeze
 end

data/spec/grape/api_remount_spec.rb

@@ -63,22 +63,245 @@ describe Grape::API do
       end
     end
 
-    context 'with a dynamically configured route' do
-      before do
-        a_remounted_api.namespace 'api' do
-          get "/#{configuration[:path]}" do
-            '10 votes'
+    describe 'with dynamic configuration' do
+      context 'when mounting an endpoint conditional on a configuration' do
+        subject(:a_remounted_api) do
+          Class.new(Grape::API) do
+            get 'always' do
+              'success'
+            end
+
+            given configuration[:mount_sometimes] do
+              get 'sometimes' do
+                'sometimes'
+              end
+            end
+          end
+        end
+
+        it 'mounts the endpoints only when configured to do so' do
+          root_api.mount({ a_remounted_api => 'with_conditional' }, with: { mount_sometimes: true })
+          root_api.mount({ a_remounted_api => 'without_conditional' }, with: { mount_sometimes: false })
+
+          get '/with_conditional/always'
+          expect(last_response.body).to eq 'success'
+
+          get '/with_conditional/sometimes'
+          expect(last_response.body).to eq 'sometimes'
+
+          get '/without_conditional/always'
+          expect(last_response.body).to eq 'success'
+
+          get '/without_conditional/sometimes'
+          expect(last_response.status).to eq 404
+        end
+      end
+
+      context 'when executing a custom block on mount' do
+        subject(:a_remounted_api) do
+          Class.new(Grape::API) do
+            get 'always' do
+              'success'
+            end
+
+            mounted do
+              configuration[:endpoints].each do |endpoint_name, endpoint_response|
+                get endpoint_name do
+                  endpoint_response
+                end
+              end
+            end
           end
         end
-        root_api.mount a_remounted_api, with: { path: 'votes' }
-        root_api.mount a_remounted_api, with: { path: 'scores' }
+
+        it 'mounts the endpoints only when configured to do so' do
+          root_api.mount a_remounted_api, with: { endpoints: { 'api_name' => 'api_response' } }
+          get 'api_name'
+          expect(last_response.body).to eq 'api_response'
+        end
       end
 
-      it 'will use the dynamic configuration on all routes' do
-        get 'api/votes'
-        expect(last_response.body).to eql '10 votes'
-        get 'api/scores'
-        expect(last_response.body).to eql '10 votes'
+      context 'when the configuration is part of the arguments of a method' do
+        subject(:a_remounted_api) do
+          Class.new(Grape::API) do
+            get configuration[:endpoint_name] do
+              'success'
+            end
+          end
+        end
+
+        it 'mounts the endpoint in the location it is configured' do
+          root_api.mount a_remounted_api, with: { endpoint_name: 'some_location' }
+          get '/some_location'
+          expect(last_response.body).to eq 'success'
+
+          get '/different_location'
+          expect(last_response.status).to eq 404
+
+          root_api.mount a_remounted_api, with: { endpoint_name: 'new_location' }
+          get '/new_location'
+          expect(last_response.body).to eq 'success'
+        end
+
+        context 'when the configuration is the value in a key-arg pair' do
+          subject(:a_remounted_api) do
+            Class.new(Grape::API) do
+              version 'v1', using: :param, parameter: configuration[:version_param]
+              get 'endpoint' do
+                'version 1'
+              end
+
+              version 'v2', using: :param, parameter: configuration[:version_param]
+              get 'endpoint' do
+                'version 2'
+              end
+            end
+          end
+
+          it 'takes the param from the configuration' do
+            root_api.mount a_remounted_api, with: { version_param: 'param_name' }
+
+            get '/endpoint?param_name=v1'
+            expect(last_response.body).to eq 'version 1'
+
+            get '/endpoint?param_name=v2'
+            expect(last_response.body).to eq 'version 2'
+
+            get '/endpoint?wrong_param_name=v2'
+            expect(last_response.body).to eq 'version 1'
+          end
+        end
+      end
+
+      context 'on the DescSCope' do
+        subject(:a_remounted_api) do
+          Class.new(Grape::API) do
+            desc 'The description of this' do
+              tags ['not_configurable_tag', configuration[:a_configurable_tag]]
+            end
+            get 'location' do
+              'success'
+            end
+          end
+        end
+
+        it 'mounts the endpoint with the appropiate tags' do
+          root_api.mount({ a_remounted_api => 'integer' }, with: { a_configurable_tag: 'a configured tag' })
+        end
+      end
+
+      context 'on the ParamScope' do
+        subject(:a_remounted_api) do
+          Class.new(Grape::API) do
+            params do
+              requires configuration[:required_param], type: configuration[:required_type]
+            end
+
+            get 'location' do
+              'success'
+            end
+          end
+        end
+
+        it 'mounts the endpoint in the location it is configured' do
+          root_api.mount({ a_remounted_api => 'string' }, with: { required_param: 'param_key', required_type: String })
+          root_api.mount({ a_remounted_api => 'integer' }, with: { required_param: 'param_integer', required_type: Integer })
+
+          get '/string/location', param_key: 'a'
+          expect(last_response.body).to eq 'success'
+
+          get '/string/location', param_integer: 1
+          expect(last_response.status).to eq 400
+
+          get '/integer/location', param_integer: 1
+          expect(last_response.body).to eq 'success'
+
+          get '/integer/location', param_integer: 'a'
+          expect(last_response.status).to eq 400
+        end
+
+        context 'on dynamic checks' do
+          subject(:a_remounted_api) do
+            Class.new(Grape::API) do
+              params do
+                optional :restricted_values, values: -> { [configuration[:allowed_value], 'always'] }
+              end
+
+              get 'location' do
+                'success'
+              end
+            end
+          end
+
+          it 'can read the configuration on lambdas' do
+            root_api.mount a_remounted_api, with: { allowed_value: 'sometimes' }
+            get '/location', restricted_values: 'always'
+            expect(last_response.body).to eq 'success'
+            get '/location', restricted_values: 'sometimes'
+            expect(last_response.body).to eq 'success'
+            get '/location', restricted_values: 'never'
+            expect(last_response.status).to eq 400
+          end
+        end
+      end
+
+      context 'when the configuration is read within a namespace' do
+        before do
+          a_remounted_api.namespace 'api' do
+            get "/#{configuration[:path]}" do
+              '10 votes'
+            end
+          end
+          root_api.mount a_remounted_api, with: { path: 'votes' }
+          root_api.mount a_remounted_api, with: { path: 'scores' }
+        end
+
+        it 'will use the dynamic configuration on all routes' do
+          get 'api/votes'
+          expect(last_response.body).to eql '10 votes'
+          get 'api/scores'
+          expect(last_response.body).to eql '10 votes'
+        end
+      end
+
+      context 'when the configuration is read in a helper' do
+        subject(:a_remounted_api) do
+          Class.new(Grape::API) do
+            helpers do
+              def printed_response
+                configuration[:some_value]
+              end
+            end
+
+            get 'location' do
+              printed_response
+            end
+          end
+        end
+
+        it 'will use the dynamic configuration on all routes' do
+          root_api.mount(a_remounted_api, with: { some_value: 'response value' })
+
+          get '/location'
+          expect(last_response.body).to eq 'response value'
+        end
+      end
+
+      context 'when the configuration is read within the response block' do
+        subject(:a_remounted_api) do
+          Class.new(Grape::API) do
+            get 'location' do
+              configuration[:some_value]
+            end
+          end
+        end
+
+        it 'will use the dynamic configuration on all routes' do
+          root_api.mount(a_remounted_api, with: { some_value: 'response value' })
+
+          get '/location'
+          expect(last_response.body).to eq 'response value'
+        end
       end
     end
   end

data/spec/grape/api_spec.rb

@@ -1628,6 +1628,199 @@ XML
     end
   end
 
+  describe 'lifecycle' do
+    let!(:lifecycle) { [] }
+    let!(:standard_cycle) do
+      %i[before before_validation after_validation api_call after finally]
+    end
+
+    let!(:validation_error) do
+      %i[before before_validation finally]
+    end
+
+    let!(:errored_cycle) do
+      %i[before before_validation after_validation api_call finally]
+    end
+
+    before do
+      current_cycle = lifecycle
+
+      subject.before do
+        current_cycle << :before
+      end
+
+      subject.before_validation do
+        current_cycle << :before_validation
+      end
+
+      subject.after_validation do
+        current_cycle << :after_validation
+      end
+
+      subject.after do
+        current_cycle << :after
+      end
+
+      subject.finally do
+        current_cycle << :finally
+      end
+    end
+
+    context 'when the api_call succeeds' do
+      before do
+        current_cycle = lifecycle
+
+        subject.get 'api_call' do
+          current_cycle << :api_call
+        end
+      end
+
+      it 'follows the standard life_cycle' do
+        get '/api_call'
+        expect(lifecycle).to eq standard_cycle
+      end
+    end
+
+    context 'when the api_call has a controlled error' do
+      before do
+        current_cycle = lifecycle
+
+        subject.get 'api_call' do
+          current_cycle << :api_call
+          error!(:some_error)
+        end
+      end
+
+      it 'follows the errored life_cycle (skips after)' do
+        get '/api_call'
+        expect(lifecycle).to eq errored_cycle
+      end
+    end
+
+    context 'when the api_call has an exception' do
+      before do
+        current_cycle = lifecycle
+
+        subject.get 'api_call' do
+          current_cycle << :api_call
+          raise StandardError
+        end
+      end
+
+      it 'follows the errored life_cycle (skips after)' do
+        expect { get '/api_call' }.to raise_error(StandardError)
+        expect(lifecycle).to eq errored_cycle
+      end
+    end
+
+    context 'when the api_call fails validation' do
+      before do
+        current_cycle = lifecycle
+
+        subject.params do
+          requires :some_param, type: String
+        end
+
+        subject.get 'api_call' do
+          current_cycle << :api_call
+        end
+      end
+
+      it 'follows the failed_validation cycle (skips after_validation, api_call & after)' do
+        get '/api_call'
+        expect(lifecycle).to eq validation_error
+      end
+    end
+  end
+
+  describe '.finally' do
+    let!(:code) { { has_executed: false } }
+    let(:block_to_run) do
+      code_to_execute = code
+      proc do
+        code_to_execute[:has_executed] = true
+      end
+    end
+
+    context 'when the ensure block has no exceptions' do
+      before { subject.finally(&block_to_run) }
+
+      context 'when no API call is made' do
+        it 'has not executed the ensure code' do
+          expect(code[:has_executed]).to be false
+        end
+      end
+
+      context 'when no errors occurs' do
+        before do
+          subject.get '/no_exceptions' do
+            'success'
+          end
+        end
+
+        it 'executes the ensure code' do
+          get '/no_exceptions'
+          expect(last_response.body).to eq 'success'
+          expect(code[:has_executed]).to be true
+        end
+
+        context 'with a helper' do
+          let(:block_to_run) do
+            code_to_execute = code
+            proc do
+              code_to_execute[:value] = some_helper
+            end
+          end
+
+          before do
+            subject.helpers do
+              def some_helper
+                'some_value'
+              end
+            end
+
+            subject.get '/with_helpers' do
+              'success'
+            end
+          end
+
+          it 'has access to the helper' do
+            get '/with_helpers'
+            expect(code[:value]).to eq 'some_value'
+          end
+        end
+      end
+
+      context 'when an unhandled occurs inside the API call' do
+        before do
+          subject.get '/unhandled_exception' do
+            raise StandardError
+          end
+        end
+
+        it 'executes the ensure code' do
+          expect { get '/unhandled_exception' }.to raise_error StandardError
+          expect(code[:has_executed]).to be true
+        end
+      end
+
+      context 'when a handled error occurs inside the API call' do
+        before do
+          subject.rescue_from(StandardError) { error! 'handled' }
+          subject.get '/handled_exception' do
+            raise StandardError
+          end
+        end
+
+        it 'executes the ensure code' do
+          get '/handled_exception'
+          expect(code[:has_executed]).to be true
+          expect(last_response.body).to eq 'handled'
+        end
+      end
+    end
+  end
+
   describe '.rescue_from' do
     it 'does not rescue errors when rescue_from is not set' do
       subject.get '/exception' do
@@ -3676,4 +3869,21 @@ XML
       expect(grape_api.eql?(MyAPI))
     end
   end
+
+  describe 'const_missing' do
+    subject(:grape_api) { Class.new(Grape::API) }
+    let(:mounted) do
+      Class.new(Grape::API) do
+        get '/missing' do
+          SomeRandomConstant
+        end
+      end
+    end
+
+    before { subject.mount mounted => '/const' }
+
+    it 'raises an error' do
+      expect { get '/const/missing' }.to raise_error(NameError).with_message(/SomeRandomConstant/)
+    end
+  end
 end