Class: Comet::LiveUserConnection

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ LiveUserConnection

Returns a new instance of LiveUserConnection.



44
45
46
 
# File 'lib/comet/models/live_user_connection.rb', line 44

def initialize
  clear
end

Instance Attribute Details

#allows_filenames ⇒ Object

Returns the value of attribute allows_filenames.



39
40
41
 
# File 'lib/comet/models/live_user_connection.rb', line 39

def allows_filenames
  @allows_filenames
end

#connection_time ⇒ Object

Returns the value of attribute connection_time.



36
37
38
 
# File 'lib/comet/models/live_user_connection.rb', line 36

def connection_time
  @connection_time
end

#device_id ⇒ Object

Returns the value of attribute device_id.



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

def device_id
  @device_id
end

#ipaddress ⇒ Object

Returns the value of attribute ipaddress.



33
34
35
 
# File 'lib/comet/models/live_user_connection.rb', line 33

def ipaddress
  @ipaddress
end

#reported_platform ⇒ Object

Returns the value of attribute reported_platform.



27
28
29
 
# File 'lib/comet/models/live_user_connection.rb', line 27

def reported_platform
  @reported_platform
end

#reported_platform_version ⇒ Object

Returns the value of attribute reported_platform_version.



30
31
32
 
# File 'lib/comet/models/live_user_connection.rb', line 30

def reported_platform_version
  @reported_platform_version
end

#reported_version ⇒ Object

Returns the value of attribute reported_version.



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

def reported_version
  @reported_version
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



42
43
44
 
# File 'lib/comet/models/live_user_connection.rb', line 42

def unknown_json_fields
  @unknown_json_fields
end

#username ⇒ Object

Returns the value of attribute username.



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

def username
  @username
end

Instance Method Details

#clear ⇒ Object 



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/comet/models/live_user_connection.rb', line 48

def clear
  @username = ''
  @device_id = ''
  @reported_version = ''
  @reported_platform = ''
  @reported_platform_version = Comet::OSInfo.new
  @ipaddress = ''
  @connection_time = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash



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
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/comet/models/live_user_connection.rb', line 67

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 'Username'
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

      @reported_platform = v
    when 'ReportedPlatformVersion'
      @reported_platform_version = Comet::OSInfo.new
      @reported_platform_version.from_hash(v)
    when 'IPAddress'
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

      @ipaddress = v
    when 'ConnectionTime'
      raise TypeError "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @connection_time = v
    when 'AllowsFilenames'
      @allows_filenames = 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



60
61
62
63
64
 
# File 'lib/comet/models/live_user_connection.rb', line 60

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



129
130
131
 
# File 'lib/comet/models/live_user_connection.rb', line 129

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/comet/models/live_user_connection.rb', line 108

def to_hash
  ret = {}
  ret['Username'] = @username
  ret['DeviceID'] = @device_id
  ret['ReportedVersion'] = @reported_version
  ret['ReportedPlatform'] = @reported_platform
  unless @reported_platform_version.nil?
    ret['ReportedPlatformVersion'] = @reported_platform_version
  end
  unless @ipaddress.nil?
    ret['IPAddress'] = @ipaddress
  end
  ret['ConnectionTime'] = @connection_time
  ret['AllowsFilenames'] = @allows_filenames
  @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



134
135
136
 
# File 'lib/comet/models/live_user_connection.rb', line 134

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