plivo 4.17.1 → 4.21.0

data/lib/plivo/utils.rb

@@ -67,6 +67,117 @@ module Plivo
       expected_value?(param_name, expected_values, param_value)
     end
 
+    def valid_multiple_destination_nos?(param_name, param_value, options = nil)
+      if param_value.split(options[:delimiter]).size > 1 && options[:role].downcase != 'agent'
+        raise_invalid_request("Multiple #{param_name} values given for role #{options[:role]}")
+      elsif param_value.split(options[:delimiter]).size >= options[:agent_limit]
+        raise_invalid_request("No of #{param_name} values provided should be lesser than #{options[:agent_limit]}")
+      else
+        return true
+      end
+    end
+
+    def valid_multiple_destination_integers?(param_name, param_value)
+      if (param_value.is_a? String)
+        values = param_value.split("<")
+        for i in values
+          unless (Integer(i) rescue false)
+            raise_invalid_request("#{param_name} Destination Value must be integer")
+          end
+        end
+      end
+    end
+    
+    def valid_url?(param_name, param_value, mandatory = false)
+      if mandatory && param_value.nil?
+        raise_invalid_request("#{param_name} is a required parameter")
+      end
+
+      return true if param_value.nil?
+      return raise_invalid_request("#{param_name}: Expected a String but received #{param_value.class} instead") unless expected_type?(param_name, String, param_value)
+
+      if param_value =~ /^(http[s]?:\/\/([a-zA-Z]|[0-9]|[\$\-\_\@\.\&\+\/\#]|[\!\*\(\)\,]|(%[0-9a-fA-F][0-9a-fA-F]))+|nil)$/ix
+        return true
+      else
+        return raise_invalid_request("Invalid URL : Doesn't satisfy the URL format")
+      end
+    end
+
+    def valid_range?(param_name, param_value, mandatory = false, lower_bound = nil, upper_bound = nil)
+      if mandatory && param_value.nil?
+        raise_invalid_request("#{param_name} is a required parameter")
+      end
+
+      return true if param_value.nil?
+
+      return raise_invalid_request("#{param_name}: Expected an Integer but received #{param_value.class} instead") unless expected_type?(param_name, Integer, param_value)
+      if lower_bound && upper_bound
+        return raise_invalid_request("#{param_name} ranges between #{lower_bound} and #{upper_bound}") if param_value < lower_bound or param_value > upper_bound
+
+        return true if param_value >= lower_bound and param_value <= upper_bound
+      elsif lower_bound
+        return raise_invalid_request("#{param_name} should be greater than #{lower_bound}") if param_value < lower_bound
+
+        return true if param_value >= lower_bound
+      elsif upper_bound
+        return raise_invalid_request("#{param_name} should be lesser than #{upper_bound}") if param_value > upper_bound
+
+        return true if param_value <= upper_bound
+      else
+        return raise_invalid_request("Any one or both of lower and upper bound should be provided")
+      end
+    end
+
+    def multi_valid_param?(param_name, param_value, expected_types = nil, mandatory = false, expected_values = nil, make_down_case = false, seperator = ',')
+      if mandatory && param_value.nil?
+        raise_invalid_request("#{param_name} is a required parameter")
+      end
+
+      return true if param_value.nil?
+
+      if make_down_case
+        param_value = param_value.downcase
+      else
+        param_value = param_value.uppercase
+      end
+
+      for val in param_value.split(seperator)
+        return expected_type?(param_name, expected_types, val.strip) unless expected_values
+        expected_value?(param_name, expected_values, val.strip)
+      end
+    end
+
+    def valid_date_format?(param_name, param_value, mandatory = false)
+      if mandatory && param_value.nil?
+        raise_invalid_request("#{param_name} is a required parameter")
+      end
+
+      return true if param_value.nil?
+
+      if param_value =~ /^(\d{4}\-\d{2}\-\d{2}\ \d{2}\:\d{2}(\:\d{2}(\.\d{1,6})?)?)$/ix
+        return true
+      else
+        return raise_invalid_request("Invalid Date Format")
+      end
+    end
+
+    def is_one_among_string_url?(param_name, param_value, mandatory = false, expected_values= nil)
+      if mandatory && param_value.nil?
+        raise_invalid_request("#{param_name} is a required parameter")
+      end
+
+      return true if param_value.nil?
+      return raise_invalid_request("#{param_name}: Expected a String but received #{param_value.class} instead") unless expected_type?(param_name, String, param_value)
+
+      if expected_values.include? param_value.downcase or expected_values.include? param_value.upcase
+        return true
+      elsif valid_url?(param_name, param_value)
+        return true
+      else
+        raise_invalid_request("#{param_name} neither a valid URL nor in the expected values")
+      end
+    end
+
     def expected_type?(param_name, expected_types, param_value)
       return true if expected_types.nil?
       param_value_class = param_value.class

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.17.1".freeze
+  VERSION = "4.21.0".freeze
 end

data/lib/plivo/xml/cont.rb

@@ -0,0 +1,13 @@
+module Plivo
+    module XML
+      class Cont < Element
+        @nestables = []
+        @valid_attributes = []
+  
+        def initialize(body)
+          super(body)
+        end
+      end
+    end
+  end
+  

data/lib/plivo/xml/element.rb

@@ -80,8 +80,15 @@ module Plivo
       def add(element)
         raise PlivoXMLError, 'invalid element' unless element
         if @nestables.include?(element.name)
-          @node.elements << element.node
-          element
+          if element.name == "Cont"
+            @node.elements << element.node 
+            element
+            temp = REXML::Text.new element.node.text
+            @node.elements['Cont'] = temp
+          else
+            @node.elements << element.node 
+            element
+          end
         else
           raise PlivoXMLError, "#{element.name} not nestable in #{@name}"
         end

data/lib/plivo/xml/emphasis.rb

@@ -1,7 +1,7 @@
 module Plivo
   module XML
     class Emphasis < Element
-      @nestables = %w(Break Emphasis Lang Phoneme Prosody SayAs Sub W)
+      @nestables = %w(Break Cont Emphasis Lang Phoneme Prosody SayAs Sub W)
       @valid_attributes = %w(level)
 
       VALID_LEVEL_ATTRIBUTE_VALUE=%w(strong moderate reduced)

data/lib/plivo/xml/lang.rb

@@ -1,7 +1,7 @@
 module Plivo
   module XML
     class Lang < Element
-      @nestables = %w(Break Emphasis Lang P Phoneme Prosody S SayAs Sub W)
+      @nestables = %w(Break Cont Emphasis Lang P Phoneme Prosody S SayAs Sub W)
       @valid_attributes = %w(xmllang)
 
        VALID_LANG_ATTRIBUTE_VALUES = [

data/lib/plivo/xml/multipartycall.rb

@@ -0,0 +1,188 @@
+module Plivo
+  module XML
+    class MultiPartyCall < Element
+      @nestables = []
+      @valid_attributes = %w[role maxDuration maxParticipants waitMusicUrl
+                             waitMusicMethod agentHoldMusicUrl agentHoldMusicMethod
+                             customerHoldMusicUrl customerHoldMusicMethod record
+                             recordFileFormat recordingCallbackUrl recordingCallbackMethod
+                             statusCallbackEvents statusCallbackUrl statusCallbackMethod
+                             stayAlone coachMode mute hold startMpcOnEnter endMpcOnExit
+                             enterSound enterSoundMethod exitSound exitSoundMethod
+                             onExitActionUrl onExitActionMethod relayDTMFInputs]
+
+      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]
+
+      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
+
+        raise PlivoXMLError, 'No MPC name set for the MPC' unless body
+        super(body, attributes)
+      end
+
+    end
+  end
+end

data/lib/plivo/xml/p.rb

@@ -1,7 +1,7 @@
 module Plivo
   module XML
     class P < Element
-      @nestables = %w(Break Emphasis Lang Phoneme Prosody SayAs Sub S W)
+      @nestables = %w(Break Cont Emphasis Lang Phoneme Prosody SayAs Sub S W)
       @valid_attributes = []
 
       def initialize(body)

data/lib/plivo/xml/prosody.rb

@@ -1,7 +1,7 @@
 module Plivo
   module XML
     class Prosody < Element
-      @nestables = %w(Break Emphasis Lang P Phoneme Prosody S SayAs Sub W)
+      @nestables = %w(Break Cont Emphasis Lang P Phoneme Prosody S SayAs Sub W)
       @valid_attributes = %w(volume rate pitch)
 
       VALID_VOLUME_ATTRIBUTE_VALUES=%w(default silent x-soft soft medium loud x-loud)

data/lib/plivo/xml/response.rb

@@ -2,7 +2,7 @@ module Plivo
   module XML
     class Response < Element
       @nestables = %w[Speak Play GetDigits GetInput Record Dial Message
-                      Redirect Wait Hangup PreAnswer Conference DTMF]
+                      Redirect Wait Hangup PreAnswer Conference DTMF MultiPartyCall]
       @valid_attributes = []
 
       def initialize

data/lib/plivo/xml/s.rb

@@ -1,7 +1,7 @@
 module Plivo
   module XML
     class S < Element
-      @nestables = %w(Break Emphasis Lang Phoneme Prosody SayAs Sub W)
+      @nestables = %w(Break Cont Emphasis Lang Phoneme Prosody SayAs Sub W)
       @valid_attributes = []
 
       def initialize(body)

data/lib/plivo/xml/speak.rb

@@ -13,7 +13,7 @@ module Plivo
           engine = attributes[:voice].split('.')[0]
           voice = attributes[:voice].split('.')[1]
           if SUPPORTED_ENGINES.include?(engine) && SUPPORTED_VOICES.include?(voice)
-            @nestables = %w(Break Emphasis Lang P Phoneme Prosody S SayAs Sub W)
+            @nestables = %w(Break Cont Emphasis Lang P Phoneme Prosody S SayAs Sub W)
           else
             raise PlivoXMLError, "<Speak> voice #{attributes[:voice]} is not valid."
           end

data/lib/plivo/xml/w.rb

@@ -1,7 +1,7 @@
 module Plivo
   module XML
     class W < Element
-      @nestables = %w(Break Emphasis Phoneme Prosody SayAs Sub)
+      @nestables = %w(Break Cont Emphasis Phoneme Prosody SayAs Sub)
       @valid_attributes = %w(role)
 
       VALID_ROLE_ATTRIBUTE_VALUES=%w(amazon:VB amazon:VBD amazon:SENSE_1)

data/lib/plivo/xml.rb

@@ -29,7 +29,8 @@ require_relative 'xml/say_as'
 require_relative 'xml/sub'
 require_relative 'xml/w'
 require_relative 'xml/plivo_xml'
-
+require_relative 'xml/multipartycall'
+require_relative 'xml/cont'
 include Plivo::Exceptions
 
 module Plivo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.17.1
+  version: 4.21.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -190,6 +190,7 @@ files:
 - lib/plivo/resources/lookup.rb
 - lib/plivo/resources/media.rb
 - lib/plivo/resources/messages.rb
+- lib/plivo/resources/multipartycalls.rb
 - lib/plivo/resources/nodes.rb
 - lib/plivo/resources/numbers.rb
 - lib/plivo/resources/phlo_member.rb
@@ -204,6 +205,7 @@ files:
 - lib/plivo/xml.rb
 - lib/plivo/xml/break.rb
 - lib/plivo/xml/conference.rb
+- lib/plivo/xml/cont.rb
 - lib/plivo/xml/dial.rb
 - lib/plivo/xml/dtmf.rb
 - lib/plivo/xml/element.rb
@@ -213,6 +215,7 @@ files:
 - lib/plivo/xml/hangup.rb
 - lib/plivo/xml/lang.rb
 - lib/plivo/xml/message.rb
+- lib/plivo/xml/multipartycall.rb
 - lib/plivo/xml/number.rb
 - lib/plivo/xml/p.rb
 - lib/plivo/xml/phoneme.rb