<!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::Project::GitFusionExtension::PerforceToGit — 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/Project/GitFusionExtension/PerforceToGit.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 (P)</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'><span class='object_link'><a href="../../Project.html" title="HelixWebServicesClient::Models::Project (class)">Project</a></span></span> » <span class='title'><span class='object_link'><a href="../GitFusionExtension.html" title="HelixWebServicesClient::Models::Project::GitFusionExtension (class)">GitFusionExtension</a></span></span> » <span class="title">PerforceToGit</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::Project::GitFusionExtension::PerforceToGit </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::Project::GitFusionExtension::PerforceToGit</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/project/git_fusion_extension.rb</dd> </dl> <div class="clear"></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="#enable_stream_imports-instance_method" title="#enable_stream_imports (instance method)">- (Object) <strong>enable_stream_imports</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Returns the value of attribute enable_stream_imports.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#http_url-instance_method" title="#http_url (instance method)">- (Object) <strong>http_url</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Returns the value of attribute http_url.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#ssh_url-instance_method" title="#ssh_url (instance method)">- (Object) <strong>ssh_url</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Returns the value of attribute ssh_url.</p> </div></span> </li> </ul> <h2> Class Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#from_hash-class_method" title="from_hash (class method)">+ (Object) <strong>from_hash</strong>(hash) </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#json_create-class_method" title="json_create (class method)">+ (Object) <strong>json_create</strong>(obj) </a> </span> <span class="summary_desc"><div class='inline'></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="#initialize-instance_method" title="#initialize (instance method)">- (PerforceToGit) <strong>initialize</strong>(enable_stream_imports: nil, http_url: nil, ssh_url: nil) </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'> <p>A new instance of PerforceToGit.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_h-instance_method" title="#to_h (instance method)">- (Object) <strong>to_h</strong> </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_json-instance_method" title="#to_json (instance method)">- (Object) <strong>to_json</strong>(*a) </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::Project::GitFusionExtension::PerforceToGit (class)">PerforceToGit</a></span></tt>) <strong>initialize</strong>(enable_stream_imports: nil, http_url: nil, ssh_url: nil) </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of PerforceToGit</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 282 283 284 285 286</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/project/git_fusion_extension.rb', line 282</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>enable_stream_imports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>http_url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ssh_url:</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='ivar'>@enable_stream_imports</span> <span class='op'>=</span> <span class='id identifier rubyid_enable_stream_imports'>enable_stream_imports</span> <span class='ivar'>@http_url</span> <span class='op'>=</span> <span class='id identifier rubyid_http_url'>http_url</span> <span class='ivar'>@ssh_url</span> <span class='op'>=</span> <span class='id identifier rubyid_ssh_url'>ssh_url</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="enable_stream_imports=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="enable_stream_imports-instance_method"> - (<tt>Object</tt>) <strong>enable_stream_imports</strong> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute enable_stream_imports</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 276 277 278</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/project/git_fusion_extension.rb', line 276</span> <span class='kw'>def</span> <span class='id identifier rubyid_enable_stream_imports'>enable_stream_imports</span> <span class='ivar'>@enable_stream_imports</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="http_url=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="http_url-instance_method"> - (<tt>Object</tt>) <strong>http_url</strong> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute http_url</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 278 279 280</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/project/git_fusion_extension.rb', line 278</span> <span class='kw'>def</span> <span class='id identifier rubyid_http_url'>http_url</span> <span class='ivar'>@http_url</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="ssh_url=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="ssh_url-instance_method"> - (<tt>Object</tt>) <strong>ssh_url</strong> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute ssh_url</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 280 281 282</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/project/git_fusion_extension.rb', line 280</span> <span class='kw'>def</span> <span class='id identifier rubyid_ssh_url'>ssh_url</span> <span class='ivar'>@ssh_url</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="class_method_details" class="method_details_list"> <h2>Class Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="from_hash-class_method"> + (<tt>Object</tt>) <strong>from_hash</strong>(hash) </h3><table class="source_code"> <tr> <td> <pre class="lines"> 300 301 302 303</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/project/git_fusion_extension.rb', line 300</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_hash'>from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span> <span class='id identifier rubyid_mapped'>mapped</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_hash'>hash</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_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='rbracket'>]</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_mapped'>mapped</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="json_create-class_method"> + (<tt>Object</tt>) <strong>json_create</strong>(obj) </h3><table class="source_code"> <tr> <td> <pre class="lines"> 309 310 311 312 313 314 315 316 317 318</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/project/git_fusion_extension.rb', line 309</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_json_create'>json_create</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span> <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='lbracket'>[</span><span class='symbol'>:enable_stream_imports</span><span class='comma'>,</span> <span class='symbol'>:http_url</span><span class='comma'>,</span> <span class='symbol'>:ssh_url</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</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_jsonKey'>jsonKey</span> <span class='op'>=</span> <span class='id identifier rubyid_camelize'>camelize</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='id identifier rubyid_jsonKey'>jsonKey</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='id identifier rubyid_jsonKey'>jsonKey</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</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="to_h-instance_method"> - (<tt>Object</tt>) <strong>to_h</strong> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 288 289 290 291 292 293 294 295 296 297 298</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/project/git_fusion_extension.rb', line 288</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span> <span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='lbracket'>[</span><span class='symbol'>:enable_stream_imports</span><span class='comma'>,</span> <span class='symbol'>:http_url</span><span class='comma'>,</span> <span class='symbol'>:ssh_url</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</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_val'>val</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='id identifier rubyid_camelize'>camelize</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</span> <span class='kw'>unless</span> <span class='id identifier rubyid_val'>val</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>end</span> <span class='id identifier rubyid_hash'>hash</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="to_json-instance_method"> - (<tt>Object</tt>) <strong>to_json</strong>(*a) </h3><table class="source_code"> <tr> <td> <pre class="lines"> 305 306 307</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/project/git_fusion_extension.rb', line 305</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='id identifier rubyid_to_h'>to_h</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Wed Jul 15 15:50:10 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. |