api_taster 0.4.5 → 0.4.6

data/README.md

@@ -1,6 +1,6 @@
 # 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 Rails application's API.
+A quick and easy way to visually test your Rails application's API.
 
 ![](http://i.imgur.com/8Dnto.png)
 
@@ -11,8 +11,8 @@ There are already many awesome API clients (such as [Postman](https://chrome.goo
 API Taster compared to alternatives, have the following advantages:
 
 - API endpoints are automatically generated from your Rails routes definition
-- Defining post params is as easy as defining routes
-- Post params can be shared with your test factories
+- Defining params is as easy as defining routes
+- Params can be shared with your test factories
 
 ## Usage
 
@@ -29,14 +29,6 @@ Rails.application.routes.draw do
 end
 ```
 
-Add API Taster into the autoload paths in `development.rb`:
-
-```ruby
-config.autoload_paths += %W(
-  #{ApiTaster::Engine.root}
-)
-```
-
 In `routes.rb`, define parameters for each API endpoint after the normal routes definition block. For example:
 
 ```ruby

data/app/controllers/api_taster/routes_controller.rb

@@ -10,7 +10,7 @@ module ApiTaster
 
     def show
       @route  = Route.find(params[:id])
-      @inputs = Route.params_for(@route)
+      @params = Route.params_for(@route)
     end
 
     def missing_definitions

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

@@ -5,39 +5,39 @@
   :label_type => 'important'
 %>
 
-<% if @inputs.is_a?(Hash) && @inputs.has_key?(:undefined) %>
-  <%= render 'undefined_route', :route => @inputs[:undefined] %>
+<% if @params.is_a?(Hash) && @params.has_key?(:undefined) %>
+  <%= render 'undefined_route', :route => @params[:undefined] %>
 <% else %>
-  <% @inputs.each do |input| %>
+  <% @params.each do |param| %>
     <%= form_tag @route[:path], :method => @route[:verb], :class => 'well form-horizontal', :remote => true do %>
 
-      <% if input[:url_params].empty? && input[:post_params].empty? %>
+      <% if param[:url_params].empty? && param[:post_params].empty? %>
         <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>
+          <% if param[:url_params].present? %>
+            <li<% unless param[:post_params].present? %> class="active"<% end %>><a href="#" id="url-params">URL</a></li>
           <% end %>
-          <% if input[:post_params].present? %>
+          <% if param[:post_params].present? %>
             <li class="active"><a href="#" id="post-params">POST</a></li>
           <% end %>
         </ul>
       <% end %>
 
-      <% if input[:url_params].present? %>
+      <% if param[:url_params].present? %>
         <fieldset ref="url-params">
-          <% input[:url_params].each do |label, value| %>
+          <% param[: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? %>
+      <% if param[:post_params].present? %>
         <fieldset ref="post-params">
-          <%= ApiTaster::FormBuilder.new(input[:post_params]).html.html_safe %>
+          <%= ApiTaster::FormBuilder.new(param[:post_params]).html.html_safe %>
         </fieldset>
       <% end %>
 

data/lib/api_taster/route.rb

@@ -7,6 +7,7 @@ module ApiTaster
     cattr_accessor :obsolete_definitions
 
     class << self
+
       def map_routes
         self.route_set            = Rails.application.routes
         self.supplied_params      = {}
@@ -18,8 +19,8 @@ module ApiTaster
       end
 
       def normalise_routes!
+        @_route_counter = 0
         self.routes = []
-        i = -1
 
         unless route_set.respond_to?(:routes)
           raise ApiTaster::Exception.new('Route definitions are missing, have you defined ApiTaster.routes?')
@@ -31,14 +32,16 @@ module ApiTaster
 
           if (rack_app = discover_rack_app(route.app)) && rack_app.respond_to?(:routes)
             rack_app.routes.routes.each do |rack_route|
-              self.routes << normalise_route(rack_route, i+=1)
+              self.routes << normalise_route(rack_route, route.path.spec)
             end
           end
 
           next if route.verb.source.empty?
 
-          self.routes << normalise_route(route, i+=1)
+          self.routes << normalise_route(route)
         end
+
+        self.routes.flatten!
       end
 
       def grouped_routes
@@ -84,14 +87,16 @@ module ApiTaster
         end
       end
 
-      def normalise_route(route, id)
-        {
-          :id   => id,
-          :name => route.name,
-          :verb => route.verb.source.gsub(/[$^]/, ''),
-          :path => route.path.spec.to_s.sub('(.:format)', ''),
-          :reqs => route.requirements
-        }
+      def normalise_route(route, path_prefix = nil)
+        route.verb.source.split('|').map do |verb|
+          {
+            :id   => @_route_counter+=1,
+            :name => route.name,
+            :verb => verb.gsub(/[$^]/, ''),
+            :path => path_prefix.to_s + route.path.spec.to_s.sub('(.:format)', ''),
+            :reqs => route.requirements
+          }
+        end
       end
 
       def split_input(input, route)

data/lib/api_taster/version.rb

@@ -1,3 +1,3 @@
 module ApiTaster
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

data/spec/controllers/api_taster/routes_controller_spec.rb

@@ -15,7 +15,7 @@ module ApiTaster
       get :show, :id => 1, :use_route => :api_taster
 
       assigns(:route).should be_kind_of(Route)
-      assigns(:inputs).should be_kind_of(Array)
+      assigns(:params).should be_kind_of(Array)
     end
 
     it "#missing_definitions" do

data/spec/dummy/config/routes.rb

@@ -2,6 +2,7 @@ Rails.application.routes.draw do
   mount ApiTaster::Engine => "/api_taster"
 
   get 'home' => 'application#home', :as => :home
+  match 'custom' => 'application#home', :via => [:get, :delete]
 
   resources :users, :except => [:new, :edit] do
     resources :comments, :only => [:new, :edit]

data/spec/route_spec.rb

@@ -2,9 +2,16 @@ require 'spec_helper'
 
 module ApiTaster
   describe Route do
+    context "undefined ApiTaster.routes" do
+      it "errors out" do
+        Route.route_set = nil
+        expect { Route.normalise_routes! }.to raise_exception(ApiTaster::Exception)
+      end
+    end
+
     let(:app_home_route) do
       {
-        :id   => 0,
+        :id   => 1,
         :name => 'home',
         :verb => 'GET',
         :path => '/home',
@@ -19,6 +26,7 @@ module ApiTaster
       routes = ActionDispatch::Routing::RouteSet.new
       routes.draw do
         get 'home' => 'application#home', :as => :home
+        match 'dual_action' => 'dummy/action', :via => [:get, :delete]
         resources :users do
           resources :comments
         end
@@ -34,11 +42,13 @@ module ApiTaster
       Route.routes.first.should == app_home_route
     end
 
-    context "undefined ApiTaster.routes" do
-      it "errors out" do
-        Route.route_set = nil
-        expect { Route.normalise_routes! }.to raise_exception(ApiTaster::Exception)
-      end
+    it "finds rack app routes" do
+      Route.find_by_verb_and_path(:get, '/app/home').should_not == nil
+    end
+
+    it "outputs routes for all verbs" do
+      Route.find_by_verb_and_path(:get, '/dual_action').should_not == nil
+      Route.find_by_verb_and_path(:delete, '/dual_action').should_not == nil
     end
 
     it "#grouped_routes" do
@@ -49,7 +59,7 @@ module ApiTaster
     end
 
     it "#find" do
-      Route.find(0).should == app_home_route
+      Route.find(1).should == app_home_route
       Route.find(999).should == nil
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_taster
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000 Z
+date: 2012-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -339,7 +339,6 @@ files:
 - spec/dummy/tmp/cache/sass/f455898439b6313d4297be03fbcfa4df713cf294/_bootstrap.scssc
 - spec/dummy/tmp/cache/sass/fced329c33ec1fff188d99efbc4d1fd1c556b66a/bootstrap.min.cssc
 - spec/dummy/tmp/cache/sass/fced329c33ec1fff188d99efbc4d1fd1c556b66a/layout.css.scssc
-- spec/dummy/tmp/pids/server.pid
 homepage: https://github.com/fredwu/api_taster
 licenses: []
 post_install_message: 
@@ -354,7 +353,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4235987413395832386
+      hash: -1174127571206954277
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -363,7 +362,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4235987413395832386
+      hash: -1174127571206954277
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -501,7 +500,6 @@ test_files:
 - spec/dummy/tmp/cache/sass/f455898439b6313d4297be03fbcfa4df713cf294/_bootstrap.scssc
 - spec/dummy/tmp/cache/sass/fced329c33ec1fff188d99efbc4d1fd1c556b66a/bootstrap.min.cssc
 - spec/dummy/tmp/cache/sass/fced329c33ec1fff188d99efbc4d1fd1c556b66a/layout.css.scssc
-- spec/dummy/tmp/pids/server.pid
 - spec/form_builder_spec.rb
 - spec/mapper_spec.rb
 - spec/route_spec.rb