RubyGems - apes - Versions diffs - 1.0.0 - Mend

apes 1.0.0

Files changed (122) hide show

checksums.yaml +7 -0
data/.gitignore +7 -0
data/.rubocop.yml +82 -0
data/.travis-gemfile +15 -0
data/.travis.yml +15 -0
data/.yardopts +1 -0
data/CHANGELOG.md +3 -0
data/Gemfile +22 -0
data/README.md +177 -0
data/Rakefile +44 -0
data/apes.gemspec +34 -0
data/doc/Apes.html +130 -0
data/doc/Apes/Concerns.html +127 -0
data/doc/Apes/Concerns/Errors.html +1089 -0
data/doc/Apes/Concerns/Pagination.html +636 -0
data/doc/Apes/Concerns/Request.html +766 -0
data/doc/Apes/Concerns/Response.html +940 -0
data/doc/Apes/Controller.html +1100 -0
data/doc/Apes/Errors.html +125 -0
data/doc/Apes/Errors/AuthenticationError.html +133 -0
data/doc/Apes/Errors/BadRequestError.html +157 -0
data/doc/Apes/Errors/BaseError.html +320 -0
data/doc/Apes/Errors/InvalidDataError.html +157 -0
data/doc/Apes/Errors/MissingDataError.html +157 -0
data/doc/Apes/Model.html +378 -0
data/doc/Apes/PaginationCursor.html +2138 -0
data/doc/Apes/RuntimeConfiguration.html +909 -0
data/doc/Apes/Serializers.html +125 -0
data/doc/Apes/Serializers/JSON.html +389 -0
data/doc/Apes/Serializers/JWT.html +452 -0
data/doc/Apes/Serializers/List.html +347 -0
data/doc/Apes/UrlsParser.html +1432 -0
data/doc/Apes/Validators.html +125 -0
data/doc/Apes/Validators/BaseValidator.html +278 -0
data/doc/Apes/Validators/BooleanValidator.html +494 -0
data/doc/Apes/Validators/EmailValidator.html +350 -0
data/doc/Apes/Validators/PhoneValidator.html +375 -0
data/doc/Apes/Validators/ReferenceValidator.html +372 -0
data/doc/Apes/Validators/TimestampValidator.html +640 -0
data/doc/Apes/Validators/UuidValidator.html +372 -0
data/doc/Apes/Validators/ZipCodeValidator.html +372 -0
data/doc/Apes/Version.html +189 -0
data/doc/ApplicationController.html +547 -0
data/doc/Concerns.html +128 -0
data/doc/Concerns/ErrorHandling.html +826 -0
data/doc/Concerns/PaginationHandling.html +463 -0
data/doc/Concerns/RequestHandling.html +512 -0
data/doc/Concerns/ResponseHandling.html +579 -0
data/doc/Errors.html +126 -0
data/doc/Errors/AuthenticationError.html +123 -0
data/doc/Errors/BadRequestError.html +147 -0
data/doc/Errors/BaseError.html +289 -0
data/doc/Errors/InvalidDataError.html +147 -0
data/doc/Errors/MissingDataError.html +147 -0
data/doc/Model.html +315 -0
data/doc/PaginationCursor.html +764 -0
data/doc/Serializers.html +126 -0
data/doc/Serializers/JSON.html +253 -0
data/doc/Serializers/JWT.html +253 -0
data/doc/Serializers/List.html +245 -0
data/doc/Validators.html +126 -0
data/doc/Validators/BaseValidator.html +209 -0
data/doc/Validators/BooleanValidator.html +391 -0
data/doc/Validators/EmailValidator.html +298 -0
data/doc/Validators/PhoneValidator.html +313 -0
data/doc/Validators/ReferenceValidator.html +284 -0
data/doc/Validators/TimestampValidator.html +476 -0
data/doc/Validators/UuidValidator.html +310 -0
data/doc/Validators/ZipCodeValidator.html +310 -0
data/doc/_index.html +435 -0
data/doc/class_list.html +58 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +339 -0
data/doc/file.README.html +252 -0
data/doc/file_list.html +60 -0
data/doc/frames.html +26 -0
data/doc/index.html +252 -0
data/doc/js/app.js +219 -0
data/doc/js/full_list.js +181 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +615 -0
data/doc/top-level-namespace.html +112 -0
data/lib/apes.rb +40 -0
data/lib/apes/concerns/errors.rb +111 -0
data/lib/apes/concerns/pagination.rb +81 -0
data/lib/apes/concerns/request.rb +237 -0
data/lib/apes/concerns/response.rb +74 -0
data/lib/apes/controller.rb +77 -0
data/lib/apes/errors.rb +38 -0
data/lib/apes/model.rb +94 -0
data/lib/apes/pagination_cursor.rb +152 -0
data/lib/apes/runtime_configuration.rb +80 -0
data/lib/apes/serializers.rb +88 -0
data/lib/apes/urls_parser.rb +233 -0
data/lib/apes/validators.rb +234 -0
data/lib/apes/version.rb +24 -0
data/spec/apes/concerns/errors_spec.rb +141 -0
data/spec/apes/concerns/pagination_spec.rb +114 -0
data/spec/apes/concerns/request_spec.rb +244 -0
data/spec/apes/concerns/response_spec.rb +79 -0
data/spec/apes/controller_spec.rb +54 -0
data/spec/apes/errors_spec.rb +14 -0
data/spec/apes/models_spec.rb +148 -0
data/spec/apes/pagination_cursor_spec.rb +113 -0
data/spec/apes/runtime_configuration_spec.rb +100 -0
data/spec/apes/serializers_spec.rb +70 -0
data/spec/apes/urls_parser_spec.rb +150 -0
data/spec/apes/validators_spec.rb +237 -0
data/spec/spec_helper.rb +30 -0
data/views/_included.json.jbuilder +9 -0
data/views/_pagination.json.jbuilder +9 -0
data/views/collection.json.jbuilder +4 -0
data/views/errors/400.json.jbuilder +9 -0
data/views/errors/403.json.jbuilder +7 -0
data/views/errors/404.json.jbuilder +6 -0
data/views/errors/422.json.jbuilder +19 -0
data/views/errors/500.json.jbuilder +12 -0
data/views/errors/501.json.jbuilder +7 -0
data/views/layouts/general.json.jbuilder +36 -0
data/views/object.json.jbuilder +4 -0
metadata +262 -0

data/doc/Apes/RuntimeConfiguration.html ADDED

@@ -0,0 +1,909 @@
+<!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: Apes::RuntimeConfiguration
+    &mdash; 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#!Apes/RuntimeConfiguration.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 (R)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Apes.html" title="Apes (module)">Apes</a></span></span>
+     &raquo;
+    <span class="title">RuntimeConfiguration</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: Apes::RuntimeConfiguration
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">Apes::RuntimeConfiguration</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/apes/runtime_configuration.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Internal class to handle runtime configuration.</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="#cors_source-class_method" title="cors_source (class method)">+ (String) <strong>cors_source</strong>(default = &quot;localhost&quot;) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the CORS source used by Apes.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#development%3F-class_method" title="development? (class method)">+ (Boolean) <strong>development?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Check if Rails is in development environment.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#environment-class_method" title="environment (class method)">+ (String) <strong>environment</strong>(default = &quot;development&quot;) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the current Rails environment.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#gems_root-class_method" title="gems_root (class method)">+ (String) <strong>gems_root</strong>(default = nil) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the current RubyGems root directory.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#jwt_token-class_method" title="jwt_token (class method)">+ (String) <strong>jwt_token</strong>(default = &quot;secret&quot;) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the JWT token used by Apes.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#rails_root-class_method" title="rails_root (class method)">+ (String) <strong>rails_root</strong>(default = nil) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the current Rails root directory.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#root-class_method" title="root (class method)">+ (String) <strong>root</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns the root directory of apes.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#timestamp_formats-class_method" title="timestamp_formats (class method)">+ (Hash) <strong>timestamp_formats</strong>(default = {}) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Returns a map where keys are tags and values are strftime compliant formats.</p>
+</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="cors_source-class_method">
+    + (<tt>String</tt>) <strong>cors_source</strong>(default = &quot;localhost&quot;)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the CORS source used by Apes. This should be defined in the Rails secrets.yml file.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>default</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>&quot;localhost&quot;</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The fallback if no valid CORS source is found in Rails secrets file.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The CORS source used by Apes.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+59
+60
+61</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/runtime_configuration.rb', line 59</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_cors_source'>cors_source</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>localhost</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_fetch_with_fallback'>fetch_with_fallback</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</span><span class='period'>.</span><span class='id identifier rubyid_secrets'>secrets</span><span class='period'>.</span><span class='id identifier rubyid_cors_source'>cors_source</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="development?-class_method">
+    + (<tt>Boolean</tt>) <strong>development?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Check if Rails is in development environment.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p><code>true</code> if Rails is in <code>development</code> environment, <code>false</code> otherwise.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+43
+44
+45</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/runtime_configuration.rb', line 43</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_development?'>development?</span>
+  <span class='id identifier rubyid_environment'>environment</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>development</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="environment-class_method">
+    + (<tt>String</tt>) <strong>environment</strong>(default = &quot;development&quot;)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the current Rails environment.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>default</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>&quot;development&quot;</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The fallback environment if Rails configuration is invalid.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The the current Rails environment.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+36
+37
+38</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/runtime_configuration.rb', line 36</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_environment'>environment</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>development</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_fetch_with_fallback'>fetch_with_fallback</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_env'>env</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="gems_root-class_method">
+    + (<tt>String</tt>) <strong>gems_root</strong>(default = nil)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the current RubyGems root directory.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>default</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The fallback if RubyGems configuration is invalid.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The current RubyGems root directory.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+28
+29
+30</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/runtime_configuration.rb', line 28</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_gems_root'>gems_root</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_fetch_with_fallback'>fetch_with_fallback</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Gem</span><span class='period'>.</span><span class='id identifier rubyid_loaded_specs'>loaded_specs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>lazier</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_full_gem_path'>full_gem_path</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</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 class="method_details ">
+  <h3 class="signature " id="jwt_token-class_method">
+    + (<tt>String</tt>) <strong>jwt_token</strong>(default = &quot;secret&quot;)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the JWT token used by Apes. This should be defined in the Rails secrets.yml file.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>default</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>&quot;secret&quot;</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The fallback if no valid secret is found in Rails secrets file.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The JWT token used by Apes.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+51
+52
+53</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/runtime_configuration.rb', line 51</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_jwt_token'>jwt_token</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>secret</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_fetch_with_fallback'>fetch_with_fallback</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</span><span class='period'>.</span><span class='id identifier rubyid_secrets'>secrets</span><span class='period'>.</span><span class='id identifier rubyid_jwt'>jwt</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="rails_root-class_method">
+    + (<tt>String</tt>) <strong>rails_root</strong>(default = nil)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the current Rails root directory.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>default</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The fallback if Rails configuration is invalid.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The current Rails root directory.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/runtime_configuration.rb', line 20</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_rails_root'>rails_root</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_fetch_with_fallback'>fetch_with_fallback</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</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 class="method_details ">
+  <h3 class="signature " id="root-class_method">
+    + (<tt>String</tt>) <strong>root</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the root directory of apes.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+12
+13
+14</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/runtime_configuration.rb', line 12</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_root'>root</span>
+  <span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Gem</span><span class='period'>.</span><span class='id identifier rubyid_loaded_specs'>loaded_specs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>apes</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_full_gem_path'>full_gem_path</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="timestamp_formats-class_method">
+    + (<tt>Hash</tt>) <strong>timestamp_formats</strong>(default = {})
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns a map where keys are tags and values are strftime compliant formats.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>default</span>
+        <span class='type'>(<tt>String</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The fallback if no valid configuration is found in Rails.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'><p>A object describing valid timestamps formats.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+67
+68
+69</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/runtime_configuration.rb', line 67</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_timestamp_formats'>timestamp_formats</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_fetch_with_fallback'>fetch_with_fallback</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_timestamp_formats'>timestamp_formats</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Sat Jun  4 12:41:54 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.3.0).
+</div>
+  </body>
+</html>