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.



56
57
58
 
# File 'lib/comet/models/live_user_connection.rb', line 56

def initialize
  clear
end

Instance Attribute Details

#allows_filenames ⇒ Object

The current state of the “Allow administrator to view my files” client-side option. If this option is refused, some live-connected actions will be refused by the device.



51
52
53
 
# File 'lib/comet/models/live_user_connection.rb', line 51

def allows_filenames
  @allows_filenames
end

#connection_time ⇒ Object

Unix timestamp, in seconds.



46
47
48
 
# File 'lib/comet/models/live_user_connection.rb', line 46

def connection_time
  @connection_time
end

#device_id ⇒ Object

Returns the value of attribute device_id.



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

def device_id
  @device_id
end

#device_time_zone ⇒ Object

The reported timezone of the device, in IANA format.



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

def device_time_zone
  @device_time_zone
end

#ipaddress ⇒ Object

The live-connected device’s remote IP address, as seen from the Comet Server.



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

def ipaddress
  @ipaddress
end

#reported_platform ⇒ Object

The operating system of the device. It is one of the PLATFORM_ constants; then a forwardslash (/); then the device’s GOARCH.



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

def reported_platform
  @reported_platform
end

#reported_platform_version ⇒ Object

The operating system of the device, in extended detail.



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

def reported_platform_version
  @reported_platform_version
end

#reported_version ⇒ Object

The Comet Backup software version that this live-connected device reports that it is running. It takes the format “MAJOR.MINOR.PATCH”, such as “23.2.0”. See the APPLICATION_VERSION constant for more information.



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

def reported_version
  @reported_version
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



54
55
56
 
# File 'lib/comet/models/live_user_connection.rb', line 54

def unknown_json_fields
  @unknown_json_fields
end

#username ⇒ Object

Returns the value of attribute username.



16
17
18
 
# File 'lib/comet/models/live_user_connection.rb', line 16

def username
  @username
end

Instance Method Details

#clear ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/comet/models/live_user_connection.rb', line 60

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

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/comet/models/live_user_connection.rb', line 80

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

      @device_time_zone = 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

Raises:

  • (TypeError) 


73
74
75
76
77
 
# File 'lib/comet/models/live_user_connection.rb', line 73

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



149
150
151
 
# File 'lib/comet/models/live_user_connection.rb', line 149

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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/comet/models/live_user_connection.rb', line 125

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 @device_time_zone.nil?
    ret['DeviceTimeZone'] = @device_time_zone
  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



154
155
156
 
# File 'lib/comet/models/live_user_connection.rb', line 154

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