RubyGems - google-authsub - Versions diffs - 0.0.4 - Mend

google-authsub 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (69) hide show

data/.gitignore +1 -0
data/MIT-LICENSE +20 -0
data/README +98 -0
data/Rakefile +19 -0
data/VERSION +1 -0
data/coverage/-Library-Ruby-Gems-1_8-gems-FakeWeb-1_1_2-lib-fake_net_http_rb.html +679 -0
data/coverage/-Library-Ruby-Gems-1_8-gems-FakeWeb-1_1_2-lib-fake_web_rb.html +843 -0
data/coverage/-Library-Ruby-Gems-1_8-gems-rcov-0_8_1_2_0-lib-rcov_rb.html +1598 -0
data/coverage/index.html +360 -0
data/coverage/lib-googleauthsub_rb.html +877 -0
data/coverage/spec-googleauthsub_spec_rb.html +950 -0
data/coverage/spec-spec_helper_rb.html +640 -0
data/doc/classes/AuthEchoServlet.html +152 -0
data/doc/classes/AuthEchoServlet.src/M000001.html +20 -0
data/doc/classes/AuthEchoServlet.src/M000002.html +18 -0
data/doc/classes/GData/AuthSubError.html +139 -0
data/doc/classes/GData/AuthSubError.src/M000019.html +18 -0
data/doc/classes/GData/Error.html +111 -0
data/doc/classes/GData/GoogleAuthSub.html +521 -0
data/doc/classes/GData/GoogleAuthSub.src/M000001.html +29 -0
data/doc/classes/GData/GoogleAuthSub.src/M000002.html +22 -0
data/doc/classes/GData/GoogleAuthSub.src/M000003.html +29 -0
data/doc/classes/GData/GoogleAuthSub.src/M000004.html +22 -0
data/doc/classes/GData/GoogleAuthSub.src/M000005.html +24 -0
data/doc/classes/GData/GoogleAuthSub.src/M000006.html +19 -0
data/doc/classes/GData/GoogleAuthSub.src/M000007.html +18 -0
data/doc/classes/GData/GoogleAuthSub.src/M000008.html +18 -0
data/doc/classes/GData/GoogleAuthSub.src/M000009.html +24 -0
data/doc/classes/GData/GoogleAuthSub.src/M000010.html +25 -0
data/doc/classes/GData/GoogleAuthSub.src/M000011.html +30 -0
data/doc/classes/GData/GoogleAuthSub.src/M000012.html +18 -0
data/doc/classes/GData/GoogleAuthSub.src/M000013.html +18 -0
data/doc/classes/GData/GoogleAuthSub.src/M000014.html +18 -0
data/doc/classes/GData/GoogleAuthSub.src/M000015.html +18 -0
data/doc/classes/GData/GoogleAuthSub.src/M000016.html +20 -0
data/doc/classes/GData/GoogleAuthSub.src/M000017.html +20 -0
data/doc/classes/GData/GoogleAuthSub.src/M000018.html +19 -0
data/doc/classes/GData.html +162 -0
data/doc/created.rid +1 -0
data/doc/files/googleauthsub_rb.html +140 -0
data/doc/files/lib/googleauthsub_rb.html +140 -0
data/doc/files/spec/googleauthsub_spec_rb.html +146 -0
data/doc/files/spec/googleresponder_rb.html +121 -0
data/doc/files/spec/spec_helper_rb.html +149 -0
data/doc/fr_class_index.html +31 -0
data/doc/fr_file_index.html +30 -0
data/doc/fr_method_index.html +45 -0
data/doc/index.html +24 -0
data/doc/rdoc-style.css +208 -0
data/google-authsub-0.0.2.gem +0 -0
data/google-authsub-0.0.3.gem +0 -0
data/google-authsub.gemspec +109 -0
data/lib/googleauthsub.rb +271 -0
data/live test/authsub_test.html +40 -0
data/live test/gastest.rb +90 -0
data/spec/googleauthsub_spec.rb +350 -0
data/spec/googleresponder.rb +26 -0
data/spec/mock responses/bad_token_info.txt +11 -0
data/spec/mock responses/calendar.txt +11 -0
data/spec/mock responses/revoke_token.txt +7 -0
data/spec/mock responses/revoked_token.txt +17 -0
data/spec/mock responses/session_token.txt +9 -0
data/spec/mock responses/token_info.txt +11 -0
data/spec/mock responses/unauthorized.txt +18 -0
data/spec/mock_certs/test_private_key.pem +15 -0
data/spec/mock_certs/test_public_key.pem +6 -0
data/spec/spec_helper.rb +30 -0
data/spec/spec_opts +7 -0
metadata +125 -0

data/doc/classes/GData/GoogleAuthSub.html ADDED Viewed

@@ -0,0 +1,521 @@
+<?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>Class: GData::GoogleAuthSub</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>Class</strong></td>
+          <td class="class-name-in-header">GData::GoogleAuthSub</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/googleauthsub_rb.html">
+                lib/googleauthsub.rb
+                </a>
+        <br />
+                <a href="../../files/spec/spec_helper_rb.html">
+                spec/spec_helper.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+<a href="GoogleAuthSub.html">GoogleAuthSub</a> This class handles the
+Google Authentication for Web Applications API
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000017">auth_data</a>&nbsp;&nbsp;
+      <a href="#M000016">auth_header</a>&nbsp;&nbsp;
+      <a href="#M000015">delete</a>&nbsp;&nbsp;
+      <a href="#M000012">get</a>&nbsp;&nbsp;
+      <a href="#M000004">new</a>&nbsp;&nbsp;
+      <a href="#M000013">post</a>&nbsp;&nbsp;
+      <a href="#M000014">put</a>&nbsp;&nbsp;
+      <a href="#M000006">receive_token</a>&nbsp;&nbsp;
+      <a href="#M000005">request_url</a>&nbsp;&nbsp;
+      <a href="#M000010">revoke_token</a>&nbsp;&nbsp;
+      <a href="#M000008">secure_token?</a>&nbsp;&nbsp;
+      <a href="#M000009">session_token</a>&nbsp;&nbsp;
+      <a href="#M000007">session_token?</a>&nbsp;&nbsp;
+      <a href="#M000003">set_private_key</a>&nbsp;&nbsp;
+      <a href="#M000018">sig</a>&nbsp;&nbsp;
+      <a href="#M000011">token_info</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">next_url</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">scope</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">secure</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">session</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">sigalg</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">target</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">token</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000004.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(opts = {})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Create a <a href="GoogleAuthSub.html#M000004">new</a> GoogleAuthsub object
+Options specified in <tt>opts</tt> consist of:
+</p>
+<ul>
+<li>:next_url - (String) The url to redirect back to once the user has signed
+in to Google.
+</li>
+<li>:scope_url - (String) The service from Google that you wish to receive data
+from with this token.
+</li>
+<li>:session - (boolean) Whether the token is able to be used to <a
+href="GoogleAuthSub.html#M000012">get</a> a session token or is just one
+use.
+</li>
+<li>:secure - (boolean) Whether the token can be used for sessions.
+</li>
+<li>:sigalg - (String) Currently not needed, as the Authsub specification only
+has rsa-sha1.
+</li>
+</ul>
+        </div>
+      </div>
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000003.html');return false;">
+          <span class="method-name">set_private_key</span><span class="method-args">(key)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<tt>key</tt> can be a File, String or OpenSSL::Pkey::RSA Sets the private
+key to use for secure sessions. This should correspond to the public key
+sent to Google in the registration process. For registration details see:
+</p>
+<pre>
+  http://code.google.com/apis/accounts/docs/RegistrationForWebAppsAuto.html
+</pre>
+<p>
+This sets the class variable @@pkey to an OpenSSL::Pkey::RSA object
+</p>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000017" class="method-detail">
+        <a name="M000017"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000017.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000017.html');return false;">
+          <span class="method-name">auth_data</span><span class="method-args">(method,url)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+check the <a href="GoogleAuthSub.html#M000017">auth_data</a> section of the
+header
+</p>
+        </div>
+      </div>
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000016.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000016.html');return false;">
+          <span class="method-name">auth_header</span><span class="method-args">(method, url)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<a href="GoogleAuthSub.html#M000016">auth_header</a> Check what
+authorization header we are sending. method is Net::HTTP::Get or
+Net::HTTP::Post
+</p>
+        </div>
+      </div>
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000015.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000015.html');return false;">
+          <span class="method-name">delete</span><span class="method-args">(url)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<a href="GoogleAuthSub.html#M000015">delete</a> <tt>url</tt> Does a HTTP
+DELETE request to Google using the AuthSub token. This returns a
+Net::HTTPResponse object.
+</p>
+        </div>
+      </div>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000012.html');return false;">
+          <span class="method-name">get</span><span class="method-args">(url)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<a href="GoogleAuthSub.html#M000012">get</a> <tt>url</tt> Does a HTTP GET
+request to Google using the AuthSub token. This returns a Net::HTTPResponse
+object.
+</p>
+        </div>
+      </div>
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000013.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000013.html');return false;">
+          <span class="method-name">post</span><span class="method-args">(url)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<a href="GoogleAuthSub.html#M000013">post</a> <tt>url</tt> Does a HTTP POST
+request to Google using the AuthSub token. This returns a Net::HTTPResponse
+object.
+</p>
+        </div>
+      </div>
+      <div id="method-M000014" class="method-detail">
+        <a name="M000014"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000014.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000014.html');return false;">
+          <span class="method-name">put</span><span class="method-args">(url)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<a href="GoogleAuthSub.html#M000014">put</a> <tt>url</tt> Does a HTTP PUT
+request to Google using the AuthSub token. This returns a Net::HTTPResponse
+object.
+</p>
+        </div>
+      </div>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000006.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000006.html');return false;">
+          <span class="method-name">receive_token</span><span class="method-args">(url)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<tt>url</tt> :the URL received from Google once the user has signed in.
+</p>
+<p>
+This method extracts the token from the request url that Google sends the
+user back to. This url will be like: <a
+href="http://www.example.com/next?Token=CMDshfjfkeodf">www.example.com/next?Token=CMDshfjfkeodf</a>
+In Rails applications you don&#8216;t need this method, just use
++GoogleAuthsub#token=params[:token]+
+</p>
+        </div>
+      </div>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000005.html');return false;">
+          <span class="method-name">request_url</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+This returns a URI::HTTPS object which contains the Google url to request a
+token from.
+</p>
+        </div>
+      </div>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000010.html');return false;">
+          <span class="method-name">revoke_token</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<a href="GoogleAuthSub.html#M000010">revoke_token</a> This revokes either a
+single use or session token The token will not be able to be used again if
+this call is successful. It returns true on sucess, false on failure.
+</p>
+        </div>
+      </div>
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000008.html');return false;">
+          <span class="method-name">secure_token?</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns true if the token is used for secure sessions
+</p>
+        </div>
+      </div>
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000009.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000009.html');return false;">
+          <span class="method-name">session_token</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<a href="GoogleAuthSub.html#M000009">session_token</a> This method
+exchanges a previously received single use token with a session token.
+Raises error if an invalid response is received.
+</p>
+        </div>
+      </div>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000007.html');return false;">
+          <span class="method-name">session_token?</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns true if this token can be exchanged for a session token
+</p>
+        </div>
+      </div>
+      <div id="method-M000018" class="method-detail">
+        <a name="M000018"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000018.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000018.html');return false;">
+          <span class="method-name">sig</span><span class="method-args">(header)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+extract signature from header
+</p>
+        </div>
+      </div>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+        <div class="method-heading">
+          <a href="GoogleAuthSub.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('GoogleAuthSub.src/M000011.html');return false;">
+          <span class="method-name">token_info</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+<a href="GoogleAuthSub.html#M000011">token_info</a> Returns the information
+for the session token from Google. Returns a map {:target, :scope, :secure}
+</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>