Merge pull request #1242 from glennpratt/request-in-validations

Pass request to validators along with params.

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-01-15 12:33:35 +0900 using RuboCop version 0.35.1.
+# on 2016-01-08 12:24:37 -0600 using RuboCop version 0.35.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -22,13 +22,13 @@ Metrics/BlockNesting:
 # Offense count: 5
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 277
+  Max: 281
 
-# Offense count: 22
+# Offense count: 23
 Metrics/CyclomaticComplexity:
   Max: 14
 
-# Offense count: 760
+# Offense count: 759
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 215
@@ -43,7 +43,7 @@ Metrics/MethodLength:
 Metrics/ModuleLength:
   Max: 272
 
-# Offense count: 15
+# Offense count: 16
 Metrics/PerceivedComplexity:
   Max: 16
 
@@ -57,7 +57,7 @@ Style/BlockDelimiters:
     - 'spec/grape/middleware/versioner/header_spec.rb'
     - 'spec/grape/request_spec.rb'
 
-# Offense count: 106
+# Offense count: 105
 # Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false

lib/grape/endpoint.rb

@@ -248,7 +248,7 @@ def run
 
         route_setting(:saved_validations).each do |validator|
           begin
-            validator.validate!(params)
+            validator.validate(@request)
           rescue Grape::Exceptions::Validation => e
             validation_errors << e
           end

lib/grape/validations/validators/base.rb

@@ -17,6 +17,22 @@ def initialize(attrs, options, required, scope)
         @scope = scope
       end
 
+      # Validates a given request.
+      # @note This method must be thread-safe.
+      # @note Override #validate! unless you need to access the entire request.
+      # @param request [Grape::Request] the request currently being handled
+      # @raise [Grape::Exceptions::Validation] if validation failed
+      # @return [void]
+      def validate(request)
+        validate!(request.params)
+      end
+
+      # Validates a given parameter hash.
+      # @note This method must be thread-safe.
+      # @note Override #validate iff you need to access the entire request.
+      # @param params [Hash] parameters to validate
+      # @raise [Grape::Exceptions::Validation] if validation failed
+      # @return [void]
       def validate!(params)
         attributes = AttributesIterator.new(self, @scope, params)
         attributes.each do |resource_params, attr_name|

lib/grape/validations/validators/coerce.rb

@@ -5,6 +5,11 @@ class API
 
   module Validations
     class CoerceValidator < Base
+      def initialize(*_args)
+        super
+        @converter = Types.build_coercer(type, @option[:method])
+      end
+
       def validate_param!(attr_name, params)
         fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :coerce unless params.is_a? Hash
         new_value = coerce_value(params[attr_name])
@@ -17,6 +22,14 @@ def validate_param!(attr_name, params)
 
       private
 
+      # @!attribute [r] converter
+      # Object that will be used for parameter coercion and type checking.
+      #
+      # See {Types.build_coercer}
+      #
+      # @return [Virtus::Attribute]
+      attr_reader :converter
+
       def valid_type?(val)
         # Special value to denote coercion failure
         return false if val.instance_of?(Types::InvalidValue)
@@ -49,17 +62,6 @@ def coerce_value(val)
       def type
         @option[:type]
       end
-
-      # Create and cache the attribute object
-      # that will be used for parameter coercion
-      # and type checking.
-      #
-      # See {Types.build_coercer}
-      #
-      # @return [Virtus::Attribute]
-      def converter
-        @converter ||= Types.build_coercer(type, @option[:method])
-      end
     end
   end
 end

spec/grape/api/custom_validations_spec.rb

@@ -10,25 +10,30 @@ def validate_param!(attr_name, params)
           fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long"
         end
       end
+      class InBody < Grape::Validations::PresenceValidator
+        def validate(request)
+          validate!(request.env['api.request.body'])
+        end
+      end
     end
   end
 
-  subject do
-    Class.new(Grape::API) do
-      params do
-        requires :text, default_length: 140
-      end
-      get do
-        'bacon'
+  context 'using a custom length validator' do
+    subject do
+      Class.new(Grape::API) do
+        params do
+          requires :text, default_length: 140
+        end
+        get do
+          'bacon'
+        end
       end
     end
-  end
 
-  def app
-    subject
-  end
+    def app
+      subject
+    end
 
-  context 'using a custom length validator' do
     it 'under 140 characters' do
       get '/', text: 'abc'
       expect(last_response.status).to eq 200
@@ -45,4 +50,32 @@ def app
       expect(last_response.body).to eq 'bacon'
     end
   end
+
+  context 'using a custom body-only validator' do
+    subject do
+      Class.new(Grape::API) do
+        params do
+          requires :text, in_body: true
+        end
+        get do
+          'bacon'
+        end
+      end
+    end
+
+    def app
+      subject
+    end
+
+    it 'allows field in body' do
+      get '/', text: 'abc'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq 'bacon'
+    end
+    it 'ignores field in query' do
+      get '/', nil, text: 'abc'
+      expect(last_response.status).to eq 400
+      expect(last_response.body).to eq 'text is missing'
+    end
+  end
 end