RubyGems - moonrope - Versions diffs - 1.4.1 → 2.0.0 - Mend

moonrope 1.4.1 → 2.0.0

Files changed (95) hide show

checksums.yaml +4 -4
data/Gemfile +9 -0
data/Gemfile.lock +47 -0
data/MIT-LICENCE +20 -0
data/README.md +24 -0
data/bin/moonrope +28 -0
data/docs/authentication.md +114 -0
data/docs/controllers.md +106 -0
data/docs/exceptions.md +27 -0
data/docs/introduction.md +29 -0
data/docs/structures.md +214 -0
data/example/authentication.rb +50 -0
data/example/controllers/meta_controller.rb +14 -0
data/example/controllers/users_controller.rb +92 -0
data/example/structures/pet_structure.rb +12 -0
data/example/structures/user_structure.rb +35 -0
data/html/assets/lock.svg +3 -0
data/html/assets/reset.css +101 -0
data/html/assets/style.css +348 -0
data/html/assets/tool.svg +4 -0
data/html/assets/try.js +151 -0
data/html/authenticators/default.html +191 -0
data/html/controllers/meta/version.html +144 -0
data/html/controllers/meta.html +73 -0
data/html/controllers/users/create.html +341 -0
data/html/controllers/users/list.html +348 -0
data/html/controllers/users/show.html +261 -0
data/html/controllers/users/update.html +387 -0
data/html/controllers/users.html +93 -0
data/html/index.html +166 -0
data/html/moonrope.txt +0 -0
data/html/structures/pet.html +176 -0
data/html/structures/user.html +338 -0
data/lib/moonrope/action.rb +165 -37
data/lib/moonrope/authenticator.rb +39 -0
data/lib/moonrope/base.rb +24 -6
data/lib/moonrope/controller.rb +4 -2
data/lib/moonrope/doc_context.rb +94 -0
data/lib/moonrope/doc_server.rb +123 -0
data/lib/moonrope/dsl/action_dsl.rb +159 -9
data/lib/moonrope/dsl/authenticator_dsl.rb +31 -0
data/lib/moonrope/dsl/base_dsl.rb +21 -18
data/lib/moonrope/dsl/controller_dsl.rb +60 -9
data/lib/moonrope/dsl/filterable_dsl.rb +27 -0
data/lib/moonrope/dsl/structure_dsl.rb +27 -2
data/lib/moonrope/errors.rb +3 -0
data/lib/moonrope/eval_environment.rb +82 -3
data/lib/moonrope/eval_helpers/filter_helper.rb +82 -0
data/lib/moonrope/eval_helpers.rb +28 -5
data/lib/moonrope/guard.rb +35 -0
data/lib/moonrope/html_generator.rb +65 -0
data/lib/moonrope/param_set.rb +11 -1
data/lib/moonrope/rack_middleware.rb +1 -1
data/lib/moonrope/railtie.rb +31 -14
data/lib/moonrope/request.rb +25 -14
data/lib/moonrope/structure.rb +74 -11
data/lib/moonrope/structure_attribute.rb +15 -0
data/lib/moonrope/version.rb +1 -1
data/lib/moonrope.rb +5 -4
data/moonrope.gemspec +21 -0
data/spec/spec_helper.rb +32 -0
data/spec/specs/action_spec.rb +455 -0
data/spec/specs/base_spec.rb +29 -0
data/spec/specs/controller_spec.rb +31 -0
data/spec/specs/param_set_spec.rb +31 -0
data/templates/basic/_action_form.erb +77 -0
data/templates/basic/_errors_table.erb +32 -0
data/templates/basic/_structure_attributes_list.erb +55 -0
data/templates/basic/action.erb +168 -0
data/templates/basic/assets/lock.svg +3 -0
data/templates/basic/assets/reset.css +101 -0
data/templates/basic/assets/style.css +348 -0
data/templates/basic/assets/tool.svg +4 -0
data/templates/basic/assets/try.js +151 -0
data/templates/basic/authenticator.erb +51 -0
data/templates/basic/controller.erb +20 -0
data/templates/basic/index.erb +114 -0
data/templates/basic/layout.erb +46 -0
data/templates/basic/structure.erb +23 -0
data/test/test_helper.rb +81 -0
data/test/tests/action_access_test.rb +63 -0
data/test/tests/actions_test.rb +524 -0
data/test/tests/authenticators_test.rb +87 -0
data/test/tests/base_test.rb +35 -0
data/test/tests/controllers_test.rb +49 -0
data/test/tests/eval_environment_test.rb +136 -0
data/test/tests/evel_helpers_test.rb +60 -0
data/test/tests/examples_test.rb +11 -0
data/test/tests/helpers_test.rb +97 -0
data/test/tests/param_set_test.rb +44 -0
data/test/tests/rack_middleware_test.rb +109 -0
data/test/tests/request_test.rb +232 -0
data/test/tests/structures_param_extensions_test.rb +159 -0
data/test/tests/structures_test.rb +335 -0
metadata +82 -48

data/html/controllers/users/create.html ADDED Viewed

@@ -0,0 +1,341 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Create a new user - Users API - API Documentation</title>
+    <link href='https://fonts.googleapis.com/css?family=Lato:400,700,900' rel='stylesheet' type='text/css'>
+    <link href='https://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
+    <link rel="stylesheet" href="../../assets/reset.css">
+    <link rel="stylesheet" href="../../assets/style.css">
+  </head>
+  <body>
+    <section class='sidebarBackground'></section>
+    <section class="sidebar">
+      <nav>
+        <ul>
+          <li>
+            <a href='../../index.html' class="">
+              Home
+            </a>
+          </li>
+          <li>
+            <a href='../../authenticators/default.html' class="">
+              Authentication
+            </a>
+          </li>
+          <li>
+            <a href='../../controllers/meta.html' class="">
+              Meta API
+            </a>
+          </li>
+          <li>
+            <a href='../../controllers/users.html' class="active">
+              Users API
+            </a>
+          </li>
+        </ul>
+      </nav>
+    </section>
+    <section class='content'>
+<h1>Create a new user</h1>
+<p class='text'>      This action will create a new user with the properties which have been provided.
+</p>
+<p class='tryFormActivate'><a class='tryFormActivate__button' href='#'>Try this request in your browser</a></p>
+<form class='tryForm'>
+  <input type='hidden' name='controller' value='users'>
+  <input type='hidden' name='action' value='create'>
+  <div class='tryForm__header'>
+    <input type='text' id='host' name='host' value=''>
+    /api/
+    <input type='text' id='version' name='version' value='v1' class='v'>
+    /users/create
+  </div>
+  <p class='tryForm__heading'>Headers</p>
+  <table class='tryForm__table'>
+    <tr>
+      <td width="50%"><code>X-Auth-Application</code></td>
+      <td width="50%"><input type='text' class='tryForm__tableField headerField' name='X-Auth-Application'></td>
+    </tr>
+    <tr>
+      <td width="50%"><code>X-Auth-Token</code></td>
+      <td width="50%"><input type='text' class='tryForm__tableField headerField' name='X-Auth-Token'></td>
+    </tr>
+  </table>
+  <p class='tryForm__heading'>Parameters</p>
+  <table class='tryForm__table'>
+    <tr>
+      <td width="30%"><code>username</code></td>
+      <td width="20%">String</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='username' placeholder='' data-type='String'></td>
+    </tr>
+    <tr>
+      <td width="30%"><code>first_name</code></td>
+      <td width="20%">String</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='first_name' placeholder='' data-type='String'></td>
+    </tr>
+    <tr>
+      <td width="30%"><code>last_name</code></td>
+      <td width="20%">String</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='last_name' placeholder='' data-type='String'></td>
+    </tr>
+    <tr>
+      <td width="30%"><code>email_address</code></td>
+      <td width="20%">String</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='email_address' placeholder='' data-type='String'></td>
+    </tr>
+    <tr>
+      <td width="30%"><code>password</code></td>
+      <td width="20%">String</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='password' placeholder='' data-type='String'></td>
+    </tr>
+    <tr>
+      <td width="30%"><code>admin</code></td>
+      <td width="20%">Boolean</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='admin' placeholder='' data-type='boolean'></td>
+    </tr>
+  </table>
+  <p class='tryForm__button'>
+    <button class='tryForm__buttonLink' type='submit'>Make this request</button>
+    <button class='tryForm__buttonLink tryFormCancel' type='button'>Cancel</button>
+  </p>
+  <pre class='tryForm__output'>The request output will be shown here...</pre>
+</form>
+<h2>URL</h2>
+<p class='apiURLFull'><span>/api/v1/</span>users/create</p>
+  <h2>Access</h2>
+  <p class='text'>
+    Must be authenticated with a valid user API token.
+    If not authorised, a <code>NotAuthenticated</code> error will be returned.
+  </p>
+<h2>Parameters</h2>
+  <table class='table paramTable'>
+    <thead>
+      <tr>
+        <th width="60%">Parameter</th>
+        <th width="20%">Type</th>
+        <th width="20%">Default</th>
+      </tr>
+    </thead>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>username</span>
+        </p>
+          <p class='paramTable__description'>The user's username</p>
+      </td>
+      <td>String</td>
+      <td>
+          <span class='paramTable__nil'>null</span>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>first_name</span>
+        </p>
+          <p class='paramTable__description'>The user's first name</p>
+      </td>
+      <td>String</td>
+      <td>
+          <span class='paramTable__nil'>null</span>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>last_name</span>
+        </p>
+          <p class='paramTable__description'>The user's last name</p>
+      </td>
+      <td>String</td>
+      <td>
+          <span class='paramTable__nil'>null</span>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>email_address</span>
+        </p>
+          <p class='paramTable__description'>The user's e-mail address</p>
+      </td>
+      <td>String</td>
+      <td>
+          <span class='paramTable__nil'>null</span>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>password</span>
+        </p>
+          <p class='paramTable__description'>The user's password</p>
+      </td>
+      <td>String</td>
+      <td>
+          <span class='paramTable__nil'>null</span>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>admin</span>
+        </p>
+          <p class='paramTable__description'>Should this user be an admin?</p>
+      </td>
+      <td>Boolean</td>
+      <td>
+          <span class='paramTable__nil'>null</span>
+      </td>
+    </tr>
+  </table>
+<h2>Errors</h2>
+  <table class='table errorsTable'>
+  <thead>
+    <tr>
+      <th width="60%">Error</th>
+      <th width="40%">Attributes</th>
+    </tr>
+  </thead>
+  <tr>
+    <td>
+      <p>
+        <span class='paramTable__name'>ValidationError</span>
+          <p class='paramTable__description'>The details provided were not sufficient to save the user</p>
+      </p>
+    </td>
+    <td>
+      <ul class='errorAttributeList'>
+        <li>
+          <p class='errorAttributeList__name'>errors</p>
+          <p class='errorAttributeList__desc'>An array of errors for each field</p>
+        </li>
+      </ul>
+    </td>
+  </tr>
+</table>
+<h2>Response Data</h2>
+    <p class='text'>This action will return a <a class='link' href='../../structures/user.html'>user structure</a>.</p>
+      You'll receive all attributes for this structure (basic and extended attributes).
+    </section>
+    <footer class='footer'>
+      <p>Generated by Moonrope at 12:43 on Monday 22 February 2016 for d3c499</p>
+    </footer>
+    <script src='https://code.jquery.com/jquery-1.12.0.min.js'></script>
+    <script src='../../assets/try.js'></script>
+  </body>
+</html>

data/html/controllers/users/list.html ADDED Viewed

@@ -0,0 +1,348 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>List all users - Users API - API Documentation</title>
+    <link href='https://fonts.googleapis.com/css?family=Lato:400,700,900' rel='stylesheet' type='text/css'>
+    <link href='https://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
+    <link rel="stylesheet" href="../../assets/reset.css">
+    <link rel="stylesheet" href="../../assets/style.css">
+  </head>
+  <body>
+    <section class='sidebarBackground'></section>
+    <section class="sidebar">
+      <nav>
+        <ul>
+          <li>
+            <a href='../../index.html' class="">
+              Home
+            </a>
+          </li>
+          <li>
+            <a href='../../authenticators/default.html' class="">
+              Authentication
+            </a>
+          </li>
+          <li>
+            <a href='../../controllers/meta.html' class="">
+              Meta API
+            </a>
+          </li>
+          <li>
+            <a href='../../controllers/users.html' class="active">
+              Users API
+            </a>
+          </li>
+        </ul>
+      </nav>
+    </section>
+    <section class='content'>
+<h1>List all users</h1>
+<p class='text'>This action will return a list of all users which the authenticated user has access to.</p>
+<p class='tryFormActivate'><a class='tryFormActivate__button' href='#'>Try this request in your browser</a></p>
+<form class='tryForm'>
+  <input type='hidden' name='controller' value='users'>
+  <input type='hidden' name='action' value='list'>
+  <div class='tryForm__header'>
+    <input type='text' id='host' name='host' value=''>
+    /api/
+    <input type='text' id='version' name='version' value='v1' class='v'>
+    /users/list
+  </div>
+  <p class='tryForm__heading'>Headers</p>
+  <table class='tryForm__table'>
+    <tr>
+      <td width="50%"><code>X-Auth-Application</code></td>
+      <td width="50%"><input type='text' class='tryForm__tableField headerField' name='X-Auth-Application'></td>
+    </tr>
+    <tr>
+      <td width="50%"><code>X-Auth-Token</code></td>
+      <td width="50%"><input type='text' class='tryForm__tableField headerField' name='X-Auth-Token'></td>
+    </tr>
+  </table>
+  <p class='tryForm__heading'>Parameters</p>
+  <table class='tryForm__table'>
+    <tr>
+      <td width="30%"><code>page</code></td>
+      <td width="20%">Integer</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='page' placeholder='1' data-type='Integer'></td>
+    </tr>
+    <tr>
+      <td width="30%"><code>per_page</code></td>
+      <td width="20%">Integer</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='per_page' placeholder='30' data-type='Integer'></td>
+    </tr>
+    <tr>
+      <td width="30%"><code>sort_by</code></td>
+      <td width="20%">String</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='sort_by' placeholder='username' data-type='String'></td>
+    </tr>
+    <tr>
+      <td width="30%"><code>order</code></td>
+      <td width="20%">String</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='order' placeholder='asc' data-type='String'></td>
+    </tr>
+    <tr>
+      <td width="30%"><code>filters</code></td>
+      <td width="20%">Hash</td>
+      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='filters' placeholder='{}' data-type='Hash'></td>
+    </tr>
+  </table>
+  <p class='tryForm__button'>
+    <button class='tryForm__buttonLink' type='submit'>Make this request</button>
+    <button class='tryForm__buttonLink tryFormCancel' type='button'>Cancel</button>
+  </p>
+  <pre class='tryForm__output'>The request output will be shown here...</pre>
+</form>
+<h2>URL</h2>
+<p class='apiURLFull'><span>/api/v1/</span>users/list</p>
+  <h2>Access</h2>
+  <p class='text'>
+    Must be authenticated with a valid user API token.
+    If not authorised, a <code>NotAuthenticated</code> error will be returned.
+  </p>
+<h2>Parameters</h2>
+  <table class='table paramTable'>
+    <thead>
+      <tr>
+        <th width="60%">Parameter</th>
+        <th width="20%">Type</th>
+        <th width="20%">Default</th>
+      </tr>
+    </thead>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>page</span>
+        </p>
+          <p class='paramTable__description'>The page number</p>
+      </td>
+      <td>Integer</td>
+      <td>
+          1
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>per_page</span>
+        </p>
+          <p class='paramTable__description'>The number of items to return per page</p>
+      </td>
+      <td>Integer</td>
+      <td>
+          30
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>sort_by</span>
+        </p>
+          <p class='paramTable__description'>The field to sort by</p>
+      </td>
+      <td>String</td>
+      <td>
+          username
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>order</span>
+        </p>
+          <p class='paramTable__description'>The direction to order units by</p>
+      </td>
+      <td>String</td>
+      <td>
+          asc
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'>filters</span>
+        </p>
+          <p class='paramTable__description'>A hash of filters to apply to results</p>
+      </td>
+      <td>Hash</td>
+      <td>
+          {}
+      </td>
+    </tr>
+  </table>
+<h2>Filtering</h2>
+<p class='text'>
+  This action supports filtering. You can filter the results which you receive by
+  providing filters in the <code>filters</code> parameter. The following attributes
+  are supported for filtering.
+</p>
+<table class='table paramTable'>
+  <thead>
+    <tr>
+      <th width="40%">Attribute</th>
+      <th width="60%">Supported Operators</th>
+    </tr>
+  </thead>
+  <tr>
+    <td><span class='paramTable__name'>username</span></td>
+    <td>eq, not_eq, starts_with, ends_with, in, not_in</td>
+  </tr>
+  <tr>
+    <td><span class='paramTable__name'>age</span></td>
+    <td>eq, not_eq, gt, gte, lt, lte, in, not_in</td>
+  </tr>
+  <tr>
+    <td><span class='paramTable__name'>admin</span></td>
+    <td>eq, not_eq</td>
+  </tr>
+</table>
+<h2>Errors</h2>
+  <table class='table errorsTable'>
+  <thead>
+    <tr>
+      <th width="60%">Error</th>
+      <th width="40%">Attributes</th>
+    </tr>
+  </thead>
+  <tr>
+    <td>
+      <p>
+        <span class='paramTable__name'>FilterError</span>
+          <p class='paramTable__description'>An error has occurred while processing filters for this action</p>
+      </p>
+    </td>
+    <td>
+      <ul class='errorAttributeList'>
+        <li>
+          <p class='errorAttributeList__name'>issue_code</p>
+          <p class='errorAttributeList__desc'>A more specific issue code</p>
+        </li>
+        <li>
+          <p class='errorAttributeList__name'>issue_message</p>
+          <p class='errorAttributeList__desc'>A more specific message about the issue</p>
+        </li>
+      </ul>
+    </td>
+  </tr>
+</table>
+<h2>Response Data</h2>
+    <p class='text'>This action will return an array of <a class='link' href='../../structures/user.html'>user structures</a>.</p>
+    You'll receive just the basic attributes for this structure. No expansions are provided.
+    </section>
+    <footer class='footer'>
+      <p>Generated by Moonrope at 12:43 on Monday 22 February 2016 for d3c499</p>
+    </footer>
+    <script src='https://code.jquery.com/jquery-1.12.0.min.js'></script>
+    <script src='../../assets/try.js'></script>
+  </body>
+</html>