... h1. Overview
This page describes the plugin specification for the integration of [status.net|http://status.net] microblogging platform into Community Equity.
The status.net activity streams plugin will support th activity streams standard 1.0 [activity streams|http://martin.atkins.me.uk/specs/activitystreams/activityschema] AND CEQ specific extensions.
{gliffy:name=overview|space=ceqdoc|page=Laconica Plugin (status.net)|pageid=126615635|align=left|size=M}
h1. Table of contents
{toc}
h1. Unique URL mapping
|| URL || Remark ||
| [http://xx.xx/notice/5185338] | using unique notice ID |
h1. User ID mapping
{tip} this table is used to map the UserID from your web venue to the CeQ User Key {tip}
(!) Laconica should be integrated with OpenSSO. Then we would not need any userID mapping
|| CeQ || status.net \\ || Activity Streams \\ || CeQ Extension \\ || Remark ||
| PersonKey | | display name \\
[http://activitystrea.ms/schema/1.0/person] | display name \\
[http://activitystrea.ms/schema/1.0/person] | |
| ScreenName | | display name \\
[http://activitystrea.ms/schema/1.0/person] | display name \\
[http://activitystrea.ms/schema/1.0/person] | |
| Surname \\ | | | | -extracted from email address with assumption firstname.lastname@xxx- |
| GivenName \\ | | | | -extracted from email address with assumption firstname.lastname@xxx- |
| Email \\ | | | <email:"address"> \\ | |
| PictureURL \\ | | avatar \\
[http://activitystrea.ms/schema/1.0/person] | | PhotoURL \\ |
| Country \\ | | | <country:"country"> | Country of the user's Primary address \\ |
(!) if integrated with OpenSSO - getting all attributes from Master authentication service - means no need to map UserID
h1. Asset type mapping
{tip} this table is used to map the asset type from your web venue to the CeQ application type {tip}
|| Asset Type || CeQ Application || Laconi.ca \\ || Activity streams object || Remark \\ ||
| Microblogging \\ | Microblogging \\ | Notice \\ | [{{http://activitystrea.ms/schema/1.0/note}}|http://activitystrea.ms/schema/1.0/article] | see [http://martin.atkins.me.uk/specs/activitystreams/activityschema#anchor8] for details \\ |
| Attachment \\ | Attachment \\ | Attachment to a notice \\ | [http://activitystrea.ms/schema/1.0/file] | are attachments just images or general attachments . If its just images we should use [http://activitystrea.ms/schema/1.0/photo] or \\ |
h1. Activity mapping
{tip} this table is used to map the activities between status.net and CeQ. {tip}
|| CeQ Activity || Activity Streams Verb \\ || Micro Blogging || status.net \\ ||
| CREATE: Indicates that an information has been created | Post \\ [http://activitystrea.ms/schema/1.0/post|http://activitystrea.ms/schema/1.0/post]\\ [Documentation|http://martin.atkins.me.uk/specs/activitystreams/atomactivity#postverb] | . | onEndNoticeSave |
| DELETE: Indicates that an information has been deleted | Delete \\ [http://community-equity.org/schema/1.0/delete|http://community-equity.org/schema/1.0/delete]\\
\* add additional post verb to support default activity streams reader \\ | | onEndNoticeDelete |
| CLONE: Indicates that an information has been cloned | Clone \\
[http://community-equity.org/schema/1.0/clone] \\
\* add additional post verb to support default activity streams reader \\ | ReTweet by whom | onEndNoticeSave, RT @username message |
| RATE: Indicates that an information has been rated | Favorite \\
[http://activitystrea.ms/schema/1.0/favorite]\\
\\
Unfavorite \\
[http://community-equity.org/schema/1.0/unfavorite|http://community-equity.org/schema/1.0/delete]\\
\* add additional post verb to support default activity streams reader \\
\\
-Rate- \\
-[http://community-equity.org/schema/1.0/rate |http://community-equity.org/schema/1.0/rate]- \\
Suggest to use favorite and do the mapping in the CEQ backend e.g. \\
favorite = 5star, unfavorite= 1star or 3star? \\ | How many times it's been favored - if favored - map to 5 star? by whom? \\
\[http://community-equity.org/schema/1.0/rate\]
{quote}
see activity streams discussion on [rate|http://wiki.activitystrea.ms/Rating-Verb-Examples]
{quote} | onFavorNotice / onDisfavorNotice |
| COMMENT: Indicates that an information has been commented | Post \\ [http://activitystrea.ms/schema/1.0/post|http://activitystrea.ms/schema/1.0/post]\\ [Documentation|http://martin.atkins.me.uk/specs/activitystreams/atomactivity#postverb] | How many responses there are to it.? by whom? | onEndNoticeSave, checks if the comment_to field has a value |
| UPDATE_META_DATA: Indicates that the meta data of an information has been updated | N/A | N/A \\ | N/A \\ |
| TAG: Indicates that an information has been tagged | Tag \\ [http://activitystrea.ms/schema/1.0/tag|http://activitystrea.ms/schema/1.0/tag]\\ [Documentation|http://martin.atkins.me.uk/specs/activitystreams/activityschema#anchor5] | \#tags and \!tags | onEndNoticeSave, check all tags and groups used and send it over |
| VIEW: Indicates that an information has been viewed | Play \\ [http://activitystrea.ms/schema/1.0/play|http://activitystrea.ms/schema/1.0/play]\\ [Documentation|http://martin.atkins.me.uk/specs/activitystreams/activityschema#play] | | |
| Join Group \\ | Join \\ [http://activitystrea.ms/schema/1.0/join|http://activitystrea.ms/schema/1.0/join]\\ [Documentation|http://martin.atkins.me.uk/specs/activitystreams/activityschema#join] | | |
| Leave Group \\ | [http://community-equity.org/schema/1.0/leave|http://community-equity.org/schema/1.0/clone]\\
\* add additional post verb to support default activity streams reader | | |
| N/A \\ | start follow \\
[http://activitystrea.ms/schema/1.0/follow]\\ | | |
| N/A \\ | [http://community-equity.org/schema/1.0/unfollow|http://community-equity.org/schema/1.0/clone]\\
\* add additional post verb to support default activity streams reader | | |
h1. Access Control mapping
{tip} this section is used to map the Access control information from your web venue to the CeQ ACL service {tip}
h2. Group/Members synchronization
# Define which system is the System of Record (SoR) for the group/membership management
# Define the synchronization model from your SoR with the CeQ group management
Laconica groups are the SoR for Groups. Following events need to be captured
|| Event \\ || status.net \\ || CeQ \\ || Activity streams \\ || Remark \\ ||
| Create Group \\ | | | [http://activitystrea.ms/schema/1.0/group] | |
| Delete Group \\ | | | [http://activitystrea.ms/schema/1.0/group] | |
h2. Information ACL mapping
(!) if we have ACL in .8 an beyond we should map read/write access
|| InformationID or URL || Read || Write || Admin ||
| [https://xxx.com/xxx] | group(s),user(s) || group(s),user(s) | group(s),user(s) |
h1. Options
h2.
h3.
h2. Feed duration
There will be a parameter in the feed URL to define the date/time and page_size of the feed. The default will be 1 day
{code}
Example: http://xxx.com/feed/activity.atom?datetime=01/012/2009/12:00&page_size=100
{code}
h1. Related Tickets |