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

camping-oauth 1.0.0

Files changed (102) hide show

data/doc/classes/OAuthCampingPlugin/Controllers.src/M000024.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_controllers (OAuthCampingPlugin::Controllers)</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 768</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">common_oauth_controllers</span>
+                <span class="ruby-value str">&quot;\nclass OAuthRegisterApplication &lt; R '/oauth/register'\ndef get\n@application= ClientApplication.new\nrender :new_application_registration\nend\n\ndef post\n@user = User.find(@state.user_id)\nif !@user\nreturn \&quot;login first\&quot;\nend\n\n@application = ClientApplication.find_by_user_id_and_name(@state.user_id, input.name)\nif @application\n@info = 'You already have an application with this name.'\nelse\n@application = ClientApplication.new :user_id =&gt; @state.user_id,\n:name =&gt; input.name,\n:url =&gt; input.url,\n:support_url =&gt; input.support_url,\n:callback_url =&gt; input.callback_url\n\n@user.client_applications &lt;&lt; @application\n\n@application.save\nif @application\nreturn(render(:application_registration))\nelse\n@info = @application.errors.full_messages unless @application.errors.empty?\nend\nend\n\nrender :new_application_registration\nend\nend\n\nclass OAuthProvideRequestToken &lt; R '/oauth/request_token'\ninclude OAuthCampingPlugin::OAuth\n\ndef post\noauth_consumer_key = oauth_header_params['oauth_consumer_key']\n\n@application = ClientApplication.find_by_key(oauth_consumer_key)\n@token = @application.create_request_token\nlog_debug 'OAuthProvideRequestToken&gt; request token for oauth_consumer_key:' + oauth_consumer_key + '=' + @token.inspect\n@token.to_query\nend\nend\n\nclass OAuthAuthorizeToken &lt; R '/oauth/authorize'\ninclude OAuthCampingPlugin::OAuth\n\ndef get\n@oauth_token = input.oauth_token\nrender :authorize\nend\n\ndef post\n@token = RequestToken.find_by_token input.oauth_token\nreturn(render(:authorize_failure_token_not_found)) if @token.nil?\n\nreturn(render(:authorize_failure_invalidated)) if @token.invalidated?\n\nreturn(render(:authorize_failure)) unless user_authorizes_token?\n\n@token.authorize!(current_user)\nlog_debug 'OAuthAuthorizeToken&gt; request token=' + @token.inspect\n\nif @token.oauth10?\n@redirect_url = input.oauth_callback || @token.client_application.callback_url\nelse\n@redirect_url = (@token.oob? || @token.callback_url.nil?) ? @token.client_application.callback_url : @token.callback_url\nend\n\nreturn(render(:authorize_success)) unless @redirect_url\n\n@full_redirect_url = @token.oauth10? ? (@redirect_url + '?oauth_token=' + @token.token) :  (@redirect_url + '?oauth_token=' + @token.token + '&amp;oauth_verifier=' + @token.verifier)\n\nredirect @full_redirect_url\nend\n\n# Override this to match your authorization page form\ndef user_authorizes_token?\ninput.authorize == '1' || input.authorize == 'on'\nend\nend\n\nclass OAuthRevokeToken &lt; R '/oauth/revoke'\ninclude OAuthCampingPlugin::OAuth\n\ndef get\n@token = OauthToken.find_by_token(input.oauth_token)\nreturn(render(:authorize_failure_token_not_found)) if @token.nil?\n\nrender :revoke\nend\n\ndef post\n@token = OauthToken.find_by_token(input.oauth_token)\nreturn(render(:authorize_failure_token_not_found)) if @token.nil?\n\nif input.revoke != 'on'\n@info = \&quot;You did not confirm you wanted to revoke this token. Check the checkbox to confirm.\&quot;\nreturn(render(:revoke))\nend\n\n@token.invalidate!\nlog_debug 'OAuthRevokeToken&gt; access token=' + @token.inspect\n\nrender :revoke_success\nend\nend\n\nclass OAuthProvideAccessToken &lt; R '/oauth/access_token'\ninclude OAuthCampingPlugin::OAuth\n\ndef post\nlog_debug 'OAuthProvideAccessToken&gt; @current_token=' + self.current_token.inspect\n\nreturn(r(401,'')) if self.current_token.nil?\n\n@token = self.current_token.exchange!\nlog_debug 'OAuthProvideAccessToken&gt; access token=' + @token.inspect\n\nreturn(r(401,'')) if self.current_token.nil?\n@token.to_query\n\nend #post\nend\n\n&quot;</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/OAuthCampingPlugin/Controllers.src/M000025.html ADDED Viewed

@@ -0,0 +1,26 @@
+<?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_controllers (OAuthCampingPlugin::Controllers)</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 907</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include_oauth_controllers</span>
+                <span class="ruby-identifier">module_eval</span> <span class="ruby-constant">OAuthCampingPlugin</span><span class="ruby-operator">::</span><span class="ruby-constant">Controllers</span>.<span class="ruby-identifier">common_oauth_controllers</span>
+                <span class="ruby-comment cmt"># Add Oauth to each controller</span>
+                <span class="ruby-identifier">r</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span>
+                        <span class="ruby-identifier">x</span>.<span class="ruby-identifier">class_eval</span> <span class="ruby-keyword kw">do</span>
+                                <span class="ruby-identifier">include</span> <span class="ruby-constant">OAuthCampingPlugin</span><span class="ruby-operator">::</span><span class="ruby-constant">OAuth</span>
+                                <span class="ruby-identifier">include</span> <span class="ruby-constant">OAuthCampingPlugin</span><span class="ruby-operator">::</span><span class="ruby-constant">Helpers</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/classes/OAuthCampingPlugin/Filters.html ADDED Viewed

@@ -0,0 +1,161 @@
+<?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>Module: OAuthCampingPlugin::Filters</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="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">OAuthCampingPlugin::Filters</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/camping-oauth_rb.html">
+                lib/camping-oauth.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+<a href="Filters.html">Filters</a> module for <a
+href="OAuth.html">OAuth</a> Camping Plugin. The module will be plugged in
+to the main app <a href="Helpers.html">Helpers</a> module. Example:
+</p>
+<pre>
+      module CampingOAuthProvider
+              include Camping::Session
+              include CampingFilters
+              extend  OAuthCampingPlugin
+              include OAuthCampingPlugin::Filters
+              # ...
+      end
+</pre>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000034">included</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000034" class="method-detail">
+        <a name="M000034"></a>
+        <div class="method-heading">
+          <a href="Filters.src/M000034.html" target="Code" class="method-signature"
+            onclick="popupCode('Filters.src/M000034.html');return false;">
+          <span class="method-name">included</span><span class="method-args">(mod)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Adds 3 before filters for the common <a href="OAuth.html">OAuth</a>
+controllers:
+</p>
+<pre>
+ - OAuthRegisterApplication
+ - OAuthProvideRequestToken
+ - OAuthProvideAccessToken
+</pre>
+<p>
+Also adds a before filter on all controllers to ensure the user is set
+</p>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/classes/OAuthCampingPlugin/Filters.src/M000034.html ADDED Viewed

@@ -0,0 +1,34 @@
+<?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>included (OAuthCampingPlugin::Filters)</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 434</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">included</span>(<span class="ruby-identifier">mod</span>)
+                <span class="ruby-identifier">mod</span>.<span class="ruby-identifier">module_eval</span> <span class="ruby-keyword kw">do</span>
+                        <span class="ruby-identifier">before</span> <span class="ruby-identifier">:all</span> <span class="ruby-keyword kw">do</span>
+                                <span class="ruby-identifier">set_user</span>
+                        <span class="ruby-keyword kw">end</span>
+                        <span class="ruby-identifier">before</span> <span class="ruby-identifier">:OAuthRegisterApplication</span> <span class="ruby-keyword kw">do</span>
+                                <span class="ruby-identifier">login_required</span>
+                        <span class="ruby-keyword kw">end</span>
+                        <span class="ruby-identifier">before</span> <span class="ruby-identifier">:OAuthProvideRequestToken</span> <span class="ruby-keyword kw">do</span>
+                                <span class="ruby-identifier">verify_oauth_consumer_signature</span>
+                        <span class="ruby-keyword kw">end</span>
+                        <span class="ruby-identifier">before</span> <span class="ruby-identifier">:OAuthProvideAccessToken</span> <span class="ruby-keyword kw">do</span>
+                                <span class="ruby-identifier">verify_oauth_request_token</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/classes/OAuthCampingPlugin/Helpers.html ADDED Viewed

@@ -0,0 +1,283 @@
+<?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>Module: OAuthCampingPlugin::Helpers</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="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">OAuthCampingPlugin::Helpers</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/camping-oauth_rb.html">
+                lib/camping-oauth.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+<a href="Helpers.html">Helpers</a> module for <a
+href="OAuth.html">OAuth</a> Camping Plugin. The module will be plugged in
+to the main app <a href="Helpers.html">Helpers</a> module. Its methods will
+be added to <a href="Controllers.html">Controllers</a> and <a
+href="Views.html">Views</a>. Example:
+</p>
+<pre>
+      module CampingOAuthProvider::Helpers
+              extend OAuthCampingPlugin::Helpers
+              include OAuthCampingPlugin::Helpers
+      end
+</pre>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000033">access_denied</a>&nbsp;&nbsp;
+      <a href="#M000027">app_module</a>&nbsp;&nbsp;
+      <a href="#M000031">current_user</a>&nbsp;&nbsp;
+      <a href="#M000026">log_debug</a>&nbsp;&nbsp;
+      <a href="#M000032">login_required</a>&nbsp;&nbsp;
+      <a href="#M000029">nonce_class</a>&nbsp;&nbsp;
+      <a href="#M000030">set_user</a>&nbsp;&nbsp;
+      <a href="#M000028">user_class</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000033" class="method-detail">
+        <a name="M000033"></a>
+        <div class="method-heading">
+          <a href="Helpers.src/M000033.html" target="Code" class="method-signature"
+            onclick="popupCode('Helpers.src/M000033.html');return false;">
+          <span class="method-name">access_denied</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Redirects to the login page with an access denied error message
+</p>
+        </div>
+      </div>
+      <div id="method-M000027" class="method-detail">
+        <a name="M000027"></a>
+        <div class="method-heading">
+          <a href="Helpers.src/M000027.html" target="Code" class="method-signature"
+            onclick="popupCode('Helpers.src/M000027.html');return false;">
+          <span class="method-name">app_module</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Reverse engineers the main app module
+</p>
+        </div>
+      </div>
+      <div id="method-M000031" class="method-detail">
+        <a name="M000031"></a>
+        <div class="method-heading">
+          <a href="Helpers.src/M000031.html" target="Code" class="method-signature"
+            onclick="popupCode('Helpers.src/M000031.html');return false;">
+          <span class="method-name">current_user</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the current user model instance
+</p>
+        </div>
+      </div>
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
+        <div class="method-heading">
+          <a href="Helpers.src/M000026.html" target="Code" class="method-signature"
+            onclick="popupCode('Helpers.src/M000026.html');return false;">
+          <span class="method-name">log_debug</span><span class="method-args">(msg)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Logs a specific message if in debug mode
+</p>
+        </div>
+      </div>
+      <div id="method-M000032" class="method-detail">
+        <a name="M000032"></a>
+        <div class="method-heading">
+          <a href="Helpers.src/M000032.html" target="Code" class="method-signature"
+            onclick="popupCode('Helpers.src/M000032.html');return false;">
+          <span class="method-name">login_required</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns whether or not the user is logged in Typically used within a
+controller before filter such as in:
+</p>
+<pre>
+             before :OAuthRegisterApplication do
+                     login_required
+             end
+</pre>
+        </div>
+      </div>
+      <div id="method-M000029" class="method-detail">
+        <a name="M000029"></a>
+        <div class="method-heading">
+          <a href="Helpers.src/M000029.html" target="Code" class="method-signature"
+            onclick="popupCode('Helpers.src/M000029.html');return false;">
+          <span class="method-name">nonce_class</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Reverse engineers the main OauthNonce model class
+</p>
+        </div>
+      </div>
+      <div id="method-M000030" class="method-detail">
+        <a name="M000030"></a>
+        <div class="method-heading">
+          <a href="Helpers.src/M000030.html" target="Code" class="method-signature"
+            onclick="popupCode('Helpers.src/M000030.html');return false;">
+          <span class="method-name">set_user</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Looks up the user based on saved state (if any) and assigns it to the @user
+variable
+</p>
+        </div>
+      </div>
+      <div id="method-M000028" class="method-detail">
+        <a name="M000028"></a>
+        <div class="method-heading">
+          <a href="Helpers.src/M000028.html" target="Code" class="method-signature"
+            onclick="popupCode('Helpers.src/M000028.html');return false;">
+          <span class="method-name">user_class</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Reverse engineers the main User model class
+</p>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>