debshots/doc/Users/OmniauthCallbacksController.html

546 lines
No EOL
14 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Users::OmniauthCallbacksController
&mdash; Documentation by YARD 0.9.25
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Users::OmniauthCallbacksController";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (O)</a> &raquo;
<span class='title'>Users</span>
&raquo;
<span class="title">OmniauthCallbacksController</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Users::OmniauthCallbacksController
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Devise::OmniauthCallbacksController</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Devise::OmniauthCallbacksController</li>
<li class="next">Users::OmniauthCallbacksController</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>app/controllers/users/omniauth_callbacks_controller.rb</dd>
</dl>
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#amazon-instance_method" title="#amazon (instance method)">#<strong>amazon</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#failure-instance_method" title="#failure (instance method)">#<strong>failure</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#github-instance_method" title="#github (instance method)">#<strong>github</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#google_oauth2-instance_method" title="#google_oauth2 (instance method)">#<strong>google_oauth2</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#launchpad-instance_method" title="#launchpad (instance method)">#<strong>launchpad</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Workaround for <a
href="https://github.com/plataformatec/devise/issues/2432">github.com/plataformatec/devise/issues/2432</a>
skip_before_filter :verify_authenticity_token.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#login_via-instance_method" title="#login_via (instance method)">#<strong>login_via</strong>(provider_name) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stackexchange-instance_method" title="#stackexchange (instance method)">#<strong>stackexchange</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="amazon-instance_method">
#<strong>amazon</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/users/omniauth_callbacks_controller.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_amazon'>amazon</span>
<span class='id identifier rubyid_login_via'>login_via</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Amazon</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="failure-instance_method">
#<strong>failure</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/users/omniauth_callbacks_controller.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_failure'>failure</span>
<span class='id identifier rubyid_redirect_to'>redirect_to</span> <span class='id identifier rubyid_root_path'>root_path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="github-instance_method">
#<strong>github</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/users/omniauth_callbacks_controller.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_github'>github</span>
<span class='id identifier rubyid_login_via'>login_via</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Github</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="google_oauth2-instance_method">
#<strong>google_oauth2</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/users/omniauth_callbacks_controller.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_google_oauth2'>google_oauth2</span>
<span class='id identifier rubyid_login_via'>login_via</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Google</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="launchpad-instance_method">
#<strong>launchpad</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Workaround for <a
href="https://github.com/plataformatec/devise/issues/2432">github.com/plataformatec/devise/issues/2432</a>
skip_before_filter :verify_authenticity_token</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/users/omniauth_callbacks_controller.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_launchpad'>launchpad</span>
<span class='id identifier rubyid_login_via'>login_via</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Launchpad</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="login_via-instance_method">
#<strong>login_via</strong>(provider_name) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/users/omniauth_callbacks_controller.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_login_via'>login_via</span><span class='lparen'>(</span><span class='id identifier rubyid_provider_name'>provider_name</span><span class='rparen'>)</span>
<span class='comment'># TODO: log
</span>
<span class='comment'># You need to implement the method below in your model (e.g. app/models/user.rb)
</span> <span class='ivar'>@user</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../User.html" title="User (class)">User</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_omniauth'><span class='object_link'><a href="../User.html#from_omniauth-class_method" title="User.from_omniauth (method)">from_omniauth</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>omniauth.auth</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='comment'># Has the user uploaded screenshots while not being logged in?
</span> <span class='comment'># Move the screenshots to the real account and tell the user.
</span> <span class='kw'>if</span> <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span>
<span class='id identifier rubyid_flash'>flash</span><span class='lbracket'>[</span><span class='symbol'>:notice</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>I18n</span><span class='period'>.</span><span class='id identifier rubyid_t'>t</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>devise.omniauth_callbacks.success</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:kind</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_provider_name'>provider_name</span>
<span class='id identifier rubyid_sign_in_and_redirect'>sign_in_and_redirect</span> <span class='ivar'>@user</span><span class='comma'>,</span> <span class='symbol'>:event</span> <span class='op'>=&gt;</span> <span class='symbol'>:authentication</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_redirect_to'>redirect_to</span> <span class='id identifier rubyid_new_user_session_url'>new_user_session_url</span><span class='comma'>,</span> <span class='label'>alert:</span> <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_full_messages'>full_messages</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="stackexchange-instance_method">
#<strong>stackexchange</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/users/omniauth_callbacks_controller.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stackexchange'>stackexchange</span>
<span class='id identifier rubyid_login_via'>login_via</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>StackExchange</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Oct 20 19:33:31 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
</div>
</body>
</html>