p4ws.html #69

# Change User Description Committed
#69 16346 tjuricek Removing build directory prior to migration
#68 16334 tjuricek HWS/NOARCH/2015.1.main/201510211937

Documentation updates for new system configuration options.
#67 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.
#66 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.
#65 16144 tjuricek HWS/NOARCH/2015.1.main/201510081946

Major revision to URL structure. This is a breaking change to the API.
#64 16093 tjuricek HWS/NOARCH/2015.1.main/201510061647

Rename of trust setting, and adjustments to Helix Sync logic for selecting pending changelists
#63 16077 tjuricek HWS/NOARCH/2015.1.main/201510051630

Includes changes to trust behavior
#62 16007 tjuricek HWS/NOARCH/2015.1.main/201510011648

Documentation updates for the new default parameter to getting the latest helix sync client
#61 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)
#60 15783 tjuricek HWS/NOARCH/2015.1.main/201509180120
#59 15769 tjuricek HWS/NOARCH/2015.1.main/201509170120
#58 15758 tjuricek HWS/NOARCH/2015.1.main/201509161743
#57 15737 tjuricek HWS/NOARCH/2015.1.main/201509150120
#56 15708 tjuricek HWS/NOARCH/2015.1.main/201509140120
#55 15699 tjuricek HWS/NOARCH/2015.1.main/201509111845
#54 15690 tjuricek HWS/NOARCH/2015.1.main/201509110141
#53 15676 tjuricek HWS/NOARCH/2015.1.main/201509092205
#52 15545 tjuricek Place in config and hooks for Helix Cloud authentication.
#51 15530 tjuricek Add basic development guide
#50 15517 tjuricek Do not require changelist ID for submitting Helix Sync pending changelists.
#49 15499 tjuricek Naive implementation of helix sync project submit for "helix versioning engine projects".
#48 15496 tjuricek Revise GET /helix_sync/v1/changes/[project] to /helix_sync/v1/changes/[project]/pending

The base method is really intended for the latest changelist number. Meh.
#47 15487 tjuricek Add basic ability to create pending changelists for helix sync projects.
#46 15483 tjuricek Add a new 'hws_console` application to the deployment.

This should give users the ability to use the Ruby client for quick and dirty debugging of issues with HWS.
Since it's so easy, I've added it to the deployment guide.
#45 15479 tjuricek Added a basic "HVE project" implementation for creating clients.
#44 15460 tjuricek Add notes on service startup in deployment
#43 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.
#42 15435 tjuricek Add proposed HTTP methods for Helix Sync.

It's a little unclear to me why you would need a local root directory to create the shared shelving changelist for a particular project (and user).
So I didn't add that.
#41 15423 tjuricek Revised HWS Qt API.

This is a major revision of the API, which removes most of the "typed" data, replacing it with a more generic "executeMethodDone" callback.
The main benefit here is to allow the API to interop with different versions of p4d, and not restrict the methods it can call.
We may add more helpers in the future.
#40 15299 tjuricek Revise documentation of our new 'list available services' method.
#39 15297 tjuricek Implement of 'cluster services' configuration.

The configuration will be stored in a local JSON file, which is expected to be maintained by the systems admin. Eventually, it's expected to have this sort of thing implemented via Helix Admin.
#38 15260 tjuricek Fix truncation of content when listing a single file's details.

Added message warning people about timeouts. This does work, and doesn't bring the system down, but you'll probably hit timeouts if you're trying to download files using this system.
#37 15257 tjuricek Added stress test, corrected per-request header config.

Apparently using underscores is a "special" mechanism for HTTP headers, and requires adjusting nginx to allow such things. Might as well just recommend using hyphens, which get converted to underscores anyway.

The current test just hits a listing of 20000 files against p4play. Returns a 2.5 MB response, which doesn't seem to cause problems (yay).
#36 15242 tjuricek Add Helix Sync stubs and documentation
#35 15241 tjuricek Add Git Fusion stubs and documentation.
#34 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
#33 15229 tjuricek Remove incorrect default setting for P4HOST
#32 15228 tjuricek Revise triggers implementation, tests, and documentation.
#31 15227 tjuricek Revise implementation, tests, and documentation for protections management.

Remove some specs I will not be revising from the helix_web_services project.
#30 15225 tjuricek Revise counter implementation, tests, and documentation

Wasn't available in the Ruby client before, so, it's now available.
#29 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.
#28 15211 tjuricek Implement tests and documentation for label spec management.
#27 15210 tjuricek Implement tests and documentation for job spec management.
#26 15209 tjuricek Implement tests and documentation for group spec management.
#25 15208 tjuricek Revise 'command' implementation, tests, and documentaiton.

This includes a change from a command blacklist to a whitelist. See P4WEBAPI-21
#24 15205 tjuricek Implemented tests and documentation for depot spec editing.
#23 15189 tjuricek Update files implementation, testing, and documentation.
#22 15188 tjuricek Execute user modification commands as the super user in tests.
#21 15185 tjuricek Update user spec management implementation, tests, and documentation.
#20 15144 tjuricek Setup stream spec tests and documentation.

Also revised the documentation folder http_p4_web_api -> helix_versioning_engine
#19 15132 tjuricek Provde a basic submit -e mechanism on classic perforce workspaces.
#18 15110 tjuricek Revise changes methods for new p4 connection handling, add server specs, remove model references in client, and update asciidoc documentation.
#17 15099 tjuricek Revise project services to be our simple 'container' for other systems.
#16 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.
#15 15090 tjuricek Update _proposed_ API for project services.

This is *very likely* to change, and will not be implemented until reviewed.
#14 15078 tjuricek clients spec method revisions

Updated some other documentation.
#13 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.
#12 15073 tjuricek Update Auth::Middleware and add spec
#11 15042 tjuricek Document error conventions.
#10 15038 tjuricek Document 'login' auth method and client programming overview.
#9 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.
#8 14980 tjuricek Starting to make revisions to the Asciidoc guide.

These are just revisions to the preable sections.
#7 14184 tjuricek Revise the CD diagram, update official docs, and change the DB configuration key.
#6 14182 tjuricek Asciidoc conversion of the changes HTTP guide
#5 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.
#4 14027 tjuricek Move almost all Qt SDK documentation to Doxygen system, and just reference it in the main doc site.
#3 14002 tjuricek Some preliminary API documentation for the JavaScript SDK.
#2 13614 tjuricek Update the Qt guide to include the QSettings* constructor.
#1 13612 tjuricek Update deployment guide, switch built documentation to asciidoc, remove unused packaging script for p4_web_api