====== Socialuty ======



This document is about both the protocol //spec// and the web-app //requirements & design//, written down while on the job...

Enjoy!


===== Login =====

==== spec ====

There is no protocol spec for login: each pear can implement its own.


==== requirements ====

To use the app users must be logged in.

This is done through an html form containing username and password field.\\
https protocol must be preferred.\\
Password are stored/sent as MD5 hashes.


==== design ====

users table:

^                      users                                         ^^^
|**//username//**|''varchar(20) PK''             |                     |
|//password//    |''varchar(20) not null''       |(MD5 hash)           |
|//firstname//   |''varchar(20) not null''       |                     |
|//lastname//    |''varchar(20) not null''       |                     |
|//picture//     |''varchar(20)''                |(url of the profile picture) |



===== Registration =====

==== spec ====

An user can optionally register to the socialuty.org site as to allow people to find her.\\
Here is the http to the registration page:

<code>

POST /register.php HTTP/1.1
host: www.socialuty.org
User-Agent: <useragent>
Content-Type: application/x-www-form-urlencoded
Content-Length: <length>

firstname=[firstname]
&lastname=[lastname]
&country=[country]
&city=[city]
&home=[pear-url]


HTTP/1.1 200 OK
Content-Type: text/xml

<socialuty:response xmlns:socialuty="www.socialuty.org">
    <socialuty:result>
        <code>S_OK</ code>
        <description>welcome</description>
        <details>...</details>
    </socialuty:result>
    <socialuty:data>
        <userid>1234567890</userid>
    </socialuty:data>
</socialuty:response>

</code>