Helix SwarmHelix Swarm

HWSHelpers.html

  • //
  • guest/
  • doug_scheirer/
  • helix-web-services/
  • main/
  • build/
  • doc/
  • helix_web_services/
  • HWSHelpers.html #11
  • View
  • Commits
  • Open Download .zip Download (10 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: HWSHelpers
  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#!HWSHelpers.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 (H)</a> &raquo;
  35.     
  36.     
  37.     <span class="title">HWSHelpers</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: HWSHelpers
  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/hws_helpers.rb</dd>
  83.   
  84. </dl>
  85. <div class="clear"></div>
  86.  
  87. <h2>Overview</h2><div class="docstring">
  88.   <div class="discussion">
  89.     
  90. <p>These are helper methods that should be common to most modular
  91. &#39;Apps&#39; in Helix Web Services.</p>
  92.  
  93.  
  94.   </div>
  95. </div>
  96. <div class="tags">
  97.   
  98.  
  99. </div>
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.   
  107.     <h2>
  108.       Instance Method Summary
  109.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  110.     </h2>
  111.  
  112.     <ul class="summary">
  113.       
  114.         <li class="public ">
  115.   <span class="summary_signature">
  116.     
  117.       <a href="#p4-instance_method" title="#p4 (instance method)">- (Object) <strong>p4</strong> </a>
  118.     
  119.  
  120.     
  121.   </span>
  122.   
  123.   
  124.   
  125.   
  126.   
  127.   
  128.   
  129.  
  130.   
  131.     <span class="summary_desc"><div class='inline'></div></span>
  132.   
  133. </li>
  134.  
  135.       
  136.         <li class="public ">
  137.   <span class="summary_signature">
  138.     
  139.       <a href="#require_p4-instance_method" title="#require_p4 (instance method)">- (Object) <strong>require_p4</strong> </a>
  140.     
  141.  
  142.     
  143.   </span>
  144.   
  145.   
  146.   
  147.   
  148.   
  149.   
  150.   
  151.  
  152.   
  153.     <span class="summary_desc"><div class='inline'>
  154. <p>This will ensure that the environment contains a p4 handle that is
  155. configured using our typical <code>hws_settings</code> options.</p>
  156. </div></span>
  157.   
  158. </li>
  159.  
  160.       
  161.         <li class="public ">
  162.   <span class="summary_signature">
  163.     
  164.       <a href="#require_p4_with_temp_client-instance_method" title="#require_p4_with_temp_client (instance method)">- (Object) <strong>require_p4_with_temp_client</strong> </a>
  165.     
  166.  
  167.     
  168.   </span>
  169.   
  170.   
  171.   
  172.   
  173.   
  174.   
  175.   
  176.  
  177.   
  178.     <span class="summary_desc"><div class='inline'>
  179. <p>This ensures that the <code>p4</code> handle has an associated temporary
  180. client workspace.</p>
  181. </div></span>
  182.   
  183. </li>
  184.  
  185.       
  186.         <li class="public ">
  187.   <span class="summary_signature">
  188.     
  189.       <a href="#user-instance_method" title="#user (instance method)">- (Object) <strong>user</strong> </a>
  190.     
  191.  
  192.     
  193.   </span>
  194.   
  195.   
  196.   
  197.   
  198.   
  199.   
  200.   
  201.  
  202.   
  203.     <span class="summary_desc"><div class='inline'></div></span>
  204.   
  205. </li>
  206.  
  207.       
  208.     </ul>
  209.   
  210.  
  211.  
  212.  
  213.   <div id="instance_method_details" class="method_details_list">
  214.     <h2>Instance Method Details</h2>
  215.  
  216.     
  217.       <div class="method_details first">
  218.   <h3 class="signature first" id="p4-instance_method">
  219.   
  220.     - (<tt>Object</tt>) <strong>p4</strong> 
  221.   
  222.  
  223.   
  224.  
  225.   
  226. </h3><table class="source_code">
  227.   <tr>
  228.     <td>
  229.       <pre class="lines">
  230.  
  231.  
  232. 33
  233. 34
  234. 35</pre>
  235.     </td>
  236.     <td>
  237.       <pre class="code"><span class="info file"># File 'lib/hws_helpers.rb', line 33</span>
  238.  
  239. <span class='kw'>def</span> <span class='id identifier rubyid_p4'>p4</span>
  240.   <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='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>require_p4 not called</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  241. <span class='kw'>end</span></pre>
  242.     </td>
  243.   </tr>
  244. </table>
  245. </div>
  246.     
  247.       <div class="method_details ">
  248.   <h3 class="signature " id="require_p4-instance_method">
  249.   
  250.     - (<tt>Object</tt>) <strong>require_p4</strong> 
  251.   
  252.  
  253.   
  254.  
  255.   
  256. </h3><div class="docstring">
  257.   <div class="discussion">
  258.     
  259. <p>This will ensure that the environment contains a p4 handle that is
  260. configured using our typical <code>hws_settings</code> options.</p>
  261.  
  262. <p>It should be rare to actually require using this method. This is typically
  263. generated by authentication middleware.</p>
  264.  
  265. <p>The p4 is possibly <em>not</em> connected or logged in.</p>
  266.  
  267.  
  268.   </div>
  269. </div>
  270. <div class="tags">
  271.   
  272.  
  273. </div><table class="source_code">
  274.   <tr>
  275.     <td>
  276.       <pre class="lines">
  277.  
  278.  
  279. 16
  280. 17
  281. 18
  282. 19
  283. 20
  284. 21
  285. 22</pre>
  286.     </td>
  287.     <td>
  288.       <pre class="code"><span class="info file"># File 'lib/hws_helpers.rb', line 16</span>
  289.  
  290. <span class='kw'>def</span> <span class='id identifier rubyid_require_p4'>require_p4</span>
  291.   <span class='kw'>unless</span> <span class='op'>!</span><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='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
  292.     <span class='id identifier rubyid_p4'>p4</span> <span class='op'>=</span> <span class='const'>P4Util</span><span class='period'>.</span><span class='id identifier rubyid_open_from_env'>open_from_env</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
  293.     <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span>
  294.     <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='id identifier rubyid_p4'>p4</span>
  295.   <span class='kw'>end</span>
  296. <span class='kw'>end</span></pre>
  297.     </td>
  298.   </tr>
  299. </table>
  300. </div>
  301.     
  302.       <div class="method_details ">
  303.   <h3 class="signature " id="require_p4_with_temp_client-instance_method">
  304.   
  305.     - (<tt>Object</tt>) <strong>require_p4_with_temp_client</strong> 
  306.   
  307.  
  308.   
  309.  
  310.   
  311. </h3><div class="docstring">
  312.   <div class="discussion">
  313.     
  314. <p>This ensures that the <code>p4</code> handle has an associated temporary
  315. client workspace.</p>
  316.  
  317. <p>The local temporary directory is saved under &#39;p4_root&#39;.</p>
  318.  
  319.  
  320.   </div>
  321. </div>
  322. <div class="tags">
  323.   
  324.  
  325. </div><table class="source_code">
  326.   <tr>
  327.     <td>
  328.       <pre class="lines">
  329.  
  330.  
  331. 28
  332. 29
  333. 30
  334. 31</pre>
  335.     </td>
  336.     <td>
  337.       <pre class="code"><span class="info file"># File 'lib/hws_helpers.rb', line 28</span>
  338.  
  339. <span class='kw'>def</span> <span class='id identifier rubyid_require_p4_with_temp_client'>require_p4_with_temp_client</span>
  340.   <span class='id identifier rubyid_require_p4'>require_p4</span>
  341.   <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_root</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>P4Util</span><span class='period'>.</span><span class='id identifier rubyid_create_temp_client'>create_temp_client</span><span class='lparen'>(</span><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='rparen'>)</span>
  342. <span class='kw'>end</span></pre>
  343.     </td>
  344.   </tr>
  345. </table>
  346. </div>
  347.     
  348.       <div class="method_details ">
  349.   <h3 class="signature " id="user-instance_method">
  350.   
  351.     - (<tt>Object</tt>) <strong>user</strong> 
  352.   
  353.  
  354.   
  355.  
  356.   
  357. </h3><table class="source_code">
  358.   <tr>
  359.     <td>
  360.       <pre class="lines">
  361.  
  362.  
  363. 37
  364. 38
  365. 39</pre>
  366.     </td>
  367.     <td>
  368.       <pre class="code"><span class="info file"># File 'lib/hws_helpers.rb', line 37</span>
  369.  
  370. <span class='kw'>def</span> <span class='id identifier rubyid_user'>user</span>
  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='period'>.</span><span class='id identifier rubyid_first'>first</span>
  372. <span class='kw'>end</span></pre>
  373.     </td>
  374.   </tr>
  375. </table>
  376. </div>
  377.     
  378.   </div>
  379.  
  380. </div>
  381.  
  382.     <div id="footer">
  383.   Generated on Mon Oct 12 22:20:49 2015 by
  384.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  385.   0.8.7.6 (ruby-2.2.3).
  386. </div>
  387.  
  388.   </body>
  389. </html>
# Change User Description Committed
#11 16275 Doug Scheirer Merge from main 9 years ago
#10 16196 Doug Scheirer Merge from main 9 years ago
#9 16148 Doug Scheirer Merge from main 9 years ago
#8 16114 Doug Scheirer Merge from main 9 years ago
#7 16079 Doug Scheirer Merge from main 9 years ago
#6 16014 Doug Scheirer Merge down from main 9 years ago
#5 15884 Doug Scheirer Merge from main 9 years ago
#4 15868 Doug Scheirer Merge from main 9 years ago
#3 15845 Doug Scheirer Integ from main 9 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/HWSHelpers.html
#31 15676 tjuricek HWS/NOARCH/2015.1.main/201509092205 10 years ago
#30 15589 tjuricek Update path to test output and update docs. 10 years ago
#29 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
#28 15517 tjuricek Do not require changelist ID for submitting Helix Sync pending changelists. 10 years ago
#27 15499 tjuricek Naive implementation of helix sync project submit for "helix versioning engine projects". 10 years ago
#26 15487 tjuricek Add basic ability to create pending changelists for helix sync projects. 10 years ago
#25 15479 tjuricek Added a basic "HVE project" implementation for creating clients. 10 years ago
#24 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
#23 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
#22 15228 tjuricek Revise triggers implementation, tests, and documentation. 10 years ago
#21 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
#20 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
#19 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
#18 15211 tjuricek Implement tests and documentation for label spec management. 10 years ago
#17 15210 tjuricek Implement tests and documentation for job spec management. 10 years ago
#16 15209 tjuricek Implement tests and documentation for group spec management. 10 years ago
#15 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
#14 15205 tjuricek Implemented tests and documentation for depot spec editing. 10 years ago
#13 15189 tjuricek Update files implementation, testing, and documentation. 10 years ago
#12 15185 tjuricek Update user spec management implementation, tests, and documentation. 10 years ago
#11 15144 tjuricek Setup stream spec tests and documentation.

Also revised the documentation folder http_p...4_web_api -> helix_versioning_engine «		 10 years ago
#10 15132 tjuricek Provde a basic submit -e mechanism on classic perforce workspaces. 10 years ago
#9 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
#8 15099 tjuricek Revise project services to be our simple 'container' for other systems. 10 years ago
#7 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
#6 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
#5 15078 tjuricek clients spec method revisions

Updated some other documentation. 		10 years ago
#4 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
#3 15073 tjuricek Update Auth::Middleware and add spec 10 years ago
#2 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
#1 15038 tjuricek Document 'login' auth method and client programming overview. 10 years ago