Class: Swagger::Data::Headers

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-swagger/data/headers.rb

Overview

github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#headersObject

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

attr_swagger, #bulk_set, #swagger_attributes, #to_json, #to_swagger, #to_yaml

Constructor Details

#initialize ⇒ Headers

Returns a new instance of Headers.



6
7
8
 
# File 'lib/ruby-swagger/data/headers.rb', line 6

def initialize
  @headers = {}
end

Class Method Details

.parse(headers) ⇒ Object 



10
11
12
13
14
15
16
17
18
 
# File 'lib/ruby-swagger/data/headers.rb', line 10

def self.parse(headers)
  return nil unless headers

  h = Swagger::Data::Headers.new

  headers.each { |header_key, header_value| h.add_header(header_key, header_value) }

  h
end

Instance Method Details

#[](key) ⇒ Object 



31
32
33
 
# File 'lib/ruby-swagger/data/headers.rb', line 31

def [](key)
  @headers[key]
end

#add_header(header_key, header_value) ⇒ Object

Raises:

  • (ArgumentError) 


20
21
22
23
24
25
26
27
28
29
 
# File 'lib/ruby-swagger/data/headers.rb', line 20

def add_header(header_key, header_value)
  raise ArgumentError.new('Swagger::Data::Headers#add_header - parameter name is nil') unless header_key
  raise ArgumentError.new('Swagger::Data::Headers#add_header - parameter value is nil') unless header_value

  unless header_value.is_a?(Swagger::Data::Header)
    header_value = Swagger::Data::Header.parse(header_value)
  end

  @headers[header_key] = header_value
end

#as_swagger ⇒ Object 



35
36
37
38
39
40
41
42
43
 
# File 'lib/ruby-swagger/data/headers.rb', line 35

def as_swagger
  res = {}

  @headers.each do |key, value|
    res[key] = value.to_swagger
  end

  res
end