kylefang/deployd
1
0
Fork 0
mirror of https://github.com/zhigang1992/deployd.git synced 2026-06-04 06:19:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:deployd/deployd

Browse Source
This commit is contained in:
Dallon Feldner
2012-04-05 09:11:10 -07:00
parent b5ee8ddb79 22d69acc27
commit 7800ce86e8
10 changed files with 526 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files

272
docs/collection.html
View File

@@ -4,6 +4,7 @@
<title>Deployd Documentation</title>
<link href="css/bootstrap.min.css" rel="stylesheet" type="text/css" />
<link href="css/style.css" rel="stylesheet" type="text/css" />
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
</head>
<body>
<div class="navbar navbar-fixed-top">
@@ -13,15 +14,280 @@
<a href="index.html"><img src="img/logo-text.png" alt="Deployd"></a>
</span>
<ul class="nav">
<li class="active"><a href="collection.html">Collection</a></li>
<li><a href="collection.html">Collection</a></li>
<li><a href="usercollection.html">User Collection</a></li>
<li><a href="static.html">Static</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<script>
$('.nav a').each(function () {
var url = window.location.toString();
if(url.indexOf($(this).attr('href')) === (url.lastIndexOf('/') + 1))
$(this).parent().addClass('active');
});
</script>
</div>
</div>
</div>
<div class="container">/bin/sh: markdown: command not found
<div class="container"><h1>Collection Resource</h1>
<p>A Collection resource allows your app to save and load data in a simple schema.</p>
<h2>Setting up a collection</h2>
<p>After creating a Collection resource in the dashboard, you can set up the schema by dragging properties into the database and naming them. </p>
<p>The grid view below the property list allows you to edit the Collection manually.</p>
<h2>Property types</h2>
<p>You can currently use the following property types:</p>
<ul>
<li><strong>String</strong> - Arbritrary text data</li>
<li><strong>Number</strong> - Numeric value, supports floating points</li>
<li><strong>Boolean</strong> - True or false</li>
<li><strong>Date</strong> - A specific point in time</li>
</ul>
<h2>Formats</h2>
<p>You must format the request body as a JSON string and pass the header "Content-Type: application/json".</p>
<h2>Saving data</h2>
<p>To save data, send a POST request to the root of the Collection:</p>
<pre><code>POST /people
Content-Type: application/json
{
"age": 23,
"firstName": "Joe",
"lastName": "Smith"
}
</code></pre>
<p>The server will respond with the object, which will have a new <code>_id</code> property. </p>
<pre><code>200 OK
{
"_id": "4f71fc7c2ba744786f000001",
"age": 23,
"firstName": "Joe",
"lastName": "Smith"
}
</code></pre>
<p>This <code>_id</code> is used to find the object's URL (i.e. <code>/people/4f71fc7c2ba744786f000001</code>)</p>
<h2>Listing data</h2>
<p>A GET request to the root of the Collection will return an array of objects in the collection:</p>
<pre><code>GET /people
200 OK
[
{
"_id": "4f71fc7c2ba744786f000001",
"age": 23,
"firstName": "Joe",
"lastName": "Smith"
},
{
"_id": "4f71fe8b2ba744786f000002",
"age": 36,
"firstName": "John",
"lastName": "Doe"
}
]
</code></pre>
<h2>Retrieving a specific object</h2>
<p>A GET request at an object's URL will return the properties of that object:</p>
<pre><code>GET /people/4f71fc7c2ba744786f000001
200 OK
{
"_id": "4f71fc7c2ba744786f000001",
"age": 23,
"firstName": "Joe",
"lastName": "Smith"
}
</code></pre>
<h2>Updating an object</h2>
<p>A PUT request at an object's URL will update the object. You must include all properties except for <code>_id</code>.</p>
<pre><code>PUT /people/4f71fc7c2ba744786f000001
Content-Type: application/json
{
"age": 24,
"firstName": "Fred",
"lastName": "Smith"
}
</code></pre>
<p>The server will respond with the entire object:</p>
<pre><code>200 OK
{
"_id": "4f71fc7c2ba744786f000001",
"age": 24,
"firstName": "Fred",
"lastName": "Smith"
}
</code></pre>
<h2>Deleting an object</h2>
<p>A DELETE request at an object's URL will permanently remove that object from the collection:</p>
<pre><code>DELETE /people/4f71fc7c2ba744786f000001
204 No Content
</code></pre>
<h2>Filtering results</h2>
<p>You can add querystring parameters to a GET request at the root to filter the results by properties specified:</p>
<pre><code>GET /people?firstName=Joe&amp;lastName=Smith
</code></pre>
<p><strong>NOTE</strong>: This currently only works for String properties.</p>
<h2>Advanced querying</h2>
<p>If you need to query additional types of properties, pass a JSON object as the <code>q</code> parameter with the properties you wish to filter:</p>
<pre><code>GET /people?q={
"age": 23
}
</code></pre>
<p>The <code>q</code> parameter supports <a href="http://www.mongodb.org/display/DOCS/Advanced+Queries">MongoDB's query language</a> for particularly advanced queries. Note that Collections do not currently support embedded documents or arrays.</p>
<pre><code>GET /people?q={
"$orderby": { "age": 1 },
"name": {
"$regex": "^j"
"$options": "i",
}
}
</code></pre>
<h1>Collection Event Handlers</h1>
<p>You can attach micro-scripts to events to add logic and validation to your objects. Collections currently support the following events:</p>
<ul>
<li><strong>On Get</strong> - called when data is read</li>
<li><strong>On Post</strong> - called when data is created</li>
<li><strong>On Put</strong> - called when data is updated</li>
<li><strong>On Delete</strong> - called when data is destroyed</li>
</ul>
<h2>Reading and setting properties</h2>
<p>In an event micro-script, the <code>this</code> object refers to the current object, and has all of the properties of the object.</p>
<p>You can set values on the <code>this</code> object during an On Post or On Put event. These changes will be saved to the database.</p>
<pre><code>// On Post:
this.dateCreated = new Date();
// On Put:
this.totalScore = this.level1Points + this.level2Points;
</code></pre>
<h2>Accessing the current user</h2>
<p>If the request is coming from a logged in User, you can use the "me" object to access their properties.</p>
<pre><code>// On Post:
this.creator = me._id;
</code></pre>
<h2>Cancelling an event</h2>
<p>You can stop any event by calling the <code>cancel(message, [code])</code> method.</p>
<pre><code>//On Delete:
if (this.protected) {
cancel('This post is protected and cannot be deleted');
}
DELETE /posts/123456
400 Bad Request
{
"message": "This post is protected and cannot be deleted"
}
</code></pre>
<p>You can pass an integer to the <code>cancel()</code> method as the second parameter to set the HTTP status code. For example, 401 means "Unauthorized".</p>
<pre><code>//On Put
if (this.creator !== me._id) {
cancel("You cannot view this post because it is not yours!", 401);
}
PUT /posts/13456
Content-Type: application/json
{ ... }
401 Unauthorized
{
"message": "You cannot view this post because it is not yours!"
}
</code></pre>
<h2>Validation</h2>
<p>Use the <code>error(name, message)</code> function to add a validation error.</p>
<pre><code>//On Post
if (this.age &lt; 18) {
error('age', 'must be older than 18')
}
POST /people
{
"firstName": "Joe",
"lastName": "Smith",
"age": 12
}
400 Bad Request
{
errors: {
"age": "must be older than 18"
}
}
</code></pre>
<h2>Hiding properties</h2>
<p>If you wish to hide certain properties from a user, use the <code>hide(propertyName)</code> function.</p>
<pre><code>//On Get
if (this.creator !== me._id) {
hide('lastName');
hide('age');
}
</code></pre>
<h2>Protecting properties from modification</h2>
<p>Use the <code>protect(propertyName)</code> function to protect specified properties during a POST or PUT.</p>
<pre><code>//On Put
protect('createdDate');
</code></pre>
</div>
</body>

79
docs/collection.markdown
View File

@@ -1,17 +1,14 @@
Collection Resource
===================
# Collection Resource
A Collection resource allows your app to save and load data in a simple schema.
Setting up a collection
-----------------------
## Setting up a collection
After creating a Collection resource in the dashboard, you can set up the schema by dragging properties into the database and naming them.
The grid view below the property list allows you to edit the Collection manually.
Property types
--------------
## Property types
You can currently use the following property types:
@@ -20,13 +17,11 @@ You can currently use the following property types:
* **Boolean** - True or false
* **Date** - A specific point in time
Formats
-------
## Formats
You must format the request body as a JSON string and pass the header "Content-Type: application/json".
Saving data
-----------
## Saving data
To save data, send a POST request to the root of the Collection:
@@ -38,7 +33,7 @@ To save data, send a POST request to the root of the Collection:
"lastName": "Smith"
}
The server will respond with the object, which will have a new "_id" property.
The server will respond with the object, which will have a new `_id` property.
200 OK
{
@@ -48,10 +43,9 @@ The server will respond with the object, which will have a new "_id" property.
"lastName": "Smith"
}
This _id is used to find the object's URL (i.e. /people/4f71fc7c2ba744786f000001)
This `_id` is used to find the object's URL (i.e. `/people/4f71fc7c2ba744786f000001`)
Listing data
------------
## Listing data
A GET request to the root of the Collection will return an array of objects in the collection:
@@ -73,8 +67,7 @@ A GET request to the root of the Collection will return an array of objects in t
}
]
Retrieving a specific object
----------------------------
## Retrieving a specific object
A GET request at an object's URL will return the properties of that object:
@@ -89,10 +82,9 @@ A GET request at an object's URL will return the properties of that object:
}
Updating an object
------------------
## Updating an object
A PUT request at an object's URL will update the object. You must include all properties except for "_id".
A PUT request at an object's URL will update the object. You must include all properties except for `_id`.
PUT /people/4f71fc7c2ba744786f000001
Content-Type: application/json
@@ -112,8 +104,8 @@ The server will respond with the entire object:
"lastName": "Smith"
}
Deleting an object
------------------
## Deleting an object
A DELETE request at an object's URL will permanently remove that object from the collection:
@@ -122,8 +114,7 @@ A DELETE request at an object's URL will permanently remove that object from the
204 No Content
Filtering results
-----------------
## Filtering results
You can add querystring parameters to a GET request at the root to filter the results by properties specified:
@@ -131,16 +122,15 @@ You can add querystring parameters to a GET request at the root to filter the re
**NOTE**: This currently only works for String properties.
Advanced querying
-----------------
## Advanced querying
If you need to query additional types of properties, pass a JSON object as the "q" parameter with the properties you wish to filter:
If you need to query additional types of properties, pass a JSON object as the `q` parameter with the properties you wish to filter:
GET /people?q={
"age": 23
}
The "q" parameter supports [MongoDB's query language](http://www.mongodb.org/display/DOCS/Advanced+Queries) for particularly advanced queries. Note that Collections do not currently support embedded documents or arrays.
The `q` parameter supports [MongoDB's query language](http://www.mongodb.org/display/DOCS/Advanced+Queries) for particularly advanced queries. Note that Collections do not currently support embedded documents or arrays.
GET /people?q={
"$orderby": { "age": 1 },
@@ -151,8 +141,7 @@ The "q" parameter supports [MongoDB's query language](http://www.mongodb.org/dis
}
Collection Event Handlers
=========================
# Collection Event Handlers
You can attach micro-scripts to events to add logic and validation to your objects. Collections currently support the following events:
@@ -161,12 +150,11 @@ You can attach micro-scripts to events to add logic and validation to your objec
* **On Put** - called when data is updated
* **On Delete** - called when data is destroyed
Reading and setting properties
------------------------------
## Reading and setting properties
In an event micro-script, the "this" object refers to the current object, and has all of the properties of the object.
In an event micro-script, the `this` object refers to the current object, and has all of the properties of the object.
You can set values on the "this" object during an On Post or On Put event. These changes will be saved to the database.
You can set values on the `this` object during an On Post or On Put event. These changes will be saved to the database.
// On Post:
this.dateCreated = new Date();
@@ -174,8 +162,7 @@ You can set values on the "this" object during an On Post or On Put event. These
// On Put:
this.totalScore = this.level1Points + this.level2Points;
Accessing the current user
--------------------------
## Accessing the current user
If the request is coming from a logged in User, you can use the "me" object to access their properties.
@@ -183,10 +170,9 @@ If the request is coming from a logged in User, you can use the "me" object to a
this.creator = me._id;
Cancelling an event
-------------------
## Cancelling an event
You can stop any event by calling the cancel(message, [code]) method.
You can stop any event by calling the `cancel(message, [code])` method.
//On Delete:
if (this.protected) {
@@ -200,7 +186,7 @@ You can stop any event by calling the cancel(message, [code]) method.
"message": "This post is protected and cannot be deleted"
}
You can pass an integer to the cancel() method as the second parameter to set the HTTP status code. For example, 401 means "Unauthorized".
You can pass an integer to the `cancel()` method as the second parameter to set the HTTP status code. For example, 401 means "Unauthorized".
//On Put
if (this.creator !== me._id) {
@@ -217,10 +203,9 @@ You can pass an integer to the cancel() method as the second parameter to set th
}
Validation
----------
## Validation
Use the error(name, message) function to add a validation error.
Use the `error(name, message)` function to add a validation error.
//On Post
if (this.age < 18) {
@@ -241,10 +226,9 @@ Use the error(name, message) function to add a validation error.
}
}
Hiding properties
-----------------
## Hiding properties
If you wish to hide certain properties from a user, use the hide(propertyName) function.
If you wish to hide certain properties from a user, use the `hide(propertyName)` function.
//On Get
if (this.creator !== me._id) {
@@ -252,10 +236,9 @@ If you wish to hide certain properties from a user, use the hide(propertyName) f
hide('age');
}
Protecting properties from modification
---------------------------------------
## Protecting properties from modification
Use the protect(propertyName) function to protect specified properties during a POST or PUT.
Use the `protect(propertyName)` function to protect specified properties during a POST or PUT.
//On Put
protect('createdDate');

55
docs/files.html Normal file
View File

@@ -0,0 +1,55 @@
<!DOCTYPE html>
<html>
<head>
<title>Deployd Documentation</title>
<link href="css/bootstrap.min.css" rel="stylesheet" type="text/css" />
<link href="css/style.css" rel="stylesheet" type="text/css" />
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<span class="brand">
<a href="index.html"><img src="img/logo-text.png" alt="Deployd"></a>
</span>
<ul class="nav">
<li><a href="collection.html">Collection</a></li>
<li><a href="usercollection.html">User Collection</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<script>
$('.nav a').each(function () {
var url = window.location.toString();
if(url.indexOf($(this).attr('href')) === (url.lastIndexOf('/') + 1))
$(this).parent().addClass('active');
});
</script>
</div>
</div>
</div>
<div class="container"><h1>Files Resource</h1>
<p>The Files Resource allows you host static files from your app, such as HTML, browser JavaScript, CSS, images, and videos. </p>
<h2>Accessing files</h2>
<p>Send a GET request with the filename to load the raw file. This is how browsers request pages and files by default.</p>
<pre><code>GET /files/bg.jpg
</code></pre>
<h2>Folders</h2>
<p>If you prefer to have separate folders for Javascript, CSS, and images, create multiple Static Resources at the paths you want to store the files.</p>
<p>You can also give a Static Resource an empty path <code>/</code>. This will assign it to the root of your app.</p>
<h2>Home page</h2>
<p>If a Static Resource receives a request without a filename, it will automatically redirect to "index.html" if available.</p>
</div>
</body>
</html>

19
docs/files.markdown Normal file
View File

@@ -0,0 +1,19 @@
# Files Resource
The Files Resource allows you host static files from your app, such as HTML, browser JavaScript, CSS, images, and videos.
## Accessing files
Send a GET request with the filename to load the raw file. This is how browsers request pages and files by default.
GET /files/bg.jpg
## Folders
If you prefer to have separate folders for Javascript, CSS, and images, create multiple Static Resources at the paths you want to store the files.
You can also give a Static Resource an empty path `/`. This will assign it to the root of your app.
## Home page
If a Static Resource receives a request without a filename, it will automatically redirect to "index.html" if available.

73
docs/index.html
View File

@@ -4,6 +4,7 @@
<title>Deployd Documentation</title>
<link href="css/bootstrap.min.css" rel="stylesheet" type="text/css" />
<link href="css/style.css" rel="stylesheet" type="text/css" />
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
</head>
<body>
<div class="navbar navbar-fixed-top">
@@ -13,15 +14,81 @@
<a href="index.html"><img src="img/logo-text.png" alt="Deployd"></a>
</span>
<ul class="nav">
<li class="active"><a href="collection.html">Collection</a></li>
<li><a href="collection.html">Collection</a></li>
<li><a href="usercollection.html">User Collection</a></li>
<li><a href="static.html">Static</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<script>
$('.nav a').each(function () {
var url = window.location.toString();
if(url.indexOf($(this).attr('href')) === (url.lastIndexOf('/') + 1))
$(this).parent().addClass('active');
});
</script>
</div>
</div>
</div>
<div class="container">/bin/sh: markdown: command not found
<div class="container"><div id="index">
<div class="hero-unit">
<h1>Deployd</h1>
<p>A modern web server for front-end developers.</p>
</div>
</div>
<h2>Basics</h2>
<p>Deployd is a web server built on resources, in the style of REST. In the dashboard, you can build your app by creating resources and configuring them to work the way the want.</p>
<h2>Routing</h2>
<p>When Deployd receives an HTTP request, it checks the first part of the URL to see which resource should handle the request:</p>
<ul>
<li><strong>/todos</strong>/12345 - handled by the <strong>/todos</strong> resource</li>
<li><strong>/admin</strong>/users/12345 - handled by the <strong>/admin</strong> resource, if it exists (you cannot create multi-part resource names)</li>
<li><strong>/img</strong>/bg.jpg - handled by the <strong>/img</strong> resource</li>
<li><strong>/</strong>index.html - handled by the <strong>/</strong> resource</li>
</ul>
<h2>Reserved resource names</h2>
<p>Certain resource paths are used internally by Deployd. You should not create resources with these names:</p>
<ul>
<li>/keys</li>
<li>/types</li>
<li>/resources</li>
<li>/sessions</li>
<li>/property-types</li>
<li>/__dashboard</li>
</ul>
<h2>REST</h2>
<p>REST is a web service design pattern that conforms closely to HTTP itself. In Deployd, HTTP methods or verbs have meaning:</p>
<ul>
<li><strong>GET</strong> - Load a resource without modifying it (this is a browser's default method)</li>
<li><strong>POST</strong> - Create a resource, or send data to a special that doesn't fit within these methods</li>
<li><strong>PUT</strong> - Update an existing resource</li>
<li><strong>DELETE</strong> - Destroy an existing resource</li>
</ul>
<p>In Deployd, HTTP response codes are also important:</p>
<ul>
<li><strong>200</strong> OK - The request succeeded</li>
<li><strong>204</strong> No Content - The request succeeded, but there is no content to return (for example, after a deletion, or requesting an empty list)</li>
<li><strong>400</strong> Bad Request - The request did not pass validation. Change the parameters and try again.</li>
<li><strong>401</strong> Unauthorized - The request's session does not have permission to access that resource. </li>
<li><strong>404</strong> Not Found - That URL does not reference an existing resource</li>
<li><strong>500</strong> Internal Server Error - Deployd has failed to process the request due to an unexpected error.</li>
</ul>
<h2>Cross-Origin AJAX</h2>
<p>Deployd is configured so that you can easily develop a web app locally on your computer. It will send Access-Control-Allow-Origin HTTP headers if a request is coming from localhost or your filesystem, which will allow modern web browsers to use AJAX normally. It will not send these headers for any other domain.</p>
</div>
</body>

12
docs/layout/header.html
View File

@@ -4,6 +4,7 @@
<title>Deployd Documentation</title>
<link href="css/bootstrap.min.css" rel="stylesheet" type="text/css" />
<link href="css/style.css" rel="stylesheet" type="text/css" />
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
</head>
<body>
<div class="navbar navbar-fixed-top">
@@ -13,10 +14,17 @@
<a href="index.html"><img src="img/logo-text.png" alt="Deployd"></a>
</span>
<ul class="nav">
<li class="active"><a href="collection.html">Collection</a></li>
<li><a href="collection.html">Collection</a></li>
<li><a href="usercollection.html">User Collection</a></li>
<li><a href="static.html">Static</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<script>
$('.nav a').each(function () {
var url = window.location.toString();
if(url.indexOf($(this).attr('href')) === (url.lastIndexOf('/') + 1))
$(this).parent().addClass('active');
});
</script>
</div>
</div>
</div>

28
docs/static.html
View File

@@ -1,28 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<title>Deployd Documentation</title>
<link href="css/bootstrap.min.css" rel="stylesheet" type="text/css" />
<link href="css/style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<span class="brand">
<a href="index.html"><img src="img/logo-text.png" alt="Deployd"></a>
</span>
<ul class="nav">
<li class="active"><a href="collection.html">Collection</a></li>
<li><a href="usercollection.html">User Collection</a></li>
<li><a href="static.html">Static</a></li>
</ul>
</div>
</div>
</div>
<div class="container">/bin/sh: markdown: command not found
</div>
</body>
</html>

23
docs/static.markdown
View File

@@ -1,23 +0,0 @@
Static Resource
===============
The Static Resource allows you host static files from your app, such as HTML, browser JavaScript, CSS, images, and videos.
Accessing files
---------------
Send a GET request with the filename to load the raw file. This is how browsers request pages and files by default.
GET /files/bg.jpg
Folders
-------
If you prefer to have seperate folders for Javascript, CSS, and images, create multiple Static Resources at the paths you want to store the files.
You can also give a Static Resource an empty path ("/"). This will assign it to the root of your app.
Home page
---------
If a Static Resource receives a request without a filename, it will automatically redirect to "index.html" if available.

68
docs/usercollection.html
View File

@@ -4,6 +4,7 @@
<title>Deployd Documentation</title>
<link href="css/bootstrap.min.css" rel="stylesheet" type="text/css" />
<link href="css/style.css" rel="stylesheet" type="text/css" />
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
</head>
<body>
<div class="navbar navbar-fixed-top">
@@ -13,15 +14,76 @@
<a href="index.html"><img src="img/logo-text.png" alt="Deployd"></a>
</span>
<ul class="nav">
<li class="active"><a href="collection.html">Collection</a></li>
<li><a href="collection.html">Collection</a></li>
<li><a href="usercollection.html">User Collection</a></li>
<li><a href="static.html">Static</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<script>
$('.nav a').each(function () {
var url = window.location.toString();
if(url.indexOf($(this).attr('href')) === (url.lastIndexOf('/') + 1))
$(this).parent().addClass('active');
});
</script>
</div>
</div>
</div>
<div class="container">/bin/sh: markdown: command not found
<div class="container"><h1>User Collection Resource</h1>
<p>A User Collection resource behaves much like the standard Collection resource, but adds the ability to authenticate with a username and password.</p>
<h2>Special properties</h2>
<p>The User Collection contains two special properties:</p>
<ul>
<li><strong>email</strong> - For security, hidden by default on all users except the current user.</li>
<li><strong>password</strong> - Never readable under any circumstances. Can only be set when the user is logged in, when creating a new user, or from the Dashboard.</li>
</ul>
<h2>Registering a user</h2>
<p>First create a user by POSTing it to the root of the collection.
For this example our collection will be called <code>/users</code>.</p>
<pre><code>POST /users/login
Content-Type: application/json
{
"email": "foo@bar.com",
"password": "barfoo"
}
</code></pre>
<h2>Authenticating a user</h2>
<p>To login a user, send a POST request to <code>/&lt;collection name&gt;/login</code>:</p>
<pre><code>POST /users/login
Content-Type: application/json
{
"email": "foo@bar.com",
"password": "barfoo"
}
</code></pre>
<p>The server will respond with the user, without the password.</p>
<pre><code>200 OK
{
"_id": "4f71fc7c2ba744786f000001",
"email": "foo@bar.com"
}
</code></pre>
<h2>Logging out</h2>
<p>To logout a user send a DELETE request to <code>/&lt;collection name&gt;/logout</code>:</p>
<pre><code>204 No Content
</code></pre>
<p>The currently logged in user is available when GETing <code>/users/me</code>.</p>
</div>
</body>

13
docs/usercollection.markdown
View File

@@ -1,18 +1,15 @@
User Collection Resource
========================
# User Collection Resource
A User Collection resource behaves much like the standard Collection resource, but adds the ability to authenticate with a username and password.
Special properties
------------------
## Special properties
The User Collection contains two special properties:
* **email** - For security, hidden by default on all users except the current user.
* **password** - Never readable under any circumstances. Can only be set when the user is logged in, when creating a new user, or from the Dashboard.
Authenticating a user
---------------------
## Registering a user
First create a user by POSTing it to the root of the collection.
For this example our collection will be called `/users`.
@@ -24,6 +21,8 @@ For this example our collection will be called `/users`.
"password": "barfoo"
}
## Authenticating a user
To login a user, send a POST request to `/<collection name>/login`:
POST /users/login
@@ -41,6 +40,8 @@ The server will respond with the user, without the password.
"email": "foo@bar.com"
}
## Logging out
To logout a user send a DELETE request to `/<collection name>/logout`:
204 No Content