rails_api_doc 0.0.2

data/app/assets/stylesheets/rails_api_doc/parameters.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/rails_api_doc/projects.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/rails_api_doc/apis_controller.rb

@@ -0,0 +1,149 @@
+require_dependency "rails_api_doc/application_controller"
+
+module RailsApiDoc
+  class ApisController < ApplicationController
+    # GET /apis
+    # GET /apis.json
+    def index
+      @project = Project.find params[:project_id]
+      @apis = @project.apis.page(params[:page]).per(RailsApiDoc::Api::DEFAULT_PAGE_SIZE)
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @apis }
+      end
+    end
+  
+    # GET /apis/1
+    # GET /apis/1.json
+    def show
+      @project = Project.find params[:project_id]
+      @api = Api.find(params[:id])
+  
+      respond_to do |format|
+        format.html # show.html.erb
+        format.json { render json: @api }
+      end
+    end
+  
+    # GET /apis/new
+    # GET /apis/new.json
+    def new
+      @project = Project.find params[:project_id]
+      @api = @project.apis.new
+      @parameters = @api.parameters.build
+      @api.success_responses.build
+      @api.failure_responses.build
+  
+      respond_to do |format|
+        format.html # new.html.erb
+        format.json { render json: @api }
+      end
+    end
+  
+    # GET /apis/1/edit
+    def edit
+      @project = Project.find params[:project_id]
+      @api = Api.find(params[:id])
+    end
+  
+    # POST /apis
+    # POST /apis.json
+    def create
+      @project = Project.find params[:project_id]
+      @api = @project.apis.new(params[:api])
+      # paramerer_attr = params[:api][:parameters_attributes].delete_if { |k, v| v["name"].blank? }
+      respond_to do |format|
+        if @api.save
+          # paramerer_attr.each do |k, v|
+          #   debugger
+          #   @api.parameters.create(v)
+          # end
+          format.html { redirect_to project_apis_path, notice: 'Api was successfully created.' }
+          format.json { render json: @api, status: :created, location: @api }
+        else
+          format.html { render action: "new" }
+          format.json { render json: @api.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    # PUT /apis/1
+    # PUT /apis/1.json
+    def update
+      @project = Project.find params[:project_id]
+      @api = @project.apis.find(params[:id])
+      # @api.parameters.build
+      respond_to do |format|
+        if @api.update_attributes(params[:api])
+          format.html { redirect_to project_api_path(@project, @api), notice: 'Api was successfully updated.' }
+          format.json { head :no_content }
+        else
+          format.html { render action: "edit" }
+          format.json { render json: @api.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    # DELETE /apis/1
+    # DELETE /apis/1.json
+    def destroy
+      @project = Project.find params[:project_id]
+      @api = @project.apis.find(params[:id])
+      @api.destroy
+  
+      respond_to do |format|
+        format.html { redirect_to project_apis_path }
+        format.json { head :no_content }
+      end
+    end
+
+    def generate_doc
+      @project = Project.find params[:project_id]
+      puts "dir>>>>>>>>>>>>>>>#{Dir.pwd}"
+      project_name = @project.name.gsub(" ", "_")
+      _dir = "app/assets/projects/#{project_name}/"
+      unless File.directory?(_dir)
+        FileUtils.mkdir_p(_dir)
+      end
+      Dir.chdir(_dir) do 
+      puts "dir>>>>>>>>>>>>>>>#{Dir.pwd}"
+      apis = @project.apis
+      data = ""
+      params = ""
+      unless apis.blank?
+        apis.each do |api|
+        data += '/**
+* @api {' "#{api.request_type}" +  '}' +   " #{api.url}" + " #{api.name}" + "\n" + 
+'* @apiName' +  " #{api.name}"  + "\n" +
+'* @apiGroup' + " #{api.api_group}" + "\n" + 
+'* @apiVersion' + " #{api.version}" + "\n" +   
+'*' +  (val = api.parameters.blank? ? "\n" : api.parameters.map{|p| "\n" + '* @apiParam {' + "#{p.param_type}" + '}' +  " #{p.name}" + " #{p.note}" }.join("")) + "\n" +
+'* @apiSuccessExample Success-Response:' + (response = api.success_responses.blank? ? "\n" + "*" + "{}" : "\n" +  api.success_responses.map{|p|  "*" + (note = p.note.blank? ? "" : (p.note + "\n")) + "#{res = p.success_structure.gsub("\r\n", "\n*")}"  + "\n"}.join("")) + "\n"  +
+'* @apiErrorExample Error-Response:' + (response = api.failure_responses.blank? ? "\n" + "*" + "{}" : "\n" +  api.failure_responses.map{|p|  "*" + (note = p.note.blank? ? "" : (p.note + "\n")) + "#{res = p.failure_structure.gsub("\r\n", "\n*")}"  + "\n"}.join("")) + "\n"  + 
+"*/" + "\n" 
+end
+
+      File.open("api.js", 'w+') {
+        |f| f.write("#{data}") 
+      }
+
+      # write package file
+      package_data = '{
+        "name": '+  '"' + @project.name + ' APIDOC",
+        "version": "0.1.0",
+        "description": "Documentation for RESTful web APIs"
+      }'
+      File.open("package.json", 'w+') {
+        |f| f.write("#{package_data}") 
+      }
+
+      end
+      system "apidoc"
+    end
+      flash[:notice] = "Api Doc Generated"
+      redirect_to project_apis_path(@project)
+    end
+  end
+
+end

data/app/controllers/rails_api_doc/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsApiDoc
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/rails_api_doc/parameters_controller.rb

@@ -0,0 +1,87 @@
+require_dependency "rails_api_doc/application_controller"
+
+module RailsApiDoc
+  class ParametersController < ApplicationController
+    # GET /parameters
+    # GET /parameters.json
+    def index
+      @parameters = Parameter.all
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @parameters }
+      end
+    end
+  
+    # GET /parameters/1
+    # GET /parameters/1.json
+    def show
+      @parameter = Parameter.find(params[:id])
+  
+      respond_to do |format|
+        format.html # show.html.erb
+        format.json { render json: @parameter }
+      end
+    end
+  
+    # GET /parameters/new
+    # GET /parameters/new.json
+    def new
+      @parameter = Parameter.new
+  
+      respond_to do |format|
+        format.html # new.html.erb
+        format.json { render json: @parameter }
+      end
+    end
+  
+    # GET /parameters/1/edit
+    def edit
+      @parameter = Parameter.find(params[:id])
+    end
+  
+    # POST /parameters
+    # POST /parameters.json
+    def create
+      @parameter = Parameter.new(params[:parameter])
+  
+      respond_to do |format|
+        if @parameter.save
+          format.html { redirect_to @parameter, notice: 'Parameter was successfully created.' }
+          format.json { render json: @parameter, status: :created, location: @parameter }
+        else
+          format.html { render action: "new" }
+          format.json { render json: @parameter.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    # PUT /parameters/1
+    # PUT /parameters/1.json
+    def update
+      @parameter = Parameter.find(params[:id])
+  
+      respond_to do |format|
+        if @parameter.update_attributes(params[:parameter])
+          format.html { redirect_to @parameter, notice: 'Parameter was successfully updated.' }
+          format.json { head :no_content }
+        else
+          format.html { render action: "edit" }
+          format.json { render json: @parameter.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    # DELETE /parameters/1
+    # DELETE /parameters/1.json
+    def destroy
+      @parameter = Parameter.find(params[:id])
+      @parameter.destroy
+  
+      respond_to do |format|
+        format.html { redirect_to parameters_url }
+        format.json { head :no_content }
+      end
+    end
+  end
+end

data/app/controllers/rails_api_doc/projects_controller.rb

@@ -0,0 +1,87 @@
+require_dependency "rails_api_doc/application_controller"
+
+module RailsApiDoc
+  class ProjectsController < ApplicationController
+    # GET /projects
+    # GET /projects.json
+    def index
+      @projects = Project.all
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @projects }
+      end
+    end
+  
+    # GET /projects/1
+    # GET /projects/1.json
+    def show
+      @project = Project.find(params[:id])
+  
+      respond_to do |format|
+        format.html # show.html.erb
+        format.json { render json: @project }
+      end
+    end
+  
+    # GET /projects/new
+    # GET /projects/new.json
+    def new
+      @project = Project.new
+  
+      respond_to do |format|
+        format.html # new.html.erb
+        format.json { render json: @project }
+      end
+    end
+  
+    # GET /projects/1/edit
+    def edit
+      @project = Project.find(params[:id])
+    end
+  
+    # POST /projects
+    # POST /projects.json
+    def create
+      @project = Project.new(params[:project])
+  
+      respond_to do |format|
+        if @project.save
+          format.html { redirect_to @project, notice: 'Project was successfully created.' }
+          format.json { render json: @project, status: :created, location: @project }
+        else
+          format.html { render action: "new" }
+          format.json { render json: @project.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    # PUT /projects/1
+    # PUT /projects/1.json
+    def update
+      @project = Project.find(params[:id])
+  
+      respond_to do |format|
+        if @project.update_attributes(params[:project])
+          format.html { redirect_to @project, notice: 'Project was successfully updated.' }
+          format.json { head :no_content }
+        else
+          format.html { render action: "edit" }
+          format.json { render json: @project.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    # DELETE /projects/1
+    # DELETE /projects/1.json
+    def destroy
+      @project = Project.find(params[:id])
+      @project.destroy
+  
+      respond_to do |format|
+        format.html { redirect_to projects_url }
+        format.json { head :no_content }
+      end
+    end
+  end
+end

data/app/helpers/rails_api_doc/apis_helper.rb

@@ -0,0 +1,29 @@
+module RailsApiDoc
+  module ApisHelper
+
+  	def link_to_add_fields(name, f, association)
+	    new_object = f.object.class.reflect_on_association(association).klass.new
+	    fields = f.fields_for(association, new_object, :child_index => "new_#{association}") do |builder|
+	      render(association.to_s.singularize + "_fields", :f => builder)
+	    end
+	    link_to_function(name, ("add_fields(this, '#{association}', '#{escape_javascript(fields)}')"))
+  	end
+
+  	def link_to_add_success_fields(name, f, association)
+	    new_object = f.object.class.reflect_on_association(association).klass.new
+	    fields = f.fields_for(association, new_object, :child_index => "new_#{association}") do |builder|
+	      render(association.to_s.singularize + "_fields", :f => builder)
+	    end
+	    link_to_function(name, ("add_success_fields(this, '#{association}', '#{escape_javascript(fields)}')"))
+  	end
+
+  	def link_to_add_failure_fields(name, f, association)
+	    new_object = f.object.class.reflect_on_association(association).klass.new
+	    fields = f.fields_for(association, new_object, :child_index => "new_#{association}") do |builder|
+	      render(association.to_s.singularize + "_fields", :f => builder)
+	    end
+	    link_to_function(name, ("add_failure_fields(this, '#{association}', '#{escape_javascript(fields)}')"))
+  	end
+  	
+  end
+end

data/app/helpers/rails_api_doc/application_helper.rb

@@ -0,0 +1,4 @@
+module RailsApiDoc
+  module ApplicationHelper
+  end
+end

data/app/helpers/rails_api_doc/parameters_helper.rb

@@ -0,0 +1,4 @@
+module RailsApiDoc
+  module ParametersHelper
+  end
+end

data/app/helpers/rails_api_doc/projects_helper.rb

@@ -0,0 +1,4 @@
+module RailsApiDoc
+  module ProjectsHelper
+  end
+end