Class: Zyphr::PasswordPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/zyphr/models/password_policy.rb

Overview

Structured password policy rules for the application. Use these fields to drive a live, client-side requirements checklist (e.g. a green/grey indicator per rule) before submitting a registration or reset.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PasswordPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
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/zyphr/models/password_policy.rb', line 84

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

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

  if attributes.key?(:'min_length')
    self.min_length = attributes[:'min_length']
  else
    self.min_length = nil
  end

  if attributes.key?(:'max_length')
    self.max_length = attributes[:'max_length']
  else
    self.max_length = nil
  end

  if attributes.key?(:'require_uppercase')
    self.require_uppercase = attributes[:'require_uppercase']
  else
    self.require_uppercase = nil
  end

  if attributes.key?(:'require_lowercase')
    self.require_lowercase = attributes[:'require_lowercase']
  else
    self.require_lowercase = nil
  end

  if attributes.key?(:'require_numbers')
    self.require_numbers = attributes[:'require_numbers']
  else
    self.require_numbers = nil
  end

  if attributes.key?(:'require_special')
    self.require_special = attributes[:'require_special']
  else
    self.require_special = nil
  end

  if attributes.key?(:'disallow_common')
    self.disallow_common = attributes[:'disallow_common']
  else
    self.disallow_common = nil
  end
end

Instance Attribute Details

#disallow_common ⇒ Object

Whether commonly used passwords are rejected.



38
39
40
 
# File 'lib/zyphr/models/password_policy.rb', line 38

def disallow_common
  @disallow_common
end

#max_length ⇒ Object

Maximum password length.



23
24
25
 
# File 'lib/zyphr/models/password_policy.rb', line 23

def max_length
  @max_length
end

#min_length ⇒ Object

Minimum password length.



20
21
22
 
# File 'lib/zyphr/models/password_policy.rb', line 20

def min_length
  @min_length
end

#require_lowercase ⇒ Object

Whether at least one lowercase letter (a-z) is required.



29
30
31
 
# File 'lib/zyphr/models/password_policy.rb', line 29

def require_lowercase
  @require_lowercase
end

#require_numbers ⇒ Object

Whether at least one number (0-9) is required.



32
33
34
 
# File 'lib/zyphr/models/password_policy.rb', line 32

def require_numbers
  @require_numbers
end

#require_special ⇒ Object

Whether at least one special character is required.



35
36
37
 
# File 'lib/zyphr/models/password_policy.rb', line 35

def require_special
  @require_special
end

#require_uppercase ⇒ Object

Whether at least one uppercase letter (A-Z) is required.



26
27
28
 
# File 'lib/zyphr/models/password_policy.rb', line 26

def require_uppercase
  @require_uppercase
end

Class Method Details

._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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/zyphr/models/password_policy.rb', line 314

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Zyphr.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



54
55
56
 
# File 'lib/zyphr/models/password_policy.rb', line 54

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/zyphr/models/password_policy.rb', line 59

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/zyphr/models/password_policy.rb', line 41

def self.attribute_map
  {
    :'min_length' => :'min_length',
    :'max_length' => :'max_length',
    :'require_uppercase' => :'require_uppercase',
    :'require_lowercase' => :'require_lowercase',
    :'require_numbers' => :'require_numbers',
    :'require_special' => :'require_special',
    :'disallow_common' => :'disallow_common'
  }
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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/zyphr/models/password_policy.rb', line 290

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/zyphr/models/password_policy.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/zyphr/models/password_policy.rb', line 64

def self.openapi_types
  {
    :'min_length' => :'Integer',
    :'max_length' => :'Integer',
    :'require_uppercase' => :'Boolean',
    :'require_lowercase' => :'Boolean',
    :'require_numbers' => :'Boolean',
    :'require_special' => :'Boolean',
    :'disallow_common' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/zyphr/models/password_policy.rb', line 263

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      min_length == o.min_length &&
      max_length == o.max_length &&
      require_uppercase == o.require_uppercase &&
      require_lowercase == o.require_lowercase &&
      require_numbers == o.require_numbers &&
      require_special == o.require_special &&
      disallow_common == o.disallow_common
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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/zyphr/models/password_policy.rb', line 385

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


277
278
279
 
# File 'lib/zyphr/models/password_policy.rb', line 277

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



283
284
285
 
# File 'lib/zyphr/models/password_policy.rb', line 283

def hash
  [min_length, max_length, require_uppercase, require_lowercase, require_numbers, require_special, disallow_common].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/zyphr/models/password_policy.rb', line 143

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @min_length.nil?
    invalid_properties.push('invalid value for "min_length", min_length cannot be nil.')
  end

  if @max_length.nil?
    invalid_properties.push('invalid value for "max_length", max_length cannot be nil.')
  end

  if @require_uppercase.nil?
    invalid_properties.push('invalid value for "require_uppercase", require_uppercase cannot be nil.')
  end

  if @require_lowercase.nil?
    invalid_properties.push('invalid value for "require_lowercase", require_lowercase cannot be nil.')
  end

  if @require_numbers.nil?
    invalid_properties.push('invalid value for "require_numbers", require_numbers cannot be nil.')
  end

  if @require_special.nil?
    invalid_properties.push('invalid value for "require_special", require_special cannot be nil.')
  end

  if @disallow_common.nil?
    invalid_properties.push('invalid value for "disallow_common", disallow_common cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



361
362
363
 
# File 'lib/zyphr/models/password_policy.rb', line 361

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/zyphr/models/password_policy.rb', line 367

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



355
356
357
 
# File 'lib/zyphr/models/password_policy.rb', line 355

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



179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/zyphr/models/password_policy.rb', line 179

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @min_length.nil?
  return false if @max_length.nil?
  return false if @require_uppercase.nil?
  return false if @require_lowercase.nil?
  return false if @require_numbers.nil?
  return false if @require_special.nil?
  return false if @disallow_common.nil?
  true
end