apipie-rails 0.0.7

data/app/public/apipie/stylesheets/bundled/prettify.css

@@ -0,0 +1,30 @@
+.com { color: #93a1a1; }
+.lit { color: #195f91; }
+.pun, .opn, .clo { color: #93a1a1; }
+.fun { color: #dc322f; }
+.str, .atv { color: #D14; }
+.kwd, .linenums .tag { color: #1e347b; }
+.typ, .atn, .dec, .var { color: teal; }
+.pln { color: #48484c; }
+
+.prettyprint {
+  padding: 8px;
+  background-color: #f7f7f9;
+  border: 1px solid #e1e1e8;
+}
+.prettyprint.linenums {
+  -webkit-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+     -moz-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+          box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin: 0 0 0 33px; /* IE indents via margin-left */
+}
+ol.linenums li {
+  padding-left: 12px;
+  color: #bebec5;
+  line-height: 18px;
+  text-shadow: 0 1px 0 #fff;
+}

data/app/views/apipie/apipies/_params.html.erb

@@ -0,0 +1,22 @@
+<% level ||= 0 %>
+<% col = 255 - level * 5 %>
+<% params.each do |param| %>
+  <tr style='background-color:rgb(<%= "#{col},#{col},#{col}" %>);'>
+    <td>
+      <strong><%= param[:full_name] %> </strong><br>
+      <small>
+        <%= param[:required] ? 'required' : 'optional' %>
+        <%= param[:allow_nil] ? ', nil allowed' : '' %>
+      </small>
+    </td>
+    <td>
+      <%= param[:description].html_safe %>
+      <% unless param[:validator].blank? %>
+        <br>
+        Value: <%= param[:validator] %>
+      <% end %>
+    </td>
+  </tr>
+
+  <%= render(:partial => "params", :locals => {:level => level + 1, :params => param[:params]}) unless param[:params].blank? %>
+<% end %>

data/app/views/apipie/apipies/_params_plain.html.erb

@@ -0,0 +1,16 @@
+<ul>
+  <% params.each do |param| %>
+    <li>
+      <strong><%= param[:name] %> </strong>:
+      <small>
+        <%= param[:required] ? 'required' : 'optional' %>
+        <%= param[:allow_nil] ? ', nil allowed' : '' %>
+        <% if param[:validator] %>
+          [ <%= param[:validator] %> ]
+        <% end %>
+      </small>
+      <%= param[:description].html_safe %>
+    </li>
+    <%= render(:partial => "params_plain", :locals => {:params => param[:params]}) unless param[:params].blank? %>
+  <% end %>
+</ul>

data/app/views/apipie/apipies/index.html.erb

@@ -0,0 +1,36 @@
+<ul class='breadcrumb'>
+  <li class='active'><a href='<%= @doc[:doc_url] %>.html'><%= @doc[:name] %></a></li>
+</ul>
+
+<div><%= @doc[:info].html_safe %></div>
+
+<h1 class='page-header'>Resources</h1>
+
+<% @doc[:resources].sort_by(&:first).each do |key, api| %>
+  <h2>
+    <a href='<%= api[:doc_url] %>.html'><%= api[:name] %></a><br>
+    <small><%= api[:short_description] %></small>
+  </h2>
+  <table class='table'>
+    <thead>
+      <tr>
+        <th>Resource</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% api[:methods].each do |m| %>
+        <% m[:apis].each do |a| %>
+          <tr>
+            <td><a href='<%= m[:doc_url] %>.html'><%= a[:http_method] %> <%= a[:api_url] %></a></td>
+            <td width='60%'><%= a[:short_description] %></td>
+          </tr>
+        <% end %>
+      <% end %>
+    </tbody>
+  </table>
+<% end %>
+
+<% content_for :apipie_footer do %>
+  <%= raw @doc[:copyright] %>
+<% end %>

data/app/views/apipie/apipies/method.html.erb

@@ -0,0 +1,63 @@
+<ul class='breadcrumb'>
+  <li>
+    <a href='<%= @doc[:doc_url] %>.html'><%= @doc[:name] %></a>
+    <span class='divider'>/</span>
+  </li>
+  <li>
+    <a href='<%= @resource[:doc_url] %>.html'><%= @resource[:name] %></a>
+    <span class='divider'>/</span>
+  </li>
+  <li class='active'><%= @method[:name] %></li>
+</ul>
+
+<% @method[:apis].each do |api| %>
+  <div class='page-header'>
+    <h1>
+      <%= api[:http_method] %> <%= api[:api_url] %><br>
+      <small><%= raw api[:short_description] %></small>
+    </h1>
+  </div>
+<% end %>
+
+<div>
+  <% unless @method[:see_url].blank? %>
+    Also see <%= link_to @method[:see], @method[:see_url] %>.
+  <% end %>
+
+  <%= raw @method[:full_description] %>
+
+  <% unless @method[:examples].blank? %>
+    <h2>Examples</h2>
+    <% @method[:examples].each do |example| %>
+      <pre><%= example %></pre>
+    <% end %>
+  <% end %>
+
+  <% unless @method[:errors].blank? %>
+    <h2>Errors</h2>
+    <% @method[:errors].each do |err| %>
+      <%= err.code %>
+      <%= err.description %>
+      <br>
+    <% end %>
+  <% end %>
+
+  <% unless @method[:params].blank? %>
+    <h2>Params</h2>
+    <table class='table'>
+      <thead>
+        <tr>
+          <th>Param name</th>
+          <th>Description</th>
+        </tr>
+      </thead>
+      <tbody>
+        <%= render(:partial => "params", :locals => {:params => @method[:params]}) %>
+      </tbody>
+    </table>
+  <% end %>
+</div>
+
+<% content_for :apipie_footer do %>
+  <%= raw @doc[:copyright] %>
+<% end %>

data/app/views/apipie/apipies/plain.html.erb

@@ -0,0 +1,70 @@
+<% @doc[:resources].sort_by(&:first).each do |key, resource| %>
+  <h4><a href='#<%= key %>'><%= resource[:name] %></a></h4>
+  <ul>
+    <% resource[:methods].each do |method| %>
+      <li><a href='#<%= key %>-<%= method[:name] %>'><%= method[:name] %></a></li>
+    <% end %>
+  </ul>
+<% end %>
+
+
+<% @doc[:resources].sort_by(&:first).each do |key, resource| %>
+
+  <hr/>
+
+  <div>
+    <h2 id="<%= key %>">
+      <a href='#<%= key %>'><%= resource[:name] %></a><br>
+      <small><%= raw resource[:short_description] %></small>
+    </h2>
+  </div>
+
+  <% unless resource[:full_description].blank? %>
+    <div><%= raw resource[:full_description] %></div>
+  <% end %>
+
+  <div>
+
+    <% resource[:methods].each do |method| %>
+      <hr/>
+
+      <h3 id="<%= "#{key}-#{method[:name]}" %>">
+      <a href='#<%= key %>'><%= resource[:name] %></a> / <a href='#<%= "#{key}-#{method[:name]}" %>'><%= method[:name] %></a>
+      </h3>
+
+      <div>
+        <% method[:apis].each do |api| %>
+          <h4>
+              <%= api[:http_method] %> <%= api[:api_url] %>
+            <br>
+            <small><%= raw api[:short_description] %></small>
+          </h4>
+        <% end %>
+      </div>
+
+      <div>
+        <%= raw method[:full_description] %>
+        <% unless method[:examples].blank? %>
+          <h4>Examples</h4>
+          <% method[:examples].each do |example| %>
+            <pre class="wiki"><%= example %></pre>
+          <% end %>
+        <% end %>
+
+        <% unless method[:errors].blank? %>
+          <h4>Errors</h4>
+          <% method[:errors].each do |err| %>
+            <%= err.code %>
+            <%= err.description %>
+            <br>
+          <% end %>
+        <% end %>
+
+        <% unless method[:params].blank? %>
+          <h4>Params</h4>
+          <%= render(:partial => "params_plain", :locals => {:params => method[:params]}) %>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+<% end %>

data/app/views/apipie/apipies/resource.html.erb

@@ -0,0 +1,82 @@
+<ul class='breadcrumb'>
+  <li><a href='<%= @doc[:doc_url] %>.html'><%= @doc[:name] %></a><span class='divider'>/</span></li>
+  <li class='active'><%= @resource[:name] %></li>
+</ul>
+
+<div class='page-header'>
+  <h1>
+    <%= @resource[:name] %><br>
+    <small><%= raw @resource[:short_description] %></small>
+  </h1>
+</div>
+
+
+<% unless @resource[:full_description].blank? %>
+  <div><%= raw @resource[:full_description] %></div>
+<% end %>
+
+<div class='accordion' id='accordion'>
+
+  <% @resource[:methods].each do |m| %>
+    <hr>
+    <div class='pull-right small'>
+      <a href='<%= m[:doc_url] %>.html'> >>> </a>
+    </div>
+    <div>
+      <% m[:apis].each do |api| %>
+        <h2>
+          <a href='#description-<%= m[:name] %>'
+           class='accordion-toggle'
+           data-toggle='collapse'
+           data-parent='#accordion'>
+            <%= api[:http_method] %> <%= api[:api_url] %>
+          </a><br>
+          <small><%= raw api[:short_description] %></small>
+        </h2>
+      <% end %>
+    </div>
+
+    <% unless m[:see_url].blank? %>
+      Also see <%= link_to m[:see], m[:see_url] %>
+    <% end %>
+
+    <div id='description-<%= m[:name] %>' class='collapse accordion-body'>
+
+      <%= raw m[:full_description] %>
+      <% unless m[:errors].blank? %>
+        <h3>Errors</h3>
+        <% m[:errors].each do |err| %>
+          <%= err.code %>
+          <%= err.description %>
+          <br>
+        <% end %>
+      <% end %>
+
+      <% unless m[:examples].blank? %>
+        <h3>Examples</h3>
+        <% m[:examples].each do |example| %>
+          <pre><%= example %></pre>
+        <% end %>
+      <% end %>
+
+      <% unless m[:params].blank? %>
+        <h3>Params</h3>
+        <table class='table'>
+          <thead>
+            <tr>
+              <th>Param name</th>
+              <th>Description</th>
+            </tr>
+          </thead>
+          <tbody>
+            <%= render(:partial => "params", :locals => {:params => m[:params]}) %>
+          </tbody>
+        </table>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+
+<% content_for :apipie_footer do %>
+  <%= raw @doc[:copyright] %>
+<% end %>

data/app/views/apipie/apipies/static.html.erb

@@ -0,0 +1,101 @@
+<% @doc[:resources].sort_by(&:first).each do |key, resource| %>
+  <h4><a href='#<%= key %>'><%= resource[:name] %></a></h4>
+  <ul>
+    <% resource[:methods].each do |method| %>
+      <li><a href='#<%= key %>-<%= method[:name] %>'><%= method[:name] %></a></li>
+    <% end %>
+  </ul>
+<% end %>
+
+
+
+<div><%= @doc[:info].html_safe %></div>
+
+<hr>
+
+<% @doc[:resources].sort_by(&:first).each do |key, resource| %>
+
+  <ul class='breadcrumb'  id='<%= key %>'>
+    <li><a href='#'><%= @doc[:name] %></a><span class='divider'>/</span></li>
+    <li class='active'><%= resource[:name] %></li>
+  </ul>
+
+  <div class='page-header'>
+    <h1>
+      <a href='#<%= key %>'><%= resource[:name] %></a><br>
+      <small><%= raw resource[:short_description] %></small>
+    </h1>
+  </div>
+
+  <% unless resource[:full_description].blank? %>
+    <div><%= raw resource[:full_description] %></div>
+  <% end %>
+
+  <div class='accordion' id='accordion'>
+
+    <% resource[:methods].each do |method| %>
+      <hr>
+
+      <ul class='breadcrumb' id='<%= key %>-<%= method[:name] %>'>
+        <li>
+          <a href='#'><%= @doc[:name] %></a>
+          <span class='divider'>/</span>
+        </li>
+        <li>
+          <a href='#<%= key %>'><%= resource[:name] %></a>
+          <span class='divider'>/</span>
+        </li>
+        <li class='active'><%= method[:name] %></li>
+      </ul>
+
+      <div>
+        <% method[:apis].each do |api| %>
+          <h3>
+            <a href='#<%= key %>-<%= method[:name] %>'>
+              <%= api[:http_method] %> <%= api[:api_url] %>
+            </a><br>
+            <small><%= raw api[:short_description] %></small>
+          </h3>
+        <% end %>
+      </div>
+
+      <div>
+        <%= raw method[:full_description] %>
+        <% unless method[:examples].blank? %>
+          <h2>Examples</h2>
+          <% method[:examples].each do |example| %>
+            <pre><%= example %></pre>
+          <% end %>
+        <% end %>
+
+        <% unless method[:errors].blank? %>
+          <h2>Errors</h2>
+          <% method[:errors].each do |err| %>
+            <%= err.code %>
+            <%= err.description %>
+            <br>
+          <% end %>
+        <% end %>
+
+        <% unless method[:params].blank? %>
+          <h2>Params</h2>
+          <table class='table'>
+            <thead>
+              <tr>
+                <th>Param name</th>
+                <th>Description</th>
+              </tr>
+            </thead>
+            <tbody>
+              <%= render(:partial => "params", :locals => {:params => method[:params]}) %>
+            </tbody>
+          </table>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+<% end %>
+
+<% content_for :apipie_footer do %>
+  <%= raw @doc[:copyright] %>
+<% end %>

data/app/views/layouts/apipie/apipie.html.erb

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>API documentation</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+  <% %w[bundled/bootstrap.min.css
+        application.css
+        bundled/prettify.css
+        bundled/bootstrap-responsive.min.css ].each do |file| %>
+    <link type="text/css" rel="stylesheet"
+          href="<%= Apipie.full_url("stylesheets/#{file}") %>"/>
+  <% end %>
+  <!-- IE6-8 support of HTML5 elements -->
+  <!--[if lt IE 9]>
+    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+</head>
+<body>
+  <div class="container">
+    <div class="row">
+      <div id='container'>
+        <%= yield %>
+      </div>
+    </div>
+    <hr>
+    <footer><%= yield :apipie_footer %></footer>
+  </div>
+  <% %w[
+    bundled/jquery-1.7.2.js
+    bundled/bootstrap-collapse.js
+    bundled/prettify.js
+    apipie.js ].each do |file| %>
+    <script type="text/javascript"
+            src="<%= Apipie.full_url("javascripts/#{file}") %>"></script>
+  <% end %>
+</body>
+</html>