apitome 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjBhMmIwYWE5MTk1ODg5Njg3Zjg3ZTYyZGZlNjMxNmZkYjkxODEwNg==
+  data.tar.gz: !binary |-
+    YmZlY2NjYzczOTZlNmQ1YWVjZDhhYWRmNWIzMTc4N2IwOTE4NDY1YQ==
+SHA512:
+  metadata.gz: !binary |-
+    OGQ4ZDQ3YjQyMzM2MjU0ZmQ0ZDkwNTVhOThjYTIwMTEzOTg4ZGRkMDdhNGFm
+    ODlkNDMyODlkZTIzNzEwM2E2MzBhNWM5MTNiM2E0YmFlZmY2ZmY2MjgzZmEz
+    ZDBiY2U1OTkwMjk3YmRkZDNiYzgxYWZkY2JiZjNjMjhiMjgzNGQ=
+  data.tar.gz: !binary |-
+    ODY2NWU2ZTlhNzhhNmNhMDkyZGQyOTg2ZjY4MDlhY2NkZDQ2ZjYyMjA2ZmRm
+    MTBkNTBjMDY1N2Y2OGU3ZWYxOGZkNDgwM2NjZjg5ZTM0OGFmNzRhNWQwM2Vm
+    NjMxNjc4Nzk0YzEzMjE1MmQ1OGMxMzBmNWYxMmQ1MGQ2YTdhNzY=

data/MIT.LICENSE

@@ -0,0 +1,22 @@
+Copyright 2013 Jeremy Jackson / ModeSet
+
+https://github.com/modeset/teaspoon
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,21 @@
+Apitome
+=======
+
+
+
+`spec_helper.rb`
+```ruby
+RspecApiDocumentation.configure do |config|
+  config.format = :json
+end
+```
+
+## License
+
+Licensed under the [MIT License](http://creativecommons.org/licenses/MIT/)
+
+Copyright 2013 [Mode Set](https://github.com/modeset)
+
+
+## Make Code Not War
+![crest](https://secure.gravatar.com/avatar/aa8ea677b07f626479fd280049b0e19f?s=75)

data/app/assets/javascripts/apitome/application.js

@@ -0,0 +1,16 @@
+//= require apitome/jquery-2.0.3.min
+//= require apitome/bootstrap.min
+//= require apitome/highlight.min
+
+hljs.initHighlightingOnLoad();
+
+jQuery(function(){
+  $(document.body).scrollspy({target: '.sidebar', offset: $('.navbar').outerHeight(true)});
+  var $sideBar = $('.single-page .sidebar');
+  $sideBar.affix({
+    offset: {
+      top: function () { return this.top = $sideBar.offset().top - $('.docs-nav').height() - 30 }
+    }
+  })
+});
+

data/app/assets/stylesheets/apitome/application.css

@@ -0,0 +1,120 @@
+/*
+ *= require apitome/bootstrap.min
+ *= require apitome/highlight_themes/default
+ */
+
+body {
+  position: relative;
+  padding-top: 50px;
+}
+
+h1,
+h2 {
+  margin-top: 30px;
+}
+pre code {
+  padding: 0;
+  background: transparent;
+}
+.table code {
+  font-size: 13px;
+  font-weight: normal;
+}
+
+.docs-nav {
+  text-shadow: 0 -1px 0 rgba(0,0,0,.15);
+  background-color: #eee;
+  border-color: #ddd;
+  border-top: 4px solid #009dc4;
+  box-shadow: 0 1px 0 rgba(255,255,255,.1);
+  margin-bottom: 25px;
+}
+.docs-nav .navbar-brand {
+  margin: 0;
+}
+.docs-nav .navbar-brand a {
+  color: #333;
+  text-decoration: none;
+}
+
+.sidebar.affix {
+  position: static;
+}
+.sidenav {
+  margin-top: 30px;
+  margin-bottom: 30px;
+  padding-top: 10px;
+  padding-bottom: 10px;
+  text-shadow: 0 1px 0 #fff;
+  background-color: #f7f5fa;
+  border-radius: 5px;
+}
+.sidebar .nav > li > a {
+  display: block;
+  color: #716b7a;
+  padding: 5px 20px;
+}
+.sidebar .nav > li > a:hover,
+.sidebar .nav > li > a:focus {
+  text-decoration: none;
+  background-color: #e5e3e9;
+  border-right: 1px solid #dbd8e0;
+}
+.sidebar .nav > .active > a,
+.sidebar .nav > .active:hover > a,
+.sidebar .nav > .active:focus > a {
+  font-weight: bold;
+  color: #333;
+  background-color: transparent;
+  border-right: 1px solid #009dc4;
+}
+.sidebar .nav .nav {
+  margin-bottom: 8px;
+}
+.sidebar .nav .nav > li > a {
+  padding-top: 3px;
+  padding-bottom: 3px;
+  padding-left: 30px;
+  font-size: 90%;
+}
+
+body.single-page .docs-section section.readme article {
+  margin-top: -50px;
+  margin-bottom: -20px;
+}
+body.single-page .docs-section section article {
+  padding-top: 50px;
+}
+
+@media screen and (min-width: 992px) {
+  .sidebar.affix {
+    position: fixed;
+    top: 80px;
+  }
+  .sidebar.affix,
+  .sidebar.affix-bottom {
+    width: 283px;
+  }
+  .sidebar.affix-bottom {
+    position: absolute;
+  }
+  .sidebar.affix .sidenav,
+  .sidebar.affix-bottom .sidenav {
+    margin-top: 0;
+    margin-bottom: 0;
+  }
+  body.single-page .sidebar .nav .nav {
+    display: none;
+  }
+  body.single-page .sidebar .nav > .active > ul {
+    display: block;
+  }
+}
+
+@media screen and (min-width: 1200px) {
+  .sidebar.affix,
+  .sidebar.affix-bottom {
+    width: 350px;
+  }
+}
+

data/app/controllers/apitome/docs_controller.rb

@@ -0,0 +1,63 @@
+class Apitome::DocsController < ActionController::Base
+
+  layout Apitome.configuration.layout
+
+  helper_method :resources, :example, :formatted_body, :param_headers, :param_extras, :formatted_readme, :set_example, :id_for
+
+  def index
+  end
+
+  def show
+  end
+
+  private
+
+  def file_for(file)
+    file = Apitome.configuration.root.join(Apitome.configuration.doc_path, file)
+    raise Apitome::FileNotFound unless File.exists?(file)
+    File.read(file)
+  end
+
+  def resources
+    @resources ||= JSON.parse(file_for('index.json'))['resources']
+  end
+
+  def example
+    @example ||= JSON.parse(file_for("#{params[:path]}.json"))
+  end
+
+  def set_example(resource)
+    @example = JSON.parse(file_for("#{resource}.json"))
+  end
+
+  def formatted_readme
+    file = Apitome.configuration.root.join(Apitome.configuration.doc_path, Apitome.configuration.readme)
+    GitHub::Markdown.render_gfm(file_for(file))
+  end
+
+  def formatted_body(body, type)
+    if type =~ /json/
+      JSON.pretty_generate(JSON.parse(body))
+    else
+      body
+    end
+  end
+
+  def param_headers(params)
+    titles = %w{Name Description}
+    titles += param_extras(params)
+  end
+
+  def param_extras(params)
+    extras = []
+    for param in params
+      extras += param.reject{ |k,v| %w{name description required scope}.include?(k) }.keys
+    end
+    extras.uniq
+  end
+
+  def id_for(str)
+    str.gsub(/\.json$/, '').underscore.gsub(/[^0-9a-z]+/i, '-')
+  end
+
+end

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

@@ -0,0 +1,10 @@
+<% resources.each do |resource| %>
+  <section class="example" id="<%= id_for(resource['name']) %>">
+    <% resource['examples'].each do |example| %>
+      <article id="<%= id_for(example['link'].gsub('.json', '')) %>">
+        <% set_example(example['link'].gsub('.json', '')) %>
+        <%= render partial: 'example' %>
+      </article>
+    <% end %>
+  </section>
+<% end %>

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

@@ -0,0 +1,4 @@
+<section class="body">
+  <h4>Body</h4>
+  <pre><code class="<%= type %>"><%= formatted_body(body, type) %></code></pre>
+</section>

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

@@ -0,0 +1,4 @@
+<section class="curl">
+  <h4>cURL</h4>
+  <pre><%= request['curl'] %></pre>
+</section>

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

@@ -0,0 +1,25 @@
+<h2><%= example['resource'] %> API</h2>
+<h3><%= example['description'] %></h3>
+
+<%= render partial: 'apitome/docs/explanation',    locals: {explaination: example['explanation']} if example['explanation'] %>
+<%= 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>Request</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']} %>
+      <%= render partial: 'apitome/docs/query',    locals: {request: request, index: index} unless request['request_query_parameters'].empty? %>
+      <%= render partial: 'apitome/docs/body',     locals: {request: request, index: index, body: request['request_body'], type: request['request_content_type']} if request['request_body'] %>
+      <%= render partial: 'apitome/docs/curl',     locals: {request: request, index: index} if request['curl'] %>
+    </div>
+
+    <h3>Response</h3>
+    <div class="response">
+      <%= 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

@@ -0,0 +1,3 @@
+<p class="explanation">
+  <%= raw example['explanation'] %>
+</p>

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

@@ -0,0 +1,7 @@
+<header class="navbar navbar-fixed-top docs-nav" role="banner">
+  <div class="container">
+    <div class="navbar-header">
+      <h1 class="navbar-brand"><a href="<%= Apitome.configuration.mount_at %>"><%= Apitome.configuration.title %></a></h1>
+    </div>
+  </div>
+</header>

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

@@ -0,0 +1,4 @@
+<section class="headers">
+  <h4>Headers</h4>
+  <pre><code class="http"><%= headers.map{ |k,v| "#{k}: #{v}" }.join("\n") %></code></pre>
+</section>

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

@@ -0,0 +1,28 @@
+<ul class="nav sidenav">
+  <li>
+    <% if Apitome.configuration.single_page %>
+      <a href="#readme">README</a>
+    <% else %>
+      <a href="<%= Apitome.configuration.mount_at %>">README</a>
+    <% end %>
+  </li>
+  <% resources.each do |resource| %>
+    <li>
+      <% if Apitome.configuration.single_page %>
+        <a href="#<%= id_for(resource['examples'].first['link']) %>"><%= 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>
+        <ul class="nav">
+          <% resource['examples'].each do |example| %>
+            <li><%= link_to example['description'], "#{Apitome.configuration.mount_at}/#{example['link'].gsub(/\.json$/, '')}" %></li>
+          <% end %>
+        </ul>
+      <% end %>
+    </li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,27 @@
+<section class="params">
+  <h3>Parameters</h3>
+  <div class="table-responsive">
+    <table class="table table-bordered">
+      <tr>
+        <% param_headers(params).each do |title| %>
+          <th><%= title %></th>
+        <% end %>
+      </tr>
+      <% params.each do |param| %>
+        <tr>
+          <td class="name <%= param['required'] ? 'required' : '' %>">
+            <% if param['scope'] %>
+              <%= "#{param['scope']}[#{param['name']}]" %>
+            <% else %>
+              <%= param['name'] %>
+            <% end %>
+          </td>
+          <td class="description"><%= param['description'] %></td>
+          <% param_extras(params).each do |extra| %>
+            <td class="extra"><%= param[extra] %></td>
+          <% end %>
+        </tr>
+      <% end %>
+    </table>
+  </div>
+</section>

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

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

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

@@ -0,0 +1,4 @@
+<section class="route">
+  <h4>Route</h4>
+  <pre><%= "#{request['request_method']} #{request['request_path']}" %></pre>
+</section>

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

@@ -0,0 +1,4 @@
+<section class="status">
+  <h4>Status</h4>
+  <pre><code class="http"><%= request['response_status'] %></code></pre>
+</section>

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

@@ -0,0 +1,6 @@
+<section class="readme" id="readme">
+  <article>
+    <%= raw formatted_readme %>
+  </article>
+</section>
+<%= render 'all_examples' if Apitome.configuration.single_page %>

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

@@ -0,0 +1 @@
+<%= render 'example' %>

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

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= Apitome.configuration.title %></title>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <%= stylesheet_link_tag    Apitome.configuration.css_override || 'apitome/application', media: 'all' %>
+  <%= javascript_include_tag Apitome.configuration.js_override || 'apitome/application' %>
+</head>
+<body class="<%= Apitome.configuration.single_page ? 'single-page' : '' %>">
+
+<div class="container">
+  <%= render 'header' %>
+  <div class="container docs-container">
+    <div class="row">
+      <div class="col-md-4">
+        <div id="sidebar" class="sidebar hidden-print" role="complementary">
+          <%= render 'navigation' %>
+        </div>
+      </div>
+      <div class="col-md-8" role="main">
+        <div class="docs-section">
+          <%= yield %>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+
+</body>
+</html>