Added HEAD and GetRedirectLocation

Fixes #143
Closes #154

Author: zippy1981

specs/Specs_WebClient.bas

@@ -25,7 +25,7 @@ Public Function Specs() As SpecSuite
 
     Client.BaseUrl = HttpbinBaseUrl
     Client.TimeoutMs = 5000
-    
+
     ' --------------------------------------------- '
     ' Properties
     ' --------------------------------------------- '
@@ -46,42 +46,46 @@ Public Function Specs() As SpecSuite
 
     With Specs.It("[Windows-only] Insecure should set options in WinHttpRequest")
 #If Mac Then
-    ' (Windows-only)
-    .Expect(True).ToEqual True
+        ' (Windows-only)
+        .Expect(True).ToEqual True
 #Else
-    Dim Http As Object
-    Set Request = New WebRequest
-    
-    ' WinHttpRequestOption_EnableCertificateRevocationCheck = 18
-    ' WinHttpRequestOption_SslErrorIgnoreFlags = 4
-    
-    Set Http = Client.PrepareHttpRequest(Request)
-    .Expect(Http.Option(18)).ToEqual True
-    .Expect(Http.Option(4)).ToEqual 0
-    
-    Client.Insecure = True
-    
-    Set Http = Client.PrepareHttpRequest(Request)
-    .Expect(Http.Option(18)).ToEqual False
-    .Expect(Http.Option(4)).ToEqual 13056
+        Dim Http As Object
+        Set Request = New WebRequest
+        
+        ' WinHttpRequestOption_EnableCertificateRevocationCheck = 18
+        ' WinHttpRequestOption_SslErrorIgnoreFlags = 4
+        
+        Set Http = Client.PrepareHttpRequest(Request)
+        .Expect(Http.Option(18)).ToEqual True
+        .Expect(Http.Option(4)).ToEqual 0
+        
+        Client.Insecure = True
+        
+        Set Http = Client.PrepareHttpRequest(Request)
+        .Expect(Http.Option(18)).ToEqual False
+        .Expect(Http.Option(4)).ToEqual 13056
 #End If
+
+        Client.Insecure = False
     End With
 
     With Specs.It("[Mac-only] Insecure should set --insecure flag in cURL")
 #If Mac Then
-    Set Request = New WebRequest
-    
-    Curl = Client.PrepareCurlRequest(Request)
-    .Expect(Curl).ToNotMatch "--insecure"
-    
-    Client.Insecure = True
-    
-    Curl = Client.PrepareCurlRequest(Request)
-    .Expect(Curl).ToMatch "--insecure"
+        Set Request = New WebRequest
+        
+        Curl = Client.PrepareCurlRequest(Request)
+        .Expect(Curl).ToNotMatch "--insecure"
+        
+        Client.Insecure = True
+        
+        Curl = Client.PrepareCurlRequest(Request)
+        .Expect(Curl).ToMatch "--insecure"
 #Else
-    ' (Mac-only)
-    .Expect(True).ToEqual True
+        ' (Mac-only)
+        .Expect(True).ToEqual True
 #End If
+
+        Client.Insecure = False
     End With
 
     ' ============================================= '
@@ -113,6 +117,46 @@ Public Function Specs() As SpecSuite
         .Expect(Response.Data("headers")("Cookie")).ToMatch "abc=123"
         .Expect(Response.Data("form")("message")).ToEqual "Howdy!"
     End With
+
+    With Specs.It("Execute should work with each method")
+        Set Request = New WebRequest
+        
+        Request.Method = WebMethod.HttpGet
+        Request.Resource = "get"
+        
+        Set Response = Client.Execute(Request)
+        .Expect(Response.StatusCode).ToEqual WebStatusCode.Ok
+        
+        Request.Method = WebMethod.HttpPost
+        Request.Resource = "post"
+        
+        Set Response = Client.Execute(Request)
+        .Expect(Response.StatusCode).ToEqual WebStatusCode.Ok
+        
+        Request.Method = WebMethod.HttpPatch
+        Request.Resource = "patch"
+        
+        Set Response = Client.Execute(Request)
+        .Expect(Response.StatusCode).ToEqual WebStatusCode.Ok
+        
+        Request.Method = WebMethod.HttpPut
+        Request.Resource = "put"
+        
+        Set Response = Client.Execute(Request)
+        .Expect(Response.StatusCode).ToEqual WebStatusCode.Ok
+        
+        Request.Method = WebMethod.HttpDelete
+        Request.Resource = "delete"
+        
+        Set Response = Client.Execute(Request)
+        .Expect(Response.StatusCode).ToEqual WebStatusCode.Ok
+        
+        Request.Method = WebMethod.HttpHead
+        Request.Resource = "get"
+        
+        Set Response = Client.Execute(Request)
+        .Expect(Response.StatusCode).ToEqual WebStatusCode.Ok
+    End With
 
     ' GetJson
     ' --------------------------------------------- '
@@ -198,6 +242,18 @@ Public Function Specs() As SpecSuite
 
     ' SetProxy
 
+    ' GetRedirectLocation
+    ' --------------------------------------------- '
+    With Specs.It("should GetRedirectLocation of Request")
+        Set Request = New WebRequest
+        Request.Resource = "redirect/1"
+        
+        Dim RedirectLocation As String
+        RedirectLocation = Client.GetRedirectLocation(Request)
+        
+        .Expect(RedirectLocation).ToEqual "/get"
+    End With
+    
     ' GetFullUrl
     ' --------------------------------------------- '
     With Specs.It("should GetFullUrl of Request")

src/WebClient.cls

@@ -449,6 +449,26 @@ Public Sub SetProxy(ProxyServer As String, _
     Me.ProxyBypassList = BypassList
 End Sub
 
+''
+' If the given Request is a redirect (301, 302, or 307),
+' then get value of the "Location" header
+'
+' @param {WebRequest} Request
+' @return {String}
+''
+Public Function GetRedirectLocation(Request As WebRequest) As String
+    Dim RedirectRequest As WebRequest
+    Set RedirectRequest = Request.Clone
+    RedirectRequest.Method = WebMethod.HttpHead
+    
+    Dim Response As WebResponse
+    Set Response = Me.Execute(RedirectRequest)
+    
+    If Response.StatusCode = 301 Or Response.StatusCode = 302 Or Response.StatusCode = 307 Then
+        GetRedirectLocation = WebHelpers.FindInKeyValues(Response.Headers, "Location")
+    End If
+End Function
+
 ''
 ' Get full url by joining given `WebRequest.FormattedResource` and `BaseUrl`.
 '

src/WebHelpers.bas

@@ -304,6 +304,7 @@ Public Enum WebMethod
     HttpPut = 2
     HttpDelete = 3
     HttpPatch = 4
+    HttpHead = 5
 End Enum
 
 ''
@@ -1404,6 +1405,8 @@ Public Function MethodToName(Method As WebMethod) As String
         MethodToName = "POST"
     Case WebMethod.HttpGet
         MethodToName = "GET"
+    Case WebMethod.HttpHead
+        MethodToName = "HEAD"
     End Select
 End Function