Merge pull request #27 from timhall/formurlencoded

timhall · timhall · commit 1dbafac9b6b5 · 2014-02-22T11:21:30.000-05:00
Add form-urlencoded
diff --git a/specs/Excel-REST - Specs.xlsm b/specs/Excel-REST - Specs.xlsm
diff --git a/specs/RestHelpersSpecs.bas b/specs/RestHelpersSpecs.bas
@@ -18,11 +18,12 @@ Public Function Specs() As SpecSuite
     Dim Parsed As Object
     Dim Obj As Object
     Dim Coll As Collection
-    Dim A As Object
-    Dim B As Object
-    Dim Combined As Object
+    Dim A As Dictionary
+    Dim B As Dictionary
+    Dim Combined As Dictionary
     Dim Whitelist As Variant
-    Dim Filtered As Object
+    Dim Filtered As Dictionary
+    Dim Encoded As String
     Dim ResponseHeaders As String
     Dim Headers As Collection
     Dim Cookies As Dictionary
@@ -107,10 +108,14 @@ Public Function Specs() As SpecSuite
     
     With Specs.It("should url encode values")
         .Expect(RestHelpers.URLEncode(" !""#$%&'")).ToEqual "%20%21%22%23%24%25%26%27"
+        .Expect(RestHelpers.URLEncode("A + B")).ToEqual "A%20%2B%20B"
+        .Expect(RestHelpers.URLEncode("A + B", True)).ToEqual "A+%2B+B"
     End With
     
     With Specs.It("should decode url values")
         .Expect(RestHelpers.URLDecode("+%20%21%22%23%24%25%26%27")).ToEqual "  !""#$%&'"
+        .Expect(RestHelpers.URLDecode("A%20%2B%20B")).ToEqual "A + B"
+        .Expect(RestHelpers.URLDecode("A+%2B+B")).ToEqual "A + B"
     End With
     
     With Specs.It("should join url with /")
@@ -155,6 +160,29 @@ Public Function Specs() As SpecSuite
         .Expect(Filtered.Exists("dangerous")).ToEqual False
     End With
     
+    With Specs.It("should combine and convert parameters to url-encoded string")
+        Set A = New Dictionary
+        Set B = New Dictionary
+        
+        A.Add "a", 1
+        A.Add "b", 3.14
+        B.Add "b", 4.14
+        B.Add "c", "Howdy!"
+        B.Add "d & e", "A + B"
+        
+        Encoded = RestHelpers.DictionariesToUrlEncodedString(A, B)
+        .Expect(Encoded).ToEqual "a=1&b=4.14&c=Howdy%21&d+%26+e=A+%2B+B"
+    End With
+    
+    With Specs.It("should parse url-encoded string")
+        Set Parsed = RestHelpers.ParseUrlEncoded("a=1&b=3.14&c=Howdy%21&d+%26+e=A+%2B+B")
+        
+        .Expect(Parsed("a")).ToEqual "1"
+        .Expect(Parsed("b")).ToEqual "3.14"
+        .Expect(Parsed("c")).ToEqual "Howdy!"
+        .Expect(Parsed("d & e")).ToEqual "A + B"
+    End With
+    
     With Specs.It("should extract headers from response headers")
         ResponseHeaders = "Connection: keep -alive" & vbCrLf & _
             "Date: Tue, 18 Feb 2014 15:00:26 GMT" & vbCrLf & _
diff --git a/specs/RestRequestSpecs.bas b/specs/RestRequestSpecs.bas
@@ -97,7 +97,7 @@ Public Function Specs() As SpecSuite
         Request.AddParameter "A B", " !""#$%&'"
         Request.Method = httpGET
         
-        .Expect(Request.FormattedResource).ToEqual "?A%20B=%20%21%22%23%24%25%26%27"
+        .Expect(Request.FormattedResource).ToEqual "?A+B=+%21%22%23%24%25%26%27"
     End With
     
     With Specs.It("should include cachebreaker in FormattedResource by default")
@@ -144,7 +144,7 @@ Public Function Specs() As SpecSuite
         .Expect(Request.Body).ToEqual "{""A"":123}"
         
         Request.Method = httpPOST
-        .Expect(Request.Body).ToEqual "{""A"":123,""b"":456}"
+        .Expect(Request.Body).ToEqual "{""b"":456,""A"":123}"
     End With
     
     With Specs.It("should use given client base url for FullUrl only if BaseUrl isn't already set")
@@ -175,25 +175,20 @@ Public Function Specs() As SpecSuite
         .Expect(Request.FullUrl("facebook.com/api/")).ToEqual "https://facebook.com/api/status"
     End With
     
-    With Specs.It("should user form-urlencoded content type for non-GET requests with parameters")
+    With Specs.It("should include content-type based on specified format")
         Set Request = New RestRequest
         
         Request.AddParameter "A", 123
         Request.Method = httpPOST
         
-        .Expect(Request.ContentType).ToEqual "application/x-www-form-urlencoded;charset=UTF-8"
-    End With
-    
-    With Specs.It("should use application/json for GET requests with parameters and requests without parameters")
-        Set Request = New RestRequest
-        
-        Request.Method = httpPOST
+        ' JSON by default
         .Expect(Request.ContentType).ToEqual "application/json"
         
-        Request.AddParameter "A", 123
-        Request.Method = httpGET
-        
+        Request.Format = json
         .Expect(Request.ContentType).ToEqual "application/json"
+        
+        Request.Format = formurlencoded
+        .Expect(Request.ContentType).ToEqual "application/x-www-form-urlencoded;charset=UTF-8"
     End With
     
     With Specs.It("should override existing headers, url segments, and parameters")
@@ -260,6 +255,23 @@ Public Function Specs() As SpecSuite
         .Expect(Request.Body).ToEqual "Howdy!"
     End With
     
+    With Specs.It("should format body based on set format")
+        Set Request = New RestRequest
+        Request.Method = httpPOST
+        
+        Request.AddParameter "A", 123
+        Request.AddParameter "B", "Howdy!"
+        
+        ' JSON by default
+        .Expect(Request.Body).ToEqual "{""A"":123,""B"":""Howdy!""}"
+        
+        Request.Format = json
+        .Expect(Request.Body).ToEqual "{""A"":123,""B"":""Howdy!""}"
+        
+        Request.Format = formurlencoded
+        .Expect(Request.Body).ToEqual "A=123&B=Howdy%21"
+    End With
+    
     InlineRunner.RunSuite Specs
 End Function
 
diff --git a/src/RestHelpers.bas b/src/RestHelpers.bas
@@ -259,6 +259,69 @@ Public Function FilterObject(ByVal Original As Dictionary, Whitelist As Variant)
     Set FilterObject = Filtered
 End Function
 
+''
+' Convert dictionaries to url encoded string
+'
+' @param {Dictionary...} Dictionaries
+' @return {String} UrlEncoded string (e.g. a=123&b=456&...)
+' --------------------------------------------- '
+
+Public Function DictionariesToUrlEncodedString(ParamArray Dictionaries() As Variant) As String
+    Dim Encoded As String
+    Dim i As Integer
+    Dim Combined As Dictionary
+    Dim ParameterKey As Variant
+    
+    Set Combined = Dictionaries(LBound(Dictionaries))
+    For i = LBound(Dictionaries) + 1 To UBound(Dictionaries)
+        Set Combined = CombineObjects(Combined, Dictionaries(i))
+    Next i
+    
+    If Not Combined Is Nothing Then
+        For Each ParameterKey In Combined.keys()
+            If Len(Encoded) > 0 Then: Encoded = Encoded & "&"
+            Encoded = Encoded & URLEncode(ParameterKey, True) & "=" & URLEncode(Combined(ParameterKey), True)
+        Next ParameterKey
+    End If
+    
+    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
 '
@@ -415,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
     
diff --git a/src/RestRequest.cls b/src/RestRequest.cls
@@ -49,6 +49,7 @@ Public Enum AvailableMethods
 End Enum
 Public Enum AvailableFormats
     json
+    formurlencoded
 End Enum
 
 ' --------------------------------------------- '
@@ -108,7 +109,6 @@ End Property
 
 Public Property Get FormattedResource() As String
     Dim segment As Variant
-    Dim parameterKey As Variant
     
     FormattedResource = Me.Resource
     
@@ -131,45 +131,47 @@ Public Property Get FormattedResource() As String
         If (Me.Parameters.count > 0 And Me.Method = httpGET) Or Me.QuerystringParams.count > 0 Then
             If InStr(FormattedResource, "?") <= 0 Then
                 FormattedResource = FormattedResource & "?"
+            Else
+                FormattedResource = FormattedResource & "&"
             End If
             
             ' Only load parameters to querystring if GET request (otherwise they are added to the body)
             If Me.Method = httpGET Then
-                For Each parameterKey In Me.Parameters.keys()
-                    If Right(FormattedResource, 1) <> "?" Then: FormattedResource = FormattedResource & "&"
-                    FormattedResource = FormattedResource & URLEncode(parameterKey) & "=" & URLEncode(Me.Parameters(parameterKey))
-                Next parameterKey
+                FormattedResource = FormattedResource & RestHelpers.DictionariesToUrlEncodedString(Me.Parameters, Me.QuerystringParams)
+            Else
+                FormattedResource = FormattedResource & RestHelpers.DictionariesToUrlEncodedString(Me.QuerystringParams)
             End If
-            
-            For Each parameterKey In Me.QuerystringParams.keys()
-                If Right(FormattedResource, 1) <> "?" Then: FormattedResource = FormattedResource & "&"
-                FormattedResource = FormattedResource & URLEncode(parameterKey) & "=" & URLEncode(Me.QuerystringParams(parameterKey))
-            Next parameterKey
         End If
     End If
 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
 
@@ -205,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
@@ -215,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
