<!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> Class: HelixWebServicesClient::Models::Depot — 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#!HelixWebServicesClient/Models/Depot.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 (D)</a> » <span class='title'><span class='object_link'><a href="../../HelixWebServicesClient.html" title="HelixWebServicesClient (class)">HelixWebServicesClient</a></span></span> » <span class='title'><span class='object_link'><a href="../Models.html" title="HelixWebServicesClient::Models (module)">Models</a></span></span> » <span class="title">Depot</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>Class: HelixWebServicesClient::Models::Depot </h1> <dl class="box"> <dt class="r1">Inherits:</dt> <dd class="r1"> <span class="inheritName">Object</span> <ul class="fullTree"> <li>Object</li> <li class="next">HelixWebServicesClient::Models::Depot</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> <dt class="r2 last">Defined in:</dt> <dd class="r2 last">lib/helix_web_services_client/models/depot.rb</dd> </dl> <div class="clear"></div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Model that can be obtained via file browsing (the files command with no arguments) <em>or</em> via the list_depots command.</p> <p>This implements a few methods to assist in file browsing, since our underlying data is actually quite inconsistent. These methods are shared between Dir, and File:</p> <ul><li> <p>name - The name without any parent specifier</p> </li><li> <p>depot_path - The typical '//depot/dir1/file' style path specifier</p> </li><li> <p>browsable? - Can you list children of this path?</p> </li></ul> <p>For more details on the output fields, see <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_depot.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_depot.html</a></p> </div> </div> <div class="tags"> </div> <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#address-instance_method" title="#address (instance method)">- (Object) <strong>address</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>If type is :remote, this is likely the P4PORT address of the remote server.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#date-instance_method" title="#date (instance method)">- (Object) <strong>date</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>DateTime associated with the depot.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#depot-instance_method" title="#depot (instance method)">- (Object) <strong>depot</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The depot name.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#description-instance_method" title="#description (instance method)">- (Object) <strong>description</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Short description of the depot's purpose.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#map-instance_method" title="#map (instance method)">- (Object) <strong>map</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>If type is :local, :spec, or :archive, this points to the relative location of the depot subdirectory.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#owner-instance_method" title="#owner (instance method)">- (Object) <strong>owner</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The user who owns the depot.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#spec_map-instance_method" title="#spec_map (instance method)">- (Object) <strong>spec_map</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>When type is :spec, an optional description of what specs should be saved.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#suffix-instance_method" title="#suffix (instance method)">- (Object) <strong>suffix</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>If type is :spec, this holds an optional suffix for generated paths to objects in the spec depot.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#type-instance_method" title="#type (instance method)">- (Object) <strong>type</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>:local, :remote, :spec, :stream, :unload, or :archive.</p> </div></span> </li> </ul> <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="#browsable%3F-instance_method" title="#browsable? (instance method)">- (Boolean) <strong>browsable?</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>You should always be able to list files and dirs of a depot (I think), you just might not get any results.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#depot_path-instance_method" title="#depot_path (instance method)">- (Object) <strong>depot_path</strong> </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">- (Depot) <strong>initialize</strong>(obj = {}) </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'> <p>A new instance of Depot.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_internal_hash-instance_method" title="#to_internal_hash (instance method)">- (Object) <strong>to_internal_hash</strong> </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - (<tt><span class='object_link'><a href="" title="HelixWebServicesClient::Models::Depot (class)">Depot</a></span></tt>) <strong>initialize</strong>(obj = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Depot</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 51</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='ivar'>@depot</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Depot</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Depot</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@date</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Date</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_datetime'>to_datetime</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Date</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Type</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@address</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Address</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Address</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@map</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Map</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Map</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@description</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Description</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Description</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@owner</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Owner</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Owner</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@suffix</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Suffix</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Suffix</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@spec_map</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>SpecMap</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>SpecMap</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># If the user has defined symbols in the Ruby-ish API, then use that </span> <span class='comment'># too, but we expect the data to be in the right format. </span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_each_key'>each_key</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> <span class='id identifier rubyid_accessor'>accessor</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_accessor'>accessor</span><span class='comma'>,</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_accessor'>accessor</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id="address=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="address-instance_method"> - (<tt>Object</tt>) <strong>address</strong> </h3><div class="docstring"> <div class="discussion"> <p>If type is :remote, this is likely the P4PORT address of the remote server. May not be set in all cases.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 30 31 32</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 30</span> <span class='kw'>def</span> <span class='id identifier rubyid_address'>address</span> <span class='ivar'>@address</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="date=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="date-instance_method"> - (<tt>Object</tt>) <strong>date</strong> </h3><div class="docstring"> <div class="discussion"> <p>DateTime associated with the depot</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 23 24 25</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 23</span> <span class='kw'>def</span> <span class='id identifier rubyid_date'>date</span> <span class='ivar'>@date</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="depot=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="depot-instance_method"> - (<tt>Object</tt>) <strong>depot</strong> </h3><div class="docstring"> <div class="discussion"> <p>The depot name</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 20 21 22</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 20</span> <span class='kw'>def</span> <span class='id identifier rubyid_depot'>depot</span> <span class='ivar'>@depot</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="description=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="description-instance_method"> - (<tt>Object</tt>) <strong>description</strong> </h3><div class="docstring"> <div class="discussion"> <p>Short description of the depot's purpose. Optional</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 38 39 40</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 38</span> <span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span> <span class='ivar'>@description</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="map=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="map-instance_method"> - (<tt>Object</tt>) <strong>map</strong> </h3><div class="docstring"> <div class="discussion"> <p>If type is :local, :spec, or :archive, this points to the relative location of the depot subdirectory. See command reference for more details</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 35 36 37</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 35</span> <span class='kw'>def</span> <span class='id identifier rubyid_map'>map</span> <span class='ivar'>@map</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="owner=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="owner-instance_method"> - (<tt>Object</tt>) <strong>owner</strong> </h3><div class="docstring"> <div class="discussion"> <p>The user who owns the depot.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 41 42 43</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 41</span> <span class='kw'>def</span> <span class='id identifier rubyid_owner'>owner</span> <span class='ivar'>@owner</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="spec_map=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="spec_map-instance_method"> - (<tt>Object</tt>) <strong>spec_map</strong> </h3><div class="docstring"> <div class="discussion"> <p>When type is :spec, an optional description of what specs should be saved. See command reference for more details.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 49 50 51</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 49</span> <span class='kw'>def</span> <span class='id identifier rubyid_spec_map'>spec_map</span> <span class='ivar'>@spec_map</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="suffix=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="suffix-instance_method"> - (<tt>Object</tt>) <strong>suffix</strong> </h3><div class="docstring"> <div class="discussion"> <p>If type is :spec, this holds an optional suffix for generated paths to objects in the spec depot. See command reference for more details.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 45 46 47</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 45</span> <span class='kw'>def</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='ivar'>@suffix</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="type=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="type-instance_method"> - (<tt>Object</tt>) <strong>type</strong> </h3><div class="docstring"> <div class="discussion"> <p>:local, :remote, :spec, :stream, :unload, or :archive</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 26 27 28</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 26</span> <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span> <span class='ivar'>@type</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="browsable?-instance_method"> - (<tt>Boolean</tt>) <strong>browsable?</strong> </h3><div class="docstring"> <div class="discussion"> <p>You should always be able to list files and dirs of a depot (I think), you just might not get any results.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Boolean</tt>)</span> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 80 81 82</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 80</span> <span class='kw'>def</span> <span class='id identifier rubyid_browsable?'>browsable?</span> <span class='kw'>true</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="depot_path-instance_method"> - (<tt>Object</tt>) <strong>depot_path</strong> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 74 75 76</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 74</span> <span class='kw'>def</span> <span class='id identifier rubyid_depot_path'>depot_path</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>//</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_depot'>depot</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="name-instance_method"> - (<tt>Object</tt>) <strong>name</strong> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 70 71 72</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 70</span> <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span> <span class='id identifier rubyid_depot'>depot</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="to_internal_hash-instance_method"> - (<tt>Object</tt>) <strong>to_internal_hash</strong> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 84 85 86 87 88 89 90 91 92 93 94</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/depot.rb', line 84</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_internal_hash'>to_internal_hash</span> <span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>Depot:</span> <span class='ivar'>@depot</span> <span class='rbrace'>}</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@type</span> <span class='kw'>if</span> <span class='ivar'>@type</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Address</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@address</span> <span class='kw'>if</span> <span class='ivar'>@address</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Map</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@map</span> <span class='kw'>if</span> <span class='ivar'>@map</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@description</span> <span class='kw'>if</span> <span class='ivar'>@description</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Owner</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@owner</span> <span class='kw'>if</span> <span class='ivar'>@owner</span> <span class='id identifier rubyid_hash'>hash</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Thu Jul 16 12:13:02 2015 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.8.7.6 (ruby-2.2.1). </div> </body> </html>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#6 | 15676 | tjuricek | HWS/NOARCH/2015.1.main/201509092205 | ||
#5 | 15073 | tjuricek | Update Auth::Middleware and add spec | ||
#4 | 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. |
||
#3 | 15038 | tjuricek | Document 'login' auth method and client programming overview. | ||
#2 | 15032 | tjuricek |
Starting config and doc revisions. System is now broken while revisions underway. Configuration 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. |
||
#1 | 14049 | tjuricek |
Add methods to generate client workspaces for a user. The Qt SDK was updated based on immediate need. Also, add Ruby client SDK documentation to the docs site. Everything is early, but there's *some* reference available at least. |