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/Validators/EmailValidator.html ADDED

@@ -0,0 +1,350 @@
+<!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::Validators::EmailValidator
+    &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/Validators/EmailValidator.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 (E)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../Apes.html" title="Apes (module)">Apes</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Validators.html" title="Apes::Validators (module)">Validators</a></span></span>
+     &raquo;
+    <span class="title">EmailValidator</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::Validators::EmailValidator
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="BaseValidator.html" title="Apes::Validators::BaseValidator (class)">BaseValidator</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">ActiveModel::EachValidator</li>
+            <li class="next"><span class='object_link'><a href="BaseValidator.html" title="Apes::Validators::BaseValidator (class)">BaseValidator</a></span></li>
+            <li class="next">Apes::Validators::EmailValidator</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/apes/validators.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Validates email.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+    <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_valid%3F-instance_method" title="#check_valid? (instance method)">- (Boolean) <strong>check_valid?</strong>(value) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Checks if the value is valid for this validator.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Apes::Validators::EmailValidator) <strong>initialize</strong>(options) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new validator.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseValidator.html" title="Apes::Validators::BaseValidator (class)">BaseValidator</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseValidator.html#validate_each-instance_method" title="Apes::Validators::BaseValidator#validate_each (method)">#validate_each</a></span></p>
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="Apes::Validators::EmailValidator (class)">Apes::Validators::EmailValidator</a></span></tt>) <strong>initialize</strong>(options)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new validator.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>options</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The options for the validations.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+91
+92
+93</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/validators.rb', line 91</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+  <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_reverse_merge'>reverse_merge</span><span class='lparen'>(</span><span class='label'>default_message:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>must be a valid email</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</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_valid?-instance_method">
+    - (<tt>Boolean</tt>) <strong>check_valid?</strong>(value)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Checks if the value is valid for this validator.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>value</span>
+        <span class='type'>(<tt>Object</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The value to validate.</p>
+</div>
+    </li>
+</ul>
+<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 the value is valid, false otherwise.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+99
+100
+101</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/validators.rb', line 99</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_check_valid?'>check_valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='op'>||</span> <span class='const'>UrlsParser</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_email?'>email?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Sat Jun  4 12:41:53 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>

data/doc/Apes/Validators/PhoneValidator.html ADDED

@@ -0,0 +1,375 @@
+<!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::Validators::PhoneValidator
+    &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/Validators/PhoneValidator.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 (P)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../Apes.html" title="Apes (module)">Apes</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Validators.html" title="Apes::Validators (module)">Validators</a></span></span>
+     &raquo;
+    <span class="title">PhoneValidator</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::Validators::PhoneValidator
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="BaseValidator.html" title="Apes::Validators::BaseValidator (class)">BaseValidator</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">ActiveModel::EachValidator</li>
+            <li class="next"><span class='object_link'><a href="BaseValidator.html" title="Apes::Validators::BaseValidator (class)">BaseValidator</a></span></li>
+            <li class="next">Apes::Validators::PhoneValidator</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/apes/validators.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Validates phones.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="VALID_REGEX-constant" class="">VALID_REGEX =
+          <div class="docstring">
+  <div class="discussion">
+    <p>The pattern to recognize valid phones.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^(
+  ((\+|00)\d)? # International prefix
+  ([0-9\-\s\/\(\)]{7,}) # All the rest
+)$</span><span class='regexp_end'>/mx</span></span></pre></dd>
+    </dl>
+    <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_valid%3F-instance_method" title="#check_valid? (instance method)">- (Boolean) <strong>check_valid?</strong>(value) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Checks if the value is valid for this validator.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Apes::Validators::PhoneValidator) <strong>initialize</strong>(options) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new validator.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseValidator.html" title="Apes::Validators::BaseValidator (class)">BaseValidator</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseValidator.html#validate_each-instance_method" title="Apes::Validators::BaseValidator#validate_each (method)">#validate_each</a></span></p>
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="Apes::Validators::PhoneValidator (class)">Apes::Validators::PhoneValidator</a></span></tt>) <strong>initialize</strong>(options)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Creates a new validator.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>options</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The options for the validations.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+145
+146
+147</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/validators.rb', line 145</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+  <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_reverse_merge'>reverse_merge</span><span class='lparen'>(</span><span class='label'>default_message:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>must be a valid phone</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</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_valid?-instance_method">
+    - (<tt>Boolean</tt>) <strong>check_valid?</strong>(value)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Checks if the value is valid for this validator.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>value</span>
+        <span class='type'>(<tt>Object</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The value to validate.</p>
+</div>
+    </li>
+</ul>
+<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 the value is valid, false otherwise.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+153
+154
+155</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/apes/validators.rb', line 153</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_check_valid?'>check_valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='op'>||</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>=~</span> <span class='const'>VALID_REGEX</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>