20 |
20 | 
51 |
60 | var oauthObject = OAuthSimple().sign({path:'http://example.com/rest/',
61 | parameters: 'foo=bar&gorp=banana',
62 | signatures:{
63 | api_key:'12345abcd',
64 | shared_secret:'xyz-5309'
65 | }});
66 | document.getElementById('someLink').href=oauthObject.signed_url;
67 |
68 | *
69 | * that will sign as a "GET" using "SHA1-MAC" the url. If you need more than
70 | * that, read on, McDuff.
71 | */
72 |
73 | /** OAuthSimple creator
74 | *
75 | * Create an instance of OAuthSimple
76 | *
77 | * @param api_key {string} The API Key (sometimes referred to as the consumer key) This value is usually supplied by the site you wish to use.
78 | * @param shared_secret (string) The shared secret. This value is also usually provided by the site you wish to use.
79 | */
80 | OAuthSimple = function (consumer_key,shared_secret)
81 | {
82 | /* if (api_key == undefined)
83 | throw("Missing argument: api_key (oauth_consumer_key) for OAuthSimple. This is usually provided by the hosting site.");
84 | if (shared_secret == undefined)
85 | throw("Missing argument: shared_secret (shared secret) for OAuthSimple. This is usually provided by the hosting site.");
86 | */ var self = {};
87 | self._secrets={};
88 |
89 |
90 | // General configuration options.
91 | if (consumer_key !== undefined) {
92 | self._secrets['consumer_key'] = consumer_key;
93 | }
94 | if (shared_secret !== undefined) {
95 | self._secrets['shared_secret'] = shared_secret;
96 | }
97 | self._default_signature_method= "HMAC-SHA1";
98 | self._action = "GET";
99 | self._nonce_chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
100 | self._parameters={};
101 |
102 |
103 | self.reset = function() {
104 | this._parameters={};
105 | this._path=undefined;
106 | this.sbs=undefined;
107 | return this;
108 | };
109 |
110 | /** set the parameters either from a hash or a string
111 | *
112 | * @param {string,object} List of parameters for the call, this can either be a URI string (e.g. "foo=bar&gorp=banana" or an object/hash)
113 | */
114 | self.setParameters = function (parameters) {
115 | if (parameters === undefined) {
116 | parameters = {};
117 | }
118 | if (typeof(parameters) == 'string') {
119 | parameters=this._parseParameterString(parameters);
120 | }
121 | this._parameters = this._merge(parameters,this._parameters);
122 | if (this._parameters['oauth_nonce'] === undefined) {
123 | this._getNonce();
124 | }
125 | if (this._parameters['oauth_timestamp'] === undefined) {
126 | this._getTimestamp();
127 | }
128 | if (this._parameters['oauth_method'] === undefined) {
129 | this.setSignatureMethod();
130 | }
131 | if (this._parameters['oauth_consumer_key'] === undefined) {
132 | this._getApiKey();
133 | }
134 | if(this._parameters['oauth_token'] === undefined) {
135 | this._getAccessToken();
136 | }
137 | if(this._parameters['oauth_version'] === undefined) {
138 | this._parameters['oauth_version']=='1.0';
139 | }
140 |
141 | return this;
142 | };
143 |
144 | /** convienence method for setParameters
145 | *
146 | * @param parameters {string,object} See .setParameters
147 | */
148 | self.setQueryString = function (parameters) {
149 | return this.setParameters(parameters);
150 | };
151 |
152 | /** Set the target URL (does not include the parameters)
153 | *
154 | * @param path {string} the fully qualified URI (excluding query arguments) (e.g "http://example.org/foo")
155 | */
156 | self.setURL = function (path) {
157 | if (path == '') {
158 | throw ('No path specified for OAuthSimple.setURL');
159 | }
160 | this._path = path;
161 | return this;
162 | };
163 |
164 | /** convienence method for setURL
165 | *
166 | * @param path {string} see .setURL
167 | */
168 | self.setPath = function(path){
169 | return this.setURL(path);
170 | };
171 |
172 | /** set the "action" for the url, (e.g. GET,POST, DELETE, etc.)
173 | *
174 | * @param action {string} HTTP Action word.
175 | */
176 | self.setAction = function(action) {
177 | if (action === undefined) {
178 | action="GET";
179 | }
180 | action = action.toUpperCase();
181 | if (action.match('[^A-Z]')) {
182 | throw ('Invalid action specified for OAuthSimple.setAction');
183 | }
184 | this._action = action;
185 | return this;
186 | };
187 |
188 | /** set the signatures (as well as validate the ones you have)
189 | *
190 | * @param signatures {object} object/hash of the token/signature pairs {api_key:, shared_secret:, oauth_token: oauth_secret:}
191 | */
192 | self.signatures = function(signatures) {
193 | if (signatures)
194 | {
195 | this._secrets = this._merge(signatures,this._secrets);
196 | }
197 | // Aliases
198 | if (this._secrets['api_key']) {
199 | this._secrets.consumer_key = this._secrets.api_key;
200 | }
201 | if (this._secrets['access_token']) {
202 | this._secrets.oauth_token = this._secrets.access_token;
203 | }
204 | if (this._secrets['access_secret']) {
205 | this._secrets.oauth_secret = this._secrets.access_secret;
206 | }
207 | if (this._secrets['oauth_token_secret']) {
208 | this._secrets.oauth_secret = this._secrets.oauth_token_secret;
209 | }
210 | // Gauntlet
211 | if (this._secrets.consumer_key === undefined) {
212 | throw('Missing required consumer_key in OAuthSimple.signatures');
213 | }
214 | if (this._secrets.shared_secret === undefined) {
215 | throw('Missing required shared_secret in OAuthSimple.signatures');
216 | }
217 | if ((this._secrets.oauth_token !== undefined) && (this._secrets.oauth_secret === undefined)) {
218 | throw('Missing oauth_secret for supplied oauth_token in OAuthSimple.signatures');
219 | }
220 | return this;
221 | };
222 |
223 | self.setTokensAndSecrets = function(signatures) {
224 | return this.signatures(signatures);
225 | };
226 |
227 | /** set the signature method (currently only Plaintext or SHA-MAC1)
228 | *
229 | * @param method {string} Method of signing the transaction (only PLAINTEXT and SHA-MAC1 allowed for now)
230 | */
231 | self.setSignatureMethod = function(method) {
232 | if (method === undefined) {
233 | method = this._default_signature_method;
234 | }
235 | //TODO: accept things other than PlainText or SHA-MAC1
236 | if (method.toUpperCase().match(/(PLAINTEXT|HMAC-SHA1)/) === undefined) {
237 | throw ('Unknown signing method specified for OAuthSimple.setSignatureMethod');
238 | }
239 | this._parameters['oauth_signature_method']= method.toUpperCase();
240 | return this;
241 | };
242 |
243 | /** sign the request
244 | *
245 | * note: all arguments are optional, provided you've set them using the
246 | * other helper functions.
247 | *
248 | * @param args {object} hash of arguments for the call
249 | * {action:, path:, parameters:, method:, signatures:}
250 | * all arguments are optional.
251 | */
252 | self.sign = function (args) {
253 | if (args === undefined) {
254 | args = {};
255 | }
256 | // Set any given parameters
257 | if(args['action'] !== undefined) {
258 | this.setAction(args['action']);
259 | }
260 | if (args['path'] !== undefined) {
261 | this.setPath(args['path']);
262 | }
263 | if (args['method'] !== undefined) {
264 | this.setSignatureMethod(args['method']);
265 | }
266 | this.signatures(args['signatures']);
267 | this.setParameters(args['parameters']);
268 | // check the parameters
269 | var normParams = this._normalizedParameters();
270 | this._parameters['oauth_signature']=this._generateSignature(normParams);
271 | return {
272 | parameters: this._parameters,
273 | signature: this._oauthEscape(this._parameters['oauth_signature']),
274 | signed_url: this._path + '?' + this._normalizedParameters(),
275 | header: this.getHeaderString()
276 | };
277 | };
278 |
279 | /** Return a formatted "header" string
280 | *
281 | * NOTE: This doesn't set the "Authorization: " prefix, which is required.
282 | * I don't set it because various set header functions prefer different
283 | * ways to do that.
284 | *
285 | * @param args {object} see .sign
286 | */
287 | self.getHeaderString = function(args) {
288 | if (this._parameters['oauth_signature'] === undefined) {
289 | this.sign(args);
290 | }
291 |
292 | var j,pName,pLength,result = 'OAuth ';
293 | for (pName in this._parameters)
294 | {
295 | if (pName.match(/^oauth/) === undefined) {
296 | continue;
297 | }
298 | if ((this._parameters[pName]) instanceof Array)
299 | {
300 | pLength = this._parameters[pName].length;
301 | for (j=0;j| Source: | " + escapeText( source ) + " |
|---|
| Expected: | " + expected + " |
|---|---|
| Result: | " + actual + " |
| Diff: | " + QUnit.diff( expected, actual ) + " |
| Source: | " + escapeText( source ) + " |
| Result: | " + escapeText( actual ) + " |
|---|---|
| Source: | " + escapeText( source ) + " |