(Objective-C) Quickbooks OAuth1 Authorization (3-legged)

Demonstrates 3-legged OAuth1 authorization for Quickbooks.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <NSString.h>
#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoHttpResponse.h>
#import <CkoHashtable.h>
#import <CkoStringBuilder.h>
#import <CkoSocket.h>
#import <CkoTask.h>
#import <CkoJsonObject.h>
#import <CkoFileAccess.h>

NSString *consumerKey = @"QUICKBOOKS_CONSUMER_KEY";
NSString *consumerSecret = @"QUICKBOOKS_CONSUMER_SECRET";

NSString *requestTokenUrl = @"https://oauth.intuit.com/oauth/v1/get_request_token";
NSString *authorizeUrl = @"https://appcenter.intuit.com/Connect/Begin";
NSString *accessTokenUrl = @"https://oauth.intuit.com/oauth/v1/get_access_token";

// The port number is picked at random. It's some unused port that won't likely conflict with anything else..
NSString *callbackUrl = @"http://localhost:3017/";
int callbackLocalPort = 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
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

http.OAuth1 = YES;
http.OAuthConsumerKey = consumerKey;
http.OAuthConsumerSecret = consumerSecret;
http.OAuthCallback = callbackUrl;

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
CkoHttpResponse *resp = [http PostUrlEncoded: requestTokenUrl req: req];
if (http.LastMethodSuccess != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

if ([resp.StatusCode intValue] >= 400) {
    NSLog(@"%@%d",@"Error response status code = ",[resp.StatusCode intValue]);
    NSLog(@"%@",resp.BodyStr);
    return;
}

// If successful, the resp.BodyStr contains this:  
// oauth_token=-Wa_KwAAAAAAxfEPAAABV8Qar4Q&oauth_token_secret=OfHY4tZBX2HK4f7yIw76WYdvnl99MVGB&oauth_callback_confirmed=true
NSLog(@"%@",resp.BodyStr);

CkoHashtable *hashTab1 = [[CkoHashtable alloc] init];
[hashTab1 AddQueryParams: resp.BodyStr];

NSString *requestToken = [hashTab1 LookupStr: @"oauth_token"];
NSString *requestTokenSecret = [hashTab1 LookupStr: @"oauth_token_secret"];
http.OAuthTokenSecret = requestTokenSecret;

NSLog(@"%@%@",@"oauth_token = ",requestToken);
NSLog(@"%@%@",@"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.
CkoStringBuilder *sbUrlForBrowser = [[CkoStringBuilder alloc] init];
[sbUrlForBrowser Append: authorizeUrl];
[sbUrlForBrowser Append: @"?oauth_token="];
[sbUrlForBrowser Append: requestToken];
NSString *urlForBrowser = [sbUrlForBrowser GetAsString];

// When the urlForBrowser is loaded into a browser, the response from Quickbooks 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.
CkoSocket *listenSock = [[CkoSocket alloc] init];

int backLog = 5;
success = [listenSock BindAndListen: [NSNumber numberWithInt: callbackLocalPort] backlog: [NSNumber numberWithInt: backLog]];
if (success != YES) {
    NSLog(@"%@",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.
int maxWaitMs = 60000;
CkoTask *task = [listenSock AcceptNextConnectionAsync: [NSNumber numberWithInt: 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 Quickbooks 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: [NSNumber numberWithInt: maxWaitMs]];
if (!success || ([task.StatusInt intValue] != 7) || (task.TaskSuccess != YES)) {
    if (!success) {
        // The task.LastErrorText applies to the Wait method call.
        NSLog(@"%@",task.LastErrorText);
    }
    else {
        // The ResultErrorText applies to the underlying task method call (i.e. the AcceptNextConnection)
        NSLog(@"%@",task.Status);
        NSLog(@"%@",task.ResultErrorText);
    }

    return;
}

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

// We no longer need the listen socket...
// Close it so that it's no longer listening on port 3017.
[listenSock Close: [NSNumber numberWithInt: 10]];

// The first thing to do is to get the connected socket.
CkoSocket *sock = [[CkoSocket alloc] init];
[sock LoadTaskResult: task];

// Read the start line of the request..
NSString *startLine = [sock ReceiveUntilMatch: @"\r\n"];
if (sock.LastMethodSuccess != YES) {
    NSLog(@"%@",sock.LastErrorText);
    return;
}

// Read the request header.
NSString *requestHeader = [sock ReceiveUntilMatch: @"\r\n\r\n"];
if (sock.LastMethodSuccess != YES) {
    NSLog(@"%@",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.
CkoStringBuilder *sbResponseHtml = [[CkoStringBuilder alloc] init];
[sbResponseHtml Append: @"<html><body><p>Chilkat thanks you!</b></body</html>"];

CkoStringBuilder *sbResponse = [[CkoStringBuilder alloc] init];
[sbResponse Append: @"HTTP/1.1 200 OK\r\n"];
[sbResponse Append: @"Content-Length: "];
[sbResponse AppendInt: sbResponseHtml.Length];
[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: [NSNumber numberWithInt: 50]];

// The information we need is in the startLine.
// For example, the startLine will look like this:
//  GET /?oauth_token=abcdRQAAZZAAxfBBAAABVabcd_k&oauth_verifier=9rdOq5abcdCe6cn8M3jabcdj3Eabcd HTTP/1.1
CkoStringBuilder *sbStartLine = [[CkoStringBuilder alloc] init];
[sbStartLine Append: startLine];
int numReplacements = [[sbStartLine Replace: @"GET /?" replacement: @""] intValue];
numReplacements = [[sbStartLine Replace: @" HTTP/1.1" replacement: @""] intValue];
[sbStartLine Trim];

// oauth_token=qyprdP04IrTDIXtP1HRZz0geQdjXHVlGDxXPexlXZsjZNRcY&oauth_verifier=arx5pj5&realmId=193514465596199&dataSource=QBO
NSLog(@"%@%@",@"startline: ",[sbStartLine GetAsString]);

[hashTab1 Clear];
[hashTab1 AddQueryParams: [sbStartLine GetAsString]];

requestToken = [hashTab1 LookupStr: @"oauth_token"];
NSString *authVerifier = [hashTab1 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 != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

// Make sure a successful response was received.
if ([resp.StatusCode intValue] != 200) {
    NSLog(@"%@",resp.StatusLine);
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",resp.BodyStr);
    return;
}

// If successful, the resp.BodyStr contains something like this:
// oauth_token=12347455-ffffrrlaBdCjbdGfyjZabcdb5APNtuTPNabcdEpp&oauth_token_secret=RxxxxJ8mTzUhwES4xxxxuJyFWDN8ZfHmrabcddh88LmWE
NSLog(@"%@",resp.BodyStr);

CkoHashtable *hashTab2 = [[CkoHashtable alloc] init];
[hashTab2 AddQueryParams: resp.BodyStr];

NSString *accessToken = [hashTab2 LookupStr: @"oauth_token"];
NSString *accessTokenSecret = [hashTab2 LookupStr: @"oauth_token_secret"];

// The access token + secret is what should be saved and used for
// subsequent REST API calls.
NSLog(@"%@%@",@"Access Token = ",accessToken);
NSLog(@"%@%@",@"Access Token Secret = ",accessTokenSecret);

// Save this access token for future calls.
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json AppendString: @"oauth_token" value: accessToken];
[json AppendString: @"oauth_token_secret" value: accessTokenSecret];

// Also save the realmId and dataSource from hashTab1.
NSString *realmId = [hashTab1 LookupStr: @"realmId"];
NSLog(@"%@%@",@"realmId = ",realmId);
NSString *dataSource = [hashTab1 LookupStr: @"dataSource"];
NSLog(@"%@%@",@"dataSource = ",dataSource);

[json AppendString: @"realmId" value: realmId];
[json AppendString: @"dataSource" value: dataSource];

CkoFileAccess *fac = [[CkoFileAccess alloc] init];
[fac WriteEntireTextFile: @"qa_data/tokens/quickbooks.json" fileData: [json Emit] charset: @"utf-8" includePreamble: NO];

NSLog(@"%@",@"Success.");