Add cURL - Tests pass on Mac!

Author: timhall

specs/Excel-REST - Specs - Async.xlsm

@@ -29,7 +29,7 @@ Public Function Specs() As SpecSuite
 
     With Specs.It("should login")
         Auth.Login
-        .Expect(Auth.Token).ToBeDefined
+        .Expect(Auth.Token).ToNotBeUndefined
     End With
 
     With Specs.It("should skip login if API key is used")

specs/Excel-REST - Specs.xlsm

@@ -149,7 +149,7 @@ Sub LinkedInSpecs()
         Set Response = Client.Execute(Request)
 
         .Expect(Response.StatusCode).ToEqual 200
-        .Expect(Response.Data("firstName")).ToBeDefined
+        .Expect(Response.Data("firstName")).ToNotBeUndefined
     End With
 
     With Specs.It("should search with space")
@@ -160,7 +160,7 @@ Sub LinkedInSpecs()
         Set Response = Client.Execute(Request)
 
         .Expect(Response.StatusCode).ToEqual 200
-        .Expect(Response.Data("companies")).ToBeDefined
+        .Expect(Response.Data("companies")).ToNotBeUndefined
 
         If (Response.StatusCode <> 200) Then
             Debug.Print "Error :" & Response.StatusCode & " - " & Response.Content

specs/GoogleAuthenticatorSpecs.bas

@@ -246,7 +246,7 @@ Public Function Specs() As SpecSuite
         Set Response = Client.Execute(Request)
         .Expect(Response.Cookies.Count).ToEqual 4
         .Expect(Response.Cookies("unsigned-cookie")).ToEqual "simple-cookie"
-        .Expect(Response.Cookies("signed-cookie")).ToContain "special-cookie"
+        .Expect(Response.Cookies("signed-cookie")).ToMatch "special-cookie"
         .Expect(Response.Cookies("tricky;cookie")).ToEqual "includes; semi-colon and space at end "
         .Expect(Response.Cookies("duplicate-cookie")).ToEqual "B"
     End With
@@ -327,7 +327,9 @@ Public Function Specs() As SpecSuite
         .Expect(Response.Data("b")).ToEqual "2"
         .Expect(Response.Data("c")).ToEqual "3.14"
     End With
-    
+
+#If Mac Then
+#Else
     With Specs.It("should convert and parse XML")
         Set Request = New RestRequest
         Request.Resource = "xml"
@@ -347,6 +349,7 @@ Public Function Specs() As SpecSuite
         .Expect(Response.Data.FirstChild.SelectSingleNode("X").Text).ToEqual "1.23"
         .Expect(Response.Data.FirstChild.SelectSingleNode("Y").Text).ToEqual "4.56"
     End With
+#End If
 
     With Specs.It("should convert and parse plaintext")
         Set Request = New RestRequest
@@ -382,7 +385,45 @@ Public Function Specs() As SpecSuite
         .Expect(Response.Data("b")).ToEqual 2
         .Expect(Response.Data("c")).ToEqual 3.14
     End With
-    
+
+#If Mac Then
+    With Specs.It("should prepare cURL request")
+        Set Client = New RestClient
+        Client.BaseUrl = "http://localhost:3000/"
+        Client.Username = "user"
+        Client.Password = "password"
+        Client.ProxyServer = "proxyserver"
+        Client.ProxyBypassList = "proxyserver:80, *.github.com"
+        Client.ProxyUsername = "proxyuser"
+        Client.ProxyPassword = "proxypassword"
+        
+        Set Request = New RestRequest
+        Request.Resource = "text"
+        Request.AddQuerystringParam "type", "message"
+        Request.Method = httpPOST
+        Request.RequestFormat = AvailableFormats.plaintext
+        Request.ResponseFormat = AvailableFormats.json
+        Request.AddBodyString "Howdy!"
+        Request.AddHeader "custom", "Howdy!"
+        Request.AddCookie "test-cookie", "howdy"
+        
+        Dim cURL As String
+        
+        cURL = Client.PrepareCURL(Request)
+        .Expect(cURL).ToMatch "http://localhost:3000/text?type=message"
+        .Expect(cURL).ToMatch "-X POST"
+        .Expect(cURL).ToMatch "--user user:password"
+        .Expect(cURL).ToMatch "--proxy proxyserver"
+        .Expect(cURL).ToMatch "--noproxy proxyserver:80, *.github.com"
+        .Expect(cURL).ToMatch "--proxy-user proxyuser:proxypassword"
+        .Expect(cURL).ToMatch "-H 'Content-Type: text/plain'"
+        .Expect(cURL).ToMatch "-H 'Accept: application/json'"
+        .Expect(cURL).ToMatch "-H 'custom: Howdy!'"
+        .Expect(cURL).ToMatch "--cookie 'test-cookie=howdy;'"
+        .Expect(cURL).ToMatch "-d 'Howdy!'"
+    End With
+#End If
+ 
     Set Client = Nothing
 
     InlineRunner.RunSuite Specs

specs/OAuth1AuthenticatorSpecs.bas

@@ -223,22 +223,22 @@ Public Function Specs() As SpecSuite
     End With
 
     With Specs.It("should extract parts from url")
-        Set Parts = RestHelpers.UrlParts("https://www.google.com/dir/1/2/search.html?arg=0-a&arg1=1-b&arg3-c#hash")
+        Set Parts = RestHelpers.UrlParts("https://www.google.com/dir/1/2/search.html?message=Howdy World!&other=123#hash")
 
         .Expect(Parts("Protocol")).ToEqual "https"
         .Expect(Parts("Host")).ToEqual "www.google.com"
         .Expect(Parts("Port")).ToEqual "443"
         .Expect(Parts("Path")).ToEqual "/dir/1/2/search.html"
-        .Expect(Parts("Querystring")).ToEqual "arg=0-a&arg1=1-b&arg3-c"
+        .Expect(Parts("Querystring")).ToEqual "message=Howdy World!&other=123"
         .Expect(Parts("Hash")).ToEqual "hash"
 
-        Set Parts = RestHelpers.UrlParts("localhost:3000/dir/1/2/search.html?arg=0-a&arg1=1-b&arg3-c#hash")
+        Set Parts = RestHelpers.UrlParts("localhost:3000/dir/1/2/page%202.html?message=Howdy%20World%21&other=123#hash")
 
         .Expect(Parts("Protocol")).ToEqual ""
         .Expect(Parts("Host")).ToEqual "localhost"
         .Expect(Parts("Port")).ToEqual "3000"
-        .Expect(Parts("Path")).ToEqual "/dir/1/2/search.html"
-        .Expect(Parts("Querystring")).ToEqual "arg=0-a&arg1=1-b&arg3-c"
+        .Expect(Parts("Path")).ToEqual "/dir/1/2/page%202.html"
+        .Expect(Parts("Querystring")).ToEqual "message=Howdy%20World%21&other=123"
         .Expect(Parts("Hash")).ToEqual "hash"
     End With
 

specs/RestClientSpecs.bas

@@ -34,7 +34,7 @@ Public Password As String
 Public ProxyServer As String
 Public ProxyUsername As String
 Public ProxyPassword As String
-Public ProxyBypassList As Variant
+Public ProxyBypassList As String
 
 ' ============================================= '
 ' Public Methods
@@ -62,9 +62,10 @@ Public Function Execute(Request As RestRequest) As RestResponse
     cURL = Me.PrepareCURL(Request)
     Result = RestHelpers.ExecuteInShell(cURL)
 
-    ' TODO Check Result.ExitCode
-    Set Response = RestHelpers.CreateResponseFromCURL(Result.Output, Request.ResponseFormat)
+    Set Response = RestHelpers.CreateResponseFromCURL(Result, Request.ResponseFormat)
     RestHelpers.LogResponse Response, Request
+    Set Execute = Response
+    Exit Function
 
 ErrorHandling:
 
@@ -166,7 +167,7 @@ End Function
 ' --------------------------------------------- '
 
 Public Sub SetProxy(ProxyServer As String, _
-    Optional Username As String = "", Optional Password As String = "", Optional BypassList As Variant)
+    Optional Username As String = "", Optional Password As String = "", Optional BypassList As String = "")
 
     Me.ProxyServer = ProxyServer
     Me.ProxyUsername = Username
@@ -256,18 +257,53 @@ End Function
 
 Public Function PrepareCURL(Request As RestRequest) As String
     Dim cURL As String
+    cURL = "curl -i"
 
     ' Prepare request
     Set Request = PrepareRequest(Request)
 
-    ' Setup proxy?
+    ' Set timeouts
+    cURL = cURL & " --connect-timeout " & Me.TimeoutMS / 1000
+    cURL = cURL & " --max-time " & 3 * Me.TimeoutMS / 1000
+    
+    ' Setup proxy
+    If Me.ProxyServer <> "" Then
+        cURL = cURL & " --proxy " & Me.ProxyServer
+        
+        If Me.ProxyBypassList <> "" Then
+            cURL = cURL & " --noproxy " & Me.ProxyBypassList
+        End If
+        If Me.ProxyUsername <> "" Then
+            cURL = cURL & " --proxy-user " & Me.ProxyUsername & ":" & Me.ProxyPassword
+        End If
+    End If
 
     ' Setup Basic authentication
+    If Me.Username <> "" Then
+        cURL = cURL & " --user " & Me.Username & ":" & Me.Password
+        Request.AddHeader "Authorization", "Basic " & RestHelpers.Base64Encode(Me.Username & ":" & Me.Password)
+    End If
 
     ' Setup authenticator
     BeforeExecute Request
 
-    ' Set headers
+    ' Set headers and cookies
+    Dim HeaderKey As Variant
+    For Each HeaderKey In Request.Headers.Keys
+        cURL = cURL & " -H '" & HeaderKey & ": " & Request.Headers(HeaderKey) & "'"
+    Next HeaderKey
+    
+    Dim CookieKey As Variant
+    Dim CookieString As String
+    For Each CookieKey In Request.Cookies.Keys
+        CookieString = CookieString & CookieKey & "=" & Request.Cookies(CookieKey) & ";"
+    Next CookieKey
+    cURL = cURL & " --cookie '" & CookieString & "'"
+    
+    ' Add method, data, and url
+    cURL = cURL & " -X " & Request.MethodName
+    cURL = cURL & " -d '" & Request.Body & "'"
+    cURL = cURL & " '" & Request.FullUrl(Me.BaseUrl) & "'"
 
     ' Log request and return
     RestHelpers.LogRequest Request

specs/RestHelpersSpecs.bas

@@ -29,12 +29,12 @@ Private Declare Function popen Lib "libc.dylib" (ByVal Command As String, ByVal
 Private Declare Function pclose Lib "libc.dylib" (ByVal File As Long) As Long
 Private Declare Function fread Lib "libc.dylib" (ByVal outStr As String, ByVal size As Long, ByVal Items As Long, ByVal stream As Long) As Long
 Private Declare Function feof Lib "libc.dylib" (ByVal File As Long) As Long
+#End If
 
 Public Type ShellResult
     Output As String
     ExitCode As Long
 End Type
-#End If
 
 Private pDocumentHelper As Object
 Private pElHelper As Object
@@ -360,7 +360,7 @@ Public Function UrlEncode(Text As Variant, Optional SpaceAsPlus As Boolean = Fal
         For i = 1 To StringLen
             ' Get character and ascii code
             Char = Mid$(UrlVal, i, 1)
-            charCode = asc(Char)
+            charCode = Asc(Char)
             Select Case charCode
                 Case 97 To 122, 65 To 90, 48 To 57, 45, 46, 95, 126
                     ' Use original for AZaz09-._~
@@ -526,6 +526,8 @@ Public Function UrlParts(Url As String) As Dictionary
     Dim Results As Variant
     Dim ResultPart As Variant
     Dim EqualsIndex As Long
+    Dim Key As String
+    Dim Value As String
     Command = "perl -e '{use URI::URL;" & vbNewLine & _
         "$url = new URI::URL """ & Url & """;" & vbNewLine & _
         "print ""Protocol="" . $url->scheme;" & vbNewLine & _
@@ -539,7 +541,10 @@ Public Function UrlParts(Url As String) As Dictionary
     Results = Split(ExecuteInShell(Command).Output, " | ")
     For Each ResultPart In Results
         EqualsIndex = InStr(1, ResultPart, "=")
-        Parts.Add Trim(VBA.Mid$(ResultPart, 1, EqualsIndex - 1)), Trim(VBA.Mid$(ResultPart, EqualsIndex + 1))
+        Key = Trim(VBA.Mid$(ResultPart, 1, EqualsIndex - 1))
+        Value = Trim(VBA.Mid$(ResultPart, EqualsIndex + 1))
+        
+        Parts.Add Key, Value
     Next ResultPart
 
     If AddedProtocol And Parts.Exists("Protocol") Then
@@ -769,13 +774,98 @@ End Function
 
 ''
 ' Create response for cURL
+' References:
+' http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html
+' http://curl.haxx.se/libcurl/c/libcurl-errors.html
 '
 ' @param {String} Raw result from cURL
 ' @return {RestResponse}
 ' --------------------------------------------- '
-Public Function CreateResponseFromCURL(Raw As String, Optional Format As AvailableFormats = AvailableFormats.json) As RestResponse
+Public Function CreateResponseFromCURL(Result As ShellResult, Optional Format As AvailableFormats = AvailableFormats.json) As RestResponse
+    Dim StatusCode As Long
+    Dim StatusText As String
+    Dim Headers As String
+    Dim Body As Variant
+    Dim ResponseText As String
+    
+    If Result.ExitCode > 0 Then
+        Dim ErrorNumber As Long
+        
+        ErrorNumber = Result.ExitCode / 256
+        If ErrorNumber = 28 Then
+            Set CreateResponseFromCURL = CreateResponse(StatusCodes.RequestTimeout, "Request Timeout")
+        Else
+            LogError "cURL Error: " & ErrorNumber, "RestHelpers.CreateResponseFromCURL"
+        End If
+        
+        Exit Function
+    End If
+    
+    Dim Lines() As String
+    Lines = Split(Result.Output, vbCrLf)
+    
+    ' Extract status code and text from status line
+    Dim StatusLine As String
+    Dim StatusLineParts() As String
+    StatusLine = Lines(0)
+    StatusLineParts = Split(StatusLine)
+    StatusCode = CLng(StatusLineParts(1))
+    StatusText = Mid$(StatusLine, InStr(1, StatusLine, StatusCode) + 4)
+    
+    ' Find blank line before body
+    Dim Line As Variant
+    Dim BlankLineIndex
+    BlankLineIndex = 0
+    For Each Line In Lines
+        If Trim(Line) = "" Then
+            Exit For
+        End If
+        BlankLineIndex = BlankLineIndex + 1
+    Next Line
+    
+    ' Extract body and headers strings
+    Dim HeaderLines() As String
+    Dim BodyLines() As String
+    Dim ReadIndex As Long
+    Dim WriteIndex As Long
+    
+    ReDim HeaderLines(0 To BlankLineIndex - 2)
+    ReDim BodyLines(0 To UBound(Lines) - BlankLineIndex - 1)
+    
+    WriteIndex = 0
+    For ReadIndex = 1 To BlankLineIndex - 1
+        HeaderLines(WriteIndex) = Lines(ReadIndex)
+        WriteIndex = WriteIndex + 1
+    Next ReadIndex
+    
+    WriteIndex = 0
+    For ReadIndex = BlankLineIndex + 1 To UBound(Lines)
+        BodyLines(WriteIndex) = Lines(ReadIndex)
+        WriteIndex = WriteIndex + 1
+    Next ReadIndex
+    
+    ResponseText = Join$(BodyLines, vbCrLf)
+    Body = StringToBytes(ResponseText)
+    
+    ' Create Response
     Set CreateResponseFromCURL = New RestResponse
-    Debug.Print "cURL Result: " & Raw
+    CreateResponseFromCURL.StatusCode = StatusCode
+    CreateResponseFromCURL.StatusDescription = StatusText
+    CreateResponseFromCURL.Body = Body
+    CreateResponseFromCURL.Content = ResponseText
+    
+    ' Convert content to data by format
+    If Format <> AvailableFormats.plaintext Then
+        On Error Resume Next
+        Set CreateResponseFromCURL.Data = RestHelpers.ParseByFormat(CreateResponseFromCURL.Content, Format)
+        On Error GoTo 0
+    End If
+    
+    ' Extract headers
+    Set CreateResponseFromCURL.Headers = ExtractHeaders(Join$(HeaderLines, vbCrLf))
+    
+    ' Extract cookies
+    Set CreateResponseFromCURL.Cookies = ExtractCookies(CreateResponseFromCURL.Headers)
 End Function
 
 ''
@@ -1080,7 +1170,7 @@ End Function
 ' @param {String} Text
 ' @return {String}
 ' --------------------------------------------- '
-Public Function PrepareTextForShell(Text As String) As String
+Public Function PrepareTextForShell(ByVal Text As String) As String
     Text = Replace("""" & Text & """", "!", """'!'""")
 
     ' Guard for ! at beginning or end ("'!'"..." or "..."'!'")