/// WebOS OAuth \\\

This Files where downloaded from http://github.com/fillito/WebOS-OAuth

By: Daniel García (fillito)
E-Mail: fillito@gmail.com
Web: www.fillito.com
Madrid - Spain
Last Update : 2010 Jul 22

Description : 
------------

    This is just a small library for making OAuth Authentications in Palm WebOS. 
You just have to instantiate it passing a json object with the complete OAuth configurations (requestToken Url, authorize Url, accessToken Url, consumer_key, consumer_key_secret) and push it as a normal Mojo Scene. 

The application MUST be configured as a web-application on the server side (non client application).
This library captures the callback redirect url to get the final token to complete the authentication. 


Installation :
-------------

1.  Simple copy and paste All files except the sources.json into your WebOS Application folder. 
2.  Open your application's sources.json file and paste the content of the sources.json included in this library

	 {"source": "app/assistants/utils/oauth.js"},
   	 {
        	"scenes": "oauth",
	        "source": "app/assistants/oauth-assistant.js"
	 } 

     So your application can access the library files

3. Simple set up a json object containing the configuration data as shown here and push the oauth Scene

	var oauthConfig={
		callbackScene:'assistantName', //Name of the assistant to be called on the OAuth Success
		requestTokenUrl:'http:// -domain- /oauth/request_token',
		requestTokenMethod:'GET', // Optional - 'GET' by default if not specified
		authorizeUrl:'http:// -domain- /oauth/authorize',
		accessTokenUrl:'http:// -domain- /oauth/access_token',
		accessTokenMethod:'GET', // Optional - 'GET' by default if not specified
		consumer_key:' -your consumer key- ',
		consumer_key_secret:' -your consumer key secret- ',
		callback:'http://www.google.com' // Optional - 'oob' by default if not specified
	 };
	 Mojo.Controller.stageController.pushScene('oauth',oauthConfig);	
	

Web App Configuration :
----------------------

This library does a little tricky hack so you can make an OAuth Authentication for any OAuth API. 
Some OAuth API offers two types of application authentication : web app & client app.
Client Apps type returns a PIN code that you can use as authentication token, but not all API offers this method. 

This library enable OAuth on WebOS ONLY for Web App type Authentication. If you know a little bit about OAuth, you will realise that web app type needs a Callback URL to return the oauth token as a GET parameter. The trick this library uses, is to capture this token as the server redirects. 

To enable this, the only thing you have to take into account, is to configure your application (registered to access the API) callback URL to redirect to www.google.com.  <----- IMPORTANT !!!!

This library listen the embedded web browser to be redirected to www.google.com/?oauth_token=******* , so you MUST set it so it works.

- Contact me if you have dubts about it -
 ------------------------------
|   UPDATE ! : 2010 April 30   |
 ------------------------------

APIs also accept the callback to be passed as a parameter throught the OAuth process. Configure it on your application OAuth Server if it's mandatory or on your self application if this option is enabled.


Comments : 
---------

This is just the first version of this library. Please, contact me if you need anything related to this library or you want to make any suggestion to improve it.

Thanks for download !!
Fork me at GitHub !!  http://github.com/fillito/WebOS-OAuth