rails_api_explorer 0.0.1.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 072d32c87b27d505bb62ce22a1d491668db4e48d
+  data.tar.gz: ae39b35ef35b5ddf691b3a3dfcd3fcfa8e5f1841
+SHA512:
+  metadata.gz: f447e761837f2647ab0bd4dc022d6f044185ffed149547581c5e14973878cf56c2637943cf75fddda2375034fd97e2dd298995be235ea2b77235661d94bfc079
+  data.tar.gz: 976d4f7a37d9fe5d215a0ed0896cae9f6e58f038015dda0f7b22e7be61da777b36aeca76903b07aa6a9cc0058a9b4abe9716dab7ba0a8fc7acdd6271d07094a6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ApiExplorer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/api_explorer/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/api_explorer/explorer.js

@@ -0,0 +1,146 @@
+$(function() {
+    $(".hidden").hide().removeClass("hidden");
+
+    window.responses = {};
+
+    $(".shared-input.header").change(function() {
+        updateShareds();
+    });
+    $(".shared-link").click(function() {
+        $($(this).attr("href")).find("input").focus();
+    });
+
+    function updateShareds() {
+        $(".shared-input.header").each(function() {
+            name = $(this).attr("data-name");
+            $(".shared.header[data-name=" + name + "]").val($(this).val());
+        });
+    }
+
+    function setValuesFromRequest(request) {
+        $("[data-source-request='" + request + "']").each(function(input) {
+            v = eval("responses['" + request + "']" + $(this).attr("data-source-accessor"));
+            $(this).val(v);
+        });
+        updateShareds();
+    }
+
+    // Enable / disable params
+    $(".param input").prop("disabled", false); // Firefox autocomplete workaround
+    $(".send-toggle").click(function(event) {
+        event.preventDefault();
+
+        var setState = function(elements, state) {
+            elements.each(function(i, el) {
+                $(el).attr("data-send", state ? "true" : "false");
+                $(el).find("input").first().prop("disabled", !state);
+                $(el).find(".send-toggle").first().text(state ? "don't send" : "send");
+                $(el).find(".name").first().toggleClass("strikethrough", !state);
+            });
+        }
+
+        var param = $(this).closest(".param");
+        var send = param.attr("data-send") == "true" ? false : true;
+        setState(param.add(param.find(".param")), send); // enable or disable children
+        if (send)
+            setState(param.parents(".param"), true); // enable parents
+    });
+
+    $("form").submit(function(event) {
+        event.preventDefault();
+
+        var form = $(this);
+        var req = form.serializeObject().request;
+        form.closest(".request").find(".status").html("Requesting...");
+
+        path = req.path;
+        if (req.url_params) {
+            $.each(req.url_params, function(p, v) {
+                path = path.replace(":" + p, v);
+            });
+        }
+
+        $.ajax({
+            url: path,
+            type: req.method,
+            headers: req.headers,
+            data: req.params,
+            dataType: 'json'
+        }).always(function(data, status, error) {
+            if(status == 'success') {
+                code = 200;
+                var key = req.method.toUpperCase() + ":" + req.path.replace(api_explorer_base_url, "");
+                window.responses[key] = data;
+                setValuesFromRequest(key);
+            } else {
+                code = data.status;
+                try {
+                    data = $.parseJSON(data.responseText);
+                } catch(SyntaxError) {}
+            }
+            if (code == 0) {
+                form.closest(".request").find(".status").text("Can't reach server");
+                form.closest(".request").find(".response").hide();
+            } else {
+                form.closest(".request").find(".status").text(code);
+                form.closest(".request").find(".response").text(JSON.stringify(data, null, 4)).show();
+            }
+        });
+    });
+
+
+    $.fn.serializeObject = function() {
+        var self = this,
+        json = {},
+        push_counters = {},
+        patterns = {
+            "validate": /^[a-zA-Z][a-zA-Z0-9_\-]*(?:\[(?:\d*|[a-zA-Z0-9_\-]+)\])*$/,
+            "key":      /[a-zA-Z0-9_\-]+|(?=\[\])/g,
+            "push":     /^$/,
+            "fixed":    /^\d+$/,
+            "named":    /^[a-zA-Z0-9_\-]+$/
+        };
+
+        this.build = function(base, key, value){
+            base[key] = value;
+            return base;
+        };
+        this.push_counter = function(key){
+            if(push_counters[key] === undefined){
+                push_counters[key] = 0;
+            }
+            return push_counters[key]++;
+        };
+        $.each($(this).serializeArray(), function(){
+            // skip invalid keys
+            if(!patterns.validate.test(this.name)) {
+                return;
+            }
+            var k,
+            keys = this.name.match(patterns.key),
+            merge = this.value,
+            reverse_key = this.name;
+
+            while((k = keys.pop()) !== undefined){
+
+                // adjust reverse_key
+                reverse_key = reverse_key.replace(new RegExp("\\[" + k + "\\]$"), '');
+
+                // push
+                if(k.match(patterns.push)){
+                    merge = self.build([], self.push_counter(reverse_key), merge);
+                }
+                // fixed
+                else if(k.match(patterns.fixed)){
+                    merge = self.build([], k, merge);
+                }
+                // named
+                else if(k.match(patterns.named)){
+                    merge = self.build({}, k, merge);
+                }
+            }
+            json = $.extend(true, json, merge);
+        });
+        return json;
+    };
+});

data/app/assets/javascripts/api_explorer/scroll.js

@@ -0,0 +1,38 @@
+$(function() {
+  /**
+   * Check a href for an anchor. If exists, and in document, scroll to it.
+   * If href argument ommited, assumes context (this) is HTML Element,
+   * which will be the case when invoked by jQuery after an event
+   */
+  function scroll_if_anchor(href) {
+      href = typeof(href) == "string" ? href : $(this).attr("href");
+
+      var fromTop = 0;
+
+      if ($(".navbar-fixed-top").length > 0) {
+          fromTop = $(".navbar-fixed-top").height();
+      }
+
+      // If our Href points to a valid, non-empty anchor, and is on the same page (e.g. #foo)
+      // Legacy jQuery and IE7 may have issues: http://stackoverflow.com/q/1593174
+      if(href.indexOf("#") == 0) {
+          var $target = $(href);
+
+          // Older browser without pushState might flicker here, as they momentarily
+          // jump to the wrong position (IE < 10)
+          if($target.length) {
+              $('html, body').animate({ scrollTop: $target.offset().top - fromTop });
+              if(history && "pushState" in history) {
+                  history.pushState({}, document.title, window.location.pathname + href);
+                  return false;
+              }
+          }
+      }
+  }
+
+  // When our page loads, check to see if it contains and anchor
+  scroll_if_anchor(window.location.hash);
+
+  // Intercept all anchor clicks
+  $("body").on("click", "a", scroll_if_anchor);
+});

data/app/assets/stylesheets/api_explorer/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/api_explorer/explorer.css

@@ -0,0 +1,70 @@
+.hidden {
+    display: none;
+}
+
+.params .params {
+    margin-left: 30px;
+}
+
+.param-inputs .param-inputs {
+    margin-left: 30px;
+}
+
+.param-inputs fieldset {
+    border: none;
+    padding: 0;
+}
+.param-inputs input {
+    border: none;
+}
+h3 input {
+    border: none;
+    width: 120px;
+    text-align: center;
+}
+
+legend {
+    margin-bottom: 5px;
+}
+.param-inputs legend {
+    font-size: 100%;
+    border: none;
+    margin-bottom: 0;
+}
+label {
+    font-weight: normal;
+    margin-bottom: 0;
+}
+
+.response {
+  border: solid 1px black;
+  background-color: #CCC;
+  padding: 20px;
+  max-height: 400px;
+  overflow: scroll;
+}
+
+.description {
+    font-size: 80%;
+}
+
+fieldset {
+    margin-bottom: 5px;
+}
+
+legend, label {
+    position: relative;
+}
+
+.send-toggle {
+    font-size: 80%;
+    cursor: pointer;
+    display: none;
+}
+:hover > .send-toggle {
+    display: inline;
+}
+
+.strikethrough {
+    text-decoration: line-through;
+}

data/app/controllers/api_explorer/application_controller.rb

@@ -0,0 +1,5 @@
+class ApiExplorer::ApplicationController < ApplicationController
+  before_filter do
+    instance_eval(&ApiExplorer.auth) if ApiExplorer.auth
+  end
+end

data/app/controllers/api_explorer/explorer_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "api_explorer/application_controller"
+
+module ApiExplorer
+  class ExplorerController < ApplicationController
+    def index
+      @description = ApiExplorer.description
+    end
+  end
+end

data/app/helpers/api_explorer/application_helper.rb

@@ -0,0 +1,4 @@
+module ApiExplorer
+  module ApplicationHelper
+  end
+end

data/app/helpers/api_explorer/explorer_helper.rb

@@ -0,0 +1,4 @@
+module ApiExplorer
+  module ExplorerHelper
+  end
+end

data/app/views/api_explorer/explorer/_content_node.html.erb

@@ -0,0 +1,12 @@
+<li>
+  <% if node.is_a?(ApiExplorer::Request) %>
+    <a href="#node-<%= id %>"><%= node.title %></a>
+  <% else %>
+    <a href="#node-<%= id %>"><%= node.title %></a>
+    <ul class="children">
+      <% node.children.each_with_index do |ch, i| %>
+        <%= render 'content_node', node: ch, id: "#{id}-#{i}" %>
+      <% end %>
+    </ul>
+  <% end %>
+</li>

data/app/views/api_explorer/explorer/_node.html.erb

@@ -0,0 +1,17 @@
+<% node.children.each_with_index do |ch, i| %>
+  <% if ch.is_a?(ApiExplorer::Request) %>
+    <%= render 'request', req: ch, id: "#{id}-#{i}", depth: depth + 1 %>
+  <% else %>
+    <div class="group row" id="node<%= id %>-<%= i %>">
+      <div class="col-sm-12">
+        <% header_n = [1 + depth, 2].min %>
+        <h<%= header_n %>><%= ch.title %></h<%= header_n %>>
+        <% if ch.children.any? %>
+          <div class="children">
+            <%= render 'node', id: "#{id}-#{i}", node: ch, depth: depth + 1 %>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  <% end %>
+<% end %>

data/app/views/api_explorer/explorer/_params.html.erb

@@ -0,0 +1,14 @@
+<div class="params">
+  <% params.each do |param| %>
+    <div class="param">
+      <%= param.name %>:
+      <% if param.type == :hash %>
+        {
+          <%= render 'params', params: param.children %>
+        }
+      <% else %>
+        <small><%= param.type %></small>
+      <% end %>
+    </div>
+  <% end %>
+</div>

data/app/views/api_explorer/explorer/_request.html.erb

@@ -0,0 +1,39 @@
+<div class="row request" id="node<%= id %>">
+  <%= form_for :request, url: request_path, html: { class: "col-sm-6" } do |f| %>
+    <%= f.hidden_field :method, value: req.method %>
+    <%= f.hidden_field :path, value: req.full_path %>
+
+    <%= f.fields_for :url_params do |pf| %>
+      <h3>
+        <%= req.method.to_s.upcase %>
+        <% req.url_segments.each do |type, s| %>
+          <% if type == :param %>
+            <%= pf.text_field s, placeholder: ":#{s}" %>
+            <!-- span contenteditable="true" data-ph="<%= ":#{s}" %>" data-name="<%= s %>"></span -->
+          <% else %>
+            <%= raw s %>
+          <% end %>
+        <% end %>
+      </h3>
+    <% end %>
+
+    <div>
+      <p><%= simple_format req.description %></p>
+
+      <!-- %= render 'api_explorer/explorer/form/url_params', params: req.url_params, f: f % -->
+      <%= render 'api_explorer/explorer/form/headers', request: req, f: f %>
+      <% if req.params.any? %>
+        <fieldset>
+          <legend>Parameters</legend>
+          <%= render 'api_explorer/explorer/form/params', name: 'params', params: req.params, f: f %>
+        </fieldset>
+      <% end %>
+      <%= f.submit "Send", class: "btn btn-primary" %>
+    </div>
+  <% end %>
+
+  <div class="col-sm-6 output">
+    <p class="status"></p>
+    <pre class="response hidden"></pre>
+  </div>
+</div>

data/app/views/api_explorer/explorer/_shared.html.erb

@@ -0,0 +1,12 @@
+<div class="row">
+  <div class="col-sm-12">
+    <h3>Shared headers</h3>
+
+    <% @description.headers.each do |h| %>
+      <div id="shared-header-<%= h.name %>">
+        <%= label_tag h.name, h.name %>:
+        <%= text_field_tag h.name, "", class: "shared-input header", data: { name: h.name, source_request: h.source[:request], source_accessor: h.source[:accessor] } %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/api_explorer/explorer/form/_headers.html.erb

@@ -0,0 +1,25 @@
+<% if request.excluded_shared_headers.any? %>
+  <p>Note: Does <strong>not</strong> use these shared headers: <%= request.excluded_shared_headers.join(", ") %>.</p>
+<% end %>
+
+<%= f.fields_for :headers do |hf| %>
+  <% @description.headers.each do |h| %>
+    <% next if request.excluded_shared_headers.include?(h.name) %>
+
+    <!--%= hf.label h.name, h.name %-->
+    <!--%= raw " (<a class='shared-link' href='#shared-header-#{h.name}'>shared</a>)" %-->
+    <%= hf.hidden_field h.name, class: "shared header", data: { name: h.name } %>
+  <% end %>
+<% end %>
+
+<% if request.headers.any? %>
+  <fieldset>
+    <legend>Headers</legend>
+    <%= f.fields_for :headers do |hf| %>
+      <% request.headers.each do |h| %>
+        <%= hf.label h.name, h.name + ":" %>
+        <%= hf.text_field h.name %>
+      <% end %>
+    <% end %>
+  </fieldset>
+<% end %>

data/app/views/api_explorer/explorer/form/_param.html.erb

@@ -0,0 +1,28 @@
+<div class="param" data-param-name="<%= p.name %>" data-send="true">
+  <% if p.type == :hash %>
+    <fieldset>
+      <legend>
+        <span class="name"><%= p.name %></span>:
+        {
+        <a class="send-toggle">don't send</a>
+      </legend>
+        <div class="description"><%= simple_format p.description %></div>
+        <div class="param-inputs">
+          <%= render 'api_explorer/explorer/form/params', name: p.name, params: p.params, f: f %>
+        </div>
+      }
+    </fieldset>
+  <% else %>
+    <%= f.label p.name do %>
+      <span class="name"><%= p.name %></span>:
+    <% end %>
+
+    <% if p.name == 'password' %>
+      <%= f.password_field p.name, placeholder: p.type %>
+    <% else %>
+      <%= f.text_field p.name, placeholder: p.type %>
+    <% end %>
+    <a class="send-toggle">don't send</a>
+    <div class="description"><%= p.description %></div>
+  <% end %>
+</div>

data/app/views/api_explorer/explorer/form/_params.html.erb

@@ -0,0 +1,7 @@
+<%= f.fields_for name do |pf| %>
+  <div class="param-inputs">
+    <% params.each do |p| %>
+      <%= render 'api_explorer/explorer/form/param', f: pf, p: p %>
+    <% end %>
+  </div>
+<% end %>

data/app/views/api_explorer/explorer/form/_url_params.html.erb

@@ -0,0 +1,13 @@
+<% return if params.none? %>
+
+<fieldset>
+  <legend>URL Parameters</legend>
+  <%= f.fields_for :url_params do |pf| %>
+    <% params.each do |p| %>
+      <p>
+        <%= pf.label p, p + ":" %>
+        <%= pf.text_field p %>
+      </p>
+    <% end %>
+  <% end %>
+</fieldset>

data/app/views/api_explorer/explorer/index.html.erb

@@ -0,0 +1,20 @@
+<script type="text/javascript">
+  window.api_explorer_base_url = "<%= @description.base_url %>";
+</script>
+
+<%= stylesheet_link_tag    "api_explorer/application", media: "all" %>
+<%= javascript_include_tag "api_explorer/application" %>
+
+<div class="row">
+  <div class="col-sm-12">
+    <h1>Index</h1>
+    <ul class="contents">
+      <% @description.children.each_with_index do |ch, i| %>
+        <%= render 'content_node', node: ch, id: i %>
+      <% end %>
+    </ul>
+  </div>
+</div>
+
+<%= render 'shared' %>
+<%= render 'node', node: @description, id: "", depth: 0 %>

data/app/views/api_explorer/explorer/perform_request.html.erb

@@ -0,0 +1 @@
+<%= raw ap @response %>

data/config/routes.rb

@@ -0,0 +1,4 @@
+ApiExplorer::Engine.routes.draw do
+  root to: 'explorer#index'
+  post 'request' => 'explorer#perform_request'
+end

data/lib/api_explorer/description.rb

@@ -0,0 +1,7 @@
+module ApiExplorer
+  class Description < Group
+    def base_url
+      path
+    end
+  end
+end

data/lib/api_explorer/dsl/base_proxy.rb

@@ -0,0 +1,13 @@
+module ApiExplorer
+  class BaseProxy
+    attr_accessor :obj
+
+    def initialize(obj = nil)
+      self.obj = obj
+    end
+
+    def collect(&block)
+      instance_eval(&block)
+    end
+  end
+end

data/lib/api_explorer/dsl/description_proxy.rb

@@ -0,0 +1,7 @@
+module ApiExplorer
+  class DescriptionProxy < GroupProxy
+    def base_url(url)
+      path url
+    end
+  end
+end

data/lib/api_explorer/dsl/group_proxy.rb

@@ -0,0 +1,44 @@
+module ApiExplorer
+  class GroupProxy < BaseProxy
+    def path(path = nil)
+      obj.path = path if path
+      obj.path
+    end
+
+    def group(title, &block)
+      group = Group.new(title)
+      proxy = GroupProxy.new(group)
+      proxy.collect(&block) if block_given?
+      obj.add_child group
+    end
+
+    def request(method, path, &block)
+      method = method.to_s.downcase.to_sym
+      req = Request.new(method, path)
+      proxy = RequestProxy.new(req)
+      proxy.collect(&block) if block_given?
+      obj.add_child req
+    end
+
+    def shared(&block)
+      proxy = RequestProxy.new(obj)
+      proxy.collect(&block)
+    end
+
+    def get(path, &block)
+      request(:get, path, &block)
+    end
+    def post(path, &block)
+      request(:post, path, &block)
+    end
+    def put(path, &block)
+      request(:put, path, &block)
+    end
+    def patch(path, &block)
+      request(:patch, path, &block)
+    end
+    def delete(path, &block)
+      request(:delete, path, &block)
+    end
+  end
+end

data/lib/api_explorer/dsl/request_proxy.rb

@@ -0,0 +1,41 @@
+module ApiExplorer
+  class RequestProxy < BaseProxy
+    def exclude_shared_header(name)
+      obj.excluded_shared_headers << name
+    end
+
+    def desc(description)
+      obj.description = description
+    end
+
+    def param(name, type = nil, options = {}, &block)
+      desc = options.fetch(:desc, "")
+      if type.nil? && block_given?
+        param = Parameter.new(name, [], desc)
+        param.type = :hash
+        proxy = RequestProxy.new(param)
+        proxy.collect(&block)
+        obj.params << param
+      else
+        obj.params << Parameter.new(name, type, desc)
+      end
+    end
+
+    def struct(name, options = {}, &block)
+      param(name, nil, options, &block)
+    end
+    def string(name, options = {}, &block)
+      param(name, :string, options)
+    end
+    def boolean(name, options = {}, &block)
+      param(name, :boolean, options)
+    end
+    def integer(name, options = {}, &block)
+      param(name, :integer, options)
+    end
+
+    def header(name, options = {})
+      obj.headers << Header.new(name, options)
+    end
+  end
+end

data/lib/api_explorer/dsl.rb

@@ -0,0 +1,4 @@
+require "api_explorer/dsl/base_proxy"
+require "api_explorer/dsl/group_proxy"
+require "api_explorer/dsl/description_proxy"
+require "api_explorer/dsl/request_proxy"

data/lib/api_explorer/engine.rb

@@ -0,0 +1,5 @@
+module ApiExplorer
+  class Engine < ::Rails::Engine
+    isolate_namespace ApiExplorer
+  end
+end

data/lib/api_explorer/group.rb

@@ -0,0 +1,18 @@
+module ApiExplorer
+  class Group < Node
+    attr_accessor :headers, :params, :title
+
+    def initialize(title, path = "", children = [], shared_headers = [], shared_params = [])
+      super nil, children, path
+
+      self.title   = title
+      self.headers = shared_headers
+      self.params  = shared_params
+    end
+
+    def add_child(child)
+      children << child
+      child.parent = self
+    end
+  end
+end

data/lib/api_explorer/header.rb

@@ -0,0 +1,10 @@
+module ApiExplorer
+  class Header
+    def initialize(name, options = {})
+      self.name = name.to_s
+      self.source = options[:source] || {}
+    end
+
+    attr_accessor :name, :source
+  end
+end

data/lib/api_explorer/node.rb

@@ -0,0 +1,30 @@
+module ApiExplorer
+  class Node
+    attr_accessor :parent, :children, :path
+
+    def initialize(parent = nil, children = nil, path = nil)
+      self.parent   = parent || NullNode.new
+      self.children = children || []
+      self.path     = path.to_s
+
+      self.children.each { |c| c.parent = self }
+    end
+
+    def full_path
+      parent.full_path + path
+    end
+
+
+    private
+
+      class NullNode
+        def full_path
+          ""
+        end
+
+        def method_missing
+          nil
+        end
+      end
+  end
+end

data/lib/api_explorer/parameter.rb

@@ -0,0 +1,16 @@
+module ApiExplorer
+  class Parameter
+    def initialize(name, type_or_children, description)
+      self.name = name.to_s
+      self.description = description
+      if type_or_children.is_a?(Array)
+        self.type = :hash
+        self.params = type_or_children
+      else
+        self.type = type_or_children.to_s.to_sym
+      end
+    end
+
+    attr_accessor :name, :type, :params, :description
+  end
+end

data/lib/api_explorer/request.rb

@@ -0,0 +1,37 @@
+module ApiExplorer
+  class Request < Node
+    attr_accessor :method, :params, :headers, :description, :excluded_shared_headers
+
+    def initialize(method, path, params = [], headers = [], description = "", excluded_shared_headers = [])
+      super nil, nil, path
+
+      self.method                  = method.to_s
+      self.params                  = Array(params)
+      self.headers                 = Array(headers)
+      self.description             = description
+      self.excluded_shared_headers = Array(excluded_shared_headers)
+    end
+
+    def url
+      full_path
+    end
+
+    def url_params
+      path.scan(/:[a-zA-Z_\-]+/).map { |s| s[1..s.size] }
+    end
+
+    def url_segments
+      path.scan(/(:[a-zA-Z_\-]+)|([^:]+)/).map do |param, normal|
+        if param
+          [:param, param[1..param.size]]
+        else
+          [:normal, normal]
+        end
+      end
+    end
+
+    def title
+      "#{method.upcase} #{path}"
+    end
+  end
+end

data/lib/api_explorer/version.rb

@@ -0,0 +1,3 @@
+module ApiExplorer
+  VERSION = "0.0.1.pre.1"
+end

data/lib/api_explorer.rb

@@ -0,0 +1,19 @@
+require "api_explorer/engine"
+require "api_explorer/node"
+require "api_explorer/group"
+require "api_explorer/description"
+require "api_explorer/header"
+require "api_explorer/parameter"
+require "api_explorer/request"
+require "api_explorer/dsl"
+
+module ApiExplorer
+  mattr_accessor :description, :shared_headers, :shared_params, :auth
+
+  def self.describe(&block)
+    self.description = Description.new("", "", [], [], [])
+    proxy = DescriptionProxy.new(description)
+    proxy.collect(&block)
+    #self.description = Description.new(proxy.path, proxy.children, proxy.shared_headers, proxy.shared_params)
+  end
+end

data/lib/rails_api_explorer.rb

@@ -0,0 +1 @@
+require "api_explorer"

data/lib/tasks/api_explorer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :api_explorer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: rails_api_explorer
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.1
+platform: ruby
+authors:
+- Max Hollmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- maxhollmann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/api_explorer/application.js
+- app/assets/javascripts/api_explorer/explorer.js
+- app/assets/javascripts/api_explorer/scroll.js
+- app/assets/stylesheets/api_explorer/application.css
+- app/assets/stylesheets/api_explorer/explorer.css
+- app/controllers/api_explorer/application_controller.rb
+- app/controllers/api_explorer/explorer_controller.rb
+- app/helpers/api_explorer/application_helper.rb
+- app/helpers/api_explorer/explorer_helper.rb
+- app/views/api_explorer/explorer/_content_node.html.erb
+- app/views/api_explorer/explorer/_node.html.erb
+- app/views/api_explorer/explorer/_params.html.erb
+- app/views/api_explorer/explorer/_request.html.erb
+- app/views/api_explorer/explorer/_shared.html.erb
+- app/views/api_explorer/explorer/form/_headers.html.erb
+- app/views/api_explorer/explorer/form/_param.html.erb
+- app/views/api_explorer/explorer/form/_params.html.erb
+- app/views/api_explorer/explorer/form/_url_params.html.erb
+- app/views/api_explorer/explorer/index.html.erb
+- app/views/api_explorer/explorer/perform_request.html.erb
+- config/routes.rb
+- lib/api_explorer.rb
+- lib/api_explorer/description.rb
+- lib/api_explorer/dsl.rb
+- lib/api_explorer/dsl/base_proxy.rb
+- lib/api_explorer/dsl/description_proxy.rb
+- lib/api_explorer/dsl/group_proxy.rb
+- lib/api_explorer/dsl/request_proxy.rb
+- lib/api_explorer/engine.rb
+- lib/api_explorer/group.rb
+- lib/api_explorer/header.rb
+- lib/api_explorer/node.rb
+- lib/api_explorer/parameter.rb
+- lib/api_explorer/request.rb
+- lib/api_explorer/version.rb
+- lib/rails_api_explorer.rb
+- lib/tasks/api_explorer_tasks.rake
+homepage: https://github.com/maxhollmann/rails_api_explorer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides a simple DSL to describe your API, and let's you mount an interactive
+  sandbox to explore and test it.
+test_files: []