Class: RubstApi::Security::APIKeyHeader

Inherits:

Base

• Object
• Base
• RubstApi::Security::APIKeyHeader

Defined in:

lib/rubst_api/security.rb

Instance Attribute Summary

Attributes inherited from Base

#auto_error, #description, #scheme_name

Instance Method Summary

• #call(request:) ⇒ Object
• #initialize(name:, **options) ⇒ APIKeyHeader constructor

  A new instance of APIKeyHeader.

• #openapi_scheme ⇒ Object

Methods inherited from Base

#fail_auth

Constructor Details

#initialize(name:, **options) ⇒ APIKeyHeader

Returns a new instance of APIKeyHeader.

# File 'lib/rubst_api/security.rb', line 50

def initialize(name:, **options) = (@name = name; super(**options))

Instance Method Details

#call(request:) ⇒ Object

# File 'lib/rubst_api/security.rb', line 51

def call(request:)
  request.headers[@name] || (auto_error ? fail_auth("Not authenticated") : nil)
end

#openapi_scheme ⇒ Object

# File 'lib/rubst_api/security.rb', line 54

def openapi_scheme = { type: "apiKey", in: "header", name: @name, description: description }.compact