Class: Swagger::Data::SecurityDefinitions

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

Overview

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

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 ⇒ SecurityDefinitions

Returns a new instance of SecurityDefinitions.



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

def initialize
  @security = {}
end

Class Method Details

.parse(security) ⇒ Object 



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

def self.parse(security)
  return nil unless security

  params = Swagger::Data::SecurityDefinitions.new

  security.each do |pname, pvalue|
    params.add_param(pname, pvalue)
  end

  params
end

Instance Method Details

#[](pname) ⇒ Object 



33
34
35
 
# File 'lib/ruby-swagger/data/security_definitions.rb', line 33

def [](pname)
  @security[pname]
end

#add_param(pname, pvalue) ⇒ Object

Raises:

  • (ArgumentError) 


22
23
24
25
26
27
28
29
30
31
 
# File 'lib/ruby-swagger/data/security_definitions.rb', line 22

def add_param(pname, pvalue)
  raise ArgumentError.new('Swagger::Data::SecurityDefinitions#add_param - parameter name is nil') unless pname
  raise ArgumentError.new('Swagger::Data::SecurityDefinitions#add_param - parameter value is nil') unless pvalue

  unless pvalue.is_a?(Swagger::Data::SecurityScheme)
    pvalue = Swagger::Data::SecurityScheme.parse(pvalue)
  end

  @security[pname] = pvalue
end

#as_swagger ⇒ Object 



37
38
39
40
41
42
43
44
45
 
# File 'lib/ruby-swagger/data/security_definitions.rb', line 37

def as_swagger
  swagger_params = {}

  @security.each do |p_k, p_v|
    swagger_params[p_k] = p_v.to_swagger
  end

  swagger_params
end