gitlabhq/doc/code/classes/OmniauthCallbacksController.html
2012-12-30 14:43:00 +02:00

188 lines
No EOL
7 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!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>OmniauthCallbacksController</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
<link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
<link rel="stylesheet" href="../css/github.css" type="text/css" media="screen" />
<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
<script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
<script src="../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
</head>
<body>
<div class="banner">
<h1>
<span class="type">Class</span>
OmniauthCallbacksController
<span class="parent">&lt;
Devise::OmniauthCallbacksController
</span>
</h1>
<ul class="files">
<li><a href="../files/app/controllers/omniauth_callbacks_controller_rb.html">app/controllers/omniauth_callbacks_controller.rb</a></li>
</ul>
</div>
<div id="bodyContent">
<div id="content">
<!-- Method ref -->
<div class="sectiontitle">Methods</div>
<dl class="methods">
<dt>F</dt>
<dd>
<ul>
<li>
<a href="#method-i-failure_message">failure_message</a>
</li>
</ul>
</dd>
<dt>L</dt>
<dd>
<ul>
<li>
<a href="#method-i-ldap">ldap</a>
</li>
</ul>
</dd>
</dl>
<!-- Methods -->
<div class="sectiontitle">Instance Public methods</div>
<div class="method">
<div class="title method-title" id="method-i-failure_message">
<b>failure_message</b>()
<a href="../classes/OmniauthCallbacksController.html#method-i-failure_message" name="method-i-failure_message" class="permalink">Link</a>
</div>
<div class="description">
<p>Extend the standard message generation to accept our custom exception</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source:
<a href="javascript:toggleSource('method-i-failure_message_source')" id="l_method-i-failure_message_source">show</a>
</p>
<div id="method-i-failure_message_source" class="dyn-source">
<pre><span class="ruby-comment"># File app/controllers/omniauth_callbacks_controller.rb, line 9</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">failure_message</span>
<span class="ruby-identifier">exception</span> = <span class="ruby-identifier">env</span>[<span class="ruby-string">&quot;omniauth.error&quot;</span>]
<span class="ruby-identifier">error</span> = <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">error_reason</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:error_reason</span>)
<span class="ruby-identifier">error</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">error</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:error</span>)
<span class="ruby-identifier">error</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">message</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:message</span>)
<span class="ruby-identifier">error</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">env</span>[<span class="ruby-string">&quot;omniauth.error.type&quot;</span>].<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">error</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">humanize</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">error</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title method-title" id="method-i-ldap">
<b>ldap</b>()
<a href="../classes/OmniauthCallbacksController.html#method-i-ldap" name="method-i-ldap" class="permalink">Link</a>
</div>
<div class="description">
</div>
<div class="sourcecode">
<p class="source-link">
Source:
<a href="javascript:toggleSource('method-i-ldap_source')" id="l_method-i-ldap_source">show</a>
</p>
<div id="method-i-ldap_source" class="dyn-source">
<pre><span class="ruby-comment"># File app/controllers/omniauth_callbacks_controller.rb, line 18</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">ldap</span>
<span class="ruby-comment"># We only find ourselves here if the authentication to LDAP was successful.</span>
<span class="ruby-ivar">@user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_for_ldap_auth</span>(<span class="ruby-identifier">request</span>.<span class="ruby-identifier">env</span>[<span class="ruby-string">&quot;omniauth.auth&quot;</span>], <span class="ruby-identifier">current_user</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@user</span>.<span class="ruby-identifier">persisted?</span>
<span class="ruby-ivar">@user</span>.<span class="ruby-identifier">remember_me</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">sign_in_and_redirect</span> <span class="ruby-ivar">@user</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>