Class: DependencyTracker::LdapUser

Inherits:
Object
  • Object
show all
Defined in:
lib/dependency-tracker-client/models/ldap_user.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LdapUser

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 57

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DependencyTracker::LdapUser` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DependencyTracker::LdapUser`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'username')
    self.username = attributes[:'username']
  end

  if attributes.key?(:'dn')
    self.dn = attributes[:'dn']
  end

  if attributes.key?(:'teams')
    if (value = attributes[:'teams']).is_a?(Array)
      self.teams = value
    end
  end

  if attributes.key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.key?(:'permissions')
    if (value = attributes[:'permissions']).is_a?(Array)
      self.permissions = value
    end
  end
end

Instance Attribute Details

#dnObject

Returns the value of attribute dn.



19
20
21
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 19

def dn
  @dn
end

#emailObject

Returns the value of attribute email.



23
24
25
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 23

def email
  @email
end

#permissionsObject

Returns the value of attribute permissions.



25
26
27
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 25

def permissions
  @permissions
end

#teamsObject

Returns the value of attribute teams.



21
22
23
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 21

def teams
  @teams
end

#usernameObject

Returns the value of attribute username.



17
18
19
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 17

def username
  @username
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



28
29
30
31
32
33
34
35
36
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 28

def self.attribute_map
  {
    :'username' => :'username',
    :'dn' => :'dn',
    :'teams' => :'teams',
    :'email' => :'email',
    :'permissions' => :'permissions'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



240
241
242
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 240

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



50
51
52
53
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 50

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



39
40
41
42
43
44
45
46
47
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 39

def self.openapi_types
  {
    :'username' => :'String',
    :'dn' => :'String',
    :'teams' => :'Array<Team>',
    :'email' => :'String',
    :'permissions' => :'Array<Permission>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



215
216
217
218
219
220
221
222
223
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      username == o.username &&
      dn == o.dn &&
      teams == o.teams &&
      email == o.email &&
      permissions == o.permissions
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 268

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    DependencyTracker.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 337

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 247

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


227
228
229
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 227

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



233
234
235
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 233

def hash
  [username, dn, teams, email, permissions].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 97

def list_invalid_properties
  invalid_properties = Array.new
  if !@username.nil? && @username.to_s.length > 255
    invalid_properties.push('invalid value for "username", the character length must be smaller than or equal to 255.')
  end

  if !@username.nil? && @username.to_s.length < 1
    invalid_properties.push('invalid value for "username", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/[\P{Cc}]+/)
  if !@username.nil? && @username !~ pattern
    invalid_properties.push("invalid value for \"username\", must conform to the pattern #{pattern}.")
  end

  if !@dn.nil? && @dn.to_s.length > 255
    invalid_properties.push('invalid value for "dn", the character length must be smaller than or equal to 255.')
  end

  if !@dn.nil? && @dn.to_s.length < 1
    invalid_properties.push('invalid value for "dn", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/[\P{Cc}]+/)
  if !@dn.nil? && @dn !~ pattern
    invalid_properties.push("invalid value for \"dn\", must conform to the pattern #{pattern}.")
  end

  if !@email.nil? && @email.to_s.length > 255
    invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 255.')
  end

  if !@email.nil? && @email.to_s.length < 0
    invalid_properties.push('invalid value for "email", the character length must be great than or equal to 0.')
  end

  pattern = Regexp.new(/[\P{Cc}]+/)
  if !@email.nil? && @email !~ pattern
    invalid_properties.push("invalid value for \"email\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



313
314
315
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 313

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 319

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



307
308
309
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 307

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/dependency-tracker-client/models/ldap_user.rb', line 143

def valid?
  return false if !@username.nil? && @username.to_s.length > 255
  return false if !@username.nil? && @username.to_s.length < 1
  return false if !@username.nil? && @username !~ Regexp.new(/[\P{Cc}]+/)
  return false if !@dn.nil? && @dn.to_s.length > 255
  return false if !@dn.nil? && @dn.to_s.length < 1
  return false if !@dn.nil? && @dn !~ Regexp.new(/[\P{Cc}]+/)
  return false if !@email.nil? && @email.to_s.length > 255
  return false if !@email.nil? && @email.to_s.length < 0
  return false if !@email.nil? && @email !~ Regexp.new(/[\P{Cc}]+/)
  true
end