jeena/tent.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Add some app examples

Browse source
This commit is contained in:
Jonathan Rudenberg 2012-09-05 22:35:31 -04:00
parent 966052ce82
commit 3fedbc2a71
3 changed files with 29 additions and 139 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Gemfile.lock
View file

@ -16,7 +16,7 @@ GIT
GIT GIT
remote: git@github.com:tent/tent-apidoc.git remote: git@github.com:tent/tent-apidoc.git
revision: e2a5370bf7b0a6c76bccfbed64737fec13118016 revision: dcd6de68a96f6f747b22cfaec38665df36999937
branch: master branch: master
specs: specs:
tent-apidoc (0.1.0) tent-apidoc (0.1.0)
@ -28,7 +28,7 @@ GIT
GIT GIT
remote: git@github.com:tent/tent-client-ruby.git remote: git@github.com:tent/tent-client-ruby.git
revision: 8688a03c6858512cd25201a5366c201ee3b12440 revision: 14be20e340477e75bfb9bedb962fd5c2c96173cb
branch: master branch: master
specs: specs:
tent-client (0.0.1) tent-client (0.0.1)

158
content/docs/app-auth.md
View file

@ -15,19 +15,12 @@ Authentication](http://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-01).
### App Registration ### App Registration
Before authenticating a user, the application must be registered with the Before authenticating a user, the application must be registered with the
specified Tent entity. The first step is to perform discovery on the provided specified Tent entity. The first step is to perform discovery on the provided
entity url. entity url.
```text {discovery example}
HEAD /
Host: titanous.com
```
```text
200 OK
Tent-Server: https://tent.titanous.com
```
The next step is to register the application with the server. Registration The next step is to register the application with the server. Registration
specifies some details about the app, as well as the exact `redirect_uris` that specifies some details about the app, as well as the exact `redirect_uris` that
@ -35,95 +28,15 @@ will be used during the OAuth flow. The response `id`, `secret`, and
`mac_algorithm` are used to authenticate future requests to the Tent server. `mac_algorithm` are used to authenticate future requests to the Tent server.
The `id` is used as the `client_id` in all OAuth requests. The `id` is used as the `client_id` in all OAuth requests.
```text {create_app example}
POST /apps
Content-Type: application/json
Accept: application/json
```
```json #### App JSON Schema
{
"name": "FooApp",
"description": "Does amazing foos with your data",
"url": "http://foooo.com",
"icon": "http://foooo.com/icon.png",
"redirect_uris": ["http://fooapp.com/tent/callback"],
"scopes": {
"write_profile": "Uses an app profile section to describe foos",
"read_followings": "Calculates foos based on your followings"
}
}
```
```text
201 Created
Content-Type: application/json
Location: https://tent.titanous.com/apps/6737b
```
```json
{
"id": "6737b",
"secret": "3d2adf9a68bf64f4eaff70a7c7700a8",
"mac_algorithm": "hmac-sha-256"
}
```
#### Request Parameters
| Name | Required | Type | Description |
| --------------- | -------- | ------ | ----------- |
| `name` | Required | String | The human name of the app to show the user |
| `description` | Required | String | A short description of the application to show the user |
| `url` | Required | String | The main url of the app |
| `icon` | Optional | String | The url to an icon for the app |
| `redirect_uris` | Optional | Array | A list of **exact** (including parameters) urls that will be used as OAuth `redirect_uri` |
| `scopes` | Optional | Object | A list of scope key to description value mappings of all scopes that the app might use. The descriptions should describe why the specific scope is necessary for the app to function. |
#### Response Parameters
| Name | Description |
| --------------- | ----------- |
| `id` | The identifier of the app. This is used as the MAC key identifier for requests to/from the Tent server, as well as the `client_id` in the OAuth flow. |
| `secret` | The secret used as the MAC key when modifying the registration and receiving notifications. |
| `mac_algorithm` | The MAC algorithm to be used. |
### App Registration Modification
The request must be authenticated with a MAC generated using the secret from the
initial registration.
#### PATCH /apps/:id
```text
PATCH /apps/aff70a7
Host: tent.titanous.com
Content-Type: application/json
Accept: application/json
Authorization: MAC id="aff70a7",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
```
```json
{
"name": "FooApp",
"description": "Does amazing foos with your data",
"url": "http://foooo.com",
"icon": "http://foooo.com/icon.png",
"redirect_uris": ["http://fooapp.com/tent/callback"],
"scopes": {
"write_profile": "Uses an app profile section to describe foos",
"read_followings": "Calculates foos based on your followings"
}
}
```
{app schema}
### Authentication Flow ### Authentication Flow
#### Auth Request #### Auth Request
The app requests the user's Tent identifier, and performs discovery on it to The app requests the user's Tent identifier, and performs discovery on it to
@ -131,12 +44,12 @@ find the Tent API root. The app then builds an auth request and redirects the
user-agent to it: user-agent to it:
```text ```text
/auth?client_id=6737b /oauth/authorize?client_id={app_id var}
&redirect_uri=http://fooapp.com/tent/callback &redirect_uri=http://app.example.com/tent/callback
&scope=read_posts,read_profile &scope=read_posts,read_profile
&state=87351cc2f6737bfc8ba &state=87351cc2f6737bfc8ba
&tent_profile_info_types=https://tent.io/types/info/music &tent_profile_info_types=https://tent.io/types/info/music/v0.1.0
&tent_post_types=https://tent.io/types/posts/status##0.2.0,https://tent.io/types/posts/photo##0.2.0 &tent_post_types=https://tent.io/types/posts/status/v0.1.0,https://tent.io/types/posts/photo/v0.1.0
``` ```
##### Parameters ##### Parameters
@ -147,8 +60,8 @@ user-agent to it:
| `redirect_uri` | Required | The URI to redirect to after authentication is complete. It must **exactly** match a URI (including parameters) provided during app registration in `redirect_uris`. | | `redirect_uri` | Required | The URI to redirect to after authentication is complete. It must **exactly** match a URI (including parameters) provided during app registration in `redirect_uris`. |
| `state` | Optional | This parameter will be added to the `redirect_uri` and should always be set to a random string that is stored in the session, and then verified to prevent cross-site request forgery attacks. | | `state` | Optional | This parameter will be added to the `redirect_uri` and should always be set to a random string that is stored in the session, and then verified to prevent cross-site request forgery attacks. |
| `scope` | Optional | A comma-separated list of scopes that the app is requesting access to. | | `scope` | Optional | A comma-separated list of scopes that the app is requesting access to. |
| `tent_profile_info_types` | Optional | A comma-separated list of `profile_info_type_url##version` profile info type specifiers that the app is requesting access to. Set to `all` to request full access to the profile. | | `tent_profile_info_types` | Optional | A comma-separated list of profile info type urls that the app is requesting access to. Set to `all` to request full access to the profile. |
| `tent_post_types` | Optional | A comma-separated list of `post_type_url##version` type/version specifiers that the app is requesting access to. Set to `all` to request access to all posts. | | `tent_post_types` | Optional | A comma-separated list of type urls that the app is requesting access to. Set to `all` to request access to all posts. |
##### Scopes ##### Scopes
@ -176,7 +89,7 @@ the initial request to prevent request forgery.
```text ```text
302 Found 302 Found
Location: http://fooapp.com/tent/callback?code=27ec1c54980f1af74&state=87351cc2f6737bfc8ba Location: http://app.example.com/tent/callback?code={app_code var}&state=87351cc2f6737bfc8ba
``` ```
#### Access Token #### Access Token
@ -184,44 +97,12 @@ Location: http://fooapp.com/tent/callback?code=27ec1c54980f1af74&state=87351cc2f
The `code` must be traded for permanent authentication details that can be used The `code` must be traded for permanent authentication details that can be used
to access the Tent server on behalf of the user. to access the Tent server on behalf of the user.
##### POST /apps/:id/access\_token ##### POST /apps/:id/authorizations
The request must be signed with a MAC using the secret obtained during app The request must be signed with a MAC using the secret obtained during app
registration. Currently only the `mac` `token_type` is supported. registration. Currently only the `mac` `token_type` is supported.
```text {app_auth example}
POST /apps/6737b/access_token
Content-Type: application/json
Accept: application/json
Authorization: MAC id="6737b",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
```
```json
{
"code": "27ec1c54980f1af74",
"token_type": "mac"
}
```
The server will respond with the authentication details necessary to interact
with the Tent server on behalf of the user.
```text
200 OK
Content-Type: application/json
```
```json
{
"access_token": "7b7df67598602",
"mac_key": "18bcf2bae86948731",
"mac_algorithm": "hmac-sha-256"
"token_type": "mac",
}
```
##### Response Parameters ##### Response Parameters
@ -246,5 +127,10 @@ authorized using the credentials retrieved at the end of the auth flow.
The `access_token` and `mac_key` are the MAC key identifier and MAC key The `access_token` and `mac_key` are the MAC key identifier and MAC key
respectively. respectively.
Currently all Authorization headers in this documentation are fake, but they
will be real examples when we have the example generator written. ### App Registration Modification
The request must be authenticated with a MAC generated using the secret from the
initial registration.
#### PUT /apps/:id

6
lib/api_example.rb
View file

@ -5,7 +5,7 @@ class ApiExampleFilter < Nanoc::Filter
type :text type :text
def run(content, params={}) def run(content, params={})
content.gsub(/\{(\w+) example\}/) { api_example($1) } content.gsub(/\{(\w+) example\}/) { api_example($1) }.gsub(/\{(\w+) var\}/) { api_var($1) }
end end
private private
@ -13,4 +13,8 @@ class ApiExampleFilter < Nanoc::Filter
def api_example(id) def api_example(id)
TentApiDoc.examples[id.to_sym] TentApiDoc.examples[id.to_sym]
end end
def api_var(id)
TentApiDoc.variables[id.to_sym]
end
end end