Class: Forgejo::User

Inherits:
Object
  • Object
show all
Defined in:
lib/forgejo/models/user.rb

Overview

User represents a user

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

Initializes the object

Parameters:

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

    Model attributes in the form of hash



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/forgejo/models/user.rb', line 159

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Forgejo::User` 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 `Forgejo::User`. 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?(:'active')
    self.active = attributes[:'active']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'login_name')
    self. = attributes[:'login_name']
  else
    self. = 'empty'
  end

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Is user active



20
21
22
 
# File 'lib/forgejo/models/user.rb', line 20

def active
  @active
end

#avatar_url ⇒ Object

URL to the user’s avatar



23
24
25
 
# File 'lib/forgejo/models/user.rb', line 23

def avatar_url
  @avatar_url
end

#created ⇒ Object

Returns the value of attribute created.



25
26
27
 
# File 'lib/forgejo/models/user.rb', line 25

def created
  @created
end

#description ⇒ Object

the user’s description



28
29
30
 
# File 'lib/forgejo/models/user.rb', line 28

def description
  @description
end

#email ⇒ Object

Returns the value of attribute email.



30
31
32
 
# File 'lib/forgejo/models/user.rb', line 30

def email
  @email
end

#followers_count ⇒ Object

user counts



33
34
35
 
# File 'lib/forgejo/models/user.rb', line 33

def followers_count
  @followers_count
end

#following_count ⇒ Object

Returns the value of attribute following_count.



35
36
37
 
# File 'lib/forgejo/models/user.rb', line 35

def following_count
  @following_count
end

#full_name ⇒ Object

the user’s full name



38
39
40
 
# File 'lib/forgejo/models/user.rb', line 38

def full_name
  @full_name
end

#html_url ⇒ Object

URL to the user’s gitea page



41
42
43
 
# File 'lib/forgejo/models/user.rb', line 41

def html_url
  @html_url
end

#id ⇒ Object

the user’s id



44
45
46
 
# File 'lib/forgejo/models/user.rb', line 44

def id
  @id
end

#is_admin ⇒ Object

Is the user an administrator



47
48
49
 
# File 'lib/forgejo/models/user.rb', line 47

def is_admin
  @is_admin
end

#language ⇒ Object

User locale



50
51
52
 
# File 'lib/forgejo/models/user.rb', line 50

def language
  @language
end

#last_login ⇒ Object

Returns the value of attribute last_login.



52
53
54
 
# File 'lib/forgejo/models/user.rb', line 52

def 
  
end

#location ⇒ Object

the user’s location



55
56
57
 
# File 'lib/forgejo/models/user.rb', line 55

def location
  @location
end

#login ⇒ Object

the user’s username



58
59
60
 
# File 'lib/forgejo/models/user.rb', line 58

def 
  @login
end

#login_name ⇒ Object

the user’s authentication sign-in name.



61
62
63
 
# File 'lib/forgejo/models/user.rb', line 61

def 
  @login_name
end

#prohibit_login ⇒ Object

Is user login prohibited



64
65
66
 
# File 'lib/forgejo/models/user.rb', line 64

def 
  
end

#pronouns ⇒ Object

the user’s pronouns



67
68
69
 
# File 'lib/forgejo/models/user.rb', line 67

def pronouns
  @pronouns
end

#restricted ⇒ Object

Is user restricted



70
71
72
 
# File 'lib/forgejo/models/user.rb', line 70

def restricted
  @restricted
end

#source_id ⇒ Object

The ID of the user’s Authentication Source



73
74
75
 
# File 'lib/forgejo/models/user.rb', line 73

def source_id
  @source_id
end

#starred_repos_count ⇒ Object

Returns the value of attribute starred_repos_count.



75
76
77
 
# File 'lib/forgejo/models/user.rb', line 75

def starred_repos_count
  @starred_repos_count
end

#visibility ⇒ Object

User visibility level option: public, limited, private



78
79
80
 
# File 'lib/forgejo/models/user.rb', line 78

def visibility
  @visibility
end

#website ⇒ Object

the user’s website



81
82
83
 
# File 'lib/forgejo/models/user.rb', line 81

def website
  @website
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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/forgejo/models/user.rb', line 352

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 = Forgejo.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



113
114
115
 
# File 'lib/forgejo/models/user.rb', line 113

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



118
119
120
 
# File 'lib/forgejo/models/user.rb', line 118

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/forgejo/models/user.rb', line 84

def self.attribute_map
  {
    :'active' => :'active',
    :'avatar_url' => :'avatar_url',
    :'created' => :'created',
    :'description' => :'description',
    :'email' => :'email',
    :'followers_count' => :'followers_count',
    :'following_count' => :'following_count',
    :'full_name' => :'full_name',
    :'html_url' => :'html_url',
    :'id' => :'id',
    :'is_admin' => :'is_admin',
    :'language' => :'language',
    :'last_login' => :'last_login',
    :'location' => :'location',
    :'login' => :'login',
    :'login_name' => :'login_name',
    :'prohibit_login' => :'prohibit_login',
    :'pronouns' => :'pronouns',
    :'restricted' => :'restricted',
    :'source_id' => :'source_id',
    :'starred_repos_count' => :'starred_repos_count',
    :'visibility' => :'visibility',
    :'website' => :'website'
  }
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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/forgejo/models/user.rb', line 328

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



152
153
154
155
 
# File 'lib/forgejo/models/user.rb', line 152

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

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/forgejo/models/user.rb', line 123

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'avatar_url' => :'String',
    :'created' => :'Time',
    :'description' => :'String',
    :'email' => :'String',
    :'followers_count' => :'Integer',
    :'following_count' => :'Integer',
    :'full_name' => :'String',
    :'html_url' => :'String',
    :'id' => :'Integer',
    :'is_admin' => :'Boolean',
    :'language' => :'String',
    :'last_login' => :'Time',
    :'location' => :'String',
    :'login' => :'String',
    :'login_name' => :'String',
    :'prohibit_login' => :'Boolean',
    :'pronouns' => :'String',
    :'restricted' => :'Boolean',
    :'source_id' => :'Integer',
    :'starred_repos_count' => :'Integer',
    :'visibility' => :'String',
    :'website' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/forgejo/models/user.rb', line 285

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      avatar_url == o.avatar_url &&
      created == o.created &&
      description == o.description &&
      email == o.email &&
      followers_count == o.followers_count &&
      following_count == o.following_count &&
      full_name == o.full_name &&
      html_url == o.html_url &&
      id == o.id &&
      is_admin == o.is_admin &&
      language == o.language &&
       == o. &&
      location == o.location &&
       == o. &&
       == o. &&
       == o. &&
      pronouns == o.pronouns &&
      restricted == o.restricted &&
      source_id == o.source_id &&
      starred_repos_count == o.starred_repos_count &&
      visibility == o.visibility &&
      website == o.website
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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/forgejo/models/user.rb', line 423

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


315
316
317
 
# File 'lib/forgejo/models/user.rb', line 315

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



321
322
323
 
# File 'lib/forgejo/models/user.rb', line 321

def hash
  [active, avatar_url, created, description, email, followers_count, following_count, full_name, html_url, id, is_admin, language, , location, , , , pronouns, restricted, source_id, starred_repos_count, visibility, website].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



270
271
272
273
274
 
# File 'lib/forgejo/models/user.rb', line 270

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



399
400
401
 
# File 'lib/forgejo/models/user.rb', line 399

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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/forgejo/models/user.rb', line 405

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



393
394
395
 
# File 'lib/forgejo/models/user.rb', line 393

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



278
279
280
281
 
# File 'lib/forgejo/models/user.rb', line 278

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end