<!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: HelixWebServices::Master
— 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#!HelixWebServices/Master.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 (M)</a> »
<span class='title'><span class='object_link'><a href="../HelixWebServices.html" title="HelixWebServices (module)">HelixWebServices</a></span></span>
»
<span class="title">Master</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: HelixWebServices::Master
</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">HelixWebServices::Master</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.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A master Sinatra instance that basically sets up routing to each of the
sub-applications, and connects the authorization mechanism.</p>
<p>In the future, we may have status and health check functionality available
here.</p>
<p>We mount each application under a “versioned” subpath. This allows us to
keep an old and new version of a sub-application in the system at the same
time, ideally to allow for migration to breaking changes.</p>
</div>
</div>
<div class="tags">
</div>
<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="#register_app-class_method" title="register_app (class method)">+ (Object) <strong>register_app</strong>(app) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="register_app-class_method">
+ (<tt>Object</tt>) <strong>register_app</strong>(app)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
111
112
113
114
115
116
117
118
119
120
121
122
123</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/helix_web_services.rb', line 111</span>
<span class='kw'>def</span> <span class='id identifier rubyid_register_app'>register_app</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_use'>use</span> <span class='id identifier rubyid_app'>app</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_register'>register</span> <span class='const'>HelixWebServices</span><span class='op'>::</span><span class='const'>ErrorHandling</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span>
<span class='id identifier rubyid_content_type'>content_type</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-Helix-Web-Services-Version</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>HelixWebServices</span><span class='op'>::</span><span class='const'>PRODUCT_ID</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_helpers'>helpers</span> <span class='const'>HWSHelpers</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_not_found'>not_found</span> <span class='kw'>do</span>
<span class='id identifier rubyid_status'>status</span> <span class='int'>404</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Sep 15 01:20:29 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. |
|
|