Helix SwarmHelix Swarm

Master.html

  • //
  • guest/
  • ptomiak/
  • hws/
  • build/
  • doc/
  • helix_web_services/
  • HelixWebServices/
  • Master.html #1
  • View
  • Commits
  • Open Download .zip Download (6 KB) 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4.   <head>
  5.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>
  7.   Class: HelixWebServices::Master
  8.   
  9.     &mdash; Documentation by YARD 0.8.7.6
  10.   
  11. </title>
  12.  
  13.   <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
  14.  
  15.   <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
  16.  
  17. <script type="text/javascript" charset="utf-8">
  18.   hasFrames = window.top.frames.main ? true : false;
  19.   relpath = '../';
  20.   framesUrl = "../frames.html#!HelixWebServices/Master.html";
  21. </script>
  22.  
  23.  
  24.   <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
  25.  
  26.   <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
  27.  
  28.  
  29.   </head>
  30.   <body>
  31.     <div id="header">
  32.       <div id="menu">
  33.   
  34.     <a href="../_index.html">Index (M)</a> &raquo;
  35.     <span class='title'><span class='object_link'><a href="../HelixWebServices.html" title="HelixWebServices (module)">HelixWebServices</a></span></span>
  36.      &raquo; 
  37.     <span class="title">Master</span>
  38.   
  39.  
  40.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  41. </div>
  42.  
  43.       <div id="search">
  44.   
  45.     <a class="full_list_link" id="class_list_link"
  46.         href="../class_list.html">
  47.       Class List
  48.     </a>
  49.   
  50.     <a class="full_list_link" id="method_list_link"
  51.         href="../method_list.html">
  52.       Method List
  53.     </a>
  54.   
  55.     <a class="full_list_link" id="file_list_link"
  56.         href="../file_list.html">
  57.       File List
  58.     </a>
  59.   
  60. </div>
  61.       <div class="clear"></div>
  62.     </div>
  63.  
  64.     <iframe id="search_frame"></iframe>
  65.  
  66.     <div id="content"><h1>Class: HelixWebServices::Master
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.     <dt class="r1">Inherits:</dt>
  75.     <dd class="r1">
  76.       <span class="inheritName">Sinatra::Base</span>
  77.       
  78.         <ul class="fullTree">
  79.           <li>Object</li>
  80.           
  81.             <li class="next">Sinatra::Base</li>
  82.           
  83.             <li class="next">HelixWebServices::Master</li>
  84.           
  85.         </ul>
  86.         <a href="#" class="inheritanceTree">show all</a>
  87.       
  88.       </dd>
  89.     
  90.   
  91.   
  92.     
  93.   
  94.     
  95.   
  96.   
  97.   
  98.     <dt class="r2 last">Defined in:</dt>
  99.     <dd class="r2 last">lib/helix_web_services.rb</dd>
  100.   
  101. </dl>
  102. <div class="clear"></div>
  103.  
  104. <h2>Overview</h2><div class="docstring">
  105.   <div class="discussion">
  106.     
  107. <p>A master Sinatra instance that basically sets up routing to each of the
  108. sub-applications, and connects the authorization mechanism.</p>
  109.  
  110. <p>In the future, we may have status and health check functionality available
  111. here.</p>
  112.  
  113. <p>We mount each application under a “versioned” subpath. This allows us to
  114. keep an old and new version of a sub-application in the system at the same
  115. time, ideally to allow for migration to breaking changes.</p>
  116.  
  117.  
  118.   </div>
  119. </div>
  120. <div class="tags">
  121.   
  122.  
  123. </div>
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.   
  131.     <h2>
  132.       Class Method Summary
  133.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  134.     </h2>
  135.  
  136.     <ul class="summary">
  137.       
  138.         <li class="public ">
  139.   <span class="summary_signature">
  140.     
  141.       <a href="#register_app-class_method" title="register_app (class method)">+ (Object) <strong>register_app</strong>(app) </a>
  142.     
  143.  
  144.     
  145.   </span>
  146.   
  147.   
  148.   
  149.   
  150.   
  151.   
  152.   
  153.  
  154.   
  155.     <span class="summary_desc"><div class='inline'></div></span>
  156.   
  157. </li>
  158.  
  159.       
  160.     </ul>
  161.   
  162.  
  163.  
  164.   
  165.  
  166.   <div id="class_method_details" class="method_details_list">
  167.     <h2>Class Method Details</h2>
  168.  
  169.     
  170.       <div class="method_details first">
  171.   <h3 class="signature first" id="register_app-class_method">
  172.   
  173.     + (<tt>Object</tt>) <strong>register_app</strong>(app) 
  174.   
  175.  
  176.   
  177.  
  178.   
  179. </h3><table class="source_code">
  180.   <tr>
  181.     <td>
  182.       <pre class="lines">
  183.  
  184.  
  185. 111
  186. 112
  187. 113
  188. 114
  189. 115
  190. 116
  191. 117
  192. 118
  193. 119
  194. 120
  195. 121
  196. 122
  197. 123</pre>
  198.     </td>
  199.     <td>
  200.       <pre class="code"><span class="info file"># File 'lib/helix_web_services.rb', line 111</span>
  201.  
  202. <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>
  203.   <span class='id identifier rubyid_use'>use</span> <span class='id identifier rubyid_app'>app</span>
  204.   <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>
  205.   <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>
  206.     <span class='id identifier rubyid_content_type'>content_type</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span>
  207.     <span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>X-Helix-Web-Services-Version</span><span class='tstring_end'>&#39;</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>
  208.   <span class='kw'>end</span>
  209.   <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>
  210.   <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>
  211.     <span class='id identifier rubyid_status'>status</span> <span class='int'>404</span>
  212.     <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
  213.   <span class='kw'>end</span>
  214. <span class='kw'>end</span></pre>
  215.     </td>
  216.   </tr>
  217. </table>
  218. </div>
  219.     
  220.   </div>
  221.  
  222. </div>
  223.  
  224.     <div id="footer">
  225.   Generated on Tue Sep 15 01:20:29 2015 by
  226.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  227.   0.8.7.6 (ruby-2.2.3).
  228. </div>
  229.  
  230.   </body>
  231. </html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use. 10 years ago