RubyGems - webroar - Versions diffs - 0.6.1 → 0.7.0 - Mend

webroar 0.6.1 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (402) hide show

data/src/admin_panel/doc/app/App.html ADDED Viewed

@@ -0,0 +1,489 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+  <title>Class: App</title>
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+  <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+</head>
+<body id="top" class="class">
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+            <li><a href="./app/models/app_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="app/models/app.rb">app/models/app.rb</a></li>
+          </ul>
+        </div>
+      </div>
+    </div>
+    <div id="class-metadata">
+      <!-- Parent Class -->
+      <div id="parent-class-section" class="section">
+        <h3 class="section-header">Parent</h3>
+        <p class="link">ActiveRecord::Base</p>
+      </div>
+      <!-- Method Quickref -->
+      <div id="method-list-section" class="section">
+        <h3 class="section-header">Methods</h3>
+        <ul class="link-list">
+          <li><a href="#method-c-exceptions_count">::exceptions_count</a></li>
+          <li><a href="#method-c-get_all">::get_all</a></li>
+          <li><a href="#method-c-get_application_data">::get_application_data</a></li>
+          <li><a href="#method-c-restart">::restart</a></li>
+          <li><a href="#method-c-start">::start</a></li>
+          <li><a href="#method-c-stop">::stop</a></li>
+        </ul>
+      </div>
+    </div>
+    <div id="project-metadata">
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+          <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a></li>
+        </ul>
+      </div>
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+        <ul class="link-list">
+          <li><a href="./Analytics.html">Analytics</a></li>
+          <li><a href="./Analytics/Database.html">Analytics::Database</a></li>
+          <li><a href="./Analytics/ResourceUsage.html">Analytics::ResourceUsage</a></li>
+          <li><a href="./Analytics/Throughput.html">Analytics::Throughput</a></li>
+          <li><a href="./Analytics/Url.html">Analytics::Url</a></li>
+          <li><a href="./Analytics/UrlBreakup.html">Analytics::UrlBreakup</a></li>
+          <li><a href="./ActionView.html">ActionView</a></li>
+          <li><a href="./ActionView/Helpers.html">ActionView::Helpers</a></li>
+          <li><a href="./ActionView/Helpers/AssetTagHelper.html">ActionView::Helpers::AssetTagHelper</a></li>
+          <li><a href="./AdminController.html">AdminController</a></li>
+          <li><a href="./AdminHelper.html">AdminHelper</a></li>
+          <li><a href="./App.html">App</a></li>
+          <li><a href="./AppException.html">AppException</a></li>
+          <li><a href="./AppTimeSample.html">AppTimeSample</a></li>
+          <li><a href="./ApplicationController.html">ApplicationController</a></li>
+          <li><a href="./ApplicationHelper.html">ApplicationHelper</a></li>
+          <li><a href="./ApplicationSpecification.html">ApplicationSpecification</a></li>
+          <li><a href="./ApplicationSpecificationController.html">ApplicationSpecificationController</a></li>
+          <li><a href="./ApplicationSpecificationHelper.html">ApplicationSpecificationHelper</a></li>
+          <li><a href="./Control.html">Control</a></li>
+          <li><a href="./ExceptionDetail.html">ExceptionDetail</a></li>
+          <li><a href="./ExceptionsController.html">ExceptionsController</a></li>
+          <li><a href="./ExceptionsHelper.html">ExceptionsHelper</a></li>
+          <li><a href="./GraphController.html">GraphController</a></li>
+          <li><a href="./GraphHelper.html">GraphHelper</a></li>
+          <li><a href="./Headers.html">Headers</a></li>
+          <li><a href="./HeadersController.html">HeadersController</a></li>
+          <li><a href="./HeadersHelper.html">HeadersHelper</a></li>
+          <li><a href="./MailSpecification.html">MailSpecification</a></li>
+          <li><a href="./MailSpecificationController.html">MailSpecificationController</a></li>
+          <li><a href="./MailSpecificationHelper.html">MailSpecificationHelper</a></li>
+          <li><a href="./Mailer.html">Mailer</a></li>
+          <li><a href="./Object.html">Object</a></li>
+          <li><a href="./PseudoModel.html">PseudoModel</a></li>
+          <li><a href="./ResourceUsage.html">ResourceUsage</a></li>
+          <li><a href="./SCGI.html">SCGI</a></li>
+          <li><a href="./ServerSpecification.html">ServerSpecification</a></li>
+          <li><a href="./ServerSpecificationController.html">ServerSpecificationController</a></li>
+          <li><a href="./ServerSpecificationHelper.html">ServerSpecificationHelper</a></li>
+          <li><a href="./SignalHelper.html">SignalHelper</a></li>
+          <li><a href="./UrlBreakupTimeSample.html">UrlBreakupTimeSample</a></li>
+          <li><a href="./UrlTimeSample.html">UrlTimeSample</a></li>
+          <li><a href="./User.html">User</a></li>
+          <li><a href="./YAMLConfig.html">YAMLConfig</a></li>
+          <li><a href="./YAMLWriter.html">YAMLWriter</a></li>
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+    </div>
+  </div>
+  <div id="documentation">
+    <h1 class="class">App</h1>
+    <div id="description" class="description">
+<p>This is the model class <a href="App.html">App</a> which relates itself
+with the apps table in database.</p>
+    </div><!-- description -->
+    <div id="5Buntitled-5D" class="documentation-section">
+      <!-- Methods -->
+      <div id="public-class-method-details" class="method-section section">
+        <h3 class="section-header">Public Class Methods</h3>
+        <div id="exceptions_count-method" class="method-detail ">
+          <a name="method-c-exceptions_count"></a>
+          <div class="method-heading">
+            <span class="method-name">exceptions_count</span><span
+              class="method-args">(name)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <div class="method-description">
+            <p>Take Application Name as argument and returns count of distinct open
+exceptions</p>
+            <div class="method-source-code" id="exceptions_count-source">
+<pre>
+<span class="ruby-comment"># File app/models/app.rb, line 40</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">exceptions_count</span>(<span class="ruby-identifier">name</span>)
+  <span class="ruby-keyword">if</span> <span class="ruby-identifier">app</span> = <span class="ruby-identifier">get_application_data</span>(<span class="ruby-identifier">name</span>)
+    <span class="ruby-constant">AppException</span>.<span class="ruby-identifier">count_open</span>(<span class="ruby-identifier">app</span>.<span class="ruby-identifier">id</span>)
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-value">0</span>
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- exceptions_count-source -->
+          </div>
+        </div><!-- exceptions_count-method -->
+        <div id="get_all-method" class="method-detail ">
+          <a name="method-c-get_all"></a>
+          <div class="method-heading">
+            <span class="method-name">get_all</span><span
+              class="method-args">(page = 1, per_page = 5)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <div class="method-description">
+            <div class="method-source-code" id="get_all-source">
+<pre>
+<span class="ruby-comment"># File app/models/app.rb, line 48</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_all</span>(<span class="ruby-identifier">page</span> = <span class="ruby-value">1</span>, <span class="ruby-identifier">per_page</span> = <span class="ruby-value">5</span>)
+  <span class="ruby-identifier">info</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load_file</span>(<span class="ruby-constant">CONFIG_FILE_PATH</span>) <span class="ruby-keyword">rescue</span> <span class="ruby-keyword">nil</span>
+  <span class="ruby-identifier">applications</span> = <span class="ruby-identifier">info</span>[<span class="ruby-string">&quot;Application Specification&quot;</span>].<span class="ruby-identifier">paginate</span>(<span class="ruby-value">:page</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">page</span>,<span class="ruby-value">:per_page</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">per_page</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">info</span>[<span class="ruby-string">&quot;Application Specification&quot;</span>]
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- get_all-source -->
+          </div>
+        </div><!-- get_all-method -->
+        <div id="get_application_data-method" class="method-detail ">
+          <a name="method-c-get_application_data"></a>
+          <div class="method-heading">
+            <span class="method-name">get_application_data</span><span
+              class="method-args">(name)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <div class="method-description">
+            <p>This method is used to get the application data. It needs name of the
+application as an input.</p>
+            <div class="method-source-code" id="get_application_data-source">
+<pre>
+<span class="ruby-comment"># File app/models/app.rb, line 34</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_application_data</span>(<span class="ruby-identifier">name</span>)
+  <span class="ruby-identifier">app</span> = <span class="ruby-identifier">where</span>(<span class="ruby-value">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">name</span>).<span class="ruby-identifier">first</span>
+  <span class="ruby-keyword">return</span> <span class="ruby-identifier">app</span>
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- get_application_data-source -->
+          </div>
+        </div><!-- get_application_data-method -->
+        <div id="restart-method" class="method-detail ">
+          <a name="method-c-restart"></a>
+          <div class="method-heading">
+            <span class="method-name">restart</span><span
+              class="method-args">(app_name)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <div class="method-description">
+            <p>Restart the application</p>
+            <div class="method-source-code" id="restart-source">
+<pre>
+<span class="ruby-comment"># File app/models/app.rb, line 83</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">restart</span>(<span class="ruby-identifier">app_name</span>)
+  <span class="ruby-identifier">ctl</span> = <span class="ruby-constant">Control</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">app_name</span>)
+  <span class="ruby-identifier">reply</span> = <span class="ruby-keyword">nil</span>
+  <span class="ruby-identifier">err_log</span> = <span class="ruby-keyword">nil</span>
+  <span class="ruby-keyword">begin</span>
+    <span class="ruby-identifier">reply</span>, <span class="ruby-identifier">err_log</span> = <span class="ruby-identifier">ctl</span>.<span class="ruby-identifier">restart</span>
+  <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+    <span class="ruby-identifier">reply</span> = <span class="ruby-node">&quot;An error occurred while sending 'restart' request for application '#{app_name}'. Please refer the '/var/log/webroar/#{app_name}.log' file for details.&quot;</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-keyword">return</span> <span class="ruby-identifier">reply</span>, <span class="ruby-identifier">err_log</span>
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- restart-source -->
+          </div>
+        </div><!-- restart-method -->
+        <div id="start-method" class="method-detail ">
+          <a name="method-c-start"></a>
+          <div class="method-heading">
+            <span class="method-name">start</span><span
+              class="method-args">(app_name)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <div class="method-description">
+            <p>Start the application</p>
+            <div class="method-source-code" id="start-source">
+<pre>
+<span class="ruby-comment"># File app/models/app.rb, line 54</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">start</span>(<span class="ruby-identifier">app_name</span>)
+  <span class="ruby-identifier">ctl</span> = <span class="ruby-constant">Control</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">app_name</span>)
+  <span class="ruby-identifier">reply</span> = <span class="ruby-keyword">nil</span>
+  <span class="ruby-comment">#err_obj = nil</span>
+  <span class="ruby-identifier">err_log</span> = <span class="ruby-keyword">nil</span>
+  <span class="ruby-keyword">begin</span>
+    <span class="ruby-identifier">reply</span>, <span class="ruby-identifier">err_log</span> = <span class="ruby-identifier">ctl</span>.<span class="ruby-identifier">add</span>
+  <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+    <span class="ruby-comment">#err_obj = e</span>
+    <span class="ruby-identifier">reply</span> = <span class="ruby-node">&quot;An error occurred while sending 'start' request for application '#{app_name}'. Please refer the '/var/log/webroar/#{app_name}.log' file for details.&quot;</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-comment">#return reply, e</span>
+  <span class="ruby-keyword">return</span> <span class="ruby-identifier">reply</span>, <span class="ruby-identifier">err_log</span>
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- start-source -->
+          </div>
+        </div><!-- start-method -->
+        <div id="stop-method" class="method-detail ">
+          <a name="method-c-stop"></a>
+          <div class="method-heading">
+            <span class="method-name">stop</span><span
+              class="method-args">(app_name)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <div class="method-description">
+            <p>Stop the application</p>
+            <div class="method-source-code" id="stop-source">
+<pre>
+<span class="ruby-comment"># File app/models/app.rb, line 70</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">stop</span>(<span class="ruby-identifier">app_name</span>)
+  <span class="ruby-identifier">ctl</span> = <span class="ruby-constant">Control</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">app_name</span>)
+  <span class="ruby-identifier">reply</span> = <span class="ruby-keyword">nil</span>
+  <span class="ruby-identifier">err_log</span> = <span class="ruby-keyword">nil</span>
+  <span class="ruby-keyword">begin</span>
+    <span class="ruby-identifier">reply</span>, <span class="ruby-identifier">err_log</span> = <span class="ruby-identifier">ctl</span>.<span class="ruby-identifier">delete</span>
+  <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+    <span class="ruby-identifier">reply</span> = <span class="ruby-node">&quot;An error occurred while sending 'stop' request for application '#{app_name}'. Please refer the '/var/log/webroar/#{app_name}.log' file for details.&quot;</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-keyword">return</span> <span class="ruby-identifier">reply</span>, <span class="ruby-identifier">err_log</span>
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- stop-source -->
+          </div>
+        </div><!-- stop-method -->
+      </div><!-- public-class-method-details -->
+    </div><!-- 5Buntitled-5D -->
+  </div><!-- documentation -->
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+</body>
+</html>