rave-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r807064 - in /websites/staging/rave/trunk/content: ./ rave/documentation/oauth-consumer.html
Date Fri, 02 Mar 2012 12:12:18 GMT
Author: buildbot
Date: Fri Mar  2 12:12:18 2012
New Revision: 807064

Log:
Staging update by buildbot for rave

Modified:
    websites/staging/rave/trunk/content/   (props changed)
    websites/staging/rave/trunk/content/rave/documentation/oauth-consumer.html

Propchange: websites/staging/rave/trunk/content/
------------------------------------------------------------------------------
    cms:source-revision = 1296165

Modified: websites/staging/rave/trunk/content/rave/documentation/oauth-consumer.html
==============================================================================
--- websites/staging/rave/trunk/content/rave/documentation/oauth-consumer.html (original)
+++ websites/staging/rave/trunk/content/rave/documentation/oauth-consumer.html Fri Mar  2
12:12:18 2012
@@ -70,30 +70,39 @@
     <h1 class="title">Use Rave as OAuth consumer</h1>
     <p>After following the instructions, 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.</p>
-<h2 id="place_the_gadget_definition_on_your_server">Place the gadget definition on
your server</h2>
+<h2 id="place-the-gadget-definition-on-your-server">Place the gadget definition on
your server</h2>
 <p>Place the <a href="http://gadget-doc-examples.googlecode.com/svn/trunk/opensocial-gadgets/oauth-contacts.xml">example
OAuth Gadget</a>
 on your <em>own</em> public server. Make sure that the gadget is accessible without
any restrictions.</p>
-<h2 id="register_your_web_application">Register your web application</h2>
+<h2 id="register-your-web-application">Register your web application</h2>
 <p>Follow <a href="http://code.google.com/apis/accounts/docs/RegistrationForWebAppsAuto.html">Google's
instructions</a> to register
 your domain for OAuth Authentication. You will create an OAuth consumer key and secret.</p>
-<h2 id="add_the_oauth_consumer_key_and_secret_to_the_rave_database">Add the OAuth consumer
key and secret to the Rave database</h2>
-<p>Until there is a web interface to handle the contents of the database, execute the
following query (use your own values)</p>
-<div class="codehilite"><pre><span class="n">INSERT</span> <span
class="n">INTO</span> <span class="n">oauth_consumer_store</span><span
class="p">(</span><span class="n">id</span><span class="p">,</span>
<span class="n">gadget_uri</span><span class="p">,</span> <span
class="n">service_name</span><span class="p">,</span> <span class="n">consumer_key</span><span
class="p">,</span> <span class="n">consumer_secret</span><span class="p">,</span>
<span class="n">key_type</span><span class="p">)</span>
-<span class="n">VALUES</span> <span class="p">(</span><span class="n">set</span><span
class="p">(</span><span class="nv">@consumer_store_id_oauth</span><span
class="p">,</span> <span class="k">next</span> <span class="n">value</span>
<span class="k">for</span> <span class="n">consumer_store_id_seq</span><span
class="p">),</span>
+<h2 id="add-the-oauth-consumer-key-and-secret-to-the-rave-database">Add the OAuth consumer
key and secret to the Rave database</h2>
+<p>Until there is a web interface to handle the contents of the database, modify and
execute the following query:</p>
+<div class="codehilite"><pre><span class="n">SET</span> <span
class="nv">@consumer_store_id_oauth</span> <span class="o">=</span> <span
class="p">(</span><span class="n">SELECT</span> <span class="n">seq_count</span>
<span class="n">FROM</span> <span class="n">RAVE_SHINDIG_SEQUENCES</span>
<span class="n">WHERE</span> <span class="n">seq_name</span> <span
class="o">=</span> <span class="s">&#39;oauth_consumer_store&#39;</span><span
class="p">);</span>
+<span class="n">INSERT</span> <span class="n">INTO</span> <span
class="n">oauth_consumer_store</span><span class="p">(</span><span
class="n">entity_id</span><span class="p">,</span> <span class="n">gadget_uri</span><span
class="p">,</span> <span class="n">service_name</span><span class="p">,</span>
<span class="n">consumer_key</span><span class="p">,</span> <span
class="n">consumer_secret</span><span class="p">,</span> <span class="n">key_type</span><span
class="p">)</span>
+<span class="n">VALUES</span> <span class="p">(</span><span class="nv">@consumer_store_id_oauth</span><span
class="p">,</span>
                                 <span class="s">&#39;http://example.com/sampleoauth.xml&#39;</span><span
class="p">,</span> <span class="s">&#39;google&#39;</span><span
class="p">,</span>
-                                <span class="s">&#39;gadgetConsumer&#39;</span><span
class="p">,</span> <span class="s">&#39;gadgetSecret&#39;</span><span
class="p">,</span> <span class="s">&#39;HMAC-SYMMETRIC&#39;</span><span
class="p">);</span>
+                                <span class="s">&#39;gadgetConsumer&#39;</span><span
class="p">,</span> <span class="s">&#39;gadgetSecret&#39;</span><span
class="p">,</span> <span class="s">&#39;HMAC_SYMMETRIC&#39;</span><span
class="p">);</span>
+<span class="n">UPDATE</span> <span class="n">RAVE_SHINDIG_SEQUENCES</span>
<span class="n">SET</span> <span class="n">seq_count</span> <span
class="o">=</span> <span class="p">(</span><span class="n">seq_count</span>
<span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">WHERE</span> <span class="n">seq_name</span> <span
class="o">=</span> <span class="s">&#39;oauth_consumer_store&#39;</span><span
class="p">;</span>
 </pre></div>
 
 
-<h2 id="add_your_widget_to_the_rave_database">Add your Widget to the Rave database</h2>
-<p>Within the Widget Store it is possible to add your own Widget. Self added widgets
must be published first.</p>
-<div class="codehilite"><pre><span class="n">INSERT</span> <span
class="n">INTO</span> <span class="n">widget</span> <span class="p">(</span><span
class="n">id</span><span class="p">,</span> <span class="n">title</span><span
class="p">,</span> <span class="n">url</span><span class="p">,</span>
<span class="n">type</span><span class="p">,</span> <span class="n">widget_status</span><span
class="p">)</span>
-<span class="n">VALUES</span><span class="p">(</span><span class="n">set</span><span
class="p">(</span><span class="nv">@widget_id_oauth</span><span class="p">,</span>
<span class="k">next</span> <span class="n">value</span> <span
class="k">for</span> <span class="n">widget_id_seq</span><span class="p">),</span>
<span class="s">&#39;Google Contacts&#39;</span><span class="p">,</span>
-        <span class="s">&#39;http://example.com/sampleoauth.xml&#39;</span><span
class="p">,</span> <span class="s">&#39;OpenSocial&#39;</span><span
class="p">,</span> <span class="s">&#39;PUBLISHED&#39;</span><span
class="p">);</span>
-</pre></div>
-
-
-<h2 id="use_the_widget">Use the Widget</h2>
+<ul>
+<li>gadget_uri: URI where the gadget definition is hosted</li>
+<li>service name: this value should match the value of attribute name in element OAuth/Service
in the gadget definition. In this example the service name is google</li>
+<li>consumer_key: the consumer key the OAuth consumer (Apache Rave) uses for the authentication
with the OAuth provider</li>
+<li>consumer_secret: the shared secret between the OAuth consumer (Apache Rave) and
OAuth provider</li>
+<li>key_type: allowed values are "HMAC_SYMMETRIC", "RSA_PRIVATE" and "PLAINTEXT"</li>
+</ul>
+<h2 id="add-your-widget-to-the-apache-rave-portal">Add your Widget to the Apache Rave
portal</h2>
+<ul>
+<li>Go to the widget store</li>
+<li>Click on "Add new widget"</li>
+<li>Enter the required form fields and submit the form</li>
+<li>Go to the admin interface (in the demo setup the 'canonical' user has admin privileges)</li>
+<li>Find the new widget and change its status from "preview" to "published"</li>
+</ul>
+<h2 id="use-the-widget">Use the Widget</h2>
 <ul>
 <li>Go to the Widget Store and add the "Google Contacts" gadget.</li>
 <li>Then go back to your page.<ul>



Mime
View raw message