api_taster 0.2.2 → 0.3.0

data/README.md

@@ -69,6 +69,12 @@ end
 
 That's it! Enjoy! :)
 
+## Obsolete / Mismatched Route Definitions Detection
+
+APIs evolve - especially during the development stage. To keep `ApiTaster.routes` in sync with your route definitions, API Taster provides a warning page that shows you the definitions that are obsolete/mismatched therefore you could correct or remove them.
+
+![](http://i.imgur.com/rqYiY.png)
+
 ## 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:

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

@@ -1,17 +1,23 @@
 var ApiTaster = {
+
 	formAction: '',
+
 	disableUrlParams: function() {
 		$("fieldset[ref=url-params] input").prop("disabled", true);
 	},
+
 	enableUrlParams: function() {
 		$("fieldset[ref=url-params] input").prop("disabled", false);
 	},
+
 	storeFormActionFor: function(form) {
 		ApiTaster.formAction = form.attr("action")
 	},
+
 	restoreFormActionFor: function(form) {
 		$(form).attr("action", ApiTaster.formAction);
 	},
+
 	detectContentType: function(response) {
 		var contentType = response.getResponseHeader("Content-Type");
 		var detectedContentType = null
@@ -22,9 +28,11 @@ var ApiTaster = {
 
 		return detectedContentType;
 	}
+
 };
 
 $.fn.extend({
+
 	replaceUrlParams: function(params) {
 		var form = this;
 
@@ -43,6 +51,7 @@ $.fn.extend({
 			}
 		});
 	},
+
 	enableNavTabsFor: function(contentElement) {
 		var container = this;
 
@@ -56,6 +65,7 @@ $.fn.extend({
 			$(contentElement + "[ref=" + $(this).attr("id") + "]", container).show();
 		});
 	},
+
 	showNavTab: function(name) {
 		$("ul.nav-tabs li", this).removeClass("active");
 		$("ul.nav-tabs li a#response-" + name, this).parent().show().addClass("active");
@@ -64,17 +74,19 @@ $.fn.extend({
 
 		return $("pre[ref=response-" + name + "]", this).show();
 	},
+
 	displayOnlySelectedParamsFieldset: function() {
 		$("fieldset", this).hide();
 		$("fieldset[ref=" + $("ul.nav-tabs li.active a").attr("id") + "]", this).show();
 	}
+
 });
 
 jQuery(function($) {
-	$("a.show-api").click(function(e) {
+	$("#list-api-div a").click(function(e) {
 		e.preventDefault();
 
-		$("a.show-api").parent().removeClass("active");
+		$(this).parent().siblings().removeClass("active");
 		$(this).parent().addClass("active");
 
 		$("#show-api-div .div-container").load(this.href, function() {

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

@@ -74,7 +74,7 @@ legend {
   text-align: right;
 }
 
-.breadcrumb-controller {
+.breadcrumb-parent {
   font-weight: bold;
   color: $colour_grey;
 }

data/app/controllers/api_taster/routes_controller.rb

@@ -2,11 +2,16 @@ module ApiTaster
   class RoutesController < ApplicationController
     def index
       @routes = Route.grouped_routes
+      @has_obsolete_definitions = Route.obsolete_definitions.size > 0
     end
 
     def show
       @route  = Route.find(params[:id])
       @inputs = Route.inputs_for(@route)
     end
+
+    def obsolete_definitions
+      @obsolete_definitions = Route.obsolete_definitions
+    end
   end
 end

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

@@ -0,0 +1,9 @@
+<ul class="breadcrumb">
+  <li class="breadcrumb-parent"><%= parent %><span class="divider">/</span></li>
+  <li>
+    <div class="label-api">
+      <span class="label label-<%= label_type %>"><%= label %></span>
+    </div>
+    <strong><%= current %></strong>
+  </li>
+</ul>

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

@@ -2,6 +2,8 @@
   <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

@@ -2,11 +2,22 @@
   <div id="list-api-div" class="span5">
     <div class="div-container">
       <ul class="well nav nav-list">
+        <% if @has_obsolete_definitions %>
+          <li class="nav-header">Information</li>
+          <li>
+            <a href="<%= obsolete_definitions_routes_path %>">
+              <div class="label-api">
+                <span class="label label-warning">Warning</span>
+              </div>
+              Obsolete Definitions Detected
+            </a>
+          </li>
+        <% end %>
         <% @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]) %>">
+              <a href="<%= route_path(route[:id]) %>">
                 <div class="label-api label-api-full">
                   <span class="label label-important"><%= route[:verb] %></span>
                 </div>

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

@@ -0,0 +1,18 @@
+<%= render 'breadcrumb',
+  :parent     => 'Information',
+  :current    => 'Obsolete Definitions Detected',
+  :label      => 'Warning',
+  :label_type => 'warning'
+%>
+
+<div class="alert alert-error">
+  <p><strong>The following route definitions are found within <code>ApiTaster.routes</code> but they are not defined in your routes. Please feel free to correct or remove them.</strong></p>
+
+  <pre class="prettyprint lang-rb">ApiTaster.routes do
+
+    <% @obsolete_definitions.each do |route| %>
+  <%= route[:verb].downcase %> '<%= route[:path] %>'<%= ", #{route[:params]}" if route[:params].present? %>
+
+    <% end %>
+end</pre>
+</div>

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

@@ -1,12 +1,9 @@
-<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>
+<%= render 'breadcrumb',
+  :parent     => @route[:reqs][:controller].humanize,
+  :current    => @route[:path],
+  :label      => @route[:verb],
+  :label_type => 'important'
+%>
 
 <% if @inputs.is_a?(Hash) && @inputs.has_key?(:undefined) %>
   <%= render 'undefined_route', :route => @inputs[:undefined] %>

data/config/routes.rb

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

data/lib/api_taster.rb

@@ -6,8 +6,9 @@ require 'api_taster/form_builder'
 
 module ApiTaster
   def self.routes(&block)
-    Route.route_set = Rails.application.routes
-    Route.inputs    = {}
+    Route.route_set            = Rails.application.routes
+    Route.inputs               = {}
+    Route.obsolete_definitions = []
     Mapper.instance_eval(&block)
   end
 end

data/lib/api_taster/mapper.rb

@@ -22,8 +22,16 @@ module ApiTaster
       def map_method(method, path, params)
         route = Route.find_by_verb_and_path(method, path)
 
-        Route.inputs[route[:id]] ||= []
-        Route.inputs[route[:id]] << params
+        if route.nil?
+          Route.obsolete_definitions << {
+            :verb   => method,
+            :path   => path,
+            :params => params
+          }
+        else
+          Route.inputs[route[:id]] ||= []
+          Route.inputs[route[:id]] << params
+        end
       end
     end
   end

data/lib/api_taster/route.rb

@@ -2,6 +2,7 @@ module ApiTaster
   class Route
     cattr_accessor :route_set
     cattr_accessor :inputs
+    cattr_accessor :obsolete_definitions
 
     class << self
       def routes

data/lib/api_taster/version.rb

@@ -1,3 +1,3 @@
 module ApiTaster
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/spec/controllers/api_taster/routes_controller_spec.rb

@@ -17,5 +17,11 @@ module ApiTaster
       assigns(:route).should be_kind_of(Route)
       assigns(:inputs).should be_kind_of(Array)
     end
+
+    it "#obsolete_definitions" do
+      get :obsolete_definitions, :use_route => :api_taster
+
+      assigns(:obsolete_definitions).should be_kind_of(Array)
+    end
   end
 end

data/spec/dummy/config/routes.rb

@@ -9,6 +9,10 @@ Rails.application.routes.draw do
 end
 
 ApiTaster.routes do
+  get '/i_dont_exist_anymore', {
+    :hello => 'world'
+  }
+
   get '/users'
 
   post '/users', {

data/spec/mapper_spec.rb

@@ -2,6 +2,25 @@ require 'spec_helper'
 
 module ApiTaster
   describe Mapper do
+    context "non-existing routes" do
+      before(:all) do
+        routes = ActionDispatch::Routing::RouteSet.new
+        routes.draw do
+          # nothing
+        end
+
+        ApiTaster.routes do
+          get '/dummy_route'
+        end
+
+        Route.route_set = routes
+      end
+
+      it "records obsolete definitions" do
+        Route.obsolete_definitions.first[:path].should == '/dummy_route'
+      end
+    end
+
     before(:all) do
       Rails.application.routes.draw { resources :dummy_users }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_taster
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -181,10 +181,12 @@ files:
 - app/controllers/api_taster/application_controller.rb
 - app/controllers/api_taster/routes_controller.rb
 - app/helpers/api_taster/application_helper.rb
+- app/views/api_taster/routes/_breadcrumb.html.erb
 - app/views/api_taster/routes/_param_form_element.html.erb
 - app/views/api_taster/routes/_param_form_legend.html.erb
 - app/views/api_taster/routes/_undefined_route.html.erb
 - app/views/api_taster/routes/index.html.erb
+- app/views/api_taster/routes/obsolete_definitions.html.erb
 - app/views/api_taster/routes/show.html.erb
 - app/views/layouts/api_taster/application.html.erb
 - config/routes.rb
@@ -349,7 +351,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3781747277784541610
+      hash: 2945703428300743977
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -358,7 +360,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3781747277784541610
+      hash: 2945703428300743977
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24