Added bxml v2 "warnings". added missing tests (#14)

Author: avbel

lib/bandwidth/xml/verbs/pause.rb

@@ -6,6 +6,7 @@ class Pause
         include XmlVerb
 
         def to_xml(xml)
+          warn "[DEPRECATION] Verb 'Pause' will be removed in Bandwidth XML v2"
           xml.Pause(compact_hash({
            'duration' => duration
           }))

lib/bandwidth/xml/verbs/play_audio.rb

@@ -6,6 +6,7 @@ class PlayAudio
         include XmlVerb
 
         def to_xml(xml)
+          warn "[DEPRECATION] Attribute 'digits' of 'PlayAudio' will be removed in Bandwidth XML v2" if digits
           xml.PlayAudio(url, compact_hash({
            'digits' => digits
           }))

lib/bandwidth/xml/verbs/reject.rb

@@ -6,6 +6,7 @@ class Reject
         include XmlVerb
 
         def to_xml(xml)
+          warn "[DEPRECATION] Verb 'Reject' will be removed in Bandwidth XML v2"
           xml.Reject(compact_hash({
            'reason' => reason
           }))

lib/bandwidth/xml/verbs/send_message.rb

@@ -6,6 +6,7 @@ class SendMessage
         include XmlVerb
 
         def to_xml(xml)
+          warn "[DEPRECATION] Verb 'SendMessage' will be removed in Bandwidth XML v2"
           xml.SendMessage(text, compact_hash({
            'requestUrl' => request_url,
            'requestUrlTimeout' => request_url_timeout,

lib/bandwidth/xml/verbs/speak_sentence.rb

@@ -9,7 +9,7 @@ def to_xml(xml)
           xml.SpeakSentence(sentence, compact_hash({
            'voice' => voice,
            'locale' => locale,
-           'gender' => gender
+           'gender' => gender || 'female'
           }))
         end
       end

lib/bandwidth/xml/verbs/transfer.rb

@@ -8,15 +8,29 @@ class Transfer
         def to_xml(xml)
           xml.Transfer(compact_hash({
            'transferTo' => transfer_to || to,
-           'transferCallerId' => transfer_caller_id || caller_id
+           'transferCallerId' => transfer_caller_id || caller_id,
+           'requestUrl' => request_url,
+           'requestUrlTimeout' => request_url_timeout,
+           'callTimeout' => call_timeout,
+           'tag' => tag,
           })) do
-            if speak_sentence
-              s = if speak_sentence.is_a?(SpeakSentence)
-                  then speak_sentence
-                  else SpeakSentence.new(speak_sentence)
-                  end
-              s.to_xml(xml)
+            def embedded_xml(xml, property, type)
+              if property
+                s = if property.is_a?(type)
+                    then property
+                    else type.new(property)
+                    end
+                s.to_xml(xml)
+              end
             end
+            numbers = phone_numbers
+            numbers = [phone_number] if !numbers && phone_number
+            (numbers || []).each do |n|
+              xml.PhoneNumber(n)
+            end
+            embedded_xml(xml, speak_sentence, SpeakSentence)
+            embedded_xml(xml, play_audio, PlayAudio)
+            embedded_xml(xml, record, Record)
           end
         end
       end

spec/bandwidth/xml/verbs/speak_sentence_spec.rb

@@ -2,7 +2,7 @@
 describe SpeakSentence do
   describe '#to_xml' do
     it 'should generate valid xml' do
-      expect(Helper.to_xml(SpeakSentence.new(:voice => "kate", :sentence => "text"))).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><SpeakSentence voice=\"kate\">text</SpeakSentence></Response>")
+      expect(Helper.to_xml(SpeakSentence.new(:voice => "kate", :sentence => "text"))).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><SpeakSentence voice=\"kate\" gender=\"female\">text</SpeakSentence></Response>")
     end
   end
 end

spec/bandwidth/xml/verbs/transfer_spec.rb

@@ -6,8 +6,23 @@
       expect(Helper.to_xml(Transfer.new(:to => "to", :caller_id => "id"))).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Transfer transferTo=\"to\" transferCallerId=\"id\"></Transfer></Response>")
     end
     it 'should allow to embed SpeakSentence' do
-      expect(Helper.to_xml(Transfer.new(:to => "to", :caller_id => "id", :speak_sentence => {:voice => "kate", :sentence => "text"}))).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Transfer transferTo=\"to\" transferCallerId=\"id\"><SpeakSentence voice=\"kate\">text</SpeakSentence></Transfer></Response>")
-      expect(Helper.to_xml(Transfer.new(:to => "to", :caller_id => "id", :speak_sentence => SpeakSentence.new({:voice => "kate", :sentence => "text"})))).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Transfer transferTo=\"to\" transferCallerId=\"id\"><SpeakSentence voice=\"kate\">text</SpeakSentence></Transfer></Response>")
+      result = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Transfer transferTo=\"to\" transferCallerId=\"id\"><SpeakSentence voice=\"kate\" gender=\"female\">text</SpeakSentence></Transfer></Response>"
+      expect(Helper.to_xml(Transfer.new(:to => "to", :caller_id => "id", :speak_sentence => {:voice => "kate", :sentence => "text"}))).to eql(result)
+      expect(Helper.to_xml(Transfer.new(:to => "to", :caller_id => "id", :speak_sentence => SpeakSentence.new({:voice => "kate", :sentence => "text"})))).to eql(result)
+    end
+    it 'should allow to embed PlayAudio' do
+      result = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Transfer transferTo=\"to\" transferCallerId=\"id\"><PlayAudio>url1</PlayAudio></Transfer></Response>"
+      expect(Helper.to_xml(Transfer.new(:to => "to", :caller_id => "id", :play_audio => {:url =>"url1"}))).to eql(result)
+    end
+    it 'should allow to embed Record' do
+      result = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Transfer transferTo=\"to\" transferCallerId=\"id\"><Record requestUrl=\"url1\"/></Transfer></Response>"
+      expect(Helper.to_xml(Transfer.new(:to => "to", :caller_id => "id", :record => {:request_url =>"url1"}))).to eql(result)
+    end
+    it 'should allow to embed phone numbers' do
+      result = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Transfer transferTo=\"to\" transferCallerId=\"id\"><PhoneNumber>+1234568901</PhoneNumber><PhoneNumber>+1234568902</PhoneNumber></Transfer></Response>"
+      expect(Helper.to_xml(Transfer.new(:to => "to", :caller_id => "id", :phone_numbers => ["+1234568901", "+1234568902"]))).to eql(result)
+      result = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Transfer transferTo=\"to\" transferCallerId=\"id\"><PhoneNumber>+1234568901</PhoneNumber></Transfer></Response>"
+      expect(Helper.to_xml(Transfer.new(:to => "to", :caller_id => "id", :phone_number => "+1234568901"))).to eql(result)
     end
   end
 end