(Swift 2) Xero OAuth1 Authorization (3-legged)

Demonstrates 3-legged OAuth1 authorization for Xero

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    var consumerKey: String? = "XERO_CONSUMER_KEY"
    var consumerSecret: String? = "XERO_CONSUMER_SECRET"

    var requestTokenUrl: String? = "https://api.xero.com/oauth/RequestToken"
    var authorizeUrl: String? = "https://api.xero.com/oauth/Authorize"
    var accessTokenUrl: String? = "https://api.xero.com/oauth/AccessToken"

    // The port number is picked at random. It's some unused port that won't likely conflict with anything else..
    var callbackUrl: String? = "http://localhost:3017/"
    var callbackLocalPort: Int = 3017

    // The 1st step in 3-legged OAuth1.0a is to send a POST to the request token URL to obtain an OAuth Request Token
    let http = CkoHttp()
    var success: Bool

    http.OAuth1 = true
    http.OAuthConsumerKey = consumerKey
    http.OAuthConsumerSecret = consumerSecret
    http.OAuthCallback = callbackUrl

    let req = CkoHttpRequest()
    var resp: CkoHttpResponse? = http.PostUrlEncoded(requestTokenUrl, req: req)
    if http.LastMethodSuccess != true {
        print("\(http.LastErrorText)")
        return
    }

    // If successful, the resp.BodyStr contains something like this:  
    // oauth_token=-Wa_KwAAAAAAxfEPAAABV8Qar4Q&oauth_token_secret=OfHY4tZBX2HK4f7yIw76WYdvnl99MVGB&oauth_callback_confirmed=true
    print("\(resp!.BodyStr)")

    let hashTab = CkoHashtable()
    hashTab.AddQueryParams(resp!.BodyStr)

    var requestToken: String? = hashTab.LookupStr("oauth_token")
    var requestTokenSecret: String? = hashTab.LookupStr("oauth_token_secret")
    http.OAuthTokenSecret = requestTokenSecret

    resp = nil

    print("oauth_token = \(requestToken!)")
    print("oauth_token_secret = \(requestTokenSecret!)")

    // ---------------------------------------------------------------------------
    // The next step is to form a URL to send to the authorizeUrl
    // This is an HTTP GET that we load into a popup browser.
    let sbUrlForBrowser = CkoStringBuilder()
    sbUrlForBrowser.Append(authorizeUrl)
    sbUrlForBrowser.Append("?oauth_token=")
    sbUrlForBrowser.Append(requestToken)
    var urlForBrowser: String? = sbUrlForBrowser.GetAsString()

    // When the urlForBrowser is loaded into a browser, the response from Xero will redirect back to localhost:3017
    // We'll need to start a socket that is listening on port 3017 for the callback from the browser.
    let listenSock = CkoSocket()

    var backLog: Int = 5
    success = listenSock.BindAndListen(callbackLocalPort, backlog: backLog)
    if success != true {
        print("\(listenSock.LastErrorText)")
        return
    }

    // Wait for the browser's connection in a background thread.
    // (We'll send load the URL into the browser following this..)
    // Wait a max of 60 seconds before giving up.
    var maxWaitMs: Int = 60000
    var task: CkoTask? = listenSock.AcceptNextConnectionAsync(maxWaitMs)
    task!.Run()

    //  At this point, your application should load the URL in a browser.
    //  For example,
    //  in C#:  System.Diagnostics.Process.Start(urlForBrowser);
    //  in Java: Desktop.getDesktop().browse(new URI(urlForBrowser));
    //  in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
    //               wsh.Run urlForBrowser
    // in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
    // in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl        
    //  The Xero account owner would interactively accept or deny the authorization request.

    //  Add the code to load the url in a web browser here...
    //  Add the code to load the url in a web browser here...
    //  Add the code to load the url in a web browser here...
    // System.Diagnostics.Process.Start(urlForBrowser);

    // Wait for the listenSock's task to complete.
    success = task!.Wait(maxWaitMs)
    if !success || (task!.StatusInt.intValue != 7) || (task!.TaskSuccess != true) {
        if !success {
            // The task.LastErrorText applies to the Wait method call.
            print("\(task!.LastErrorText)")
        }
        else {
            // The ResultErrorText applies to the underlying task method call (i.e. the AcceptNextConnection)
            print("\(task!.Status)")
            print("\(task!.ResultErrorText)")
        }

        task = nil
        return
    }

    // If we get to this point, the connection from the browser arrived and was accepted.

    // We no longer need the listen socket...
    // Stop listening on port 3017.
    listenSock.Close(10)

    // First get the connected socket.
    let sock = CkoSocket()
    sock.LoadTaskResult(task)
    task = nil

    // Read the start line of the request..
    var startLine: String? = sock.ReceiveUntilMatch("\r\n")
    if sock.LastMethodSuccess != true {
        print("\(sock.LastErrorText)")
        return
    }

    // Read the request header.
    var requestHeader: String? = sock.ReceiveUntilMatch("\r\n\r\n")
    if sock.LastMethodSuccess != true {
        print("\(sock.LastErrorText)")
        return
    }

    // The browser SHOULD be sending us a GET request, and therefore there is no body to the request.
    // Once the request header is received, we have all of it.
    // We can now send our HTTP response.
    let sbResponseHtml = CkoStringBuilder()
    sbResponseHtml.Append("<html><body><p>Chilkat thanks you!</b></body</html>")

    let sbResponse = CkoStringBuilder()
    sbResponse.Append("HTTP/1.1 200 OK\r\n")
    sbResponse.Append("Content-Length: ")
    sbResponse.AppendInt(sbResponseHtml.Length.intValue)
    sbResponse.Append("\r\n")
    sbResponse.Append("Content-Type: text/html\r\n")
    sbResponse.Append("\r\n")
    sbResponse.AppendSb(sbResponseHtml)

    sock.SendString(sbResponse.GetAsString())
    sock.Close(50)

    // The information we need is in the startLine.
    // For example, the startLine will look something like this:
    //  GET /?oauth_token=abcdRQAAZZAAxfBBAAABVabcd_k&oauth_verifier=9rdOq5abcdCe6cn8M3jabcdj3Eabcd&org=mUkIZabcdKEababcd189t0 HTTP/1.1
    let sbStartLine = CkoStringBuilder()
    sbStartLine.Append(startLine)
    var numReplacements: Int = sbStartLine.Replace("GET /?", replacement: "").intValue
    numReplacements = sbStartLine.Replace(" HTTP/1.1", replacement: "").intValue
    sbStartLine.Trim()

    // oauth_token=abcdRQAAZZAAxfBBAAABVabcd_k&oauth_verifier=9rdOq5abcdCe6cn8M3jabcdj3Eabcd&org=mUkIZabcdKEababcd189t0
    print("startline: \(sbStartLine.GetAsString())")

    hashTab.Clear()
    hashTab.AddQueryParams(sbStartLine.GetAsString())

    requestToken = hashTab.LookupStr("oauth_token")
    var authVerifier: String? = hashTab.LookupStr("oauth_verifier")

    // ------------------------------------------------------------------------------
    // Finally , we must exchange the OAuth Request Token for an OAuth Access Token.

    http.OAuthToken = requestToken
    http.OAuthVerifier = authVerifier
    resp = http.PostUrlEncoded(accessTokenUrl, req: req)
    if http.LastMethodSuccess != true {
        print("\(http.LastErrorText)")
        return
    }

    // Make sure a successful response was received.
    if resp!.StatusCode.intValue != 200 {
        print("\(resp!.StatusLine)")
        print("\(resp!.Header)")
        print("\(resp!.BodyStr)")
        return
    }

    // If successful, the resp.BodyStr contains something like this:
    // oauth_token=85123455-fF41296Bi3daM8eCo9Y5vZabcdxXpRv864plYPOjr&oauth_token_secret=afiYJOgabcdSfGae7BDvJVVTwys8fUGpra5guZxbmFBZo&oauth_expires_in=1800&xero_org_muid=abcdecNhPKabcdNjz189t0
    print("\(resp!.BodyStr)")

    hashTab.Clear()
    hashTab.AddQueryParams(resp!.BodyStr)

    var accessToken: String? = hashTab.LookupStr("oauth_token")
    var accessTokenSecret: String? = hashTab.LookupStr("oauth_token_secret")
    var orgMuid: String? = hashTab.LookupStr("xero_org_muid")
    var expiresIn: String? = hashTab.LookupStr("oauth_expires_in")

    resp = nil

    // The access token + secret is what should be saved and used for
    // subsequent REST API calls.
    print("Access Token = \(accessToken!)")
    print("Access Token Secret = \(accessTokenSecret!)")
    print("xero_org_muid = \(orgMuid!)")
    print("oauth_expires_in  = \(expiresIn!)")

    // Save this access token for future calls.
    // Just in case we need xero_org_muid and oauth_expires_in, save those also..
    let json = CkoJsonObject()
    json.AppendString("oauth_token", value: accessToken)
    json.AppendString("oauth_token_secret", value: accessTokenSecret)
    json.AppendString("xero_org_muid", value: orgMuid)
    json.AppendString("oauth_expires_in", value: expiresIn)

    let fac = CkoFileAccess()
    fac.WriteEntireTextFile("qa_data/tokens/xero.json", fileData: json.Emit(), charset: "utf-8", includePreamble: false)

    print("Success.")

}