Skip to content

Commit

Permalink
Correct link doc
Browse files Browse the repository at this point in the history
  • Loading branch information
andreareginato committed Apr 22, 2011
1 parent 72d61d0 commit ff6ab9b
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 13 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.rdoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
= Changelog

== Release v0.3.1 (2011/04/22)

* Added documentation with screenshots
*


== Release v0.3.0 (2011/04/21)

Expand Down
24 changes: 12 additions & 12 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ that code along with its client secret to the Rest OAuth 2.0 Server in order to

=== Getting an access token

This flow begins by sending the user to the authorization endpoint <tt>http://localhost:3000/oauth/authorization</tt>
This flow begins by sending the user to the authorization endpoint <tt>/oauth/authorization</tt>
with the following query parameters

* <b>response_type</b> (REQUIRED): always use "code" as response type
Expand Down Expand Up @@ -189,7 +189,7 @@ If the user approves access will be appended an authorization code in the query
https://example.com/callback?code=g2VDXwrT0S6iZeUeYQBYi2stxRy&state=2af5D3vds

Now, the client reached through the <tt>redirect_uri</tt> should swap that authorization code for an access token by POSTing
it along the following params to the token endpoint <tt>http://localhost:3000/oauth/token</tt> using the JSON format.
it along the following params to the token endpoint <tt>/oauth/token</tt> using the JSON format.

* <b>code</b> (REQUIRED): authorization code (from the previous step)
* <b>grant_type</b> (REQUIRED): always use "authorization_code" as grant type
Expand Down Expand Up @@ -261,7 +261,7 @@ and SilverLight).
=== Getting a user's permission


This flow begins by sending the user to the authorization endpoint <tt>http://localhost:3000/oauth/authorization</tt>
This flow begins by sending the user to the authorization endpoint <tt>/oauth/authorization</tt>
with the following query parameters

* <b>response_type</b> (REQUIRED): always use "token" as response type
Expand Down Expand Up @@ -316,7 +316,7 @@ system or a highly privileged application. The authorization server should take

=== Getting an access token

The client should POST to the token endpoint <tt>http://localhost:3000/oauth/token</tt> along with the following params
The client should POST to the token endpoint <tt>/oauth/token</tt> along with the following params
using the JSON format:

* <b>grant_type</b> (REQUIRED): always use "password" as grant type
Expand Down Expand Up @@ -423,20 +423,20 @@ Rest OAuth 2.0 Server allows you to personalize some options changing {oauth.yml
Rest OAuth 2.0 Server is working on top of 5 models. They are pretty simple so if you want to have more information about
them, check the source code, which is clearly documented.

* {OauthClient}[link:blob/master/app/models/oauth/oauth_client.rb]: represents the credentials of a client application.
* {OauthToken}[link:blob/master/app/models/oauth/oauth_token.rb]: represents the token used to access user's resources.
* {OauthAuthorizarion}[link:blob/master/app/models/oauth/oauth_authorization.rb]: represents the authorization token used to exchange an access token.
* {OauthAccess}[link:blob/master/app/models/oauth/oauth_access.rb]: represents the relation between a client and a user, whenever a user grant an authorization.
* {OauthDailyRequests}[link:blob/master/app/models/oauth/oauth_daily_request.rb]: represents a daily request from the client on behalf of a specific user.
* {OauthClient}[link:tree/master/app/models/oauth/oauth_client.rb]: represents the credentials of a client application.
* {OauthToken}[link:tree/master/app/models/oauth/oauth_token.rb]: represents the token used to access user's resources.
* {OauthAuthorizarion}[link:tree/master/app/models/oauth/oauth_authorization.rb]: represents the authorization token used to exchange an access token.
* {OauthAccess}[link:tree/master/app/models/oauth/oauth_access.rb]: represents the relation between a client and a user, whenever a user grant an authorization.
* {OauthDailyRequests}[link:tree/master/app/models/oauth/oauth_daily_request.rb]: represents a daily request from the client on behalf of a specific user.


== Basic auth system

In addition to the models above there is a basic authentication system

* {User}[link:blob/master/app/models/user.rb]: represents the basic user authentication functionalities
* {UsersController}[blob/master/app/controllers/users_controller.rb]: represents the user definition
* {SessionsController}[blob/master/app/controllers/sessions_controller.rb]: represents the session definition
* {User}[link:tree/master/app/models/user.rb]: represents the basic user authentication functionalities
* {UsersController}[link:tree/master/app/controllers/users_controller.rb]: represents the user definition
* {SessionsController}[link:tree/master/app/controllers/sessions_controller.rb]: represents the session definition

This model is kept simple on purpose, but you can easily change it with the authentication system you prefer like {Authlogic}[https://github.com/binarylogic/authlogic],
{Devise}[https://github.com/plataformatec/devise] or {Warden}[https://github.com/hassox/warden]. Just remember that your user model <b>must</b>
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.2.2
v0.3.1

0 comments on commit ff6ab9b

Please sign in to comment.