Helix SwarmHelix Swarm

Auth.html

  • //
  • guest/
  • doug_scheirer/
  • helix-web-services/
  • main/
  • build/
  • doc/
  • helix_web_services/
  • Cloud/
  • Auth.html #5
  • View
  • Commits
  • Open Download .zip Download (18 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.   Class: Cloud::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#!Cloud/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.     <span class='title'><span class='object_link'><a href="../Cloud.html" title="Cloud (module)">Cloud</a></span></span>
  36.      &raquo; 
  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>Class: Cloud::Auth
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.     <dt class="r1">Inherits:</dt>
  75.     <dd class="r1">
  76.       <span class="inheritName">Object</span>
  77.       
  78.         <ul class="fullTree">
  79.           <li>Object</li>
  80.           
  81.             <li class="next">Cloud::Auth</li>
  82.           
  83.         </ul>
  84.         <a href="#" class="inheritanceTree">show all</a>
  85.       
  86.       </dd>
  87.     
  88.   
  89.   
  90.     
  91.   
  92.     
  93.   
  94.   
  95.   
  96.     <dt class="r2 last">Defined in:</dt>
  97.     <dd class="r2 last">lib/cloud/auth.rb</dd>
  98.   
  99. </dl>
  100. <div class="clear"></div>
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.   
  110.     <h2>
  111.       Class Method Summary
  112.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  113.     </h2>
  114.  
  115.     <ul class="summary">
  116.       
  117.         <li class="public ">
  118.   <span class="summary_signature">
  119.     
  120.       <a href="#login-class_method" title="login (class method)">+ (Object) <strong>login</strong>(user, password) </a>
  121.     
  122.  
  123.     
  124.   </span>
  125.   
  126.   
  127.   
  128.   
  129.   
  130.   
  131.   
  132.  
  133.   
  134.     <span class="summary_desc"><div class='inline'></div></span>
  135.   
  136. </li>
  137.  
  138.       
  139.         <li class="public ">
  140.   <span class="summary_signature">
  141.     
  142.       <a href="#logout-class_method" title="logout (class method)">+ (Object) <strong>logout</strong>(env) </a>
  143.     
  144.  
  145.     
  146.   </span>
  147.   
  148.   
  149.   
  150.   
  151.   
  152.   
  153.   
  154.  
  155.   
  156.     <span class="summary_desc"><div class='inline'></div></span>
  157.   
  158. </li>
  159.  
  160.       
  161.         <li class="public ">
  162.   <span class="summary_signature">
  163.     
  164.       <a href="#valid_session%3F-class_method" title="valid_session? (class method)">+ (Boolean) <strong>valid_session?</strong>(env, auth) </a>
  165.     
  166.  
  167.     
  168.   </span>
  169.   
  170.   
  171.   
  172.   
  173.   
  174.   
  175.   
  176.  
  177.   
  178.     <span class="summary_desc"><div class='inline'></div></span>
  179.   
  180. </li>
  181.  
  182.       
  183.     </ul>
  184.   
  185.  
  186.  
  187.  
  188.   <div id="class_method_details" class="method_details_list">
  189.     <h2>Class Method Details</h2>
  190.  
  191.     
  192.       <div class="method_details first">
  193.   <h3 class="signature first" id="login-class_method">
  194.   
  195.     + (<tt>Object</tt>) <strong>login</strong>(user, password) 
  196.   
  197.  
  198.   
  199.  
  200.   
  201. </h3><table class="source_code">
  202.   <tr>
  203.     <td>
  204.       <pre class="lines">
  205.  
  206.  
  207. 33
  208. 34
  209. 35
  210. 36
  211. 37
  212. 38
  213. 39
  214. 40
  215. 41
  216. 42
  217. 43
  218. 44
  219. 45
  220. 46
  221. 47
  222. 48
  223. 49
  224. 50
  225. 51</pre>
  226.     </td>
  227.     <td>
  228.       <pre class="code"><span class="info file"># File 'lib/cloud/auth.rb', line 33</span>
  229.  
  230. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
  231.   <span class='kw'>begin</span>
  232.     <span class='comment'># POST (cloud url)/api/v1/login
  233. </span>    <span class='comment'># puts &quot;login against #{Settings.cloud_settings[:helix_cloud_url]}/api/v1/login&quot;
  234. </span>    <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='const'>URI</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>Settings</span><span class='period'>.</span><span class='id identifier rubyid_cloud_settings'>cloud_settings</span><span class='lbracket'>[</span><span class='symbol'>:helix_cloud_url</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/api/v1/login</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  235.     <span class='comment'># return the session token for this user
  236. </span>    <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='rparen'>)</span>
  237.     <span class='id identifier rubyid_req'>req</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span>
  238.     <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_set_form_data'>set_form_data</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user[name]</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user[password]</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
  239.     <span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='period'>.</span><span class='id identifier rubyid_hostname'>hostname</span><span class='comma'>,</span> <span class='id identifier rubyid_uri'>uri</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_http'>http</span><span class='op'>|</span>
  240.       <span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_req'>req</span><span class='rparen'>)</span>
  241.     <span class='rbrace'>}</span>
  242.  
  243.     <span class='comment'># the body contains the required cookie
  244. </span>    <span class='kw'>return</span> <span class='lparen'>(</span><span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>200</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
  245.   <span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
  246.     <span class='comment'># puts e.message
  247. </span>  <span class='kw'>end</span>
  248. <span class='kw'>end</span></pre>
  249.     </td>
  250.   </tr>
  251. </table>
  252. </div>
  253.     
  254.       <div class="method_details ">
  255.   <h3 class="signature " id="logout-class_method">
  256.   
  257.     + (<tt>Object</tt>) <strong>logout</strong>(env) 
  258.   
  259.  
  260.   
  261.  
  262.   
  263. </h3><table class="source_code">
  264.   <tr>
  265.     <td>
  266.       <pre class="lines">
  267.  
  268.  
  269. 53
  270. 54
  271. 55
  272. 56
  273. 57
  274. 58</pre>
  275.     </td>
  276.     <td>
  277.       <pre class="code"><span class="info file"># File 'lib/cloud/auth.rb', line 53</span>
  278.  
  279. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_logout'>logout</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
  280.   <span class='comment'># POST (cloud url)/api/v1/logout
  281. </span>  <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='const'>URI</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>HWSSettings</span><span class='period'>.</span><span class='id identifier rubyid_cloud_settings'>cloud_settings</span><span class='lbracket'>[</span><span class='symbol'>:helix_cloud_url</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/api/v1/login</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  282.   <span class='comment'># set the session token somehow
  283. </span>  <span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='rparen'>)</span>
  284. <span class='kw'>end</span></pre>
  285.     </td>
  286.   </tr>
  287. </table>
  288. </div>
  289.     
  290.       <div class="method_details ">
  291.   <h3 class="signature " id="valid_session?-class_method">
  292.   
  293.     + (<tt>Boolean</tt>) <strong>valid_session?</strong>(env, auth) 
  294.   
  295.  
  296.   
  297.  
  298.   
  299. </h3><div class="docstring">
  300.   <div class="discussion">
  301.     
  302.  
  303.   </div>
  304. </div>
  305. <div class="tags">
  306.   
  307. <p class="tag_title">Returns:</p>
  308. <ul class="return">
  309.   
  310.     <li>
  311.       
  312.       
  313.         <span class='type'>(<tt>Boolean</tt>)</span>
  314.       
  315.       
  316.       
  317.     </li>
  318.   
  319. </ul>
  320.  
  321. </div><table class="source_code">
  322.   <tr>
  323.     <td>
  324.       <pre class="lines">
  325.  
  326.  
  327. 8
  328. 9
  329. 10
  330. 11
  331. 12
  332. 13
  333. 14
  334. 15
  335. 16
  336. 17
  337. 18
  338. 19
  339. 20
  340. 21
  341. 22
  342. 23
  343. 24
  344. 25
  345. 26
  346. 27
  347. 28
  348. 29
  349. 30</pre>
  350.     </td>
  351.     <td>
  352.       <pre class="code"><span class="info file"># File 'lib/cloud/auth.rb', line 8</span>
  353.  
  354. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_valid_session?'>valid_session?</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='comma'>,</span> <span class='id identifier rubyid_auth'>auth</span><span class='rparen'>)</span>
  355.   <span class='comment'># if the session is not valid, throw an exception
  356. </span>  <span class='comment'># GET (cloud url)/api/v1/user
  357. </span>  <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='const'>URI</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>Settings</span><span class='period'>.</span><span class='id identifier rubyid_cloud_settings'>cloud_settings</span><span class='lbracket'>[</span><span class='symbol'>:helix_cloud_url</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/api/v1/user</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  358.   <span class='comment'># auth.credentials.first == username
  359. </span>  <span class='comment'># auth.credentials.last == session token
  360. </span>  <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Get</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='rparen'>)</span>
  361.   <span class='id identifier rubyid_req'>req</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Cookie</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_auth'>auth</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
  362.   <span class='id identifier rubyid_req'>req</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span>
  363.  
  364.   <span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='period'>.</span><span class='id identifier rubyid_hostname'>hostname</span><span class='comma'>,</span> <span class='id identifier rubyid_uri'>uri</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_http'>http</span><span class='op'>|</span>
  365.     <span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_req'>req</span><span class='rparen'>)</span>
  366.   <span class='rbrace'>}</span>
  367.  
  368.   <span class='comment'># make sure the username matches?
  369. </span>  <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>200</span><span class='tstring_end'>&#39;</span></span> <span class='op'>||</span> <span class='const'>JSON</span><span class='lparen'>(</span><span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='id identifier rubyid_auth'>auth</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
  370.  
  371.   <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTH_CREDENTIALS</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_auth'>auth</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span>
  372.   <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>p4.user</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='lparen'>(</span><span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  373.   <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>p4</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>nil</span>
  374.  
  375.   <span class='kw'>return</span> <span class='kw'>true</span>
  376. <span class='kw'>end</span></pre>
  377.     </td>
  378.   </tr>
  379. </table>
  380. </div>
  381.     
  382.   </div>
  383.  
  384. </div>
  385.  
  386.     <div id="footer">
  387.   Generated on Mon Oct 12 22:20:51 2015 by
  388.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  389.   0.8.7.6 (ruby-2.2.3).
  390. </div>
  391.  
  392.   </body>
  393. </html>
# Change User Description Committed
#5 16275 Doug Scheirer Merge from main 9 years ago
#4 16196 Doug Scheirer Merge from main 9 years ago
#3 16148 Doug Scheirer Merge from main 9 years ago
#2 16114 Doug Scheirer Merge from main 9 years ago
#1 16079 Doug Scheirer Merge from main 9 years ago
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services/Cloud/Auth.html
#2 16077 tjuricek HWS/NOARCH/2015.1.main/201510051630

Includes changes to trust behavior 		9 years ago
#1 16075 tjuricek HWS/NOARCH/2015.1.main/201510051543

This includes a first implementation of the Helix C...loud integration with Helix Sync. «		 9 years ago