api_taster 0.2.0 → 0.2.1

data/README.md

@@ -2,7 +2,7 @@
 
 A quick and easy way to visually test out your application's API.
 
-![](http://i.imgur.com/1kyEk.png)
+![](http://i.imgur.com/ryjOH.png)
 
 ## Why?
 
@@ -19,17 +19,17 @@ API Taster compared to alternatives, have the following advantages:
 Add API Taster in your gemfile:
 
 ```ruby
-gem 'api_taster'
+gem 'api_taster', :group => :development
 ```
 Mount API Taster, this will allow you to visit API Taster from within your app. For example:
 
 ```ruby
 Rails.application.routes.draw do
-  mount ApiTaster::Engine => "/api_taster"
+  mount ApiTaster::Engine => "/api_taster" if Rails.env.development?
 end
 ```
 
-Add API Taster into the autoload paths in `application.rb`:
+Add API Taster into the autoload paths in `development.rb`:
 
 ```ruby
 config.autoload_paths += %W(
@@ -40,33 +40,52 @@ config.autoload_paths += %W(
 In `routes.rb`, define parameters for each API endpoint after the normal routes definition block. For example:
 
 ```ruby
-ApiTaster.routes do
-  get '/users'
-
-  post '/users', {
-    :user => {
-      :name => 'Fred'
+if Rails.env.development?
+  ApiTaster.routes do
+    get '/users'
+
+    post '/users', {
+      :user => {
+        :name => 'Fred'
+      }
     }
-  }
 
-  get '/users/:id', {
-    :id => 1
-  }
+    get '/users/:id', {
+      :id => 1
+    }
 
-  put '/users/:id', {
-    :id => 1, :user => {
-      :name => 'Awesome'
+    put '/users/:id', {
+      :id => 1, :user => {
+        :name => 'Awesome'
+      }
     }
-  }
 
-  delete '/users/:id', {
-    :id => 1
-  }
+    delete '/users/:id', {
+      :id => 1
+    }
+  end
 end
 ```
 
 That's it! Enjoy! :)
 
+## Use with an Engine
+
+Rails Engines are largely self contained and separated from your main app. Therefore, to use API Taster with an Engine, you would need some extra efforts:
+
+In your app Gemfile, you would also need:
+
+```ruby
+gem "jquery-rails"
+gem "bootstrap-sass"
+```
+
+If you are hand-picking Rails components, make sure in your `application.rb` you have Sprockets enabled:
+
+```ruby
+require "sprockets/railtie"
+```
+
 ## License
 
 This gem is released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).

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

@@ -1,10 +1,10 @@
 var ApiTaster = {
 	formAction: '',
 	disableUrlParams: function() {
-		$("#url-params input").prop("disabled", true);
+		$("fieldset[ref=url-params] input").prop("disabled", true);
 	},
 	enableUrlParams: function() {
-		$("#url-params input").prop("disabled", false);
+		$("fieldset[ref=url-params] input").prop("disabled", false);
 	},
 	storeFormActionFor: function(form) {
 		ApiTaster.formAction = form.attr("action")
@@ -32,6 +32,23 @@ $.fn.extend({
 				form.attr("action", replacedAction);
 			}
 		});
+	},
+	enableNavTabsFor: function(contentElement) {
+		var container = this;
+
+		$("ul.nav-tabs a", container).click(function(e) {
+			e.preventDefault();
+
+			$(this).parent().siblings().removeClass("active");
+			$(this).parent().addClass("active");
+
+			$(contentElement, container).hide();
+			$(contentElement + "[ref=" + $(this).attr("id") + "]", container).show();
+		});
+	},
+	displayOnlySelectedParamsFieldset: function() {
+		$("fieldset", this).hide();
+		$("fieldset[ref=" + $("ul.nav-tabs li.active a").attr("id") + "]", this).show();
 	}
 });
 
@@ -42,8 +59,11 @@ jQuery(function($) {
 		$("a.show-api").parent().removeClass("active");
 		$(this).parent().addClass("active");
 
-		$("#show-api-div").load(this.href, function() {
+		$("#show-api-div .div-container").load(this.href, function() {
 			prettyPrint();
+
+			$("#show-api-div form").enableNavTabsFor("fieldset");
+			$("#show-api-div form").displayOnlySelectedParamsFieldset();
 		});
 	});
 
@@ -74,15 +94,7 @@ jQuery(function($) {
 			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();
-		});
+		$("#show-api-response-div").enableNavTabsFor("pre");
 	});
 });
 

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

@@ -3,11 +3,38 @@
 $colour_text: #333;
 $colour_grey: #999;
 
+// layout
+
+body, html {
+  height: 100%;
+  overflow: hidden;
+}
+
 body {
-  padding-top: 50px;
-  padding-bottom: 50px;
 }
 
+#wrapper {
+  height: 100%;
+
+  #main-container {
+    height: 100%;
+    overflow: hidden;
+    padding-top: 50px;
+  }
+}
+
+#list-api-div,
+#show-api-div {
+  height: 100%;
+  overflow: auto;
+
+  .div-container {
+    padding-bottom: 50px;
+  }
+}
+
+// elements
+
 .hidden {
   display: none;
 }
@@ -22,11 +49,21 @@ legend {
   font-weight: bold;
   color: $colour_grey;
 
-  &.super-legend {
-    color: $colour_text;
+  &.compact-legend {
+    padding: 0;
+    font-size: 12px;
+    line-height: 24px;
   }
 }
 
+.nav-label {
+  padding: 8px 12px;
+  line-height: 18px;
+  margin-right: 5px;
+  font-weight: bold;
+  color: $colour_grey;
+}
+
 .label-api {
   display: inline-block;
   padding-right: 5px;

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

@@ -1 +1 @@
-<legend><%= label %></legend>
+<legend class="compact-legend"><%= label %></legend>

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

@@ -1,24 +1,28 @@
-<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>
+<div id="main-container" class="row">
+  <div id="list-api-div" class="span5">
+    <div class="div-container">
+      <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 %>
-      <% end %>
-    </ul>
+      </ul>
+    </div>
   </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 class="div-container">
+      <div class="alert alert-block alert-info">
+        <h3>Select an API endpoint on the left to get started. :)</h3>
+      </div>
     </div>
   </div>
 </div>

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

@@ -18,11 +18,20 @@
         <div class="alert alert-info">
           No params specified.
         </div>
+      <% else %>
+        <ul class="nav nav-tabs">
+          <li class="nav-label">Request</li>
+          <% if input[:url_params].present? %>
+            <li<% unless input[:post_params].present? %> class="active"<% end %>><a href="#" id="url-params">URL</a></li>
+          <% end %>
+          <% if input[:post_params].present? %>
+            <li class="active"><a href="#" id="post-params">POST</a></li>
+          <% end %>
+        </ul>
       <% end %>
 
       <% if input[:url_params].present? %>
-        <fieldset id="url-params">
-          <legend class="super-legend">URL Params</legend>
+        <fieldset ref="url-params">
           <% input[:url_params].each do |label, value| %>
             <%= render 'param_form_element', :label => "[api_taster_url_params]#{label}", :value => value, :label_text => label %>
           <% end %>
@@ -30,8 +39,7 @@
       <% end %>
 
       <% if input[:post_params].present? %>
-        <fieldset>
-          <legend class="super-legend">Post Params</legend>
+        <fieldset ref="post-params">
           <%= ApiTaster::FormBuilder.new(input[:post_params]).html.html_safe %>
         </fieldset>
       <% end %>
@@ -45,8 +53,8 @@
 <% end %>
 
 <div id="show-api-response-div" class="well hidden">
-  <legend class="super-legend">Response</legend>
   <ul class="nav nav-tabs">
+    <li class="nav-label">Response</li>
     <li class="active"><a href="#" id="response-json">JSON</a></li>
     <li><a href="#" id="response-raw">Raw</a></li>
   </ul>

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

@@ -22,7 +22,7 @@
     </div>
   </div>
 
-  <div class="container">
+  <div id="wrapper" class="container">
     <%= yield %>
   </div>
 </body>

data/lib/api_taster/version.rb

@@ -1,3 +1,3 @@
 module ApiTaster
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/dummy/config/routes.rb

@@ -13,7 +13,10 @@ ApiTaster.routes do
 
   post '/users', {
     :user => {
-      :name => 'Fred'
+      :name => 'Fred',
+      :comment => {
+        :title => 'hi!'
+      }
     }
   }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_taster
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000 Z
+date: 2012-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -349,7 +349,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1097102219077556863
+      hash: 2843027510352515993
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -358,7 +358,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1097102219077556863
+      hash: 2843027510352515993
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24