rapidoc 0.0.6 → 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19849b869a7892e7201a4eb86c4b72cac46d99dd
+  data.tar.gz: 49e69db36a4e329cf25413d758e0ecc980c2611b
+SHA512:
+  metadata.gz: 8992fc2d53b76afe72ffe258b6ce7431b81c743e9eddde3d80e931a234c1e4b84c36a927ff959eb8584ab986106e60dddee9e6bc68e85b479bebfe8112fa0bfe
+  data.tar.gz: 5a9ca90ce4ce17ed9dd7c2cfad814e0b94b6c28eba77c76afcdde43a7f7a71522a9956113d38dec2875b93b9aac8c2683eeb4bc41db62b4fccbf3141abfd3733

data/.gitignore

@@ -5,6 +5,8 @@
 .config
 .yardoc
 .rvmrc
+.ruby-version
+.ruby-gemset
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.rdoc

@@ -1,6 +1,6 @@
 = Rapidoc
 
-REST API documentation generator for rails projects ( 0.06 version ).
+REST API documentation generator for rails projects ( 0.07 version ).
 
 This gem let you generate API documentation of your rails project in html format.
 It uses routes information, rapidoc comments and json examples for generate
@@ -17,10 +17,14 @@ Add this line to your application's Gemfile:
 
     gem 'rapidoc'
 
-And then execute:
+Then execute:
 
     $ bundle
 
+And finally, run:
+
+    rake rapidoc:install
+
 == Usage
 
 For generate documentation run:
@@ -129,6 +133,11 @@ For more details and options please visit the Wiki[https://github.com/drinor/rap
 
 * Simple and intuitive navigation.
 
+== Contributors
+
+* harchs[https://github.com/harchs] 
+* ljrzarate[https://github.com/ljrzarate]
+
 == Contributing
 
 1. Fork it

data/lib/rapidoc.rb

@@ -21,15 +21,30 @@ module Rapidoc
 
   METHODS = [ "GET", "PUT", "DELETE", "POST" ]
 
-  def create_structure
-    # should be done in this order
-    FileUtils.mkdir target_dir unless File.directory? target_dir
-    FileUtils.mkdir actions_dir unless File.directory? actions_dir
+  def create_config_structure
     FileUtils.cp_r GEM_CONFIG_DIR + "/.", config_dir unless File.directory? config_dir
-    FileUtils.cp_r GEM_ASSETS_DIR, target_dir
     FileUtils.mkdir examples_dir unless File.directory? examples_dir
   end
 
+  def create_doc_structure
+    FileUtils.mkdir_p target_dir unless File.directory? target_dir
+    FileUtils.mkdir_p actions_dir unless File.directory? actions_dir
+    FileUtils.cp_r GEM_ASSETS_DIR, target_dir
+  end
+
+  def create_folders_for_file(file)
+    route_dir = file.split("/")
+    route_dir.pop
+    route_dir = route_dir.join("/")
+    FileUtils.mkdir route_dir unless File.directory? route_dir
+  end
+
+  def create_folders_for_files(files)
+    files.each do |file|
+      create_folders_for_file file
+    end
+  end
+
   def remove_structure
     remove_doc
     remove_config
@@ -40,12 +55,13 @@ module Rapidoc
   end
 
   def remove_doc
-    FileUtils.rm_r target_dir if File.directory? target_dir
+    FileUtils.rm_r "#{::Rails.root}/public/docs" if File.directory? "#{::Rails.root}/public/docs"
   end
 
   def reset_structure
     remove_structure
-    create_structure
+    create_config_structure
+    create_doc_structure
   end
 
   def remove_examples
@@ -54,7 +70,6 @@ module Rapidoc
 
   def generate_doc
     resources_doc = get_resources
-
     generate_index_template( resources_doc )
     generate_actions_templates( resources_doc )
   end

data/lib/rapidoc/action_doc.rb

@@ -10,8 +10,8 @@ module Rapidoc
   #
   class ActionDoc
     attr_reader :resource, :urls, :action, :action_method, :description,
-      :response_formats, :authentication, :params, :file, :http_responses,
-      :errors, :example_res, :example_req
+      :response_formats, :authentication, :params, :headers, :file, :http_responses,
+      :errors, :example_res, :example_req, :resource_name
 
     ##
     # @param resource [String] resource name
@@ -19,11 +19,12 @@ module Rapidoc
     # @param urls [Array] all urls that call this method
     #
     def initialize( routes_info, controller_info, examples_route )
+      @resource_name    = routes_info[:resource].split('/').last
       @resource         = routes_info[:resource].to_s
       @action           = routes_info[:action].to_s
       @action_method    = routes_info[:method].to_s || '-----'
       @urls             = routes_info[:urls]
-      @file             = @resource + '_' + @action
+      @file             = @resource + '/' + @action
 
       puts " - Generating #{@action} action documentation..." if trace?
 
@@ -43,6 +44,7 @@ module Rapidoc
       @description      = controller_info["description"]
       @response_formats = default_response_formats || controller_info["response_formats"]
       @params           = controller_info["params"]
+      @headers          = controller_info["headers"]
       @http_responses   = get_http_responses controller_info["http_responses"]
       @errors           = controller_info["errors"] ? controller_info["errors"].dup : []
       @authentication   = get_authentication controller_info["authentication_required"]
@@ -50,7 +52,7 @@ module Rapidoc
     end
 
     def get_authentication( required_authentication )
-      if [ true, false ].include? required_authentication 
+      if [ true, false ].include? required_authentication
         required_authentication
       else
         default_authentication
@@ -75,14 +77,14 @@ module Rapidoc
     end
 
     def load_request( examples_route )
-      file = examples_route + '/' + @resource + '_' + @action + '_request.json'
+      file = examples_route + '/' + @resource + '/' + @action + '_request.json'
       return unless File.exists?( file )
       puts "  + Loading request examples..." if trace?
       File.open( file ){ |f| @example_req = JSON.pretty_generate( JSON.parse(f.read) ) }
     end
 
     def load_response( examples_route )
-      file = examples_route + '/' + @resource + '_' + @action + '_response.json'
+      file = examples_route + '/' + @resource + '/' + @action + '_response.json'
       return unless File.exists?( file )
       puts "  + Loading response examples..." if trace?
       File.open( file ){ |f| @example_res = JSON.pretty_generate( JSON.parse(f.read) ) }

data/lib/rapidoc/config.rb

@@ -80,7 +80,7 @@ module Rapidoc
       if File.exists?( config_file_path )
         form_file_name( target_dir_from_config, f )
       else
-        form_file_name( File.join( ::Rails.root.to_s, 'rapidoc' ), f )
+        form_file_name( File.join( ::Rails.root.to_s, 'public/docs' ), f )
       end
     end
 
@@ -110,9 +110,9 @@ module Rapidoc
 
     def target_dir_from_config
       if @@config and @@config.has_key?( "doc_route" )
-        File.join(::Rails.root.to_s, @@config['doc_route'] )
+        File.join(::Rails.root.to_s, "public/docs/#{@@config['doc_route']}" )
       else
-        File.join(::Rails.root.to_s, 'rapidoc' )
+        File.join(::Rails.root.to_s, 'public/docs' )
       end
     end
 

data/lib/rapidoc/http_response.rb

@@ -25,13 +25,15 @@ module Rapidoc
         when 204
           'No content'
         when 401
-          'Unauthorized'
+          'Access Denied'
         when 403
           'Forbidden'
         when 404
           'Not found'
         when 422
           'Unprocessable Entity'
+        when 400
+          'Bad Request'
         else
           ''
       end

data/lib/rapidoc/resource_doc.rb

@@ -15,8 +15,8 @@ module Rapidoc
     # @param routes_doc [RoutesDoc] routes documentation
     #
     def initialize( resource_name, routes_actions_info )
-      @name = resource_name.to_s
-      @controller_file = name.to_s.pluralize + '_controller' + controllers_extension
+      @name = resource_name.to_s.split('/').last
+      @controller_file = resource_name.to_s.pluralize + '_controller' + controllers_extension
 
       generate_info routes_actions_info
     end

data/lib/rapidoc/resources_extractor.rb

@@ -22,7 +22,7 @@ module Rapidoc
       routes = Dir.chdir( ::Rails.root.to_s ) { `rake routes` }
 
       routes.split("\n").each do |entry|
-        routes_doc.add_route( entry )
+        routes_doc.add_route( entry ) unless entry.match(/URI/)
       end
 
       routes_doc

data/lib/rapidoc/templates/action.html.hbs

@@ -5,17 +5,17 @@
     <title>Rapidoc - Action</title>
     <meta name="description" content="Artículo en GenbetaDev sobre Bootstrap 2.0">
     <meta name="author" content="Rafael Jurado González" >
-    <link href="../assets/css/bootstrap.min.css" rel="stylesheet">
-    <link href="../assets/css/rapidoc.css" rel="stylesheet">
-    <link href="../assets/css/bootstrap-responsive.min.css" rel="stylesheet">
-    <script src="../assets/js/jquery-1.9.0.min.js"></script>
-    <script src="../assets/js/bootstrap.min.js"></script>
-    <script src="../assets/js/json2.js"></script>
+    <link href="../../assets/css/bootstrap.min.css" rel="stylesheet">
+    <link href="../../assets/css/rapidoc.css" rel="stylesheet">
+    <link href="../../assets/css/bootstrap-responsive.min.css" rel="stylesheet">
+    <script src="../../assets/js/jquery-1.9.0.min.js"></script>
+    <script src="../../assets/js/bootstrap.min.js"></script>
+    <script src="../../assets/js/json2.js"></script>
     <style>
       body { padding-top: 60px; }
     </style>
   </head>
-  <body onload="prueba()">
+  <body>
 
     <div class="navbar navbar-fixed-top">
       <div class="navbar-inner">
@@ -28,9 +28,11 @@
           <a class="brand" href="#">{{info.project_name}}</a>
           <div class="nav-collapse">
             <ul class="nav">
-              <li><a href="../index.html">Resources</a></li>
+              <li><a href="../../index.html">Resources</a></li>
               <li class="active"><a href="#">Action</a></li>
-              <li><a target="_blank" href="https://github.com/drinor/rapidoc.git">Contact</a></li>
+              {{#if info.contact}}
+                <li><a target="_blank" href="{{info.contact}}">Contact</a></li>
+              {{/if}}
             </ul>
           </div>
         </div>
@@ -39,12 +41,13 @@
 
     <div class="container">
       <div class="page-header">
-        <h1><a href="../index.html?collapse=collapse{{action.resource}}">{{action.resource}}</a></h1>
+        <h1><a href="../../index.html?collapse=collapse{{action.resource}}">{{action.resource}}</a></h1>
       </div>
 
       <ul class="nav nav-tabs" id="myTab">
         <li class="active"><a href="#home">Home</a></li>
         {{#if action.params}}<li><a href="#params">Params</a></li>{{/if}}
+        {{#if action.headers}}<li><a href="#headers">Headers</a></li>{{/if}}
         {{#if action.errors}}<li><a href="#errors">Errors</a></li>{{/if}}
         {{#if action.example_req}}<li><a href="#request">Request</a></li>{{/if}}
         {{#if action.example_res}}<li><a href="#response">Response</a></li>{{/if}}
@@ -95,6 +98,7 @@
         {{#if action.params}}
         <div class="tab-pane my_tab" id="params">
           <table class="table table-hover" id="table-params">
+            <tr><th>Name</th><th>Type</th><th>Description</th><th>Format</th></tr>
             {{#each action.params}}
               <tr>
                 <td>
@@ -113,9 +117,28 @@
                   {{/if}}
                 </td>
                 <td>{{this.description}}</td>
+                <td>{{this.format}}</td>
               </tr>
             {{/each}}
-            <tr><td></td><td><td></td></tr>
+            <tr><td></td><td><td></td><td></td></tr>
+          </table>
+        </div>
+        {{/if}}
+
+        {{#if action.headers}}
+        <div class="tab-pane my_tab" id="headers">
+          <table class="table table-hover" id="table-headers">
+            <tr><th>Name</th><th>Description</th></tr>
+            {{#each action.headers}}
+              <tr>
+                <td>
+                  <strong>{{this.name}}</strong></br>
+                  <span class="small">required</span>
+                </td>
+                <td>{{this.description}}</td>
+              </tr>
+            {{/each}}
+            <tr><td></td><td><td></tr>
           </table>
         </div>
         {{/if}}

data/lib/rapidoc/templates/index.html.hbs

@@ -28,7 +28,9 @@
           <div class="nav-collapse">
             <ul class="nav">
               <li class="active"><a href="index.html">Resources</a></li>
-              <li><a  target="_blank" href="https://github.com/drinor/rapidoc.git">Contact</a></li>
+              {{#if info.contact}}
+                <li><a  target="_blank" href="{{info.contact}}">Contact</a></li>
+              {{/if}}
             </ul>
           </div>
         </div>
@@ -64,7 +66,7 @@
                     </td>
                     <td>
                       {{#if ../this.has_controller_info}}
-                        <a href="actions/{{../../this.resource}}_{{../../this.action}}.html">{{this}}<a>
+                        <a href="actions/{{../../this.resource_name}}/{{../../this.action}}.html">{{this}}<a>
                       {{else}}
                         {{this}}
                       {{/if}}
@@ -86,7 +88,6 @@
       <script>
         window.onload = function () { 
           var collapse = '#' + decodeURI( (RegExp(name + '=' + '(.+?)(&|$)').exec(location.search)||[,null])[1] );
-          console.log(collapse)
           $(collapse).collapse('show')
         }
       </script>

data/lib/rapidoc/templates_generator.rb

@@ -8,7 +8,6 @@ module Rapidoc
     def generate_index_template( resources_doc )
       template = get_index_template
       result = template.call( :info => rapidoc_config, :resources => resources_doc )
-
       File.open( target_dir("index.html"), 'w' ) { |file| file.write result }
     end
 
@@ -53,7 +52,14 @@ module Rapidoc
 
     def create_action_template( template, action_doc )
       result = template.call( :info => rapidoc_config, :action => action_doc )
-      File.open( actions_dir("#{action_doc.file}.html"), 'w' ) { |file| file.write result }
+      resource = action_doc.resource.split('/').last
+      action = action_doc.action
+      dir_name = File.dirname(actions_dir("#{resource}"))
+      dir_name += "/#{resource}"
+      unless File.directory?(dir_name)
+        FileUtils.mkdir_p(dir_name)
+      end
+      File.open( actions_dir("#{resource}/#{action}.html"), 'w' ) { |file| file.write result }
     end
 
     def get_action_template

data/lib/rapidoc/version.rb

@@ -1,3 +1,3 @@
 module Rapidoc
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/rapidoc/yaml_parser.rb

@@ -14,15 +14,15 @@ module Rapidoc
     #
     def extract_resource_info( lines, blocks, file_name )
       blocks ? info = [] : blocks = []
-
       blocks.each.map do |b|
         if lines[ b[:init] ].include? "=begin resource"
           n_lines = b[:end] - b[:init] - 1
-          
           begin
             info.push YAML.load( lines[ b[:init] +1, n_lines ].join.gsub(/\ *#/, '') )
-          rescue SyntaxError => e
+          rescue Psych::SyntaxError => e
             puts "Error parsing block in #{file_name} file [#{b[:init]} - #{b[:end]}]"
+          rescue => e
+            puts e
           end
         end
       end
@@ -44,7 +44,7 @@ module Rapidoc
       blocks.each do |b|
         if lines[ b[:init] ].include? "=begin action"
           n_lines = b[:end] - b[:init] - 1
-          
+
           begin
             info << YAML.load( lines[ b[:init] + 1, n_lines ].join.gsub(/\ *#/, '') )
           rescue Exception => e

data/lib/tasks/rapidoc.rake

@@ -2,16 +2,25 @@ include Rapidoc
 
 namespace :rapidoc do
 
+  desc "Generate config folder"
+  task :install do
+    create_config_structure
+  end
+
   desc "Generate the api documentation"
   task :generate do
-    load_config
-    create_structure
-    puts "Generating API documentation..."
-    generate_doc
-    puts "Completed API documentation generation"
+    if File.exists?( "#{::Rails.root}/config/rapidoc/rapidoc.yml" )
+      load_config
+      create_doc_structure
+      puts "Generating API documentation..."
+      generate_doc
+      puts "Completed API documentation generation"
+    else
+      puts "Need install rapidoc for run it, for install run rapidoc:install task"
+    end
   end
 
-  desc "Generate the config files"
+  desc "Remove the documentation"
   task :clean do
     remove_doc
   end

data/rapidoc.gemspec

@@ -4,21 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rapidoc/version'
 
 Gem::Specification.new do |gem|
+  gem.license       = "MIT"
   gem.name          = "rapidoc"
   gem.version       = Rapidoc::VERSION
-  gem.authors       = ["Rafael Jurado"]
-  gem.email         = ["rjurado@nosolosoftware.biz"]
+  gem.authors       = ["Rafael Jurado, Harold Rangel, Luis Rodriguez"]
+  gem.email         = ["rjurado@openmailbox.org, aarold.rangel@koombea.com, luis.rodriguez@koombea.com"]
   gem.description   = %q{Generates REST API documentation.}
   gem.summary       = %q{Generates REST API documentation.}
-  gem.homepage      = "https://github.com/drinor/rapidoc.git"
+  gem.homepage      = "https://github.com/drinor/rapidoc"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency  "rails", ">= 3.2.0"
-  gem.add_dependency  "handlebars", "~> 0.4.0"
+  gem.add_dependency  "rails", ">= 3.2"
+  gem.add_dependency  "handlebars", ">= 0.4.0"
   gem.add_development_dependency  "rspec-rails"
   gem.add_development_dependency  "sqlite3", "~> 1.3.7"
   gem.add_development_dependency  "capybara"