Class: Grape::Middleware::Versioner::AcceptVersionHeader

Inherits:

Base

• Object
• Base
• Grape::Middleware::Versioner::AcceptVersionHeader

Includes:

Grape::Middleware::VersionerHelpers

Defined in:

lib/grape/middleware/versioner/accept_version_header.rb

Overview

This middleware sets various version related rack environment variables based on the HTTP Accept-Version header

Example: For request header

Accept-Version: v1

The following rack env variables are set:

env['api.version']  => 'v1'

If version does not match this route, then a 406 is raised with X-Cascade header to alert Grape::Router to attempt the next matched route.

Constant Summary

Constants included from Grape::Middleware::VersionerHelpers

Grape::Middleware::VersionerHelpers::DEFAULT_PARAMETER, Grape::Middleware::VersionerHelpers::DEFAULT_PATTERN

Constants inherited from Base

Base::TEXT_HTML

Instance Attribute Summary

Attributes inherited from Base

#app, #env, #options

Instance Method Summary

• #before ⇒ Object

Methods included from Grape::Middleware::VersionerHelpers

#cascade?, #default_options, #error_headers, #mount_path, #parameter_key, #pattern, #potential_version_match?, #prefix, #strict?, #vendor, #version_not_found!, #version_options, #versions

Methods inherited from Base

#after, #call, #call!, #content_type, #content_type_for, #content_types, #default_options, #initialize, #mime_types, #response

Methods included from DSL::Headers

#header

Methods included from Helpers

#context

Constructor Details

This class inherits a constructor from Grape::Middleware::Base

Instance Method Details

#before ⇒ Object

# File 'lib/grape/middleware/versioner/accept_version_header.rb', line 22

def before
  potential_version = env[Grape::Http::Headers::HTTP_ACCEPT_VERSION]&.strip
  not_acceptable!('Accept-Version header must be set.') if strict? && potential_version.blank?

  return if potential_version.blank?

  not_acceptable!('The requested version is not supported.') unless potential_version_match?(potential_version)
  env[Grape::Env::API_VERSION] = potential_version
end