grape 1.0.0 → 1.6.0

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

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class RegexpValidator < Base
       def validate_param!(attr_name, params)
         return unless params.respond_to?(:key?) && params.key?(attr_name)
-        return if Array.wrap(params[attr_name]).all? { |param| param.nil? || (param.to_s =~ (options_key?(:value) ? @option[:value] : @option)) }
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:regexp)
+        return if Array.wrap(params[attr_name]).all? { |param| param.nil? || param.to_s.match?((options_key?(:value) ? @option[:value] : @option)) }
+
+        raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:regexp))
       end
     end
   end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    class SameAsValidator < Base
+      def validate_param!(attr_name, params)
+        confirmation = options_key?(:value) ? @option[:value] : @option
+        return if params[attr_name] == params[confirmation]
+
+        raise Grape::Exceptions::Validation.new(
+          params: [@scope.full_name(attr_name)],
+          message: build_message
+        )
+      end
+
+      private
+
+      def build_message
+        if options_key?(:message)
+          @option[:message]
+        else
+          format I18n.t(:same_as, scope: 'grape.errors.messages'), parameter: @option
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class ValuesValidator < Base
-      def initialize(attrs, options, required, scope, opts = {})
+      def initialize(attrs, options, required, scope, **opts)
         if options.is_a?(Hash)
           @excepts = options[:except]
           @values = options[:value]
@@ -11,6 +13,7 @@ module Grape
                'Use the except validator instead.' if @excepts
 
           raise ArgumentError, 'proc must be a Proc' if @proc && !@proc.is_a?(Proc)
+
           warn '[DEPRECATION] The values validator proc option is deprecated. ' \
                'The lambda expression can now be assigned directly to values.' if @proc
         else
@@ -24,32 +27,45 @@ module Grape
 
       def validate_param!(attr_name, params)
         return unless params.is_a?(Hash)
-        return unless params[attr_name] || required_for_root_scope?
 
-        param_array = params[attr_name].nil? ? [nil] : Array.wrap(params[attr_name])
+        val = params[attr_name]
+
+        return if val.nil? && !required_for_root_scope?
+
+        # don't forget that +false.blank?+ is true
+        return if val != false && val.blank? && @allow_blank
+
+        param_array = val.nil? ? [nil] : Array.wrap(val)
 
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: except_message \
+        raise validation_exception(attr_name, except_message) \
           unless check_excepts(param_array)
 
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:values) \
-          unless check_values(param_array)
+        raise validation_exception(attr_name, message(:values)) \
+          unless check_values(param_array, attr_name)
 
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:values) \
+        raise validation_exception(attr_name, message(:values)) \
           if @proc && !param_array.all? { |param| @proc.call(param) }
       end
 
       private
 
-      def check_values(param_array)
+      def check_values(param_array, attr_name)
         values = @values.is_a?(Proc) && @values.arity.zero? ? @values.call : @values
         return true if values.nil?
-        return param_array.all? { |param| values.call(param) } if values.is_a? Proc
+
+        begin
+          return param_array.all? { |param| values.call(param) } if values.is_a? Proc
+        rescue StandardError => e
+          warn "Error '#{e}' raised while validating attribute '#{attr_name}'"
+          return false
+        end
         param_array.all? { |param| values.include?(param) }
       end
 
       def check_excepts(param_array)
         excepts = @excepts.is_a?(Proc) ? @excepts.call : @excepts
         return true if excepts.nil?
+
         param_array.none? { |param| excepts.include?(param) }
       end
 
@@ -61,6 +77,10 @@ module Grape
       def required_for_root_scope?
         @required && @scope.root?
       end
+
+      def validation_exception(attr_name, message)
+        Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message)
+      end
     end
   end
 end

data/lib/grape/validations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   # Registry to store and locate known Validators.
   module Validations

data/lib/grape/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Grape
   # The current version of Grape.
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.6.0'
 end

data/lib/grape.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'rack'
 require 'rack/builder'
@@ -10,18 +12,17 @@ require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/array/wrap'
+require 'active_support/core_ext/array/conversions'
 require 'active_support/core_ext/hash/deep_merge'
 require 'active_support/core_ext/hash/reverse_merge'
 require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/hash/slice'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/dependencies/autoload'
 require 'active_support/notifications'
 require 'i18n'
-require 'thread'
-
-require 'virtus'
 
-I18n.load_path << File.expand_path('../grape/locale/en.yml', __FILE__)
+I18n.load_path << File.expand_path('grape/locale/en.yml', __dir__)
 
 module Grape
   extend ::ActiveSupport::Autoload
@@ -29,12 +30,10 @@ module Grape
   eager_autoload do
     autoload :API
     autoload :Endpoint
-    autoload :Router
 
     autoload :Namespace
 
     autoload :Path
-
     autoload :Cookies
     autoload :Validations
     autoload :ErrorFormatter
@@ -55,105 +54,125 @@ module Grape
 
   module Exceptions
     extend ::ActiveSupport::Autoload
-    autoload :Base
-    autoload :Validation
-    autoload :ValidationArrayErrors
-    autoload :ValidationErrors
-    autoload :MissingVendorOption
-    autoload :MissingMimeType
-    autoload :MissingOption
-    autoload :InvalidFormatter
-    autoload :InvalidVersionerOption
-    autoload :UnknownValidator
-    autoload :UnknownOptions
-    autoload :UnknownParameter
-    autoload :InvalidWithOptionForRepresent
-    autoload :IncompatibleOptionValues
-    autoload :MissingGroupTypeError,          'grape/exceptions/missing_group_type'
-    autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
-    autoload :InvalidMessageBody
-    autoload :InvalidAcceptHeader
-    autoload :InvalidVersionHeader
-    autoload :MethodNotAllowed
+    eager_autoload do
+      autoload :Base
+      autoload :Validation
+      autoload :ValidationArrayErrors
+      autoload :ValidationErrors
+      autoload :MissingVendorOption
+      autoload :MissingMimeType
+      autoload :MissingOption
+      autoload :InvalidFormatter
+      autoload :InvalidVersionerOption
+      autoload :UnknownValidator
+      autoload :UnknownOptions
+      autoload :UnknownParameter
+      autoload :InvalidWithOptionForRepresent
+      autoload :IncompatibleOptionValues
+      autoload :MissingGroupTypeError,          'grape/exceptions/missing_group_type'
+      autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
+      autoload :InvalidMessageBody
+      autoload :InvalidAcceptHeader
+      autoload :InvalidVersionHeader
+      autoload :MethodNotAllowed
+      autoload :InvalidResponse
+      autoload :EmptyMessageBody
+    end
   end
 
   module Extensions
     extend ::ActiveSupport::Autoload
-
-    autoload :DeepMergeableHash
-    autoload :DeepSymbolizeHash
-    autoload :DeepHashWithIndifferentAccess
-    autoload :Hash
-
+    eager_autoload do
+      autoload :DeepMergeableHash
+      autoload :DeepSymbolizeHash
+      autoload :Hash
+    end
     module ActiveSupport
       extend ::ActiveSupport::Autoload
-
-      autoload :HashWithIndifferentAccess
+      eager_autoload do
+        autoload :HashWithIndifferentAccess
+      end
     end
 
     module Hashie
       extend ::ActiveSupport::Autoload
-
-      autoload :Mash
+      eager_autoload do
+        autoload :Mash
+      end
     end
   end
 
   module Middleware
     extend ::ActiveSupport::Autoload
-    autoload :Base
-    autoload :Versioner
-    autoload :Formatter
-    autoload :Error
-    autoload :Globals
-    autoload :Stack
+    eager_autoload do
+      autoload :Base
+      autoload :Versioner
+      autoload :Formatter
+      autoload :Error
+      autoload :Globals
+      autoload :Stack
+      autoload :Helpers
+    end
 
     module Auth
       extend ::ActiveSupport::Autoload
-      autoload :Base
-      autoload :DSL
-      autoload :StrategyInfo
-      autoload :Strategies
+      eager_autoload do
+        autoload :Base
+        autoload :DSL
+        autoload :StrategyInfo
+        autoload :Strategies
+      end
     end
 
     module Versioner
       extend ::ActiveSupport::Autoload
-      autoload :Path
-      autoload :Header
-      autoload :Param
-      autoload :AcceptVersionHeader
+      eager_autoload do
+        autoload :Path
+        autoload :Header
+        autoload :Param
+        autoload :AcceptVersionHeader
+      end
     end
   end
 
   module Util
     extend ::ActiveSupport::Autoload
-    autoload :InheritableValues
-    autoload :StackableValues
-    autoload :ReverseStackableValues
-    autoload :InheritableSetting
-    autoload :StrictHashConfiguration
-    autoload :Registrable
+    eager_autoload do
+      autoload :InheritableValues
+      autoload :StackableValues
+      autoload :ReverseStackableValues
+      autoload :InheritableSetting
+      autoload :StrictHashConfiguration
+      autoload :Registrable
+    end
   end
 
   module ErrorFormatter
     extend ::ActiveSupport::Autoload
-    autoload :Base
-    autoload :Json
-    autoload :Txt
-    autoload :Xml
+    eager_autoload do
+      autoload :Base
+      autoload :Json
+      autoload :Txt
+      autoload :Xml
+    end
   end
 
   module Formatter
     extend ::ActiveSupport::Autoload
-    autoload :Json
-    autoload :SerializableHash
-    autoload :Txt
-    autoload :Xml
+    eager_autoload do
+      autoload :Json
+      autoload :SerializableHash
+      autoload :Txt
+      autoload :Xml
+    end
   end
 
   module Parser
     extend ::ActiveSupport::Autoload
-    autoload :Json
-    autoload :Xml
+    eager_autoload do
+      autoload :Json
+      autoload :Xml
+    end
   end
 
   module DSL
@@ -177,27 +196,41 @@ module Grape
 
   class API
     extend ::ActiveSupport::Autoload
-    autoload :Helpers
+    eager_autoload do
+      autoload :Helpers
+    end
   end
 
   module Presenters
     extend ::ActiveSupport::Autoload
-    autoload :Presenter
+    eager_autoload do
+      autoload :Presenter
+    end
   end
 
-  module ServeFile
+  module ServeStream
     extend ::ActiveSupport::Autoload
-    autoload :FileResponse
-    autoload :FileBody
-    autoload :SendfileResponse
+    eager_autoload do
+      autoload :FileBody
+      autoload :SendfileResponse
+      autoload :StreamResponse
+    end
   end
 end
 
-require 'grape/util/content_types'
+require 'grape/config'
+require 'grape/content_types'
+
+require 'grape/util/lazy_value'
+require 'grape/util/lazy_block'
+require 'grape/util/endpoint_configuration'
 
 require 'grape/validations/validators/base'
 require 'grape/validations/attributes_iterator'
+require 'grape/validations/single_attribute_iterator'
+require 'grape/validations/multiple_attributes_iterator'
 require 'grape/validations/validators/allow_blank'
+require 'grape/validations/validators/as'
 require 'grape/validations/validators/at_least_one_of'
 require 'grape/validations/validators/coerce'
 require 'grape/validations/validators/default'
@@ -205,6 +238,7 @@ require 'grape/validations/validators/exactly_one_of'
 require 'grape/validations/validators/mutual_exclusion'
 require 'grape/validations/validators/presence'
 require 'grape/validations/validators/regexp'
+require 'grape/validations/validators/same_as'
 require 'grape/validations/validators/values'
 require 'grape/validations/validators/except_values'
 require 'grape/validations/params_scope'

data/spec/grape/api/custom_validations_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Validations do
@@ -8,7 +10,8 @@ describe Grape::Validations do
           def validate_param!(attr_name, params)
             @option = params[:max].to_i if params.key?(:max)
             return if params[attr_name].length <= @option
-            raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long"
+
+            raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long")
           end
         end
       end
@@ -87,7 +90,7 @@ describe Grape::Validations do
       module CustomValidationsSpec
         class WithMessageKey < Grape::Validations::PresenceValidator
           def validate_param!(attr_name, _params)
-            raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: :presence
+            raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: :presence)
           end
         end
       end
@@ -126,7 +129,7 @@ describe Grape::Validations do
             return unless @option
             # check if user is admin or not
             # as an example get a token from request and check if it's admin or not
-            raise Grape::Exceptions::Validation, params: @attrs, message: 'Can not set Admin only field.' unless request.headers['X-Access-Token'] == 'admin'
+            raise Grape::Exceptions::Validation.new(params: @attrs, message: 'Can not set Admin only field.') unless request.headers['X-Access-Token'] == 'admin'
           end
         end
       end

data/spec/grape/api/deeply_included_options_spec.rb

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

data/spec/grape/api/defines_boolean_in_params_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::API::Instance do
+  describe 'boolean constant' do
+    module DefinesBooleanInstanceSpec
+      class API < Grape::API
+        params do
+          requires :message, type: Boolean
+        end
+        post :echo do
+          { class: params[:message].class.name, value: params[:message] }
+        end
+      end
+    end
+
+    def app
+      DefinesBooleanInstanceSpec::API
+    end
+
+    let(:expected_body) do
+      { class: 'TrueClass', value: true }.to_s
+    end
+
+    it 'sets Boolean as a type' do
+      post '/echo?message=true'
+      expect(last_response.status).to eq(201)
+      expect(last_response.body).to eq expected_body
+    end
+
+    context 'Params endpoint type' do
+      subject { DefinesBooleanInstanceSpec::API.new.router.map['POST'].first.options[:params]['message'][:type] }
+      it 'params type is a boolean' do
+        is_expected.to eq 'Grape::API::Boolean'
+      end
+    end
+  end
+end

data/spec/grape/api/inherited_helpers_spec.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::API::Helpers do
+  let(:user) { 'Miguel Caneo' }
+  let(:id)   { '42' }
+
+  module InheritedHelpersSpec
+    class SuperClass < Grape::API
+      helpers do
+        params(:superclass_params) { requires :id, type: String }
+
+        def current_user
+          params[:user]
+        end
+      end
+    end
+
+    class OverriddenSubClass < SuperClass
+      params { use :superclass_params }
+
+      helpers do
+        def current_user
+          "#{params[:user]} with id"
+        end
+      end
+
+      get 'resource' do
+        "#{current_user}: #{params['id']}"
+      end
+    end
+
+    class SubClass < SuperClass
+      params { use :superclass_params }
+
+      get 'resource' do
+        "#{current_user}: #{params['id']}"
+      end
+    end
+
+    class Example < SubClass
+      params { use :superclass_params }
+
+      get 'resource' do
+        "#{current_user}: #{params['id']}"
+      end
+    end
+  end
+
+  context 'non overriding subclass' do
+    subject { InheritedHelpersSpec::SubClass }
+
+    def app
+      subject
+    end
+
+    context 'given expected params' do
+      it 'inherits helpers from a superclass' do
+        get '/resource', id: id, user: user
+        expect(last_response.body).to eq("#{user}: #{id}")
+      end
+    end
+
+    context 'with lack of expected params' do
+      it 'returns missing error' do
+        get '/resource'
+        expect(last_response.body).to eq('id is missing')
+      end
+    end
+  end
+
+  context 'overriding subclass' do
+    subject { InheritedHelpersSpec::OverriddenSubClass }
+
+    def app
+      subject
+    end
+
+    context 'given expected params' do
+      it 'overrides helpers from a superclass' do
+        get '/resource', id: id, user: user
+        expect(last_response.body).to eq("#{user} with id: #{id}")
+      end
+    end
+
+    context 'with lack of expected params' do
+      it 'returns missing error' do
+        get '/resource'
+        expect(last_response.body).to eq('id is missing')
+      end
+    end
+  end
+
+  context 'example subclass' do
+    subject { InheritedHelpersSpec::Example }
+
+    def app
+      subject
+    end
+
+    context 'given expected params' do
+      it 'inherits helpers from a superclass' do
+        get '/resource', id: id, user: user
+        expect(last_response.body).to eq("#{user}: #{id}")
+      end
+    end
+
+    context 'with lack of expected params' do
+      it 'returns missing error' do
+        get '/resource'
+        expect(last_response.body).to eq('id is missing')
+      end
+    end
+  end
+end