restapi 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -1,15 +1,12 @@
 source "http://rubygems.org"
 
 gem "rails", "3.0.11"
-gem "capybara", ">= 0.4.0"
 gem "sqlite3"
 
 group :development, :test do
   gem "rspec-rails"
-  gem "ZenTest"
-  gem "rcov"
+  #gem "rcov"
+  gem "redcarpet"
+  gem "RedCloth"
+  gem "rake"
 end
-
-# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
-#gem 'ruby-debug'
-# gem 'ruby-debug19'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.6.2)
+    RedCloth (4.2.9)
     abstract (1.0.0)
     actionmailer (3.0.11)
       actionpack (= 3.0.11)
@@ -31,19 +31,9 @@ GEM
     activesupport (3.0.11)
     arel (2.0.10)
     builder (2.1.2)
-    capybara (1.1.2)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      selenium-webdriver (~> 2.0)
-      xpath (~> 0.1.4)
-    childprocess (0.3.1)
-      ffi (~> 1.0.6)
     diff-lcs (1.1.3)
     erubis (2.6.6)
       abstract (>= 1.0.0)
-    ffi (1.0.11)
     i18n (0.5.0)
     json (1.6.5)
     mail (2.2.19)
@@ -52,8 +42,6 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.17.2)
-    multi_json (1.0.4)
-    nokogiri (1.5.0)
     polyglot (0.3.3)
     rack (1.2.5)
     rack-mount (0.6.14)
@@ -75,9 +63,9 @@ GEM
       rdoc (~> 3.4)
       thor (~> 0.14.4)
     rake (0.9.2.2)
-    rcov (1.0.0)
     rdoc (3.12)
       json (~> 1.4)
+    redcarpet (2.1.1)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -91,28 +79,20 @@ GEM
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec (~> 2.8.0)
-    rubyzip (0.9.6.1)
-    selenium-webdriver (2.19.0)
-      childprocess (>= 0.2.5)
-      ffi (~> 1.0.9)
-      multi_json (~> 1.0.4)
-      rubyzip
     sqlite3 (1.3.5)
     thor (0.14.6)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.31)
-    xpath (0.1.4)
-      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  ZenTest
-  capybara (>= 0.4.0)
+  RedCloth
   rails (= 3.0.11)
-  rcov
+  rake
+  redcarpet
   rspec-rails
   sqlite3

data/README.rdoc

@@ -0,0 +1,3 @@
+= Rails API documentation generator
+
+{<img src="https://secure.travis-ci.org/Pajk/rails-restapi.png?branch=master" alt="Build Status" />}[http://travis-ci.org/Pajk/rails-restapi]

data/app/controllers/restapi/restapis_controller.rb

@@ -4,21 +4,12 @@ module Restapi
     
     def index
       respond_to do |format|
-        format.json { render :json => Restapi.to_json(params[:resource], params[:method]) }
+        format.json do
+          render :json => Restapi.to_json(params[:resource], params[:method])
+        end
         format.html
       end
     end
 
-    protected
-
-    helper_method :restapi_javascript_src
-    def restapi_javascript_src(file)
-      "#{Restapi.configuration.doc_base_url}/javascripts/#{file}"
-    end
-
-    helper_method :restapi_stylesheet_src
-    def restapi_stylesheet_src(file)
-      "#{Restapi.configuration.doc_base_url}/stylesheets/#{file}"
-    end
   end
 end

data/app/public/restapi/javascripts/jst.js

@@ -9,11 +9,13 @@ Restapi.Templates.Index = _.template(
         <thead><tr><th>Resource</th><th>Description</th></tr></thead> \
         <tbody> \
           <% _.each(api.methods, function(m) { %> \
-            <tr> \
-              <td><a href='<%= m.doc_url %>'><%= m.http_method %> <%= m.api_url %></a></td> \
-              <td width='60%'><%= m['short_description'] %></td> \
-            </tr> \
-            <% }) %> \
+            <% _.each(m.apis, function(api) { %> \
+              <tr> \
+                <td><a href='<%= m.doc_url %>'><%= api.http_method %> <%= api.api_url %></a></td> \
+                <td width='60%'><%= api.short_description %></td> \
+              </tr> \
+            <% }) %>\
+          <% }) %> \
         </tbody> \
        </table> \
      <% }) %>");
@@ -29,30 +31,38 @@ Restapi.Templates.Resource = _.template(
         <div><%= resource.full_description %></div> \
       <% } %> \
     <div class='accordion' id='accordion'> \
-      <% _.each(resource.methods, function(api) { %> \
+      <% _.each(resource.methods, function(m) { %> \
         <hr><div class=''> \
-          <div class='pull-right small'><a href='<%= api.doc_url %>'> >>> </a></div> \
+          <div class='pull-right small'><a href='<%= m.doc_url %>'> >>> </a></div> \
           <div> \
-            <a href='#description-<%= api.name %>' class='accordion-toggle' data-toggle='collapse' data-parent='#accordion'> \
-              <h3><%= api.http_method %> <%= api.api_url %></a><br> \
-            <small><%= api.short_description %></small></h3>\
+            <% _.each(m.apis, function(api) { %> \
+              <h3> \
+                <a href='#description-<%= m.name %>' \
+                   class='accordion-toggle' \
+                   data-toggle='collapse' \
+                   data-parent='#accordion'> \
+                  <%= api.http_method %> <%= api.api_url %> \
+                </a> <br> \
+                <small><%= api.short_description %></small> \
+              </h3> \
+            <% }) %> \
           </div> \
-          <div id='description-<%= api.name %>' class='collapse accordion-body'> \
-            <%= api.full_description %> \
-            <% if(api.errors != '') { %> \
+          <div id='description-<%= m.name %>' class='collapse accordion-body'> \
+            <%= m.full_description %> \
+            <% if(m.errors != '') { %> \
               <h2>Errors</h2> \
-              <% _.each(api.errors, function(err) { %> \
+              <% _.each(m.errors, function(err) { %> \
                 <%= err.code %> \
                 <%= err.description %> \
                 <br> \
               <% }) %> \
             <% } %> \
-            <% if(api.params != ''){ %> \
+            <% if(m.params != ''){ %> \
               <h2>Params</h2> \
               <table class='table'> \
                 <thead><tr><th>Param name</th><th>Description</th></tr></thead> \
                 <tbody> \
-                  <% _.each(api.params, function(val) { %> \
+                  <% _.each(m.params, function(val) { %> \
                     <tr><td><strong><%= val.name %></strong><br>\
                     <small><%= val.required ? 'required' : 'optional' %></small></td> \
                     <td><%= val.description %><br>\
@@ -68,13 +78,22 @@ Restapi.Templates.Resource = _.template(
      
 Restapi.Templates.Method = _.template(
 "<ul class='breadcrumb'> \
-  <li><a href='<%= docs.doc_url %>'><%= docs.name %></a><span class='divider'>/</span></li> \
-  <li><a href='<%= resource.doc_url %>'><%= resource.name %></a><span class='divider'>/</span></li> \
+  <li> \
+    <a href='<%= docs.doc_url %>'><%= docs.name %></a> \
+    <span class='divider'>/</span> \
+  </li> \
+  <li> \
+    <a href='<%= resource.doc_url %>'><%= resource.name %></a> \
+    <span class='divider'>/</span> \
+  </li> \
   <li class='active'><%= method.name %></li> \
 </ul> \
-<div class='page-header'><h1><%= method.http_method %> <%= method.api_url %><br> \
-  <small><%= method.short_description %></small></h1> \
-</div> \
+<% _.each(method.apis, function(api) { %> \
+  <div class='page-header'> \
+    <h1><%= api.http_method %> <%= api.api_url %><br> \
+    <small><%= api.short_description %></small></h1> \
+    </div> \
+<% }) %> \
 <div> \
   <%= method.full_description %> \
   <% if(method.errors != '') { %> \
@@ -105,4 +124,4 @@ Restapi.Templates.Method = _.template(
       </tbody> \
     </table> \
   <% } %> \
-</div>");
+</div>");

data/app/public/restapi/javascripts/restapi.js

@@ -1,14 +1,13 @@
 var Restapi = {
   Routers: {},
   Templates: {},
+  Rendered: false,
   
   init: function() {
     new Restapi.Routers.Documentation();
-    var base = '/' + window.location.pathname.split('/')[1];
-    Backbone.history.start({pushState: true, root: base});
-  },
-
-  baseurl: function() { return document.location.toString().replace(/#.*/,""); }
+    var base = window.location.pathname;
+    Backbone.history.start({root: base});
+  }
 };
 
 $(document).ready(function() {

data/app/public/restapi/javascripts/routers/documentation_router.js

@@ -11,21 +11,25 @@ Restapi.Routers.Documentation = Backbone.Router.extend({
   },
 
   index: function() {
-    this.render('index');
+    var url = window.location.pathname + '.json';
+    this.render('index', url);
   },
   
   resource: function(resource) {
-    this.render('resource');
+    var url = [window.location.pathname, resource + '.json'].join('/');
+    this.render('resource', url);
   },
   
   method: function(resource, method) {
-    this.render('method');
+    var url = [window.location.pathname, resource, method +'.json'].join('/');
+    this.render('method', url);
   },
   
-  render: function(type) {
-    this.data = $.getJSON(window.location.pathname + '.json', function(data) {
-      $('#api-title').html(data.docs.name).attr('href', data.docs.doc_url);
-      $('footer').html(data.docs.copyright);
+  render: function(type, url) {
+    this.data = $.getJSON(url, function(data) {
+      if(!Restapi.rendered) {
+        $('footer').html(data.docs.copyright);
+      }
       
       var html = '';
       if (type == 'index') {
@@ -40,7 +44,8 @@ Restapi.Routers.Documentation = Backbone.Router.extend({
         });
       }
       
-      $("#container").append(html);
+      $("#container").html(html);
+      Restapi.rendered = true;
     });
   }
 

data/lib/restapi.rb

@@ -1,6 +1,4 @@
 require 'active_support/dependencies'
-require 'rdoc'
-require 'rdoc/markup/to_html'
 
 # add path to restapi controller to ActiveSupport paths
 %w{ controllers views }.each do |dir|
@@ -11,6 +9,7 @@ require 'rdoc/markup/to_html'
 end
 
 require "restapi/routing"
+require "restapi/markup"
 require "restapi/restapi_module"
 require "restapi/method_description"
 require "restapi/resource_description"

data/lib/restapi/application.rb

@@ -1,4 +1,3 @@
-require 'ostruct'
 require 'restapi/static_dispatcher'
 
 module Restapi
@@ -23,37 +22,38 @@ module Restapi
     end
     
     # create new method api description
-    def define_method_description(resource_name, method_name)
-      resource_name = get_resource_name(resource_name)
-
-      puts "defining api for #{resource_name}:#{method_name}"
-
+    def define_method_description(controller, method_name)
       # create new or get existing api
+      resource_name = get_resource_name(controller)
       key = [resource_name, method_name].join('#')
-      @method_descriptions[key] ||= Restapi::MethodDescription.new(method_name, resource_name, self)
+      # add method description key to resource description
+      resource = define_resource_description(controller)
 
-      # add mapi key to resource api
-      define_resource_description(resource_name).add_method(key)
+      method_description = Restapi::MethodDescription.new(method_name, resource, self)
+
+      @method_descriptions[key] ||= method_description
 
       @method_descriptions[key]
     end
 
     # create new resource api description
-    def define_resource_description(resource_name, &block)
-      resource_name = get_resource_name(resource_name)
+    def define_resource_description(controller, &block)
+      resource_name = get_resource_name(controller)
 
-      @resource_descriptions[resource_name] ||= Restapi::ResourceDescription.new(resource_name, &block)
+      # puts "defining api for #{resource_name}"
+
+      @resource_descriptions[resource_name] ||=
+        Restapi::ResourceDescription.new(controller, resource_name, &block)
+    end
+
+    def add_method_description_args(args)
+      @last_api_args << MethodDescription::Api.new(args)
     end
     
     # check if there is some saved description
     def restapi_provided?
       true unless last_api_args.blank?
     end
-    
-    # List of all the apis defined in the given scope (and its sub-scopes).
-    # def mapis_for_resource(resource_name)
-      # @method_descriptions.select { |key,val| key.first == controller_name }
-    # end
 
     # get api for given method
     def get_method_description(resource_name, method_name)
@@ -90,9 +90,9 @@ module Restapi
 
     # clear all saved data
     def clear_last
-      @last_api_args = nil
-      @last_errors = Array.new
-      @last_params = Hash.new
+      @last_api_args = []
+      @last_errors = []
+      @last_params = []
       @last_description = nil
     end
         
@@ -124,7 +124,12 @@ module Restapi
     def to_json(resource_name, method_name)
       
       _resources = if resource_name.blank?
-        resource_descriptions.collect { |_,v| v.to_json }
+        # take just resources which have some methods because
+        # we dont want to show eg ApplicationController as resource
+        resource_descriptions.inject({}) do |result, (k,v)|
+          result[k] = v.to_json unless v._methods.blank?
+          result
+        end
       else
         [@resource_descriptions[resource_name].to_json(method_name)]
       end
@@ -134,7 +139,7 @@ module Restapi
           'name' => Restapi.configuration.app_name,
           'info' => Restapi.configuration.app_info,
           'copyright' => Restapi.configuration.copyright,
-          'doc_url' => Restapi.configuration.doc_base_url,
+          'doc_url' => "#{ENV["RAILS_RELATIVE_URL_ROOT"]}#{Restapi.configuration.doc_base_url}",
           'api_url' => Restapi.configuration.api_base_url,
           'resources' => _resources
         }
@@ -146,7 +151,7 @@ module Restapi
       def get_resource_name(klass)
         if klass.class == String
           klass
-        elsif klass.class == Class && klass.ancestors.include?(ActionController::Base)
+        elsif klass.class == Class && ActionController::Base.descendants.include?(klass)
           klass.controller_name
         end
       end

data/lib/restapi/dsl_definition.rb

@@ -2,8 +2,7 @@
 
 module Restapi
 
-  # DSL is a module that provides #api, #error, #param, #error.  Use this
-  # when you'd like to use restapi outside the top level scope.
+  # DSL is a module that provides #api, #error, #param, #error.
 
   module DSL
 
@@ -29,7 +28,7 @@ module Restapi
     #       :method => "GET"
     #
     def api(args)
-      Restapi.last_api_args = args
+      Restapi.add_method_description_args(args)
     end
 
     # Describe the next method.
@@ -70,7 +69,7 @@ module Restapi
     #   end
     #
     def param(param_name, *args, &block)
-      Restapi.last_params[param_name.to_sym] = Restapi::ParamDescription.new(param_name, *args, &block)
+      Restapi.last_params << Restapi::ParamDescription.new(param_name, *args, &block)
     end
     
     # create method api and redefine newly added method
@@ -80,12 +79,9 @@ module Restapi
       
       return unless Restapi.restapi_provided?
       
-      method_name = method_name.to_sym
-      resource_name = self.controller_name
-
-      # remove mapi if exists and create new one
-      Restapi.remove_method_description(resource_name, method_name)
-      mapi = Restapi.define_method_description(resource_name, method_name)
+      # remove method description if exists and create new one
+      Restapi.remove_method_description(self, method_name)
+      description = Restapi.define_method_description(self, method_name)
 
       # redefine method only if validation is turned on
       if Restapi.configuration.validate == true
@@ -94,7 +90,7 @@ module Restapi
         
         define_method(method_name) do |*args|
           
-          mapi.params.each do |_, param|
+          description.params.each do |_, param|
 
             # check if required parameters are present
             if param.required && !params.has_key?(param.name)
@@ -116,4 +112,4 @@ module Restapi
       
     end # def method_added
   end # module DSL
-end # module Restapi
+end # module Restapi