From 8350270358f2d4867990efe0915317ea01fa54f9 Mon Sep 17 00:00:00 2001 From: metadaddy Date: Tue, 29 Mar 2011 14:00:19 -0700 Subject: [PATCH] Added toolkit, readme, example --- README | 0 README.markdown | 48 +++++++ example.page | 335 ++++++++++++++++++++++++++++++++++++++++++++++++ forcetk.js | 215 +++++++++++++++++++++++++++++++ license | 25 ++++ 5 files changed, 623 insertions(+) delete mode 100644 README create mode 100644 README.markdown create mode 100644 example.page create mode 100644 forcetk.js create mode 100644 license diff --git a/README b/README deleted file mode 100644 index e69de29..0000000 diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..2dcb686 --- /dev/null +++ b/README.markdown @@ -0,0 +1,48 @@ +Force.com JavaScript REST Toolkit +================================= + +This minimal toolkit allows JavaScript in Visualforce pages to call the Force.com REST API via the Ajax Proxy. + +Background +---------- + +Due to the [same origin policy](http://en.wikipedia.org/wiki/Same_origin_policy), JavaScript running in Visualforce pages may not use XmlHttpRequest to directly invoke the REST API, since Visualforce pages have hostnames of the form abc.na1.visual.force.com, and the REST API endpoints are of the form na1.salesforce.com. + +We can work around this restriction by using the [AJAX Proxy](http://www.salesforce.com/us/developer/docs/ajax/Content/sforce_api_ajax_queryresultiterator.htm#ajax_proxy). Since the AJAX proxy is present on all +Visualforce hosts with an endpoint of the form https://abc.na1.visual.force.com/services/proxy, our Visualforce-hosted JavaScript can invoke it, passing the desired resource URL in an HTTP header. + +Dependencies +------------ + +The toolkit uses jQuery. It has been tested on jQuery 1.4.4, but other versions may also work. + +Configuration +------------- + +You must add the correct REST endpoint hostname for your instance (i.e. https://na1.salesforce.com/ or similar) as a remote site in *Your Name > Administration Setup > Security Controls > Remote Site Settings*. + +Using the Toolkit +----------------- + +Create a zip file containing forcetk.js, jquery.js, and any other static resources your project may need. Upload the zip via *Your Name > App Setup > Develop > Static Resources*. + +Your Visualforce page will need to include jQuery and the toolkit, then create a client object, passing a session ID to the constructor. An absolutely minimal sample is: + + + + + +

The first account I see is .

+ + +A much more fully featured sample is provided in example.page. \ No newline at end of file diff --git a/example.page b/example.page new file mode 100644 index 0000000..e9dc7e3 --- /dev/null +++ b/example.page @@ -0,0 +1,335 @@ + + + + + + Force.com JavaScript REST Toolkit + + + + + + + + + + + + +
+
+
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/forcetk.js b/forcetk.js new file mode 100644 index 0000000..8080501 --- /dev/null +++ b/forcetk.js @@ -0,0 +1,215 @@ +/* + * Copyright (c) 2011, salesforce.com, inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, are permitted provided + * that the following conditions are met: + * + * Redistributions of source code must retain the above copyright notice, this list of conditions and the + * following disclaimer. + * + * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and + * the following disclaimer in the documentation and/or other materials provided with the distribution. + * + * Neither the name of salesforce.com, inc. nor the names of its contributors may be used to endorse or + * promote products derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* JavaScript library to wrap REST API on Visualforce. Leverages Ajax Proxy + * (see http://bit.ly/sforce_ajax_proxy for details). + * + * Note that you must add the REST endpoint hostname for your instance (i.e. + * https://na1.salesforce.com/ or similar) as a remote site - in the admin + * console, go to Your Name | Setup | Security Controls | Remote Site Settings + */ + +var forcetk = window.forcetk; + +if (forcetk === undefined) { + forcetk = {}; +} + +if (forcetk.Client === undefined) { + + /** + * The Client provides a convenient wrapper for the Force.com REST API, + * allowing JavaScript in Visualforce pages to use the API via the Ajax + * Proxy. + * @param sessionId a salesforce.com session ID. In a Visualforce page, + * use '{!$Api.sessionId}' to obtain a session ID. + * @param [apiVersion="21.0"] Force.com API version + * @constructor + */ + forcetk.Client = function(sessionId, apiVersion) { + this.sessionId = sessionId; + this.proxy_url = location.protocol + "//" + location.hostname + + "/services/proxy"; + // location.hostname is of the form 'abc.na1.visual.force.com', so we + // can simply split it on '.' and take the second element of the + // resulting array + this.instance_url = "https://" + location.hostname.split(".")[1] + + ".salesforce.com"; + this.apiVersion = (typeof apiVersion === 'undefined' || apiVersion == null) + ? 'v21.0' : apiVersion; + } + + /* + * Low level utility function to call the Salesforce proxy endpoint. + * @param path resource path relative to /services/data + * @param callback function to which response will be passed + * @param [method="GET"] HTTP method for call + * @param [payload=null] payload for POST/PATCH etc + */ + forcetk.Client.prototype.proxyAjax = function(path, callback, method, payload) { + var url = this.instance_url + '/services/data' + path; + var sessionId = this.sessionId; + + $j.ajax({ + type: (typeof method === 'undefined' || method == null) + ? "GET" : method, + url: this.proxy_url, + contentType: 'application/json', + processData: false, + data: (typeof payload === 'undefined' || payload == null) + ? null : payload, + success: callback, + dataType: "json", + beforeSend: function(xhr) { + xhr.setRequestHeader('SalesforceProxy-Endpoint', url); + xhr.setRequestHeader("Authorization", "OAuth " + sessionId); + } + }); + } + + /* + * Lists summary information about each Salesforce.com version currently + * available, including the version, label, and a link to each version's + * root. + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.versions = function(callback) { + this.proxyAjax('/', callback); + } + + /* + * Lists available resources for the client's API version, including + * resource name and URI. + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.resources = function(callback) { + this.proxyAjax('/' + this.apiVersion + '/', callback); + } + + /* + * Lists the available objects and their metadata for your organization's + * data. + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.describeGlobal = function(callback) { + this.proxyAjax('/' + this.apiVersion + '/sobjects/', callback); + } + + /* + * Describes the individual metadata for the specified object. + * @param objtype object type; e.g. "Account" + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.metadata = function(objtype, callback) { + this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + '/' + , callback); + } + + /* + * Completely describes the individual metadata at all levels for the + * specified object. + * @param objtype object type; e.g. "Account" + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.describe = function(objtype, callback) { + this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + + '/describe/', callback); + } + + /* + * Creates a new record of the given type. + * @param objtype object type; e.g. "Account" + * @param fields an object containing initial field names and values for + * the record, e.g. {:Name "salesforce.com", :TickerSymbol + * "CRM"} + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.create = function(objtype, fields, callback) { + this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + '/' + , callback, "POST", JSON.stringify(fields)); + } + + /* + * Retrieves field values for a record of the given type. + * @param objtype object type; e.g. "Account" + * @param id the record's object ID + * @param fields comma-separated list of fields for which to return + * values; e.g. Name,Industry,TickerSymbol + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.retrieve = function(objtype, id, fieldlist, callback) { + this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + '/' + id + + '?fields=' + fieldlist, callback); + } + + /* + * Updates field values on a record of the given type. + * @param objtype object type; e.g. "Account" + * @param id the record's object ID + * @param fields an object containing initial field names and values for + * the record, e.g. {:Name "salesforce.com", :TickerSymbol + * "CRM"} + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.update = function(objtype, id, fields, callback) { + this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + '/' + id + , callback, "PATCH", JSON.stringify(fields)); + } + + /* + * Deletes a record of the given type. Unfortunately, 'delete' is a + * reserved word in JavaScript. + * @param objtype object type; e.g. "Account" + * @param id the record's object ID + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.del = function(objtype, id, callback) { + this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + '/' + id + , callback, "DELETE"); + } + + /* + * Executes the specified SOQL query. + * @param soql a string containing the query to execute - e.g. "SELECT Id, + * Name from Account ORDER BY Name LIMIT 20" + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.query = function(soql, callback) { + this.proxyAjax('/' + this.apiVersion + '/query?q=' + escape(soql) + , callback); + } + + /* + * Executes the specified SOSL search. + * @param sosl a string containing the search to execute - e.g. "FIND + * {needle}" + * @param callback function to which response will be passed + */ + forcetk.Client.prototype.search = function(sosl, callback) { + this.proxyAjax('/' + this.apiVersion + '/search?s=' + escape(sosl) + , callback); + } +} \ No newline at end of file diff --git a/license b/license new file mode 100644 index 0000000..16a6267 --- /dev/null +++ b/license @@ -0,0 +1,25 @@ +Copyright (c) 2010, Salesforce.com +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. +* Neither the name of Salesforce.com nor the names of its contributors may be + used to endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.