DX-2466 add modifyCallBxml functionality (#52)

* DX-2466 add `modifyCallBxml` functionality

* fix 415, description, and update version

Author: ckoegel

bandwidth.gemspec

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

lib/bandwidth.rb

@@ -47,6 +47,7 @@
 require_relative 'bandwidth/http/auth/web_rtc_basic_auth.rb'
 
 # External Files
+require_relative 'bandwidth/voice_lib/bxml/response.rb'
 require_relative 'bandwidth/voice_lib/bxml/bxml.rb'
 require_relative 'bandwidth/voice_lib/bxml/verbs/bridge.rb'
 require_relative 'bandwidth/voice_lib/bxml/verbs/conference.rb'

lib/bandwidth/voice_lib/bxml/bxml.rb

@@ -3,14 +3,11 @@
   require_relative file
 }
 
-SSML_REGEX = /<([a-zA-Z\/\/].*?)>/
-SPEAK_SENTENCE_REGEX = /<SpeakSentence.*?>.*?<\/SpeakSentence>/
-
 module Bandwidth 
   module Voice 
-    class Response
+    class Bxml
       # Initializer
-      # @param verbs [Array] optional list of verbs to include into response
+      # @param verbs [Array] optional list of verbs to include in the bxml tag
       def initialize(verbs = nil)
         @verbs = verbs || []
       end
@@ -19,7 +16,7 @@ def initialize(verbs = nil)
       def to_bxml()
         xml = Builder::XmlMarkup.new()
         xml.instruct!(:xml, :version=>'1.0', :encoding=>'UTF-8')
-        xml.Response do
+        xml.Bxml do
           @verbs.each {|verb| verb.to_bxml(xml)}
         end
         xml.target!().gsub(SPEAK_SENTENCE_REGEX){|s|s.gsub(SSML_REGEX, '<\1>')}

lib/bandwidth/voice_lib/bxml/response.rb

@@ -0,0 +1,39 @@
+require 'builder'
+Dir[File.dirname(__FILE__) + '/verbs/*'].each {|file|
+  require_relative file
+}
+
+SSML_REGEX = /<([a-zA-Z\/\/].*?)>/
+SPEAK_SENTENCE_REGEX = /<SpeakSentence.*?>.*?<\/SpeakSentence>/
+
+module Bandwidth 
+  module Voice 
+    class Response
+      # Initializer
+      # @param verbs [Array] optional list of verbs to include into response
+      def initialize(verbs = nil)
+        @verbs = verbs || []
+      end
+
+      # Return BXML representaion of this response
+      def to_bxml()
+        xml = Builder::XmlMarkup.new()
+        xml.instruct!(:xml, :version=>'1.0', :encoding=>'UTF-8')
+        xml.Response do
+          @verbs.each {|verb| verb.to_bxml(xml)}
+        end
+        xml.target!().gsub(SPEAK_SENTENCE_REGEX){|s|s.gsub(SSML_REGEX, '<\1>')}
+      end
+
+      # Add one or more verbs to this response
+      def push(*verbs)
+        @verbs.push(*verbs)
+      end
+
+      # Add a verb to this response
+      def <<(verb)
+        @verbs << verb
+      end
+    end
+  end
+end

lib/bandwidth/voice_lib/voice/controllers/api_controller.rb

@@ -252,6 +252,87 @@ def modify_call(account_id,
       ApiResponse.new(_response)
     end
 
+    # Makes a PUT request to /api/v2/accounts/{accountId}/calls/{callId}/bxml
+    # @param [String] account_id Required parameter: Example:
+    # @param [String] call_id Required parameter: Example:
+    # @param [String] body Required parameter: Example:
+    # @return [void] response from the API call
+    def modify_call_bxml(account_id,
+                         call_id,
+                         body
+                        )
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
+      _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/bxml'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'callId' => { 'value' => call_id, 'encode' => false }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'content-type' => 'application/xml; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      VoiceBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      case _response.status_code
+      when 400
+        raise ApiErrorException.new(
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
+          _response
+        )
+      when 401
+        raise APIException.new(
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
+          _response
+        )
+      when 403
+        raise ApiErrorException.new(
+          'User unauthorized to perform this action.',
+          _response
+        )
+      when 404
+        raise ApiErrorException.new(
+          'The resource specified cannot be found or does not belong to you.',
+          _response
+        )
+      when 415
+        raise ApiErrorException.new(
+          'We don\'t support that media type. If a request body is required,' \
+          ' please send it to us as `application/xml`.',
+          _response
+        )
+      when 429
+        raise ApiErrorException.new(
+          'You\'re sending requests to this endpoint too frequently. Please' \
+          ' slow your request rate down and try again.',
+          _response
+        )
+      when 500
+        raise ApiErrorException.new(
+          'Something unexpected happened. Please try again.',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
     # Pauses or resumes a recording.
     # @param [String] account_id Required parameter: Example:
     # @param [String] call_id Required parameter: Example:

test/integration/test_integration.rb

@@ -262,6 +262,34 @@ def test_gather_multiple_nested_verbs
         assert_equal(expected, actual)
     end
 
+    def test_empty_bxml_verb
+        bxml = Bandwidth::Voice::Bxml.new()
+
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Bxml></Bxml>'
+        actual = bxml.to_bxml()
+        assert_equal(expected, actual)
+    end
+
+    def test_bxml_speak_sentence_pause
+        bxml = Bandwidth::Voice::Bxml.new()
+
+        speak_sentence = Bandwidth::Voice::SpeakSentence.new({
+            :sentence => "new modify call bxml is pog",
+            :voice => "Julie"
+        })
+
+        pause = Bandwidth::Voice::Pause.new({
+            :duration => 6
+        })
+
+        bxml.push(speak_sentence)
+        bxml.push(pause)
+
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Bxml><SpeakSentence voice="Julie">new modify call bxml is pog</SpeakSentence><Pause duration="6"/></Bxml>'
+        actual = bxml.to_bxml()
+        assert_equal(expected, actual)
+    end
+
     def test_hangup
         hangup = Bandwidth::Voice::Hangup.new()