Class: Comet::UserOnServer

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/user_on_server.rb

Overview

UserOnServer is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ UserOnServer

Returns a new instance of UserOnServer.



26
27
28
 
# File 'lib/comet/models/user_on_server.rb', line 26

def initialize
  clear
end

Instance Attribute Details

#server_id ⇒ Object

The server where this user was found. The 0-based indexes here correspond to the entries inside ConstellationRoleOptions->Servers.



18
19
20
 
# File 'lib/comet/models/user_on_server.rb', line 18

def server_id
  @server_id
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



24
25
26
 
# File 'lib/comet/models/user_on_server.rb', line 24

def unknown_json_fields
  @unknown_json_fields
end

#username ⇒ Object

Returns the value of attribute username.



21
22
23
 
# File 'lib/comet/models/user_on_server.rb', line 21

def username
  @username
end

Instance Method Details

#clear ⇒ Object 



30
31
32
33
34
 
# File 'lib/comet/models/user_on_server.rb', line 30

def clear
  @server_id = 0
  @username = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/comet/models/user_on_server.rb', line 44

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'ServerID'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @server_id = v
    when 'Username'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @username = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


37
38
39
40
41
 
# File 'lib/comet/models/user_on_server.rb', line 37

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



75
76
77
 
# File 'lib/comet/models/user_on_server.rb', line 75

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



64
65
66
67
68
69
70
71
72
 
# File 'lib/comet/models/user_on_server.rb', line 64

def to_hash
  ret = {}
  ret['ServerID'] = @server_id
  ret['Username'] = @username
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



80
81
82
 
# File 'lib/comet/models/user_on_server.rb', line 80

def to_json(options = {})
  to_hash.to_json(options)
end