DX-2860 StreamParams (#60)

Author: ckoegel

bandwidth.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'bandwidth-sdk'
-  s.version = '10.1.0'
+  s.version = '10.2.0'
   s.summary = 'Bandwidth'
   s.description = 'The official client SDK for Bandwidht\'s Voice, Messaging, MFA, and WebRTC APIs'
   s.authors = ['Bandwidth']

lib/bandwidth/voice_lib/bxml/verbs/start_stream.rb

@@ -15,7 +15,26 @@ def to_bxml(xml)
          'streamEventMethod' => streamEventMethod,
          'username' => username,
          'password' => password
-        }))
+        })) do
+          def embedded_xml(xml, property, type)
+            if property
+              s = if property.is_a?(type)
+                    then property
+                  else type.new(property)
+                    end
+              s.to_bxml(xml)
+            end
+          end
+          def nest_verbs_list(xml, property)
+            if property
+              property.each do |verb|
+                verb.to_bxml(xml)
+              end
+            end
+          end
+         embedded_xml(xml, stream_params, StreamParam)
+         nest_verbs_list(xml, nested_verbs)
+        end
       end
     end
   end

lib/bandwidth/voice_lib/bxml/verbs/stream_param.rb

@@ -0,0 +1,17 @@
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The StartStream verb allows a segment of a call to be sent off to another destination for additional processing
+    class StreamParam
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.StreamParam(compact_hash({
+         'name' => name,
+         'value' => value
+        }))
+      end
+    end
+  end
+end

test/integration/test_integration.rb

@@ -274,7 +274,7 @@ def test_empty_bxml_verb
         assert_equal(expected, actual)
     end
 
-    def test_bxml_speak_sentence_pause
+    def test_speak_sentence_pause
         bxml = Bandwidth::Voice::Bxml.new()
 
         speak_sentence = Bandwidth::Voice::SpeakSentence.new({
@@ -690,17 +690,56 @@ def test_webrtc_generate_transfer_bxml_verb
     end
 
     def test_start_stream_bxml_verb
-        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><StartStream destination="https://www.test.com/stream" name="test_stream" tracks="inbound" streamEventUrl="https://www.test.com/event" streamEventMethod="POST" username="username" password="password"/></Response>'
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><StartStream destination="https://www.test.com/stream" name="test_stream" tracks="inbound" streamEventUrl="https://www.test.com/event" streamEventMethod="POST" username="username" password="password"><StreamParam name="name1" value="value1"/></StartStream></Response>'
         response = Bandwidth::Voice::Response.new()
+
+        stream_param1 = Bandwidth::Voice::StreamParam.new({
+            :name => "name1",
+            :value => "value1"
+        })
+        
+        start_stream = Bandwidth::Voice::StartStream.new({
+            :destination => "https://www.test.com/stream",
+            :name => "test_stream",
+            :tracks => "inbound",
+            :streamEventUrl => "https://www.test.com/event",
+            :streamEventMethod => "POST",
+            :username => "username",
+            :password => "password",
+            :stream_params => stream_param1
+        })
+
+        response.push(start_stream)
+        actual = response.to_bxml()
+
+        assert_equal(expected, actual)
+    end
+
+    def test_start_stream_multiple_nested_stream_params
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><StartStream destination="https://www.test.com/stream" name="test_stream" tracks="inbound" streamEventUrl="https://www.test.com/event" streamEventMethod="POST" username="username" password="password"><StreamParam name="name1" value="value1"/><StreamParam name="name2" value="value2"/></StartStream></Response>'
+        response = Bandwidth::Voice::Response.new()
+
+        stream_param1 = Bandwidth::Voice::StreamParam.new({
+            :name => "name1",
+            :value => "value1"
+        })
+
+        stream_param2 = Bandwidth::Voice::StreamParam.new({
+            :name => "name2",
+            :value => "value2"
+        })
+
         start_stream = Bandwidth::Voice::StartStream.new({
             :destination => "https://www.test.com/stream",
             :name => "test_stream",
             :tracks => "inbound",
             :streamEventUrl => "https://www.test.com/event",
             :streamEventMethod => "POST",
             :username => "username",
-            :password => "password"
+            :password => "password",
+            :nested_verbs => [stream_param1, stream_param2]
         })
+
         response.push(start_stream)
         actual = response.to_bxml()