moonrope 1.3.3 → 2.0.2

data/spec/specs/base_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'moonrope/base'
+
+describe Moonrope::Base do
+  subject(:base) { Moonrope::Base.new }
+
+  context "the base" do
+    it "should be able to define & return a controller" do
+      base.dsl.controller :users
+      expect(base.controller(:users)).to be_a(Moonrope::Controller)
+    end
+
+    it "should be able to define & return a structure" do
+      base.dsl.structure :user
+      expect(base.structure(:user)).to be_a(Moonrope::Structure)
+    end
+
+    it "should be able to define & return an authenticator" do
+      base.dsl.authenticator :admin
+      expect(base.authenticators[:admin]).to be_a(Moonrope::Authenticator)
+    end
+
+    it "should be able to define & return an authenticator" do
+      base.dsl.shared_action(:find_something) { 1234 }
+      expect(base.shared_actions[:find_something]).to be_a(Proc)
+    end
+
+  end
+end

data/spec/specs/controller_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'moonrope/controller'
+require 'moonrope/base'
+
+describe Moonrope::Controller do
+  context "a controller" do
+    it "should be able to define & return an action" do
+      controller = Moonrope::Controller.new(Moonrope::Base.new, :users) do
+        action :list
+      end
+      expect(controller.action(:list)).to be_a(Moonrope::Action)
+    end
+
+    it "should be able to define & return a before filter" do
+      controller = Moonrope::Controller.new(Moonrope::Base.new, :users) do
+        before {}
+      end
+      expect(controller.befores.size).to eq(1)
+      expect(controller.befores.first).to be_a(Moonrope::BeforeAction)
+    end
+
+    it "should be able to define & return a shared action" do
+      controller = Moonrope::Controller.new(Moonrope::Base.new, :users) do
+        shared_action :example do
+        end
+      end
+      expect(controller.shared_actions.size).to eq(1)
+      expect(controller.shared_actions[:example]).to be_a(Proc)
+    end
+  end
+end

data/spec/specs/param_set_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'moonrope/param_set'
+
+describe Moonrope::ParamSet do
+
+  context "a param set" do
+    subject(:param_set) { Moonrope::ParamSet.new('example' => 'Hello') }
+
+    it "should return values in hash format" do
+      expect(param_set[:example]).to eq('Hello')
+      expect(param_set['example']).to eq('Hello')
+    end
+
+    it "should return values in dot format" do
+      expect(param_set.example).to eq('Hello')
+    end
+
+    it "should be able to say if a param exists or not" do
+      expect(param_set.has?(:example)).to be true
+      expect(param_set.has?('example')).to be true
+      expect(param_set.has?(:unknown)).to be false
+    end
+
+    it "should return a default if one exists and there's no other value" do
+      param_set._defaults = {'fruit' =>'Apple'}
+      expect(param_set.has?(:fruit)).to be true
+      expect(param_set.fruit).to eq 'Apple'
+    end
+  end
+
+end

data/templates/basic/_action_form.erb

@@ -0,0 +1,77 @@
+<% unless host.nil? %>
+  <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='<%= controller.name %>'>
+    <input type='hidden' name='action' value='<%= action.name %>'>
+    <div class='tryForm__header'>
+      <input type='text' id='host' name='host' value='<%= host %>'>
+      /api/
+      <input type='text' id='version' name='version' value='<%= version %>' class='v'>
+      /<%= controller.name %>/<%= action.name %>
+    </div>
+
+    <% if action.authenticator_to_use.is_a?(Moonrope::Authenticator) %>
+    <p class='tryForm__heading'>Headers</p>
+    <table class='tryForm__table'>
+      <% for name, options in action.authenticator_to_use.headers %>
+      <tr>
+        <td width="50%"><code><%= name %></code></td>
+        <td width="50%"><input type='text' class='tryForm__tableField headerField' name='<%= name %>'></td>
+      </tr>
+      <% end %>
+    </table>
+    <% end %>
+
+    <% unless action.params.empty? %>
+    <p class='tryForm__heading'>Parameters</p>
+    <table class='tryForm__table'>
+      <% for name, param in action.params %>
+      <tr>
+        <td width="30%"><code><%= name %></code></td>
+        <td width="20%"><%= friendly_type param[:type] %></td>
+        <td width="50%"><input type='text' class='tryForm__tableField paramField' name='<%= name %>' placeholder='<%= param[:default] %>' data-type='<%= param[:type] %>'></td>
+      </tr>
+      <% end %>
+    </table>
+    <% end %>
+
+    <% if action.can_change_full? || action.can_change_expansions? %>
+    <p class='tryForm__heading'>Structures</p>
+    <table class='tryForm__table'>
+      <% if action.can_change_full? %>
+      <tr>
+        <td width="50%">Include extended attributes?</td>
+        <td width="50%">
+          <div class='tryForm__checkbox'>
+            <input type='checkbox' class='tryForm__fullAttrs' name='full' id="full_attrs" <% if action.includes_full_attributes? %>checked='checked'<%end%>>
+            <label for="full_attrs">Yes - include extended attributes</label>
+          </div>
+        </td>
+      </tr>
+      <% end %>
+      <% if action.can_change_expansions? %>
+      <tr>
+        <td width="50%">Include expansions?</td>
+        <td width="50%">
+          <% for expansion in action.available_expansions %>
+            <div class='tryForm__checkbox'>
+              <input type='checkbox' class='tryForm__expansions' name='<%= expansion%>' id="expan_<%= expansion %>" <% if action.includes_expansion?(expansion) %>checked='checked'<%end%>>
+              <label for="expan_<%= expansion %>"><%= expansion %></label>
+            </div>
+          <% end %>
+        </td>
+      </tr>
+      <% end %>
+
+    </table>
+
+    <% end %>
+
+    <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>
+<% end %>

data/templates/basic/_errors_table.erb

@@ -0,0 +1,32 @@
+<table class='table errorsTable'>
+  <thead>
+    <tr>
+      <th width="60%">Error</th>
+      <th width="40%">Attributes</th>
+    </tr>
+  </thead>
+  <% for name, error in errors %>
+  <tr>
+    <td>
+      <p>
+        <span class='paramTable__name'><%= name %></span>
+        <% if error[:description] %>
+          <p class='paramTable__description'><%= error[:description] %></p>
+        <% end %>
+      </p>
+    </td>
+    <td>
+      <% if error[:attributes].is_a?(Hash) %>
+      <ul class='errorAttributeList'>
+        <% for name, description in error[:attributes] %>
+        <li>
+          <p class='errorAttributeList__name'><%= name %></p>
+          <p class='errorAttributeList__desc'><%= description %></p>
+        </li>
+        <% end %>
+      </ul>
+      <% end %>
+    </td>
+  </tr>
+  <% end %>
+</table>

data/templates/basic/_structure_attributes_list.erb

@@ -0,0 +1,55 @@
+<table class='table paramTable'>
+  <thead>
+    <tr>
+      <th width="45%">Attribute</th>
+      <th width="20%">Type</th>
+      <th width="35%">Example</th>
+    </tr>
+  </thead>
+  <% for attribute in attributes %>
+  <tr>
+    <td>
+      <p>
+        <span class='paramTable__name'><%= attribute.name_with_groups %></span>
+      </p>
+      <% if attribute.description %>
+        <p class='paramTable__description'><%= attribute.description %></p>
+      <% end %>
+
+      <% conditions = attribute.conditions.map { |c| structure.description_for_condition(c) }.compact %>
+      <% unless conditions.empty? %>
+        <ul class='paramTable__restrictedList'>
+          <% for condition in conditions %>
+          <li><%= condition %></li>
+          <% end %>
+        </ul>
+      <% end %>
+    </td>
+    <td><%= friendly_type(attribute.value_type) %></td>
+    <td>
+      <% if substructure = attribute.structure %>
+        <a class='link' href="<%= path("structures/#{substructure}.html")%>"><%= humanize(substructure.to_s.capitalize) %> structure</a>
+      <% else %>
+        <%= attribute.example %>
+      <% end %>
+    </td>
+  </tr>
+  <% end %>
+
+  <% if vars[:expansions] && !vars[:expansions].empty? %>
+  <% for name, expansion in vars[:expansions] %>
+  <tr>
+    <td>
+      <p>
+        <span class='paramTable__name'><%= name %></span>
+      </p>
+      <% if expansion[:description] %>
+        <p class='paramTable__description'><%= expansion[:description] %></p>
+      <% end %>
+    </td>
+    <td><%= friendly_type(expansion[:type]) %></td>
+    <td><%= expansion[:eg] || expansion[:example] %></td>
+  </tr>
+  <% end %>
+  <% end %>
+</table>

data/templates/basic/action.erb

@@ -0,0 +1,168 @@
+<% set_page_title "#{action.title || action.name} - #{action.controller.friendly_name || action.controller.name}" %>
+<% set_active_nav "controller-#{controller.name}" %>
+
+<h1><%= action.title || action.name %></h1>
+<% if action.description %>
+<p class='text'><%= action.description %></p>
+<% end %>
+
+<%= partial 'action_form', :controller => controller, :action => action %>
+
+<h2>URL</h2>
+<p class='apiURLFull'><span><%= full_prefix %>/</span><%= action.controller.name %>/<%= action.name %></p>
+
+<% if action.authenticator_to_use.is_a?(Moonrope::Authenticator) %>
+<% if rule = action.authenticator_to_use.rules[action.access_rule_to_use] %>
+<% if rule[:description] %>
+  <h2>Access</h2>
+  <p class='text'>
+    <%= rule[:description] %>
+    <% if rule[:error_code] %>
+    If not authorised, a <code><%= rule[:error_code] %></code> error will be returned.
+    <% end %>
+  </p>
+<% end %>
+<% end %>
+<% end %>
+
+<h2>Parameters</h2>
+<% if action.params.empty? %>
+  <p><em>This action doesn't support any parameters.</em></p>
+<% else %>
+  <table class='table paramTable'>
+    <thead>
+      <tr>
+        <th width="60%">Parameter</th>
+        <th width="20%">Type</th>
+        <th width="20%">Default</th>
+      </tr>
+    </thead>
+    <% for name, param in action.params %>
+    <tr>
+      <td>
+        <p>
+          <span class='paramTable__name'><%= name %></span>
+          <% if param[:required] && param[:default].nil? %><span class='paramTable__req'>Required</span><% end %>
+        </p>
+        <% if param[:description] %>
+          <p class='paramTable__description'><%= param[:description] %></p>
+        <% end %>
+      </td>
+      <td><%= friendly_type(param[:type]) %></td>
+      <td>
+        <% if param[:default].nil? %>
+          <span class='paramTable__nil'>null</span>
+        <% else %>
+          <%= param[:default] %>
+        <% end %>
+      </td>
+    </tr>
+    <% end %>
+  </table>
+<% end %>
+
+<% unless action.filters.empty? %>
+<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>
+  <% for name, filter in action.filters %>
+  <tr>
+    <td><span class='paramTable__name'><%= name %></span></td>
+    <td><%= filter[:operators].map(&:to_s).join(', ') %></td>
+  </tr>
+  <% end %>
+</table>
+<% end %>
+
+<h2>Errors</h2>
+
+<% if action.errors.empty? %>
+  <p><em>There are no action-specific errors which can be raised.</em></p>
+<% else %>
+  <%= partial "errors_table", :errors => action.errors %>
+<% end %>
+
+<% if action.returns %>
+<h2>Response Data</h2>
+<% if action.returns[:structure] %>
+  <% if action.returns[:type] == :array %>
+    <p class='text'>This action will return an array of <a class='link' href='<%= path("structures/#{action.returns[:structure]}") %>'><%= humanize(action.returns[:structure]) %> structures</a>.</p>
+  <% else %>
+    <p class='text'>This action will return a <a class='link' href='<%= path("structures/#{action.returns[:structure]}") %>'><%= humanize(action.returns[:structure]) %> structure</a>.</p>
+  <% end %>
+
+  <% if opts = action.returns[:structure_opts] %>
+    <% if opts[:paramable] == true %>
+      <p class='text'>
+        You'll receive this structure in the most basic form, without extended data or
+        any expansions. You can choose to receive extended attributes by providing the <code>_full</code> parameter. You can
+        also choose to receive any expansions by providing an array in the <code>_expansions</code>
+        parameter. A full list of expansions can be found on the
+        <a class='link' href='<%= path("structures/#{action.returns[:structure]}") %>'>structure page</a>.
+      </p>
+    <% elsif opts[:paramable].is_a?(Hash) %>
+      <p class='text'>
+        <% if opts[:paramable].has_key?(:full) %>
+          <% if opts[:paramable][:full] %>
+          You'll receive all extended data with this structure, by default.
+          <% else %>
+          You won't receive any extended data with this structure, by default.
+          <% end %>
+          You can change this behaviour by passing true or false in the <code>_full</code>
+          parameter on the request.
+        <% else %>
+        You will only receive basic data for this structure, no extended data is available.
+        <% end %>
+
+        <% if opts[:paramable].has_key?(:expansions) %>
+          <% if opts[:paramable][:expansions].is_a?(Array) %>
+          By default, you'll receive expansions for <b><%= opts[:paramable][:expansions].join(', ') %></b>.
+          You can change these by providing an array of expansion names in the <code>_expansions</code>
+          parameter on the request.
+          <% elsif opts[:paramable][:expansions] == true %>
+          By default, you'll receive all expansions for the structure. You remove any/all of them by
+          providing an array of new expansion names in the <code>_expansions</code> parameter on the
+          request.
+          <% elsif opts[:paramable][:expansions] == false %>
+          By default, you'll receive no expansions for the structure. You can add them by providing
+          an array of new expansion names in the <code>_expansions</code> parameter on the request.
+          You can send <code>true</code> rather than array to receive all expansions.
+          <% end %>
+        <% else %>
+        No expansions will be provided.
+        <% end %>
+      </p>
+    <% else %>
+      <% if opts[:full] %>
+      You'll receive all attributes for this structure (basic and extended attributes).
+      <% else %>
+      You'll only receive basic attributes for this structure.
+      <% end %>
+      <% if opts[:expansions].is_a?(Array) %>
+      You'll receive expansions for <b><%= opts[:expansions].join(', ') %></b>.
+      <% elsif opts[:expansions] == true %>
+      You'll receive all expansions for this stucture.
+      <% end %>
+    <% end %>
+  <% else %>
+    You'll receive just the basic attributes for this structure. No expansions are provided.
+  <% end %>
+<% else %>
+  <p class='text'>
+    This action will return a <%= friendly_type(action.returns[:type]) %>.
+  </p>
+  <% if eg = (action.returns[:eg] || action.returns[:example]) %>
+  <pre class='code'><%= eg %></pre>
+  <% end %>
+<% end %>
+<% end %>

data/templates/basic/assets/lock.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
+  <path fill="#ed4300" d="M3 0c-1.1 0-2 .9-2 2v1h-1v4h6v-4h-1v-1c0-1.1-.9-2-2-2zm0 1c.56 0 1 .44 1 1v1h-2v-1c0-.56.44-1 1-1z" transform="translate(1)" />
+</svg>

data/templates/basic/assets/reset.css

@@ -0,0 +1,101 @@
+html, body, body div, span, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, abbr, address, cite, code, del, dfn, em, img, ins, kbd, q, samp, small, strong, sub, sup, var, b, i, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, figure, footer, header, hgroup, menu, nav, section, time, mark, audio, video {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	outline: 0;
+	font-size: 100%;
+	letter-spacing:0;
+	vertical-align: baseline;
+	background: transparent;
+	font-weight:inherit;
+}
+
+* {
+	-webkit-box-sizing: border-box;
+	-moz-box-sizing: border-box;
+	box-sizing: border-box;
+}
+u { text-decoration: none;}
+b { font-weight:normal;}
+article, aside, figure, footer, header, hgroup, nav, section {display: block;}
+
+object,embed {max-width: 100%;}
+ul {list-style: none;}
+blockquote, q {quotes: none;}
+b,strong { font-weight:bold;}
+blockquote:before, blockquote:after, q:before, q:after {content: ''; content: none;}
+
+a {margin: 0; padding: 0; font-size: 100%; vertical-align: baseline; background: transparent;}
+
+del {text-decoration: line-through;}
+
+abbr[title], dfn[title] {border-bottom: 1px dotted #000; cursor: help;}
+
+/* tables still need cellspacing="0" in the markup */
+table {border-collapse: collapse; border-spacing: 0;}
+mark { color:inherit;}
+
+hr {display: block; height: 1px; border: 0; border-top: 1px solid #ccc; margin: 1em 0; padding: 0;}
+
+input, select {vertical-align: middle;}
+
+pre {
+	white-space: pre; /* CSS2 */
+	white-space: pre-wrap; /* CSS 2.1 */
+	white-space: pre-line; /* CSS 3 (and 2.1 as well, actually) */
+	word-wrap: break-word; /* IE */
+}
+
+input[type="radio"] {vertical-align: text-bottom;}
+input[type="checkbox"] {vertical-align: bottom; *vertical-align: baseline;}
+.ie6 input {vertical-align: text-bottom;}
+
+select, input, textarea {font: 99% sans-serif;}
+
+table {font-size: inherit; font: 100%;}
+
+/* Accessible focus treatment
+	people.opera.com/patrickl/experiments/keyboard/test */
+a:hover, a:active {outline: none;}
+
+small {font-size: 85%;}
+
+strong, th {font-weight: bold;}
+
+td, td img {vertical-align: top;}
+
+/* Make sure sup and sub don't screw with your line-heights
+	gist.github.com/413930 */
+sub, sup {font-size: 75%; line-height: 0; position: relative;}
+sup {top: -0.5em;}
+sub {bottom: -0.25em;}
+
+/* standardize any monospaced elements */
+pre, code, kbd, samp {font-family: monospace, sans-serif;}
+
+/* hand cursor on clickable elements */
+.clickable,
+label,
+input[type=button],
+input[type=submit],
+button {cursor: pointer;}
+
+/* Webkit browsers add a 2px margin outside the chrome of form elements */
+button, input, select, textarea {margin: 0;}
+
+/* make buttons play nice in IE */
+button {width: auto; overflow: visible;}
+
+/* scale images in IE7 more attractively */
+.ie7 img {-ms-interpolation-mode: bicubic;}
+
+/* prevent BG image flicker upon hover */
+.ie6 html {filter: expression(document.execCommand("BackgroundImageCache", false, true));}
+
+/* let's clear some floats */
+.clearfix:before, .clearfix:after { content: "\0020"; display: block; height: 0; overflow: hidden; }
+.clearfix:after { clear: both; }
+.clearfix { zoom: 1; }
+
+select, input, textarea, a { outline: none;}
+a { color:inherit;}