Class: OnlinePayments::SDK::ResponseHeader

Inherits:
Object
  • Object
show all
Defined in:
lib/onlinepayments/sdk/response_header.rb

Overview

Represents HTTP response headers Each header is immutable has a #name and #value attribute

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, value) ⇒ ResponseHeader

Create a new header using the name and value given as parameters.

Raises:

  • (ArgumentError) 


11
12
13
14
15
 
# File 'lib/onlinepayments/sdk/response_header.rb', line 11

def initialize(name, value)
  raise ArgumentError, 'name is required' if name.nil? || name.strip.empty?
  @name = name
  @value = value
end

Instance Attribute Details

#name ⇒ String (readonly)

HTTP header name

Returns:

  • (String) —

    the current value of name



8
9
10
 
# File 'lib/onlinepayments/sdk/response_header.rb', line 8

def name
  @name
end

#value ⇒ String (readonly)

HTTP header value

Returns:

  • (String) —

    the current value of value



8
9
10
 
# File 'lib/onlinepayments/sdk/response_header.rb', line 8

def value
  @value
end

Class Method Details

.get_header(headers, header_name) ⇒ Object

Return the OnlinePayments::SDK::ResponseHeader that goes by the given header_name, If this Response does not contain a header with the given name, return nil instead



26
27
28
29
30
31
32
33
 
# File 'lib/onlinepayments/sdk/response_header.rb', line 26

def self.get_header(headers, header_name)
  selected_headers = headers.select { |h| h.name.casecmp(header_name) == 0 }
  if selected_headers.nil? || selected_headers.length == 0
    return nil
  else
    return selected_headers[0]
  end
end

.get_header_value(headers, header_name) ⇒ Object

Returns the header value of the header that goes by the given header_name, If this response does not contain a header with the given name, return nil instead



37
38
39
40
 
# File 'lib/onlinepayments/sdk/response_header.rb', line 37

def self.get_header_value(headers, header_name)
  header = get_header(headers, header_name)
  return header&.value
end

Instance Method Details

#to_s ⇒ Object 



20
21
22
 
# File 'lib/onlinepayments/sdk/response_header.rb', line 20

def to_s
  "#{name}:#{value}"
end