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

camping-oauth 1.0.0

Files changed (102) hide show

data/doc/classes/OAuthCampingPlugin/Models.src/M000037.html ADDED Viewed

@@ -0,0 +1,56 @@
+<?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>up (OAuthCampingPlugin::Models)</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 697</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">up</span>
+                <span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Schema</span>.<span class="ruby-identifier">define</span> <span class="ruby-keyword kw">do</span>
+                        <span class="ruby-identifier">create_table</span> <span class="ruby-identifier">:client_applications</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:name</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:url</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:support_url</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:callback_url</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:key</span>, <span class="ruby-identifier">:limit</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">20</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:secret</span>, <span class="ruby-identifier">:limit</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">40</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">integer</span> <span class="ruby-identifier">:user_id</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">timestamps</span>
+                        <span class="ruby-keyword kw">end</span>
+                        <span class="ruby-identifier">add_index</span> <span class="ruby-identifier">:client_applications</span>, <span class="ruby-identifier">:key</span>, <span class="ruby-identifier">:unique</span>
+                        <span class="ruby-identifier">create_table</span> <span class="ruby-identifier">:oauth_tokens</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">integer</span> <span class="ruby-identifier">:user_id</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:type</span>, <span class="ruby-identifier">:limit</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">20</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">integer</span> <span class="ruby-identifier">:client_application_id</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:token</span>, <span class="ruby-identifier">:limit</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">20</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:secret</span>, <span class="ruby-identifier">:limit</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">40</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:callback_url</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:verifier</span>, <span class="ruby-identifier">:limit</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">20</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">timestamp</span> <span class="ruby-identifier">:authorized_at</span>, <span class="ruby-identifier">:invalidated_at</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">timestamps</span>
+                        <span class="ruby-keyword kw">end</span>
+                        <span class="ruby-identifier">add_index</span> <span class="ruby-identifier">:oauth_tokens</span>, <span class="ruby-identifier">:token</span>, <span class="ruby-identifier">:unique</span>
+                        <span class="ruby-identifier">create_table</span> <span class="ruby-identifier">:oauth_nonces</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">string</span> <span class="ruby-identifier">:nonce</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">integer</span> <span class="ruby-identifier">:timestamp</span>
+                          <span class="ruby-identifier">t</span>.<span class="ruby-identifier">timestamps</span>
+                        <span class="ruby-keyword kw">end</span>
+                        <span class="ruby-identifier">add_index</span> <span class="ruby-identifier">:oauth_nonces</span>,[<span class="ruby-identifier">:nonce</span>, <span class="ruby-identifier">:timestamp</span>], <span class="ruby-identifier">:unique</span>
+                <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/OAuthCampingPlugin/Models.src/M000038.html ADDED Viewed

@@ -0,0 +1,22 @@
+<?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>down (OAuthCampingPlugin::Models)</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 740</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">down</span>
+                <span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Schema</span>.<span class="ruby-identifier">define</span> <span class="ruby-keyword kw">do</span>
+                        <span class="ruby-identifier">drop_table</span> <span class="ruby-identifier">:client_applications</span>
+                        <span class="ruby-identifier">drop_table</span> <span class="ruby-identifier">:oauth_tokens</span>
+                        <span class="ruby-identifier">drop_table</span> <span class="ruby-identifier">:oauth_nonces</span>
+                <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/OAuthCampingPlugin/OAuth.html ADDED Viewed

@@ -0,0 +1,407 @@
+<?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::OAuth</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::OAuth</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="OAuth.html">OAuth</a> module for <a href="OAuth.html">OAuth</a>
+Camping Plugin. The module will be plugged into all controllers either:
+</p>
+<pre>
+  - directly such as in the standard common OAuth controllers (e.g. OAuthProvideRequestToken)
+  - or indirectly via the include_oauth_controllers of the OAuthCampingPlugin::Controllers module
+</pre>
+<p>
+The module provides accessors, helper, authentication, signing, and
+authorization methods specific to <a href="OAuth.html">OAuth</a>
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000008">access_token_class</a>&nbsp;&nbsp;
+      <a href="#M000012">authorized?</a>&nbsp;&nbsp;
+      <a href="#M000006">client_application_class</a>&nbsp;&nbsp;
+      <a href="#M000005">current_client_application</a>&nbsp;&nbsp;
+      <a href="#M000004">current_token</a>&nbsp;&nbsp;
+      <a href="#M000017">invalid_oauth_response</a>&nbsp;&nbsp;
+      <a href="#M000014">login_or_oauth_required</a>&nbsp;&nbsp;
+      <a href="#M000011">oauth?</a>&nbsp;&nbsp;
+      <a href="#M000009">oauth_header_params</a>&nbsp;&nbsp;
+      <a href="#M000013">oauth_required</a>&nbsp;&nbsp;
+      <a href="#M000010">oauthenticate</a>&nbsp;&nbsp;
+      <a href="#M000007">request_token_class</a>&nbsp;&nbsp;
+      <a href="#M000015">verify_oauth_consumer_signature</a>&nbsp;&nbsp;
+      <a href="#M000016">verify_oauth_request_token</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Protected Instance methods</h3>
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000008.html');return false;">
+          <span class="method-name">access_token_class</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the class of the access token
+</p>
+        </div>
+      </div>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000012.html');return false;">
+          <span class="method-name">authorized?</span><span class="method-args">(</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns whether or not the current request is authorized
+</p>
+        </div>
+      </div>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000006.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000006.html');return false;">
+          <span class="method-name">client_application_class</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the class of the client application
+</p>
+        </div>
+      </div>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000005.html');return false;">
+          <span class="method-name">current_client_application</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the current client application
+</p>
+        </div>
+      </div>
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000004.html');return false;">
+          <span class="method-name">current_token</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the current token
+</p>
+        </div>
+      </div>
+      <div id="method-M000017" class="method-detail">
+        <a name="M000017"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000017.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000017.html');return false;">
+          <span class="method-name">invalid_oauth_response</span><span class="method-args">(code=401,message=&quot;Invalid OAuth Request&quot;)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns a 401 HTTP code if <a href="OAuth.html">OAuth</a> denied the
+request
+</p>
+        </div>
+      </div>
+      <div id="method-M000014" class="method-detail">
+        <a name="M000014"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000014.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000014.html');return false;">
+          <span class="method-name">login_or_oauth_required</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Ensures that the current controller request is authorized either via:
+</p>
+<pre>
+ - the application login system
+ - or via OAuth
+</pre>
+<p>
+This method is typically used as a precondition in a before_filter.
+Example:
+</p>
+<pre>
+      before [:APITimeNow] do
+             login_or_oauth_required
+      end
+</pre>
+        </div>
+      </div>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000011.html');return false;">
+          <span class="method-name">oauth?</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns whether or not the current request is authenticated
+</p>
+        </div>
+      </div>
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000009.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000009.html');return false;">
+          <span class="method-name">oauth_header_params</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Parses the HTTP_AUTHORIZATION header for <a href="OAuth.html">OAuth</a>
+parameters and returns the params in a hash.
+</p>
+        </div>
+      </div>
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000013.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000013.html');return false;">
+          <span class="method-name">oauth_required</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Ensures that the current controller request is authorized via <a
+href="OAuth.html">OAuth</a>. This method is typically used as a
+precondition in a before_filter. Example:
+</p>
+<pre>
+      before [:APITimeNow] do
+             login_or_oauth_required
+      end
+</pre>
+        </div>
+      </div>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000010.html');return false;">
+          <span class="method-name">oauthenticate</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Authenticates the current request by verifying the signature in the current
+token and ensuring that it is an access token
+</p>
+        </div>
+      </div>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000007.html');return false;">
+          <span class="method-name">request_token_class</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the class of the current token
+</p>
+        </div>
+      </div>
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000015.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000015.html');return false;">
+          <span class="method-name">verify_oauth_consumer_signature</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Verifies that a request token request (signature) is valid for a given
+consumer clien application
+</p>
+        </div>
+      </div>
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
+        <div class="method-heading">
+          <a href="OAuth.src/M000016.html" target="Code" class="method-signature"
+            onclick="popupCode('OAuth.src/M000016.html');return false;">
+          <span class="method-name">verify_oauth_request_token</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Verifies that a request token request (signature) is valid
+</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>