api_taster 0.1.0

data/app/assets/javascripts/api_taster/app.js

@@ -0,0 +1,88 @@
+var ApiTaster = {
+	formAction: '',
+	disableUrlParams: function() {
+		$("#url-params input").prop("disabled", true);
+	},
+	enableUrlParams: function() {
+		$("#url-params input").prop("disabled", false);
+	},
+	storeFormActionFor: function(form) {
+		ApiTaster.formAction = form.attr("action")
+	},
+	restoreFormActionFor: function(form) {
+		$(form).attr("action", ApiTaster.formAction);
+	}
+};
+
+$.fn.extend({
+	replaceUrlParams: function(params) {
+		var form = this;
+
+		$.each(params, function(i, param) {
+			var matches = param["name"].match(/\[api_taster_url_params\](.*)/)
+			if (matches) {
+				var paramKey   = matches[1];
+				var paramValue = param["value"];
+
+				ApiTaster.storeFormActionFor(form);
+
+				var regex = new RegExp(":" + paramKey);
+				var replacedAction = ApiTaster.formAction.replace(regex, paramValue);
+
+				form.attr("action", replacedAction);
+			}
+		});
+	}
+});
+
+jQuery(function($) {
+	$("a.show-api").click(function(e) {
+		e.preventDefault();
+
+		$("a.show-api").parent().removeClass("active");
+		$(this).parent().addClass("active");
+
+		$("#show-api-div").load(this.href, function() {
+			prettyPrint();
+		});
+	});
+
+	$("#show-api-div").on("click", "#submit-api", function() {
+		$(this).parents("form").submit(function() {
+			$(this).unbind("submit").ajaxSubmit({
+				beforeSubmit: function(arr, $form, options) {
+					$form.replaceUrlParams(arr);
+					ApiTaster.disableUrlParams();
+					return false;
+				}
+			});
+		});
+
+		$("form").bind("ajax:complete", function(e, xhr, status) {
+			ApiTaster.enableUrlParams();
+			ApiTaster.restoreFormActionFor(this);
+
+			if ($("#show-api-response-div:visible").length == 0) {
+				$("#show-api-response-div").slideDown(100);
+			}
+
+			$("#show-api-response-div pre[ref=response-raw]").text(xhr.responseText);
+			$("#show-api-response-div pre[ref=response-json]").text(
+				JSON.stringify(JSON.parse(xhr.responseText), null, 2)
+			);
+
+			prettyPrint();
+		});
+
+		$("#show-api-response-div ul.nav-tabs a").click(function(e) {
+			e.preventDefault();
+
+			$(this).parent().siblings().removeClass("active");
+			$(this).parent().addClass("active");
+
+			$("pre", "#show-api-response-div").hide();
+			$("pre[ref=" + $(this).attr("id") + "]", "#show-api-response-div").show();
+		});
+	});
+});
+

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

@@ -0,0 +1,16 @@
+// 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require bootstrap
+//= require_tree .

data/app/assets/stylesheets/api_taster/01-prettify.css

@@ -0,0 +1 @@
+.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}

data/app/assets/stylesheets/api_taster/02-prettify-sunburst.css

@@ -0,0 +1,51 @@
+/* Pretty printing styles. Used with prettify.js. */
+/* Vim sunburst theme by David Leibovic */
+
+pre .str, code .str { color: #65B042; } /* string  - green */
+pre .kwd, code .kwd { color: #E28964; } /* keyword - dark pink */
+pre .com, code .com { color: #AEAEAE; font-style: italic; } /* comment - gray */
+pre .typ, code .typ { color: #89bdff; } /* type - light blue */
+pre .lit, code .lit { color: #3387CC; } /* literal - blue */
+pre .pun, code .pun { color: #fff; } /* punctuation - white */
+pre .pln, code .pln { color: #fff; } /* plaintext - white */
+pre .tag, code .tag { color: #89bdff; } /* html/xml tag    - light blue */
+pre .atn, code .atn { color: #bdb76b; } /* html/xml attribute name  - khaki */
+pre .atv, code .atv { color: #65B042; } /* html/xml attribute value - green */
+pre .dec, code .dec { color: #3387CC; } /* decimal - blue */
+
+pre.prettyprint, code.prettyprint {
+	background-color: #000;
+	-moz-border-radius: 8px;
+	-webkit-border-radius: 8px;
+	-o-border-radius: 8px;
+	-ms-border-radius: 8px;
+	-khtml-border-radius: 8px;
+	border-radius: 8px;
+}
+
+pre.prettyprint {
+	width: 95%;
+	margin: 1em auto;
+	padding: 1em;
+	white-space: pre-wrap;
+}
+
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums { margin-top: 0; margin-bottom: 0; color: #AEAEAE; } /* IE indents via margin-left */
+li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8 { list-style-type: none }
+/* Alternate shading for lines */
+li.L1,li.L3,li.L5,li.L7,li.L9 { }
+
+@media print {
+  pre .str, code .str { color: #060; }
+  pre .kwd, code .kwd { color: #006; font-weight: bold; }
+  pre .com, code .com { color: #600; font-style: italic; }
+  pre .typ, code .typ { color: #404; font-weight: bold; }
+  pre .lit, code .lit { color: #044; }
+  pre .pun, code .pun { color: #440; }
+  pre .pln, code .pln { color: #000; }
+  pre .tag, code .tag { color: #006; font-weight: bold; }
+  pre .atn, code .atn { color: #404; }
+  pre .atv, code .atv { color: #060; }
+}

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

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/api_taster/layout.css.scss

@@ -0,0 +1,51 @@
+@import "bootstrap";
+
+$colour_text: #333;
+$colour_grey: #999;
+
+body {
+  padding-top: 50px;
+  padding-bottom: 50px;
+}
+
+.hidden {
+  display: none;
+}
+
+.form-actions {
+  padding-bottom: 0;
+  margin-bottom: 0;
+}
+
+legend {
+  font-size: 14px;
+  font-weight: bold;
+  color: $colour_grey;
+
+  &.super-legend {
+    color: $colour_text;
+  }
+}
+
+.label-api {
+  display: inline-block;
+  padding-right: 5px;
+}
+
+.label-api-full {
+  width: 50px;
+  text-align: right;
+}
+
+.breadcrumb-controller {
+  font-weight: bold;
+  color: $colour_grey;
+}
+
+#show-api-response-div {
+  pre.nowrap {
+    overflow-x: auto;
+    white-space: pre;
+    word-wrap: normal;
+  }
+}

data/app/controllers/api_taster/application_controller.rb

@@ -0,0 +1,5 @@
+module ApiTaster
+  class ApplicationController < ActionController::Base
+    layout proc { |controller| controller.request.xhr? ? nil : 'api_taster/application' }
+  end
+end

data/app/controllers/api_taster/routes_controller.rb

@@ -0,0 +1,12 @@
+module ApiTaster
+  class RoutesController < ApplicationController
+    def index
+      @routes = Route.grouped_routes
+    end
+
+    def show
+      @route  = Route.find(params[:id])
+      @inputs = Route.inputs_for(@route)
+    end
+  end
+end

data/app/helpers/api_taster/application_helper.rb

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

data/app/views/api_taster/routes/_param_form_element.html.erb

@@ -0,0 +1,6 @@
+<div class="control-group">
+  <label class="control-label" for="<%= label %>"><%= defined?(label_text) ? label_text : label %></label>
+  <div class="controls">
+    <input type="text" name="<%= label %>" value="<%= value %>"></input>
+  </div>
+</div>

data/app/views/api_taster/routes/_param_form_legend.html.erb

@@ -0,0 +1 @@
+<legend><%= label %></legend>

data/app/views/api_taster/routes/_undefined_route.html.erb

@@ -0,0 +1,7 @@
+<div class="alert alert-error">
+  <p><strong><%= "Route '#{route[:verb]} #{route[:path]}' is undefined." %></strong></p>
+  <p>Please define this route in <code>routes.rb</code>:</p>
+  <pre class="prettyprint lang-rb">ApiTaster.routes do
+  <%= route[:verb].downcase %> '<%= route[:path] %>', {}
+end</pre>
+</div>

data/app/views/api_taster/routes/index.html.erb

@@ -0,0 +1,24 @@
+<div class="row">
+  <div class="span5">
+    <ul class="well nav nav-list">
+      <% @routes.each do |controller, routes| %>
+        <li class="nav-header"><%= controller %></li>
+        <% routes.each do |route| %>
+          <li>
+            <a class="show-api" href="<%= route_path(route[:id]) %>">
+              <div class="label-api label-api-full">
+                <span class="label label-important"><%= route[:verb] %></span>
+              </div>
+              <strong><%= route[:path] %></strong>
+            </a>
+          </li>
+        <% end %>
+      <% end %>
+    </ul>
+  </div>
+  <div id="show-api-div" class="span7">
+    <div class="alert alert-block alert-info">
+      <h3>Select an API endpoint on the left to get started. :)</h3>
+    </div>
+  </div>
+</div>

data/app/views/api_taster/routes/show.html.erb

@@ -0,0 +1,55 @@
+<ul class="breadcrumb">
+  <li class="breadcrumb-controller"><%= @route[:reqs][:controller].humanize %><span class="divider">/</span></li>
+  <li>
+    <div class="label-api">
+      <span class="label label-important"><%= @route[:verb] %></span>
+    </div>
+    <strong><%= @route[:path] %></strong>
+  </li>
+</ul>
+
+<% if @inputs.is_a?(Hash) && @inputs.has_key?(:undefined) %>
+  <%= render 'undefined_route', :route => @inputs[:undefined] %>
+<% else %>
+  <% @inputs.each do |input| %>
+    <%= form_tag @route[:path], :method => @route[:verb], :class => 'well form-horizontal', :remote => true do %>
+
+      <% if input[:url_params].empty? && input[:post_params].empty? %>
+        <div class="alert alert-info">
+          No params specified.
+        </div>
+      <% end %>
+
+      <% if input[:url_params].present? %>
+        <fieldset id="url-params">
+          <legend class="super-legend">URL Params</legend>
+          <% input[:url_params].each do |label, value| %>
+            <%= render 'param_form_element', :label => "[api_taster_url_params]#{label}", :value => value, :label_text => label %>
+          <% end %>
+        </fieldset>
+      <% end %>
+
+      <% if input[:post_params].present? %>
+        <fieldset>
+          <legend class="super-legend">Post Params</legend>
+          <%= ApiTaster::FormBuilder.new(input[:post_params]).html.html_safe %>
+        </fieldset>
+      <% end %>
+
+      <div class="form-actions">
+        <input id="submit-api" type="submit" class="btn btn-primary pull-right"></input>
+      </div>
+
+    <% end %>
+  <% end %>
+<% end %>
+
+<div id="show-api-response-div" class="well hidden">
+  <legend class="super-legend">Response</legend>
+  <ul class="nav nav-tabs">
+    <li class="active"><a href="#" id="response-json">JSON</a></li>
+    <li><a href="#" id="response-raw">Raw</a></li>
+  </ul>
+  <pre class="prettyprint nowrap" ref="response-json"></pre>
+  <pre class="prettyprint hidden" ref="response-raw"></pre>
+</div>

data/app/views/layouts/api_taster/application.html.erb

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>API Taster</title>
+  <%= stylesheet_link_tag    "api_taster/application", :media => "all" %>
+  <%= javascript_include_tag "api_taster/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <div class="navbar navbar-fixed-top">
+    <div class="navbar-inner">
+      <div class="container">
+        <h1><a class="brand" href="<%= root_path %>">API Taster</a></h1>
+        <div class="nav-collapse collapse">
+          <ul class="nav pull-right">
+            <li>
+              <a href="/" target="_blank"><%= Rails.application.class.name %> <i class="icon-share-alt icon-white"></i></a>
+            </li>
+          </ul>
+        </div>
+      </div>
+    </div>
+  </div>
+
+  <div class="container">
+    <%= yield %>
+  </div>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+ApiTaster::Engine.routes.draw do
+  resources :routes, :only => [:index, :show]
+
+  root :to => 'routes#index'
+end

data/lib/api_taster.rb

@@ -0,0 +1,13 @@
+require 'active_support/dependencies'
+require 'api_taster/engine'
+require 'api_taster/route'
+require 'api_taster/mapper'
+require 'api_taster/form_builder'
+
+module ApiTaster
+  def self.routes(&block)
+    Route.route_set = Rails.application.routes
+    Route.inputs    = {}
+    Mapper.instance_eval(&block)
+  end
+end

data/lib/api_taster/engine.rb

@@ -0,0 +1,17 @@
+module ApiTaster
+  class Engine < ::Rails::Engine
+    isolate_namespace ApiTaster
+
+    config.generators do |g|
+      g.test_framework :rspec, :view_specs => false
+    end
+
+    silence_warnings do
+      begin
+        require 'pry'
+        IRB = Pry
+        rescue LoadError
+      end
+    end
+  end
+end

data/lib/api_taster/form_builder.rb

@@ -0,0 +1,49 @@
+module ApiTaster
+  class FormBuilder < AbstractController::Base
+    include AbstractController::Rendering
+    include ActionView::Context
+    include ActionView::Helpers::CaptureHelper
+
+    self.view_paths = ApiTaster::Engine.root.join('app/views')
+
+    def initialize(params)
+      flush_output_buffer
+      @_buffer = ''
+      add_to_buffer(params)
+    end
+
+    def html
+      @_buffer
+    end
+
+    private
+
+    def add_to_buffer(params, parent_labels = [])
+      params.each do |label, value|
+        if value.is_a?(String)
+          @_buffer += render(
+            :partial => 'api_taster/routes/param_form_element',
+            :locals  => {
+              :label      => "#{print_labels(parent_labels)}#{label}",
+              :label_text => label,
+              :value      => value
+            }
+          )
+        else
+          parent_labels << label
+
+          @_buffer += render(
+            :partial => 'api_taster/routes/param_form_legend',
+            :locals  => { :label => print_labels(parent_labels) }
+          )
+
+          add_to_buffer(value, parent_labels)
+        end
+      end
+    end
+
+    def print_labels(parent_labels)
+      "[#{parent_labels * ']['}]"
+    end
+  end
+end