bandwidth-sdk 10.3.0 → 10.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6da05ba4b6e401983ac08107e419d06a018640e84f980eb39aea9f9a8c8458fd
-  data.tar.gz: daab0265c2590c6c289b9582d3325f159f3501b66240873c821f269d613e4033
+  metadata.gz: ffaae51706420e65f3e5d390fb9215c6dbcfab4fafd63afdcb23db02b9f35c2f
+  data.tar.gz: bbf5a6df61b719af55f8207cae476e6e9dfa558e39b144ce6f612616081e8b5f
 SHA512:
-  metadata.gz: 9cc3ffa14b5c4c6574f26524a8caf74e4efdba60e5ab02f7aa74e8ef6ef70d62ffa5d9c6be66ee715d64a3db9e16e0e94a0bcf829aeccc5f4c240af68e4efc9f
-  data.tar.gz: 14d7c3993dd30956d75043799b50db9ac075c505cf3255bd0dd9040ccf3695cc67f51a9ed341acfbbc010dd3326a62eb4cf7244b1e4a52cd49e0c5e635b0852e
+  metadata.gz: 40337ac287221ab0177321f3118373023052bc5f322c44e30768b1b678d51917ada3a261e5620fa0d9ad9cb9fb626d03163e4fcf8bf63b7c4ec7c04480e84a4a
+  data.tar.gz: dfade60302bddd061ff00afe378cc64f006c93c7b95c36a290aeb80f38ded9eb10d8c156b994b6cebe4fa414bde4f103c48925f844e9802cae47505fb9bc5b80

data/README.md

@@ -1,6 +1,6 @@
 # Bandwidth Ruby SDK
 
-[![Test](https://github.com/Bandwidth/ruby-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/Bandwidth/ruby-sdk/actions/workflows/test.yml)
+[![Nightly Tests](https://github.com/Bandwidth/ruby-sdk/actions/workflows/test-nightly.yml/badge.svg)](https://github.com/Bandwidth/ruby-sdk/actions/workflows/test-nightly.yml)
 
 
 | **OS** | **Ruby** |

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/record.rb

@@ -19,6 +19,7 @@ module Bandwidth
          'maxDuration' => max_duration,
          'fileFormat' => file_format,
          'transcribe' => transcribe,
+         'detectLanguage' => detect_language,
          'transcriptionAvailableUrl' => transcription_available_url,
          'transcriptionAvailableMethod' => transcription_available_method,
          'silenceTimeout' => silence_timeout,

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

@@ -16,6 +16,7 @@ module Bandwidth
          'fileFormat' => file_format,
          'multiChannel' => multi_channel,
          'transcribe' => transcribe,
+         'detectLanguage' => detect_language,
          'transcriptionAvailableUrl' => transcription_available_url,
          'transcriptionAvailableMethod' => transcription_available_method
         }))

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/lib/bandwidth/voice_lib/voice/models/transcribe_recording_request.rb

@@ -33,6 +33,10 @@ module Bandwidth
     # @return [Float]
     attr_accessor :callback_timeout
 
+    # TODO: Write general description for this method
+    # @return [Boolean]
+    attr_accessor :detect_language
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -42,6 +46,7 @@ module Bandwidth
       @_hash['password'] = 'password'
       @_hash['tag'] = 'tag'
       @_hash['callback_timeout'] = 'callbackTimeout'
+      @_hash['detect_language'] = 'detectLanguage'
       @_hash
     end
 
@@ -54,6 +59,7 @@ module Bandwidth
         password
         tag
         callback_timeout
+        detect_language
       ]
     end
 
@@ -65,6 +71,7 @@ module Bandwidth
         password
         tag
         callback_timeout
+        detect_language
       ]
     end
 
@@ -73,6 +80,7 @@ module Bandwidth
                    username = nil,
                    password = nil,
                    tag = nil,
+                   detect_language = nil,
                    callback_timeout = nil)
       @callback_url = callback_url unless callback_url == SKIP
       @callback_method = callback_method unless callback_method == SKIP
@@ -80,6 +88,7 @@ module Bandwidth
       @password = password unless password == SKIP
       @tag = tag unless tag == SKIP
       @callback_timeout = callback_timeout unless callback_timeout == SKIP
+      @detect_language = detect_language unless detect_language == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -95,6 +104,8 @@ module Bandwidth
       tag = hash.key?('tag') ? hash['tag'] : SKIP
       callback_timeout =
         hash.key?('callbackTimeout') ? hash['callbackTimeout'] : SKIP
+      detect_language =
+        hash.key?('detectLanguage') ? hash['detectLanguage'] : SKIP
 
       # Create object from extracted values.
       TranscribeRecordingRequest.new(callback_url,
@@ -102,6 +113,7 @@ module Bandwidth
                                      username,
                                      password,
                                      tag,
+                                     detect_language,
                                      callback_timeout)
     end
   end

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 1
-        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,8 +158,15 @@ class IntegrationTest < Test::Unit::TestCase
         assert(response.data.call_id.length > 0, "call_id value not set")
 
         #Get phone call information
-        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
@@ -354,6 +368,7 @@ class IntegrationTest < Test::Unit::TestCase
             :recording_available_url => "https://available.com",
             :recording_available_method => "GET",
             :transcribe => false,
+            :detect_language=> true,
             :transcription_available_url => "https://transcribe.com",
             :transcription_available_method => "POST",
             :username => "user",
@@ -371,7 +386,7 @@ class IntegrationTest < Test::Unit::TestCase
 
         response = Bandwidth::Voice::Response.new()
         response.push(record)
-        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><Record tag="tag" username="user" password="pass" recordCompleteUrl="https://complete.com" recordCompleteMethod="POST" recordingAvailableUrl="https://available.com" recordingAvailableMethod="GET" terminatingDigits="#" maxDuration="3" fileFormat="wav" transcribe="false" transcriptionAvailableUrl="https://transcribe.com" transcriptionAvailableMethod="POST" silenceTimeout="5" recordCompleteFallbackUrl="https://test.com" recordCompleteFallbackMethod="GET" fallbackUsername="fuser" fallbackPassword="fpass"/></Response>'
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><Record tag="tag" username="user" password="pass" recordCompleteUrl="https://complete.com" recordCompleteMethod="POST" recordingAvailableUrl="https://available.com" recordingAvailableMethod="GET" terminatingDigits="#" maxDuration="3" fileFormat="wav" transcribe="false" detectLanguage="true" transcriptionAvailableUrl="https://transcribe.com" transcriptionAvailableMethod="POST" silenceTimeout="5" recordCompleteFallbackUrl="https://test.com" recordCompleteFallbackMethod="GET" fallbackUsername="fuser" fallbackPassword="fpass"/></Response>'
         actual = response.to_bxml()
         assert_equal(expected, actual)
     end
@@ -764,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.3.0
+  version: 10.5.0
 platform: ruby
 authors:
 - Bandwidth
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-14 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
@@ -329,8 +332,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Bandwidth
 test_files: []