api_taster 0.3.0 → 0.4.0

data/README.md

@@ -1,8 +1,8 @@
 # ApiTaster [![Build Status](https://secure.travis-ci.org/fredwu/api_taster.png?branch=master)](http://travis-ci.org/fredwu/api_taster) [![Dependency Status](https://gemnasium.com/fredwu/api_taster.png)](https://gemnasium.com/fredwu/api_taster)
 
-A quick and easy way to visually test out your application's API.
+A quick and easy way to visually test out your Rails application's API.
 
-![](http://i.imgur.com/ryjOH.png)
+![](http://i.imgur.com/8Dnto.png)
 
 ## Why?
 
@@ -67,15 +67,23 @@ if Rails.env.development?
 end
 ```
 
-That's it! Enjoy! :)
+### Share Params with Test Factories
 
-## Obsolete / Mismatched Route Definitions Detection
+If you use a test factory such as [FactoryGirl](https://github.com/thoughtbot/factory_girl), you can require your test factories and share the params. For example in FactoryGirl you can use the `attributes_for(:name_of_factory)` method.
+
+### Missing Route Definitions Detection
+
+Instead of manually finding out which route definitions you need, API Taster provides a warning page that shows you all the missing definitions.
+
+![](http://i.imgur.com/vZb93.png)
+
+### 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)
+![](http://i.imgur.com/Fo7kQ.png)
 
-## Use with an Engine
+### 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

@@ -48,6 +48,8 @@ $.fn.extend({
 				var replacedAction = ApiTaster.formAction.replace(regex, paramValue);
 
 				form.attr("action", replacedAction);
+			} else {
+				ApiTaster.storeFormActionFor(form);
 			}
 		});
 	},

data/app/controllers/api_taster/routes_controller.rb

@@ -2,7 +2,8 @@ module ApiTaster
   class RoutesController < ApplicationController
     def index
       @routes = Route.grouped_routes
-      @has_obsolete_definitions = Route.obsolete_definitions.size > 0
+      @has_missing_definitions  = Route.missing_definitions.present?
+      @has_obsolete_definitions = Route.obsolete_definitions.present?
     end
 
     def show
@@ -10,6 +11,10 @@ module ApiTaster
       @inputs = Route.inputs_for(@route)
     end
 
+    def missing_definitions
+      @missing_definitions = Route.missing_definitions
+    end
+
     def obsolete_definitions
       @obsolete_definitions = Route.obsolete_definitions
     end

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

@@ -0,0 +1,8 @@
+<li>
+  <a href="<%= path %>">
+    <div class="label-api">
+      <span class="label label-warning">Warning</span>
+    </div>
+    <%= text %>
+  </a>
+</li>

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

@@ -0,0 +1,7 @@
+<pre class="prettyprint lang-rb">ApiTaster.routes do
+
+    <% routes.each do |route| %>
+  <%= route[:verb].downcase %> '<%= route[:path] %>'<%= ", #{route[:params]}" if route[:params].present? %>
+
+    <% end %>
+end</pre>

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

@@ -2,16 +2,20 @@
   <div id="list-api-div" class="span5">
     <div class="div-container">
       <ul class="well nav nav-list">
-        <% if @has_obsolete_definitions %>
+        <% if @has_missing_definitions || @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>
+          <% if @has_missing_definitions %>
+            <%= render 'information_warning_li',
+              :text => 'Missing Definitions Detected',
+              :path => missing_definitions_routes_path
+            %>
+          <% end %>
+          <% if @has_obsolete_definitions %>
+            <%= render 'information_warning_li',
+              :text => 'Obsolete Definitions Detected',
+              :path => obsolete_definitions_routes_path
+            %>
+          <% end %>
         <% end %>
         <% @routes.each do |controller, routes| %>
           <li class="nav-header"><%= controller %></li>

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

@@ -0,0 +1,12 @@
+<%= render 'breadcrumb',
+  :parent     => 'Information',
+  :current    => 'Missing Definitions Detected',
+  :label      => 'Warning',
+  :label_type => 'warning'
+%>
+
+<div class="alert alert-warning">
+  <p>The following route definitions are missing from <code>ApiTaster.routes</code>.</p>
+
+  <%= render 'route_definitions', :routes => @missing_definitions %>
+</div>

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

@@ -5,14 +5,8 @@
   :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>
+<div class="alert alert-warning">
+  <p>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.</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>
+  <%= render 'route_definitions', :routes => @obsolete_definitions %>
 </div>

data/config/routes.rb

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

data/lib/api_taster.rb

@@ -8,7 +8,11 @@ module ApiTaster
   def self.routes(&block)
     Route.route_set            = Rails.application.routes
     Route.inputs               = {}
+    Route.missing_definitions  = []
     Route.obsolete_definitions = []
+
     Mapper.instance_eval(&block)
+
+    Route.calculate_missing_definitions
   end
 end

data/lib/api_taster/form_builder.rb

@@ -20,16 +20,7 @@ module ApiTaster
 
     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
+        if value.is_a?(Hash)
           parent_labels << label
 
           @_buffer += render(
@@ -38,10 +29,27 @@ module ApiTaster
           )
 
           add_to_buffer(value, parent_labels)
+        elsif value.is_a?(Array)
+          value.each do |v|
+            add_element_to_buffer(parent_labels, "[#{label}][]", v)
+          end
+        else
+          add_element_to_buffer(parent_labels, label, value)
         end
       end
     end
 
+    def add_element_to_buffer(parent_labels, label, value)
+      @_buffer += render(
+        :partial => 'api_taster/routes/param_form_element',
+        :locals  => {
+          :label      => "#{print_labels(parent_labels)}#{label}",
+          :label_text => label,
+          :value      => value.to_s
+        }
+      )
+    end
+
     def print_labels(parent_labels)
       "[#{parent_labels * ']['}]"
     end

data/lib/api_taster/route.rb

@@ -2,6 +2,7 @@ module ApiTaster
   class Route
     cattr_accessor :route_set
     cattr_accessor :inputs
+    cattr_accessor :missing_definitions
     cattr_accessor :obsolete_definitions
 
     class << self
@@ -13,7 +14,7 @@ module ApiTaster
           next if route.app.is_a?(Sprockets::Environment)
           next if route.app == ApiTaster::Engine
 
-          if rack_app = discover_rack_app(route.app)
+          if (rack_app = discover_rack_app(route.app)) && rack_app.respond_to?(:routes)
             rack_app.routes.routes.each do |rack_route|
               _routes << normalise_route(rack_route, i+=1)
             end
@@ -50,8 +51,21 @@ module ApiTaster
         inputs[route[:id]].collect { |input| split_input(input, route) }
       end
 
+      def calculate_missing_definitions
+        routes.each do |route|
+          if undefined_route?(route)
+            self.missing_definitions << route
+          end
+        end
+      end
+
       private
 
+      def undefined_route?(route)
+        r = inputs_for(route)
+        r.is_a?(Hash) && r.has_key?(:undefined)
+      end
+
       def discover_rack_app(app)
         class_name = app.class.name.to_s
         if class_name == "ActionDispatch::Routing::Mapper::Constraints"

data/lib/api_taster/version.rb

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

data/spec/controllers/api_taster/routes_controller_spec.rb

@@ -18,6 +18,12 @@ module ApiTaster
       assigns(:inputs).should be_kind_of(Array)
     end
 
+    it "#missing_definitions" do
+      get :missing_definitions, :use_route => :api_taster
+
+      assigns(:missing_definitions).should be_kind_of(Array)
+    end
+
     it "#obsolete_definitions" do
       get :obsolete_definitions, :use_route => :api_taster
 

data/spec/dummy/config/routes.rb

@@ -19,7 +19,7 @@ ApiTaster.routes do
     :user => {
       :name => 'Fred',
       :comment => {
-        :title => 'hi!'
+        :title => [1, 2, 3]
       }
     }
   }

data/spec/form_builder_spec.rb

@@ -13,7 +13,9 @@ module ApiTaster
       FormBuilder.new({
         :hello => 'world',
         :nested => {
-          :foo => 'bar'
+          :foo => 'bar',
+          :integer => 1,
+          :array => [1, 2, 3]
         }
       })
     end
@@ -25,5 +27,19 @@ module ApiTaster
     it "outputs html" do
       builder.html.should match('bar')
     end
+
+    context "data types" do
+      it "does strings" do
+        builder.html.should match('value="world"')
+      end
+
+      it "does numbers" do
+        builder.html.should match('value="1"')
+      end
+
+      it "does arrays" do
+        builder.html.should match(/name="\[nested\]\[array\]\[\]" value="2"/)
+      end
+    end
   end
 end

data/spec/mapper_spec.rb

@@ -6,7 +6,7 @@ module ApiTaster
       before(:all) do
         routes = ActionDispatch::Routing::RouteSet.new
         routes.draw do
-          # nothing
+          get '/awesome_route' => 'awesome#route'
         end
 
         ApiTaster.routes do

data/spec/route_spec.rb

@@ -23,6 +23,7 @@ module ApiTaster
           resources :comments
         end
         mount Rails.application => '/app'
+        mount proc {} => '/rack_app'
       end
 
       Route.route_set = routes
@@ -71,6 +72,19 @@ module ApiTaster
       end
     end
 
+    it "#missing_definitions" do
+      routes = ActionDispatch::Routing::RouteSet.new
+      routes.draw do
+        get 'awesome_route' => 'awesome#route'
+      end
+      Rails.application.stub(:routes).and_return(routes)
+      ApiTaster.routes do
+        # nothing
+      end
+
+      Route.missing_definitions.first[:path].should == '/awesome_route'
+    end
+
     context "private methods" do
       it "#discover_rack_app" do
         klass = Class.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_taster
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-21 00:00:00.000000000 Z
+date: 2012-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -182,10 +182,13 @@ files:
 - 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/_information_warning_li.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/_route_definitions.html.erb
 - app/views/api_taster/routes/_undefined_route.html.erb
 - app/views/api_taster/routes/index.html.erb
+- app/views/api_taster/routes/missing_definitions.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
@@ -351,7 +354,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2945703428300743977
+      hash: -907459549939205334
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -360,7 +363,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2945703428300743977
+      hash: -907459549939205334
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24