apidoco 0.1.0

data/app/assets/stylesheets/apidoco/helpers.css

@@ -0,0 +1,12 @@
+/* All the helper/reusable classes should be in here */
+.pointer {
+  cursor: pointer;
+}
+
+.mt-10 {
+  margin-top: 10px !important;
+}
+
+.padding-10 {
+  padding: 10px !important;
+}

data/app/assets/stylesheets/apidoco/ng-prettyjson.min.css

@@ -0,0 +1,7 @@
+/**
+* @license ng-prettyjson - v0.2.0
+* (c) 2013 Julien VALERY https://github.com/darul75/ng-prettyjson
+* License: MIT
+**/
+
+pre.pretty-json{outline:1px solid #e9e9e9;padding:5px;margin:5px}pre.pretty-json span.string{color:green}pre.pretty-json span.number{color:#ff8c00}pre.pretty-json span.boolean{color:#00f}pre.pretty-json span.null{color:#ff00ff}pre.pretty-json span.key{color:red}pre.pretty-json span.sep{color:#000}

data/app/assets/stylesheets/apidoco/simple-sidebar.css

@@ -0,0 +1,127 @@
+/*!
+ * Start Bootstrap - Simple Sidebar (http://startbootstrap.com/)
+ * Copyright 2013-2016 Start Bootstrap
+ * Licensed under MIT (https://github.com/BlackrockDigital/startbootstrap/blob/gh-pages/LICENSE)
+ */
+
+ body {
+    overflow-x: hidden;
+ }
+
+/* Toggle Styles */
+
+#wrapper {
+    padding-left: 0;
+    -webkit-transition: all 0.5s ease;
+    -moz-transition: all 0.5s ease;
+    -o-transition: all 0.5s ease;
+    transition: all 0.5s ease;
+}
+
+#wrapper.toggled {
+    padding-left: 250px;
+}
+
+#sidebar-wrapper {
+    z-index: 1000;
+    position: fixed;
+    left: 250px;
+    width: 0;
+    height: 100%;
+    margin-left: -250px;
+    overflow-y: auto;
+    background: #000;
+    -webkit-transition: all 0.5s ease;
+    -moz-transition: all 0.5s ease;
+    -o-transition: all 0.5s ease;
+    transition: all 0.5s ease;
+}
+
+#wrapper.toggled #sidebar-wrapper {
+    width: 250px;
+}
+
+#page-content-wrapper {
+    width: 100%;
+    position: absolute;
+    padding: 15px;
+}
+
+#wrapper.toggled #page-content-wrapper {
+    position: absolute;
+    margin-right: -250px;
+}
+
+/* Sidebar Styles */
+
+.sidebar-nav {
+    position: absolute;
+    top: 0;
+    width: 250px;
+    margin: 0;
+    padding: 0;
+    list-style: none;
+}
+
+.sidebar-nav li {
+    text-indent: 20px;
+    line-height: 40px;
+}
+
+.sidebar-nav li a {
+    display: block;
+    text-decoration: none;
+    color: #999999;
+}
+
+.sidebar-nav li a:hover,
+.sidebar-nav li a:active,
+.sidebar-nav li a.active,
+.sidebar-nav li a:focus {
+    text-decoration: none;
+    color: #fff;
+    background: rgba(255,255,255,0.2);
+}
+
+.sidebar-nav > .sidebar-brand {
+    height: 65px;
+    font-size: 18px;
+    line-height: 60px;
+}
+
+.sidebar-nav > .sidebar-brand a {
+    color: #999999;
+}
+
+.sidebar-nav > .sidebar-brand a:hover {
+    color: #fff;
+    background: none;
+}
+
+@media(min-width:768px) {
+    #wrapper {
+        padding-left: 250px;
+    }
+
+    #wrapper.toggled {
+        padding-left: 0;
+    }
+
+    #sidebar-wrapper {
+        width: 250px;
+    }
+
+    #wrapper.toggled #sidebar-wrapper {
+        width: 0;
+    }
+
+    #page-content-wrapper {
+        padding: 20px;
+        position: relative;
+    }
+
+    #wrapper.toggled #page-content-wrapper {
+        position: relative;
+        margin-right: 0;
+    }
+}

data/app/controllers/apidoco/apis_controller.rb

@@ -0,0 +1,22 @@
+require_dependency "apidoco/application_controller"
+
+module Apidoco
+  class ApisController < ApplicationController
+    before_action :set_version_parser
+
+    def index
+      redirect_to api_path(id: @vp.documentations.first.name)
+    end
+
+    def show
+      @documentation = @vp.documentation(params[:id])
+      @data = @documentation.as_json
+    end
+
+    private
+
+    def set_version_parser
+      @vp = VersionParser.new
+    end
+  end
+end

data/app/controllers/apidoco/application_controller.rb

@@ -0,0 +1,5 @@
+module Apidoco
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/apidoco/application_helper.rb

@@ -0,0 +1,9 @@
+module Apidoco
+  module ApplicationHelper
+    def documentation_versions(version_parser)
+      version_parser.documentations.map do |documentation|
+        { name: documentation.name, path: api_path(id: documentation.name) }
+      end
+    end
+  end
+end

data/app/jobs/apidoco/application_job.rb

@@ -0,0 +1,4 @@
+module Apidoco
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/apidoco/application_mailer.rb

@@ -0,0 +1,6 @@
+module Apidoco
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/apidoco/application_record.rb

@@ -0,0 +1,5 @@
+module Apidoco
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

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

@@ -0,0 +1,20 @@
+<div id="sidebar-wrapper">
+  <ul class="sidebar-nav">
+    <li class="sidebar-brand">
+      <a href="#">
+        APIDOCO::{{currentVersion}}
+      </a>
+    </li>
+    <li class="padding-10">
+      <select class="form-control" ng-if="documentationVersions.length > 1" ng-model="currentVersion" ng-change="navigateToCurrentVersion(currentVersion);">
+        <option ng-repeat="version in documentationVersions" ng-value="version.name">{{version.name}}</option>
+      </select>
+    </li>
+    <li class="mt-10 padding-10">
+      <input type="text" placeholder="Search.." class="form-control input-sm" ng-model="searchKeyword" />
+    </li>
+    <li ng-repeat="x in jsonItem.apis | filter: searchKeyword">
+      <a href="#api_{{$index}}" du-smooth-scroll du-scrollspy>{{x.name}}</a>
+    </li>
+  </ul>
+</div>

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

@@ -0,0 +1,73 @@
+<div ng-controller="DocumentationController"
+  ng-init="jsonItem = <%= @data.to_json %>;
+           documentationVersions = <%= documentation_versions(@vp).to_json %>;
+           currentVersion = '<%= @documentation.version %>';">
+  <!-- Sidebar -->
+  <%= render partial: "side_bar" %>
+  <!-- Page Content -->
+  <div id="page-content-wrapper">
+    <div class="container-fluid">
+      <div class="row">
+        <div class="col-lg-12">
+          <div class="row">
+            <div class="col-lg-2">
+              <a href="#menu-toggle" class="btn btn-default glyphicon glyphicon-align-justify" id="menu-toggle"></a>
+            </div>
+          </div><br />
+
+          <div class="row">
+            <div class="col-lg-12 text_wheat">
+              <strong>BASE URL</strong>
+              {{ jsonItem.base_url }}
+            </div>
+          </div><br />
+
+          <div class="row api_details" ng-repeat="x in jsonItem.apis | filter: searchKeyword" id="api_{{$index}}">
+            <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-10">
+                  <code>{{x.end_point}}</code>
+                </div>
+              </div>
+
+              <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>
+
+              <div class="row mt-10">
+                <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>
+                    </code>
+                  </p>
+                </div>
+              </div>
+
+              <div class="row mt-10">
+                <div class="col-lg-2 text-right">Examples:</div>
+                <div class="col-lg-10">
+                  <div ng-repeat="example in x.examples">
+                    <div>
+                      <p class="text-center">Request</p>
+                      <pre pretty-json="example.request" />
+                    </div>
+                    <div>
+                      <p class="text-center">Response</p>
+                      <pre pretty-json="example.response" />
+                    </div>
+                  </div>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/layouts/apidoco/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html ng-app="apiDocoApp">
+  <head>
+    <title>Apidoco</title>
+    <%= stylesheet_link_tag    "apidoco/application", media: "all" %>
+    <%= javascript_include_tag "apidoco/application" %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <div id="wrapper">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Apidoco::Engine.routes.draw do
+  root 'apis#index'
+  resources :apis, only: [:show]
+end

data/lib/apidoco.rb

@@ -0,0 +1,8 @@
+require "angularjs-rails"
+
+require "apidoco/engine"
+require "apidoco/version_parser"
+require "apidoco/version_documentation"
+require "apidoco/resource_documentation"
+
+module Apidoco; end

data/lib/apidoco/engine.rb

@@ -0,0 +1,5 @@
+module Apidoco
+  class Engine < ::Rails::Engine
+    isolate_namespace Apidoco
+  end
+end

data/lib/apidoco/resource_documentation.rb

@@ -0,0 +1,19 @@
+module Apidoco
+  class ResourceDocumentation
+    attr_accessor :directory
+
+    def initialize(directory)
+      self.directory = directory
+    end
+
+    def as_json
+      children.map { |c| JSON.parse(File.read(c)) }
+    end
+
+    def children
+      directory.children.select do |child|
+        child.extname.eql?('.json')
+      end
+    end
+  end
+end

data/lib/apidoco/version.rb

@@ -0,0 +1,3 @@
+module Apidoco
+  VERSION = '0.1.0'
+end

data/lib/apidoco/version_documentation.rb

@@ -0,0 +1,32 @@
+module Apidoco
+  class VersionDocumentation
+    attr_accessor :directory
+
+    def initialize(directory)
+      self.directory = directory
+    end
+
+    def name
+      directory.basename.to_s
+    end
+    alias_method :version, :name
+
+    def as_json
+      {
+        name: name,
+        base_url: "",
+        apis: resource_documentations.flat_map(&:as_json)
+      }
+    end
+
+    def resource_documentations
+      resource_directories.map { |dir| ResourceDocumentation.new(dir) }
+    end
+
+    protected
+
+    def resource_directories
+      directory.children.select(&:directory?)
+    end
+  end
+end

data/lib/apidoco/version_parser.rb

@@ -0,0 +1,24 @@
+module Apidoco
+  # Parses the documentation versions, keeps track of all the documented api versions
+  class VersionParser
+    attr_accessor :base_path
+
+    def initialize
+      self.base_path = Pathname('docs').join('api')
+    end
+
+    def documentations
+      documentation_directories.map { |dir| VersionDocumentation.new(dir) }
+    end
+
+    def documentation(version)
+      documentations.find { |doc| doc.version.eql?(version) }
+    end
+
+    private
+
+    def documentation_directories
+      base_path.children.select(&:directory?)
+    end
+  end
+end

data/lib/generators/apidoco_generator.rb

@@ -0,0 +1,82 @@
+#
+# ApidocoGenerator
+#
+# @author sufinsha
+#
+class ApidocoGenerator < Rails::Generators::Base
+  desc 'This generator creates empty folder for api versions'
+  def create_apidoco_folder
+    resource = args[0]
+
+    resource_actions = actions(args[1..-1])
+
+    resource_actions.each do |action|
+      create_file "#{Rails.root}/docs/#{file_name(resource, action)}",
+                  file_content(resource, action)
+    end
+  end
+
+  private
+
+  def actions(args)
+    return args if args.present?
+
+    [:show, :index, :create, :update, :destroy]
+  end
+
+  def default_end_points_with_method(action)
+    end_points_with_method = {
+      index: {
+        endpoint: '.json', method: 'GET', collection: true
+      },
+      show: {
+        endpoint: '/:id.json', method: 'GET', collection: false
+      },
+      create: {
+        endpoint: '.json', method: 'POST', collection: true
+      },
+      update: {
+        endpoint: '/:id.json', method: 'PUT|PATCH', collection: false
+      },
+      destroy: {
+        endpoint: '/:id.json', method: 'DELETE', collection: false
+      }
+    }
+    end_points_with_method[action] || {}
+  end
+
+  def api_name(resource, action)
+    endpoint_with_method = default_end_points_with_method(action.intern)
+    resource_title = if endpoint_with_method[:collection]
+                       resource.pluralize.titleize
+                     else
+                       resource.singularize.titleize
+                     end
+    "#{action.to_s.titleize} #{resource_title}"
+  end
+
+  def file_name(resource, action)
+    "#{resource}/#{action}.json"
+  end
+
+  def resource_name(resource)
+    resource.split('/').last
+  end
+
+  def file_content(resource, action)
+    endpoint_with_method = default_end_points_with_method(action.intern)
+    name = api_name(resource_name(resource), action)
+    <<-FILE
+{
+  "name": "#{name}",
+  "end_point": "#{resource}#{endpoint_with_method[:endpoint]}",
+  "http_method": "#{endpoint_with_method[:method]}",
+  "params": [],
+  "examples": [{
+    "request": {},
+    "response": {}
+  }]
+}
+FILE
+  end
+end