Helix SwarmHelix Swarm

Auth.html

  • //
  • guest/
  • ptomiak/
  • hws/
  • build/
  • doc/
  • helix_web_services/
  • Auth.html #1
  • View
  • Commits
  • Open Download .zip Download (7 KB) 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4.   <head>
  5.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>
  7.   Module: Auth
  8.   
  9.     &mdash; Documentation by YARD 0.8.7.6
  10.   
  11. </title>
  12.  
  13.   <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
  14.  
  15.   <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
  16.  
  17. <script type="text/javascript" charset="utf-8">
  18.   hasFrames = window.top.frames.main ? true : false;
  19.   relpath = '';
  20.   framesUrl = "frames.html#!Auth.html";
  21. </script>
  22.  
  23.  
  24.   <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
  25.  
  26.   <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
  27.  
  28.  
  29.   </head>
  30.   <body>
  31.     <div id="header">
  32.       <div id="menu">
  33.   
  34.     <a href="_index.html">Index (A)</a> &raquo;
  35.     
  36.     
  37.     <span class="title">Auth</span>
  38.   
  39.  
  40.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  41. </div>
  42.  
  43.       <div id="search">
  44.   
  45.     <a class="full_list_link" id="class_list_link"
  46.         href="class_list.html">
  47.       Class List
  48.     </a>
  49.   
  50.     <a class="full_list_link" id="method_list_link"
  51.         href="method_list.html">
  52.       Method List
  53.     </a>
  54.   
  55.     <a class="full_list_link" id="file_list_link"
  56.         href="file_list.html">
  57.       File List
  58.     </a>
  59.   
  60. </div>
  61.       <div class="clear"></div>
  62.     </div>
  63.  
  64.     <iframe id="search_frame"></iframe>
  65.  
  66.     <div id="content"><h1>Module: Auth
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.   
  75.     
  76.   
  77.     
  78.   
  79.   
  80.   
  81.     <dt class="r1 last">Defined in:</dt>
  82.     <dd class="r1 last">lib/auth.rb<span class="defines">,<br />
  83.   lib/auth/app.rb,<br /> lib/auth/middleware.rb</span>
  84. </dd>
  85.   
  86. </dl>
  87. <div class="clear"></div>
  88.  
  89. <h2>Overview</h2><div class="docstring">
  90.   <div class="discussion">
  91.     
  92. <p>This is mostly a namespace of Authentication-related methods.</p>
  93.  
  94.  
  95.   </div>
  96. </div>
  97. <div class="tags">
  98.   
  99.  
  100. </div><h2>Defined Under Namespace</h2>
  101. <p class="children">
  102.   
  103.     
  104.   
  105.     
  106.       <strong class="classes">Classes:</strong> <span class='object_link'><a href="Auth/App.html" title="Auth::App (class)">App</a></span>, <span class='object_link'><a href="Auth/Middleware.html" title="Auth::Middleware (class)">Middleware</a></span>
  107.     
  108.   
  109. </p>
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.   
  118.     <h2>
  119.       Class Method Summary
  120.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  121.     </h2>
  122.  
  123.     <ul class="summary">
  124.       
  125.         <li class="public ">
  126.   <span class="summary_signature">
  127.     
  128.       <a href="#p4_ticket%3F-class_method" title="p4_ticket? (class method)">+ (Boolean) <strong>p4_ticket?</strong>(str) </a>
  129.     
  130.  
  131.     
  132.   </span>
  133.   
  134.   
  135.   
  136.   
  137.   
  138.   
  139.   
  140.  
  141.   
  142.     <span class="summary_desc"><div class='inline'>
  143. <p>Returns true if the string looks like a Perforce authentication ticket.</p>
  144. </div></span>
  145.   
  146. </li>
  147.  
  148.       
  149.         <li class="public ">
  150.   <span class="summary_signature">
  151.     
  152.       <a href="#read_token-class_method" title="read_token (class method)">+ (Object) <strong>read_token</strong>(token, settings) </a>
  153.     
  154.  
  155.     
  156.   </span>
  157.   
  158.   
  159.   
  160.   
  161.   
  162.   
  163.   
  164.  
  165.   
  166.     <span class="summary_desc"><div class='inline'></div></span>
  167.   
  168. </li>
  169.  
  170.       
  171.     </ul>
  172.   
  173.  
  174.  
  175.  
  176.   <div id="class_method_details" class="method_details_list">
  177.     <h2>Class Method Details</h2>
  178.  
  179.     
  180.       <div class="method_details first">
  181.   <h3 class="signature first" id="p4_ticket?-class_method">
  182.   
  183.     + (<tt>Boolean</tt>) <strong>p4_ticket?</strong>(str) 
  184.   
  185.  
  186.   
  187.  
  188.   
  189. </h3><div class="docstring">
  190.   <div class="discussion">
  191.     
  192. <p>Returns true if the string looks like a Perforce authentication ticket.</p>
  193.  
  194.  
  195.   </div>
  196. </div>
  197. <div class="tags">
  198.   
  199. <p class="tag_title">Returns:</p>
  200. <ul class="return">
  201.   
  202.     <li>
  203.       
  204.       
  205.         <span class='type'>(<tt>Boolean</tt>)</span>
  206.       
  207.       
  208.       
  209.     </li>
  210.   
  211. </ul>
  212.  
  213. </div><table class="source_code">
  214.   <tr>
  215.     <td>
  216.       <pre class="lines">
  217.  
  218.  
  219. 13
  220. 14
  221. 15</pre>
  222.     </td>
  223.     <td>
  224.       <pre class="code"><span class="info file"># File 'lib/auth.rb', line 13</span>
  225.  
  226. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_p4_ticket?'>p4_ticket?</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  227.   <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^[a-zA-Z0-9]{32,}$</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span> <span class='op'>!=</span> <span class='kw'>nil</span>
  228. <span class='kw'>end</span></pre>
  229.     </td>
  230.   </tr>
  231. </table>
  232. </div>
  233.     
  234.       <div class="method_details ">
  235.   <h3 class="signature " id="read_token-class_method">
  236.   
  237.     + (<tt>Object</tt>) <strong>read_token</strong>(token, settings) 
  238.   
  239.  
  240.   
  241.  
  242.   
  243. </h3><table class="source_code">
  244.   <tr>
  245.     <td>
  246.       <pre class="lines">
  247.  
  248.  
  249. 17
  250. 18
  251. 19
  252. 20
  253. 21
  254. 22
  255. 23
  256. 24
  257. 25</pre>
  258.     </td>
  259.     <td>
  260.       <pre class="code"><span class="info file"># File 'lib/auth.rb', line 17</span>
  261.  
  262. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_read_token'>read_token</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
  263.   <span class='id identifier rubyid_token_path'>token_path</span> <span class='op'>=</span> <span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_token_path'>token_path</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='id identifier rubyid_token'>token</span>
  264.   <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span><span class='id identifier rubyid_token_path'>token_path</span><span class='rparen'>)</span>
  265.     <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_token_path'>token_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>r</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_file'>file</span><span class='op'>|</span>
  266.       <span class='kw'>return</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='rparen'>)</span>
  267.     <span class='kw'>end</span>
  268.   <span class='kw'>end</span>
  269.   <span class='kw'>nil</span>
  270. <span class='kw'>end</span></pre>
  271.     </td>
  272.   </tr>
  273. </table>
  274. </div>
  275.     
  276.   </div>
  277.  
  278. </div>
  279.  
  280.     <div id="footer">
  281.   Generated on Tue Sep 15 01:20:27 2015 by
  282.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  283.   0.8.7.6 (ruby-2.2.3).
  284. </div>
  285.  
  286.   </body>
  287. </html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use. 10 years ago