Loading...
Helix SwarmHelix Swarm
Loading...

FileService.html

  • //
  • guest/
  • doug_scheirer/
  • helix-web-services/
  • main/
  • build/
  • doc/
  • helix_web_services/
  • HelixVersioningEngine/
  • FileService.html #11
  • View
  • Commits
  • Open Download .zip Download (31 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: HelixVersioningEngine::FileService
  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#!HelixVersioningEngine/FileService.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 (F)</a> &raquo;
  35.     <span class='title'><span class='object_link'><a href="../HelixVersioningEngine.html" title="HelixVersioningEngine (module)">HelixVersioningEngine</a></span></span>
  36.      &raquo; 
  37.     <span class="title">FileService</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: HelixVersioningEngine::FileService
  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">HelixVersioningEngine::FileService</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/helix_versioning_engine/file_service.rb</dd>
  98.   
  99. </dl>
  100. <div class="clear"></div>
  101.  
  102. <h2>Overview</h2><div class="docstring">
  103.   <div class="discussion">
  104.     
  105. <p>Used to obtain consistent output to “files” commands and return output in
  106. our model format for consumption by other services.</p>
  107.  
  108.  
  109.   </div>
  110. </div>
  111. <div class="tags">
  112.   
  113.  
  114. </div>
  115.  
  116.  
  117.  
  118.   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
  119.   <ul class="summary">
  120.     
  121.       <li class="public ">
  122.   <span class="summary_signature">
  123.     
  124.       <a href="#p4-instance_method" title="#p4 (instance method)">- (Object) <strong>p4</strong> </a>
  125.     
  126.  
  127.     
  128.   </span>
  129.   
  130.   
  131.   
  132.     
  133.       <span class="note title readonly">readonly</span>
  134.     
  135.     
  136.   
  137.   
  138.   
  139.   
  140.   
  141.  
  142.   
  143.     <span class="summary_desc"><div class='inline'>
  144. <p>Returns the value of attribute p4.</p>
  145. </div></span>
  146.   
  147. </li>
  148.  
  149.     
  150.   </ul>
  151.  
  152.  
  153.  
  154.  
  155.   
  156.     <h2>
  157.       Instance Method Summary
  158.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  159.     </h2>
  160.  
  161.     <ul class="summary">
  162.       
  163.         <li class="public ">
  164.   <span class="summary_signature">
  165.     
  166.       <a href="#fetch_offset-instance_method" title="#fetch_offset (instance method)">- (Object) <strong>fetch_offset</strong> </a>
  167.     
  168.  
  169.     
  170.   </span>
  171.   
  172.   
  173.   
  174.   
  175.   
  176.   
  177.   
  178.  
  179.   
  180.     <span class="summary_desc"><div class='inline'></div></span>
  181.   
  182. </li>
  183.  
  184.       
  185.         <li class="public ">
  186.   <span class="summary_signature">
  187.     
  188.       <a href="#initialize-instance_method" title="#initialize (instance method)">- (FileService) <strong>initialize</strong>(p4: nil) </a>
  189.     
  190.  
  191.     
  192.   </span>
  193.   
  194.   
  195.     <span class="note title constructor">constructor</span>
  196.   
  197.   
  198.   
  199.   
  200.   
  201.   
  202.  
  203.   
  204.     <span class="summary_desc"><div class='inline'>
  205. <p>A new instance of FileService.</p>
  206. </div></span>
  207.   
  208. </li>
  209.  
  210.       
  211.         <li class="public ">
  212.   <span class="summary_signature">
  213.     
  214.       <a href="#list-instance_method" title="#list (instance method)">- (Object) <strong>list</strong>(dirs) </a>
  215.     
  216.  
  217.     
  218.   </span>
  219.   
  220.   
  221.   
  222.   
  223.   
  224.   
  225.   
  226.  
  227.   
  228.     <span class="summary_desc"><div class='inline'></div></span>
  229.   
  230. </li>
  231.  
  232.       
  233.         <li class="public ">
  234.   <span class="summary_signature">
  235.     
  236.       <a href="#list_depots-instance_method" title="#list_depots (instance method)">- (Object) <strong>list_depots</strong> </a>
  237.     
  238.  
  239.     
  240.   </span>
  241.   
  242.   
  243.   
  244.   
  245.   
  246.   
  247.   
  248.  
  249.   
  250.     <span class="summary_desc"><div class='inline'></div></span>
  251.   
  252. </li>
  253.  
  254.       
  255.         <li class="public ">
  256.   <span class="summary_signature">
  257.     
  258.       <a href="#list_dir-instance_method" title="#list_dir (instance method)">- (Object) <strong>list_dir</strong>(dirs) </a>
  259.     
  260.  
  261.     
  262.   </span>
  263.   
  264.   
  265.   
  266.   
  267.   
  268.   
  269.   
  270.  
  271.   
  272.     <span class="summary_desc"><div class='inline'></div></span>
  273.   
  274. </li>
  275.  
  276.       
  277.         <li class="public ">
  278.   <span class="summary_signature">
  279.     
  280.       <a href="#list_file-instance_method" title="#list_file (instance method)">- (Object) <strong>list_file</strong>(file_path) </a>
  281.     
  282.  
  283.     
  284.   </span>
  285.   
  286.   
  287.   
  288.   
  289.   
  290.   
  291.   
  292.  
  293.   
  294.     <span class="summary_desc"><div class='inline'></div></span>
  295.   
  296. </li>
  297.  
  298.       
  299.         <li class="public ">
  300.   <span class="summary_signature">
  301.     
  302.       <a href="#normalize_depots-instance_method" title="#normalize_depots (instance method)">- (Object) <strong>normalize_depots</strong>(results) </a>
  303.     
  304.  
  305.     
  306.   </span>
  307.   
  308.   
  309.   
  310.   
  311.   
  312.   
  313.   
  314.  
  315.   
  316.     <span class="summary_desc"><div class='inline'></div></span>
  317.   
  318. </li>
  319.  
  320.       
  321.         <li class="public ">
  322.   <span class="summary_signature">
  323.     
  324.       <a href="#normalize_dirs-instance_method" title="#normalize_dirs (instance method)">- (Object) <strong>normalize_dirs</strong>(results) </a>
  325.     
  326.  
  327.     
  328.   </span>
  329.   
  330.   
  331.   
  332.   
  333.   
  334.   
  335.   
  336.  
  337.   
  338.     <span class="summary_desc"><div class='inline'></div></span>
  339.   
  340. </li>
  341.  
  342.       
  343.         <li class="public ">
  344.   <span class="summary_signature">
  345.     
  346.       <a href="#normalize_files-instance_method" title="#normalize_files (instance method)">- (Object) <strong>normalize_files</strong>(results) </a>
  347.     
  348.  
  349.     
  350.   </span>
  351.   
  352.   
  353.   
  354.   
  355.   
  356.   
  357.   
  358.  
  359.   
  360.     <span class="summary_desc"><div class='inline'></div></span>
  361.   
  362. </li>
  363.  
  364.       
  365.         <li class="public ">
  366.   <span class="summary_signature">
  367.     
  368.       <a href="#offset-instance_method" title="#offset (instance method)">- (Object) <strong>offset</strong> </a>
  369.     
  370.  
  371.     
  372.   </span>
  373.   
  374.   
  375.   
  376.   
  377.   
  378.   
  379.   
  380.  
  381.   
  382.     <span class="summary_desc"><div class='inline'></div></span>
  383.   
  384. </li>
  385.  
  386.       
  387.     </ul>
  388.   
  389.  
  390. <div id="constructor_details" class="method_details_list">
  391.   <h2>Constructor Details</h2>
  392.   
  393.     <div class="method_details first">
  394.   <h3 class="signature first" id="initialize-instance_method">
  395.   
  396.     - (<tt><span class='object_link'><a href="" title="HelixVersioningEngine::FileService (class)">FileService</a></span></tt>) <strong>initialize</strong>(p4: nil) 
  397.   
  398.  
  399.   
  400.  
  401.   
  402. </h3><div class="docstring">
  403.   <div class="discussion">
  404.     
  405. <p>Returns a new instance of FileService</p>
  406.  
  407.  
  408.   </div>
  409. </div>
  410. <div class="tags">
  411.   
  412.  
  413. </div><table class="source_code">
  414.   <tr>
  415.     <td>
  416.       <pre class="lines">
  417.  
  418.  
  419. 11
  420. 12
  421. 13</pre>
  422.     </td>
  423.     <td>
  424.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 11</span>
  425.  
  426. <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>p4:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  427.   <span class='ivar'>@p4</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span>
  428. <span class='kw'>end</span></pre>
  429.     </td>
  430.   </tr>
  431. </table>
  432. </div>
  433.   
  434. </div>
  435.  
  436.   <div id="instance_attr_details" class="attr_details">
  437.     <h2>Instance Attribute Details</h2>
  438.     
  439.       
  440.       <span id=""></span>
  441.       <div class="method_details first">
  442.   <h3 class="signature first" id="p4-instance_method">
  443.   
  444.     - (<tt>Object</tt>) <strong>p4</strong>  <span class="extras">(readonly)</span>
  445.   
  446.  
  447.   
  448.  
  449.   
  450. </h3><div class="docstring">
  451.   <div class="discussion">
  452.     
  453. <p>Returns the value of attribute p4</p>
  454.  
  455.  
  456.   </div>
  457. </div>
  458. <div class="tags">
  459.   
  460.  
  461. </div><table class="source_code">
  462.   <tr>
  463.     <td>
  464.       <pre class="lines">
  465.  
  466.  
  467. 9
  468. 10
  469. 11</pre>
  470.     </td>
  471.     <td>
  472.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 9</span>
  473.  
  474. <span class='kw'>def</span> <span class='id identifier rubyid_p4'>p4</span>
  475.   <span class='ivar'>@p4</span>
  476. <span class='kw'>end</span></pre>
  477.     </td>
  478.   </tr>
  479. </table>
  480. </div>
  481.     
  482.   </div>
  483.  
  484.  
  485.   <div id="instance_method_details" class="method_details_list">
  486.     <h2>Instance Method Details</h2>
  487.  
  488.     
  489.       <div class="method_details first">
  490.   <h3 class="signature first" id="fetch_offset-instance_method">
  491.   
  492.     - (<tt>Object</tt>) <strong>fetch_offset</strong> 
  493.   
  494.  
  495.   
  496.  
  497.   
  498. </h3><table class="source_code">
  499.   <tr>
  500.     <td>
  501.       <pre class="lines">
  502.  
  503.  
  504. 111
  505. 112
  506. 113
  507. 114</pre>
  508.     </td>
  509.     <td>
  510.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 111</span>
  511.  
  512. <span class='kw'>def</span> <span class='id identifier rubyid_fetch_offset'>fetch_offset</span>
  513.   <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_info'>run_info</span>
  514.   <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_p4_date_offset'>p4_date_offset</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>serverDate</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
  515. <span class='kw'>end</span></pre>
  516.     </td>
  517.   </tr>
  518. </table>
  519. </div>
  520.     
  521.       <div class="method_details ">
  522.   <h3 class="signature " id="list-instance_method">
  523.   
  524.     - (<tt>Object</tt>) <strong>list</strong>(dirs) 
  525.   
  526.  
  527.   
  528.  
  529.   
  530. </h3><table class="source_code">
  531.   <tr>
  532.     <td>
  533.       <pre class="lines">
  534.  
  535.  
  536. 15
  537. 16
  538. 17
  539. 18
  540. 19
  541. 20
  542. 21</pre>
  543.     </td>
  544.     <td>
  545.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 15</span>
  546.  
  547. <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='id identifier rubyid_dirs'>dirs</span><span class='rparen'>)</span>
  548.   <span class='kw'>if</span> <span class='id identifier rubyid_dirs'>dirs</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_dirs'>dirs</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
  549.     <span class='id identifier rubyid_list_depots'>list_depots</span>
  550.   <span class='kw'>else</span>
  551.     <span class='id identifier rubyid_list_dir'>list_dir</span><span class='lparen'>(</span><span class='id identifier rubyid_dirs'>dirs</span><span class='rparen'>)</span>
  552.   <span class='kw'>end</span>
  553. <span class='kw'>end</span></pre>
  554.     </td>
  555.   </tr>
  556. </table>
  557. </div>
  558.     
  559.       <div class="method_details ">
  560.   <h3 class="signature " id="list_depots-instance_method">
  561.   
  562.     - (<tt>Object</tt>) <strong>list_depots</strong> 
  563.   
  564.  
  565.   
  566.  
  567.   
  568. </h3><table class="source_code">
  569.   <tr>
  570.     <td>
  571.       <pre class="lines">
  572.  
  573.  
  574. 23
  575. 24
  576. 25
  577. 26
  578. 27</pre>
  579.     </td>
  580.     <td>
  581.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 23</span>
  582.  
  583. <span class='kw'>def</span> <span class='id identifier rubyid_list_depots'>list_depots</span>
  584.   <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_depots'>run_depots</span>
  585.   <span class='id identifier rubyid_normalize_depots'>normalize_depots</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  586.   <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span> <span class='const'>HelixWebServicesClient</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Depot</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  587. <span class='kw'>end</span></pre>
  588.     </td>
  589.   </tr>
  590. </table>
  591. </div>
  592.     
  593.       <div class="method_details ">
  594.   <h3 class="signature " id="list_dir-instance_method">
  595.   
  596.     - (<tt>Object</tt>) <strong>list_dir</strong>(dirs) 
  597.   
  598.  
  599.   
  600.  
  601.   
  602. </h3><table class="source_code">
  603.   <tr>
  604.     <td>
  605.       <pre class="lines">
  606.  
  607.  
  608. 47
  609. 48
  610. 49
  611. 50
  612. 51
  613. 52
  614. 53
  615. 54
  616. 55
  617. 56
  618. 57
  619. 58
  620. 59
  621. 60
  622. 61
  623. 62
  624. 63
  625. 64
  626. 65
  627. 66
  628. 67
  629. 68
  630. 69
  631. 70
  632. 71
  633. 72
  634. 73
  635. 74
  636. 75
  637. 76
  638. 77
  639. 78
  640. 79
  641. 80
  642. 81
  643. 82
  644. 83
  645. 84
  646. 85
  647. 86
  648. 87
  649. 88
  650. 89
  651. 90</pre>
  652.     </td>
  653.     <td>
  654.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 47</span>
  655.  
  656. <span class='kw'>def</span> <span class='id identifier rubyid_list_dir'>list_dir</span><span class='lparen'>(</span><span class='id identifier rubyid_dirs'>dirs</span><span class='rparen'>)</span>
  657.   <span class='id identifier rubyid_file_selector'>file_selector</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>//</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='id identifier rubyid_dirs'>dirs</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  658.   <span class='id identifier rubyid_files_results'>files_results</span> <span class='op'>=</span> <span class='kw'>nil</span>
  659.   <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_at_exception_level'>at_exception_level</span><span class='lparen'>(</span><span class='const'>P4</span><span class='op'>::</span><span class='const'>RAISE_NONE</span><span class='rparen'>)</span> <span class='kw'>do</span>
  660.     <span class='id identifier rubyid_files_results'>files_results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_files'>run_files</span><span class='lparen'>(</span><span class='id identifier rubyid_file_selector'>file_selector</span><span class='rparen'>)</span>
  661.   <span class='kw'>end</span>
  662.   <span class='id identifier rubyid_files_results'>files_results</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id identifier rubyid_files_results'>files_results</span>
  663.  
  664.   <span class='id identifier rubyid_return_val'>return_val</span> <span class='op'>=</span> <span class='kw'>nil</span>
  665.  
  666.   <span class='kw'>if</span> <span class='id identifier rubyid_files_results'>files_results</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>==</span> <span class='int'>1</span> <span class='op'>&amp;&amp;</span>
  667.       <span class='id identifier rubyid_files_results'>files_results</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>depotFile</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span>
  668.       <span class='id identifier rubyid_files_results'>files_results</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>depotFile</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_file_selector'>file_selector</span>
  669.     <span class='comment'># Treat request like a single file GET
  670. </span>    <span class='id identifier rubyid_normalize_files'>normalize_files</span><span class='lparen'>(</span><span class='id identifier rubyid_files_results'>files_results</span><span class='rparen'>)</span>
  671.     <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_files_results'>files_results</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
  672.  
  673.     <span class='id identifier rubyid_print_results'>print_results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_print'>run_print</span><span class='lparen'>(</span><span class='id identifier rubyid_file_selector'>file_selector</span><span class='rparen'>)</span>
  674.  
  675.     <span class='id identifier rubyid_results'>results</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Base64</span><span class='period'>.</span><span class='id identifier rubyid_encode64'>encode64</span><span class='lparen'>(</span><span class='id identifier rubyid_print_results'>print_results</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
  676.  
  677.     <span class='id identifier rubyid_return_val'>return_val</span> <span class='op'>=</span> <span class='const'>HelixWebServicesClient</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  678.   <span class='kw'>else</span>
  679.  
  680.     <span class='comment'># Treat request like a directory list
  681. </span>    <span class='id identifier rubyid_selector'>selector</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>//</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='id identifier rubyid_dirs'>dirs</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/*</span><span class='tstring_end'>&#39;</span></span>
  682.  
  683.     <span class='id identifier rubyid_files_results'>files_results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_files'>run_files</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-e</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_selector'>selector</span><span class='rparen'>)</span>
  684.     <span class='id identifier rubyid_normalize_files'>normalize_files</span><span class='lparen'>(</span><span class='id identifier rubyid_files_results'>files_results</span><span class='rparen'>)</span>
  685.  
  686.     <span class='id identifier rubyid_items'>items</span> <span class='op'>=</span> <span class='id identifier rubyid_files_results'>files_results</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span> <span class='const'>HelixWebServicesClient</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_f'>f</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  687.  
  688.     <span class='id identifier rubyid_dirs_results'>dirs_results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_dirs'>run_dirs</span><span class='lparen'>(</span><span class='id identifier rubyid_selector'>selector</span><span class='rparen'>)</span>
  689.     <span class='id identifier rubyid_normalize_dirs'>normalize_dirs</span><span class='lparen'>(</span><span class='id identifier rubyid_dirs_results'>dirs_results</span><span class='rparen'>)</span>
  690.  
  691.     <span class='id identifier rubyid_dirs'>dirs</span> <span class='op'>=</span> <span class='id identifier rubyid_dirs_results'>dirs_results</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='const'>HelixWebServicesClient</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  692.  
  693.     <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='id identifier rubyid_dirs'>dirs</span><span class='rparen'>)</span>
  694.  
  695.     <span class='id identifier rubyid_return_val'>return_val</span> <span class='op'>=</span> <span class='id identifier rubyid_items'>items</span>
  696.   <span class='kw'>end</span>
  697.  
  698.   <span class='id identifier rubyid_return_val'>return_val</span>
  699. <span class='kw'>end</span></pre>
  700.     </td>
  701.   </tr>
  702. </table>
  703. </div>
  704.     
  705.       <div class="method_details ">
  706.   <h3 class="signature " id="list_file-instance_method">
  707.   
  708.     - (<tt>Object</tt>) <strong>list_file</strong>(file_path) 
  709.   
  710.  
  711.   
  712.  
  713.   
  714. </h3><table class="source_code">
  715.   <tr>
  716.     <td>
  717.       <pre class="lines">
  718.  
  719.  
  720. 29
  721. 30
  722. 31
  723. 32
  724. 33
  725. 34
  726. 35
  727. 36
  728. 37
  729. 38
  730. 39
  731. 40
  732. 41
  733. 42
  734. 43
  735. 44
  736. 45</pre>
  737.     </td>
  738.     <td>
  739.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 29</span>
  740.  
  741. <span class='kw'>def</span> <span class='id identifier rubyid_list_file'>list_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='rparen'>)</span>
  742.   <span class='id identifier rubyid_files_results'>files_results</span> <span class='op'>=</span> <span class='kw'>nil</span>
  743.   <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_at_exception_level'>at_exception_level</span><span class='lparen'>(</span><span class='const'>P4</span><span class='op'>::</span><span class='const'>RAISE_NONE</span><span class='rparen'>)</span> <span class='kw'>do</span>
  744.     <span class='id identifier rubyid_files_results'>files_results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_files'>run_files</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='rparen'>)</span>
  745.   <span class='kw'>end</span>
  746.  
  747.   <span class='id identifier rubyid_normalize_files'>normalize_files</span><span class='lparen'>(</span><span class='id identifier rubyid_files_results'>files_results</span><span class='rparen'>)</span>
  748.   <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_files_results'>files_results</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
  749.  
  750.   <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='id identifier rubyid_results'>results</span>
  751.  
  752.   <span class='id identifier rubyid_print_results'>print_results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_print'>run_print</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='rparen'>)</span>
  753.  
  754.   <span class='id identifier rubyid_results'>results</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Base64</span><span class='period'>.</span><span class='id identifier rubyid_encode64'>encode64</span><span class='lparen'>(</span><span class='id identifier rubyid_print_results'>print_results</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
  755.  
  756.   <span class='const'>HelixWebServicesClient</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  757. <span class='kw'>end</span></pre>
  758.     </td>
  759.   </tr>
  760. </table>
  761. </div>
  762.     
  763.       <div class="method_details ">
  764.   <h3 class="signature " id="normalize_depots-instance_method">
  765.   
  766.     - (<tt>Object</tt>) <strong>normalize_depots</strong>(results) 
  767.   
  768.  
  769.   
  770.  
  771.   
  772. </h3><table class="source_code">
  773.   <tr>
  774.     <td>
  775.       <pre class="lines">
  776.  
  777.  
  778. 92
  779. 93
  780. 94
  781. 95</pre>
  782.     </td>
  783.     <td>
  784.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 92</span>
  785.  
  786. <span class='kw'>def</span> <span class='id identifier rubyid_normalize_depots'>normalize_depots</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  787.   <span class='ivar'>@normalize_depots</span> <span class='op'>||=</span> <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_normalizer'>normalizer</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>depots</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='rparen'>)</span>
  788.   <span class='ivar'>@normalize_depots</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  789. <span class='kw'>end</span></pre>
  790.     </td>
  791.   </tr>
  792. </table>
  793. </div>
  794.     
  795.       <div class="method_details ">
  796.   <h3 class="signature " id="normalize_dirs-instance_method">
  797.   
  798.     - (<tt>Object</tt>) <strong>normalize_dirs</strong>(results) 
  799.   
  800.  
  801.   
  802.  
  803.   
  804. </h3><table class="source_code">
  805.   <tr>
  806.     <td>
  807.       <pre class="lines">
  808.  
  809.  
  810. 102
  811. 103
  812. 104
  813. 105</pre>
  814.     </td>
  815.     <td>
  816.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 102</span>
  817.  
  818. <span class='kw'>def</span> <span class='id identifier rubyid_normalize_dirs'>normalize_dirs</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  819.   <span class='ivar'>@normalize_dirs</span> <span class='op'>||=</span> <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_normalizer'>normalizer</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dirs</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='rparen'>)</span>
  820.   <span class='ivar'>@normalize_dirs</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  821. <span class='kw'>end</span></pre>
  822.     </td>
  823.   </tr>
  824. </table>
  825. </div>
  826.     
  827.       <div class="method_details ">
  828.   <h3 class="signature " id="normalize_files-instance_method">
  829.   
  830.     - (<tt>Object</tt>) <strong>normalize_files</strong>(results) 
  831.   
  832.  
  833.   
  834.  
  835.   
  836. </h3><table class="source_code">
  837.   <tr>
  838.     <td>
  839.       <pre class="lines">
  840.  
  841.  
  842. 97
  843. 98
  844. 99
  845. 100</pre>
  846.     </td>
  847.     <td>
  848.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 97</span>
  849.  
  850. <span class='kw'>def</span> <span class='id identifier rubyid_normalize_files'>normalize_files</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  851.   <span class='ivar'>@normalize_files</span> <span class='op'>||=</span> <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_normalizer'>normalizer</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>files</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='rparen'>)</span>
  852.   <span class='ivar'>@normalize_files</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  853. <span class='kw'>end</span></pre>
  854.     </td>
  855.   </tr>
  856. </table>
  857. </div>
  858.     
  859.       <div class="method_details ">
  860.   <h3 class="signature " id="offset-instance_method">
  861.   
  862.     - (<tt>Object</tt>) <strong>offset</strong> 
  863.   
  864.  
  865.   
  866.  
  867.   
  868. </h3><table class="source_code">
  869.   <tr>
  870.     <td>
  871.       <pre class="lines">
  872.  
  873.  
  874. 107
  875. 108
  876. 109</pre>
  877.     </td>
  878.     <td>
  879.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/file_service.rb', line 107</span>
  880.  
  881. <span class='kw'>def</span> <span class='id identifier rubyid_offset'>offset</span>
  882.   <span class='ivar'>@offset</span> <span class='op'>||=</span> <span class='id identifier rubyid_fetch_offset'>fetch_offset</span>
  883. <span class='kw'>end</span></pre>
  884.     </td>
  885.   </tr>
  886. </table>
  887. </div>
  888.     
  889.   </div>
  890.  
  891. </div>
  892.  
  893.     <div id="footer">
  894.   Generated on Mon Oct 12 22:20:53 2015 by
  895.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  896.   0.8.7.6 (ruby-2.2.3).
  897. </div>
  898.  
  899.   </body>
  900. </html>
# Change User Description Committed
#11 16275 Doug Scheirer Merge from main 10 years ago
#10 16196 Doug Scheirer Merge from main 10 years ago
#9 16148 Doug Scheirer Merge from main 10 years ago
#8 16114 Doug Scheirer Merge from main 10 years ago
#7 16079 Doug Scheirer Merge from main 10 years ago
#6 16014 Doug Scheirer Merge down from main 10 years ago
#5 15884 Doug Scheirer Merge from main 10 years ago
#4 15868 Doug Scheirer Merge from main 10 years ago
#3 15845 Doug Scheirer Integ from main 10 years ago
#2 15715 Doug Scheirer merge changes from main 10 years ago
#1 15688 Doug Scheirer Populate -o //guest/perforce_software/helix-web-services/...
//guest/doug_scheirer/helix-...web-services/.... «		 10 years ago
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services/HelixVersioningEngine/FileService.html
#32 15676 tjuricek HWS/NOARCH/2015.1.main/201509092205 10 years ago
#31 15589 tjuricek Update path to test output and update docs. 10 years ago
#30 15542 tjuricek Add spaces to our basic 'component encode' mechanism, and use it for HVE project IDs.

I...n general, this will make the HVE IDs a bit more readable. «		 10 years ago
#29 15517 tjuricek Do not require changelist ID for submitting Helix Sync pending changelists. 10 years ago
#28 15499 tjuricek Naive implementation of helix sync project submit for "helix versioning engine projects". 10 years ago
#27 15487 tjuricek Add basic ability to create pending changelists for helix sync projects. 10 years ago
#26 15479 tjuricek Added a basic "HVE project" implementation for creating clients. 10 years ago
#25 15447 tjuricek Add simple Example application to list "projects" in a HVE instance.

Qt's a little weir...d to follow, so I may have to find a different kind of example to write. It does work, however. «		 10 years ago
#24 15240 tjuricek Set api level via request path on all Helix Versioning Engine methods.

This will allow... migration of applications to different P4D versions. Our internal methods (like project API) should attempt to handle backward compatibility similarly.

P4WEBAPI-118 «		 10 years ago
#23 15228 tjuricek Revise triggers implementation, tests, and documentation. 10 years ago
#22 15227 tjuricek Revise implementation, tests, and documentation for protections management.

Remove some... specs I will not be revising from the helix_web_services project. «		 10 years ago
#21 15225 tjuricek Revise counter implementation, tests, and documentation

Wasn't available in the Ruby cl...ient before, so, it's now available. «		 10 years ago
#20 15222 tjuricek Revise server specs testing and documentation.

Note: also fixed issues with setting P4P...ORT via headers. For whatever reason, the host setting doesn't seem to work like I expect it to, though P4PORT works just fine. «		 10 years ago
#19 15211 tjuricek Implement tests and documentation for label spec management. 10 years ago
#18 15210 tjuricek Implement tests and documentation for job spec management. 10 years ago
#17 15209 tjuricek Implement tests and documentation for group spec management. 10 years ago
#16 15208 tjuricek Revise 'command' implementation, tests, and documentaiton.

This includes a change from... a command blacklist to a whitelist. See P4WEBAPI-21 «		 10 years ago
#15 15205 tjuricek Implemented tests and documentation for depot spec editing. 10 years ago
#14 15189 tjuricek Update files implementation, testing, and documentation. 10 years ago
#13 15185 tjuricek Update user spec management implementation, tests, and documentation. 10 years ago
#12 15144 tjuricek Setup stream spec tests and documentation.

Also revised the documentation folder http_p...4_web_api -> helix_versioning_engine «		 10 years ago
#11 15132 tjuricek Provde a basic submit -e mechanism on classic perforce workspaces. 10 years ago
#10 15110 tjuricek Revise changes methods for new p4 connection handling, add server specs, remove model refe...rences in client, and update asciidoc documentation. « 10 years ago
#9 15099 tjuricek Revise project services to be our simple 'container' for other systems. 10 years ago
#8 15098 tjuricek Revised project services to GET-only forms.

With Helix Sync revising to integrate purel...y with Helix Cloud, this is the only thing we can reasonably define. «		 10 years ago
#7 15090 tjuricek Update _proposed_ API for project services.

This is *very likely* to change, and will n...ot be implemented until reviewed. «		 10 years ago
#6 15078 tjuricek clients spec method revisions

Updated some other documentation. 		10 years ago
#5 15077 tjuricek Add new 'model' technique, revised branch spec operations, test Auth::Middleware.

The R...uby client now does *not* strictly type anything, but extends OpenStruct with helper methods to help deal with inconsistent data formats.
See the OpenModel class documentation for more details.

The Auth::Middleware class is also *finally* implemented as well. This does not take into account all possible variations of server behavior (yet), but that will happen in follow-up work. «		 10 years ago
#4 15073 tjuricek Update Auth::Middleware and add spec 10 years ago
#3 15053 tjuricek Revise the client API to use the new login method.

The current specs will need to be re...vised since data normalization is moving out of the server and into the client. «		 10 years ago
#2 15038 tjuricek Document 'login' auth method and client programming overview. 10 years ago
#1 15032 tjuricek Starting config and doc revisions.
System is now broken while revisions underway.

Conf...iguration of the p4d connection is now done via a single HWSSettings middleware object injected into the Rack env.

The HWSP4Cleanup middleware now cleans up any p4 injected into the Rack env.

The Auth::App class now mostly just contains one method to generate a p4 ticket. /auth/v1/login.

Added yard documentation for the main project.

Yard docs have been reconfigured to dump into build/ directories. This should probably be done with each release. Hm...

The top level rake file contains a task, 'all:doc', to update our documentation. This should probably be run for each checkin. Hm...

Specs are now using Rack::Test on top of a 'live' p4d. I'd suggest you still use the p4util mechanism, which now dumps to a /tmp folder, so we can safely add P4IGNORE rules back into your local .p4config file.

Old 'perforce' application now called 'helix_versioning_engine'.

Removing cache data. Helix Sync may be slow. It may also get axed. We'll see. «		 10 years ago