apidoco 1.3.0 → 1.5.0

data/app/views/apidoco/apis/show.html.erb

@@ -1,7 +1,8 @@
 <div ng-controller="DocumentationController"
-  ng-init="jsonItem = <%= @data.to_json %>;
+  ng-init="data = <%= @data.to_json %>;
            documentationVersions = <%= documentation_versions(@vp).to_json %>;
-           currentVersion = '<%= @documentation.version %>';">
+           currentVersion = '<%= @documentation.version %>';
+           documentationArray = <%= build_documentation_array(@data[:apis]).to_json %>;">
   <!-- Sidebar -->
   <%= render partial: "side_bar" %>
   <!-- Page Content -->
@@ -17,92 +18,135 @@
             </div>
           </div><br />
 
-          <div ng-if="jsonItem.base_url" class="row">
+          <div ng-if="data.base_url" class="row">
             <div class="col-lg-12 text_wheat">
               <strong>BASE URL</strong>
-              {{ jsonItem.base_url }}
+              {{ data.base_url }}
             </div>
           </div><br />
 
-          <div class="row api_details" ng-repeat="x in jsonItem.apis | filter: searchKeyword" id="api_{{$index}}">
+          <div class="row api_details" ng-repeat="x in documentationArray | filter: searchKeyword" id="{{x.id}}">
             <div class="col-lg-12">
-              <h4>{{x.name}}</h4>
-              <div class="row mt-10">
-                <div class="col-lg-2 text-right">End Point:</div>
-                <div class="col-lg-5">
-                  <div class="input-group">
-                    <input type="text" readonly class="form-control" value="{{x.end_point}}">
-                    <span class="input-group-btn">
-                      <button class="btn btn-default" type="button" ngclipboard data-clipboard-text="{{x.end_point}}">Copy</button>
-                    </span>
-                  </div>
-                </div>
-              </div>
+              <ol class="breadcrumb">
+                <li ng-repeat="p in x.parents">{{p}}</li>
+              </ol>
+              <h2 class="section-title">{{x.name}}</h4>
 
-              <div class="row mt-10">
-                <div class="col-lg-2 text-right">HTTP Method:</div>
-                <div class="col-lg-10">{{x.http_method}}</div>
-              </div>
+              <p ng-if="x.description">{{x.description}}</p>
 
-              <div class="row mt-10" ng-if="x.header">
-                <div class="col-lg-2 text-right">Headers:</div>
-                <div class="col-lg-10">
-                  <p ng-repeat="(key, value) in x.header">
-                    <code>{{ key }}:
-                      <span>
-                        {{ value }}
+              <div class="section-block">
+                <h3 class="block-title">Request</h5>
+                <div class="row">
+                  <div class="col-sm-8">
+                    <div class="input-group">
+                      <span class="input-group-btn">
+                        <button class="btn btn-success" type="button"><b>{{x.http_method}}</b></button>
                       </span>
-                    </code>
-                  </p>
+                      <input type="text" readonly class="form-control" value="{{x.end_point}}">
+                    </div>
+                  </div>
+                  <div class="col-sm-4">
+                    <button class="btn btn-default btn-sm mt-2" type="button" ngclipboard data-clipboard-text="{{x.end_point}}">Copy</button>
+                  </div>
                 </div>
               </div>
 
-              <div class="row mt-10" ng-if="x.params && x.params.length > 0">
-                <div class="col-lg-2 text-right">Params:</div>
-                <div class="col-lg-10">
-                  <p ng-repeat="param in x.params">
-                    <code>{{param.key}}
-                      <span ng-if="param.required">
-                        #{{param.required ? 'required' : 'optional'}}</span>
-                      <span ng-if="param.type">type: {{param.type}}</span>
-                    </code>
-                  </p>
+              <div class="section-block" ng-if="x.header">
+                <h3 class="block-title">Headers</h5>
+                <div class="table-responsive">
+                  <table class="table">
+                    <thead>
+                      <tr>
+                        <td>Name</td>
+                        <td>Description</td>
+                      </tr>
+                    </thead>
+                    <tbody>
+                      <tr ng-repeat="(key, value) in x.header">
+                        <td>
+                          <code>{{key}}</code>
+                        </td>
+                        <td>
+                          <code>{{value}}</code>
+                        </td>
+                      </tr>
+                    </tbody>
+                  </table>
                 </div>
               </div>
 
-              <div class="row mt-10" ng-if="x.notes">
-                <div class="col-lg-2 text-right">Notes:</div>
-                <div class="col-lg-10">
-                  <p ng-repeat="note in x.notes">
-                    {{ note }}
-                  </p>
+              <div class="section-block" ng-if="x.params && x.params.length > 0">
+                <h3 class="block-title">Parameters</h5>
+                <div class="table-responsive">
+                  <table class="table">
+                    <thead>
+                      <tr>
+                        <td>Parameter Name</td>
+                        <td></td>
+                        <td>Data Type</td>
+                        <td>Description</td>
+                        <td></td>
+                      </tr>
+                    </thead>
+                    <tbody>
+                      <tr ng-repeat="param in x.params">
+                        <td>
+                          <code>{{param.key}}</code>
+                        </td>
+                        <td>
+                          <button class="btn btn-xs btn-danger" ng-if="param.required">required</button>
+                          <button class="btn btn-xs btn-primary" ng-if="!param.required">optional</button>
+                        </td>
+                        <td>{{param.type}}</td>
+                        <td>{{param.description}}</td>
+                        <td>
+                          {{param.notes}}
+                          <p ng-if="param.validations">
+                            <b>Validations:</b><br>
+                            <span ng-repeat="validation in param.validations">{{validation}}<br></span>
+                          </p>
+                        </td>
+                      </tr>
+                    </tbody>
+                  </table>
                 </div>
               </div>
 
-              <div class="row mt-10" ng-if="x.examples && x.examples.length > 0">
-                <div class="col-lg-2 text-right">Examples:</div>
-                <div class="col-lg-10">
-                  <div ng-repeat="example in x.examples">
-                    <div ng-if="example.request">
-                      <div class="panel panel-default">
-                        <div class="panel-heading">
-                          <h4 class="panel-title">Request</h4>
-                        </div>
-                        <div class="panel-body">
-                          <button class="btn btn-default btn-sm pull-right" ngclipboard data-clipboard-text="{{example.request}}">Copy</button>
-                          <div jq-json-viewer data="example.request"></div>
+              <div class="section-block" ng-if="x.notes">
+                <h3 class="block-title">Notes</h5>
+                <p ng-repeat="note in x.notes">
+                  {{ note }}
+                </p>
+              </div>
+
+              <div class="section-block" ng-if="x.examples && x.examples.length > 0">
+                <h3 class="block-title">Examples</h5>
+                <div class="rows" ng-repeat="example in x.examples">
+                  <div class="col-sm-6" ng-if="example.request">
+                    <div class="panel panel-default">
+                      <div class="panel-heading">
+                        <h4 class="panel-title">Request</h4>
+                      </div>
+                      <div class="panel-body">
+                        <div class="btn-group pull-right" role="group">
+                          <button class="btn btn-default btn-sm" ng-click="viewRaw(example.request)">Raw</button>
+                          <button class="btn btn-default btn-sm" ngclipboard data-clipboard-text="{{example.request}}">Copy</button>
                         </div>
+                        <div jq-json-viewer data="example.request"></div>
                       </div>
                     </div>
-                    <div ng-if="example.response">
-                      <div class="panel panel-default">
-                        <div class="panel-heading">
-                          <h4 class="panel-title">Response</h4>
-                        </div>
-                        <div class="panel-body">
-                          <button class="btn btn-default btn-sm pull-right" ngclipboard data-clipboard-text="{{example.response}}">Copy</button>
-                          <div jq-json-viewer data="example.response"></div>
+                  </div>
+                  <div class="col-sm-6" ng-if="example.response">
+                    <div class="panel panel-default">
+                      <div class="panel-heading">
+                        <h4 class="panel-title">Response</h4>
+                      </div>
+                      <div class="panel-body">
+                        <div class="btn-group pull-right" role="group">
+                          <button class="btn btn-default btn-sm" ng-click="viewRaw(example.response)">Raw</button>
+                          <button class="btn btn-default btn-sm" ngclipboard data-clipboard-text="{{example.response}}">Copy</button>
                         </div>
+                        <div jq-json-viewer data="example.response"></div>
                       </div>
                     </div>
                   </div>

data/lib/apidoco/file_parser.rb

@@ -0,0 +1,31 @@
+module Apidoco
+  # Parse a folder and find all the sub folders and files
+  class FileParser
+    attr_accessor :file, :parents
+
+    def initialize(file, parents:)
+      self.file = file
+      self.parents = parents
+    end
+
+    def as_json
+      content.merge(parents: parents, id: id)
+    end
+
+    def content
+      JSON.parse(File.read(file))
+    end
+
+    def id
+      parents.push(content['name']).join('-').downcase.delete(' ')
+    end
+
+    def published?
+      content['published'].nil? || content['published']
+    end
+
+    def sort_order
+      content['sort_order'] || 999
+    end
+  end
+end

data/lib/apidoco/folder_parser.rb

@@ -0,0 +1,42 @@
+module Apidoco
+  # Parse a folder and find all the sub folders and files
+  class FolderParser
+    attr_accessor :directory, :parents
+
+    def initialize(directory, parents: [])
+      self.directory = directory
+      self.parents = parents
+    end
+
+    def as_json
+      {
+        is_folder: true,
+        name: basename,
+        children: children.select(&:published?).sort_by(&:sort_order).map(&:as_json)
+      }
+    end
+
+    def basename
+      directory.basename.to_s.titleize
+    end
+
+    def children
+      directory.children.map do |child|
+        hierrarchy = parents + [basename]
+        if child.directory?
+          Apidoco::FolderParser.new(child, parents: hierrarchy)
+        else
+          Apidoco::FileParser.new(child, parents: hierrarchy)
+        end
+      end
+    end
+
+    def published?
+      true
+    end
+
+    def sort_order
+      999
+    end
+  end
+end

data/lib/apidoco/version.rb

@@ -1,3 +1,3 @@
 module Apidoco
-  VERSION = '1.3.0'
+  VERSION = '1.5.0'
 end

data/lib/apidoco/version_documentation.rb

@@ -15,17 +15,15 @@ module Apidoco
       {
         name: name,
         base_url: '',
-        apis: resource_documentations.flat_map(&:as_json)
+        apis: documentations.flat_map(&:as_json)
       }
     end
 
-    def resource_documentations
-      resource_directories.map { |dir| ResourceDocumentation.new(dir) }
+    def documentations
+      documentation_directories.map { |dir| FolderParser.new(dir) }
     end
 
-    protected
-
-    def resource_directories
+    def documentation_directories
       directory.children.select(&:directory?)
     end
   end

data/lib/apidoco/version_parser.rb

@@ -4,7 +4,7 @@ module Apidoco
     attr_accessor :base_path
 
     def initialize
-      self.base_path = Pathname('docs').join('api')
+      self.base_path = Rails.root.join('docs', 'api')
     end
 
     def documentations

data/lib/apidoco.rb

@@ -1,9 +1,10 @@
-require "angularjs-rails"
+require 'angularjs-rails'
 
-require "apidoco/engine"
-require "apidoco/version_parser"
-require "apidoco/version_documentation"
-require "apidoco/resource_documentation"
+require 'apidoco/engine'
+require 'apidoco/version_parser'
+require 'apidoco/version_documentation'
+require 'apidoco/folder_parser'
+require 'apidoco/file_parser'
 
 module Apidoco
   mattr_accessor :auth_name, :auth_password

data/lib/generators/apidoco_generator.rb

@@ -21,7 +21,7 @@ class ApidocoGenerator < Rails::Generators::Base
   def actions(args)
     return args if args.present?
 
-    [:show, :index, :create, :update, :destroy]
+    %i[show index create update destroy]
   end
 
   def default_end_points_with_method(action)
@@ -69,11 +69,11 @@ class ApidocoGenerator < Rails::Generators::Base
     <<-FILE
 {
   "published": true,
-  "sort_order": 100,
   "name": "#{name}",
   "end_point": "#{resource}#{endpoint_with_method[:endpoint]}",
   "http_method": "#{endpoint_with_method[:method]}",
   "params": [],
+  "header": {},
   "examples": [{
     "request": {},
     "response": {}

data/spec/dummy/config/application.rb

@@ -3,7 +3,7 @@ require_relative 'boot'
 require 'rails/all'
 
 Bundler.require(*Rails.groups)
-require "apidoco"
+require 'apidoco'
 
 module Dummy
   class Application < Rails::Application
@@ -12,4 +12,3 @@ module Dummy
     # -- all .rb files in that directory are automatically loaded.
   end
 end
-

data/spec/dummy/config/environments/production.rb

@@ -47,7 +47,7 @@ Rails.application.configure do
   config.log_level = :debug
 
   # Prepend all log lines with the following tags.
-  config.log_tags = [ :request_id ]
+  config.log_tags = [:request_id]
 
   # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
@@ -75,7 +75,7 @@ Rails.application.configure do
   # require 'syslog/logger'
   # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
 
-  if ENV["RAILS_LOG_TO_STDOUT"].present?
+  if ENV['RAILS_LOG_TO_STDOUT'].present?
     logger           = ActiveSupport::Logger.new(STDOUT)
     logger.formatter = config.log_formatter
     config.logger = ActiveSupport::TaggedLogging.new(logger)

data/spec/dummy/config/puma.rb

@@ -4,16 +4,16 @@
 # the maximum value specified for Puma. Default is set to 5 threads for minimum
 # and maximum, this matches the default thread size of Active Record.
 #
-threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }.to_i
+threads_count = ENV.fetch('RAILS_MAX_THREADS') { 5 }.to_i
 threads threads_count, threads_count
 
 # Specifies the `port` that Puma will listen on to receive requests, default is 3000.
 #
-port        ENV.fetch("PORT") { 3000 }
+port        ENV.fetch('PORT') { 3000 }
 
 # Specifies the `environment` that Puma will run in.
 #
-environment ENV.fetch("RAILS_ENV") { "development" }
+environment ENV.fetch('RAILS_ENV') { 'development' }
 
 # Specifies the number of `workers` to boot in clustered mode.
 # Workers are forked webserver processes. If using threads and workers together

data/spec/dummy/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  mount Apidoco::Engine => "/apidoco"
+  mount Apidoco::Engine => '/apidoco'
 end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,15 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 0) do
+
+end

data/spec/dummy/docs/api/v1/currencies/1.json

@@ -0,0 +1 @@
+{"published":true,"name":"Create Currency","http_method":"/currencies"}

data/spec/dummy/log/development.log

@@ -0,0 +1,7 @@
+   (87.2ms)  CREATE TABLE "schema_migrations" ("version" varchar NOT NULL PRIMARY KEY)
+   (82.6ms)  CREATE TABLE "ar_internal_metadata" ("key" varchar NOT NULL PRIMARY KEY, "value" varchar, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL)
+  ActiveRecord::InternalMetadata Load (0.3ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", :environment], ["LIMIT", 1]]
+   (0.1ms)  begin transaction
+  SQL (0.3ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES (?, ?, ?, ?)  [["key", "environment"], ["value", "development"], ["created_at", 2017-06-30 06:48:39 UTC], ["updated_at", 2017-06-30 06:48:39 UTC]]
+   (86.8ms)  commit transaction
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"