Files
Tobias Klika 2cbb942282 doc files;
2011-06-13 14:56:41 +02:00

334 lines
12 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<title>Class: User</title>
<link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
<script src="./js/jquery.js" type="text/javascript"
charset="utf-8"></script>
<script src="./js/thickbox-compressed.js" type="text/javascript"
charset="utf-8"></script>
<script src="./js/quicksearch.js" type="text/javascript"
charset="utf-8"></script>
<script src="./js/darkfish.js" type="text/javascript"
charset="utf-8"></script>
</head>
<body class="class">
<div id="metadata">
<div id="home-metadata">
<div id="home-section" class="section">
<h3 class="section-header">
<a href="./index.html">Home</a>
<a href="./index.html#classes">Classes</a>
<a href="./index.html#methods">Methods</a>
</h3>
</div>
</div>
<div id="file-metadata">
<div id="file-list-section" class="section">
<h3 class="section-header">In Files</h3>
<div class="section-body">
<ul>
<li><a href="./app/models/user_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
class="thickbox" title="app/models/user.rb">app/models/user.rb</a></li>
</ul>
</div>
</div>
</div>
<div id="class-metadata">
<!-- Parent Class -->
<div id="parent-class-section" class="section">
<h3 class="section-header">Parent</h3>
<p class="link">ActiveRecord::Base</p>
</div>
<!-- Namespace Contents -->
<!-- Method Quickref -->
<div id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#method-c-find_for_facebook_oauth">::find_for_facebook_oauth</a></li>
<li><a href="#method-c-find_for_open_id">::find_for_open_id</a></li>
<li><a href="#method-c-new_with_session">::new_with_session</a></li>
</ul>
</div>
<!-- Included Modules -->
</div>
<div id="project-metadata">
<div id="fileindex-section" class="section project-section">
<h3 class="section-header">Files</h3>
<ul>
<li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a></li>
</ul>
</div>
<div id="classindex-section" class="section project-section">
<h3 class="section-header">Class Index
<span class="search-toggle"><img src="./images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" /></span></h3>
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
<fieldset>
<legend>Quicksearch</legend>
<input type="text" name="quicksearch" value=""
class="quicksearch-field" />
</fieldset>
</form>
<ul class="link-list">
<li><a href="./LastFM.html">LastFM</a></li>
<li><a href="./LastFM/Album.html">LastFM::Album</a></li>
<li><a href="./LastFM/Artist.html">LastFM::Artist</a></li>
<li><a href="./LastFM/Chart.html">LastFM::Chart</a></li>
<li><a href="./LastFM/Request.html">LastFM::Request</a></li>
<li><a href="./LastFM/Track.html">LastFM::Track</a></li>
<li><a href="./LastFM/Validator.html">LastFM::Validator</a></li>
<li><a href="./DeviseAuth.html">DeviseAuth</a></li>
<li><a href="./DeviseAuth/RegistrationsController.html">DeviseAuth::RegistrationsController</a></li>
<li><a href="./DeviseAuth/SessionsController.html">DeviseAuth::SessionsController</a></li>
<li><a href="./Users.html">Users</a></li>
<li><a href="./Users/OmniauthCallbacksController.html">Users::OmniauthCallbacksController</a></li>
<li><a href="./ApplicationController.html">ApplicationController</a></li>
<li><a href="./ApplicationHelper.html">ApplicationHelper</a></li>
<li><a href="./Artist.html">Artist</a></li>
<li><a href="./ArtistsController.html">ArtistsController</a></li>
<li><a href="./ChartsController.html">ChartsController</a></li>
<li><a href="./HomeController.html">HomeController</a></li>
<li><a href="./Playlist.html">Playlist</a></li>
<li><a href="./PlaylistsTracks.html">PlaylistsTracks</a></li>
<li><a href="./RedisQueryable.html">RedisQueryable</a></li>
<li><a href="./SearchController.html">SearchController</a></li>
<li><a href="./Track.html">Track</a></li>
<li><a href="./TracksController.html">TracksController</a></li>
<li><a href="./User.html">User</a></li>
<li><a href="./UsersController.html">UsersController</a></li>
<li><a href="./UsersHelper.html">UsersHelper</a></li>
<li><a href="./YoutubeVideoRating.html">YoutubeVideoRating</a></li>
</ul>
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
</div>
</div>
</div>
<div id="documentation">
<h1 class="class">User</h1>
<div id="description">
</div>
<!-- Constants -->
<!-- Attributes -->
<!-- Methods -->
<div id="public-class-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>
<div id="find-for-facebook-oauth-method" class="method-detail ">
<a name="method-c-find_for_facebook_oauth"></a>
<div class="method-heading">
<span class="method-name">find_for_facebook_oauth</span><span
class="method-args">(access_token, signed_in_resource=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="find-for-facebook-oauth-source">
<pre>
<span class="ruby-comment cmt"># File app/models/user.rb, line 21</span>
21: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">find_for_facebook_oauth</span>(<span class="ruby-identifier">access_token</span>, <span class="ruby-identifier">signed_in_resource</span>=<span class="ruby-keyword kw">nil</span>)
22: <span class="ruby-identifier">data</span> = <span class="ruby-identifier">access_token</span>[<span class="ruby-value str">'extra'</span>][<span class="ruby-value str">'user_hash'</span>]
23: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_email</span>(<span class="ruby-identifier">data</span>[<span class="ruby-value str">&quot;email&quot;</span>])
24: <span class="ruby-identifier">user</span>
25: <span class="ruby-keyword kw">else</span> <span class="ruby-comment cmt"># Create a user with a stub password.
</span>
26: <span class="ruby-constant">User</span>.<span class="ruby-identifier">create!</span>(<span class="ruby-value">:email</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">data</span>[<span class="ruby-value str">&quot;email&quot;</span>], <span class="ruby-value">:password</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Devise</span>.<span class="ruby-identifier">friendly_token</span>[<span class="ruby-value">0</span>,<span class="ruby-value">20</span>])
27: <span class="ruby-keyword kw">end</span>
28: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="find-for-open-id-method" class="method-detail ">
<a name="method-c-find_for_open_id"></a>
<div class="method-heading">
<span class="method-name">find_for_open_id</span><span
class="method-args">(access_token, signed_in_resource=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="find-for-open-id-source">
<pre>
<span class="ruby-comment cmt"># File app/models/user.rb, line 30</span>
30: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">find_for_open_id</span>(<span class="ruby-identifier">access_token</span>, <span class="ruby-identifier">signed_in_resource</span>=<span class="ruby-keyword kw">nil</span>)
31: <span class="ruby-identifier">data</span> = <span class="ruby-identifier">access_token</span>[<span class="ruby-value str">'user_info'</span>]
32: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_email</span>(<span class="ruby-identifier">data</span>[<span class="ruby-value str">&quot;email&quot;</span>])
33: <span class="ruby-identifier">user</span>
34: <span class="ruby-keyword kw">else</span> <span class="ruby-comment cmt"># Create a user with a stub password.
</span>
35: <span class="ruby-constant">User</span>.<span class="ruby-identifier">create!</span>(<span class="ruby-value">:email</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">data</span>[<span class="ruby-value str">&quot;email&quot;</span>], <span class="ruby-value">:password</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Devise</span>.<span class="ruby-identifier">friendly_token</span>[<span class="ruby-value">0</span>,<span class="ruby-value">20</span>])
36: <span class="ruby-keyword kw">end</span>
37: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div id="new-with-session-method" class="method-detail ">
<a name="method-c-new_with_session"></a>
<div class="method-heading">
<span class="method-name">new_with_session</span><span
class="method-args">(params, session)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code"
id="new-with-session-source">
<pre>
<span class="ruby-comment cmt"># File app/models/user.rb, line 13</span>
13: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new_with_session</span>(<span class="ruby-identifier">params</span>, <span class="ruby-identifier">session</span>)
14: <span class="ruby-keyword kw">super</span>.<span class="ruby-identifier">tap</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">user</span><span class="ruby-operator">|</span>
15: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">data</span> = <span class="ruby-identifier">session</span>[<span class="ruby-value str">&quot;devise.facebook_data&quot;</span>] <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">session</span>[<span class="ruby-value str">&quot;devise.facebook_data&quot;</span>][<span class="ruby-value str">&quot;extra&quot;</span>][<span class="ruby-value str">&quot;user_hash&quot;</span>]
16: <span class="ruby-identifier">user</span>.<span class="ruby-identifier">email</span> = <span class="ruby-identifier">data</span>[<span class="ruby-value str">&quot;email&quot;</span>]
17: <span class="ruby-keyword kw">end</span>
18: <span class="ruby-keyword kw">end</span>
19: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
</div>
</div>
<div id="rdoc-debugging-section-dump" class="debugging-section">
<p>Disabled; run with --debug to generate this.</p>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
Rdoc Generator</a> 1.1.6</small>.</p>
</div>
</body>
</html>