Skip to content
This repository has been archived by the owner on Feb 27, 2018. It is now read-only.

lukaszkorecki/RequestPack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Request pack

Request pack consists of two classes which make consuming REST services really easy.

It's built for use with web runtimes such as Titanium Desktop or Google Chrome Applications.

Why not just use jQuery/Prototype/AwesomeFramework?

Because it's simple and just works. It also doesn't depend on any other library (except jsOAuth).

API

RequestPack consists of two classes, each using same interface, but differing in the way authentication works:

  • Request - is a wrapper around XMLHttpRequest and provides simple interface which is suitable for any sane API
  • OAuthRequest - has the same API but uses jsOAuth as the core for making requests:

Request

Request is easy to use and provides neat abstraction from regular XMLHttpRequest stuff:

req = new Req 'http://server.com/api', { accept : 'application/json'} , {username : 'lol', password : 'wat'}

req.get('/chunkybacon',
  onSuccess : (request) -> console.log(request.responseText)
  onFailure : (request) -> alert 'no bacon for you, lad'
)

...or in Javascript:

var req = new Req('http://server.com/api', { accept : 'application/json'} , {username : 'lol', password : 'wat'})

req.get('/chunkybacon', {
  onSuccess : function(request) {
    console.log(request.responseText);
  },
  onFailure : function(request) {
    alert( 'no bacon for you, lad');
  }
});

See Campfire class in examples directory for more details.

TODO

moar docs

Licence

MIT

About

Talking to REST services made simple

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published