RubyGems - moonrope - Versions diffs - 2.0.1 → 2.0.2 - Mend

moonrope 2.0.1 → 2.0.2

Files changed (30) hide show

checksums.yaml +5 -5
data/Gemfile.lock +6 -6
data/lib/moonrope/base.rb +26 -0
data/lib/moonrope/rack_middleware.rb +29 -14
data/lib/moonrope/request.rb +8 -0
data/lib/moonrope/structure.rb +2 -2
data/lib/moonrope/structure_attribute.rb +1 -1
data/lib/moonrope/version.rb +1 -1
data/moonrope.gemspec +2 -2
data/templates/basic/_action_form.erb +1 -1
data/test/tests/rack_middleware_test.rb +14 -0
data/test/tests/structures_test.rb +8 -0
metadata +11 -30
data/html/assets/lock.svg +0 -3
data/html/assets/reset.css +0 -101
data/html/assets/style.css +0 -348
data/html/assets/tool.svg +0 -4
data/html/assets/try.js +0 -151
data/html/authenticators/default.html +0 -191
data/html/controllers/meta.html +0 -73
data/html/controllers/meta/version.html +0 -144
data/html/controllers/users.html +0 -93
data/html/controllers/users/create.html +0 -341
data/html/controllers/users/list.html +0 -348
data/html/controllers/users/show.html +0 -261
data/html/controllers/users/update.html +0 -387
data/html/index.html +0 -166
data/html/moonrope.txt +0 -0
data/html/structures/pet.html +0 -176
data/html/structures/user.html +0 -338

data/html/index.html DELETED

@@ -1,166 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Welcome - 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="active">
-              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="">
-              Users API
-            </a>
-          </li>
-        </ul>
-      </nav>
-    </section>
-    <section class='content'>
-<h1>Welcome to our API documentation</h1>
-<p class='text'>
-  From here you can browse the full documentation for our HTTP
-  API. Our API is split into sections which you can browse using
-  the menu on the right. If you have any questions, you can
-  <a href='#'>contact our team</a> and we'll be happy to help out.
-</p>
-<p class='text'>
-  Before you get started, take a few minutes to review the
-  information below about how to interact with our API. It includes
-  information about how to send requests, what response data is
-  sent in and how to handle errors.
-</p>
-<h2>Making requests</h2>
-<p class='text'>
-  Our API works over the HTTP protocol with JSON. It is implemented
-  in an RPC-like manner and everything you can do with the API has
-  its own <em>action</em>.
-</p>
-<p class='text'>
-  All HTTP requests must be made over HTTPS to the URL shown on the
-  action's page in this documentation. All responses you receive from
-  the API will be returned in JSON. Requests should be made using the
-  <code>POST</code> method with any parameters encoded as JSON in the
-  body of the request.
-</p>
-<h2>Receiving responses</h2>
-<p class='text'>
-  All responses will be returned to you encoded as JSON. You will always
-  receive a hash as the response which will look like the JSON below:
-</p>
-<pre class='code'>
-{
-  <span class='jsonKey'>"status"</span>:<span class='jsonString'>"success"</span>,
-  <span class='jsonKey'>"time"</span>:<span class='jsonString'>0.123</span>,
-  <span class='jsonKey'>"flags"</span>:{
-    <span class='jsonComment'>... additional information about the request ...</span>
-  },
-  <span class='jsonKey'>"data"</span>:{
-    <span class='jsonComment'>... the data returned from the action ...</span>
-  }
-}
-</pre>
-<p class='text'>
-  The <b>status</b> attribute will give you can indication about whether the
-  request was performed successfully or whether an error occurred. Values which
-  may be returned are shown below:
-</p>
-<ul class='standardList'>
-  <li>
-    <code>success</code> - this means that the request completed successfully
-    and returned the data that was expected.
-  </li>
-  <li>
-    <code>parameter-error</code> - the parameters provided for the action are
-    not valid and should be revised.
-  </li>
-  <li>
-    <code>error</code> - an error occurred that didn't fit into the above categories.
-    This will be accompanied with an error code, a descriptive message and further
-    attributes which may be useful. The actual potential errors for each action are
-    shown in the documentation.
-  </li>
-</ul>
-<p class='text'>
-  The <b>time</b> attribute shows how long the request took to complete on the
-  server side.
-</p>
-<p class='text'>
-  The <b>flags</b> attribute contains a hash of additional attributes
-  which are relevant to your request. For example, if you receive an array of data
-  it may be paginated and this pagination data will be returned in this
-  hash.
-</p>
-<p class='text'>
-  The <b>data</b> attribute contains the result of your request. Depending on the
-  status, this will either contain the data requested or details of any
-  error which has occurred.
-</p>
-<h3>A note about HTTP status code</h3>
-<p class='text'>
-  The API does not generally use HTTP status codes to return information
-  about the outcome of a request. There are two supported statuses with
-  the API:
-</p>
-<ul class='standardList'>
-  <li>
-    <code>200 OK</code> - This is the code you'll usually receive.
-    It indicates that the response was successfully delivered and
-    returned to our service (although does not nessesary mean that
-    the action you were expecting was successful). Further status
-    information will be provided in the <code>status</code> attribute
-    on your response body.
-  </li>
-  <li>
-    <code>301 Moved Permanently</code> or <code>308 Permanent Redirect</code> -
-    This means that the API request should be sent to an alternative
-    URL. This may just mean you need to send your request using <code>https</code>
-    rather than <code>http</code> as the protocol.
-  </li>
-  <li>
-    <code>500 Internal Server Error</code> - This will be returned
-    when an error occurred within the API itself. This was not
-    anticipated by us and should be reported to us.
-  </li>
-  <li>
-    <code>503 Service Unavailable</code> - This will be returned if
-    API is currently unavailable for maintenance or other issue.
-  </li>
-</ul>
-    </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/moonrope.txt DELETED

File without changes

data/html/structures/pet.html DELETED

@@ -1,176 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Pet Structure - 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="">
-              Users API
-            </a>
-          </li>
-        </ul>
-      </nav>
-    </section>
-    <section class='content'>
-<h1>Pet Structure</h1>
-<h2>Base Attributes</h2>
-<table class='table paramTable'>
-  <thead>
-    <tr>
-      <th width="45%">Attribute</th>
-      <th width="20%">Type</th>
-      <th width="35%">Example</th>
-    </tr>
-  </thead>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>id</span>
-      </p>
-        <p class='paramTable__description'>The ID of the pet</p>
-    </td>
-    <td>Integer</td>
-    <td>
-        148
-    </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>name</span>
-      </p>
-        <p class='paramTable__description'>The name of the pet</p>
-    </td>
-    <td>String</td>
-    <td>
-        Fido
-    </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>color</span>
-      </p>
-        <p class='paramTable__description'>What color is the pet?</p>
-    </td>
-    <td>String</td>
-    <td>
-        Green
-    </td>
-  </tr>
-</table>
-<h2>Expansions</h2>
-<p class='text'>
-  Expansions are embedded structures of other objects that are related to the structure
-  that you're viewing. Which expansions are returned by a specific action are shown on that
-  action's documentation however some actions allow you to choose which expansions are
-  returned.
-</p>
-<table class='table paramTable'>
-  <thead>
-    <tr>
-      <th width="45%">Attribute</th>
-      <th width="20%">Type</th>
-      <th width="35%">Example</th>
-    </tr>
-  </thead>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>user</span>
-      </p>
-        <p class='paramTable__description'>The user who owns this pet</p>
-    </td>
-    <td>Hash</td>
-    <td>
-        <a class='link' href="../structures/user.html">User structure</a>
-    </td>
-  </tr>
-</table>
-    </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/structures/user.html DELETED

@@ -1,338 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>User Structure - 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="">
-              Users API
-            </a>
-          </li>
-        </ul>
-      </nav>
-    </section>
-    <section class='content'>
-<h1>User Structure</h1>
-<h2>Base Attributes</h2>
-<table class='table paramTable'>
-  <thead>
-    <tr>
-      <th width="45%">Attribute</th>
-      <th width="20%">Type</th>
-      <th width="35%">Example</th>
-    </tr>
-  </thead>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>id</span>
-      </p>
-        <p class='paramTable__description'>The user's internal system ID</p>
-    </td>
-    <td>Integer</td>
-    <td>
-        123
-    </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>username</span>
-      </p>
-        <p class='paramTable__description'>The user's unique username</p>
-    </td>
-    <td>String</td>
-    <td>
-        adamcooke
-    </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>name.first</span>
-      </p>
-        <p class='paramTable__description'>The user's first name</p>
-    </td>
-    <td>String</td>
-    <td>
-        Adam
-    </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>name.last</span>
-      </p>
-        <p class='paramTable__description'>The user's last name</p>
-    </td>
-    <td>String</td>
-    <td>
-        Cooke
-    </td>
-  </tr>
-</table>
-<h2>Extended Attributes</h2>
-<table class='table paramTable'>
-  <thead>
-    <tr>
-      <th width="45%">Attribute</th>
-      <th width="20%">Type</th>
-      <th width="35%">Example</th>
-    </tr>
-  </thead>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>admin</span>
-      </p>
-        <p class='paramTable__description'>Is this user an administrator?</p>
-    </td>
-    <td>Boolean</td>
-    <td>
-        false
-    </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>created_at</span>
-      </p>
-        <p class='paramTable__description'>The timestamp the user was created</p>
-    </td>
-    <td>Timestamp</td>
-    <td>
-        2016-12-25 09:42:00 +0000
-    </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>updated_at</span>
-      </p>
-        <p class='paramTable__description'>The timestamp the user was updated</p>
-    </td>
-    <td>Timestamp</td>
-    <td>
-        2016-12-25 09:42:00 +0000
-    </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>support_pin</span>
-      </p>
-        <p class='paramTable__description'>The PIN this user needs to use to access support</p>
-        <ul class='paramTable__restrictedList'>
-          <li>Can only be accessed by API users with admin access</li>
-        </ul>
-    </td>
-    <td>String</td>
-    <td>
-        4953
-    </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>mask</span>
-      </p>
-        <p class='paramTable__description'>The unique mask that represents this user</p>
-        <ul class='paramTable__restrictedList'>
-          <li>Must not be authenticated (no auth headers provided).</li>
-        </ul>
-    </td>
-    <td>String</td>
-    <td>
-        abc123abc123
-    </td>
-  </tr>
-</table>
-<h2>Expansions</h2>
-<p class='text'>
-  Expansions are embedded structures of other objects that are related to the structure
-  that you're viewing. Which expansions are returned by a specific action are shown on that
-  action's documentation however some actions allow you to choose which expansions are
-  returned.
-</p>
-<table class='table paramTable'>
-  <thead>
-    <tr>
-      <th width="45%">Attribute</th>
-      <th width="20%">Type</th>
-      <th width="35%">Example</th>
-    </tr>
-  </thead>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>pets</span>
-      </p>
-        <p class='paramTable__description'>All pets that belong to this user</p>
-    </td>
-    <td>Array</td>
-    <td>
-        <a class='link' href="../structures/pet.html">Pet structure</a>
-    </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-        <span class='paramTable__name'>balance</span>
-      </p>
-        <p class='paramTable__description'>The user's balance</p>
-    </td>
-    <td>Float</td>
-    <td>12.5</td>
-  </tr>
-</table>
-    </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>