svn commit: r1161111 - in /incubator/rave/site/trunk/content/rave: documentation/index.mdtext documentation/oauth-consumer.mdtext images/screenshot_oauth_gadget.png

[ja...@apache.org]

Author: jasha
Date: Wed Aug 24 14:22:43 2011
New Revision: 1161111

URL: http://svn.apache.org/viewvc?rev=1161111&view=rev
Log:
RAVE-82 Document how to use Rave as OAuth consumer

Added:
    incubator/rave/site/trunk/content/rave/documentation/oauth-consumer.mdtext
    incubator/rave/site/trunk/content/rave/images/screenshot_oauth_gadget.png   (with props)
Modified:
    incubator/rave/site/trunk/content/rave/documentation/index.mdtext

Modified: incubator/rave/site/trunk/content/rave/documentation/index.mdtext
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/documentation/index.mdtext?rev=1161111&r1=1161110&r2=1161111&view=diff
==============================================================================
--- incubator/rave/site/trunk/content/rave/documentation/index.mdtext (original)
+++ incubator/rave/site/trunk/content/rave/documentation/index.mdtext Wed Aug 24 14:22:43 2011
@@ -18,4 +18,7 @@ Notice:    Licensed to the Apache Softwa
 
 ## Deployments
   - [Installing](installing.html)
-     - [Host configuration](host-configuration.html)
\ No newline at end of file
+     - [Host configuration](host-configuration.html)
+
+## Howto
+  - [Use Rave as OAuth consumer](oauth-consumer.html)
\ No newline at end of file

Added: incubator/rave/site/trunk/content/rave/documentation/oauth-consumer.mdtext
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/documentation/oauth-consumer.mdtext?rev=1161111&view=auto
==============================================================================
--- incubator/rave/site/trunk/content/rave/documentation/oauth-consumer.mdtext (added)
+++ incubator/rave/site/trunk/content/rave/documentation/oauth-consumer.mdtext Wed Aug 24 14:22:43 2011
@@ -0,0 +1,53 @@
+Title: Use Rave as OAuth consumer
+Notice:    Licensed to the Apache Software Foundation (ASF) under one
+           or more contributor license agreements.  See the NOTICE file
+           distributed with this work for additional information
+           regarding copyright ownership.  The ASF licenses this file
+           to you under the Apache License, Version 2.0 (the
+           "License"); you may not use this file except in compliance
+           with the License.  You may obtain a copy of the License at
+           .
+             http://www.apache.org/licenses/LICENSE-2.0
+           .
+           Unless required by applicable law or agreed to in writing,
+           software distributed under the License is distributed on an
+           "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+           KIND, either express or implied.  See the License for the
+           specific language governing permissions and limitations
+           under the License.
+
+After following the instuctions, you will be able to use Rave as an OAuth consumer. You will add an OpenSocial Gadget
+that displays your Google Contacts, using Google as OAuth provider.
+
+# Place the gadget definition on your server
+Place the [example OAuth Gadget](http://gadget-doc-examples.googlecode.com/svn/trunk/opensocial-gadgets/oauth-contacts.xml)
+on your *own* public server. Make sure that the gadget is accessible without any restrictions.
+
+# Register your web application
+Follow [Google's instructions](http://code.google.com/apis/accounts/docs/RegistrationForWebAppsAuto.html) to register
+your domain for OAuth Authentication. You will create an OAuth consumer key and secret.
+
+# Add the OAuth consumer key and secret to the Rave database
+Until there is a web interface to handle the contents of the database, execute the following query (use your own values)
+
+    INSERT INTO oauth_consumer_store(id, gadget_uri, service_name, consumer_key, consumer_secret, key_type)
+    VALUES (set(@consumer_store_id_oauth, next value for consumer_store_id_seq),
+                                    'http://example.com/sampleoauth.xml', 'google',
+                                    'gadgetConsumer', 'gadgetSecret', 'HMAC-SYMMETRIC');
+
+# Add your Widget to the Rave database
+Within the Widget Store it is possible to add your own Widget. Self added widgets must be published first.
+
+    INSERT INTO widget (id, title, url, type, widget_status)
+    VALUES(set(@widget_id_oauth, next value for widget_id_seq), 'Google Contacts',
+            'http://example.com/sampleoauth.xml', 'OpenSocial', 'PUBLISHED');
+
+# Use the Widget
+ - Go to the Widget Store and add the "Google Contacts" gadget.
+ - Then go back to your page.
+  - Click on the link "Personalize this gadget"
+  - If you are not logged in yet, log in with your Google account
+  - Click on the "Grant access" button
+- You are being redirected back to the portal. You should now see your Google contacts
+
+![Screenshot of Sample OAuth Gadget](/rave/images/screenshot_oauth_gadget.png)
\ No newline at end of file

Added: incubator/rave/site/trunk/content/rave/images/screenshot_oauth_gadget.png
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/images/screenshot_oauth_gadget.png?rev=1161111&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/rave/site/trunk/content/rave/images/screenshot_oauth_gadget.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream