grape 0.7.0 → 0.8.0

data/UPGRADING.md

@@ -1,7 +1,7 @@
 Upgrading Grape
 ===============
 
-### Upgrading to 0.7.0
+### Upgrading to >= 0.7.0
 
 #### Changes in Exception Handling
 
@@ -78,9 +78,9 @@ end
 
 This caused the ambiguity and unexpected errors described in [#543](https://github.com/intridea/Grape/issues/543).
 
-In Grape 0.6.2, the `group`, `optional` and `requires` keywords take an additional `type` attribute which defaults to `Array`. This means that without a `type` attribute, these nested parameters will no longer accept a single hash, only an array (of hashes).
+In Grape 0.7.0, the `group`, `optional` and `requires` keywords take an additional `type` attribute which defaults to `Array`. This means that without a `type` attribute, these nested parameters will no longer accept a single hash, only an array (of hashes).
 
-Whereas in 0.6.1 the API above accepted the following json, it no longer does in 0.6.2.
+Whereas in 0.6.1 the API above accepted the following json, it no longer does in 0.7.0.
 
 ```json
 {

data/grape.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'activesupport'
   s.add_runtime_dependency 'multi_json', '>= 1.3.2'
   s.add_runtime_dependency 'multi_xml', '>= 0.5.2'
-  s.add_runtime_dependency 'hashie', '>= 1.2.0'
+  s.add_runtime_dependency 'hashie', '>= 2.1.0'
   s.add_runtime_dependency 'virtus', '>= 1.0.0'
   s.add_runtime_dependency 'builder'
 

data/lib/grape/api.rb

@@ -99,7 +99,7 @@ module Grape
           options ||= {}
           options = { using: :path }.merge(options)
 
-          raise Grape::Exceptions::MissingVendorOption.new if options[:using] == :header && !options.has_key?(:vendor)
+          raise Grape::Exceptions::MissingVendorOption.new if options[:using] == :header && !options.key?(:vendor)
 
           @versions = versions | args
           nest(block) do
@@ -159,7 +159,7 @@ module Grape
       end
 
       def error_formatter(format, options)
-        if options.is_a?(Hash) && options.has_key?(:with)
+        if options.is_a?(Hash) && options.key?(:with)
           formatter = options[:with]
         else
           formatter = options
@@ -212,14 +212,24 @@ module Grape
         end
 
         options = args.last.is_a?(Hash) ? args.pop : {}
-        handler ||= proc { options[:with] } if options.has_key?(:with)
+        handler ||= proc { options[:with] } if options.key?(:with)
 
-        handler_type = !!options[:rescue_subclasses] ? :rescue_handlers : :base_only_rescue_handlers
-        imbue handler_type, Hash[args.map { |arg| [arg, handler] }]
+        if args.include?(:all)
+          set(:rescue_all, true)
+          imbue :all_rescue_handler, handler
+        else
+          handler_type =
+            case options[:rescue_subclasses]
+            when nil, true
+              :rescue_handlers
+            else
+              :base_only_rescue_handlers
+            end
 
-        imbue(:rescue_options, options)
+          imbue handler_type, Hash[args.map { |arg| [arg, handler] }]
+        end
 
-        set(:rescue_all, true) if args.include?(:all)
+        imbue(:rescue_options, options)
       end
 
       # Allows you to specify a default representation entity for a
@@ -472,7 +482,7 @@ module Grape
 
       def cascade(value = nil)
         if value.nil?
-          settings.has_key?(:cascade) ? !!settings[:cascade] : true
+          settings.key?(:cascade) ? !!settings[:cascade] : true
         else
           set(:cascade, value)
         end
@@ -548,8 +558,8 @@ module Grape
     # errors from reaching upstream. This is effectivelly done by unsetting
     # X-Cascade. Default :cascade is true.
     def cascade?
-      return !!self.class.settings[:cascade] if self.class.settings.has_key?(:cascade)
-      return !!self.class.settings[:version_options][:cascade] if self.class.settings[:version_options] && self.class.settings[:version_options].has_key?(:cascade)
+      return !!self.class.settings[:cascade] if self.class.settings.key?(:cascade)
+      return !!self.class.settings[:version_options][:cascade] if self.class.settings[:version_options] && self.class.settings[:version_options].key?(:cascade)
       true
     end
 
@@ -579,9 +589,7 @@ module Grape
         methods_per_path.each do |path, methods|
           allowed_methods = methods.dup
           unless self.class.settings[:do_not_route_head]
-            if allowed_methods.include?('GET')
-              allowed_methods = allowed_methods | ['HEAD']
-            end
+            allowed_methods |= ['HEAD'] if allowed_methods.include?('GET')
           end
 
           allow_header = (['OPTIONS'] | allowed_methods).join(', ')

data/lib/grape/endpoint.rb

@@ -8,6 +8,18 @@ module Grape
     attr_reader :env, :request, :headers, :params
 
     class << self
+      def before_each(new_setup = false, &block)
+        if new_setup == false
+          if block_given?
+            @before_each = block
+          else
+            return @before_each
+          end
+        else
+          @before_each = new_setup
+        end
+      end
+
       # @api private
       #
       # Create an UnboundMethod that is appropriate for executing an endpoint
@@ -52,7 +64,7 @@ module Grape
     end
 
     def require_option(options, key)
-      raise Grape::Exceptions::MissingOption.new(key) unless options.has_key?(key)
+      raise Grape::Exceptions::MissingOption.new(key) unless options.key?(key)
     end
 
     def method_name
@@ -78,8 +90,8 @@ module Grape
           end
           methods.each do |method|
             route_set.add_route(self, {
-              path_info: route.route_compiled,
-              request_method: method,
+                                  path_info: route.route_compiled,
+                                  request_method: method
             },  route_info: route)
           end
         end
@@ -105,7 +117,7 @@ module Grape
           regex = Rack::Mount::RegexpWithNamedGroups.new(path)
           path_params = {}
           # named parameters in the api path
-          named_params = regex.named_captures.map { |nc| nc[0] } - %w{ version format }
+          named_params = regex.named_captures.map { |nc| nc[0] } - %w(version format)
           named_params.each { |named_param| path_params[named_param] = "" }
           # route parameters declared via desc or appended to the api declaration
           route_params = (options[:route_options][:params] || {})
@@ -118,9 +130,8 @@ module Grape
             method: request_method,
             path: prepared_path,
             params: path_params,
-            compiled: path,
-          )
-          )
+            compiled: path
+          ))
         end
       end
       routes
@@ -325,14 +336,18 @@ module Grape
       entity_class = options.delete(:with)
 
       if entity_class.nil?
-        # entity class not explicitely defined, auto-detect from first object in the collection
-        object_instance = object.respond_to?(:first) ? object.first : object
+        # entity class not explicitely defined, auto-detect from relation#klass or first object in the collection
+        object_class = if object.respond_to?(:klass)
+                         object.klass
+                       else
+                         object.respond_to?(:first) ? object.first.class : object.class
+                       end
 
-        object_instance.class.ancestors.each do |potential|
+        object_class.ancestors.each do |potential|
           entity_class ||= (settings[:representations] || {})[potential]
         end
 
-        entity_class ||= object_instance.class.const_get(:Entity) if object_instance.class.const_defined?(:Entity) && object_instance.class.const_get(:Entity).respond_to?(:represent)
+        entity_class ||= object_class.const_get(:Entity) if object_class.const_defined?(:Entity) && object_class.const_get(:Entity).respond_to?(:represent)
       end
 
       root = options.delete(:root)
@@ -384,11 +399,13 @@ module Grape
 
       cookies.read(@request)
 
+      self.class.before_each.call(self) if self.class.before_each
+
       run_filters befores
 
       run_filters before_validations
 
-      # Retieve validations from this namespace and all parent namespaces.
+      # Retrieve validations from this namespace and all parent namespaces.
       validation_errors = []
       settings.gather(:validations).each do |validator|
         begin
@@ -424,7 +441,8 @@ module Grape
             error_formatters: settings[:error_formatters],
             rescue_options: settings[:rescue_options],
             rescue_handlers: merged_setting(:rescue_handlers),
-            base_only_rescue_handlers: merged_setting(:base_only_rescue_handlers)
+            base_only_rescue_handlers: merged_setting(:base_only_rescue_handlers),
+            all_rescue_handler: settings[:all_rescue_handler]
 
       aggregate_setting(:middleware).each do |m|
         m = m.dup

data/lib/grape/exceptions/validation.rb

@@ -6,9 +6,9 @@ module Grape
       attr_accessor :param
 
       def initialize(args = {})
-        raise "Param is missing:" unless args.has_key? :param
+        raise "Param is missing:" unless args.key? :param
         @param = args[:param]
-        args[:message] = translate_message(args[:message_key]) if args.has_key? :message_key
+        args[:message] = translate_message(args[:message_key]) if args.key? :message_key
         super
       end
 

data/lib/grape/locale/en.yml

@@ -28,3 +28,5 @@ en:
         unknown_validator: 'unknown validator: %{validator_type}'
         unknown_options: 'unknown options: %{options}'
         incompatible_option_values: '%{option1}: %{value1} is incompatible with %{option2}: %{value2}'
+        mutual_exclusion: 'are mutually exclusive'
+        exactly_one: "- exactly one parameter must be provided"

data/lib/grape/middleware/auth/oauth2.rb

@@ -1,79 +1,83 @@
-module Grape::Middleware::Auth
-  # OAuth 2.0 authorization for Grape APIs.
-  class OAuth2 < Grape::Middleware::Base
-    def default_options
-      {
-        token_class: 'AccessToken',
-        realm: 'OAuth API',
-        parameter: %w(bearer_token oauth_token access_token),
-        accepted_headers: %w(HTTP_AUTHORIZATION X_HTTP_AUTHORIZATION X-HTTP_AUTHORIZATION REDIRECT_X_HTTP_AUTHORIZATION),
-        header: [/Bearer (.*)/i, /OAuth (.*)/i],
-        required: true
-      }
-    end
+module Grape
+  module Middleware
+    module Auth
+      # OAuth 2.0 authorization for Grape APIs.
+      class OAuth2 < Grape::Middleware::Base
+        def default_options
+          {
+            token_class: 'AccessToken',
+            realm: 'OAuth API',
+            parameter: %w(bearer_token oauth_token access_token),
+            accepted_headers: %w(HTTP_AUTHORIZATION X_HTTP_AUTHORIZATION X-HTTP_AUTHORIZATION REDIRECT_X_HTTP_AUTHORIZATION),
+            header: [/Bearer (.*)/i, /OAuth (.*)/i],
+            required: true
+          }
+        end
 
-    def before
-      verify_token(token_parameter || token_header)
-    end
+        def before
+          verify_token(token_parameter || token_header)
+        end
 
-    def request
-      @request ||= Grape::Request.new(env)
-    end
+        def request
+          @request ||= Grape::Request.new(env)
+        end
 
-    def params
-      @params ||= request.params
-    end
+        def params
+          @params ||= request.params
+        end
 
-    def token_parameter
-      Array(options[:parameter]).each do |p|
-        return params[p] if params[p]
-      end
-      nil
-    end
+        def token_parameter
+          Array(options[:parameter]).each do |p|
+            return params[p] if params[p]
+          end
+          nil
+        end
 
-    def token_header
-      return false unless authorization_header
-      Array(options[:header]).each do |regexp|
-        return $1 if authorization_header =~ regexp
-      end
-      nil
-    end
+        def token_header
+          return false unless authorization_header
+          Array(options[:header]).each do |regexp|
+            return $1 if authorization_header =~ regexp
+          end
+          nil
+        end
 
-    def authorization_header
-      options[:accepted_headers].each do |head|
-        return env[head] if env[head]
-      end
-      nil
-    end
+        def authorization_header
+          options[:accepted_headers].each do |head|
+            return env[head] if env[head]
+          end
+          nil
+        end
 
-    def token_class
-      @klass ||= eval(options[:token_class]) # rubocop:disable Eval
-    end
+        def token_class
+          @klass ||= eval(options[:token_class]) # rubocop:disable Eval
+        end
 
-    def verify_token(token)
-      token = token_class.verify(token)
-      if token
-        if token.respond_to?(:expired?) && token.expired?
-          error_out(401, 'invalid_grant')
-        else
-          if !token.respond_to?(:permission_for?) || token.permission_for?(env)
-            env['api.token'] = token
-          else
-            error_out(403, 'insufficient_scope')
+        def verify_token(token)
+          token = token_class.verify(token)
+          if token
+            if token.respond_to?(:expired?) && token.expired?
+              error_out(401, 'invalid_grant')
+            else
+              if !token.respond_to?(:permission_for?) || token.permission_for?(env)
+                env['api.token'] = token
+              else
+                error_out(403, 'insufficient_scope')
+              end
+            end
+          elsif !!options[:required]
+            error_out(401, 'invalid_grant')
           end
         end
-      elsif !!options[:required]
-        error_out(401, 'invalid_grant')
-      end
-    end
 
-    def error_out(status, error)
-      throw :error,
-            message: error,
-            status: status,
-            headers: {
-              'WWW-Authenticate' => "OAuth realm='#{options[:realm]}', error='#{error}'"
-            }
+        def error_out(status, error)
+          throw :error,
+                message: error,
+                status: status,
+                headers: {
+                  'WWW-Authenticate' => "OAuth realm='#{options[:realm]}', error='#{error}'"
+                }
+        end
+      end
     end
   end
 end

data/lib/grape/middleware/error.rb

@@ -14,7 +14,8 @@ module Grape
           rescue_subclasses: true, # rescue subclasses of exceptions listed
           rescue_options: { backtrace: false }, # true to display backtrace
           rescue_handlers: {}, # rescue handler blocks
-          base_only_rescue_handlers: {} # rescue handler blocks rescuing only the base class
+          base_only_rescue_handlers: {}, # rescue handler blocks rescuing only the base class
+          all_rescue_handler: nil # rescue handler block to rescue from all exceptions
         }
       end
 
@@ -40,7 +41,8 @@ module Grape
 
       def find_handler(klass)
         handler = options[:rescue_handlers].find(-> { [] }) { |error, _| klass <= error }[1]
-        handler = options[:base_only_rescue_handlers][klass] || options[:base_only_rescue_handlers][:all] unless handler
+        handler ||= options[:base_only_rescue_handlers][klass]
+        handler ||= options[:all_rescue_handler]
         handler
       end
 

data/lib/grape/middleware/formatter.rb

@@ -130,14 +130,14 @@ module Grape
         accept = headers['accept']
         return [] unless accept
 
-        accept_into_mime_and_quality = %r(
+        accept_into_mime_and_quality = %r{
           (
             \w+/[\w+.-]+)     # eg application/vnd.example.myformat+xml
           (?:
            (?:;[^,]*?)?       # optionally multiple formats in a row
            ;\s*q=([\d.]+)     # optional "quality" preference (eg q=0.5)
           )?
-        )x
+        }x
 
         vendor_prefix_pattern = /vnd\.[^+]+\+/
 

data/lib/grape/middleware/versioner/accept_version_header.rb

@@ -51,7 +51,7 @@ module Grape
         # of routes (see [Rack::Mount](https://github.com/josh/rack-mount) for more information). To prevent
         # this behavior, and not add the `X-Cascade` header, one can set the `:cascade` option to `false`.
         def cascade?
-          if options[:version_options] && options[:version_options].has_key?(:cascade)
+          if options[:version_options] && options[:version_options].key?(:cascade)
             !!options[:version_options][:cascade]
           else
             true

data/lib/grape/middleware/versioner/header.rb

@@ -60,7 +60,7 @@ module Grape
           elsif strict?
             throw :error, status: 406, headers: error_headers, message: '406 Not Acceptable'
           # If all acceptable content types specify a vendor or version that doesn't exist:
-          elsif header.values.all? { |header_value| has_vendor?(header_value) || has_version?(header_value) }
+          elsif header.values.all? { |header_value| has_vendor?(header_value) || version?(header_value) }
             throw :error, status: 406, headers: error_headers, message: 'API vendor or version not found.'
           end
         end
@@ -102,7 +102,7 @@ module Grape
         # of routes (see [Rack::Mount](https://github.com/josh/rack-mount) for more information). To prevent
         # this behavior, and not add the `X-Cascade` header, one can set the `:cascade` option to `false`.
         def cascade?
-          if options[:version_options] && options[:version_options].has_key?(:cascade)
+          if options[:version_options] && options[:version_options].key?(:cascade)
             !!options[:version_options][:cascade]
           else
             true
@@ -122,7 +122,7 @@ module Grape
 
         # @param [String] media_type a content type
         # @return [Boolean] whether the content type sets an API version
-        def has_version?(media_type)
+        def version?(media_type)
           _, subtype = Rack::Accept::Header.parse_media_type media_type
           subtype[/\Avnd\.[a-z0-9*.]+-[a-z0-9*\-.]+/]
         end