grape 0.14.0 → 0.15.0

data/lib/grape/error_formatter.rb

@@ -0,0 +1,31 @@
+module Grape
+  module ErrorFormatter
+    class << self
+      def builtin_formatters
+        {
+          serializable_hash: Grape::ErrorFormatter::Json,
+          json: Grape::ErrorFormatter::Json,
+          jsonapi: Grape::ErrorFormatter::Json,
+          txt: Grape::ErrorFormatter::Txt,
+          xml: Grape::ErrorFormatter::Xml
+        }
+      end
+
+      def formatters(options)
+        builtin_formatters.merge(options[:error_formatters] || {})
+      end
+
+      def formatter_for(api_format, options = {})
+        spec = formatters(options)[api_format]
+        case spec
+        when nil
+          options[:default_error_formatter] || Grape::ErrorFormatter::Txt
+        when Symbol
+          method(spec)
+        else
+          spec
+        end
+      end
+    end
+  end
+end

data/lib/grape/error_formatter/base.rb

@@ -1,34 +1,6 @@
 module Grape
   module ErrorFormatter
     module Base
-      class << self
-        FORMATTERS = {
-          serializable_hash: Grape::ErrorFormatter::Json,
-          json: Grape::ErrorFormatter::Json,
-          jsonapi: Grape::ErrorFormatter::Json,
-          txt: Grape::ErrorFormatter::Txt,
-          xml: Grape::ErrorFormatter::Xml
-        }
-
-        def formatters(options)
-          FORMATTERS.merge(options[:error_formatters] || {})
-        end
-
-        def formatter_for(api_format, options = {})
-          spec = formatters(options)[api_format]
-          case spec
-          when nil
-            options[:default_error_formatter] || Grape::ErrorFormatter::Txt
-          when Symbol
-            method(spec)
-          else
-            spec
-          end
-        end
-      end
-
-      module_function
-
       def present(message, env)
         present_options = {}
         present_options[:with] = message.delete(:with) if message.is_a?(Hash)

data/lib/grape/error_formatter/json.rb

@@ -1,16 +1,27 @@
 module Grape
   module ErrorFormatter
     module Json
+      extend Base
+
       class << self
         def call(message, backtrace, options = {}, env = nil)
-          message = Grape::ErrorFormatter::Base.present(message, env)
+          result = wrap_message(present(message, env))
 
-          result = message.is_a?(String) ? { error: message } : message
           if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
             result = result.merge(backtrace: backtrace)
           end
           MultiJson.dump(result)
         end
+
+        private
+
+        def wrap_message(message)
+          if message.is_a?(Exceptions::ValidationErrors) || message.is_a?(Hash)
+            message
+          else
+            { error: message }
+          end
+        end
       end
     end
   end

data/lib/grape/error_formatter/txt.rb

@@ -1,9 +1,11 @@
 module Grape
   module ErrorFormatter
     module Txt
+      extend Base
+
       class << self
         def call(message, backtrace, options = {}, env = nil)
-          message = Grape::ErrorFormatter::Base.present(message, env)
+          message = present(message, env)
 
           result = message.is_a?(Hash) ? MultiJson.dump(message) : message
           if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?

data/lib/grape/error_formatter/xml.rb

@@ -1,9 +1,11 @@
 module Grape
   module ErrorFormatter
     module Xml
+      extend Base
+
       class << self
         def call(message, backtrace, options = {}, env = nil)
-          message = Grape::ErrorFormatter::Base.present(message, env)
+          message = present(message, env)
 
           result = message.is_a?(Hash) ? message : { message: message }
           if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?

data/lib/grape/exceptions/base.rb

@@ -38,15 +38,15 @@ module Grape
       end
 
       def problem(key, attributes)
-        translate_message("#{key}.problem", attributes)
+        translate_message("#{key}.problem".to_sym, attributes)
       end
 
       def summary(key, attributes)
-        translate_message("#{key}.summary", attributes)
+        translate_message("#{key}.summary".to_sym, attributes)
       end
 
       def resolution(key, attributes)
-        translate_message("#{key}.resolution", attributes)
+        translate_message("#{key}.resolution".to_sym, attributes)
       end
 
       def translate_attributes(keys, options = {})
@@ -60,7 +60,14 @@ module Grape
       end
 
       def translate_message(key, options = {})
-        translate("#{BASE_MESSAGES_KEY}.#{key}", options.reverse_merge(default: ''))
+        case key
+        when Symbol
+          translate("#{BASE_MESSAGES_KEY}.#{key}", options.reverse_merge(default: ''))
+        when Proc
+          key.call
+        else
+          key
+        end
       end
 
       def translate(key, options = {})

data/lib/grape/exceptions/incompatible_option_values.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class IncompatibleOptionValues < Base
       def initialize(option1, value1, option2, value2)
-        super(message: compose_message('incompatible_option_values', option1: option1, value1: value1, option2: option2, value2: value2))
+        super(message: compose_message(:incompatible_option_values, option1: option1, value1: value1, option2: option2, value2: value2))
       end
     end
   end

data/lib/grape/exceptions/invalid_accept_header.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class InvalidAcceptHeader < Base
       def initialize(message, headers)
-        super(message: compose_message('invalid_accept_header', message: message), status: 406, headers: headers)
+        super(message: compose_message(:invalid_accept_header, message: message), status: 406, headers: headers)
       end
     end
   end

data/lib/grape/exceptions/invalid_formatter.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class InvalidFormatter < Base
       def initialize(klass, to_format)
-        super(message: compose_message('invalid_formatter', klass: klass, to_format: to_format))
+        super(message: compose_message(:invalid_formatter, klass: klass, to_format: to_format))
       end
     end
   end

data/lib/grape/exceptions/invalid_message_body.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class InvalidMessageBody < Base
       def initialize(body_format)
-        super(message: compose_message('invalid_message_body', body_format: body_format), status: 400)
+        super(message: compose_message(:invalid_message_body, body_format: body_format), status: 400)
       end
     end
   end

data/lib/grape/exceptions/invalid_version_header.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class InvalidVersionHeader < Base
       def initialize(message, headers)
-        super(message: compose_message('invalid_version_header', message: message), status: 406, headers: headers)
+        super(message: compose_message(:invalid_version_header, message: message), status: 406, headers: headers)
       end
     end
   end

data/lib/grape/exceptions/invalid_versioner_option.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class InvalidVersionerOption < Base
       def initialize(strategy)
-        super(message: compose_message('invalid_versioner_option', strategy: strategy))
+        super(message: compose_message(:invalid_versioner_option, strategy: strategy))
       end
     end
   end

data/lib/grape/exceptions/invalid_with_option_for_represent.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class InvalidWithOptionForRepresent < Base
       def initialize
-        super(message: compose_message('invalid_with_option_for_represent'))
+        super(message: compose_message(:invalid_with_option_for_represent))
       end
     end
   end

data/lib/grape/exceptions/method_not_allowed.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module Grape
+  module Exceptions
+    class MethodNotAllowed < Base
+      def initialize(headers)
+        super(message: '405 Not Allowed', status: 405, headers: headers)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/missing_group_type.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class MissingGroupTypeError < Base
       def initialize
-        super(message: compose_message('missing_group_type'))
+        super(message: compose_message(:missing_group_type))
       end
     end
   end

data/lib/grape/exceptions/missing_mime_type.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class MissingMimeType < Base
       def initialize(new_format)
-        super(message: compose_message('missing_mime_type', new_format: new_format))
+        super(message: compose_message(:missing_mime_type, new_format: new_format))
       end
     end
   end

data/lib/grape/exceptions/missing_option.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class MissingOption < Base
       def initialize(option)
-        super(message: compose_message('missing_option', option: option))
+        super(message: compose_message(:missing_option, option: option))
       end
     end
   end

data/lib/grape/exceptions/missing_vendor_option.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class MissingVendorOption < Base
       def initialize
-        super(message: compose_message('missing_vendor_option'))
+        super(message: compose_message(:missing_vendor_option))
       end
     end
   end

data/lib/grape/exceptions/unknown_options.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class UnknownOptions < Base
       def initialize(options)
-        super(message: compose_message('unknown_options', options: options))
+        super(message: compose_message(:unknown_options, options: options))
       end
     end
   end

data/lib/grape/exceptions/unknown_parameter.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class UnknownParameter < Base
       def initialize(param)
-        super(message: compose_message('unknown_parameter', param: param))
+        super(message: compose_message(:unknown_parameter, param: param))
       end
     end
   end

data/lib/grape/exceptions/unknown_validator.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class UnknownValidator < Base
       def initialize(validator_type)
-        super(message: compose_message('unknown_validator', validator_type: validator_type))
+        super(message: compose_message(:unknown_validator, validator_type: validator_type))
       end
     end
   end

data/lib/grape/exceptions/unsupported_group_type.rb

@@ -3,7 +3,7 @@ module Grape
   module Exceptions
     class UnsupportedGroupTypeError < Base
       def initialize
-        super(message: compose_message('unsupported_group_type'))
+        super(message: compose_message(:unsupported_group_type))
       end
     end
   end

data/lib/grape/exceptions/validation.rb

@@ -4,11 +4,12 @@ module Grape
   module Exceptions
     class Validation < Grape::Exceptions::Base
       attr_accessor :params
+      attr_accessor :message_key
 
       def initialize(args = {})
         fail 'Params are missing:' unless args.key? :params
         @params = args[:params]
-        args[:message] = translate_message(args[:message_key]) if args.key? :message_key
+        args[:message] = translate_message(args[:message]) if args.key? :message
         super
       end
 

data/lib/grape/formatter.rb

@@ -0,0 +1,31 @@
+module Grape
+  module Formatter
+    class << self
+      def builtin_formmaters
+        {
+          json: Grape::Formatter::Json,
+          jsonapi: Grape::Formatter::Json,
+          serializable_hash: Grape::Formatter::SerializableHash,
+          txt: Grape::Formatter::Txt,
+          xml: Grape::Formatter::Xml
+        }
+      end
+
+      def formatters(options)
+        builtin_formmaters.merge(options[:formatters] || {})
+      end
+
+      def formatter_for(api_format, options = {})
+        spec = formatters(options)[api_format]
+        case spec
+        when nil
+          ->(obj, _env) { obj }
+        when Symbol
+          method(spec)
+        else
+          spec
+        end
+      end
+    end
+  end
+end

data/lib/grape/middleware/base.rb

@@ -1,9 +1,13 @@
+require 'grape/dsl/headers'
+
 module Grape
   module Middleware
     class Base
       attr_reader :app, :env, :options
       TEXT_HTML = 'text/html'.freeze
 
+      include Grape::DSL::Headers
+
       # @param [Rack Application] app The standard argument for a Rack middleware.
       # @param [Hash] options A hash of options, simply stored for use by subclasses.
       def initialize(app, options = {})
@@ -22,8 +26,20 @@ module Grape
       def call!(env)
         @env = env
         before
-        @app_response = @app.call(@env)
-        after || @app_response
+        begin
+          @app_response = @app.call(@env)
+        ensure
+          begin
+            after_response = after
+          rescue StandardError => e
+            warn "caught error of type #{e.class} in after callback inside #{self.class.name} : #{e.message}"
+            raise e
+          end
+        end
+
+        response = after_response || @app_response
+        merge_headers response
+        response
       end
 
       # @abstract
@@ -61,6 +77,16 @@ module Grape
         end
         types_without_params
       end
+
+      private
+
+      def merge_headers(response)
+        return unless headers.is_a?(Hash)
+        case response
+        when Rack::Response then response.headers.merge!(headers)
+        when Array          then response[1].merge!(headers)
+        end
+      end
     end
   end
 end

data/lib/grape/middleware/error.rb

@@ -22,6 +22,8 @@ module Grape
       def call!(env)
         @env = env
 
+        inject_helpers!
+
         begin
           error_response(catch(:error) do
             return @app.call(@env)
@@ -43,6 +45,14 @@ module Grape
         handler = options[:rescue_handlers].find(-> { [] }) { |error, _| klass <= error }[1]
         handler ||= options[:base_only_rescue_handlers][klass]
         handler ||= options[:all_rescue_handler]
+        with_option = options[:rescue_options][:with]
+        if with_option.instance_of?(Symbol)
+          if respond_to?(with_option)
+            handler ||= self.class.instance_method(with_option).bind(self)
+          else
+            fail NoMethodError, "undefined method `#{with_option}'"
+          end
+        end
         handler
       end
 
@@ -59,6 +69,19 @@ module Grape
         end
       end
 
+      def inject_helpers!
+        return if helpers_available?
+        endpoint = @env['api.endpoint']
+        self.class.instance_eval do
+          include endpoint.send(:helpers)
+        end if endpoint.is_a?(Grape::Endpoint)
+        @helpers = true
+      end
+
+      def helpers_available?
+        @helpers
+      end
+
       def error!(message, status = options[:default_status], headers = {}, backtrace = [])
         headers = headers.reverse_merge(Grape::Http::Headers::CONTENT_TYPE => content_type)
         rack_response(format_message(message, backtrace), status, headers)
@@ -84,7 +107,7 @@ module Grape
 
       def format_message(message, backtrace)
         format = env[Grape::Env::API_FORMAT] || options[:format]
-        formatter = Grape::ErrorFormatter::Base.formatter_for(format, options)
+        formatter = Grape::ErrorFormatter.formatter_for(format, options)
         throw :error, status: 406, message: "The requested format '#{format}' is not supported." unless formatter
         formatter.call(message, backtrace, options, env)
       end