sets 204 as default status for delete

- adds changelog entry - addresses comments - next try to make danger happy ;)
ruby-grape · Dec 5, 2016 · 113ed0a · 113ed0a
1 parent 152fa40
commit 113ed0a
Show file tree

Hide file tree

Showing 6 changed files with 112 additions and 89 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,10 @@
-Next Release
-============
+### Next Release
 
 #### Features
 
 * [#1503](https://github.com/ruby-grape/grape/pull/1503): Allow to use regexp validator with arrays - [@akoltun](https://github.com/akoltun).
 * [#1507](https://github.com/ruby-grape/grape/pull/1507): Add group attributes for parameter definitions - [@304](https://github.com/304).
+* [#1532](https://github.com/ruby-grape/grape/pull/1532): Sets 204 as default status for delete - [@LeFnord](https://github.com/LeFnord).
 * Your contribution here.
 
 #### Fixes
@@ -15,10 +15,9 @@ Next Release
 * [#1510](https://github.com/ruby-grape/grape/pull/1510): Fix: inconsistent validation for multiple parameters - [@dgasper](https://github.com/dgasper).
 * [#1526](https://github.com/ruby-grape/grape/pull/1526): Reduce warnings caused by instance variables not initialized - [@cpetschnig](https://github.com/cpetschnig).
 * [#1531](https://github.com/ruby-grape/grape/pull/1531): Updates gem dependencies - [@LeFnord](https://github.com/LeFnord).
+* Your contribution here.
 
-
-0.18.0 (10/7/2016)
-==================
+### 0.18.0 (10/7/2016)
 
 #### Features
 
@@ -35,8 +34,7 @@ Next Release
 * [#1488](https://github.com/ruby-grape/grape/pull/1488): Ensure calling before filters when receiving OPTIONS request - [@namusyaka](https://github.com/namusyaka), [@jlfaber](https://github.com/jlfaber).
 * [#1493](https://github.com/ruby-grape/grape/pull/1493): Coercion and lambda fails params validation - [@jonmchan](https://github.com/jonmchan).
 
-0.17.0 (7/29/2016)
-==================
+### 0.17.0 (7/29/2016)
 
 #### Features
 
@@ -64,8 +62,7 @@ Next Release
 * [#1421](https://github.com/ruby-grape/grape/pull/1421): Avoid polluting `Grape::Middleware::Error` - [@namusyaka](https://github.com/namusyaka).
 * [#1422](https://github.com/ruby-grape/grape/pull/1422): Concat parent declared params with current one - [@plukevdh](https://github.com/plukevdh), [@rnubel](https://github.com/rnubel), [@namusyaka](https://github.com/namusyaka).
 
-0.16.2 (4/12/2016)
-==================
+### 0.16.2 (4/12/2016)
 
 #### Features
 
@@ -78,8 +75,7 @@ Next Release
 * [#1359](https://github.com/ruby-grape/grape/pull/1359): Avoid evaluating the same route twice - [@namusyaka](https://github.com/namusyaka), [@dblock](https://github.com/dblock).
 * [#1361](https://github.com/ruby-grape/grape/pull/1361): Return 405 correctly even if version is using as header and wrong request method - [@namusyaka](https://github.com/namusyaka), [@dblock](https://github.com/dblock).
 
-0.16.1 (4/3/2016)
-=================
+### 0.16.1 (4/3/2016)
 
 #### Features
 
@@ -94,8 +90,7 @@ Next Release
 * [#1330](https://github.com/ruby-grape/grape/pull/1330): Add `register` keyword for adding customized parsers and formatters - [@namusyaka](https://github.com/namusyaka).
 * [#1336](https://github.com/ruby-grape/grape/pull/1336): Do not modify Hash argument to `error!` - [@tjwp](https://github.com/tjwp).
 
-0.15.0 (3/8/2016)
-=================
+### 0.15.0 (3/8/2016)
 
 #### Features
 
@@ -122,8 +117,7 @@ Next Release
 * [#1283](https://github.com/ruby-grape/grape/pull/1283): Fix 500 error for xml format when method is not allowed - [@304](https://github.com/304).
 * [#1197](https://github.com/ruby-grape/grape/pull/1290): Fix using JSON and Array[JSON] as groups when parameter is optional - [@lukeivers](https://github.com/lukeivers).
 
-0.14.0 (12/07/2015)
-=================
+### 0.14.0 (12/07/2015)
 
 #### Features
 
@@ -150,8 +144,7 @@ Next Release
 * [#1101](https://github.com/ruby-grape/grape/pull/1101): Fix: Incorrect media-type `Accept` header now correctly returns 406 with `strict: true` - [@elliotlarson](https://github.com/elliotlarson).
 * [#1108](https://github.com/ruby-grape/grape/pull/1039): Raise a warning when `desc` is called with options hash and block - [@rngtng](https://github.com/rngtng).
 
-0.13.0 (8/10/2015)
-==================
+### 0.13.0 (8/10/2015)
 
 #### Features
 
@@ -172,8 +165,7 @@ Next Release
 * [#1088](https://github.com/ruby-grape/grape/pull/1088): Support ActiveSupport 3.x by explicitly requiring `Hash#except` - [@wagenet](https://github.com/wagenet).
 * [#1096](https://github.com/ruby-grape/grape/pull/1096): Fix coercion on booleans - [@towanda](https://github.com/towanda).
 
-0.12.0 (6/18/2015)
-==================
+### 0.12.0 (6/18/2015)
 
 #### Features
 
@@ -199,8 +191,7 @@ Next Release
 * [#1023](https://github.com/ruby-grape/grape/issues/1023): Fixes unexpected behavior with `present` and an object that responds to `merge` but isn't a Hash - [@dblock](https://github.com/dblock).
 * [#1017](https://github.com/ruby-grape/grape/pull/1017): Fixed `undefined method stringify_keys` with nested mutual exclusive params - [@quickpay](https://github.com/quickpay).
 
-0.11.0 (2/23/2015)
-==================
+### 0.11.0 (2/23/2015)
 
 * [#925](https://github.com/ruby-grape/grape/pull/925): Fixed `toplevel constant DateTime referenced by Virtus::Attribute::DateTime` - [@u2](https://github.com/u2).
 * [#916](https://github.com/ruby-grape/grape/pull/916): Added `DateTime/Date/Numeric/Boolean` type support `allow_blank` - [@u2](https://github.com/u2).
@@ -217,14 +208,12 @@ Next Release
 * [#913](https://github.com/ruby-grape/grape/pull/913): Fix: Invalid accept headers cause internal processing errors (500) when http_codes are defined - [@croeck](https://github.com/croeck).
 * [#917](https://github.com/ruby-grape/grape/pull/917): Use HTTPS for rubygems.org - [@O-I](https://github.com/O-I).
 
-0.10.1 (12/28/2014)
-===================
+### 0.10.1 (12/28/2014)
 
 * [#868](https://github.com/ruby-grape/grape/pull/868), [#862](https://github.com/ruby-grape/grape/pull/862), [#861](https://github.com/ruby-grape/grape/pull/861): Fixed `version`, `prefix`, and other settings being overridden or changing scope when mounting API - [@yesmeck](https://github.com/yesmeck).
 * [#864](https://github.com/ruby-grape/grape/pull/864): Fixed `declared(params, include_missing: false)` now returning attributes with `nil` and `false` values - [@ppadron](https://github.com/ppadron).
 
-0.10.0 (12/19/2014)
-===================
+### 0.10.0 (12/19/2014)
 
 * [#803](https://github.com/ruby-grape/grape/pull/803), [#820](https://github.com/ruby-grape/grape/pull/820): Added `all_or_none_of` parameter validator - [@loveltyoic](https://github.com/loveltyoic), [@natecj](https://github.com/natecj).
 * [#774](https://github.com/ruby-grape/grape/pull/774): Extended `mutually_exclusive`, `exactly_one_of`, `at_least_one_of` to work inside any kind of group: `requires` or `optional`, `Hash` or `Array` - [@ShPakvel](https://github.com/ShPakvel).
@@ -247,8 +236,7 @@ Next Release
 * [#679](https://github.com/ruby-grape/grape/issues/679): Fixed `OPTIONS` method returning 404 when combined with `prefix` - [@dblock](https://github.com/dblock).
 * [#679](https://github.com/ruby-grape/grape/issues/679): Fixed unsupported methods returning 404 instead of 405 when combined with `prefix` - [@dblock](https://github.com/dblock).
 
-0.9.0 (8/27/2014)
-=================
+### 0.9.0 (8/27/2014)
 
 #### Features
 
@@ -266,8 +254,7 @@ Next Release
 
 * [#687](https://github.com/ruby-grape/grape/pull/687): Fix: `mutually_exclusive` and `exactly_one_of` validation error messages now label parameters as strings, consistently with `requires` and `optional` - [@dblock](https://github.com/dblock).
 
-0.8.0 (7/10/2014)
-=================
+### 0.8.0 (7/10/2014)
 
 #### Features
 
@@ -287,8 +274,7 @@ Next Release
 * [#619](https://github.com/ruby-grape/grape/pull/619): Convert specs to RSpec 3 syntax with Transpec - [@danielspector](https://github.com/danielspector).
 * [#632](https://github.com/ruby-grape/grape/pull/632): `Grape::Endpoint#present` causes ActiveRecord to make an extra query during entity's detection - [@fixme](https://github.com/fixme).
 
-0.7.0 (4/2/2014)
-=================
+### 0.7.0 (4/2/2014)
 
 #### Features
 
@@ -327,8 +313,7 @@ Next Release
 * [#587](https://github.com/ruby-grape/grape/pull/587): Fix oauth2 middleware compatibility with [draft-ietf-oauth-v2-31](http://tools.ietf.org/html/draft-ietf-oauth-v2-31) spec - [@etehtsea](https://github.com/etehtsea).
 * [#610](https://github.com/ruby-grape/grape/pull/610): Fixed group keyword was not working with type parameter - [@klausmeyer](https://github.com/klausmeyer).
 
-0.6.1 (10/19/2013)
-==================
+### 0.6.1 (10/19/2013)
 
 #### Features
 
@@ -344,8 +329,7 @@ Next Release
 
 * Implemented Rubocop, a Ruby code static code analyzer - [@dblock](https://github.com/dblock).
 
-0.6.0 (9/16/2013)
-=================
+### 0.6.0 (9/16/2013)
 
 #### Features
 
@@ -363,8 +347,7 @@ Next Release
 
 * [#428](https://github.com/ruby-grape/grape/issues/428): Removes memoization from `Grape::Request` params to prevent middleware from freezing parameter values before `Formatter` can get them - [@mbleigh](https://github.com/mbleigh).
 
-0.5.0 (6/14/2013)
-=================
+### 0.5.0 (6/14/2013)
 
 #### Features
 
@@ -390,13 +373,11 @@ Next Release
 * [#423](https://github.com/ruby-grape/grape/pull/423): Fix: `Grape::Endpoint#declared` now correctly handles nested params (ie. declared with `group`) - [@jbarreneche](https://github.com/jbarreneche).
 * [#427](https://github.com/ruby-grape/grape/issues/427): Fix: `declared(params)` breaks when `params` contains array - [@timhabermaas](https://github.com/timhabermaas).
 
-0.4.1 (4/1/2013)
-================
+### 0.4.1 (4/1/2013)
 
 * [#375](https://github.com/ruby-grape/grape/pull/375): Fix: throwing an `:error` inside a middleware doesn't respect the `format` settings - [@dblock](https://github.com/dblock).
 
-0.4.0 (3/17/2013)
-=================
+### 0.4.0 (3/17/2013)
 
 * [#356](https://github.com/ruby-grape/grape/pull/356): Fix: presenting collections other than `Array` (eg. `ActiveRecord::Relation`) - [@zimbatm](https://github.com/zimbatm).
 * [#352](https://github.com/ruby-grape/grape/pull/352): Fix: using `Rack::JSONP` with `Grape::Entity` responses - [@deckchair](https://github.com/deckchair).
@@ -410,18 +391,15 @@ Next Release
 * [#353](https://github.com/ruby-grape/grape/issues/353): Revert to standard Ruby logger formatter, `require active_support/all` if you want old behavior - [@rhunter](https://github.com/rhunter), [@dblock](https://github.com/dblock).
 * Fix: `undefined method 'call' for nil:NilClass` for an API method implementation without a block, now returns an empty string - [@dblock](https://github.com/dblock).
 
-0.3.2 (2/28/2013)
-=================
+### 0.3.2 (2/28/2013)
 
 * [#355](https://github.com/ruby-grape/grape/issues/355): Relax dependency constraint on Hashie - [@reset](https://github.com/reset).
 
-0.3.1 (2/25/2013)
-=================
+### 0.3.1 (2/25/2013)
 
 * [#351](https://github.com/ruby-grape/grape/issues/351): Compatibility with Ruby 2.0 - [@mbleigh](https://github.com/mbleigh).
 
-0.3.0 (02/21/2013)
-==================
+### 0.3.0 (02/21/2013)
 
 * [#294](https://github.com/ruby-grape/grape/issues/294): Extracted `Grape::Entity` into a [grape-entity](https://github.com/agileanimal/grape-entity) gem - [@agileanimal](https://github.com/agileanimal).
 * [#340](https://github.com/ruby-grape/grape/pull/339), [#342](https://github.com/ruby-grape/grape/pull/342): Added `:cascade` option to `version` to allow disabling of rack/mount cascade behavior - [@dieb](https://github.com/dieb).
@@ -440,14 +418,12 @@ Next Release
 * [#60](https://github.com/ruby-grape/grape/issues/60): Fix: mounting of a Grape API onto a path - [@dblock](https://github.com/dblock).
 * [#335](https://github.com/ruby-grape/grape/pull/335): Fix: request body parameters from a `PATCH` request not available in `params` - [@FreakenK](https://github.com/FreakenK).
 
-0.2.6 (01/11/2013)
-==================
+### 0.2.6 (01/11/2013)
 
 * Fix: support content-type with character set when parsing POST and PUT input - [@dblock](https://github.com/dblock).
 * Fix: CVE-2013-0175, multi_xml parse vulnerability, require multi_xml 0.5.2 - [@dblock](https://github.com/dblock).
 
-0.2.5 (01/10/2013)
-==================
+### 0.2.5 (01/10/2013)
 
 * Added support for custom parsers via `parser`, in addition to built-in multipart, JSON and XML parsers - [@dblock](https://github.com/dblock).
 * Removed `body_params`, data sent via a POST or PUT with a supported content-type is merged into `params` - [@dblock](https://github.com/dblock).
@@ -456,8 +432,7 @@ Next Release
 * [#305](https://github.com/ruby-grape/grape/issues/305): Fix: presenting arrays of objects via `represent` or when auto-detecting an `Entity` constant in the objects being presented - [@brandonweiss](https://github.com/brandonweiss).
 * [#306](https://github.com/ruby-grape/grape/issues/306): Added i18n support for validation error messages - [@niedhui](https://github.com/niedhui).
 
-0.2.4 (01/06/2013)
-==================
+### 0.2.4 (01/06/2013)
 
 * [#297](https://github.com/ruby-grape/grape/issues/297): Added `default_error_formatter` - [@dblock](https://github.com/dblock).
 * [#297](https://github.com/ruby-grape/grape/issues/297): Setting `format` will automatically set `default_error_formatter` - [@dblock](https://github.com/dblock).
@@ -475,8 +450,7 @@ Next Release
 * [#304](https://github.com/ruby-grape/grape/issues/304): Fix: `present x, :with => Entity` returns class references with `format :json` - [@dblock](https://github.com/dblock).
 * [#196](https://github.com/ruby-grape/grape/issues/196): Fix: root requests don't work with `prefix` - [@dblock](https://github.com/dblock).
 
-0.2.3 (24/12/2012)
-==================
+### 0.2.3 (24/12/2012)
 
 * [#179](https://github.com/ruby-grape/grape/issues/178): Using `content_type` will remove all default content-types - [@dblock](https://github.com/dblock).
 * [#265](https://github.com/ruby-grape/grape/issues/264): Fix: Moved `ValidationError` into `Grape::Exceptions` - [@thepumpkin1979](https://github.com/thepumpkin1979).
@@ -512,8 +486,7 @@ Next Release
 * [#208](https://github.com/ruby-grape/grape/pull/208): `Entity#serializable_hash` must also check if attribute is generated by a user supplied block - [@ppadron](https://github.com/ppadron).
 * [#252](https://github.com/ruby-grape/grape/pull/252): Resources that don't respond to a requested HTTP method return 405 (Method Not Allowed) instead of 404 (Not Found) - [@simulacre](https://github.com/simulacre).
 
-0.2.1 (7/11/2012)
-=================
+### 0.2.1 (7/11/2012)
 
 * [#186](https://github.com/ruby-grape/grape/issues/186): Fix: helpers allow multiple calls with modules and blocks - [@ppadron](https://github.com/ppadron).
 * [#188](https://github.com/ruby-grape/grape/pull/188): Fix: multi-method routes append '(.:format)' only once - [@kainosnoema](https://github.com/kainosnoema).
@@ -528,8 +501,7 @@ Next Release
 * [#189](https://github.com/ruby-grape/grape/pull/189): `HEAD` requests no longer return a body - [@stephencelis](https://github.com/stephencelis).
 * [#97](https://github.com/ruby-grape/grape/issues/97): Allow overriding `Content-Type` - [@dblock](https://github.com/dblock).
 
-0.2.0 (3/28/2012)
-=================
+### 0.2.0 (3/28/2012)
 
 * Added support for inheriting exposures from entities - [@bobbytables](https://github.com/bobbytables).
 * Extended formatting with `default_format` - [@dblock](https://github.com/dblock).
@@ -549,33 +521,28 @@ Next Release
 * Added support for before and after filters - [@mbleigh](https://github.com/mbleigh).
 * Extended `rescue_from`, which can now take a block - [@dblock](https://github.com/dblock).
 
-0.1.5 (6/14/2011)
-==================
+### 0.1.5 (6/14/2011)
 
 * Extended exception handling to all exceptions - [@dblock](https://github.com/dblock).
 * Added support for returning JSON objects from within error blocks - [@dblock](https://github.com/dblock).
 * Added support for handling incoming JSON in body - [@tedkulp](https://github.com/tedkulp).
 * Added support for HTTP digest authentication - [@daddz](https://github.com/daddz).
 
-0.1.4 (4/8/2011)
-==================
+### 0.1.4 (4/8/2011)
 
 * Allow multiple definitions of the same endpoint under multiple versions - [@chrisrhoden](https://github.com/chrisrhoden).
 * Added support for multipart URL parameters - [@mcastilho](https://github.com/mcastilho).
 * Added support for custom formatters - [@spraints](https://github.com/spraints).
 
-0.1.3 (1/10/2011)
-==================
+### 0.1.3 (1/10/2011)
 
 * Added support for JSON format in route matching - [@aiwilliams](https://github.com/aiwilliams).
 * Added suport for custom middleware - [@mbleigh](https://github.com/mbleigh).
 
-0.1.1 (11/14/2010)
-==================
+### 0.1.1 (11/14/2010)
 
 * Endpoints properly reset between each request - [@mbleigh](https://github.com/mbleigh).
 
-0.1.0 (11/13/2010)
-==================
+### 0.1.0 (11/13/2010)
 
 * Initial public release - [@mbleigh](https://github.com/mbleigh).
diff --git a/README.md b/README.md
@@ -1741,7 +1741,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

diff --git a/UPGRADING.md b/UPGRADING.md
@@ -41,6 +41,21 @@ 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

diff --git a/lib/grape/dsl/inside_route.rb b/lib/grape/dsl/inside_route.rb
@@ -129,6 +129,8 @@ def status(status = nil)
           case request.request_method.to_s.upcase
           when Grape::Http::Headers::POST
             201
+          when Grape::Http::Headers::DELETE
+            204
           else
             200
           end

diff --git a/spec/grape/dsl/inside_route_spec.rb b/spec/grape/dsl/inside_route_spec.rb
@@ -91,7 +91,7 @@ def initialize
   end
 
   describe '#status' do
-    %w(GET PUT DELETE OPTIONS).each do |method|
+    %w(GET PUT OPTIONS).each do |method|
       it 'defaults to 200 on GET' do
         request = Grape::Request.new(Rack::MockRequest.env_for('/', method: method))
         expect(subject).to receive(:request).and_return(request)
@@ -105,6 +105,12 @@ def initialize
       expect(subject.status).to eq 201
     end
 
+    it 'defaults to 204 on DELETE' do
+      request = Grape::Request.new(Rack::MockRequest.env_for('/', method: 'DELETE'))
+      expect(subject).to receive(:request).and_return(request)
+      expect(subject.status).to eq 204
+    end
+
     it 'returns status set' do
       subject.status 501
       expect(subject.status).to eq 501