grape 0.18.0 → 0.19.0

data/README.md

@@ -38,6 +38,7 @@
   - [Multiple Allowed Types](#multiple-allowed-types)
   - [Validation of Nested Parameters](#validation-of-nested-parameters)
   - [Dependent Parameters](#dependent-parameters)
+  - [Group Options](#group-options)
   - [Built-in Validators](#built-in-validators)
   - [Namespace Validation and Coercion](#namespace-validation-and-coercion)
   - [Custom Validators](#custom-validators)
@@ -104,7 +105,7 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-You're reading the documentation for the stable release of Grape.
+You're reading the documentation for the stable release of Grape, 0.19.0.
 Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 ## Project Resources
@@ -1000,6 +1001,35 @@ params do
 end
 ```
 
+
+### Group Options
+
+Parameters options can be grouped. It can be useful if you want to extract
+common validation or types for several parameters. The example below presents a
+typical case when parameters share common options.
+
+```ruby
+params do
+  requires :first_name, type: String, regexp: /w+/, desc: 'First name'
+  requires :middle_name, type: String, regexp: /w+/, desc: 'Middle name'
+  requires :last_name, type: String, regexp: /w+/, desc: 'Last name'
+end
+```
+
+Grape allows you to present the same logic through the `with` method in your
+parameters block, like so:
+
+```ruby
+params do
+  with(type: String, regexp: /w+/) do
+    requires :first_name, desc: 'First name'
+    requires :middle_name, desc: 'Middle name'
+    requires :last_name, desc: 'Last name'
+  end
+end
+```
+
+
 ### Built-in Validators
 
 #### `allow_blank`
@@ -1075,12 +1105,12 @@ end
 ```
 
 Values and except can be combined to define a range of accepted values while not allowing
-certain values within the set. Custom error messages can be defined for both when the parameter 
-passed falls within the ```except``` list or when it falls entirely outside the ```value``` list. 
+certain values within the set. Custom error messages can be defined for both when the parameter
+passed falls within the ```except``` list or when it falls entirely outside the ```value``` list.
 
 ```ruby
 params do
-  requires :number, type: Integer, values: { value: 1..20 except: [4,13], except_message: 'includes unsafe numbers', message: 'is outside the range of numbers allowed' }
+  requires :number, type: Integer, values: { value: 1..20, except: [4, 13], except_message: 'includes unsafe numbers', message: 'is outside the range of numbers allowed' }
 end
 ```
 
@@ -1710,7 +1740,7 @@ cookies.delete :status_count, path: '/'
 
 ## HTTP Status Code
 
-By default Grape returns a 200 status code for `GET`-Requests and 201 for `POST`-Requests.
+By default Grape returns a 201 for `POST`-Requests, 204 for `DELETE`-Requests and 200 status code for all other Requests.
 You can use `status` to query and set the actual HTTP Status Code
 
 ```ruby
@@ -1776,7 +1806,9 @@ end
 
 When you add a route for a resource, a route for the `OPTIONS`
 method will also be added. The response to an OPTIONS request will
-include an "Allow" header listing the supported methods.
+include an "Allow" header listing the supported methods. If the resource
+has `before` and `after` callbacks they will be executed, but no other callbacks will
+run.
 
 ```ruby
 class API < Grape::API
@@ -1806,7 +1838,9 @@ curl -v -X OPTIONS http://localhost:3000/rt_count
 You can disable this behavior with `do_not_route_options!`.
 
 If a request for a resource is made with an unsupported HTTP method, an
-HTTP 405 (Method Not Allowed) response will be returned.
+HTTP 405 (Method Not Allowed) response will be returned. If the resource
+has `before` callbacks they will be executed, but no other callbacks will
+run.
 
 ``` shell
 curl -X DELETE -v http://localhost:3000/rt_count/
@@ -2766,6 +2800,14 @@ Before and after callbacks execute in the following order:
 
 Steps 4, 5 and 6 only happen if validation succeeds.
 
+If a request for a resource is made with an unsupported HTTP method (returning
+HTTP 405) only `before` callbacks will be executed.  The remaining callbacks will
+be bypassed.
+
+If a request for a resource is made that triggers the built-in `OPTIONS` handler,
+only `before` and `after` callbacks will be executed.  The remaining callbacks will
+be bypassed.
+
 #### Examples
 
 Using a simple `before` block to set a header

data/UPGRADING.md

@@ -1,6 +1,61 @@
 Upgrading Grape
 ===============
 
+### Upgrading to >= 0.18.1
+
+#### Changes in priority of :any routes
+
+Prior to this version, `:any` routes were searched after matching first route and 405 routes. This behavior has changed and `:any` routes are now searched before 405 processing. In the following example the `:any` route will match first when making a request with an unsupported verb.
+
+```ruby
+post :example do
+  'example'
+end
+route :any, '*path' do
+  error! :not_found, 404
+end
+
+get '/example' #=> before: 405, after: 404
+```
+
+#### Removed param processing from built-in OPTIONS handler
+
+When a request is made to the built-in `OPTIONS` handler, only the `before` and `after`
+callbacks associated with the resource will be run.  The `before_validation` and
+`after_validation` callbacks and parameter validations will be skipped.
+
+See [#1505](https://github.com/ruby-grape/grape/pull/1505) for more information.
+
+#### Changed endpoint params validation
+
+Grape now correctly returns validation errors for all params when multiple params are passed to a requires.
+The following code will return `one is missing, two is missing` when calling the endpoint without parameters.
+
+```ruby
+params do
+  requires :one, :two
+end
+```
+
+Prior to this version the response would be `one is missing`.
+
+See [#1510](https://github.com/ruby-grape/grape/pull/1510) for more information.
+
+#### The default status code for DELETE is now 204 instead of 200.
+
+Breaking change: Sets the default response status code for a delete request to 204.
+A status of 204 makes the response more distinguishable and therefore easier to handle on the client side, particularly because a DELETE request typically returns an empty body as the resource was deleted or voided.
+
+To achieve the old behavior, one has to set it explicitly:
+```ruby
+delete :id do
+  status 200
+  'foo successfully deleted'
+end
+```
+
+For more information see: [#1532](https://github.com/ruby-grape/grape/pull/1532).
+
 ### Upgrading to >= 0.17.0
 
 #### Removed official support for Ruby < 2.2.2
@@ -14,7 +69,7 @@ See [#1441](https://github.com/ruby-grape/grape/pull/1441) for nmore information
 The `rescue_from` clauses declared inside a namespace would take a priority over ones declared in the root scope.
 This could possibly affect those users who use different `rescue_from` clauses in root scope and in namespaces.
 
-See [#1405](https://github.com/ruby-grape/grape/pull/1405) for more inforomation.
+See [#1405](https://github.com/ruby-grape/grape/pull/1405) for more information.
 
 #### Helper methods injected inside `rescue_from` in middleware
 

data/gemfiles/rack_edge.gemfile

@@ -0,0 +1,34 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rack', github: 'rack/rack'
+
+group :development, :test do
+  gem 'bundler'
+  gem 'rake'
+  gem 'rubocop', '~> 0.45.0'
+end
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'yard'
+  gem 'appraisal'
+  gem 'benchmark-ips'
+  gem 'redcarpet'
+end
+
+group :test do
+  gem 'grape-entity', '~> 0.6'
+  gem 'maruku'
+  gem 'rack-test'
+  gem 'rspec', '~> 3.0'
+  gem 'cookiejar'
+  gem 'rack-jsonp', require: 'rack/jsonp'
+  gem 'mime-types', '~> 3.0'
+  gem 'ruby-grape-danger', '~> 0.1.0', require: false
+end
+
+gemspec path: '../'

data/gemfiles/rails_5.gemfile

@@ -7,7 +7,7 @@ gem 'rails', '5.0.0'
 group :development, :test do
   gem 'bundler'
   gem 'rake'
-  gem 'rubocop', '0.39.0'
+  gem 'rubocop', '0.45.0'
 end
 
 group :development do

data/gemfiles/rails_edge.gemfile

@@ -0,0 +1,34 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', github: 'rails/rails'
+
+group :development, :test do
+  gem 'bundler'
+  gem 'rake'
+  gem 'rubocop', '~> 0.45.0'
+end
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'yard'
+  gem 'appraisal'
+  gem 'benchmark-ips'
+  gem 'redcarpet'
+end
+
+group :test do
+  gem 'grape-entity', '~> 0.6'
+  gem 'maruku'
+  gem 'rack-test'
+  gem 'rspec', '~> 3.0'
+  gem 'cookiejar'
+  gem 'rack-jsonp', require: 'rack/jsonp'
+  gem 'mime-types', '~> 3.0'
+  gem 'ruby-grape-danger', '~> 0.1.0', require: false
+end
+
+gemspec path: '../'

data/lib/grape/api.rb

@@ -161,7 +161,7 @@ module Grape
           route_settings[:endpoint] = route.app
 
           # using the :any shorthand produces [nil] for route methods, substitute all manually
-          route_settings[:methods] = %w(GET PUT POST DELETE PATCH HEAD OPTIONS) if route_settings[:methods].include?('ANY')
+          route_settings[:methods] = %w(GET PUT POST DELETE PATCH HEAD OPTIONS) if route_settings[:methods].include?('*')
         end
       end
 

data/lib/grape/dsl/helpers.rb

@@ -31,6 +31,7 @@ module Grape
             mod = new_mod || Module.new
             define_boolean_in_mod(mod)
             inject_api_helpers_to_mod(mod) if new_mod
+
             inject_api_helpers_to_mod(mod) do
               mod.class_eval(&block)
             end if block_given?

data/lib/grape/dsl/inside_route.rb

@@ -129,6 +129,8 @@ module Grape
           case request.request_method.to_s.upcase
           when Grape::Http::Headers::POST
             201
+          when Grape::Http::Headers::DELETE
+            204
           else
             200
           end

data/lib/grape/dsl/parameters.rb

@@ -99,6 +99,7 @@ module Grape
 
         opts = attrs.extract_options!.clone
         opts[:presence] = { value: true, message: opts[:message] }
+        opts = @group.merge(opts) if @group
 
         if opts[:using]
           require_required_and_optional_fields(attrs.first, opts)
@@ -118,6 +119,7 @@ module Grape
 
         opts = attrs.extract_options!.clone
         type = opts[:type]
+        opts = @group.merge(opts) if @group
 
         # check type for optional parameter group
         if attrs && block_given?
@@ -134,6 +136,13 @@ module Grape
         end
       end
 
+      # Define common settings for one or more parameters
+      # @param (see #requires)
+      # @option (see #requires)
+      def with(*attrs, &block)
+        new_group_scope(attrs.clone, &block)
+      end
+
       # Disallow the given parameters to be present in the same request.
       # @param attrs [*Symbol] parameters to validate
       def mutually_exclusive(*attrs)
@@ -167,8 +176,8 @@ module Grape
       # @yield a parameter definition DSL
       def given(*attrs, &block)
         attrs.each do |attr|
-          attr_ = attr.is_a?(Hash) ? attr.keys[0] : attr
-          raise Grape::Exceptions::UnknownParameter.new(attr_) unless declared_param?(attr_)
+          proxy_attr = attr.is_a?(Hash) ? attr.keys[0] : attr
+          raise Grape::Exceptions::UnknownParameter.new(proxy_attr) unless declared_param?(proxy_attr)
         end
         new_lateral_scope(dependent_on: attrs, &block)
       end
@@ -184,21 +193,24 @@ module Grape
 
       alias group requires
 
+      def map_params(params, element)
+        if params.is_a?(Array)
+          params.map do |el|
+            map_params(el, element)
+          end
+        elsif params.is_a?(Hash)
+          params[element] || {}
+        else
+          {}
+        end
+      end
+
       # @param params [Hash] initial hash of parameters
       # @return hash of parameters relevant for the current scope
       # @api private
       def params(params)
         params = @parent.params(params) if @parent
-        if @element
-          params = if params.is_a?(Array)
-                     # used for calculating parent array indices for error messages
-                     params.map { |el| el[@element] || {} }
-                   elsif params.is_a?(Hash)
-                     params[@element] || {}
-                   else
-                     {}
-                   end
-        end
+        params = map_params(params, @element) if @element
         params
       end
     end

data/lib/grape/dsl/request_response.rb

@@ -110,11 +110,10 @@ module Grape
           end
           handler ||= extract_with(options)
 
-          case
-          when args.include?(:all)
+          if args.include?(:all)
             namespace_inheritable(:rescue_all, true)
             namespace_inheritable :all_rescue_handler, handler
-          when args.include?(:grape_exceptions)
+          elsif args.include?(:grape_exceptions)
             namespace_inheritable(:rescue_all, true)
             namespace_inheritable(:rescue_grape_exceptions, true)
           else

data/lib/grape/dsl/routing.rb

@@ -99,6 +99,7 @@ module Grape
               method: :any,
               path: path,
               app: app,
+              route_options: { anchor: false },
               forward_match: !app.respond_to?(:inheritable_setting),
               for: self
             )
@@ -118,6 +119,7 @@ module Grape
         #     end
         #   end
         def route(methods, paths = ['/'], route_options = {}, &block)
+          methods = '*' if methods == :any
           endpoint_options = {
             method: methods,
             path: paths,
@@ -198,6 +200,7 @@ module Grape
         # @option options [Regexp] You may supply a regular expression that the declared parameter must meet.
         def route_param(param, options = {}, &block)
           options = options.dup
+
           options[:requirements] = {
             param.to_sym => options[:requirements]
           } if options[:requirements].is_a?(Regexp)
@@ -205,6 +208,7 @@ module Grape
           Grape::Validations::ParamsScope.new(api: self) do
             requires param, type: options[:type]
           end if options.key?(:type)
+
           namespace(":#{param}", options, &block)
         end
 

data/lib/grape/endpoint.rb

@@ -95,6 +95,8 @@ module Grape
       @options[:route_options] ||= {}
 
       @lazy_initialize_lock = Mutex.new
+      @lazy_initialized = nil
+      @block = nil
 
       return unless block_given?
 
@@ -124,8 +126,8 @@ module Grape
       [options[:method],
        Namespace.joined_space(namespace_stackable(:namespace)),
        (namespace_stackable(:mount_path) || []).join('/'),
-       options[:path].join('/')
-      ].join(' ')
+       options[:path].join('/')]
+        .join(' ')
     end
 
     def routes
@@ -248,21 +250,18 @@ module Grape
 
         run_filters befores, :before
 
-        allowed_methods = env[Grape::Env::GRAPE_ALLOWED_METHODS]
-        raise Grape::Exceptions::MethodNotAllowed, header.merge('Allow' => allowed_methods) if !options? && allowed_methods
-
-        run_filters before_validations, :before_validation
-        run_validators validations, request
-        run_filters after_validations, :after_validation
+        if (allowed_methods = env[Grape::Env::GRAPE_ALLOWED_METHODS])
+          raise Grape::Exceptions::MethodNotAllowed, header.merge('Allow' => allowed_methods) unless options?
+          header 'Allow', allowed_methods
+          response_object = ''
+          status 204
+        else
+          run_filters before_validations, :before_validation
+          run_validators validations, request
+          run_filters after_validations, :after_validation
+          response_object = @block ? @block.call(self) : nil
+        end
 
-        response_object =
-          if options?
-            header 'Allow', allowed_methods
-            status 204
-            ''
-          else
-            @block ? @block.call(self) : nil
-          end
         run_filters afters, :after
         cookies.write(header)