<!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> Top Level Namespace — 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#!top-level-namespace.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</a> » <span class="title">Top Level Namespace</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>Top Level Namespace </h1> <dl class="box"> </dl> <div class="clear"></div> <h2>Defined Under Namespace</h2> <p class="children"> <strong class="modules">Modules:</strong> <span class='object_link'><a href="Errors.html" title="Errors (module)">Errors</a></span> <strong class="classes">Classes:</strong> <span class='object_link'><a href="HelixWebServicesClient.html" title="HelixWebServicesClient (class)">HelixWebServicesClient</a></span> </p> <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="top-level-namespace.html#camelize-instance_method" title="#camelize (instance method)">- (Object) <strong>camelize</strong>(s) </a> </span> <span class="summary_desc"><div class='inline'> <p>Converts a_snake_case to aSnakCase.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="top-level-namespace.html#quotify-instance_method" title="#quotify (instance method)">- (Object) <strong>quotify</strong>(s) </a> </span> <span class="summary_desc"><div class='inline'> <p>Will optionally wrap a string in quotes, escaping any quote chars.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="top-level-namespace.html#to_snake_case-instance_method" title="#to_snake_case (instance method)">- (Object) <strong>to_snake_case</strong>(s) </a> </span> <span class="summary_desc"><div class='inline'> <p>Converts aCamelCase to a_camel_case.</p> </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="camelize-instance_method"> - (<tt>Object</tt>) <strong>camelize</strong>(s) </h3><div class="docstring"> <div class="discussion"> <p>Converts a_snake_case to aSnakCase</p> <p>Allows for Ruby classes to have the typical snake_case case handling, but use camelCase styles for JSON.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 9 10 11</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 9</span> <span class='kw'>def</span> <span class='id identifier rubyid_camelize'>camelize</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_inject'>inject</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_buffer'>buffer</span><span class='comma'>,</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span> <span class='id identifier rubyid_buffer'>buffer</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_buffer'>buffer</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>?</span> <span class='id identifier rubyid_e'>e</span> <span class='op'>:</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_capitalize'>capitalize</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="quotify-instance_method"> - (<tt>Object</tt>) <strong>quotify</strong>(s) </h3><div class="docstring"> <div class="discussion"> <p>Will optionally wrap a string in quotes, escaping any quote chars</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 21 22 23 24 25 26 27</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 21</span> <span class='kw'>def</span> <span class='id identifier rubyid_quotify'>quotify</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>'</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_depotPath'>depotPath</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>'</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\'</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>'</span><span class='tstring_end'>"</span></span> <span class='kw'>else</span> <span class='id identifier rubyid_s'>s</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="to_snake_case-instance_method"> - (<tt>Object</tt>) <strong>to_snake_case</strong>(s) </h3><div class="docstring"> <div class="discussion"> <p>Converts aCamelCase to a_camel_case</p> <p>Used to convert from JSON key names to Ruby snake case conventions</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 16 17 18</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client.rb', line 16</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_snake_case'>to_snake_case</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_gsub!'>gsub!</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(.)([A-Z])</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>\1_\2</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Thu Jul 16 12:13:01 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 | |
---|---|---|---|---|---|
#61 | 16346 | tjuricek | Removing build directory prior to migration | ||
#60 | 16334 | tjuricek |
HWS/NOARCH/2015.1.main/201510211937 Documentation updates for new system configuration options. |
||
#59 | 16331 | tjuricek |
HWS/NOARCH/2015.1.main/201510211755 This is a large revision to the deployment: - nginx is now part of the system - perforce-server is *not* installed during post-install configuration The only change for migration should be to uninstall (and purge) your current nginx setup. |
||
#58 | 16206 | tjuricek | HWS/NOARCH/2015.1.main/201510122220 | ||
#57 | 16194 | tjuricek |
HWS/NOARCH/2015.1.main/201510121820 Implemented DELETE methods to help uninstallation processes for Helix Sync. |
||
#56 | 16168 | tjuricek | HWS/NOARCH/2015.1.main/201510092323 | ||
#55 | 16161 | tjuricek |
HWS/NOARCH/2015.1.main/201510082242 - Ability for custom middleware to filter P4PORT agressively - If p4d deems login not necessary, return an empty string for the valid ticket value. |
||
#54 | 16144 | tjuricek |
HWS/NOARCH/2015.1.main/201510081946 Major revision to URL structure. This is a breaking change to the API. |
||
#53 | 16093 | tjuricek |
HWS/NOARCH/2015.1.main/201510061647 Rename of trust setting, and adjustments to Helix Sync logic for selecting pending changelists |
||
#52 | 16077 | tjuricek |
HWS/NOARCH/2015.1.main/201510051630 Includes changes to trust behavior |
||
#51 | 16075 | tjuricek |
HWS/NOARCH/2015.1.main/201510051543 This includes a first implementation of the Helix Cloud integration with Helix Sync. |
||
#50 | 16007 | tjuricek |
HWS/NOARCH/2015.1.main/201510011648 Documentation updates for the new default parameter to getting the latest helix sync client |
||
#49 | 15994 | tjuricek | HWS/NOARCH/2015.1.main/201509302210 | ||
#48 | 15975 | tjuricek |
HWS/NOARCH/2015.1.main/201509291925 Add support for repo creation/update and deletion, same for SSH keys. Add util module for supporting methods, modify temp client to dissapear. (Modified submit of review 15549 by @ptomiak) |
||
#47 | 15962 | tjuricek | HWS/NOARCH/2015.1.main/201509290120 | ||
#46 | 15895 | tjuricek | HWS/NOARCH/2015.1.main/201509242158 | ||
#45 | 15887 | tjuricek | HWS/NOARCH/2015.1.main/201509241712 | ||
#44 | 15874 | tjuricek | HWS/NOARCH/2015.1.main/201509232127 | ||
#43 | 15867 | tjuricek | HWS/NOARCH/2015.1.main/201509230120 | ||
#42 | 15836 | tjuricek | HWS/NOARCH/2015.1.main/201509221612 | ||
#41 | 15826 | tjuricek | HWS/NOARCH/2015.1.main/201509212055 | ||
#40 | 15783 | tjuricek | HWS/NOARCH/2015.1.main/201509180120 | ||
#39 | 15769 | tjuricek | HWS/NOARCH/2015.1.main/201509170120 | ||
#38 | 15758 | tjuricek | HWS/NOARCH/2015.1.main/201509161743 | ||
#37 | 15737 | tjuricek | HWS/NOARCH/2015.1.main/201509150120 | ||
#36 | 15708 | tjuricek | HWS/NOARCH/2015.1.main/201509140120 | ||
#35 | 15699 | tjuricek | HWS/NOARCH/2015.1.main/201509111845 | ||
#34 | 15690 | tjuricek | HWS/NOARCH/2015.1.main/201509110141 | ||
#33 | 15676 | tjuricek | HWS/NOARCH/2015.1.main/201509092205 | ||
#32 | 15589 | tjuricek | Update path to test output and update docs. | ||
#31 | 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. |
||
#30 | 15517 | tjuricek | Do not require changelist ID for submitting Helix Sync pending changelists. | ||
#29 | 15499 | tjuricek | Naive implementation of helix sync project submit for "helix versioning engine projects". | ||
#28 | 15487 | tjuricek | Add basic ability to create pending changelists for helix sync projects. | ||
#27 | 15479 | tjuricek | Added a basic "HVE project" implementation for creating clients. | ||
#26 | 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. |
||
#25 | 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 |
||
#24 | 15228 | tjuricek | Revise triggers implementation, tests, and documentation. | ||
#23 | 15227 | tjuricek |
Revise implementation, tests, and documentation for protections management. Remove some specs I will not be revising from the helix_web_services project. |
||
#22 | 15225 | tjuricek |
Revise counter implementation, tests, and documentation Wasn't available in the Ruby client before, so, it's now available. |
||
#21 | 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. |
||
#20 | 15211 | tjuricek | Implement tests and documentation for label spec management. | ||
#19 | 15210 | tjuricek | Implement tests and documentation for job spec management. | ||
#18 | 15209 | tjuricek | Implement tests and documentation for group spec management. | ||
#17 | 15208 | tjuricek |
Revise 'command' implementation, tests, and documentaiton. This includes a change from a command blacklist to a whitelist. See P4WEBAPI-21 |
||
#16 | 15205 | tjuricek | Implemented tests and documentation for depot spec editing. | ||
#15 | 15189 | tjuricek | Update files implementation, testing, and documentation. | ||
#14 | 15185 | tjuricek | Update user spec management implementation, tests, and documentation. | ||
#13 | 15144 | tjuricek |
Setup stream spec tests and documentation. Also revised the documentation folder http_p4_web_api -> helix_versioning_engine |
||
#12 | 15132 | tjuricek | Provde a basic submit -e mechanism on classic perforce workspaces. | ||
#11 | 15110 | tjuricek | Revise changes methods for new p4 connection handling, add server specs, remove model references in client, and update asciidoc documentation. | ||
#10 | 15099 | tjuricek | Revise project services to be our simple 'container' for other systems. | ||
#9 | 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. |
||
#8 | 15090 | tjuricek |
Update _proposed_ API for project services. This is *very likely* to change, and will not be implemented until reviewed. |
||
#7 | 15078 | tjuricek |
clients spec method revisions Updated some other documentation. |
||
#6 | 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. |
||
#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. |