<!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: HelixVersioningEngine::App
— 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#!HelixVersioningEngine/App.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)</a> »
<span class='title'><span class='object_link'><a href="../HelixVersioningEngine.html" title="HelixVersioningEngine (module)">HelixVersioningEngine</a></span></span>
»
<span class="title">App</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: HelixVersioningEngine::App
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Sinatra::Base</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Sinatra::Base</li>
<li class="next">HelixVersioningEngine::App</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/helix_versioning_engine/app.rb<span class="defines">,<br />
lib/helix_versioning_engine/app/specs.rb,<br /> lib/helix_versioning_engine/app/login.rb,<br /> lib/helix_versioning_engine/app/files.rb,<br /> lib/helix_versioning_engine/app/users.rb,<br /> lib/helix_versioning_engine/app/changes.rb,<br /> lib/helix_versioning_engine/app/streams.rb,<br /> lib/helix_versioning_engine/app/commands.rb,<br /> lib/helix_versioning_engine/app/triggers.rb,<br /> lib/helix_versioning_engine/app/counters.rb,<br /> lib/helix_versioning_engine/app/protections.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Methods to manipulate protections table.</p>
<p>The 'protections' resource in our system is the complete list, so
you don't fetch or manipulate any single 'protection'. It's
all or nothing.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Class Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#normalizers-class_method" title="normalizers (class method)">+ (Object) <strong>normalizers</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute normalizers.</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="#check_whitelist-instance_method" title="#check_whitelist (instance method)">- (Object) <strong>check_whitelist</strong>(cmd, args) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_offset-instance_method" title="#fetch_offset (instance method)">- (Object) <strong>fetch_offset</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#filter_params-instance_method" title="#filter_params (instance method)">- (Object) <strong>filter_params</strong>(params) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Basically a “blacklist” of things we know the frameworks going to add to
the params array we don't want to pass on to the p4 command sets for
spec input.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(method, *args) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>It's assumed that these are typically used to find the different spec
types within typical requests.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#offset-instance_method" title="#offset (instance method)">- (Object) <strong>offset</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Will fetch the system offset based on the server date.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_msg-instance_method" title="#to_msg (instance method)">- (Object) <strong>to_msg</strong>(message) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="method_missing_details" class="method_details_list">
<h2>Dynamic Method Handling</h2>
<p class="notice this">
This class handles dynamic methods through the <tt>method_missing</tt> method
</p>
<div class="method_details first">
<h3 class="signature first" id="method_missing-instance_method">
- (<tt>Object</tt>) <strong>method_missing</strong>(method, *args)
</h3><div class="docstring">
<div class="discussion">
<p>It's assumed that these are typically used to find the different spec
types within typical requests.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68
69
70
71
72
73
74</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/app.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_method'>method</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^normalize_(.*)</span><span class='regexp_end'>/</span></span>
<span class='id identifier rubyid_spec_type'>spec_type</span> <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_last_match'>last_match</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
<span class='kw'>unless</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_normalizers'>normalizers</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_spec_type'>spec_type</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_normalizers'>normalizers</span><span class='lbracket'>[</span><span class='id identifier rubyid_spec_type'>spec_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_normalizer'>normalizer</span><span class='lparen'>(</span><span class='id identifier rubyid_spec_type'>spec_type</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_normalizers'>normalizers</span><span class='lbracket'>[</span><span class='id identifier rubyid_spec_type'>spec_type</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>*</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="class_attr_details" class="attr_details">
<h2>Class Attribute Details</h2>
<span id="normalizers=-class_method"></span>
<div class="method_details first">
<h3 class="signature first" id="normalizers-class_method">
+ (<tt>Object</tt>) <strong>normalizers</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute normalizers</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
61
62
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/app.rb', line 61</span>
<span class='kw'>def</span> <span class='id identifier rubyid_normalizers'>normalizers</span>
<span class='ivar'>@normalizers</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="check_whitelist-instance_method">
- (<tt>Object</tt>) <strong>check_whitelist</strong>(cmd, args)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/app/commands.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_check_whitelist'>check_whitelist</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='comment'># Make sure command is whitelisted
</span> <span class='id identifier rubyid_cmd_whitelisted'>cmd_whitelisted</span> <span class='op'>=</span> <span class='const'>HWSSettings</span><span class='period'>.</span><span class='id identifier rubyid_system'>system</span><span class='period'>.</span><span class='const'>COMMAND_WHITELIST</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_wl'>wl</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_wl'>wl</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
<span class='id identifier rubyid_wl'>wl</span> <span class='op'>==</span> <span class='id identifier rubyid_cmd'>cmd</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_wl'>wl</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
<span class='id identifier rubyid_wl'>wl</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>==</span> <span class='id identifier rubyid_cmd'>cmd</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_cmd_whitelisted'>cmd_whitelisted</span>
<span class='id identifier rubyid_halt'>halt</span> <span class='int'>403</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>MessageCode:</span> <span class='int'>15_360</span><span class='comma'>,</span>
<span class='label'>MessageText:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='embexpr_end'>}</span><span class='tstring_content'> not whitelisted in configuration</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='label'>MessageSeverity:</span> <span class='symbol'>:ERROR</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
<span class='kw'>end</span>
<span class='comment'># If command is whitelisted, double check that we do not have required
</span> <span class='comment'># arguments
</span> <span class='id identifier rubyid_required_args'>required_args</span> <span class='op'>=</span> <span class='const'>HWSSettings</span><span class='period'>.</span><span class='id identifier rubyid_system'>system</span><span class='period'>.</span><span class='const'>COMMAND_WHITELIST</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_wl'>wl</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_wl'>wl</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
<span class='id identifier rubyid_wl'>wl</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>==</span> <span class='id identifier rubyid_cmd'>cmd</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_required_args'>required_args</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_required_args'>required_args</span><span class='period'>.</span><span class='id identifier rubyid_drop'>drop</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_halt'>halt</span> <span class='int'>403</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>MessageCode:</span> <span class='int'>15_360</span><span class='comma'>,</span>
<span class='label'>MessageText:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='embexpr_end'>}</span><span class='tstring_content'> not used with all required arguments </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_required_args'>required_args</span><span class='period'>.</span><span class='id identifier rubyid_drop'>drop</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='label'>MessageSeverity:</span> <span class='symbol'>:ERROR</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_offset-instance_method">
- (<tt>Object</tt>) <strong>fetch_offset</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51
52
53
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/app.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_offset'>fetch_offset</span>
<span class='id identifier rubyid_offset'>offset</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_open_p4_as_user'>open_p4_as_user</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_p4'>p4</span><span class='op'>|</span>
<span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_info'>run_info</span>
<span class='id identifier rubyid_offset'>offset</span> <span class='op'>=</span> <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_p4_date_offset'>p4_date_offset</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>serverDate</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_offset'>offset</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="filter_params-instance_method">
- (<tt>Object</tt>) <strong>filter_params</strong>(params)
</h3><div class="docstring">
<div class="discussion">
<p>Basically a “blacklist” of things we know the frameworks going to add to
the params array we don't want to pass on to the p4 command sets for
spec input</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
79
80
81
82
83</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/app.rb', line 79</span>
<span class='kw'>def</span> <span class='id identifier rubyid_filter_params'>filter_params</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='kw'>do</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='id identifier rubyid_k'>k</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>spec_type</span><span class='tstring_end'>'</span></span> <span class='op'>&&</span> <span class='id identifier rubyid_k'>k</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span> <span class='op'>&&</span> <span class='id identifier rubyid_k'>k</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>splat</span><span class='tstring_end'>'</span></span> <span class='op'>&&</span> <span class='id identifier rubyid_k'>k</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>captures</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="offset-instance_method">
- (<tt>Object</tt>) <strong>offset</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Will fetch the system offset based on the server date.</p>
<p>If allow_env_p4_config is true, we don't cache. Each request could come
in from a new server, and the different servers may have different offsets.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43
44
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/app.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_offset'>offset</span>
<span class='kw'>if</span> <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_allow_env_p4_config'>allow_env_p4_config</span>
<span class='id identifier rubyid_fetch_offset'>fetch_offset</span>
<span class='kw'>else</span>
<span class='ivar'>@offset</span> <span class='op'>||=</span> <span class='id identifier rubyid_fetch_offset'>fetch_offset</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_msg-instance_method">
- (<tt>Object</tt>) <strong>to_msg</strong>(message)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30
31
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/app.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_msg'>to_msg</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
<span class='lbrace'>{</span>
<span class='label'>MessageCode:</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_msgid'>msgid</span><span class='comma'>,</span>
<span class='label'>MessageSeverity:</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_severity'>severity</span><span class='comma'>,</span>
<span class='label'>MessageText:</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Sep 15 01:20:30 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 |
|
|
#1
|
15741 |
ptomiak |
Branch HWS for my use. |
|
|