grape 0.14.0 → 0.15.0

data/UPGRADING.md

@@ -1,6 +1,73 @@
 Upgrading Grape
 ===============
 
+### Upgrading to >= 0.15.0
+
+#### Changes to availability of `:with` option of `rescue_from` method
+
+The `:with` option of `rescue_from` does not accept value except Proc, String or Symbol now.
+
+If you have been depending the old behavior, you should use lambda block instead.
+
+```ruby
+class API < Grape::API
+  rescue_from :all, with: -> { Rack::Response.new('rescued with a method', 400) }
+end
+```
+
+#### Changes to behavior of `after` method of middleware on error
+
+The `after` method of the middleware is now also called on error. The following code would work correctly.
+
+```ruby
+class ErrorMiddleware < Grape::Middleware::Base
+  def after
+    return unless @app_response && @app_response[0] == 500
+    env['rack.logger'].debug("Raised error on #{env['PATH_INFO']}")
+  end
+end
+```
+
+See [#1147](https://github.com/ruby-grape/grape/issues/1147) and [#1240](https://github.com/ruby-grape/grape/issues/1240) for discussion of the issues.
+
+A warning will be logged if an exception is raised in an `after` callback, which points you to middleware that was not called in the previous version and is called now.
+
+```
+caught error of type NoMethodError in after callback inside Api::Middleware::SomeMiddleware : undefined method `headers' for nil:NilClass
+```
+
+See [#1285](https://github.com/ruby-grape/grape/pull/1285) for more information.
+
+#### Changes to Method Not Allowed routes
+
+A `405 Method Not Allowed` error now causes `Grape::Exceptions::MethodNotAllowed` to be raised, which will be rescued via `rescue_from :all`. Restore old behavior with the following error handler.
+
+```ruby
+rescue_from Grape::Exceptions::MethodNotAllowed do |e|
+  error! e.message, e.status, e.headers
+end
+```
+
+See [#1283](https://github.com/ruby-grape/grape/pull/1283) for more information.
+
+#### Changes to Grape::Exceptions::Validation parameters
+
+When raising `Grape::Exceptions::Validation` explicitly, replace `message_key` with `message`.
+
+For example,
+
+```ruby
+fail Grape::Exceptions::Validation, params: [:oauth_token_secret], message_key: :presence
+```
+
+becomes
+
+```ruby
+fail Grape::Exceptions::Validation, params: [:oauth_token_secret], message: :presence
+```
+
+See [#1295](https://github.com/ruby-grape/grape/pull/1295) for more information.
+
 ### Upgrading to >= 0.14.0
 
 #### Changes to availability of DSL methods in filters
@@ -106,7 +173,7 @@ error!({ message: 'No such page.', id: 'missing_page' }, 404, { 'Content-Type' =
 `error!` also supports just passing a message. `error!('Server error.')` and `format: :json` returns the following JSON response
 
 ```
-{ 'error': 'Server error. }
+{ 'error': 'Server error.' }
 ```
 
 with a status code of 500 and a Content Type of text/error.

data/gemfiles/rails_3.gemfile

@@ -2,7 +2,7 @@
 
 source 'https://rubygems.org'
 
-gem 'rails', '3.2.19'
+gem 'rails', '3.2.22'
 gem 'rack-cache', '<= 1.2'
 
 group :development, :test do

data/lib/grape.rb

@@ -15,6 +15,7 @@ require 'active_support/core_ext/array/wrap'
 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/conversions'
 require 'active_support/dependencies/autoload'
 require 'active_support/notifications'
 require 'multi_json'
@@ -40,6 +41,9 @@ module Grape
 
     autoload :Cookies
     autoload :Validations
+    autoload :ErrorFormatter
+    autoload :Formatter
+    autoload :Parser
     autoload :Request
     autoload :Env, 'grape/util/env'
   end
@@ -71,6 +75,7 @@ module Grape
     autoload :InvalidMessageBody
     autoload :InvalidAcceptHeader
     autoload :InvalidVersionHeader
+    autoload :MethodNotAllowed
   end
 
   module ErrorFormatter
@@ -83,7 +88,6 @@ module Grape
 
   module Formatter
     extend ActiveSupport::Autoload
-    autoload :Base
     autoload :Json
     autoload :SerializableHash
     autoload :Txt
@@ -92,7 +96,6 @@ module Grape
 
   module Parser
     extend ActiveSupport::Autoload
-    autoload :Base
     autoload :Json
     autoload :Xml
   end
@@ -129,6 +132,7 @@ module Grape
     autoload :InheritableSetting
     autoload :StrictHashConfiguration
     autoload :FileResponse
+    autoload :SendfileResponse
   end
 
   module DSL
@@ -145,6 +149,8 @@ module Grape
       autoload :RequestResponse
       autoload :Routing
       autoload :Validations
+      autoload :Logger
+      autoload :Desc
     end
   end
 

data/lib/grape/api.rb

@@ -13,9 +13,8 @@ module Grape
 
       # Clears all defined routes, endpoints, etc., on this API.
       def reset!
-        @route_set = Rack::Mount::RouteSet.new
-        @endpoints = []
-        @routes = nil
+        reset_endpoints!
+        reset_routes!
         reset_validations!
       end
 
@@ -44,20 +43,10 @@ module Grape
         instance.call(env)
       end
 
-      # Create a scope without affecting the URL.
-      #
-      # @param _name [Symbol] Purely placebo, just allows to name the scope to
-      # make the code more readable.
-      def scope(_name = nil, &block)
-        within_namespace do
-          nest(block)
-        end
-      end
-
       # (see #cascade?)
       def cascade(value = nil)
         if value.nil?
-          inheritable_setting.namespace_inheritable.keys.include?(:cascade) ? !!namespace_inheritable(:cascade) : true
+          inheritable_setting.namespace_inheritable.keys.include?(:cascade) ? !namespace_inheritable(:cascade).nil? : true
         else
           namespace_inheritable(:cascade, value)
         end
@@ -91,9 +80,7 @@ module Grape
       def inherit_settings(other_settings)
         top_level_setting.inherit_from other_settings.point_in_time_copy
 
-        endpoints.each(&:reset_routes!)
-
-        @routes = nil
+        reset_routes!
       end
     end
 
@@ -144,8 +131,15 @@ module Grape
       self.class.endpoints.each do |endpoint|
         routes = endpoint.routes
         routes.each do |route|
-          methods_per_path[route.route_path] ||= []
-          methods_per_path[route.route_path] << route.route_method
+          route_path = route.route_path
+                       .gsub(/\(.*\)/, '') # ignore any optional portions
+                       .gsub(%r{\:[^\/.?]+}, ':x') # substitute variable names to avoid conflicts
+
+          methods_per_path[route_path] ||= []
+          methods_per_path[route_path] << route.route_method
+
+          # using the :any shorthand produces [nil] for route methods, substitute all manually
+          methods_per_path[route_path] = %w(GET PUT POST DELETE PATCH HEAD OPTIONS) if methods_per_path[route_path].compact.empty?
         end
       end
 
@@ -157,33 +151,45 @@ module Grape
         without_versioning do
           methods_per_path.each do |path, methods|
             allowed_methods = methods.dup
+
             unless self.class.namespace_inheritable(:do_not_route_head)
               allowed_methods |= [Grape::Http::Headers::HEAD] if allowed_methods.include?(Grape::Http::Headers::GET)
             end
 
-            allow_header = ([Grape::Http::Headers::OPTIONS] | allowed_methods).join(', ')
+            allow_header = (self.class.namespace_inheritable(:do_not_route_options) ? allowed_methods : [Grape::Http::Headers::OPTIONS] | allowed_methods).join(', ')
+
             unless self.class.namespace_inheritable(:do_not_route_options)
-              unless allowed_methods.include?(Grape::Http::Headers::OPTIONS)
-                self.class.options(path, {}) do
-                  header 'Allow', allow_header
-                  status 204
-                  ''
-                end
-              end
+              generate_options_method(path, allow_header) unless allowed_methods.include?(Grape::Http::Headers::OPTIONS)
             end
 
-            not_allowed_methods = %w(GET PUT POST DELETE PATCH HEAD) - allowed_methods
-            not_allowed_methods << Grape::Http::Headers::OPTIONS if self.class.namespace_inheritable(:do_not_route_options)
-            self.class.route(not_allowed_methods, path) do
-              header 'Allow', allow_header
-              status 405
-              ''
-            end
+            generate_not_allowed_method(path, allowed_methods, allow_header)
           end
         end
       end
     end
 
+    # Generate an 'OPTIONS' route for a pre-exisiting user defined route
+    def generate_options_method(path, allow_header)
+      self.class.options(path, {}) do
+        header 'Allow', allow_header
+        status 204
+        ''
+      end
+    end
+
+    # Generate a route that returns an HTTP 405 response for a user defined
+    # path on methods not specified
+    def generate_not_allowed_method(path, allowed_methods, allow_header)
+      not_allowed_methods = %w(GET PUT POST DELETE PATCH HEAD) - allowed_methods
+      not_allowed_methods << Grape::Http::Headers::OPTIONS if self.class.namespace_inheritable(:do_not_route_options)
+
+      return if not_allowed_methods.empty?
+
+      self.class.route(not_allowed_methods, path) do
+        fail Grape::Exceptions::MethodNotAllowed, header.merge('Allow' => allow_header)
+      end
+    end
+
     # Allows definition of endpoints that ignore the versioning configuration
     # used by the rest of your API.
     def without_versioning(&_block)

data/lib/grape/dsl/configuration.rb

@@ -6,122 +6,9 @@ module Grape
       extend ActiveSupport::Concern
 
       module ClassMethods
-        attr_writer :logger
-
         include Grape::DSL::Settings
-
-        # Set or retrive the configured logger. If none was configured, this
-        # method will create a new one, logging to stdout.
-        # @param logger [Object] the new logger to use
-        def logger(logger = nil)
-          if logger
-            global_setting(:logger, logger)
-          else
-            global_setting(:logger) || global_setting(:logger, Logger.new($stdout))
-          end
-        end
-
-        # Add a description to the next namespace or function.
-        # @param description [String] descriptive string for this endpoint
-        #   or namespace
-        # @param options [Hash] other properties you can set to describe the
-        #   endpoint or namespace. Optional.
-        # @option options :detail [String] additional detail about this endpoint
-        # @option options :params [Hash] param types and info. normally, you set
-        #   these via the `params` dsl method.
-        # @option options :entity [Grape::Entity] the entity returned upon a
-        #   successful call to this action
-        # @option options :http_codes [Array[Array]] possible HTTP codes this
-        #   endpoint may return, with their meanings, in a 2d array
-        # @option options :named [String] a specific name to help find this route
-        # @option options :headers [Hash] HTTP headers this method can accept
-        # @yield a block yielding an instance context with methods mapping to
-        #   each of the above, except that :entity is also aliased as #success
-        #   and :http_codes is aliased as #failure.
-        #
-        # @example
-        #
-        #     desc 'create a user'
-        #     post '/users' do
-        #       # ...
-        #     end
-        #
-        #     desc 'find a user' do
-        #       detail 'locates the user from the given user ID'
-        #       failure [ [404, 'Couldn\'t find the given user' ] ]
-        #       success User::Entity
-        #     end
-        #     get '/user/:id' do
-        #       # ...
-        #     end
-        #
-        def desc(description, options = {}, &config_block)
-          if block_given?
-            config_class = Grape::DSL::Configuration.desc_container
-
-            config_class.configure do
-              description description
-            end
-
-            config_class.configure(&config_block)
-            unless options.empty?
-              warn '[DEPRECATION] Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.'
-            end
-            options = config_class.settings
-          else
-            options = options.merge(description: description)
-          end
-
-          namespace_setting :description, options
-          route_setting :description, options
-        end
-
-        def description_field(field, value = nil)
-          if value
-            description = route_setting(:description)
-            description ||= route_setting(:description, {})
-            description[field] = value
-          else
-            description = route_setting(:description)
-            description[field] if description
-          end
-        end
-
-        def unset_description_field(field)
-          description = route_setting(:description)
-          description.delete(field) if description
-        end
-      end
-
-      module_function
-
-      # Merge multiple layers of settings into one hash.
-      def stacked_hash_to_hash(settings)
-        return if settings.blank?
-        settings.each_with_object({}) { |value, result| result.deep_merge!(value) }
-      end
-
-      # Returns an object which configures itself via an instance-context DSL.
-      def desc_container
-        Module.new do
-          include Grape::Util::StrictHashConfiguration.module(
-            :description,
-            :detail,
-            :params,
-            :entity,
-            :http_codes,
-            :named,
-            :headers
-          )
-
-          def config_context.success(*args)
-            entity(*args)
-          end
-
-          def config_context.failure(*args)
-            http_codes(*args)
-          end
-        end
+        include Grape::DSL::Logger
+        include Grape::DSL::Desc
       end
     end
   end

data/lib/grape/dsl/desc.rb

@@ -0,0 +1,101 @@
+module Grape
+  module DSL
+    module Desc
+      include Grape::DSL::Settings
+
+      # Add a description to the next namespace or function.
+      # @param description [String] descriptive string for this endpoint
+      #   or namespace
+      # @param options [Hash] other properties you can set to describe the
+      #   endpoint or namespace. Optional.
+      # @option options :detail [String] additional detail about this endpoint
+      # @option options :params [Hash] param types and info. normally, you set
+      #   these via the `params` dsl method.
+      # @option options :entity [Grape::Entity] the entity returned upon a
+      #   successful call to this action
+      # @option options :http_codes [Array[Array]] possible HTTP codes this
+      #   endpoint may return, with their meanings, in a 2d array
+      # @option options :named [String] a specific name to help find this route
+      # @option options :headers [Hash] HTTP headers this method can accept
+      # @yield a block yielding an instance context with methods mapping to
+      #   each of the above, except that :entity is also aliased as #success
+      #   and :http_codes is aliased as #failure.
+      #
+      # @example
+      #
+      #     desc 'create a user'
+      #     post '/users' do
+      #       # ...
+      #     end
+      #
+      #     desc 'find a user' do
+      #       detail 'locates the user from the given user ID'
+      #       failure [ [404, 'Couldn\'t find the given user' ] ]
+      #       success User::Entity
+      #     end
+      #     get '/user/:id' do
+      #       # ...
+      #     end
+      #
+      def desc(description, options = {}, &config_block)
+        if block_given?
+          config_class = desc_container
+
+          config_class.configure do
+            description description
+          end
+
+          config_class.configure(&config_block)
+          unless options.empty?
+            warn '[DEPRECATION] Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.'
+          end
+          options = config_class.settings
+        else
+          options = options.merge(description: description)
+        end
+
+        namespace_setting :description, options
+        route_setting :description, options
+      end
+
+      def description_field(field, value = nil)
+        if value
+          description = route_setting(:description)
+          description ||= route_setting(:description, {})
+          description[field] = value
+        else
+          description = route_setting(:description)
+          description[field] if description
+        end
+      end
+
+      def unset_description_field(field)
+        description = route_setting(:description)
+        description.delete(field) if description
+      end
+
+      # Returns an object which configures itself via an instance-context DSL.
+      def desc_container
+        Module.new do
+          include Grape::Util::StrictHashConfiguration.module(
+            :description,
+            :detail,
+            :params,
+            :entity,
+            :http_codes,
+            :named,
+            :headers
+          )
+
+          def config_context.success(*args)
+            entity(*args)
+          end
+
+          def config_context.failure(*args)
+            http_codes(*args)
+          end
+        end
+      end
+    end
+  end
+end