nocebo/diaspora
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
diaspora/doc/PublicsController.html
Raphael Sofaer 4815482354 Start some real docs
2011-06-13 16:12:32 -07:00

490 lines
No EOL
19 KiB
HTML
Raw Blame History

<!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>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: PublicsController
&mdash; Documentation by YARD 0.7.1
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') 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>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="_index.html">Index (P)</a> &raquo;
<span class="title">PublicsController</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: PublicsController
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="ApplicationController.html" title="ApplicationController (class)">ApplicationController</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next">ActionController::Base</li>
<li class="next"><span class='object_link'><a href="ApplicationController.html" title="ApplicationController (class)">ApplicationController</a></span></li>
<li class="next">PublicsController</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2">Includes:</dt>
<dd class="r2"><span class='object_link'><a href="Diaspora/Parser.html" title="Diaspora::Parser (module)">Diaspora::Parser</a></span></dd>
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">app/controllers/publics_controller.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>
Copyright &#169; 2010, Diaspora Inc. This file is
</p>
<pre class="code">
<span class='licensed identifier id'>licensed</span> <span class='under identifier id'>under</span> <span class='the identifier id'>the</span> <span class='Affero constant id'>Affero</span> <span class='General constant id'>General</span> <span class='Public constant id'>Public</span> <span class='License constant id'>License</span> <span class='version identifier id'>version</span> <span class='integer val'>3</span> <span class='or or kw'>or</span> <span class='later identifier id'>later</span><span class='dot token'>.</span> <span class='See constant id'>See</span>
<span class='the identifier id'>the</span> <span class='COPYRIGHT constant id'>COPYRIGHT</span> <span class='file identifier id'>file</span><span class='dot token'>.</span>
</pre>
</div>
</div>
<div class="tags">
</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="#hcard-instance_method" title="#hcard (instance method)">- (Object) <strong>hcard</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#host_meta-instance_method" title="#host_meta (instance method)">- (Object) <strong>host_meta</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#hub-instance_method" title="#hub (instance method)">- (Object) <strong>hub</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#receive-instance_method" title="#receive (instance method)">- (Object) <strong>receive</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#webfinger-instance_method" title="#webfinger (instance method)">- (Object) <strong>webfinger</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Diaspora/Parser.html" title="Diaspora::Parser (module)">Diaspora::Parser</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Diaspora/Parser.html#from_xml-class_method" title="Diaspora::Parser.from_xml (method)">from_xml</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="ApplicationController.html" title="ApplicationController (class)">ApplicationController</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ApplicationController.html#after_sign_in_path_for-instance_method" title="ApplicationController#after_sign_in_path_for (method)">#after_sign_in_path_for</a></span>, <span class='object_link'><a href="ApplicationController.html#clear_gc_stats-instance_method" title="ApplicationController#clear_gc_stats (method)">#clear_gc_stats</a></span>, <span class='object_link'><a href="ApplicationController.html#ensure_http_referer_is_set-instance_method" title="ApplicationController#ensure_http_referer_is_set (method)">#ensure_http_referer_is_set</a></span>, <span class='object_link'><a href="ApplicationController.html#ensure_page-instance_method" title="ApplicationController#ensure_page (method)">#ensure_page</a></span>, <span class='object_link'><a href="ApplicationController.html#grammatical_gender-instance_method" title="ApplicationController#grammatical_gender (method)">#grammatical_gender</a></span>, <span class='object_link'><a href="ApplicationController.html#redirect_unless_admin-instance_method" title="ApplicationController#redirect_unless_admin (method)">#redirect_unless_admin</a></span>, <span class='object_link'><a href="ApplicationController.html#set_git_header-instance_method" title="ApplicationController#set_git_header (method)">#set_git_header</a></span>, <span class='object_link'><a href="ApplicationController.html#set_grammatical_gender-instance_method" title="ApplicationController#set_grammatical_gender (method)">#set_grammatical_gender</a></span>, <span class='object_link'><a href="ApplicationController.html#set_header_data-instance_method" title="ApplicationController#set_header_data (method)">#set_header_data</a></span>, <span class='object_link'><a href="ApplicationController.html#set_invites-instance_method" title="ApplicationController#set_invites (method)">#set_invites</a></span>, <span class='object_link'><a href="ApplicationController.html#set_locale-instance_method" title="ApplicationController#set_locale (method)">#set_locale</a></span>, <span class='object_link'><a href="ApplicationController.html#which_action_and_user-instance_method" title="ApplicationController#which_action_and_user (method)">#which_action_and_user</a></span></p>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<p class="signature first" id="hcard-instance_method">
- (<tt>Object</tt>) <strong>hcard</strong>
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/publics_controller.rb', line 17</span>
<span class='def def kw'>def</span> <span class='hcard identifier id'>hcard</span>
<span class='@person ivar id'>@person</span> <span class='assign token'>=</span> <span class='Person constant id'>Person</span><span class='dot token'>.</span><span class='where identifier id'>where</span><span class='lparen token'>(</span><span class='symbol val'>:guid</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:guid</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='first identifier id'>first</span>
<span class='unless unless kw'>unless</span> <span class='@person ivar id'>@person</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='orop op'>||</span> <span class='@person ivar id'>@person</span><span class='dot token'>.</span><span class='owner identifier id'>owner</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
<span class='render identifier id'>render</span> <span class='string val'>'publics/hcard'</span>
<span class='else else kw'>else</span>
<span class='render identifier id'>render</span> <span class='symbol val'>:nothing</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='true true kw'>true</span><span class='comma token'>,</span> <span class='symbol val'>:status</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>404</span>
<span class='end end kw'>end</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="host_meta-instance_method">
- (<tt>Object</tt>) <strong>host_meta</strong>
</p><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/publics_controller.rb', line 26</span>
<span class='def def kw'>def</span> <span class='host_meta identifier id'>host_meta</span>
<span class='render identifier id'>render</span> <span class='string val'>'host_meta'</span><span class='comma token'>,</span> <span class='symbol val'>:content_type</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'application/xrd+xml'</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="hub-instance_method">
- (<tt>Object</tt>) <strong>hub</strong>
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/publics_controller.rb', line 39</span>
<span class='def def kw'>def</span> <span class='hub identifier id'>hub</span>
<span class='render identifier id'>render</span> <span class='symbol val'>:text</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='string val'>'hub.challenge'</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:status</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>202</span><span class='comma token'>,</span> <span class='symbol val'>:layout</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='false false kw'>false</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="receive-instance_method">
- (<tt>Object</tt>) <strong>receive</strong>
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/publics_controller.rb', line 43</span>
<span class='def def kw'>def</span> <span class='receive identifier id'>receive</span>
<span class='if if kw'>if</span> <span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:xml</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
<span class='render identifier id'>render</span> <span class='symbol val'>:nothing</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='true true kw'>true</span><span class='comma token'>,</span> <span class='symbol val'>:status</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>422</span>
<span class='return return kw'>return</span>
<span class='end end kw'>end</span>
<span class='person identifier id'>person</span> <span class='assign token'>=</span> <span class='Person constant id'>Person</span><span class='dot token'>.</span><span class='where identifier id'>where</span><span class='lparen token'>(</span><span class='symbol val'>:guid</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:guid</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='first identifier id'>first</span>
<span class='if if kw'>if</span> <span class='person identifier id'>person</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='orop op'>||</span> <span class='person identifier id'>person</span><span class='dot token'>.</span><span class='owner_id identifier id'>owner_id</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
<span class='Rails constant id'>Rails</span><span class='dot token'>.</span><span class='logger identifier id'>logger</span><span class='dot token'>.</span><span class='error identifier id'>error</span><span class='lparen token'>(</span><span class='dstring node'>&quot;Received post for nonexistent person #{params[:guid]}&quot;</span><span class='rparen token'>)</span>
<span class='render identifier id'>render</span> <span class='symbol val'>:nothing</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='true true kw'>true</span><span class='comma token'>,</span> <span class='symbol val'>:status</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>404</span>
<span class='return return kw'>return</span>
<span class='end end kw'>end</span>
<span class='@user ivar id'>@user</span> <span class='assign token'>=</span> <span class='person identifier id'>person</span><span class='dot token'>.</span><span class='owner identifier id'>owner</span>
<span class='Resque constant id'>Resque</span><span class='dot token'>.</span><span class='enqueue identifier id'>enqueue</span><span class='lparen token'>(</span><span class='Job constant id'>Job</span><span class='colon2 op'>::</span><span class='ReceiveSalmon constant id'>ReceiveSalmon</span><span class='comma token'>,</span> <span class='@user ivar id'>@user</span><span class='dot token'>.</span><span class='id identifier id'>id</span><span class='comma token'>,</span> <span class='CGI constant id'>CGI</span><span class='colon2 op'>::</span><span class='unescape identifier id'>unescape</span><span class='lparen token'>(</span><span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:xml</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
<span class='render identifier id'>render</span> <span class='symbol val'>:nothing</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='true true kw'>true</span><span class='comma token'>,</span> <span class='symbol val'>:status</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>202</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="webfinger-instance_method">
- (<tt>Object</tt>) <strong>webfinger</strong>
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32
33
34
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/controllers/publics_controller.rb', line 30</span>
<span class='def def kw'>def</span> <span class='webfinger identifier id'>webfinger</span>
<span class='@person ivar id'>@person</span> <span class='assign token'>=</span> <span class='Person constant id'>Person</span><span class='dot token'>.</span><span class='local_by_account_identifier identifier id'>local_by_account_identifier</span><span class='lparen token'>(</span><span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:q</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:q</span><span class='rbrack token'>]</span>
<span class='unless unless kw'>unless</span> <span class='@person ivar id'>@person</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
<span class='render identifier id'>render</span> <span class='string val'>'webfinger'</span><span class='comma token'>,</span> <span class='symbol val'>:content_type</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'application/xrd+xml'</span>
<span class='else else kw'>else</span>
<span class='render identifier id'>render</span> <span class='symbol val'>:nothing</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='true true kw'>true</span><span class='comma token'>,</span> <span class='symbol val'>:status</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>404</span>
<span class='end end kw'>end</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jun 13 15:59:23 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.1 (ruby-1.8.7).
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink