Merge pull request #39 from timhall/array-body

Allow Array and Collection for Body values

Author: timhall

Excel-REST - Blank.xlsm

@@ -129,7 +129,7 @@ End Function
 ' @return {RestResponse} Response
 ' --------------------------------------------- '
 
-Public Function PostJSON(Url As String, Body As Dictionary, Optional Options As Dictionary) As RestResponse
+Public Function PostJSON(Url As String, Body As Variant, Optional Options As Dictionary) As RestResponse
     Dim Request As RestRequest
     Set Request = RestHelpers.CreateRequestFromOptions(Options)
     Request.Resource = Url

specs/Excel-REST - Specs.xlsm

@@ -121,7 +121,7 @@ End Function
 ' @return {String}
 ' --------------------------------------------- '
 
-Public Function ConvertToJSON(Obj As Object) As String
+Public Function ConvertToJSON(Obj As Variant) As String
     ConvertToJSON = json_toString(Obj)
 End Function
 
@@ -296,14 +296,32 @@ Public Function FilterObject(ByVal Original As Dictionary, Whitelist As Variant)
     Set FilterObject = Filtered
 End Function
 
+Public Function IsArray(Obj As Variant) As Boolean
+    If Not IsEmpty(Obj) Then
+        If VarType(Obj) = vbObject Then
+            If TypeOf Obj Is Collection Then
+                IsArray = True
+            End If
+        ElseIf VarType(Obj) = vbArray Or VarType(Obj) = 8204 Then
+            ' VarType = 8204 seems to arise from Array(...) constructor
+            IsArray = True
+        End If
+    End If
+End Function
+
 ''
 ' Convert dictionary to url encoded string
 '
-' @param {Dictionary} Obj
+' @param {Variant} Obj
 ' @return {String} UrlEncoded string (e.g. a=123&b=456&...)
 ' --------------------------------------------- '
 
-Public Function ConvertToUrlEncoded(Obj As Dictionary) As String
+Public Function ConvertToUrlEncoded(Obj As Variant) As String
+    If IsArray(Obj) Then
+        ' TODO Handle arrays and collections
+        Err.Raise vbObjectError + 1, "RestHelpers.ConvertToUrlEncoded", "Arrays are not currently supported by ConvertToUrlEncoded"
+    End If
+    
     ConvertToUrlEncoded = DictionariesToUrlEncodedString(Obj)
 End Function
 Public Function DictionariesToUrlEncodedString(ParamArray Dictionaries() As Variant) As String

src/RestClient.cls

@@ -29,7 +29,7 @@ Private pParameters As Dictionary
 Private pQuerystringParams As Dictionary
 Private pUrlSegments As Dictionary
 Private pCookies As Dictionary
-Private pBody As Dictionary
+Private pBody As Variant
 Private pBodyString As String
 Private pContentType As String
 Private pContentLength As Long
@@ -145,26 +145,42 @@ 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
+    If Not IsEmpty(pBody) Or pBodyString <> "" Or (Me.Parameters.count > 0 And Me.Method <> httpGET) Then
         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
+            If RestHelpers.IsArray(pBody) And Me.Parameters.count > 0 And Me.Method <> httpGET Then
+                Err.Raise vbObjectError + 1, "RestRequest.Body", "Unable to combine body array and parameters"
+            End If
+        
             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)
+                    If Me.Parameters.count > 0 And Not IsEmpty(pBody) Then
+                        ' Combine defined body and parameters and convert to JSON
+                        Body = RestHelpers.ConvertToUrlEncoded(CombineObjects(Me.Parameters, pBody))
+                    ElseIf Me.Parameters.count > 0 Then
+                        Body = RestHelpers.ConvertToUrlEncoded(Me.Parameters)
+                    Else
+                        Body = RestHelpers.ConvertToUrlEncoded(pBody)
+                    End If
                 Else
-                    Body = RestHelpers.DictionariesToUrlEncodedString(pBody)
+                    Body = RestHelpers.ConvertToUrlEncoded(pBody)
                 End If
             Case AvailableFormats.json
                 If Me.Method <> httpGET Then
-                    ' Combine defined body and parameters and convert to JSON
-                    Body = RestHelpers.ConvertToJSON(CombineObjects(Me.Parameters, pBody))
+                    If Me.Parameters.count > 0 And Not IsEmpty(pBody) Then
+                        ' Combine defined body and parameters and convert to JSON
+                        Body = RestHelpers.ConvertToJSON(CombineObjects(Me.Parameters, pBody))
+                    ElseIf Me.Parameters.count > 0 Then
+                        Body = RestHelpers.ConvertToJSON(Me.Parameters)
+                    Else
+                        Body = RestHelpers.ConvertToJSON(pBody)
+                    End If
                 Else
                     Body = RestHelpers.ConvertToJSON(pBody)
                 End If
@@ -343,11 +359,17 @@ End Sub
 ''
 ' Add body to request
 '
-' @param {Dictionary} bodyVal Object to add to body (will be converted to string)
+' @param {Variant} bodyVal Object/Collection/Array to add to body (will be converted to string)
 ' --------------------------------------------- '
 
-Public Function AddBody(BodyVal As Dictionary)
-    Set pBody = BodyVal
+Public Function AddBody(BodyVal As Variant)
+    If VarType(BodyVal) = vbObject Then
+        Set pBody = BodyVal
+    ElseIf RestHelpers.IsArray(BodyVal) Then
+        pBody = BodyVal
+    Else
+        pBodyString = BodyVal
+    End If
 End Function
 
 ''