Add form-urlencoded format

Author: timhall

src/RestHelpers.bas

@@ -274,7 +274,7 @@ Public Function DictionariesToUrlEncodedString(ParamArray Dictionaries() As Vari
 
     Set Combined = Dictionaries(LBound(Dictionaries))
     For i = LBound(Dictionaries) + 1 To UBound(Dictionaries)
-        Set Combined = CombineObjects(Combined, Dictionaries(i), False)
+        Set Combined = CombineObjects(Combined, Dictionaries(i))
     Next i
 
     If Not Combined Is Nothing Then
@@ -287,6 +287,41 @@ Public Function DictionariesToUrlEncodedString(ParamArray Dictionaries() As Vari
     DictionariesToUrlEncodedString = Encoded
 End Function
 
+''
+' Parse url-encoded string to Dictionary
+'
+' @param {String} UrlEncoded
+' @return {Dictionary} Parsed
+' --------------------------------------------- '
+
+Public Function ParseUrlEncoded(Encoded As String) As Dictionary
+    Dim Items As Variant
+    Dim i As Integer
+    Dim Parts As Variant
+    Dim Parsed As New Dictionary
+    Dim Key As String
+    Dim Value As Variant
+    
+    Items = Split(Encoded, "&")
+    For i = LBound(Items) To UBound(Items)
+        Parts = Split(Items(i), "=")
+        
+        If UBound(Parts) - LBound(Parts) >= 1 Then
+            ' TODO: Handle numbers, arrays, and object better here
+            Key = URLDecode(CStr(Parts(LBound(Parts))))
+            Value = URLDecode(CStr(Parts(LBound(Parts) + 1)))
+            
+            If Parsed.Exists(Key) Then
+                Parsed(Key) = Value
+            Else
+                Parsed.Add Key, Value
+            End If
+        End If
+    Next i
+    
+    Set ParseUrlEncoded = Parsed
+End Function
+
 ''
 ' Prepare http request for execution
 '
@@ -443,7 +478,9 @@ Public Function CreateResponseFromHttp(ByRef Http As Object, Optional Format As
 
     ' Convert content to data by format
     Select Case Format
-    Case Else
+    Case AvailableFormats.formurlencoded
+        Set CreateResponseFromHttp.Data = RestHelpers.ParseUrlEncoded(Http.ResponseText)
+    Case AvailableFormats.json
         Set CreateResponseFromHttp.Data = RestHelpers.ParseJSON(Http.ResponseText)
     End Select
 

src/RestRequest.cls

@@ -49,6 +49,7 @@ Public Enum AvailableMethods
 End Enum
 Public Enum AvailableFormats
     json
+    formurlencoded
 End Enum
 
 ' --------------------------------------------- '
@@ -136,7 +137,7 @@ Public Property Get FormattedResource() As String
 
             ' Only load parameters to querystring if GET request (otherwise they are added to the body)
             If Me.Method = httpGET Then
-                FormattedResource = FormattedResource & RestHelpers.DictionariesToUrlEncodedString(Me.QuerystringParams, Me.Parameters)
+                FormattedResource = FormattedResource & RestHelpers.DictionariesToUrlEncodedString(Me.Parameters, Me.QuerystringParams)
             Else
                 FormattedResource = FormattedResource & RestHelpers.DictionariesToUrlEncodedString(Me.QuerystringParams)
             End If
@@ -147,24 +148,30 @@ End Property
 Public Property Get Body() As String
     ' Add body if it's defined or parameters have been set and it is not a GET request
     If Not pBody Is Nothing Or pBodyString <> "" Or (Me.Parameters.count > 0 And Me.Method <> httpGET) Then
-        Select Case Me.Format
-        ' (Currently only JSON is supported)
-        Case Else
-            If pBodyString <> "" Then
-                If Me.Parameters.count > 0 And Me.Method <> httpGET Then
-                    Err.Raise vbObjectError + 1, "RestRequest.Body", "Unable to combine body string and parameters"
+        If pBodyString <> "" Then
+            If Me.Parameters.count > 0 And Me.Method <> httpGET Then
+                Err.Raise vbObjectError + 1, "RestRequest.Body", "Unable to combine body string and parameters"
+            Else
+                Body = pBodyString
+            End If
+        Else
+            Select Case Me.Format
+            Case AvailableFormats.formurlencoded
+                If Me.Method <> httpGET Then
+                    ' Combine defined body and parameters and convert to JSON
+                    Body = RestHelpers.DictionariesToUrlEncodedString(Me.Parameters, pBody)
                 Else
-                    Body = pBodyString
+                    Body = RestHelpers.DictionariesToUrlEncodedString(pBody)
                 End If
-            Else
+            Case AvailableFormats.json
                 If Me.Method <> httpGET Then
                     ' Combine defined body and parameters and convert to JSON
-                    Body = RestHelpers.ConvertToJSON(CombineObjects(pBody, Me.Parameters))
+                    Body = RestHelpers.ConvertToJSON(CombineObjects(Me.Parameters, pBody))
                 Else
                     Body = RestHelpers.ConvertToJSON(pBody)
                 End If
-            End If
-        End Select
+            End Select
+        End If
     End If
 End Property
 
@@ -200,7 +207,9 @@ End Property
 
 Public Property Get FormatName() As String
     Select Case Me.Format
-    Case Else
+    Case AvailableFormats.formurlencoded
+        FormatName = "form-urlencoded"
+    Case AvailableFormats.json
         FormatName = "json"
     End Select
 End Property
@@ -210,12 +219,10 @@ Public Property Get ContentType() As String
         ContentType = pContentType
     Else
         Select Case Me.Format
-        Case Else
-            If Me.Method <> httpGET And Me.Parameters.count > 0 Then
-                ContentType = "application/x-www-form-urlencoded;charset=UTF-8"
-            Else
-                ContentType = "application/json"
-            End If
+        Case AvailableFormats.formurlencoded
+            ContentType = "application/x-www-form-urlencoded;charset=UTF-8"
+        Case AvailableFormats.json
+            ContentType = "application/json"
         End Select
     End If
 End Property