Class: Verizon::Message

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/message.rb

Overview

Message Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(is_private:, road_user_type:, trigger_conditions:, generic:, limits: SKIP, distribution_type: SKIP, distribution_schedule: SKIP, additional_properties: nil) ⇒ Message

Returns a new instance of Message.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/verizon/models/message.rb', line 79

def initialize(is_private:, road_user_type:, trigger_conditions:, generic:,
               limits: SKIP, distribution_type: SKIP,
               distribution_schedule: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @is_private = is_private
  @road_user_type = road_user_type
  @trigger_conditions = trigger_conditions
  @limits = limits unless limits == SKIP
  @distribution_type = distribution_type unless distribution_type == SKIP
  @distribution_schedule = distribution_schedule unless distribution_schedule == SKIP
  @generic = generic
  @additional_properties = additional_properties
end

Instance Attribute Details

#distribution_schedule ⇒ DistributionSchedule

The distribution schedule parameters for broadcast messages.

Returns:



42
43
44
 
# File 'lib/verizon/models/message.rb', line 42

def distribution_schedule
  @distribution_schedule
end

#distribution_type ⇒ Array[DistributionTypes]

Type of the distribution.

Returns:



38
39
40
 
# File 'lib/verizon/models/message.rb', line 38

def distribution_type
  @distribution_type
end

#generic ⇒ Generic

Custom message which is defined by the user and can support “any” message type or format. Note: ETX prefers the j2735 or the j2735_gr encoding and only vendor specific message types are allowed to be published in different message formats.

Returns:



50
51
52
 
# File 'lib/verizon/models/message.rb', line 50

def generic
  @generic
end

#is_private ⇒ TrueClass | FalseClass

Defines whether the message is private or public. Private messages are published under the Vendor ID defined in the configuration and only visible to devices of selected vendors. Public messages are published under the Public vendor and are visible to all the users.

Returns:

  • (TrueClass | FalseClass) 


18
19
20
 
# File 'lib/verizon/models/message.rb', line 18

def is_private
  @is_private
end

#limits ⇒ Array[Object]

List of limitations. These limitations can be used for making the trigger condition more precise by defining speed and motion direction requirements to be met before the messages are sent out.

Returns:

  • (Array[Object]) 


34
35
36
 
# File 'lib/verizon/models/message.rb', line 34

def limits
  @limits
end

#road_user_type ⇒ Array[RoadUserTypes]

Type of the Road User.

Returns:



22
23
24
 
# File 'lib/verizon/models/message.rb', line 22

def road_user_type
  @road_user_type
end

#trigger_conditions ⇒ Array[TriggerCondition]

Trigger conditions that define on which road user action the message will be sent. If multiple Trigger Conditions are defined any of them will trigger the message.

Returns:



28
29
30
 
# File 'lib/verizon/models/message.rb', line 28

def trigger_conditions
  @trigger_conditions
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
123
124
125
126
127
128
129
 
# File 'lib/verizon/models/message.rb', line 96

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  is_private = hash.key?('isPrivate') ? hash['isPrivate'] : nil
  road_user_type = hash.key?('roadUserType') ? hash['roadUserType'] : nil
  trigger_conditions =
    hash.key?('triggerConditions') ? hash['triggerConditions'] : nil
  generic = Generic.from_hash(hash['generic']) if hash['generic']
  limits = hash.key?('limits') ? APIHelper.deserialize_union_type(
    UnionTypeLookUp.get(:Limits), hash['limits']
  ) : SKIP
  distribution_type =
    hash.key?('distributionType') ? hash['distributionType'] : SKIP
  distribution_schedule = DistributionSchedule.from_hash(hash['distributionSchedule']) if
    hash['distributionSchedule']

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  Message.new(is_private: is_private,
              road_user_type: road_user_type,
              trigger_conditions: trigger_conditions,
              generic: generic,
              limits: limits,
              distribution_type: distribution_type,
              distribution_schedule: distribution_schedule,
              additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/verizon/models/message.rb', line 53

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['is_private'] = 'isPrivate'
  @_hash['road_user_type'] = 'roadUserType'
  @_hash['trigger_conditions'] = 'triggerConditions'
  @_hash['limits'] = 'limits'
  @_hash['distribution_type'] = 'distributionType'
  @_hash['distribution_schedule'] = 'distributionSchedule'
  @_hash['generic'] = 'generic'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



75
76
77
 
# File 'lib/verizon/models/message.rb', line 75

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



66
67
68
69
70
71
72
 
# File 'lib/verizon/models/message.rb', line 66

def self.optionals
  %w[
    limits
    distribution_type
    distribution_schedule
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (Message | Hash) —

    value against the validation is performed.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/verizon/models/message.rb', line 133

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.is_private,
                            ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
        APIHelper.valid_type?(value.road_user_type,
                              ->(val) { RoadUserTypes.validate(val) }) and
        APIHelper.valid_type?(value.trigger_conditions,
                              ->(val) { TriggerCondition.validate(val) }) and
        APIHelper.valid_type?(value.generic,
                              ->(val) { Generic.validate(val) },
                              is_model_hash: true)
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['isPrivate'],
                          ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
      APIHelper.valid_type?(value['roadUserType'],
                            ->(val) { RoadUserTypes.validate(val) }) and
      APIHelper.valid_type?(value['triggerConditions'],
                            ->(val) { TriggerCondition.validate(val) }) and
      APIHelper.valid_type?(value['generic'],
                            ->(val) { Generic.validate(val) },
                            is_model_hash: true)
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



173
174
175
176
177
178
179
180
 
# File 'lib/verizon/models/message.rb', line 173

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} is_private: #{@is_private.inspect}, road_user_type:"\
  " #{@road_user_type.inspect}, trigger_conditions: #{@trigger_conditions.inspect}, limits:"\
  " #{@limits.inspect}, distribution_type: #{@distribution_type.inspect},"\
  " distribution_schedule: #{@distribution_schedule.inspect}, generic: #{@generic.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



164
165
166
167
168
169
170
 
# File 'lib/verizon/models/message.rb', line 164

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} is_private: #{@is_private}, road_user_type: #{@road_user_type},"\
  " trigger_conditions: #{@trigger_conditions}, limits: #{@limits}, distribution_type:"\
  " #{@distribution_type}, distribution_schedule: #{@distribution_schedule}, generic:"\
  " #{@generic}, additional_properties: #{@additional_properties}>"
end