Class: RubstApi::Security::APIKeyQuery

Inherits:

Base

• Object
• Base
• RubstApi::Security::APIKeyQuery

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) ⇒ APIKeyQuery constructor

  A new instance of APIKeyQuery.

• #openapi_scheme ⇒ Object

Methods inherited from Base

#fail_auth

Constructor Details

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

Returns a new instance of APIKeyQuery.

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

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

Instance Method Details

#call(request:) ⇒ Object

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

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

#openapi_scheme ⇒ Object

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

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