Add SetHeader to WebRequest (Fixes #91)

Author: timhall

authenticators/DigestAuthenticator.cls

@@ -81,7 +81,7 @@ End Sub
 Private Sub IWebAuthenticator_BeforeExecute(ByVal Client As WebClient, ByRef Request As WebRequest)
     If Me.IsAuthenticated Then
         Me.RequestCount = Me.RequestCount + 1
-        Request.AddHeader "Authorization", CreateHeader(Client, Request)
+        Request.SetHeader "Authorization", CreateHeader(Client, Request)
     End If
 End Sub
 
@@ -97,7 +97,7 @@ Private Sub IWebAuthenticator_AfterExecute(ByVal Client As WebClient, ByVal Requ
         WebHelpers.LogDebug "Extract Authenticate and retry 401 request " & Client.GetFullUrl(Request), "Digest.AfterExecute"
         ExtractAuthenticateInformation Response
 
-        Request.AddHeader "Authorization", CreateHeader(Client, Request)
+        Request.SetHeader "Authorization", CreateHeader(Client, Request)
         Response.Update Client.Execute(Request)
     End If
 End Sub

authenticators/GoogleAuthenticator.cls

@@ -242,7 +242,7 @@ Private Sub IWebAuthenticator_BeforeExecute(ByVal Client As WebClient, ByRef Req
             Me.Token = Me.GetToken(Client)
         End If
 
-        Request.AddHeader "Authorization", "Bearer " & Me.Token
+        Request.SetHeader "Authorization", "Bearer " & Me.Token
     End If
 End Sub
 

authenticators/HttpBasicAuthenticator.cls

@@ -57,7 +57,7 @@ End Sub
 ' @param in|out {WebRequest} Request The request about to be executed
 ''
 Private Sub IWebAuthenticator_BeforeExecute(ByVal Client As WebClient, ByRef Request As WebRequest)
-    Request.AddHeader "Authorization", "Basic " & WebHelpers.Base64Encode(Me.Username & ":" & Me.Password)
+    Request.SetHeader "Authorization", "Basic " & WebHelpers.Base64Encode(Me.Username & ":" & Me.Password)
 End Sub
 
 ''

authenticators/OAuth1Authenticator.cls

@@ -70,7 +70,7 @@ End Sub
 ''
 Private Sub IWebAuthenticator_BeforeExecute(ByVal Client As WebClient, ByRef Request As WebRequest)
     ' Add authorization header to request
-    Request.AddHeader "Authorization", CreateHeader(Client, Request)
+    Request.SetHeader "Authorization", CreateHeader(Client, Request)
 End Sub
 
 ''

authenticators/OAuth2Authenticator.cls

@@ -65,7 +65,7 @@ Private Sub IWebAuthenticator_BeforeExecute(ByVal Client As WebClient, ByRef Req
         Me.Token = Me.GetToken(Client)
     End If
 
-    Request.AddHeader "Authorization", "Bearer " & Me.Token
+    Request.SetHeader "Authorization", "Bearer " & Me.Token
 End Sub
 
 ''

authenticators/TwitterAuthenticator.cls

@@ -68,7 +68,7 @@ Private Sub IWebAuthenticator_BeforeExecute(ByVal Client As WebClient, ByRef Req
         Me.Token = Me.GetToken(Client)
     End If
 
-    Request.AddHeader "Authorization", "Bearer " & Me.Token
+    Request.SetHeader "Authorization", "Bearer " & Me.Token
 End Sub
 
 ''
@@ -129,7 +129,7 @@ Public Function GetToken(auth_Client As WebClient) As String
     auth_Request.RequestFormat = WebFormat.FormUrlEncoded
     auth_Request.ResponseFormat = WebFormat.Json
 
-    auth_Request.AddHeader "Authorization", _
+    auth_Request.SetHeader "Authorization", _
         "Basic " & WebHelpers.Base64Encode(Me.ConsumerKey & ":" & Me.ConsumerSecret)
     auth_Request.AddBodyParameter "grant_type", "client_credentials"
 

specs/Specs_WebRequest.bas

@@ -337,6 +337,21 @@ Public Function Specs() As SpecSuite
         .Expect(Request.Headers(2)("Value")).ToEqual "header 2"
     End With
 
+    ' SetHeader
+    ' --------------------------------------------- '
+    With Specs.It("should SetHeader")
+        Set Request = New WebRequest
+        
+        Request.AddHeader "A", "add"
+        
+        Request.SetHeader "A", "set"
+        Request.SetHeader "B", "header"
+        
+        .Expect(Request.Headers.Count).ToEqual 2
+        .Expect(Request.Headers(1)("Value")).ToEqual "set"
+        .Expect(Request.Headers(2)("Key")).ToEqual "B"
+    End With
+    
     ' AddQuerystringParam
     ' --------------------------------------------- '
     With Specs.It("should AddQuerystringParam")

src/WebHelpers.bas

@@ -1244,7 +1244,9 @@ Public Sub AddOrReplaceInKeyValues(KeyValues As Collection, Key As Variant, Valu
             ' Replace existing
             KeyValues.Remove web_Index
 
-            If web_Index > KeyValues.Count Then
+            If KeyValues.Count = 0 Then
+                KeyValues.Add web_NewKeyValue
+            ElseIf web_Index > KeyValues.Count Then
                 KeyValues.Add web_NewKeyValue, After:=web_Index - 1
             Else
                 KeyValues.Add web_NewKeyValue, Before:=web_Index

src/WebRequest.cls

@@ -507,14 +507,14 @@ End Property
 ' ============================================= '
 
 ''
-' Add header to be sent with request
+' Add header to be sent with request.
 '
 ' @example
 ' ```VB.net
 ' Dim Request As New WebRequest
 ' Request.AddHeader "Authentication", "Bearer ..."
 '
-' ' -> (Header) Authentication: Bearer ...
+' ' -> (Header) Authorization: Bearer ...
 ' ```
 '
 ' @method AddHeader
@@ -525,6 +525,35 @@ Public Sub AddHeader(Key As String, Value As Variant)
     Me.Headers.Add WebHelpers.CreateKeyValue(Key, Value)
 End Sub
 
+''
+' Add/replace header to be sent with request.
+' `SetHeader` should be used for headers that can only be included once with a request
+' (e.g. Authorization, Content-Type, etc.).
+'
+' @example
+' ```VB.net
+' Dim Request As New WebRequest
+' Request.AddHeader "Authorization", "A..."
+' Request.AddHeader "Authorization", "B..."
+'
+' ' -> Headers:
+' '    Authorization: A...
+' '    Authorization: B...
+'
+' Request.SetHeader "Authorization", "C..."
+'
+' ' -> Headers:
+' '    Authorization: C...
+' ```
+'
+' @method SetHeader
+' @param {String} Key
+' @param {Variant} Value
+''
+Public Sub SetHeader(Key As String, Value As Variant)
+    WebHelpers.AddOrReplaceInKeyValues Me.Headers, Key, Value
+End Sub
+
 ''
 ' Url Segments are used to easily add dynamic values to `Resource`.
 ' Create a Url Segement in `Resource` with curly brackets and then
@@ -651,10 +680,10 @@ End Sub
 ''
 Public Sub Prepare()
     ' Add/replace general headers for request
-    WebHelpers.AddOrReplaceInKeyValues Me.Headers, "User-Agent", WebUserAgent
-    WebHelpers.AddOrReplaceInKeyValues Me.Headers, "Content-Type", Me.ContentType
-    WebHelpers.AddOrReplaceInKeyValues Me.Headers, "Accept", Me.Accept
-    WebHelpers.AddOrReplaceInKeyValues Me.Headers, "Content-Length", VBA.CStr(Me.ContentLength)
+    SetHeader "User-Agent", WebUserAgent
+    SetHeader "Content-Type", Me.ContentType
+    SetHeader "Accept", Me.Accept
+    SetHeader "Content-Length", VBA.CStr(Me.ContentLength)
 End Sub
 
 ''