bandwidth-sdk 10.4.0 → 10.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f011b72b189da15e3b1b43201601250454cbd2c348c9b13629c0f4b8eb02838
-  data.tar.gz: dc058e532b3e089f6591bd41d6b2984cd2ef2ba1d44f61c609e9253c918192cb
+  metadata.gz: ffaae51706420e65f3e5d390fb9215c6dbcfab4fafd63afdcb23db02b9f35c2f
+  data.tar.gz: bbf5a6df61b719af55f8207cae476e6e9dfa558e39b144ce6f612616081e8b5f
 SHA512:
-  metadata.gz: c76196ab9c8c40578883f4963b2f7b6cd368b63a8304380344f8820deae79569c13a262da25e06ba2cc3f0cf8cfa81f11b6a35080dd829ba978f07b22d6884d5
-  data.tar.gz: 2ee584741d90c28ea2b465dffcccdbed815f7a2b38b8517bcb123ccd5378bbee227a901dff9679449572f5e45ecbda36f47252a10bdb1209697a77101a52f838
+  metadata.gz: 40337ac287221ab0177321f3118373023052bc5f322c44e30768b1b678d51917ada3a261e5620fa0d9ad9cb9fb626d03163e4fcf8bf63b7c4ec7c04480e84a4a
+  data.tar.gz: dfade60302bddd061ff00afe378cc64f006c93c7b95c36a290aeb80f38ded9eb10d8c156b994b6cebe4fa414bde4f103c48925f844e9802cae47505fb9bc5b80

data/lib/bandwidth/voice_lib/bxml/verbs/custom_param.rb

@@ -0,0 +1,17 @@
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # These elements define optional user specified parameters that will be sent to the destination URL when the real-time transcription is first started
+    class CustomParam
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.CustomParam(compact_hash({
+         'name' => name,
+         'value' => value
+        }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/start_transcription.rb

@@ -0,0 +1,42 @@
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The StartTranscription verb allows a segment of a call to be transcribed and optionally for the live transcription to be sent off to another destination for additional processing
+    class StartTranscription
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.StartTranscription(compact_hash({
+         'name' => name,
+         'tracks' => tracks,
+         'transcriptionEventUrl' => transcriptionEventUrl,
+         'transcriptionEventMethod' => transcriptionEventMethod,
+         'username' => username,
+         'password' => password,
+         'destination' => destination,
+         'stabilized' => stabilized
+        })) 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, custom_params, CustomParam)
+         nest_verbs_list(xml, nested_verbs)
+        end
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/stop_transcription.rb

@@ -0,0 +1,16 @@
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The StopTranscription verb is used to stop a real-time transcription that was started with a previous `<StartTranscription>` verb
+    class StopTranscription
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.StopTranscription(compact_hash({
+         'name' => name
+        }))
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ 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
+    # These elements define optional user specified parameters that will be sent to the destination URL when the stream is first started
     class StreamParam
       include XmlVerb
 

data/test/integration/test_integration.rb

@@ -122,11 +122,18 @@ class IntegrationTest < Test::Unit::TestCase
         assert(response.data.enqueued_time.is_a?(DateTime), "enqueued time is not a DateTime object")
 
         #Get phone call information
-        sleep(15)
-        response = @bandwidth_client.voice_client.client.get_call(BW_ACCOUNT_ID, response.data.call_id)
-        assert(response.data.state.length > 0, "state value not set")
-        assert_not_nil(response.data.enqueued_time, "enqueued time is nil")
-        assert(response.data.enqueued_time.is_a?(DateTime), "enqueued time is not a DateTime object")
+        sleep(2)
+        begin
+            response = @bandwidth_client.voice_client.client.get_call(BW_ACCOUNT_ID, response.data.call_id)
+            assert(response.data.state.length > 0, "state value not set")
+            assert_not_nil(response.data.enqueued_time, "enqueued time is nil")
+            assert(response.data.enqueued_time.is_a?(DateTime), "enqueued time is not a DateTime object")
+        rescue ApiErrorException => e
+            if e.response_code != 404
+                raise StandardError, "Unexpected HTTP Response: " + e.message
+            end
+        end
+            
     end
 
     def test_create_call_with_amd_and_get_call_state
@@ -151,9 +158,15 @@ class IntegrationTest < Test::Unit::TestCase
         assert(response.data.call_id.length > 0, "call_id value not set")
 
         #Get phone call information
-        sleep(15)
-        response = @bandwidth_client.voice_client.client.get_call(BW_ACCOUNT_ID, response.data.call_id)
-        assert(response.data.state.length > 0, "state value not set")
+        sleep(2)
+        begin
+            response = @bandwidth_client.voice_client.client.get_call(BW_ACCOUNT_ID, response.data.call_id)
+            assert(response.data.state.length > 0, "state value not set")
+        rescue ApiErrorException => e
+            if e.response_code != 404
+                raise StandardError, "Unexpected HTTP Response: " + e.message
+            end
+        end
     end
 
     def test_create_call_with_priority
@@ -766,4 +779,73 @@ class IntegrationTest < Test::Unit::TestCase
 
         assert_equal(expected, actual)
     end
+
+    def test_start_transcription_bxml_verb
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><StartTranscription name="test_transcription" tracks="inbound" transcriptionEventUrl="https://www.test.com/event" transcriptionEventMethod="POST" username="username" password="password" destination="https://www.test.com/transcription"><CustomParam name="name1" value="value1"/></StartTranscription></Response>'
+        response = Bandwidth::Voice::Response.new()
+
+        custom_param1 = Bandwidth::Voice::CustomParam.new({
+            :name => "name1",
+            :value => "value1"
+        })
+        
+        start_transcription = Bandwidth::Voice::StartTranscription.new({
+            :name => "test_transcription",
+            :tracks => "inbound",
+            :transcriptionEventUrl => "https://www.test.com/event",
+            :transcriptionEventMethod => "POST",
+            :username => "username",
+            :password => "password",
+            :destination => "https://www.test.com/transcription",
+            :custom_params => custom_param1
+        })
+
+        response.push(start_transcription)
+        actual = response.to_bxml()
+
+        assert_equal(expected, actual)
+    end
+
+    def test_start_transcription_multiple_nested_custom_params
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><StartTranscription name="test_transcription" tracks="inbound" transcriptionEventUrl="https://www.test.com/event" transcriptionEventMethod="POST" username="username" password="password" destination="https://www.test.com/transcription"><CustomParam name="name1" value="value1"/><CustomParam name="name2" value="value2"/></StartTranscription></Response>'
+        response = Bandwidth::Voice::Response.new()
+
+        custom_param1 = Bandwidth::Voice::CustomParam.new({
+            :name => "name1",
+            :value => "value1"
+        })
+
+        custom_param2 = Bandwidth::Voice::CustomParam.new({
+            :name => "name2",
+            :value => "value2"
+        })
+
+        start_transcription = Bandwidth::Voice::StartTranscription.new({
+            :destination => "https://www.test.com/transcription",
+            :name => "test_transcription",
+            :tracks => "inbound",
+            :transcriptionEventUrl => "https://www.test.com/event",
+            :transcriptionEventMethod => "POST",
+            :username => "username",
+            :password => "password",
+            :nested_verbs => [custom_param1, custom_param2]
+        })
+
+        response.push(start_transcription)
+        actual = response.to_bxml()
+
+        assert_equal(expected, actual)
+    end
+
+    def test_stop_transcription_bxml_verb
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><StopTranscription name="test_transcription"/></Response>'
+        response = Bandwidth::Voice::Response.new()
+        stop_transcription = Bandwidth::Voice::StopTranscription.new({
+            :name => "test_transcription"
+        })
+        response.push(stop_transcription)
+        actual = response.to_bxml()
+
+        assert_equal(expected, actual)
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 10.4.0
+  version: 10.5.0
 platform: ruby
 authors:
 - Bandwidth
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -231,6 +231,7 @@ files:
 - lib/bandwidth/voice_lib/bxml/response.rb
 - lib/bandwidth/voice_lib/bxml/verbs/bridge.rb
 - lib/bandwidth/voice_lib/bxml/verbs/conference.rb
+- lib/bandwidth/voice_lib/bxml/verbs/custom_param.rb
 - lib/bandwidth/voice_lib/bxml/verbs/forward.rb
 - lib/bandwidth/voice_lib/bxml/verbs/gather.rb
 - lib/bandwidth/voice_lib/bxml/verbs/hangup.rb
@@ -248,9 +249,11 @@ files:
 - lib/bandwidth/voice_lib/bxml/verbs/start_gather.rb
 - lib/bandwidth/voice_lib/bxml/verbs/start_recording.rb
 - lib/bandwidth/voice_lib/bxml/verbs/start_stream.rb
+- lib/bandwidth/voice_lib/bxml/verbs/start_transcription.rb
 - lib/bandwidth/voice_lib/bxml/verbs/stop_gather.rb
 - lib/bandwidth/voice_lib/bxml/verbs/stop_recording.rb
 - lib/bandwidth/voice_lib/bxml/verbs/stop_stream.rb
+- lib/bandwidth/voice_lib/bxml/verbs/stop_transcription.rb
 - lib/bandwidth/voice_lib/bxml/verbs/stream_param.rb
 - lib/bandwidth/voice_lib/bxml/verbs/tag.rb
 - lib/bandwidth/voice_lib/bxml/verbs/transfer.rb
@@ -314,7 +317,7 @@ homepage: https://github.com/Bandwidth/ruby-sdk
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -330,7 +333,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Bandwidth
 test_files: []