Summer of Code/2013/Social Sugar project/Documentation

= Social Sugar = Social Sugar project involves development of GUI components that can help bring user's social interactions on external platforms into Sugar.

The first component we've are working on are the mini profiles.

Mini Profiles
Mini Profiles extend Web Service code adding minimal changes to the existing models to support social features such as fetching latest posts from multiple webservices and displaying it in Group View.

Detailed Description
For identification of a user on a webservice such as Project Sharing Website, or Fedora pastebin, a unique id will be used. The API of the webservice should allow posting/fetching resources related to the user via this UID (and if required authentication credentials such as API token).

BuddyModel

 * Each Buddy used to have properties like nick, color and current activity
 * We add another property  to the   which are populated initially from all webservice accounts.
 * social_ids is a dictionary of `service name`: `public id` pairs. E.g.
 * As are other properties like color, serialized social_ids are broadcasted to other online Sugar users via Telepathy.

WebServices Account Interface

 * Two new methods:  and   are added to Account class. (webservice.account.Account)
 * returns the public id associated with that account.
 * It is used to populate social_ids property initially
 * Public ids are used to fetch posts from the external webservice, e.g. latest project uploaded on Project Sharing Website. (This is implemented in the service specific extension.)
 * returns the latest post on the service.

WebServicePost

 * This is an abstract class for WebService posts returned by
 * Has unimplemented methods for title, message, image and hyperlink.

UI additions
All additions are in Group view. (F2)

Small Cloud Icon

 * A small cloud shaped icon is displayed over your friend when you both have a social sugar extension installed.
 * This icon can be clicked to view latest posts from web service account of your friend.



Large Cloud Icon

 * On clicking the small cloud icon, it expands to a larger cloud
 * This Icon acts as a placeholder for the latest post from webservice.
 * The cloud has a speech bubble like pointer to the buddy.
 * The content on this icon:
 * is provided by fetching latest posts from all the webservice accounts of my friend.
 * is rotated after a fixed time to make the interface interactive and responsive.
 * can be paused using the pause icon for kids who can take longer to read a message.
 * can have a small icon (of the service) and upto 180 characters of text.
 * Large cloud is closed by clicking on the cross (x) button which automatically suspends auto fetching/rotating of the latest posts.



Technical details for the cloud content implementation

 * SmallCloudIcon inherits  which gives it the color matching that of the buddy.
 * CloudContent is placed on top of the LargeCloudIcon using Gtk.Overlay
 * LargeCloudIcon inherits
 * The button-release-event is bound to SmallCloudIcon, whose callback draws the Gtk.Overlay containing LargeCloudIcon and CloudContent.
 * Cloud content consists of a VBox of service icon, a label and HBox containing close and pause icons.

Sugar-GMoksaya
Sugar-GMoksaya is a webservice extension which allows us to post journal projects to Moksaya, the Project Sharing Website. Addition of Mini Profile code allows us to view latest projects from our friends in Group View.

Details

 * Moksaya needs username and api key for any request. Also, we need public id of the moksaya user to fetch latest projects.
 * We ask for username and password from the user in Settings > WebService.
 * These are used to fetch the api key and public id.
 * api key, username and public id are stored in GConf for future use. Passwords are not stored.
 * Sharing is same as in webservice extension, from Journal > Copy to > GMoksaya
 * If Gmoksaya account is also configured in your friends' Sugar, then they will send you their public ids.
 * Our extension fetches latest post from friends account and keeps it in memory.
 * If the cloud is expanded, the latest post is displayed followed by  calls to other services and looping back to this service.
 * Powered by GMoksaya and gRESTful

Videos

 * Setup and sharing journal projects


 * View latest projects in Group View

Code
social-sugar branch on:


 * Sugar
 * Sugar Toolkit GTK 3
 * Sugar Artwork

master branch on:
 * Sugar GMoksaya

(Requires moksaya setup on local machine, social-sugar branch will use Rahul's deployed server making it easy to set up)

Testing
You can test the current implementation by following these steps:


 * 1) Set up your Sugar development environment
 * 2) Clone the social-sugar branch from following repositories replacing the appropriate modules in your sugar-build code:
 * 3) Sugar
 * 4) Sugar Toolkit GTK 3
 * 5) Sugar Artwork
 * 6) Clone the contents of mock-service repository inside  . You'll end up with the directory structure as shown below.
 * 7) Build Sugar and add Akshit Khurana (or other people running the service) as a friend from the neighbourhood view(F1). You can use the search to find people.
 * 8) Checkout the Friend view(F2).
 * 9) Click on the small cloud icon over the buddy icon, to view my latest mock-post!
 * 10) You should see something like: "Designed from the ground up especially for children, Sugar offers an alternative to traditional "office-desktop" software. Id: 458" in a giant speech bubble like cloud.
 * 11) Congratulations! You've got mock service running on Mini Profiles.

Directory Structure
~/.sugar/default/extensions/webservice/ ├── __init__.py └── mock-service ├── __init__.py   ├── account.py    ├── mock-service │  ├── __init__.py    │   └── mock-service.py    └── icons └── mock-service.svg

~/.sugar/default/extensions/cpsection/ ├── __init__.py └── webaccount ├── __init__.py   └── services ├── __init__.py       └── mock-service ├── __init__.py           └── service.py