Difference between revisions of "Web Services"

 
(28 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
As of Sugar 0.100, there is a mechanism for using web services from Sugar.
 
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.
+
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 Sugar Journal.
  
We have implemented three examples:
+
We have implemented several 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 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 specific to Twitter: to share Journal entries as tweets and to retrieve comments on those entries from Twitter (tch);
 +
# support for uploading text to Pastebin (tch);
 
# support for uploading Journal entries to a local server (tch).
 
# support for uploading Journal entries to a local server (tch).
 +
# [https://github.com/ignaciouy/upload-webservice support for uploading files to PutLocker] (ignacio)
 +
# [https://github.com/ignaciouy/sugar-gdrive support for uploading files to Google Drive] (ignacio)
 +
# [https://github.com/walterbender/sugarservices support for accessing the Sugar shell from Sugar activities] (walter and tch)
 +
 +
[[File:Webservices.png|300px]]
 +
 +
A new controlpanel widget for managing services
 +
 +
[[File:Configpastebin.bmp|300px]]
 +
 +
An extra icon appears in "My Settings"; Example, configuring Pastebin
 +
 +
[[File:Copypastebin.png|300px]]
 +
 +
The Journal menu now allows you to copy an entry to your web service e.g. Pastebin
  
 
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.
 
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.
Line 16: Line 32:
 
We don't yet have a simple installer for web services, so for the time being:
 
We don't yet have a simple installer for web services, so for the time being:
  
# download the <MY WEBSERVICE>.tar.gz file
+
=== Using a Sugar activity ===
# mv <MY WEBSERVICE>.tar.gz to ~/.sugar/default/extensions/
+
 
 +
See http://activities.sugarlabs.org/en-US/sugar/addon/4723
 +
 
 +
=== Using git ===
 +
# cd ~/.sugar/default
 +
# git clone <MY WEBSERVICE>.git
 +
 
 +
[http://www.youtube.com/watch?v=vw_SiGs6nEc Demonstration]
 +
 
 +
=== Using gunzip and tar ===
 +
# cd ~/.sugar/default
 +
# wget <MY WEBSERVICE>
 
# gunzip <MY WEBSERVICE>.tar.gz
 
# gunzip <MY WEBSERVICE>.tar.gz
 
# tar xvf <MY WEBSERVICE>.tar
 
# tar xvf <MY WEBSERVICE>.tar
  
=== Webservices ===
+
== Web services ==
 +
 
 +
=== Facebook ===
 +
* tar file: [http://people.sugarlabs.org/walter/facebook.tar.gz]
 +
* git repo: [https://github.com/walterbender/facebook]
 +
 
 +
You should end up with the following directory structure:
 +
<pre>
 +
~/.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
 +
</pre>
 +
 
 +
== PutLocker ==
 +
* tar file: [http://people.sugarlabs.org/ignacio/sugarupload.tar.gz]
 +
* git repo: [https://github.com/ignaciouy/upload-webservice]
 +
 
 +
You should end up with the following directory structure:
 +
<pre>
 +
~/.sugar/default/extensions/webservice/
 +
├── __init__.py
 +
└── sugarupload
 +
    ├── account.py
 +
    ├── icons
 +
    │   └── sugarupload.svg
 +
    ├── __init__.py
 +
    └── sugarupload
 +
        ├── grestful
 +
        │   ├── decorators.py
 +
        │   ├── errors.py
 +
        │   ├── helpers.py
 +
        │   ├── __init__.py
 +
        │   └── object.py
 +
        ├── __init__.py
 +
        └── sugarupload.py
 +
 
 +
~/.sugar/default/extensions/cpsection/
 +
├── __init__.py
 +
└── webaccount
 +
    ├── __init__.py
 +
    └── services
 +
        ├── __init__.py
 +
        └── sugarupload
 +
            ├── __init__.py
 +
            └── service.py
 +
 
 +
</pre>
 +
 
 +
== Sugar Google Drive ==
 +
* tar file: [http://people.sugarlabs.org/ignacio/sugarupload.tar.gz]
 +
* git repo: [https://github.com/ignaciouy/sugar-gdrive]
 +
 
 +
<pre>
 +
~/.sugar/default/extensions/webservice/
 +
├── apiclient
 +
│   ├── channel.py
 +
│   ├── discovery.py
 +
│   ├── errors.py
 +
│   ├── http.py
 +
│   ├── __init__.py
 +
│   ├── mimeparse.py
 +
│   ├── model.py
 +
│   ├── sample_tools.py
 +
│   └── schema.py
 +
├── httplib2
 +
│   ├── cacerts.txt
 +
│   ├── __init__.py
 +
│   ├── iri2uri.py
 +
│   └── socks.py
 +
├── __init__.py
 +
├── oauth2client
 +
│   ├── anyjson.py
 +
│   ├── appengine.py
 +
│   ├── client.py
 +
│   ├── clientsecrets.py
 +
│   ├── crypt.py
 +
│   ├── django_orm.py
 +
│   ├── file.py
 +
│   ├── gce.py
 +
│   ├── __init__.py
 +
│   ├── keyring_storage.py
 +
│   ├── locked_file.py
 +
│   ├── multistore_file.py
 +
│   ├── old_run.py
 +
│   ├── tools.py
 +
│   ├── util.py
 +
│   └── xsrfutil.py
 +
├── sugargdrive
 +
│   ├── account.py
 +
│   ├── icons
 +
│   │   └── sugargdrive.svg
 +
│   ├── __init__.py
 +
│   └── sugargdrive
 +
│      ├── __init__.py
 +
│      └── sugargdrive.py
 +
└── uritemplate
 +
    └── __init__.py
 +
 
 +
~/.sugar/default/extensions/cpsection/
 +
├── __init__.py
 +
└── webaccount
 +
    ├── __init__.py
 +
    └── services
 +
        ├── __init__.py
 +
        └── sugargdrive
 +
            ├── __init__.py
 +
            └── service.py
 +
</pre>
 +
 
 +
==Proposals==
 +
* Translation service [[WebServices/translation]]
 +
 
 +
==See also==
 +
See also [[features/Web_services]]
  
* facebook: [http://people.sugarlabs.org/walter/facebook.tar.gz]
+
There is a Sugar activity for installing web services: [http://activities.sugarlabs.org/en-US/sugar/addon/4723] by ignacio.

Latest revision as of 19:11, 29 July 2014

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 Sugar Journal.

We have implemented several examples:

  1. support specific to Facebook: to share Journal entries on Facebook and to retrieve comments on those entries from Facebook (walter and rgs);
  2. support specific to Twitter: to share Journal entries as tweets and to retrieve comments on those entries from Twitter (tch);
  3. support for uploading text to Pastebin (tch);
  4. support for uploading Journal entries to a local server (tch).
  5. support for uploading files to PutLocker (ignacio)
  6. support for uploading files to Google Drive (ignacio)
  7. support for accessing the Sugar shell from Sugar activities (walter and tch)

Webservices.png

A new controlpanel widget for managing services

Configpastebin.bmp

An extra icon appears in "My Settings"; Example, configuring Pastebin

Copypastebin.png

The Journal menu now allows you to copy an entry to your web service e.g. Pastebin

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 a Sugar activity

See http://activities.sugarlabs.org/en-US/sugar/addon/4723

Using git

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

Demonstration

Using gunzip and tar

  1. cd ~/.sugar/default
  2. wget <MY WEBSERVICE>
  3. gunzip <MY WEBSERVICE>.tar.gz
  4. tar xvf <MY WEBSERVICE>.tar

Web services

Facebook

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

PutLocker

You should end up with the following directory structure:

~/.sugar/default/extensions/webservice/
├── __init__.py
└── sugarupload
    ├── account.py
    ├── icons
    │   └── sugarupload.svg
    ├── __init__.py
    └── sugarupload
        ├── grestful
        │   ├── decorators.py
        │   ├── errors.py
        │   ├── helpers.py
        │   ├── __init__.py
        │   └── object.py
        ├── __init__.py
        └── sugarupload.py

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

Sugar Google Drive

~/.sugar/default/extensions/webservice/
├── apiclient
│   ├── channel.py
│   ├── discovery.py
│   ├── errors.py
│   ├── http.py
│   ├── __init__.py
│   ├── mimeparse.py
│   ├── model.py
│   ├── sample_tools.py
│   └── schema.py
├── httplib2
│   ├── cacerts.txt
│   ├── __init__.py
│   ├── iri2uri.py
│   └── socks.py
├── __init__.py
├── oauth2client
│   ├── anyjson.py
│   ├── appengine.py
│   ├── client.py
│   ├── clientsecrets.py
│   ├── crypt.py
│   ├── django_orm.py
│   ├── file.py
│   ├── gce.py
│   ├── __init__.py
│   ├── keyring_storage.py
│   ├── locked_file.py
│   ├── multistore_file.py
│   ├── old_run.py
│   ├── tools.py
│   ├── util.py
│   └── xsrfutil.py
├── sugargdrive
│   ├── account.py
│   ├── icons
│   │   └── sugargdrive.svg
│   ├── __init__.py
│   └── sugargdrive
│       ├── __init__.py
│       └── sugargdrive.py
└── uritemplate
    └── __init__.py

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

Proposals

See also

See also features/Web_services

There is a Sugar activity for installing web services: [7] by ignacio.