<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: HWSHelpers
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!HWSHelpers.html";
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index (H)</a> »
<span class="title">HWSHelpers</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: HWSHelpers
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/hws_helpers.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>These are helper methods that should be common to most modular
'Apps' in Helix Web Services.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#p4-instance_method" title="#p4 (instance method)">- (Object) <strong>p4</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#require_p4-instance_method" title="#require_p4 (instance method)">- (Object) <strong>require_p4</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This will ensure that the environment contains a p4 handle that is
configured using our typical <code>hws_settings</code> options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<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>
</span>
<span class="summary_desc"><div class='inline'>
<p>This ensures that the <code>p4</code> handle has an associated temporary
client workspace.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user-instance_method" title="#user (instance method)">- (Object) <strong>user</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="p4-instance_method">
- (<tt>Object</tt>) <strong>p4</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hws_helpers.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_p4'>p4</span>
<span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>p4</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>require_p4 not called</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="require_p4-instance_method">
- (<tt>Object</tt>) <strong>require_p4</strong>
</h3><div class="docstring">
<div class="discussion">
<p>This will ensure that the environment contains a p4 handle that is
configured using our typical <code>hws_settings</code> options.</p>
<p>It should be rare to actually require using this method. This is typically
generated by authentication middleware.</p>
<p>The p4 is possibly <em>not</em> connected or logged in.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18
19
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hws_helpers.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_require_p4'>require_p4</span>
<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'>'</span><span class='tstring_content'>p4</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<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>
<span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span>
<span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>p4</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="require_p4_with_temp_client-instance_method">
- (<tt>Object</tt>) <strong>require_p4_with_temp_client</strong>
</h3><div class="docstring">
<div class="discussion">
<p>This ensures that the <code>p4</code> handle has an associated temporary
client workspace.</p>
<p>The local temporary directory is saved under 'p4_root'.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hws_helpers.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_require_p4_with_temp_client'>require_p4_with_temp_client</span>
<span class='id identifier rubyid_require_p4'>require_p4</span>
<span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>p4_root</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>p4</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="user-instance_method">
- (<tt>Object</tt>) <strong>user</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hws_helpers.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_user'>user</span>
<span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>AUTH_CREDENTIALS</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Oct 12 22:20:49 2015 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.3).
</div>
</body>
</html> | # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #11 | 16275 | Doug Scheirer | Merge from main | ||
| #10 | 16196 | Doug Scheirer | Merge from main | ||
| #9 | 16148 | Doug Scheirer | Merge from main | ||
| #8 | 16114 | Doug Scheirer | Merge from main | ||
| #7 | 16079 | Doug Scheirer | Merge from main | ||
| #6 | 16014 | Doug Scheirer | Merge down from main | ||
| #5 | 15884 | Doug Scheirer | Merge from main | ||
| #4 | 15868 | Doug Scheirer | Merge from main | ||
| #3 | 15845 | Doug Scheirer | Integ from main | ||
| #2 | 15715 | Doug Scheirer | merge changes from main | ||
| #1 | 15688 | Doug Scheirer |
Populate -o //guest/perforce_software/helix-web-services/... //guest/doug_scheirer/helix-web-services/.... |
||
| //guest/perforce_software/helix-web-services/main/build/doc/helix_web_services/HWSHelpers.html | |||||
| #31 | 15676 | tjuricek | HWS/NOARCH/2015.1.main/201509092205 | ||
| #30 | 15589 | tjuricek | Update path to test output and update docs. | ||
| #29 | 15542 | tjuricek |
Add spaces to our basic 'component encode' mechanism, and use it for HVE project IDs. In general, this will make the HVE IDs a bit more readable. |
||
| #28 | 15517 | tjuricek | Do not require changelist ID for submitting Helix Sync pending changelists. | ||
| #27 | 15499 | tjuricek | Naive implementation of helix sync project submit for "helix versioning engine projects". | ||
| #26 | 15487 | tjuricek | Add basic ability to create pending changelists for helix sync projects. | ||
| #25 | 15479 | tjuricek | Added a basic "HVE project" implementation for creating clients. | ||
| #24 | 15447 | tjuricek |
Add simple Example application to list "projects" in a HVE instance. Qt's a little weird to follow, so I may have to find a different kind of example to write. It does work, however. |
||
| #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 |
||
| #22 | 15228 | tjuricek | Revise triggers implementation, tests, and documentation. | ||
| #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. |
||
| #20 | 15225 | tjuricek |
Revise counter implementation, tests, and documentation Wasn't available in the Ruby client before, so, it's now available. |
||
| #19 | 15222 | tjuricek |
Revise server specs testing and documentation. Note: also fixed issues with setting P4PORT via headers. For whatever reason, the host setting doesn't seem to work like I expect it to, though P4PORT works just fine. |
||
| #18 | 15211 | tjuricek | Implement tests and documentation for label spec management. | ||
| #17 | 15210 | tjuricek | Implement tests and documentation for job spec management. | ||
| #16 | 15209 | tjuricek | Implement tests and documentation for group spec management. | ||
| #15 | 15208 | tjuricek |
Revise 'command' implementation, tests, and documentaiton. This includes a change from a command blacklist to a whitelist. See P4WEBAPI-21 |
||
| #14 | 15205 | tjuricek | Implemented tests and documentation for depot spec editing. | ||
| #13 | 15189 | tjuricek | Update files implementation, testing, and documentation. | ||
| #12 | 15185 | tjuricek | Update user spec management implementation, tests, and documentation. | ||
| #11 | 15144 | tjuricek |
Setup stream spec tests and documentation. Also revised the documentation folder http_p4_web_api -> helix_versioning_engine |
||
| #10 | 15132 | tjuricek | Provde a basic submit -e mechanism on classic perforce workspaces. | ||
| #9 | 15110 | tjuricek | Revise changes methods for new p4 connection handling, add server specs, remove model references in client, and update asciidoc documentation. | ||
| #8 | 15099 | tjuricek | Revise project services to be our simple 'container' for other systems. | ||
| #7 | 15098 | tjuricek |
Revised project services to GET-only forms. With Helix Sync revising to integrate purely with Helix Cloud, this is the only thing we can reasonably define. |
||
| #6 | 15090 | tjuricek |
Update _proposed_ API for project services. This is *very likely* to change, and will not be implemented until reviewed. |
||
| #5 | 15078 | tjuricek |
clients spec method revisions Updated some other documentation. |
||
| #4 | 15077 | tjuricek |
Add new 'model' technique, revised branch spec operations, test Auth::Middleware. The Ruby 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. |
||
| #3 | 15073 | tjuricek | Update Auth::Middleware and add spec | ||
| #2 | 15053 | tjuricek |
Revise the client API to use the new login method. The current specs will need to be revised since data normalization is moving out of the server and into the client. |
||
| #1 | 15038 | tjuricek | Document 'login' auth method and client programming overview. | ||