Merge pull request #26 from timhall/response-headers

Include response headers with response

Author: timhall

specs/Excel-REST - Specs.xlsm

@@ -107,7 +107,29 @@ Public Function Specs() As SpecSuite
             .Expect(BodyToString).ToEqual "Howdy!"
         End If
     End With
-
+    
+    With Specs.It("should include headers in response")
+        Set Request = New RestRequest
+        Request.Resource = "cookie"
+        
+        Client.ExecuteAsync Request, SimpleCallback
+        Wait WaitTime
+        .Expect(AsyncResponse).ToBeDefined
+        If Not AsyncResponse Is Nothing Then
+            .Expect(AsyncResponse.Headers.count).ToBeGTE 5
+        
+            Dim Header As Dictionary
+            Dim NumCookies As Integer
+            For Each Header In AsyncResponse.Headers
+                If Header("key") = "Set-Cookie" Then
+                    NumCookies = NumCookies + 1
+                End If
+            Next Header
+            
+            .Expect(NumCookies).ToEqual 5
+        End If
+    End With
+    
     With Specs.It("should include cookies in response")
         Set Request = New RestRequest
         Request.Resource = "cookie"

specs/RestClientAsyncSpecs.bas

@@ -175,6 +175,24 @@ Public Function Specs() As SpecSuite
 
         .Expect(BodyToString).ToEqual "Howdy!"
     End With
+    
+    With Specs.It("should include headers in response")
+        Set Request = New RestRequest
+        Request.Resource = "cookie"
+        
+        Set Response = Client.Execute(Request)
+        .Expect(Response.Headers.count).ToBeGTE 5
+        
+        Dim Header As Dictionary
+        Dim NumCookies As Integer
+        For Each Header In Response.Headers
+            If Header("key") = "Set-Cookie" Then
+                NumCookies = NumCookies + 1
+            End If
+        Next Header
+        
+        .Expect(NumCookies).ToEqual 5
+    End With
 
     With Specs.It("should include cookies in response")
         Set Request = New RestRequest

specs/RestClientSpecs.bas

@@ -173,7 +173,8 @@ Public Function Specs() As SpecSuite
     End With
 
     With Specs.It("should extract cookies from response headers")
-        Set Cookies = RestHelpers.ExtractCookiesFromResponseHeaders(ResponseHeaders)
+        Set Headers = RestHelpers.ExtractHeadersFromResponseHeaders(ResponseHeaders)
+        Set Cookies = RestHelpers.ExtractCookiesFromHeaders(Headers)
         .Expect(Cookies.count).ToEqual 3
         .Expect(Cookies("unsigned-cookie")).ToEqual "simple-cookie"
         .Expect(Cookies("duplicate-cookie")).ToEqual "B"

specs/RestHelpersSpecs.bas

@@ -419,8 +419,11 @@ Public Function CreateResponseFromHttp(ByRef Http As Object, Optional Format As
         Set CreateResponseFromHttp.Data = RestHelpers.ParseJSON(Http.ResponseText)
     End Select
 
+    ' Extract headers
+    Set CreateResponseFromHttp.Headers = ExtractHeadersFromResponseHeaders(Http.getAllResponseHeaders)
+    
     ' Extract cookies
-    Set CreateResponseFromHttp.Cookies = ExtractCookiesFromResponseHeaders(Http.getAllResponseHeaders)
+    Set CreateResponseFromHttp.Cookies = ExtractCookiesFromHeaders(CreateResponseFromHttp.Headers)
 End Function
 
 ''
@@ -443,15 +446,13 @@ End Function
 ' @return {Dictionary} Cookies
 ' --------------------------------------------- '
 
-Public Function ExtractCookiesFromResponseHeaders(ResponseHeaders As String) As Dictionary
+Public Function ExtractCookiesFromHeaders(Headers As Collection) As Dictionary
     Dim Cookies As New Dictionary
     Dim Cookie As String
     Dim Key As String
     Dim Value As String
-    Dim Headers As Collection
     Dim Header As Dictionary
 
-    Set Headers = ExtractHeadersFromResponseHeaders(ResponseHeaders)
     For Each Header In Headers
         If Header("key") = "Set-Cookie" Then
             Cookie = Header("value")
@@ -470,7 +471,7 @@ Public Function ExtractCookiesFromResponseHeaders(ResponseHeaders As String) As
         End If
     Next Header
 
-    Set ExtractCookiesFromResponseHeaders = Cookies
+    Set ExtractCookiesFromHeaders = Cookies
 End Function
 
 ''

src/RestHelpers.bas

@@ -27,9 +27,11 @@ Public StatusDescription As String
 Public Content As String
 Public Data As Variant
 Public Body As Variant
+Public Headers As Collection
 Public Cookies As Dictionary
 
 Private Sub Class_Initialize()
     Body = Array()
+    Set Headers = New Collection
     Set Cookies = New Dictionary
 End Sub