Merge pull request #20 from timhall/execute-refactor

timhall · timhall · commit db6b29a0a5a9 · 2014-02-15T12:57:00.000-05:00
Refactor Execute and ExecuteAsync
diff --git a/build/export.vbs b/build/export.vbs
@@ -18,6 +18,9 @@ Set Args = Wscript.Arguments
 If Args.Length > 0 Then
   WBPath = Args(0)
   OutputPath = Args(1)
+Else
+  WBPath = "specs\Excel-REST - Specs.xlsm"
+  OutputPath = "src\"
 End If
 
 ' Setup modules to export
diff --git a/specs/Excel-REST - Specs.xlsm b/specs/Excel-REST - Specs.xlsm
diff --git a/src/RestClient.cls b/src/RestClient.cls
@@ -46,37 +46,19 @@ Public ProxyBypassList As Variant
 ' --------------------------------------------- '
 
 Public Function Execute(Request As RestRequest) As RestResponse
-    Dim Response As RestResponse
-    Dim Http As Object
-    Dim HeaderKey As Variant
-    
     On Error GoTo ErrorHandling
-    Set Http = CreateObject("MSXML2.ServerXMLHTTP.6.0")
-    HttpSetup Http, Request, False
-    
-    ' Send the request
-    Http.send Request.Body
+    Dim Http As Object
     
-    ' Handle response
-    Set Response = Request.CreateResponseFromHttp(Http)
+    Set Http = HttpSetup(Request, False)
+    Set Execute = RestHelpers.ExecuteRequest(Http, Request)
     
 ErrorHandling:
 
     If Not Http Is Nothing Then Set Http = Nothing
-    
     If Err.Number <> 0 Then
-        If InStr(Err.Description, "The operation timed out") > 0 Then
-            ' Return 408
-            Set Response = Request.CreateResponse(StatusCodes.RequestTimeout, "Request Timeout")
-            Err.Clear
-        Else
-            ' Rethrow error
-            Err.Raise Err.Number, Description:=Err.Description
-        End If
+        ' Rethrow error
+        Err.Raise Err.Number, Description:=Err.Description
     End If
-    
-    Set Execute = Response
-    
 End Function
 
 ''
@@ -89,35 +71,20 @@ End Function
 ' --------------------------------------------- '
 
 Public Function ExecuteAsync(Request As RestRequest, Callback As String, Optional ByVal CallbackArgs As Variant) As Boolean
-    Dim Response As New RestResponse
-    Dim Http As Object
-    
     On Error GoTo ErrorHandling
+    Dim Http As Object
     
     ' Setup the request
-    Set Http = CreateObject("MSXML2.ServerXMLHTTP.6.0")
-    HttpSetup Http, Request, True
-    Request.Callback = Callback
-    Request.CallbackArgs = CallbackArgs
-    
-    ' Send the request
-    Request.StartTimeoutTimer Me.TimeoutMS
-    Http.send Request.Body
-    
-    ' Clean up and return
+    Set Http = HttpSetup(Request, True)
+    RestHelpers.ExecuteRequestAsync Http, Request, TimeoutMS, Callback, CallbackArgs
     ExecuteAsync = True
     Exit Function
     
 ErrorHandling:
 
+    ' Close Http and rethrow error
     If Not Http Is Nothing Then Set Http = Nothing
-    If Not Response Is Nothing Then Set Response = Nothing
-    
-    If Err.Number <> 0 Then
-        ' Rethrow error
-        Err.Raise Err.Number, Description:=Err.Description
-    End If
-    
+    Err.Raise Err.Number, Description:=Err.Description
 End Function
 
 ''
@@ -142,24 +109,24 @@ End Sub
 ' Private Methods
 ' ============================================= '
 
-Private Sub HttpSetup(ByRef Http As Object, ByRef Request As RestRequest, Optional UseAsync As Boolean = False)
-    RestHelpers.PrepareHttpRequest Http, Request, Me.TimeoutMS, UseAsync
+Private Function HttpSetup(ByRef Request As RestRequest, Optional UseAsync As Boolean = False) As Object
+    Set HttpSetup = RestHelpers.PrepareHttpRequest(Request, Me.TimeoutMS, UseAsync)
     
     If Me.ProxyServer <> "" Then
-        RestHelpers.PrepareProxyForHttpRequest Http, Me.ProxyServer, Me.ProxyUsername, Me.ProxyPassword, Me.ProxyBypassList
+        RestHelpers.PrepareProxyForHttpRequest HttpSetup, Me.ProxyServer, Me.ProxyUsername, Me.ProxyPassword, Me.ProxyBypassList
     End If
     
     ' Before execute and http open hooks for authenticator
     If Not Me.Authenticator Is Nothing Then
         Me.Authenticator.BeforeExecute Request
-        Me.Authenticator.HttpOpen Http, Request, Me.BaseUrl, UseAsync
+        Me.Authenticator.HttpOpen HttpSetup, Request, Me.BaseUrl, UseAsync
     Else
         ' Nothing hooked in so open http object
-        Http.Open Request.MethodName(), Request.FullUrl(Me.BaseUrl), UseAsync
+        HttpSetup.Open Request.MethodName(), Request.FullUrl(Me.BaseUrl), UseAsync
     End If
     
-    RestHelpers.SetHeaders Http, Request
-End Sub
+    RestHelpers.SetHeaders HttpSetup, Request
+End Function
 
 Private Sub Class_Initialize()
     Me.TimeoutMS = DefaultTimeoutMS
diff --git a/src/RestClientBase.bas b/src/RestClientBase.bas
@@ -15,6 +15,8 @@ Attribute VB_Name = "RestClientBase"
 ' ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ '
 Option Explicit
 
+' > Customize with BaseUrl
+Private Const DefaultBaseUrl As String = ""
 Private Const TimeoutMS As Integer = 5000
 Private Initialized As Boolean
 
@@ -48,12 +50,13 @@ Private Sub HttpOpen(ByRef Http As Object, ByRef Request As RestRequest, BaseUrl
     Http.Open Request.MethodName(), Request.FullUrl(BaseUrl), UseAsync
 End Sub
 
-' > Customize with BaseUrl and other properties
+
 Private Sub Initialize()
-    ' BaseUrl = "https://..."
-    ' ProxyServer = "..."
-    ' ProxyUsername = "..."
-    ' ProxyPassword = "..."
+    If BaseUrl = "" Then
+        BaseUrl = DefaultBaseUrl
+    End If
+    
+    ' > Customize with any properties
     
     Initialized = True
 End Sub
@@ -70,36 +73,19 @@ End Sub
 ' --------------------------------------------- '
 
 Public Function Execute(Request As RestRequest) As RestResponse
-    Dim Response As RestResponse
-    Dim Http As Object
-    Dim HeaderKey As Variant
-    
     On Error GoTo ErrorHandling
-    Set Http = CreateObject("MSXML2.ServerXMLHTTP.6.0")
-    HttpSetup Http, Request, False
-    
-    ' Send the request
-    Http.send Request.Body
+    Dim Http As Object
     
-    ' Handle response
-    Set Response = Request.CreateResponseFromHttp(Http)
+    Set Http = HttpSetup(Request, False)
+    Set Execute = RestHelpers.ExecuteRequest(Http, Request)
     
 ErrorHandling:
 
     If Not Http Is Nothing Then Set Http = Nothing
-    
     If Err.Number <> 0 Then
-        If InStr(Err.Description, "The operation timed out") > 0 Then
-            ' Return 408
-            Set Response = Request.CreateResponse(StatusCodes.RequestTimeout, "Request Timeout")
-            Err.Clear
-        Else
-            ' Rethrow error
-            Err.Raise Err.Number, Description:=Err.Description
-        End If
+        ' Rethrow error
+        Err.Raise Err.Number, Description:=Err.Description
     End If
-    
-    Set Execute = Response
 End Function
 
 ''
@@ -112,50 +98,52 @@ End Function
 ' --------------------------------------------- '
 
 Public Function ExecuteAsync(Request As RestRequest, Callback As String, Optional ByVal CallbackArgs As Variant) As Boolean
-    Dim Response As New RestResponse
-    Dim Http As Object
-    
     On Error GoTo ErrorHandling
+    Dim Http As Object
     
     ' Setup the request
-    Set Http = CreateObject("MSXML2.ServerXMLHTTP.6.0")
-    HttpSetup Http, Request, True
-    Request.Callback = Callback
-    Request.CallbackArgs = CallbackArgs
-    
-    ' Send the request
-    Request.StartTimeoutTimer TimeoutMS
-    Http.send Request.Body
-    
-    ' Clean up and return
+    Set Http = HttpSetup(Request, True)
+    RestHelpers.ExecuteRequestAsync Http, Request, TimeoutMS, Callback, CallbackArgs
     ExecuteAsync = True
     Exit Function
     
 ErrorHandling:
 
+    ' Close Http and rethrow error
     If Not Http Is Nothing Then Set Http = Nothing
-    If Not Response Is Nothing Then Set Response = Nothing
-    
-    If Err.Number <> 0 Then
-        ' Rethrow error
-        Err.Raise Err.Number, Description:=Err.Description
-    End If
+    Err.Raise Err.Number, Description:=Err.Description
 End Function
 
-Private Sub HttpSetup(ByRef Http As Object, ByRef Request As RestRequest, Optional UseAsync As Boolean = False)
-    If Not Initialized Then: Initialize
-    
-    RestHelpers.PrepareHttpRequest Http, Request, TimeoutMS, UseAsync
+''
+' Setup proxy server
+'
+' @param {String} ProxyServer
+' @param {String} [Username=""]
+' @param {String} [Password=""]
+' @param {Variant} [BypassList]
+' --------------------------------------------- '
+
+Public Sub SetupProxy(ProxyServer As String, _
+    Optional Username As String = "", Optional Password As String = "", Optional BypassList As Variant)
     
+    ProxyServer = ProxyServer
+    ProxyUsername = ProxyUsername
+    ProxyPassword = ProxyPassword
+    BypassList = BypassList
+End Sub
+
+Private Function HttpSetup(ByRef Request As RestRequest, Optional UseAsync As Boolean = False) As Object
+    If Not Initialized Then: Initialize
     
+    Set HttpSetup = RestHelpers.PrepareHttpRequest(Request, TimeoutMS, UseAsync)
+
     If ProxyServer <> "" Then
-        RestHelpers.PrepareProxyForHttpRequest Http, ProxyServer, ProxyUsername, ProxyPassword, ProxyBypassList
+        RestHelpers.PrepareProxyForHttpRequest HttpSetup, ProxyServer, ProxyUsername, ProxyPassword, ProxyBypassList
     End If
     
     ' Before execute and http open hooks for authentication
     BeforeExecute Request
-    HttpOpen Http, Request, BaseUrl, UseAsync
+    HttpOpen HttpSetup, Request, BaseUrl, UseAsync
     
-    RestHelpers.SetHeaders Http, Request
-End Sub
-
+    RestHelpers.SetHeaders HttpSetup, Request
+End Function
diff --git a/src/RestHelpers.bas b/src/RestHelpers.bas
@@ -228,14 +228,16 @@ End Function
 ''
 ' Prepare http request for execution
 '
-' @param {Object} Http request
 ' @param {RestRequest} Request
 ' @param {Integer} TimeoutMS
 ' @param {Boolean} [UseAsync=False]
+' @return {Object} Setup http object
 ' --------------------------------------------- '
 
-Public Sub PrepareHttpRequest(ByRef Http As Object, Request As RestRequest, TimeoutMS As Integer, _
-    Optional UseAsync As Boolean = False)
+Public Function PrepareHttpRequest(Request As RestRequest, TimeoutMS As Integer, _
+    Optional UseAsync As Boolean = False) As Object
+    Dim Http As Object
+    Set Http = CreateObject("MSXML2.ServerXMLHTTP.6.0")
     
     ' Set timeouts
     Http.setTimeouts TimeoutMS, TimeoutMS, TimeoutMS, TimeoutMS
@@ -257,7 +259,9 @@ Public Sub PrepareHttpRequest(ByRef Http As Object, Request As RestRequest, Time
         Set Request.HttpRequest = Http
         Http.onreadystatechange = Request
     End If
-End Sub
+    
+    Set PrepareHttpRequest = Http
+End Function
 
 ''
 ' Set headers to http object for given request
@@ -277,9 +281,9 @@ End Sub
 ' Prepare proxy for http object
 '
 ' @param {String} ProxyServer
-' @param {Variant} [BypassList]
 ' @param {String} [Username=""]
 ' @param {String} [Password=""]
+' @param {Variant} [BypassList]
 ' --------------------------------------------- '
 
 Public Sub PrepareProxyForHttpRequest(ByRef Http As Object, ProxyServer As String, _
@@ -292,7 +296,67 @@ Public Sub PrepareProxyForHttpRequest(ByRef Http As Object, ProxyServer As Strin
             Http.SetProxyCredentials Username, Password
         End If
     End If
+End Sub
+
+''
+' Execute request synchronously
+'
+' @param {Object} Http
+' @param {RestRequest} Request The request to execute
+' @return {RestResponse} Wrapper of server response for request
+' --------------------------------------------- '
+
+Public Function ExecuteRequest(ByRef Http As Object, ByRef Request As RestRequest) As RestResponse
+    On Error GoTo ErrorHandling
+    Dim Response As RestResponse
+
+    ' Send the request and handle response
+    Http.Send Request.Body
+    Set Response = Request.CreateResponseFromHttp(Http)
+    
+ErrorHandling:
+
+    If Not Http Is Nothing Then Set Http = Nothing
+    If Err.Number <> 0 Then
+        If InStr(Err.Description, "The operation timed out") > 0 Then
+            ' Return 408
+            Set Response = Request.CreateResponse(StatusCodes.RequestTimeout, "Request Timeout")
+            Err.Clear
+        Else
+            ' Rethrow error
+            Err.Raise Err.Number, Description:=Err.Description
+        End If
+    End If
+    
+    Set ExecuteRequest = Response
+End Function
+
+''
+' Execute request asynchronously
+'
+' @param {Object} Http
+' @param {RestRequest} Request The request to execute
+' @param {String} Callback Name of function to call when request completes (specify "" if none)
+' @param {Variant} [CallbackArgs] Variable array of arguments that get passed directly to callback function
+' --------------------------------------------- '
+
+Public Sub ExecuteRequestAsync(ByRef Http As Object, ByRef Request As RestRequest, TimeoutMS As Integer, Callback As String, Optional ByVal CallbackArgs As Variant)
+    On Error GoTo ErrorHandling
+
+    Request.Callback = Callback
+    Request.CallbackArgs = CallbackArgs
     
+    ' Send the request
+    Request.StartTimeoutTimer TimeoutMS
+    Http.Send Request.Body
+    
+    Exit Sub
+    
+ErrorHandling:
+
+    ' Close http and rethrow error
+    If Not Http Is Nothing Then Set Http = Nothing
+    Err.Raise Err.Number, Description:=Err.Description
 End Sub
 
 ' ======================================================================================== '
