ruby-grape / grape / 33639489762

97%

master: 97%

Pull #2887

github

Add support for the HTTP QUERY method (RFC 10008)

QUERY is a safe, idempotent method whose content carries the query, for
cases where the query is too voluminous, too structured or too sensitive to
encode into a request URI. Grape had no support for it: `query` was not a
verb, and a route declared with `route :query` was answered with 405.

Three changes make it work:

* `Grape::HTTP_SUPPORTED_METHODS` gains QUERY, which mints the `query` DSL
  verb, routes the method, and lists it in the resource's `Allow` header.
  Rack has no constant for the method yet, so `Grape::QUERY` holds the
  literal.
* `Formatter::BODY_CARRYING_METHODS` gains QUERY, so the content is parsed
  into `params` the way a POST body is. Without this the request that *is*
  a query arrived with `params` empty.
* A QUERY that sends content without a `Content-Type` is rejected with 400
  rather than read as the API's default format, per RFC 10008 Sections 2
  and 2.1. Every other method keeps the fallback.

`default_status` already answers 200 rather than 201 for QUERY, and the
unsupported-media-type (415), unparseable-content (400) and unacceptable
`Accept` (406) paths already behave as Sections 2.1 requires once the body
is read at all.

The `Accept-Query` response header (Section 3) is not implemented; it is
optional, and its Structured Fields serialization is worth its own change.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

1239 of 1334 branches covered (92.88%)

Branch coverage included in aggregate %.

3 of 3 new or added lines in 2 files covered. (100.0%)

3925 of 3993 relevant lines covered (98.3%)

27530.72 hits per line