apitome 0.0.8 → 0.3.0

data/app/views/apitome/docs/_all_examples.html.erb

@@ -1,9 +1,13 @@
 <% resources.each do |resource| %>
   <section class="example" id="<%= id_for(resource['name']) %>">
     <h1 class="resource-name"><%= resource['name'] %></h1>
+
+    <%= render partial: 'resource_explanation', locals: { explanation: resource['explanation'] } if resource['explanation'] %>
+
     <% resource['examples'].each do |example| %>
-      <article id="<%= id_for(example['link'].gsub('.json', '')) %>">
-        <%= render partial: 'example', locals: { example: set_example(example['link'].gsub('.json', '')) } %>
+      <% link = example['link'].gsub(/.json$/, '') %>
+      <article id="<%= id_for(link) %>">
+        <%= render partial: 'example', locals: { example: set_example(link).merge!(link: link) } %>
       </article>
     <% end %>
   </section>

data/app/views/apitome/docs/_body.html.erb

@@ -1,4 +1,4 @@
 <section class="body">
-  <h4><%= t(:body) %></h4>
+  <h4><%= t(:body, scope: :apitome) %></h4>
   <pre><code class="<%= type %>"><%= formatted_body(body, type) %></code></pre>
 </section>

data/app/views/apitome/docs/_curl.html.erb

@@ -1,4 +1,4 @@
 <section class="curl">
-  <h4><%= t(:curl) %></h4>
+  <h4><%= t(:curl, scope: :apitome) %></h4>
   <pre><%= request['curl'] %></pre>
 </section>

data/app/views/apitome/docs/_endpoint.html.erb

@@ -0,0 +1,4 @@
+<section class="endpoint">
+  <h3><%= t(:endpoint, scope: :apitome) %></h3>
+  <pre><%= "#{method} #{endpoint}" %></pre>
+</section>

data/app/views/apitome/docs/_example.html.erb

@@ -1,11 +1,12 @@
 <h2><%= example['description'] %></h2>
 
 <%= render partial: 'apitome/docs/explanation',    locals: {explaination: example['explanation']} if example['explanation'] %>
+<%= render partial: 'apitome/docs/endpoint',       locals: {method: example['http_method'], endpoint: example['route']} %>
 <%= render partial: 'apitome/docs/params',         locals: {params: example['parameters']} if example['parameters'].size > 0 %>
 
 <% example['requests'].each_with_index do |request, index| %>
   <div id="<%= "request-#{index}" %>">
-    <h3><%= t(:request) %></h3>
+    <h3><%= t(:request, scope: :apitome) %></h3>
     <div class="request">
       <%= render partial: 'apitome/docs/route',    locals: {request: request, index: index} %>
       <%= render partial: 'apitome/docs/headers',  locals: {request: request, index: index, headers: request['request_headers']} %>
@@ -14,12 +15,15 @@
       <%= render partial: 'apitome/docs/curl',     locals: {request: request, index: index} if request['curl'] %>
     </div>
 
-    <h3><%= t(:response) %></h3>
+    <h3><%= t(:response, scope: :apitome) %></h3>
     <div class="response">
-      <%= render partial: 'apitome/docs/response_fields',   locals: {params: example['response_fields']}  if example['response_fields'].size > 0 %>
-      <%= render partial: 'apitome/docs/status',   locals: {request: request, index: index} %>
-      <%= render partial: 'apitome/docs/headers',  locals: {request: request, index: index, headers: request['response_headers']} %>
-      <%= render partial: 'apitome/docs/body',     locals: {request: request, index: index, body: request['response_body'], type: request['response_content_type']} if request['response_body'] %>
+      <%- if Apitome.configuration.simulated_response %>
+        <%= link_to('Simulated Response', simulated_path(example[:link])) if example[:link].present? %>
+      <%- end %>
+      <%= render partial: 'apitome/docs/response_fields', locals: {params: example['response_fields']} if example['response_fields'].size > 0 %>
+      <%= render partial: 'apitome/docs/status',          locals: {request: request, index: index} %>
+      <%= render partial: 'apitome/docs/headers',         locals: {request: request, index: index, headers: request['response_headers']} %>
+      <%= render partial: 'apitome/docs/body',            locals: {request: request, index: index, body: request['response_body'], type: request['response_content_type']} if request['response_body'] %>
     </div>
   </div>
 <% end %>

data/app/views/apitome/docs/_explanation.html.erb

@@ -1,3 +1,3 @@
-<p class="explanation">
-  <%= raw example['explanation'] %>
-</p>
+<div class="explanation">
+  <%= raw rendered_markdown(example['explanation'].strip_heredoc) %>
+</div>

data/app/views/apitome/docs/_headers.html.erb

@@ -1,4 +1,6 @@
-<section class="headers">
-  <h4><%= t(:headers) %></h4>
-  <pre><code class="http"><%= headers.map{ |k,v| "#{k}: #{v}" }.join("\n") %></code></pre>
-</section>
+<% unless headers.blank? %>
+  <section class="headers">
+    <h4><%= t(:headers, scope: :apitome) %></h4>
+    <pre><code class="http"><%= headers.map{ |k,v| "#{k}: #{v}" }.join("\n") %></code></pre>
+  </section>
+<% end %>

data/app/views/apitome/docs/_navigation.html.erb

@@ -1,25 +1,29 @@
 <ul class="nav sidenav">
-  <li>
-    <% if Apitome.configuration.single_page %>
-      <a href="#readme"><%= t(:readme) %></a>
-    <% else %>
-      <a href="<%= Apitome.configuration.mount_at %>"><%= t(:readme) %></a>
-    <% end %>
-  </li>
+  <% if Apitome.configuration.readme %>
+    <li>
+      <% if Apitome.configuration.single_page %>
+        <a href="#readme"><%= t(:readme, scope: :apitome) %></a>
+      <% else %>
+        <a href="<%= Apitome.configuration.mount_at %>"><%= t(:readme, scope: :apitome) %></a>
+      <% end %>
+    </li>
+  <% end %>
   <% resources.each do |resource| %>
     <li>
       <% if Apitome.configuration.single_page %>
-        <a href="#<%= id_for(resource['examples'].first['link']) %>"><%= resource['name'] %></a>
+        <a href="#<%= id_for(resource['name']) %>"><%= resource['name'] %></a>
         <ul class="nav">
           <% resource['examples'].each do |example| %>
             <li><%= link_to example['description'], "##{id_for(example['link'])}" %></li>
           <% end %>
         </ul>
       <% else %>
-        <li><%= link_to resource['name'], "#{Apitome.configuration.mount_at}/#{resource['examples'].first['link'].gsub(/\.json$/, '')}" %></li>
+        <%= link_to resource['name'], resource_link(resource), class: "#{link_active?(resource_link(resource)) ? 'active' : ''}" %>
         <ul class="nav">
           <% resource['examples'].each do |example| %>
-            <li><%= link_to example['description'], "#{Apitome.configuration.mount_at}/#{example['link'].gsub(/\.json$/, '')}" %></li>
+            <li class="<%= link_active?(example_link(example)) ? 'active' : '' %>">
+              <%= link_to example['description'], example_link(example) %>
+            </li>
           <% end %>
         </ul>
       <% end %>

data/app/views/apitome/docs/_params.html.erb

@@ -1,22 +1,22 @@
 <section class="params">
-  <h3><%= t(:parameters) %></h3>
+  <h3><%= t(:parameters, scope: :apitome) %></h3>
   <div class="table-responsive">
     <table class="table table-bordered">
       <tr>
         <% param_headers(params).each do |title| %>
-          <th><%= title %></th>
+          <th><%= title.titlecase %></th>
         <% end %>
       </tr>
       <% params.each do |param| %>
         <tr>
           <td class="name">
             <% if param['scope'] %>
-              <%= "#{param['scope']}[#{param['name']}]" %>
+              <%= "#{format_scope(param['scope'])}[#{param['name']}]" %>
             <% else %>
               <%= param['name'] %>
             <% end %>
             <% if param['required'] %>
-              <span class="label label-danger required">required</span>
+              <span class="label label-danger required"><%= t(:required, scope: :apitome) %></span>
             <% end %>
           </td>
           <td class="description"><%= param['description'] %></td>

data/app/views/apitome/docs/_query.html.erb

@@ -1,4 +1,4 @@
 <section class="query-parameters">
-  <h4><%= t(:query_parameters) %></h4>
+  <h4><%= t(:query_parameters, scope: :apitome) %></h4>
   <pre><%= request['request_query_parameters'].map{ |k,v| "#{k}=#{v}" }.join("\n") %></pre>
 </section>

data/app/views/apitome/docs/_resource_explanation.html.erb

@@ -0,0 +1,3 @@
+<article class="resource_explanation">
+  <%= raw rendered_markdown(explanation.strip_heredoc) %>
+</article>

data/app/views/apitome/docs/_response_fields.html.erb

@@ -1,5 +1,5 @@
 <section class="params">
-  <h3><%= t(:response_fields) %></h3>
+  <h3><%= t(:response_fields, scope: :apitome) %></h3>
   <div class="table-responsive">
     <table class="table table-bordered">
       <tr>

data/app/views/apitome/docs/_route.html.erb

@@ -1,4 +1,4 @@
 <section class="route">
-  <h4><%= t(:route) %></h4>
+  <h4><%= t(:route, scope: :apitome) %></h4>
   <pre><%= "#{request['request_method']} #{request['request_path']}" %></pre>
 </section>

data/app/views/apitome/docs/_status.html.erb

@@ -1,4 +1,4 @@
 <section class="status">
-  <h4><%= t(:status) %></h4>
+  <h4><%= t(:status, scope: :apitome) %></h4>
   <pre><code class="http"><%= request['response_status'] %></code></pre>
 </section>

data/app/views/apitome/docs/index.html.erb

@@ -1,6 +1,11 @@
-<section class="readme" id="readme">
-  <article>
-    <%= raw formatted_readme %>
-  </article>
-</section>
-<%= render 'all_examples' if Apitome.configuration.single_page %>
+<% if Apitome.configuration.readme %>
+  <section class="readme" id="readme">
+    <article>
+      <%= raw formatted_readme %>
+    </article>
+  </section>
+<% end %>
+<% if Apitome.configuration.single_page %>
+    <a href="#top" id="scroll-to-top" class="hidden btn btn-primary">Back to Top</a>
+<% end %>
+<%= render 'all_examples' if Apitome.configuration.single_page %>

data/app/views/apitome/docs/show.html.erb

@@ -1,2 +1,3 @@
 <h1 class="resource-name"><%= example['resource'] %></h1>
-<%= render 'example' %>
+<%= render partial: 'resource_explanation', locals: { explanation: example['resource_explanation'] } if example['resource_explanation'] %>
+<%= render partial: 'example', locals: { example: example.merge!(link: params[:path]) } %>

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

@@ -3,11 +3,11 @@
 <head>
   <title><%= Apitome.configuration.title %></title>
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <%= stylesheet_link_tag    Apitome.configuration.code_theme_url, media: 'all' %>
-  <%= stylesheet_link_tag    Apitome.configuration.css_override || 'apitome/application', media: 'all' %>
-  <%= javascript_include_tag Apitome.configuration.js_override || 'apitome/application' %>
+  <%= stylesheet_link_tag Apitome.configuration.css_override || "apitome/application", media: "all" %>
+  <%= stylesheet_link_tag "apitome/highlight_themes/#{Apitome.configuration.code_theme}", media: "all" %>
+  <%= javascript_include_tag Apitome.configuration.js_override || "apitome/application" %>
 </head>
-<body class="<%= Apitome.configuration.single_page ? 'single-page' : '' %>">
+<body class="<%= Apitome.configuration.single_page ? "single-page" : "" %>">
 
 <div class="container">
   <%= render 'header' %>

data/config/locales/en.yml

@@ -1,12 +1,15 @@
 en:
-  body: Body
-  curl: cURL
-  headers: Headers
-  parameters: Parameters
-  query_parameters: Query Parameters
-  readme: README
-  request: Request
-  response: Response
-  response_fields: Response Fields
-  route: Route
-  status: Status
+  apitome:
+    body: Body
+    curl: cURL
+    endpoint: Endpoint
+    headers: Headers
+    parameters: Parameters
+    query_parameters: Query Parameters
+    readme: README
+    request: Request
+    required: required
+    response_fields: Response Fields
+    response: Response
+    route: Route
+    status: Status

data/config/locales/es.yml

@@ -1,11 +1,15 @@
 es:
-  body: Cuerpo
-  curl: cURL
-  headers: Encabezados
-  parameters: Parametros
-  query_parameters: Parámetros de la consulta
-  readme: LEEME
-  request: Solicitud
-  response: Respuesta
-  route: Ruta
-  status: Estado
+  apitome:
+    body: Cuerpo
+    curl: cURL
+    endpoint: Punto de llegada
+    headers: Encabezados
+    parameters: Parametros
+    query_parameters: Parámetros de la consulta
+    readme: LEEME
+    request: Solicitud
+    required: requerido
+    response_fields: Campos de respuesta
+    response: Respuesta
+    route: Ruta
+    status: Estado

data/lib/apitome.rb

@@ -1,7 +1,7 @@
-require 'apitome/version'
-require 'apitome/exceptions'
-require 'apitome/configuration'
+require "kramdown"
 
-require 'apitome/engine'
+require "apitome/version"
+require "apitome/exceptions"
+require "apitome/configuration"
 
-require 'kramdown'
+require "apitome/engine"

data/lib/apitome/configuration.rb

@@ -4,31 +4,52 @@ module Apitome
   class Configuration
     include Singleton
 
-    cattr_accessor :mount_at, :root, :doc_path, :title, :layout, :code_theme, :css_override, :js_override, :readme, :single_page
-    @@mount_at     = "/api/docs"
-    @@root         = nil # will default to Rails.root if left unset
-    @@doc_path     = 'doc/api'
-    @@title        = 'Apitome Documentation'
-    @@layout       = 'apitome/application'
-    @@code_theme   = 'default'
+    cattr_accessor *[
+      :mount_at,
+      :root,
+      :doc_path,
+      :parent_controller,
+      :title,
+      :layout,
+      :code_theme,
+      :css_override,
+      :js_override,
+      :readme,
+      :single_page,
+      :url_formatter,
+      :remote_url,
+      :http_basic_authentication,
+      :precompile_assets,
+      :simulated_response,
+    ]
+
+    @@mount_at = "/api/docs"
+    @@root = nil # will default to Rails.root if left unset
+    @@doc_path = "doc/api"
+    @@parent_controller = "ActionController::Base"
+    @@title = "Apitome Documentation"
+    @@layout = "apitome/application"
+    @@code_theme = "default"
     @@css_override = nil
-    @@js_override  = nil
-    @@readme       = '../api.md'
-    @@single_page  = true
+    @@js_override = nil
+    @@readme = "../api.md"
+    @@single_page = true
+    @@url_formatter = -> (str) { str.gsub(/\.json$/, "").underscore.gsub(/[^0-9a-z]+/i, "-") }
+    @@remote_url = nil
+    @@http_basic_authentication = nil
+    @@precompile_assets = true
+    @@simulated_response = true
 
     def self.root=(path)
       @@root = Pathname.new(path.to_s) if path.present?
     end
-
-    def self.code_theme_url
-      "apitome/highlight_themes/#{@@code_theme}"
-    end
   end
 
   mattr_accessor :configuration
   @@configuration = Configuration
 
-  def self.setup
+  def self.configure
     yield @@configuration
   end
+  singleton_class.send(:alias_method, :setup, :configure)
 end

data/lib/apitome/engine.rb

@@ -1,22 +1,28 @@
 module Apitome
   class Engine < ::Rails::Engine
     isolate_namespace Apitome
+    apitome = Apitome.configuration
 
-    config.assets.precompile += %w( apitome/*.css apitome/*.js )
+    routes do
+      root to: "docs#index"
+      get "/simulate/*path", to: "docs#simulate", as: :simulated if apitome.simulated_response
+      get "/*path", to: "docs#show" unless Apitome.configuration.single_page
+    end
 
     initializer :assets, group: :all do |app|
-      # default the root if it's not set
-      Apitome.configuration.root ||= app.root
+      apitome.root ||= app.root
+
+      config.assets.precompile += ["apitome/*.css", "apitome/*.js"]
+      config.assets.paths << root.join("assets", "stylesheets").to_s
+      config.assets.paths << root.join("assets", "javascripts").to_s
     end
 
     config.after_initialize do |app|
-      # prepend routes so a catchall doesn't get in the way
-      if Apitome.configuration.mount_at.present?
+      if apitome.mount_at.present?
         app.routes.prepend do
-          mount Apitome::Engine => Apitome.configuration.mount_at
+          mount Apitome::Engine => apitome.mount_at
         end
       end
     end
-
   end
 end

data/lib/apitome/exceptions.rb

@@ -1,3 +1,7 @@
 module Apitome
-  class FileNotFound < Exception; end
+  class Error < StandardError
+  end
+
+  class FileNotFoundError < Apitome::Error
+  end
 end

data/lib/apitome/version.rb

@@ -1,3 +1,3 @@
 module Apitome
-  VERSION = "0.0.8"
+  VERSION = "0.3.0"
 end

data/lib/generators/apitome/install/POST_INSTALL

@@ -1,4 +1,4 @@
 +============================================================================+
 Congratulations! Apitome was successfully installed.
 
-Documentation and more can be found at: https://github.com/modeset/apitome
+Documentation and more can be found at: https://github.com/jejacks0n/apitome

data/lib/generators/apitome/install/install_generator.rb

@@ -5,10 +5,8 @@ module Apitome
 
       desc "Installs the Apitome initializer and markdown file into your application."
 
-      class_option :assets, type: :boolean,
-                   aliases: "-a",
-                   default: false,
-                   desc:    "Install the javascript and stylesheet assets to /public"
+      class_option :assets, type: :boolean, default: false,
+        aliases: "-a", desc: "Install the javascript and stylesheet assets to /public"
 
       def copy_initializers
         copy_file "templates/initializer.rb", "config/initializers/apitome.rb"
@@ -17,14 +15,15 @@ module Apitome
 
       def copy_assets
         return unless options[:assets]
-        copy_file "../../../../app/assets/javascripts/apitome/bundle.js", "public/javascripts/apitome/application.js"
-        copy_file "../../../../app/assets/stylesheets/apitome/bundle.css", "public/stylesheets/apitome/application.css"
+        @asset_root = "../../../../app/assets"
+
+        copy_file "#{@asset_root}/javascripts/apitome/bundle.js", "public/javascripts/apitome/application.js"
+        copy_file "#{@asset_root}/stylesheets/apitome/bundle.css", "public/stylesheets/apitome/application.css"
       end
 
-      def display_readme
+      def display_post_install
         readme "POST_INSTALL" if behavior == :invoke
       end
-
     end
   end
 end