Class: Plivo::XML::MultiPartyCall

Inherits:
Element
  • Object
show all
Defined in:
lib/plivo/xml/multipartycall.rb

Constant Summary collapse

VALID_ROLE_VALUES = 
%w[agent supervisor customer]
VALID_METHOD_VALUES = 
%w[GET POST]
VALID_BOOL_VALUES = 
[true, false]
VALID_RECORD_FILE_FORMAT_VALUES = 
%w[mp3 wav]

Constants inherited from Element

Element::SSML_TAGS

Instance Attribute Summary

Attributes inherited from Element

#name, #node

Instance Method Summary collapse

Methods inherited from Element

#add, #add_attribute, #convert_value, #hyphenate, #method_missing, #to_s, #to_xml

Constructor Details

#initialize(body, attributes = {}) ⇒ MultiPartyCall

Returns a new instance of MultiPartyCall.

Raises:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
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
123
124
125
126
127
128
129
130
131
132
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/plivo/xml/multipartycall.rb', line 21

def initialize(body, attributes = {})
  if attributes[:role] && !VALID_ROLE_VALUES.include?(attributes[:role].downcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:role]} for role"
  elsif !attributes[:role]
    raise PlivoXMLError, "role not mentioned : possible values - Agent / Supervisor / Customer"
  end

  if attributes[:maxDuration] && (attributes[:maxDuration]<300 || attributes[:maxDuration]>28800)
    raise PlivoXMLError, "invalid attribute value #{attributes[:maxDuration]} for maxDuration"
  elsif !attributes[:maxDuration]
    attributes[:maxDuration] = 14400
  end

  if attributes[:maxParticipants] && (attributes[:maxParticipants]<2 || attributes[:maxParticipants]>10)
    raise PlivoXMLError, "invalid attribute value #{attributes[:maxParticipants]} for maxParticipants"
  elsif !attributes[:maxParticipants]
    attributes[:maxParticipants] = 10
  end

  if attributes[:waitMusicMethod] && !VALID_METHOD_VALUES.include?(attributes[:waitMusicMethod].upcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:waitMusicMethod]} for waitMusicMethod"
  elsif !attributes[:waitMusicMethod]
    attributes[:waitMusicMethod] = 'GET'
  end

  if attributes[:agentHoldMusicMethod] && !VALID_METHOD_VALUES.include?(attributes[:agentHoldMusicMethod].upcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:agentHoldMusicMethod]} for agentHoldMusicMethod"
  elsif !attributes[:agentHoldMusicMethod]
    attributes[:agentHoldMusicMethod] = 'GET'
  end

  if attributes[:customerHoldMusicMethod] && !VALID_METHOD_VALUES.include?(attributes[:customerHoldMusicMethod].upcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:customerHoldMusicMethod]} for customerHoldMusicMethod"
  elsif !attributes[:customerHoldMusicMethod]
    attributes[:customerHoldMusicMethod] = 'GET'
  end

  if attributes[:record] && !VALID_BOOL_VALUES.include?(attributes[:record])
    raise PlivoXMLError, "invalid attribute value #{attributes[:record]} for record"
  elsif !attributes[:record]
    attributes[:record] = false
  end

  if attributes[:recordFileFormat] && !VALID_RECORD_FILE_FORMAT_VALUES.include?(attributes[:recordFileFormat])
    raise PlivoXMLError, "invalid attribute value #{attributes[:recordFileFormat]} for recordFileFormat"
  elsif !attributes[:recordFileFormat]
    attributes[:recordFileFormat] = 'mp3'
  end

  if attributes[:recordingCallbackMethod] && !VALID_METHOD_VALUES.include?(attributes[:recordingCallbackMethod].upcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:recordingCallbackMethod]} for recordingCallbackMethod"
  elsif !attributes[:recordingCallbackMethod]
    attributes[:recordingCallbackMethod] = 'GET'
  end

  if attributes[:statusCallbackEvents] && !multi_valid_param?(:statusCallbackEvents, attributes[:statusCallbackEvents], String, false, %w[mpc-state-changes participant-state-changes participant-speak-events participant-digit-input-events add-participant-api-events], true, ',') == true
    raise PlivoXMLError, "invalid attribute value #{attributes[:statusCallbackEvents]} for statusCallbackEvents"
  elsif !attributes[:statusCallbackEvents]
    attributes[:statusCallbackEvents] = 'mpc-state-changes,participant-state-changes'
  end

  if attributes[:statusCallbackMethod] && !VALID_METHOD_VALUES.include?(attributes[:statusCallbackMethod].upcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:statusCallbackMethod]} for statusCallbackMethod"
  elsif !attributes[:statusCallbackMethod]
    attributes[:statusCallbackMethod] = 'POST'
  end

  if attributes[:stayAlone] && !VALID_BOOL_VALUES.include?(attributes[:stayAlone])
    raise PlivoXMLError, "invalid attribute value #{attributes[:stayAlone]} for stayAlone"
  elsif !attributes[:stayAlone]
    attributes[:stayAlone] = false
  end

  if attributes[:coachMode] && !VALID_BOOL_VALUES.include?(attributes[:coachMode])
    raise PlivoXMLError, "invalid attribute value #{attributes[:coachMode]} for coachMode"
  elsif !attributes[:coachMode]
    attributes[:coachMode] = true
  end

  if attributes[:mute] && !VALID_BOOL_VALUES.include?(attributes[:mute])
    raise PlivoXMLError, "invalid attribute value #{attributes[:mute]} for mute"
  elsif !attributes[:mute]
    attributes[:mute] = false
  end

  if attributes[:hold] && !VALID_BOOL_VALUES.include?(attributes[:hold])
    raise PlivoXMLError, "invalid attribute value #{attributes[:hold]} for hold"
  elsif !attributes[:hold]
    attributes[:hold] = false
  end

  if attributes[:startMpcOnEnter] && !VALID_BOOL_VALUES.include?(attributes[:startMpcOnEnter])
    raise PlivoXMLError, "invalid attribute value #{attributes[:startMpcOnEnter]} for startMpcOnEnter"
  elsif !attributes[:startMpcOnEnter]
    attributes[:startMpcOnEnter] = true
  end

  if attributes[:endMpcOnExit] && !VALID_BOOL_VALUES.include?(attributes[:endMpcOnExit])
    raise PlivoXMLError, "invalid attribute value #{attributes[:endMpcOnExit]} for endMpcOnExit"
  elsif !attributes[:endMpcOnExit]
    attributes[:endMpcOnExit] = false
  end

  if attributes[:enterSound] && !is_one_among_string_url?(:enterSound, attributes[:enterSound], false, %w[beep:1 beep:2 none])
    raise PlivoXMLError, "invalid attribute value #{attributes[:enterSound]} for enterSound"
  elsif !attributes[:enterSound]
    attributes[:enterSound] = 'beep:1'
  end

  if attributes[:enterSoundMethod] && !VALID_METHOD_VALUES.include?(attributes[:enterSoundMethod].upcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:enterSoundMethod]} for enterSoundMethod"
  elsif !attributes[:enterSoundMethod]
    attributes[:enterSoundMethod] = 'GET'
  end

  if attributes[:exitSound] && !is_one_among_string_url?(:exitSound, attributes[:exitSound], false, %w[beep:1 beep:2 none])
    raise PlivoXMLError, "invalid attribute value #{attributes[:exitSound]} for exitSound"
  elsif !attributes[:exitSound]
    attributes[:exitSound] = 'beep:2'
  end

  if attributes[:exitSoundMethod] && !VALID_METHOD_VALUES.include?(attributes[:exitSoundMethod].upcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:exitSoundMethod]} for exitSoundMethod"
  elsif !attributes[:exitSoundMethod]
    attributes[:exitSoundMethod] = 'GET'
  end

  if attributes[:onExitActionMethod] && !VALID_METHOD_VALUES.include?(attributes[:onExitActionMethod].upcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:onExitActionMethod]} for onExitActionMethod"
  elsif !attributes[:onExitActionMethod]
    attributes[:onExitActionMethod] = 'POST'
  end

  if attributes[:relayDTMFInputs] && !VALID_BOOL_VALUES.include?(attributes[:relayDTMFInputs])
    raise PlivoXMLError, "invalid attribute value #{attributes[:relayDTMFInputs]} for relayDTMFInputs"
  elsif !attributes[:relayDTMFInputs]
    attributes[:relayDTMFInputs] = false
  end

  if attributes[:waitMusicUrl] && !valid_url?(:waitMusicUrl, attributes[:waitMusicUrl], false)
    raise PlivoXMLError, "invalid attribute value #{attributes[:waitMusicUrl]} for waitMusicUrl"
  end

  if attributes[:agentHoldMusicUrl] && !valid_url?(:agentHoldMusicUrl, attributes[:agentHoldMusicUrl], false)
    raise PlivoXMLError, "invalid attribute value #{attributes[:agentHoldMusicUrl]} for agentHoldMusicUrl"
  end

  if attributes[:customerHoldMusicUrl] && !valid_url?(:customerHoldMusicUrl, attributes[:customerHoldMusicUrl], false)
    raise PlivoXMLError, "invalid attribute value #{attributes[:customerHoldMusicUrl]} for customerHoldMusicUrl"
  end

  if attributes[:recordingCallbackUrl] && !valid_url?(:recordingCallbackUrl, attributes[:recordingCallbackUrl], false)
    raise PlivoXMLError, "invalid attribute value #{attributes[:recordingCallbackUrl]} for recordingCallbackUrl"
  end

  if attributes[:statusCallbackUrl] && !valid_url?(:statusCallbackUrl, attributes[:statusCallbackUrl], false)
    raise PlivoXMLError, "invalid attribute value #{attributes[:statusCallbackUrl]} for statusCallbackUrl"
  end

  if attributes[:customerHoldMusicUrl] && !valid_url?(:customerHoldMusicUrl, attributes[:customerHoldMusicUrl], false)
    raise PlivoXMLError, "invalid attribute value #{attributes[:customerHoldMusicUrl]} for customerHoldMusicUrl"
  end

  if attributes[:startRecordingAudio] && !valid_url?(:startRecordingAudio, attributes[:startRecordingAudio], false)
    raise PlivoXMLError, "invalid attribute value #{attributes[:startRecordingAudio]} for startRecordingAudio"
  end

  if attributes[:stopRecordingAudio] && !valid_url?(:stopRecordingAudio, attributes[:stopRecordingAudio], false)
    raise PlivoXMLError, "invalid attribute value #{attributes[:stopRecordingAudio]} for stopRecordingAudio"
  end

  if attributes[:startRecordingAudioMethod] && !VALID_METHOD_VALUES.include?(attributes[:startRecordingAudioMethod].upcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:startRecordingAudioMethod]} for startRecordingAudioMethod"
  elsif !attributes[:startRecordingAudioMethod]
    attributes[:startRecordingAudioMethod] = 'GET'
  end

  if attributes[:stopRecordingAudioMethod] && !VALID_METHOD_VALUES.include?(attributes[:stopRecordingAudioMethod].upcase)
    raise PlivoXMLError, "invalid attribute value #{attributes[:stopRecordingAudioMethod]} for stopRecordingAudioMethod"
  elsif !attributes[:stopRecordingAudioMethod]
    attributes[:stopRecordingAudioMethod] = 'GET'
  end

  raise PlivoXMLError, 'No MPC name set for the MPC' unless body
  super(body, attributes)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Plivo::XML::Element