Difference between revisions of "Web Services"

Revision as of 19:03, 10 July 2013

As of Sugar 0.100, there is a mechanism for using web services from Sugar.

There is new section to the Sugar Control Panel to manage online accounts and some interventions to the Sugar Journal toolbars and palettes in order to expose any installed online services, adding Copy-to and Refresh capabilities to the journal.

We have implemented three examples:

support specific to Facebook: to share Journal entries on Facebook and to retrieve comments on those entries from Facebook (walter and rgs);
support specific to Twitter: to share Journal entries as tweets and to retrieve comments on those entries from Twitter (tch);
support for uploading Journal entries to a local server (tch).

We are working with community members on other extensions based on the framework and encourage other community members to work with us on additional services.

For now, web services implementations are welcome to handle their retrieval of tokens on their own. In the future we might want to delegate that to Gnome Online Accounts or a similar auth/token provider.

Installing web services

We don't yet have a simple installer for web services, so for the time being:

Using git

cd ~/.sugar/default
git clone <MY WEBSERVICE>.git

Using tar

cd ~/.sugar/default
wget <MY WEBSERVICE>
gunzip <MY WEBSERVICE>.tar.gz
tar xvf <MY WEBSERVICE>.tar

Web services

Facebook

tar file: [1]
git repo: [2]

You should end up with the following directory structure:

~/.sugar/default/extensions/webservice/
├── __init__.py
└── facebook
    ├── __init__.py
    ├── account.py
    ├── facebook
    │   ├── __init__.py
    │   └── facebook.py
    └── icons
        ├── facebook-like-insensitive.svg
        ├── facebook-like.svg
        ├── facebook-refresh-insensitive.svg
        ├── facebook-refresh.svg
        ├── facebook-share-insensitive.svg
        └── facebook-share.svg

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

@@ Line 21: / Line 21: @@
 === Using tar ===
-# cd ~/.sugar/default/extensions  (you may have to create this directory with mkdir)
+# cd ~/.sugar/default
 # wget <MY WEBSERVICE>
 # gunzip <MY WEBSERVICE>.tar.gz