Class: Comet::StreamableEvent

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ StreamableEvent

Returns a new instance of StreamableEvent.



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

def initialize
  clear
end

Instance Attribute Details

#actor ⇒ Object

Returns the value of attribute actor.



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

def actor
  @actor
end

#data ⇒ Object

Returns the value of attribute data.



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

def data
  @data
end

#owner_organization_id ⇒ Object

Returns the value of attribute owner_organization_id.



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

def owner_organization_id
  @owner_organization_id
end

#resource_id ⇒ Object

Returns the value of attribute resource_id.



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

def resource_id
  @resource_id
end

#timestamp ⇒ Object

Returns the value of attribute timestamp.



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

def timestamp
  @timestamp
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#type_string ⇒ Object

Returns the value of attribute type_string.



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

def type_string
  @type_string
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



37
38
39
 
# File 'lib/comet/models/streamable_event.rb', line 37

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/comet/models/streamable_event.rb', line 43

def clear
  @actor = ''
  @owner_organization_id = ''
  @resource_id = ''
  @type = 0
  @timestamp = 0
  @type_string = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


61
62
63
64
65
66
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
 
# File 'lib/comet/models/streamable_event.rb', line 61

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

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

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

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

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

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

      @type_string = v
    when 'Data'
      @data = 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) 


54
55
56
57
58
 
# File 'lib/comet/models/streamable_event.rb', line 54

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



123
124
125
 
# File 'lib/comet/models/streamable_event.rb', line 123

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/comet/models/streamable_event.rb', line 99

def to_hash
  ret = {}
  ret['Actor'] = @actor
  ret['OwnerOrganizationID'] = @owner_organization_id
  unless @resource_id.nil?
    ret['ResourceID'] = @resource_id
  end
  ret['Type'] = @type
  unless @timestamp.nil?
    ret['Timestamp'] = @timestamp
  end
  unless @type_string.nil?
    ret['TypeString'] = @type_string
  end
  unless @data.nil?
    ret['Data'] = @data
  end
  @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



128
129
130
 
# File 'lib/comet/models/streamable_event.rb', line 128

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