1. Create a Bulk API job
+ + +
+ + +
+ + + +
+
+ Account List
+
+
+
+ -
+
+
+ The first account I see is .
@@ -99,14 +137,14 @@ Your HTML page will need to include jQuery and the toolkit, then create a client function sessionCallback(oauthResponse) { if (typeof oauthResponse === 'undefined' || typeof oauthResponse['access_token'] === 'undefined') { - $('#message').html('Error - unauthorized!'); + $('#message').text('Error - unauthorized!'); } else { client.setSessionToken(oauthResponse.access_token, null, oauthResponse.instance_url); client.query("SELECT Name FROM Account LIMIT 1", function(response){ - $('#message').html('The first account I see is ' + $('#message').text('The first account I see is ' +response.records[0].Name); }); } @@ -117,39 +155,50 @@ Your HTML page will need to include jQuery and the toolkit, then create a client More fully featured samples are provided in [example.html](Force.com-JavaScript-REST-Toolkit/blob/master/example.html) and [mobile.html](Force.com-JavaScript-REST-Toolkit/blob/master/mobile.html). -Using the Toolkit in a PhoneGap app ------------------------------------ +Using the Toolkit in a Cordova app +---------------------------------- -Your HTML page will need to include jQuery, the toolkit, PhoneGap and the ChildBrowser plugin, then create a client object, passing a session ID to the constructor. You can use __https://login.salesforce.com/services/oauth2/success__ as the redirect URI and catch the page load in ChildBrowser. +Your HTML page will need to include jQuery, the toolkit and Cordova. You will also need to install the [InAppBrowser](http://plugins.cordova.io/#/package/org.apache.cordova.inappbrowser) plugin to be able to pop up a browser window for authentication. Create a client object, passing a session ID to the constructor. You can use __https://login.salesforce.com/services/oauth2/success__ as the redirect URI and catch the page load in InAppBrowser. An absolutely minimal sample using OAuth to obtain a session ID is: + - - - - - + + + -Click here.
+ + + + + -A fully featured sample (including persistence of the OAuth refresh token to the iOS Keychain) is provided in [phonegap.html](Force.com-JavaScript-REST-Toolkit/blob/master/phonegap.html). +A fully featured sample (including persistence of the OAuth refresh token to the iOS Keychain) for iOS is provided in [cordova-ios.html](https://github.com/developerforce/Force.com-JavaScript-REST-Toolkit/blob/master/cordova-ios.html). The sample uses Cordova 4.3.0 and the InAppBrowser and iOS Keychain plugins. Install these with + cordova plugin add org.apache.cordova.inappbrowser + cordova plugin add com.shazron.cordova.plugin.keychainutil diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..e31774d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +## Security + +Please report any security issue to [security@salesforce.com](mailto:security@salesforce.com) +as soon as it is discovered. This library limits its runtime dependencies in +order to reduce the total cost of ownership as much as can be, but all consumers +should remain vigilant and have their security stakeholders review all third-party +products (3PP) like this one and their dependencies. \ No newline at end of file diff --git a/app.js b/app.js index 10b7064..7ce5297 100644 --- a/app.js +++ b/app.js @@ -51,18 +51,18 @@ function metadataCallback(response){ // Using TrimPath Template for now - may switch to jQuery Template at some // point - $j('#prompt').html(TrimPath.processDOMTemplate("prompt_jst" + $('#prompt').html(TrimPath.processDOMTemplate("prompt_jst" , response)); // Set up autocomplete - $j( "#value" ).autocomplete({ + $( "#value" ).autocomplete({ source: function( request, response ) { var query = "SELECT Id, Name FROM Account "+ - "WHERE "+$j("#field").val()+" LIKE '%"+request.term+"%' "+ + "WHERE "+$("#field").val()+" LIKE '%"+request.term+"%' "+ "ORDER BY Name LIMIT 20"; client.query(query, function( data ) { - response( $j.map( data.records, function( record ) { + response( $.map( data.records, function( record ) { return { label: record.Name, value: record.Id @@ -76,22 +76,22 @@ if ( ui.item != null ) { showAccountDetail(ui.item.value); } else { - filterAccounts($j("#field").val(),this.value); + filterAccounts($("#field").val(),this.value); } return false; }, }); - $j('#go').click(function(e) { - var field = $j("#field").val(); - var value = $j("#value").val(); + $('#go').click(function(e) { + var field = $("#field").val(); + var value = $("#value").val(); e.preventDefault(); filterAccounts(field,value); }); - $j('#new').click(function(e) { + $('#new').click(function(e) { e.preventDefault(); // Just make Trimpath happy @@ -101,19 +101,19 @@ dummy[response.fields[i].name] = ''; } $dialog.html(TrimPath.processDOMTemplate("edit_jst", dummy)); - $dialog.find('#action').html('Create').click(function(e) { + $dialog.find('#action').text('Create').click(function(e) { e.preventDefault(); $dialog.dialog('close'); var fields = {}; $dialog.find('input').each(function() { - var child = $j(this); + var child = $(this); if ( child.val().length > 0 ) { fields[child.attr("name")] = child.val(); } }); - $j('#list').html(ajaxgif+" creating account..."); + $('#list').html(ajaxgif+" creating account..."); client.create('Account', fields, createCallback, errorCallback); }); @@ -125,21 +125,21 @@ } function queryCallback(response) { - $j('#list').html(TrimPath.processDOMTemplate("accounts_jst" + $('#list').html(TrimPath.processDOMTemplate("accounts_jst" , response)); - $j('#version').html($j.fn.jquery); - $j('#uiversion').html($j.ui.version); + $('#version').text($.fn.jquery); + $('#uiversion').text($.ui.version); - $j("#list tr:nth-child(odd)").addClass("odd"); + $("#list tr:nth-child(odd)").addClass("odd"); - $j('#logout').click(logout); + $('#logout').click(logout); - $j('#accounts').find('.id') + $('#accounts').find('.id') .hover(function() { - $j(this).addClass("highlighted"); + $(this).addClass("highlighted"); },function(){ - $j(this).removeClass("highlighted"); + $(this).removeClass("highlighted"); }) .click(function(){ showAccountDetail(this.id); @@ -156,36 +156,36 @@ && !response.Website.startsWith('http://')) { response.Website = 'http://'+response.Website; } - $dialog.html(TrimPath.processDOMTemplate("detail_jst" + $dialog.TrimPath.processDOMTemplate("detail_jst" ,response)); $dialog.find('#industry').click(function(e) { e.preventDefault(); $dialog.dialog('close'); - filterIndustry($j(this).html()); + filterIndustry($(this).text()); }); $dialog.find('#delete').click(function(e) { e.preventDefault(); $dialog.dialog('close'); - $j('#list').html(ajaxgif+" deleting account..."); + $('#list').html(ajaxgif+" deleting account..."); client.del('Account', $dialog.find('#id').val(), deleteCallback, errorCallback); }); $dialog.find('#edit').click(function(e) { e.preventDefault(); $dialog.html(TrimPath.processDOMTemplate("edit_jst" ,response)); - $dialog.find('#action').html('Update').click(function(e) { + $dialog.find('#action').text('Update').click(function(e) { e.preventDefault(); $dialog.dialog('close'); var fields = {}; $dialog.find('input').each(function() { - var child = $j(this); + var child = $(this); if ( child.val().length > 0 && child.attr("name") != 'id') { fields[child.attr("name")] = child.val(); } }); - $j('#list').html(ajaxgif+" updating account..."); + $('#list').html(ajaxgif+" updating account..."); client.update('Account', $dialog.find('#id').val(), fields, updateCallback, errorCallback); }); @@ -193,19 +193,19 @@ } function createCallback(response) { - $j('#list').html('Created '+response.id); + $('#list').text('Created '+response.id); setTimeout("filterAccounts()",1000); } function updateCallback(response) { - $j('#list').html('Updated'); + $('#list').text('Updated'); setTimeout("filterAccounts()",1000); } function deleteCallback(response) { - $j('#list').html('Deleted'); + $('#list').text('Deleted'); setTimeout("filterAccounts()",1000); } @@ -222,7 +222,7 @@ } function filterIndustry(industry) { - $j('#list').html(ajaxgif+" loading data..."); + $('#list').html(ajaxgif+" loading data..."); var query = "SELECT Id, Name FROM Account WHERE Industry = '"+industry +"' ORDER BY Name LIMIT 20"; @@ -231,7 +231,7 @@ } function filterAccounts(field, value) { - $j('#list').html(ajaxgif+" loading data..."); + $('#list').html(ajaxgif+" loading data..."); var query = ( typeof value !== 'undefined' && value.length > 0 ) ? "SELECT Id, Name FROM Account WHERE "+field+" LIKE '%"+value diff --git a/bulk.page b/bulk.page new file mode 100644 index 0000000..e9e7504 --- /dev/null +++ b/bulk.page @@ -0,0 +1,255 @@ + + +| Account Name: | |
| Industry: | |
| Ticker Symbol: |
This should be used if performing a query that retrieves more than can be returned + * in accordance with http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_query.htm
+ *Ex: forcetkClient.queryMore( successResponse.nextRecordsUrl, successHandler, failureHandler )
+ * + * @param url - the url retrieved from nextRecordsUrl or prevRecordsUrl + * @param callback function to which response will be passed + * @param [error=null] function to which jqXHR will be passed in case of error + */ + forcetk.Client.prototype.queryMore = function (url, callback, error) { + 'use strict'; + //-- ajax call adds on services/data to the url call, so only send the url after + var serviceData = "services/data", + index = url.indexOf(serviceData); + + if (index > -1) { + url = url.substr(index + serviceData.length); + } + + return this.ajax(url, callback, error); + }; /* * Executes the specified SOSL search. @@ -333,8 +634,9 @@ if (forcetk.Client === undefined) { * @param callback function to which response will be passed * @param [error=null] function to which jqXHR will be passed in case of error */ - forcetk.Client.prototype.search = function(sosl, callback, error) { - this.ajax('/' + this.apiVersion + '/search?s=' + escape(sosl) - , callback, error); - } -} \ No newline at end of file + forcetk.Client.prototype.search = function (sosl, callback, error) { + 'use strict'; + return this.ajax('/' + this.apiVersion + '/search?q=' + encodeURIComponent(sosl), + callback, error); + }; +} diff --git a/jxon.js b/jxon.js new file mode 100644 index 0000000..192694d --- /dev/null +++ b/jxon.js @@ -0,0 +1,140 @@ +/* + * JXON.js + * Ratatosk + * + * Created by Alexander Ljungberg on March 15th, 2012. + * + * Public domain JXON implementation from algorithm #3 of: + * https://developer.mozilla.org/en/Parsing_and_serializing_XML + * + * Any copyright is dedicated to the Public Domain. + * + * Modified by Andrew (Pat) Patterson, 2015 from original at + * https://github.com/wireload/Ratatosk/blob/master/jxon.js + * to preserve case of element and attribute names + */ + +JXON = function() +{ + +}; + +JXON.buildValue = function(sValue) +{ + if (/^\s*$/.test(sValue)) + return null; + if (/^(true|false)$/i.test(sValue)) + return sValue.toLowerCase() === "true"; + if (isFinite(sValue)) + return parseFloat(sValue); + // Don't do this - it'll parse anything that looks like a date and get the timezone wrong. + // https://bugzilla.mozilla.org/show_bug.cgi?id=693077 + //if (isFinite(Date.parse(sValue))) + // return new Date(sValue); + return sValue; +}; + +JXON.fromXML = function(xmlString) +{ + return JXON.getJXONData((new DOMParser()).parseFromString(xmlString, "text/xml")); +}; + +JXON.getJXONData = function(oXMLParent) +{ + var vResult = /* put here the default value for empty nodes! */ null, + nLength = 0, + sCollectedTxt = ""; + if (oXMLParent.hasAttributes && oXMLParent.hasAttributes()) + { + vResult = {}; + for (nLength; nLength < oXMLParent.attributes.length; nLength++) + { + oItAttr = oXMLParent.attributes.item(nLength); + vResult["@" + oItAttr.nodeName] = JXON.buildValue(oItAttr.value.replace(/^\s+|\s+$/g, "")); + } + } + if (oXMLParent.hasChildNodes()) + { + for (var oItChild, sItKey, sItVal, nChildId = 0; nChildId < oXMLParent.childNodes.length; nChildId++) + { + oItChild = oXMLParent.childNodes.item(nChildId); + if (oItChild.nodeType === 4) + { + sCollectedTxt += oItChild.nodeValue; + } /* nodeType is "CDATASection" (4) */ + else if (oItChild.nodeType === 3) + { + sCollectedTxt += oItChild.nodeValue.replace(/^\s+|\s+$/g, ""); + } /* nodeType is "Text" (3) */ + else if (oItChild.nodeType === 1 && !oItChild.prefix) + { /* nodeType is "Element" (1) */ + if (nLength === 0) + vResult = {}; + sItKey = oItChild.nodeName; + sItVal = JXON.getJXONData(oItChild); + if (vResult.hasOwnProperty(sItKey)) + { + if (vResult[sItKey].constructor !== Array) + vResult[sItKey] = [vResult[sItKey]]; + vResult[sItKey].push(sItVal); + } + else + { + vResult[sItKey] = sItVal; + nLength++; + } + } + } + } + if (sCollectedTxt) + nLength > 0 ? vResult.keyValue = JXON.buildValue(sCollectedTxt) : vResult = JXON.buildValue(sCollectedTxt); + /* if (nLength > 0) { Object.freeze(vResult); } */ + return vResult; +}; + +JXON.loadObj = function(oParentObj, oParentEl, oNewDoc) +{ + var nSameIdx, + vValue, + oChild; + for (var sName in oParentObj) + { + vValue = oParentObj[sName]; + if (sName === "keyValue") + { + if (vValue !== null && vValue !== true) + oParentEl.appendChild(oNewDoc.createTextNode(String(vValue))); + } + else if (sName.charAt(0) === "@") + oParentEl.setAttribute(sName.slice(1), vValue); + else + { + oChild = oNewDoc.createElement(sName); + if (vValue && vValue.constructor === Date) + oChild.appendChild(oNewDoc.createTextNode(vValue.toGMTString())); + else if (vValue && vValue.constructor === Array) + { + for (nSameIdx = 0; nSameIdx < vValue.length; nSameIdx++) + JXON.loadObj(vValue[nSameIdx], oChild); + } + else if (vValue && vValue instanceof Object) + { + JXON.loadObj(vValue, oChild, oNewDoc); + } + else if (vValue !== null && vValue !== true) + oChild.appendChild(oNewDoc.createTextNode(vValue.toString())); + + oParentEl.appendChild(oChild); + // CPLog.error("Document: " + (new XMLSerializer()).serializeToString(oNewDoc)); + } + } +}; + +JXON.toXML = function(oJXONObj, rootName) +{ + var oNewDoc = document.implementation.createDocument("", "", null), + rootNode = oNewDoc.createElement(rootName || 'xml'); + oNewDoc.appendChild(rootNode); + JXON.loadObj(oJXONObj, rootNode, oNewDoc); + return (new XMLSerializer()).serializeToString(oNewDoc); +}; diff --git a/mobile.html b/mobile.html index c1a14eb..9c07cad 100644 --- a/mobile.html +++ b/mobile.html @@ -55,13 +55,8 @@ // OAuth var client = new forcetk.Client(clientId, loginUrl, proxyUrl);; -// We use $j rather than $ for jQuery -if (window.$j === undefined) { - $j = $; -} - -$j(document).ready(function() { - $j('#login').popupWindow({ +$(document).ready(function() { + $('#login').popupWindow({ windowURL: getAuthorizeUrl(loginUrl, clientId, redirectUri), windowName: 'Connect', centerBrowser: 1, @@ -79,7 +74,6 @@ function sessionCallback(oauthResponse) { if (typeof oauthResponse === 'undefined' || typeof oauthResponse['access_token'] === 'undefined') { - //$j('#prompt').html('Error - unauthorized!'); errorCallback({ status: 0, statusText: 'Unauthorized', @@ -91,10 +85,10 @@ addClickListeners(); - $j.mobile.changePage('#mainpage',"slide",false,true); - $j.mobile.pageLoading(); + $.mobile.changePage('#mainpage',"slide",false,true); + $.mobile.pageLoading(); getAccounts(function(){ - $j.mobile.pageLoading(true); + $.mobile.pageLoading(true); }); } } diff --git a/mobile.page b/mobile.page index 40105bf..c3f54e8 100644 --- a/mobile.page +++ b/mobile.page @@ -50,20 +50,17 @@ an HTML5 mobile app using jQuery Mobile| Account Name: | |
| Industry: | |
| Ticker Symbol: |