RubyGems - camping-oauth - Versions diffs - 1.0.0 - Mend

camping-oauth 1.0.0

Files changed (102) hide show

data/doc/classes/OAuthCampingPlugin/Views.src/M000018.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>common_oauth_views (OAuthCampingPlugin::Views)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/camping-oauth.rb, line 937</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">common_oauth_views</span>
+                <span class="ruby-value str">&quot;\ndef authorize_failure\nh1 \&quot;You have denied access to this token\&quot;\nend\n\ndef authorize_failure_token_not_found\nh1 \&quot;Token not found\&quot;\nend\n\ndef authorize_failure_invalidated\nh1 \&quot;Token could not be authorized since it has become invalid\&quot;\nend\n\ndef authorize_success\nh1 \&quot;You have successfully authorized access to this token\&quot;\np @info\nend\n\ndef revoke_success\nh1 \&quot;You have successfully revoked access to this token\&quot;\np @info\nend\n&quot;</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/OAuthCampingPlugin/Views.src/M000019.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>register_view (OAuthCampingPlugin::Views)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/camping-oauth.rb, line 966</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">register_view</span>
+                <span class="ruby-value str">&quot;\ndef new_application_registration\nh2 \&quot;New OAuth Consumer\&quot;\nh3 \&quot;Application Registration\&quot;\ndiv.info @info if @info\nform.new_app_reg! :action =&gt; R(OAuthRegisterApplication), :method =&gt; 'post' do\nlabel 'Name (*)', :for =&gt; 'name'; br\ninput.app_name! :name =&gt; 'name', :type =&gt; 'text'; br\n\nlabel 'Url (*)', :for =&gt; 'url'; br\ninput.url :name =&gt; 'url', :type =&gt; 'text'; br\n\nlabel 'Callback Url (*)', :for =&gt; 'callback_url'; br\ninput.url :name =&gt; 'callback_url', :type =&gt; 'text'; br;\n\nlabel 'Support Url', :for =&gt; 'support_url'; br\ninput.url :name =&gt; 'support_url', :type =&gt; 'text'; br;br;\n\ninput :type =&gt; 'submit', :name =&gt; 'signup', :value =&gt; 'Register'\nend\nend\n\n&quot;</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/OAuthCampingPlugin/Views.src/M000020.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>registration_view (OAuthCampingPlugin::Views)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/camping-oauth.rb, line 995</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">registration_view</span>
+                <span class="ruby-value str">&quot;\ndef application_registration\nh2 \&quot;Application Registration\&quot;\ndiv @info if @info\n\ntable.application_registration do\ntr { td \&quot;Name\&quot;;                      td @application.name}\ntr { td \&quot;Url\&quot;;                                       td @application.url}\ntr { td \&quot;Support Url\&quot;;               td @application.support_url}\ntr { td \&quot;Callback Url\&quot;;      td @application.callback_url}\ntr { td \&quot;Key\&quot;;                               td @application.key}\ntr { td \&quot;Secret\&quot;;                    td @application.secret}\nend\nend\n\n&quot;</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/OAuthCampingPlugin/Views.src/M000021.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>authorize_view (OAuthCampingPlugin::Views)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/camping-oauth.rb, line 1017</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">authorize_view</span>
+                <span class="ruby-value str">&quot;\ndef authorize\ndiv @info if @info\nform :action =&gt; R(OAuthAuthorizeToken), :method =&gt; 'post' do\ninput :name =&gt; 'oauth_token', :type=&gt;'hidden', :value=&gt;@oauth_token;\ninput :name =&gt; 'authorize', :type=&gt;'checkbox';\nlabel 'Authorize token ' + @oauth_token, :for =&gt; 'authorize'; br\n\ninput :type =&gt; 'submit', :name =&gt; 'authorize_btn', :value =&gt; 'Authorize'\na \&quot;Cancel\&quot;, :href=&gt;\&quot;/applications\&quot;\nend\nend\n\n&quot;</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/OAuthCampingPlugin/Views.src/M000022.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>revoke_view (OAuthCampingPlugin::Views)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/camping-oauth.rb, line 1037</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">revoke_view</span>
+                <span class="ruby-value str">&quot;\ndef revoke\ndiv @info if @info\nform :action =&gt; R(OAuthRevokeToken), :method =&gt; 'post' do\ninput :name =&gt; 'oauth_token', :type=&gt;'hidden', :value=&gt;@token.token;\ninput :name =&gt; 'revoke', :type=&gt;'checkbox';\nlabel 'Revoke token ' + @token.token, :for =&gt; 'revoke'; br\n\ninput :type =&gt; 'submit', :name =&gt; 'revoke_btn', :value =&gt; 'Revoke'\na \&quot;Cancel\&quot;, :href=&gt;\&quot;/applications\&quot;\nend\nend\n\n&quot;</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/OAuthCampingPlugin/Views.src/M000023.html ADDED Viewed

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>include_oauth_views (OAuthCampingPlugin::Views)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/camping-oauth.rb, line 1058</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include_oauth_views</span>
+                <span class="ruby-identifier">module_eval</span> <span class="ruby-constant">OAuthCampingPlugin</span><span class="ruby-operator">::</span><span class="ruby-constant">Views</span>.<span class="ruby-identifier">common_oauth_views</span>
+                <span class="ruby-identifier">module_eval</span> <span class="ruby-keyword kw">do</span>
+                        <span class="ruby-identifier">app_module_name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">&quot;::&quot;</span>).<span class="ruby-identifier">first</span>
+                        <span class="ruby-identifier">mab_class_name</span> = <span class="ruby-node">&quot;#{app_module_name}::Mab&quot;</span>
+                        <span class="ruby-identifier">mab_class</span> = <span class="ruby-identifier">mab_class_name</span>.<span class="ruby-identifier">constantize</span>
+                        <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mab_class</span>.<span class="ruby-identifier">public_instance_methods</span>.<span class="ruby-identifier">include?</span> <span class="ruby-value str">'register'</span>
+                                <span class="ruby-identifier">module_eval</span> <span class="ruby-constant">OAuthCampingPlugin</span><span class="ruby-operator">::</span><span class="ruby-constant">Views</span>.<span class="ruby-identifier">register_view</span>
+                        <span class="ruby-keyword kw">end</span>
+                        <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mab_class</span>.<span class="ruby-identifier">public_instance_methods</span>.<span class="ruby-identifier">include?</span> <span class="ruby-value str">'application_registration'</span>
+                                <span class="ruby-identifier">module_eval</span> <span class="ruby-constant">OAuthCampingPlugin</span><span class="ruby-operator">::</span><span class="ruby-constant">Views</span>.<span class="ruby-identifier">registration_view</span>
+                        <span class="ruby-keyword kw">end</span>
+                        <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mab_class</span>.<span class="ruby-identifier">public_instance_methods</span>.<span class="ruby-identifier">include?</span> <span class="ruby-value str">'authorize'</span>
+                                <span class="ruby-identifier">module_eval</span> <span class="ruby-constant">OAuthCampingPlugin</span><span class="ruby-operator">::</span><span class="ruby-constant">Views</span>.<span class="ruby-identifier">authorize_view</span>
+                        <span class="ruby-keyword kw">end</span>
+                        <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">mab_class</span>.<span class="ruby-identifier">public_instance_methods</span>.<span class="ruby-identifier">include?</span> <span class="ruby-value str">'revoke'</span>
+                                <span class="ruby-identifier">module_eval</span> <span class="ruby-constant">OAuthCampingPlugin</span><span class="ruby-operator">::</span><span class="ruby-constant">Views</span>.<span class="ruby-identifier">revoke_view</span>
+                        <span class="ruby-keyword kw">end</span>
+                <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/created.rid ADDED Viewed

	@@ -0,0 +1 @@
1	+ Mon, 07 Jun 2010 05:09:03 -0600

data/doc/files/examples/camping-oauth-consumer/camping-oauth-consumer_rb.html ADDED Viewed

@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: camping-oauth-consumer.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>camping-oauth-consumer.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>examples/camping-oauth-consumer/camping-oauth-consumer.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Wed Jun 02 20:18:43 -0600 2010</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">CampingOAuthProvider_URL</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;http://localhost:3301/&quot;</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">CampingOAuthProvider_KEY</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;SQnIXDQyhFB5q3wfZyMY&quot;</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">CampingOAuthProvider_SECRET</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;PmW02FNs7rXG97sAVXMWhFoJVZ98cnj21vv6p1ad&quot;</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/files/examples/camping-oauth-provider/camping-oauth-provider_rb.html ADDED Viewed

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: camping-oauth-provider.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>camping-oauth-provider.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>examples/camping-oauth-provider/camping-oauth-provider.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Wed Jun 02 20:14:23 -0600 2010</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/files/lib/camping-oauth_rb.html ADDED Viewed

@@ -0,0 +1,576 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: camping-oauth.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>camping-oauth.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/camping-oauth.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Mon Jun 07 05:05:09 -0600 2010</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <table>
+<tr><td valign="top">Author:</td><td>Philippe F. Monnet (<a
+href="mailto:pfmonnet@gmail.com">pfmonnet@gmail.com</a>)
+</td></tr>
+<tr><td valign="top">Copyright:</td><td>Copyright (c) 2010 Philippe F. Monnet - <a
+href="../../classes/OAuth.html">OAuth</a> Camping plugin
+</td></tr>
+<tr><td valign="top">Copyright:</td><td>Copyright (c) 2009 Pelle Braendgaard - A subset of the Rails <a
+href="../../classes/OAuth.html">OAuth</a> plugin reused in <a
+href="../../classes/OAuth.html">OAuth</a> Camping
+</td></tr>
+<tr><td valign="top">License:</td><td>Distributes under the same terms as Ruby
+</td></tr>
+<tr><td valign="top">Version:</td><td>0.0.1
+</td></tr>
+</table>
+<h1>Installing Camping-<a href="../../classes/OAuth.html">OAuth</a></h1>
+<p>
+A lightweight <a href="../../classes/OAuth.html">OAuth</a> plugin for Ruby
+Camping. To install the library and its prerequisisites, type the following
+commands:
+</p>
+<pre>
+  $ gem install filtering_camping
+  $ gem install oauth
+  $ gem install oauth-plugin
+  $ gem install camping-oauth
+</pre>
+<h1>Adding <a href="../../classes/OAuth.html">OAuth</a> Provider Support To Your App</h1>
+<h3>Add new gem and require statements</h3>
+<p>
+Add the following statements towards the top of your source file (before
+the Camping.goes statement):
+</p>
+<pre>
+        gem 'camping' , '&gt;= 2.0'
+        gem 'filtering_camping'
+        gem 'oauth'
+        gem 'oauth-plugin'
+        %w(rubygems active_record camping camping/session markaby json redcloth erb
+        oauth
+        oauth/server
+        oauth/request_proxy
+        oauth/request_proxy/rack_request
+        filtering_camping
+        camping-oauth
+        ).each { |lib| require lib }
+</pre>
+<h3>Customizing the main module</h3>
+<p>
+First we&#8216;ll make sure to include the Camping::Session and
+CampingFilters modules, and to extend the app module with <a
+href="../../classes/OAuthCampingPlugin.html">OAuthCampingPlugin</a>, like
+so:
+</p>
+<pre>
+        module CampingOAuthProvider
+                include Camping::Session
+                include CampingFilters
+                extend  OAuthCampingPlugin
+                include OAuthCampingPlugin::Filters
+                # ...
+        end
+</pre>
+<p>
+This gives us the ability to leverage a logger for the camping-oauth
+plugin.
+</p>
+<p>
+<a
+href="../../classes/OAuthCampingPlugin.html#M000001">OAuthCampingPlugin.logger</a>
+= Logger.new(File.dirname(<em>FILE</em>) + &#8217;/yourmodule.log&#8217;);
+<a
+href="../../classes/OAuthCampingPlugin.html#M000001">OAuthCampingPlugin.logger</a>.level
+= Logger::DEBUG
+</p>
+<p>
+Now let&#8216;s customize the create method by adding a call to <a
+href="../../classes/OAuthCampingPlugin.html#M000003">OAuthCampingPlugin.create</a>,
+so we can give the plugin to run any needed initialization.
+</p>
+<pre>
+        def CampingOAuthProvider.create
+                OAuthCampingPlugin.create
+        end
+</pre>
+<p>
+Ok, at this point we have a minimally configured application module. Our
+next step is to move on to the Models module.
+</p>
+<h3>Plugging in the <a href="../../classes/OAuth.html">OAuth</a> models</h3>
+<p>
+First, we&#8216;ll include the include <a
+href="../../classes/OAuthCampingPlugin/Models.html">OAuthCampingPlugin::Models</a>
+module so we can get all the <a
+href="../../classes/OAuth.html">OAuth</a>-specific models. Then we&#8216;ll
+define a User model. The User will need to keep track of the applications
+it provided access to. It will also manage the tokens associated with these
+applications. Our model will look like this:
+</p>
+<pre>
+        class User &lt; Base;
+                has_many :client_applications
+                has_many :tokens,
+                        :class_name=&gt;&quot;OauthToken&quot;,
+                        :order=&gt;&quot;authorized_at desc&quot;,
+                        :include=&gt;[:client_application]
+        end
+</pre>
+<p>
+Now we need a CreateUserSchema migration class to define our database
+tables for User, and <a href="../../classes/OAuth.html">OAuth</a> models.
+In the up and down methods we will plugin a call to the corresponding
+method from the <a
+href="../../classes/OAuthCampingPlugin/Models.html">OAuthCampingPlugin::Models</a>
+module to create the tables for ClientApplication, OAuthToken, and
+OauthNonce.
+</p>
+<pre>
+        class CreateUserSchema &lt; V 1.0
+                def self.up
+                        create_table :CampingOAuthProvider_users, :force =&gt; true do |t|
+                                t.integer   :id, :null =&gt; false
+                                t.string            :username
+                                t.string            :password
+                        end
+                        User.create :username =&gt; 'admin', :password =&gt; 'camping'
+                        OAuthCampingPlugin::Models.up
+                end
+                def self.down
+                        OAuthCampingPlugin::Models.down
+                        drop_table :CampingOAuthProvider_users
+                end
+        end
+</pre>
+<p>
+At this point we can go back to the main module and add the code to
+configure the ActiveRecord connection and invoke our new schema migration
+if the User table does not exist yet. This code will be added to the create
+method:
+</p>
+<pre>
+        module CampingOAuthProvider
+                # ...
+                def CampingOAuthProvider.create
+                        dbconfig = YAML.load(File.read('config/database.yml'))
+                        Camping::Models::Base.establish_connection  dbconfig['development']
+                        OAuthCampingPlugin.create
+                        CampingOAuthProvider::Models.create_schema :assume =&gt; (CampingOAuthProvider::Models::User.table_exists? ? 1.1 : 0.0)
+                end
+        end
+</pre>
+<p>
+You probably noticed that the database configuration is loaded from a
+database.yml file. So let&#8216;s create a subfolder named config and a
+file named database.yml, then let&#8216;s configure the yaml file as
+follows:
+</p>
+<pre>
+        development:
+          adapter: sqlite3
+          database: campingoauthprovider.db
+</pre>
+<p>
+Now if we restart the application, our migration should be executed.
+</p>
+<h3>Creating a common helpers module</h3>
+<p>
+The Helpers module is used in Camping to provide common utilities to both
+the Controllers and Views modules. Enhancing our Helpers module is very
+easy, we need to add both and extend and an include of the <a
+href="../../classes/OAuthCampingPlugin/Helpers.html">OAuthCampingPlugin::Helpers</a>
+module so we can enhance both instance and class sides:
+</p>
+<pre>
+        module CampingOAuthProvider::Helpers
+                extend OAuthCampingPlugin::Helpers
+                include OAuthCampingPlugin::Helpers
+        end
+</pre>
+<h3>E.Plugging in the <a href="../../classes/OAuth.html">OAuth</a> controllers</h3>
+<p>
+We will need to extend our app Controllers module with the <a
+href="../../classes/OAuthCampingPlugin/Controllers.html">OAuthCampingPlugin::Controllers</a>
+module using the extend statement. Then just before the end of the
+Controllers module, we&#8216;ll add a call to the include_oauth_controllers
+method. This is how camping-oauth will inject and plugin the common <a
+href="../../classes/OAuth.html">OAuth</a> controllers and helpers. It is
+important that this call always remaining the last statement of the module,
+even when you add new controller classes. So the module should look like
+so:
+</p>
+<pre>
+        module CampingOAuthProvider::Controllers
+                extend OAuthCampingPlugin::Controllers
+                # ...
+                include_oauth_controllers
+        end #Controllers
+</pre>
+<p>
+Before we continue fleshing out the logic of our controllers, let&#8216;s
+finish hooking up the Views module.
+</p>
+<h3>Plugging in the <a href="../../classes/OAuth.html">OAuth</a> common views</h3>
+<p>
+We will need to extend our app Views module with the <a
+href="../../classes/OAuthCampingPlugin/Views.html">OAuthCampingPlugin::Views</a>
+module using the extend statement. Then just before the end of the Views
+module, we&#8216;ll add a call to the include_oauth_views method. This is
+how camping-oauth will inject and plugin the common <a
+href="../../classes/OAuth.html">OAuth</a> views. It is important that this
+call always remaining the last statement of the module, even when you add
+new view methods. So the module should look like so:
+</p>
+<pre>
+        module CampingOAuthProvider::Views
+                extend OAuthCampingPlugin::Views
+                # ...
+                include_oauth_views
+        end
+</pre>
+<h3>Adding basic login and registration capabilities</h3>
+<p>
+Let&#8216;s add a Login controller class to our Controllers module:
+</p>
+<pre>
+        class Login &lt; R '/login'
+                def get
+                        render :login
+                end
+                def post
+                        @user = User.find_by_username_and_password(input.username, input.password)
+                        if @user
+                                @state.user_id = @user.id
+                                if @state.return_to.nil?
+                                        redirect R(Index)
+                                else
+                                        return_to = @state.return_to
+                                        @state.return_to = nil
+                                        redirect(return_to)
+                                end
+                        else
+                                @info = 'Wrong username or password.'
+                        end
+                        render :login
+                end
+        end
+</pre>
+<p>
+And now add the corresponding login view in the Views module&quot;
+</p>
+<pre>
+        def login
+                div @info if @info
+                form :action =&gt; R(Login), :method =&gt; 'post' do
+                        label 'Username', :for =&gt; 'username'; br
+                        input :name =&gt; 'username', :type =&gt; 'text'; br
+                        label 'Password', :for =&gt; 'password'; br
+                        input :name =&gt; 'password', :type =&gt; 'text'; br
+                        input :type =&gt; 'submit', :name =&gt; 'login', :value =&gt; 'Login'
+                end
+        end
+</pre>
+<p>
+Let&#8216;s verify we can login by accessing the following url:
+</p>
+<pre>
+        http://localhost:3301/login
+</pre>
+<p>
+Now that login support is in place you can test out one of the <a
+href="../../classes/OAuth.html">OAuth</a> controllers by navigating to the
+following url:
+</p>
+<pre>
+        http://localhost:3301/oauth/register
+</pre>
+<p>
+Since the camping-oauth plugin installed a :before filter on the
+OAuthRegisterApplication controller requiring user login, you should be
+redirected first to the login page. Since we created a default account when
+running the migration, login as admin with camping as the password. Once
+logged in you should be redirected back to the <a
+href="../../classes/OAuth.html">OAuth</a> Application Registration page.
+</p>
+<p>
+As a side note, you can style all common <a
+href="../../classes/OAuth.html">OAuth</a> views later using CSS.
+We&#8216;ll let you add the SignUp controller and its signup view on your
+own.
+</p>
+<h3>Adding our custom API, protected by <a href="../../classes/OAuth.html">OAuth</a></h3>
+<p>
+Since the premise of this post was to make it easy for web apps to consume
+an <a href="../../classes/OAuth.html">OAuth</a>-protected service,
+let&#8216;s create a very simple controller (no view needed) to expose some
+data as JSON.
+</p>
+<pre>
+        class APITimeNow &lt; R '/api/timenow'
+                def get
+                        @result = {:now=&gt;Time.now.utc.to_s}
+                        @result[:username] = @user.username if @user
+                        @headers['Content-Type'] = &quot;application/json&quot;
+                        log_debug @result.to_json
+                        @result.to_json
+                end
+        end
+</pre>
+<p>
+Now we can test it by navigating to the following url (after installing the
+JSONview plugin for FireFox to make it easier to see the returned JSON
+data):
+</p>
+<pre>
+                http://localhost:3301/api/timenow
+</pre>
+<p>
+Note that at this point this controller is NOT YET protected by <a
+href="../../classes/OAuth.html">OAuth</a>. For that we need to declare a
+before filter for the APITimeNow controller requiring to be either logged
+in or <a href="../../classes/OAuth.html">OAuth</a>-authenticated. So
+let&#8216;s add this code snippet to our main module:
+</p>
+<pre>
+        module GatedCampingSite
+                # ...
+                before [:APITimeNow] do
+                        login_or_oauth_required
+                end
+                # ...
+        end
+</pre>
+<p>
+So now if we logged out (by deleting the session cookies since we have not
+implemented logoff) and refreshed our browser we would be redirected to the
+login page.
+</p>
+<h2>Testing And Troubleshooting</h2>
+<p>
+At this stage, we have a basic Camping <a
+href="../../classes/OAuth.html">OAuth</a> provider, now let&#8216;s test
+it! The first thing is to register a new <a
+href="../../classes/OAuth.html">OAuth</a> consumer named
+camping-oauth-consumer. We&#8216;ll assume that:
+</p>
+<pre>
+   1. it is located at http://localhost:3000/ (fictitious for now)
+   2. it exposes a url: http://localhost:3000/callback to accept an OAuth token once authorized
+</pre>
+<p>
+Once you register you should see the a page with the registration results.
+The key and secret will be used by our consumer as credentials when
+accessing our <a href="../../classes/OAuth.html">OAuth</a> provider, so
+copy/paste them into a notepad.
+</p>
+<p>
+For our first test consumer will use IRB, so open up a session and
+let&#8216;s define 3 variables for: url of our provider, key and secret
+(use your own values) of our registered consumer:
+</p>
+<pre>
+        @site={:site=&gt;&quot;http://localhost:3301&quot;}
+        @mykey=&quot;SQnIXDQyhFB5q3wfZyMY&quot;
+        @mysecret=&quot;PmW02FNs7rXG97sAVXMWhFoJVZ98cnj21vv6p1ad&quot;
+</pre>
+<p>
+Now let&#8216;s require oauth and let&#8216;s instantiate an <a
+href="../../classes/OAuth.html">OAuth</a> consumer:
+</p>
+<pre>
+        require 'oauth'
+        @consumer = OAuth::Consumer.new(@mykey,@mysecret,@site)
+</pre>
+<p>
+You should get an instance of a OAuth::Consumer back. Our next step is to
+request an <a href="../../classes/OAuth.html">OAuth</a> RequestToken like
+so:
+</p>
+<pre>
+        @request_token = @consumer.get_request_token
+</pre>
+<p>
+You should get an OAuth::RequestToken back. Let&#8216;s see how and where
+we should authorize this request token:
+</p>
+<pre>
+        http://localhost:3301/oauth/authorize?oauth_token=0Qd6g3SjWHQEM6sUTcd9
+</pre>
+<p>
+We should be prompted by the <a href="../../classes/OAuth.html">OAuth</a>
+Authorization controller of our provider. If you click on the checkbox and
+the Authorize button, the provider will redirect you to the callback url we
+defined during registration passing back the Oauth token id and and a
+verifier code. Since we don&#8216;t have a consumer web app up and running,
+we will get a navigation error. Here is what the target (redirection) url
+looks like:
+</p>
+<pre>
+                http://localhost:3000/callback?oauth_token=0Qd6g3SjWHQEM6sUTcd9&amp;oauth_verifier=71Jt3GhiwvHlZYO9zA8c
+</pre>
+<p>
+This verifier acts as a sort of session id we need to pass to get an <a
+href="../../classes/OAuth.html">OAuth</a> Access Token. So from our IRB
+session, let&#8216;s evaluate the following statement:
+</p>
+<pre>
+        @verifier = '71Jt3GhiwvHlZYO9zA8c'
+        @access_token = @request_token.get_access_token(:oauth_verifier=&gt;@verifier)
+</pre>
+<p>
+You should get an instance of OAuth::AccessToken back. So now let&#8216;s
+call our provider api:
+</p>
+<pre>
+        @response = @access_token.get('/api/timenow')
+        @info = @response.body
+</pre>
+<p>
+You should get back a JSON object. So this concludes our whirlwind tour of
+<a href="../../classes/OAuth.html">OAuth</a> from a provider and consumer
+side.
+</p>
+<h3>Examples Source Code</h3>
+<p>
+Also if you look in the examples folder of the camping-oauth gem you will
+find the full source for both a provider (the one we have been working on)
+and a consumer app (to be run on port 3302).
+</p>
+<h1>More information</h1>
+<p>
+Check for updates :
+</p>
+<ul>
+<li><a href="http://blog.monnet-usa.com">blog.monnet-usa.com</a>
+</li>
+</ul>
+    </div>
+    <div id="requires-list">
+      <h3 class="section-bar">Required files</h3>
+      <div class="name-list">
+      oauth&nbsp;&nbsp;
+      activerecord&nbsp;&nbsp;
+      </div>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>