Class: Comet::StatResult

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ StatResult

Returns a new instance of StatResult.



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

def initialize
  clear
end

Instance Attribute Details

#boosters ⇒ Object

Returns the value of attribute boosters.



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

def boosters
  @boosters
end

#buckets ⇒ Object

Returns the value of attribute buckets.



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

def buckets
  @buckets
end

#devices ⇒ Object

Returns the value of attribute devices.



22
23
24
 
# File 'lib/comet/models/stat_result.rb', line 22

def devices
  @devices
end

#network_devices ⇒ Object

Returns the value of attribute network_devices.



28
29
30
 
# File 'lib/comet/models/stat_result.rb', line 28

def network_devices
  @network_devices
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



31
32
33
 
# File 'lib/comet/models/stat_result.rb', line 31

def unknown_json_fields
  @unknown_json_fields
end

#users ⇒ Object

Returns the value of attribute users.



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

def users
  @users
end

Instance Method Details

#clear ⇒ Object 



37
38
39
40
41
42
43
44
 
# File 'lib/comet/models/stat_result.rb', line 37

def clear
  @buckets = 0
  @users = 0
  @devices = 0
  @boosters = 0
  @network_devices = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/comet/models/stat_result.rb', line 54

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

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

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

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

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

      @network_devices = 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) 


47
48
49
50
51
 
# File 'lib/comet/models/stat_result.rb', line 47

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



100
101
102
 
# File 'lib/comet/models/stat_result.rb', line 100

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



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/comet/models/stat_result.rb', line 86

def to_hash
  ret = {}
  ret['Buckets'] = @buckets
  ret['Users'] = @users
  ret['Devices'] = @devices
  ret['Boosters'] = @boosters
  ret['NetworkDevices'] = @network_devices
  @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



105
106
107
 
# File 'lib/comet/models/stat_result.rb', line 105

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