moonrope 1.4.1 → 2.0.0

data/html/assets/try.js

@@ -0,0 +1,151 @@
+$(document).ready(function() {
+
+  $form = $('form.tryForm')
+
+  // Get all fields which will be added as headers
+  var headerFields = $('input.headerField', $form)
+
+  // Add stored values to header fields
+  if(typeof(Storage) !== "undefined") {
+    headerFields.each(function() {
+      $field = $(this)
+      $field.val(localStorage.getItem("header__" + $(this).attr('name')))
+    })
+
+  }
+
+
+  //
+  // Form submission
+  //
+  $form.on('submit', function() {
+
+    // Gets values used to make up the URL which should be
+    // requested for this request.
+    var host = $("input[name=host]", $(this)).val()
+    var version = $("input[name=version]", $(this)).val()
+    var controller = $("input[name=controller]", $(this)).val()
+    var action = $("input[name=action]", $(this)).val()
+    var url = host + "/api/" + version + "/" + controller + "/" + action
+    // Get the output box ready for use
+    var outputBox = $('.tryForm__output', $(this))
+    // Create a hash fo all parameters which will be submitted
+    var parameters = {}
+    $('input.paramField').each(function(){
+      $this = $(this)
+      value = $this.val()
+      type = $this.data('type')
+      name = $this.attr('name')
+      if(value.length) {
+        if(type == 'Integer') {
+          parameters[name] = parseInt(value);
+        } else if (type == "Hash" || type == "Array") {
+          parameters[name] = JSON.parse(value);
+        } else {
+          parameters[name] = value;
+        }
+      }
+    });
+
+    // Include/exclude full attributes as needed
+    var fullAttrsCheckbox = $('#full_attrs')
+    if(fullAttrsCheckbox.length) {
+      parameters['_full'] = !!fullAttrsCheckbox.prop('checked')
+    }
+
+    // Include/exclude expansions
+    var expansionCheckboxes = $('.tryForm__expansions')
+    if(expansionCheckboxes.length) {
+      parameters['_expansions'] = []
+      expansionCheckboxes.each(function() {
+        $this = $(this)
+        name = $(this).attr('name')
+        if($(this).prop('checked')) {
+          parameters['_expansions'].push(name)
+        }
+      })
+    }
+
+    // Make the AJAX request
+    $.ajax({
+      url: url,
+      method: 'POST',
+      contentType: 'application/json',
+      data: JSON.stringify(parameters),
+      beforeSend: function(xhr) {
+        // Add any headers which have been added
+        headerFields.each(function() {
+          $field = $(this)
+          name = $field.attr('name')
+          value = $field.val()
+          if(typeof(Storage) !== "undefined") {
+            localStorage.setItem("header__" + name, value)
+          }
+          if(value.length) {
+            xhr.setRequestHeader(name, $field.val())
+          }
+        })
+      },
+      success: function(data) {
+        // Success means that we got a 200 OK which means we can be pretty
+        // sure that we've got a moonrope response.
+        if(data.status == "success") {
+          outputBox.addClass('tryForm__output--success').removeClass('tryForm__output--error')
+        } else {
+          outputBox.addClass('tryForm__output--error').removeClass('tryForm__output--success')
+        }
+        outputBox.text(JSON.stringify(data, null, 4))
+        outputBox.show()
+      },
+      error: function() {
+        // Errors which occurr aren't very well reported at the moment.
+        // They should be.
+        outputBox.show()
+        outputBox.text("Failed to make request.")
+        outputBox.addClass('tryForm__output--error').removeClass('tryForm__output--success')
+      }
+    })
+    return false
+  });
+
+  //
+  // Open the try form
+  //
+  $('p.tryFormActivate a').on('click', function() {
+    $form = $('form.tryForm')
+    $parent = $(this).parents('p')
+    $form.show('fast')
+    $parent.hide()
+    return false
+  });
+
+  //
+  // Close the try form
+  //
+  $('button.tryFormCancel').on('click', function() {
+    $form = $('form.tryForm')
+    $parent = $('p.tryFormActivate')
+    $form.hide()
+    $parent.show()
+    return false
+  });
+
+  // http://stackoverflow.com/questions/8100770/auto-scaling-inputtype-text-to-width-of-value
+  // http://jsfiddle.net/MqM76/217/
+  $.fn.textWidth = function(text, font) {
+      if (!$.fn.textWidth.fakeEl) $.fn.textWidth.fakeEl =      $('<span>').hide().appendTo(document.body);
+      $.fn.textWidth.fakeEl.text(text || this.val() || this.text()).css('font', font || this.css('font'));
+      return $.fn.textWidth.fakeEl.width();
+  };
+
+  // Automatically ensure that the size for the header inputs is
+  // correct
+  function resizeInput() {
+    $this = $(this)
+    $this.css('width', $this.textWidth() + "px")
+    $this.attr('size', $this.val().length)
+  }
+
+  $('form.tryForm .tryForm__header input').on('input', resizeInput).trigger('input')
+
+});

data/html/authenticators/default.html

@@ -0,0 +1,191 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Authentication - 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="active">
+              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>Authentication</h1>
+
+
+<p class='text'>
+      To authenticate to the API, you need to pass an appropriate API token with your
+    request. To find out how to obtain an API token, please refer to the Authentication
+    API documentaton which outlines the available methods available for this.
+
+</p>
+
+<h2>Authentication Headers</h2>
+<p class='text'>
+  The following headers are used to identify yourself to the API client. These should be
+  sent as standard HTTP headers with any API request.
+</p>
+<table class='table paramTable'>
+  <thead>
+    <tr>
+      <th width="60%">Header</th>
+      <th width="40%">Example</th>
+    </tr>
+  </thead>
+  
+  <tr>
+    <td>
+      <p>
+        <span class='paramTable__name'>X-Auth-Application</span>
+      </p>
+      
+        <p class='paramTable__description'>The API application which is generated by us and provided to you.</p>
+      
+    </td>
+    <td>abc123abc123abc123 </td>
+  </tr>
+  
+  <tr>
+    <td>
+      <p>
+        <span class='paramTable__name'>X-Auth-Token</span>
+      </p>
+      
+        <p class='paramTable__description'>The API token for the user you wish to authenticate as.</p>
+      
+    </td>
+    <td>abc123abc123abc123 </td>
+  </tr>
+  
+</table>
+
+<h2>Errors</h2>
+<p class='text'>
+  The errors listed below may be raised if any issues occur when verifying your
+  identity with the API.
+</p>
+
+  <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'>InvalidApplicationToken</span>
+        
+          <p class='paramTable__description'>The application token provided in X-Auth-Application is not valid.</p>
+        
+      </p>
+    </td>
+    <td>
+      
+      <ul class='errorAttributeList'>
+        
+        <li>
+          <p class='errorAttributeList__name'>token</p>
+          <p class='errorAttributeList__desc'>The token used to find the application</p>
+        </li>
+        
+      </ul>
+      
+    </td>
+  </tr>
+  
+  <tr>
+    <td>
+      <p>
+        <span class='paramTable__name'>InvalidAuthToken</span>
+        
+          <p class='paramTable__description'>The auth token provided in X-Auth-Token is not valid.</p>
+        
+      </p>
+    </td>
+    <td>
+      
+      <ul class='errorAttributeList'>
+        
+        <li>
+          <p class='errorAttributeList__name'>token</p>
+          <p class='errorAttributeList__desc'>The token that was used</p>
+        </li>
+        
+      </ul>
+      
+    </td>
+  </tr>
+  
+  <tr>
+    <td>
+      <p>
+        <span class='paramTable__name'>ExpiredAuthToken</span>
+        
+          <p class='paramTable__description'>The auth token provided in X-Auth-Token has expired.</p>
+        
+      </p>
+    </td>
+    <td>
+      
+      <ul class='errorAttributeList'>
+        
+        <li>
+          <p class='errorAttributeList__name'>expired_at</p>
+          <p class='errorAttributeList__desc'>The time the token expired</p>
+        </li>
+        
+      </ul>
+      
+    </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/controllers/meta/version.html

@@ -0,0 +1,144 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>version - Meta 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="active">
+              Meta API
+            </a>
+          </li>
+          
+          <li>
+            <a href='../../controllers/users.html' class="">
+              Users API
+            </a>
+          </li>
+          
+        </ul>
+      </nav>
+    </section>
+    <section class='content'>
+      
+
+
+<h1>version</h1>
+
+<p class='text'>Return the current software version</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='meta'>
+  <input type='hidden' name='action' value='version'>
+  <div class='tryForm__header'>
+    <input type='text' id='host' name='host' value=''>
+    /api/
+    <input type='text' id='version' name='version' value='v1' class='v'>
+    /meta/version
+  </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__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>meta/version</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>
+
+  <p><em>This action doesn't support any parameters.</em></p>
+
+
+
+
+<h2>Errors</h2>
+
+
+  <p><em>There are no action-specific errors which can be raised.</em></p>
+
+
+
+<h2>Response Data</h2>
+
+  <p class='text'>
+    This action will return a String.
+  </p>
+  
+  <pre class='code'>v1.2.3</pre>
+  
+
+
+
+    </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/meta.html

@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Meta 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="active">
+              Meta API
+            </a>
+          </li>
+          
+          <li>
+            <a href='../controllers/users.html' class="">
+              Users API
+            </a>
+          </li>
+          
+        </ul>
+      </nav>
+    </section>
+    <section class='content'>
+      
+
+<h1>Meta API</h1>
+
+  <p class='text'>    The meta API provides you with access to information about the API itself.
+</p>
+
+<h2>Action</h2>
+<p class='text'>
+  The following actions are available. Choose from the list below
+  to view full details of how to access them.
+</p>
+<ul class='standardList'>
+  
+  <li>
+    <a class='link' href='../controllers/meta/version.html'>version</a>
+    <p class='apiURL'><span>/api/v1/</span><b>meta/version</b></p>
+    <p class='meta'>Return the current software version</p>
+  </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>