Class: RestEasy::Auth::PSK

Inherits:
Object
  • Object
show all
Defined in:
lib/rest_easy/auth/psk.rb

Overview

Pre-shared key (API key) authentication. Applies a static key as a request header.

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, header_name: "Authorization", header_prefix: "Bearer") ⇒ PSK

Returns a new instance of PSK.



8
9
10
11
12
 
# File 'lib/rest_easy/auth/psk.rb', line 8

def initialize(api_key:, header_name: "Authorization", header_prefix: "Bearer")
  @api_key = api_key
  @header_name = header_name
  @header_prefix = header_prefix
end

Instance Method Details

#apply(request) ⇒ Object 



14
15
16
 
# File 'lib/rest_easy/auth/psk.rb', line 14

def apply(request)
  request.headers[@header_name] = "#{@header_prefix} #{@api_key}"
end

#on_rejected(response) ⇒ Object

Raises:



18
19
20
 
# File 'lib/rest_easy/auth/psk.rb', line 18

def on_rejected(response)
  raise RestEasy::RequestError.new(response)
end