apitome 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a353a3202331bc578b1953eb57e5487af66e7f74
-  data.tar.gz: 43208184eb1f9fb13e24b2f150103e558f44ac55
+  metadata.gz: a1e1b44d0fcdb63bafd524f03297c31f51c4b523
+  data.tar.gz: f7ed3657e3e285f7aaae171fcf0337e3052108a2
 SHA512:
-  metadata.gz: 7042fbafc30cdae94c57f1ed70481a4616333e6d09cdba777a662182fc4fd733582379b295dbfae540ba2754c5130ed899d32dbad0c24e71d197159aabaf50a3
-  data.tar.gz: 5ef301b2e922b7882c849dd26c98a39de676b93c5e3c8eac1b58bb49a942a06c9e4eb5b98514a63e40f87ac09f6e15a6bf6a23eac3991e6a1de1045c8b07bafd
+  metadata.gz: f57528a4c1e0488e6a9b546f1cd99212fd889f082642cd6eb2a7744cad4c8526536d2f9a5d2325cbafbc840058f351845eaa1a6ce316527b33e561ea81e0e3d5
+  data.tar.gz: 3fe1abfa64a4fc598312173ff16702b8d2adbbab1959458322a754cf20fee6fd3462d8165bb33b285881e319659abe6787ce7a70bb037231183a091c6c18fd40

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

@@ -1,6 +1,5 @@
 /*
  *= require apitome/bootstrap.min
- *= require apitome/highlight_themes/default
  */
 
 body {
@@ -10,7 +9,7 @@ body {
 
 h1,
 h2 {
-  margin-top: 30px;
+  margin-top: 20px;
 }
 pre {
   background: #fcfbf9;
@@ -80,12 +79,28 @@ pre code {
   font-size: 90%;
 }
 
-body.single-page .docs-section section.readme article {
-  margin-top: -50px;
-  margin-bottom: -20px;
+body.single-page .docs-section > section {
+  padding-top: 20px;
+  padding-bottom: 10px;
+  border-bottom: 1px solid #eee;
 }
-body.single-page .docs-section section article {
-  padding-top: 50px;
+body.single-page .docs-section > section h1 {
+  padding-top: 25px;
+  margin-bottom: -45px;
+}
+body.single-page .docs-section > section article {
+  padding-top: 60px;
+}
+
+body.single-page .docs-section > section.readme {
+  padding-top: 0;
+}
+body.single-page .docs-section > section.readme h1 {
+  padding-top: 0;
+  margin-bottom: 0;
+}
+body.single-page .docs-section > section.readme article {
+  margin-top: -52px;
 }
 
 @media screen and (min-width: 992px) {

data/app/controllers/apitome/docs_controller.rb

@@ -32,7 +32,11 @@ class Apitome::DocsController < ActionController::Base
 
   def formatted_readme
     file = Apitome.configuration.root.join(Apitome.configuration.doc_path, Apitome.configuration.readme)
-    GitHub::Markdown.render_gfm(file_for(file))
+    if defined?(GitHub::Markdown)
+      GitHub::Markdown.render_gfm(file_for(file))
+    else
+      Kramdown::Document.new(file_for(file)).to_html
+    end
   end
 
   def formatted_body(body, type)

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

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

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

@@ -1,4 +1,4 @@
 <section class="body">
-  <h4>Body</h4>
+  <h4><%= t(:body) %></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>cURL</h4>
+  <h4><%= t(:curl) %></h4>
   <pre><%= request['curl'] %></pre>
 </section>

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

@@ -1,11 +1,11 @@
-<h3><%= example['description'] %></h3>
+<h2><%= example['description'] %></h2>
 
 <%= 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>
+    <h3><%= t(: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']} %>
@@ -14,8 +14,9 @@
       <%= render partial: 'apitome/docs/curl',     locals: {request: request, index: index} if request['curl'] %>
     </div>
 
-    <h3>Response</h3>
+    <h3><%= t(:response) %></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'] %>

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

@@ -1,4 +1,4 @@
 <section class="headers">
-  <h4>Headers</h4>
+  <h4><%= t(: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

@@ -1,9 +1,9 @@
 <ul class="nav sidenav">
   <li>
     <% if Apitome.configuration.single_page %>
-      <a href="#readme">README</a>
+      <a href="#readme"><%= t(:readme) %></a>
     <% else %>
-      <a href="<%= Apitome.configuration.mount_at %>">README</a>
+      <a href="<%= Apitome.configuration.mount_at %>"><%= t(:readme) %></a>
     <% end %>
   </li>
   <% resources.each do |resource| %>

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

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

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

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

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

@@ -0,0 +1,27 @@
+<section class="params">
+  <h3><%= t(:response_fields) %></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">
+            <% 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/_route.html.erb

@@ -1,4 +1,4 @@
 <section class="route">
-  <h4>Route</h4>
+  <h4><%= t(:route) %></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>Status</h4>
+  <h4><%= t(:status) %></h4>
   <pre><code class="http"><%= request['response_status'] %></code></pre>
 </section>

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

@@ -1,2 +1,2 @@
-<h2 class="resource-name"><%= example['resource'] %></h2>
+<h1 class="resource-name"><%= example['resource'] %></h1>
 <%= render 'example' %>

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

@@ -3,6 +3,7 @@
 <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' %>
 </head>

data/config/locales/en.yml

@@ -0,0 +1,12 @@
+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

data/config/locales/es.yml

@@ -0,0 +1,11 @@
+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

data/lib/apitome.rb

@@ -4,4 +4,4 @@ require 'apitome/configuration'
 
 require 'apitome/engine'
 
-require 'github/markdown'
+require 'kramdown'

data/lib/apitome/configuration.rb

@@ -19,6 +19,10 @@ module Apitome
     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

data/lib/apitome/engine.rb

@@ -2,6 +2,8 @@ module Apitome
   class Engine < ::Rails::Engine
     isolate_namespace Apitome
 
+    config.assets.precompile += %w( apitome/*.css apitome/*.js )
+
     initializer :assets, group: :all do |app|
       # default the root if it's not set
       Apitome.configuration.root ||= app.root

data/lib/apitome/version.rb

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

data/lib/generators/apitome/install/templates/initializer.rb

@@ -1,9 +1,9 @@
 Apitome.setup do |config|
 
-  # This determines where the Apitome routes will be mounted. Changing this to "/api/documentation" for instance would
+  # This determines where the Apitome routes will be mounted. Changing this to '/api/documentation' for instance would
   # allow you to browse to http://localhost:3000/api/documentation to see your api documentation. Set to nil and mount
   # it yourself if you need to.
-  config.mount_at = "/api/docs"
+  config.mount_at = '/api/docs'
 
   # This defaults to Rails.root if left nil. If you're providing documentation for an engine using a dummy application
   # it can be useful to set this to your engines root.. E.g. Application::Engine.root
@@ -33,7 +33,7 @@ Apitome.setup do |config|
   # override, but if you want to override it entirely you can do so.
   config.js_override = nil
 
-  # You can provide a "README" style markdown file for the documentation, which is a useful place to include general
+  # You can provide a 'README' style markdown file for the documentation, which is a useful place to include general
   # information. This path is relative to your doc_path configuration.
   config.readme = '../api.md'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apitome
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - jejacks0n
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -45,19 +45,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: github-markdown
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.3
 description: API documentation renderer for Rails using RSpec API Documentation JSON
   output
 email:
@@ -83,11 +83,14 @@ files:
 - app/views/apitome/docs/_navigation.html.erb
 - app/views/apitome/docs/_params.html.erb
 - app/views/apitome/docs/_query.html.erb
+- app/views/apitome/docs/_response_fields.html.erb
 - app/views/apitome/docs/_route.html.erb
 - app/views/apitome/docs/_status.html.erb
 - app/views/apitome/docs/index.html.erb
 - app/views/apitome/docs/show.html.erb
 - app/views/layouts/apitome/application.html.erb
+- config/locales/en.yml
+- config/locales/es.yml
 - config/routes.rb
 - lib/apitome.rb
 - lib/apitome/configuration.rb
@@ -110,37 +113,8 @@ files:
 - spec/dummy/config/initializers/apitome.rb
 - spec/dummy/config/routes.rb
 - spec/dummy/doc/api.md
-- spec/dummy/doc/api/access_tokens/generating_an_access_token.json
-- spec/dummy/doc/api/alerts/listing_alert_types.json
-- spec/dummy/doc/api/alerts/listing_alerts.json
-- spec/dummy/doc/api/index.json
-- spec/dummy/log/development.log
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
-- spec/dummy/tmp/cache/assets/development/sprockets/038ff9775f572c3dfc1a380247c59890
-- spec/dummy/tmp/cache/assets/development/sprockets/03fdbedf7c517a2e1feda524c52a652a
-- spec/dummy/tmp/cache/assets/development/sprockets/07b6695ed44671a8d213823bc763b378
-- spec/dummy/tmp/cache/assets/development/sprockets/0f10ed0a447d44a80afcc427e858ddf1
-- spec/dummy/tmp/cache/assets/development/sprockets/3c0d7839d05fa6264e540e4612e76d8e
-- spec/dummy/tmp/cache/assets/development/sprockets/51da1b3982537bb7f98b971e3f9c45f1
-- spec/dummy/tmp/cache/assets/development/sprockets/53ba3c64ee4d340ffd21feaab8cc579a
-- spec/dummy/tmp/cache/assets/development/sprockets/54ddec13d8230a77be44f49bba9ab063
-- spec/dummy/tmp/cache/assets/development/sprockets/82a9467461d6cbd74f0c38002037d366
-- spec/dummy/tmp/cache/assets/development/sprockets/82b46b5876ec191ffb4ee1f73b9037cf
-- spec/dummy/tmp/cache/assets/development/sprockets/833c936b0961f9bc9f6821682b662c28
-- spec/dummy/tmp/cache/assets/development/sprockets/86d22f0e7f750dbdf5b602b99e7c51c8
-- spec/dummy/tmp/cache/assets/development/sprockets/898d7a0610dc79a7141e7b570b77a951
-- spec/dummy/tmp/cache/assets/development/sprockets/8eb01b8f553b48d4712bc6df728f05ed
-- spec/dummy/tmp/cache/assets/development/sprockets/98be05ccb93e3f09cd213ad66be4afd5
-- spec/dummy/tmp/cache/assets/development/sprockets/a4636c23002ad75a90567e067a4a87b2
-- spec/dummy/tmp/cache/assets/development/sprockets/a47d2ddd9c0e1b87d20a911bb1c92651
-- spec/dummy/tmp/cache/assets/development/sprockets/a7dbf6dc1b06132961af53b0dc4bd187
-- spec/dummy/tmp/cache/assets/development/sprockets/b7fc26490932e9ef364d72f46116f29a
-- spec/dummy/tmp/cache/assets/development/sprockets/d9052716353aa1cde34614ee79e75fc2
-- spec/dummy/tmp/cache/assets/development/sprockets/dab2b969e1e0d90b3b2325566486eca9
-- spec/dummy/tmp/cache/assets/development/sprockets/dfd8cd5b3aa5e4d8e14f8b26118e94f3
-- spec/dummy/tmp/cache/assets/development/sprockets/e71d75c9c50c9552b2c6a42957e853fd
-- spec/dummy/tmp/cache/assets/development/sprockets/fa138ab5e008fb2d4c75be6c6558677b
 - vendor/assets/javascripts/apitome/bootstrap.min.LICENSE
 - vendor/assets/javascripts/apitome/bootstrap.min.js
 - vendor/assets/javascripts/apitome/highlight.min.LICENSE
@@ -195,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: 'Apitome: /iˈpitəmē/ An API documentation reader RSpec API Documentation'
@@ -210,36 +184,7 @@ test_files:
 - spec/dummy/config/initializers/apitome.rb
 - spec/dummy/config/routes.rb
 - spec/dummy/config.ru
-- spec/dummy/doc/api/access_tokens/generating_an_access_token.json
-- spec/dummy/doc/api/alerts/listing_alert_types.json
-- spec/dummy/doc/api/alerts/listing_alerts.json
-- spec/dummy/doc/api/index.json
 - spec/dummy/doc/api.md
-- spec/dummy/log/development.log
 - spec/dummy/public/favicon.ico
 - spec/dummy/Rakefile
 - spec/dummy/script/rails
-- spec/dummy/tmp/cache/assets/development/sprockets/038ff9775f572c3dfc1a380247c59890
-- spec/dummy/tmp/cache/assets/development/sprockets/03fdbedf7c517a2e1feda524c52a652a
-- spec/dummy/tmp/cache/assets/development/sprockets/07b6695ed44671a8d213823bc763b378
-- spec/dummy/tmp/cache/assets/development/sprockets/0f10ed0a447d44a80afcc427e858ddf1
-- spec/dummy/tmp/cache/assets/development/sprockets/3c0d7839d05fa6264e540e4612e76d8e
-- spec/dummy/tmp/cache/assets/development/sprockets/51da1b3982537bb7f98b971e3f9c45f1
-- spec/dummy/tmp/cache/assets/development/sprockets/53ba3c64ee4d340ffd21feaab8cc579a
-- spec/dummy/tmp/cache/assets/development/sprockets/54ddec13d8230a77be44f49bba9ab063
-- spec/dummy/tmp/cache/assets/development/sprockets/82a9467461d6cbd74f0c38002037d366
-- spec/dummy/tmp/cache/assets/development/sprockets/82b46b5876ec191ffb4ee1f73b9037cf
-- spec/dummy/tmp/cache/assets/development/sprockets/833c936b0961f9bc9f6821682b662c28
-- spec/dummy/tmp/cache/assets/development/sprockets/86d22f0e7f750dbdf5b602b99e7c51c8
-- spec/dummy/tmp/cache/assets/development/sprockets/898d7a0610dc79a7141e7b570b77a951
-- spec/dummy/tmp/cache/assets/development/sprockets/8eb01b8f553b48d4712bc6df728f05ed
-- spec/dummy/tmp/cache/assets/development/sprockets/98be05ccb93e3f09cd213ad66be4afd5
-- spec/dummy/tmp/cache/assets/development/sprockets/a4636c23002ad75a90567e067a4a87b2
-- spec/dummy/tmp/cache/assets/development/sprockets/a47d2ddd9c0e1b87d20a911bb1c92651
-- spec/dummy/tmp/cache/assets/development/sprockets/a7dbf6dc1b06132961af53b0dc4bd187
-- spec/dummy/tmp/cache/assets/development/sprockets/b7fc26490932e9ef364d72f46116f29a
-- spec/dummy/tmp/cache/assets/development/sprockets/d9052716353aa1cde34614ee79e75fc2
-- spec/dummy/tmp/cache/assets/development/sprockets/dab2b969e1e0d90b3b2325566486eca9
-- spec/dummy/tmp/cache/assets/development/sprockets/dfd8cd5b3aa5e4d8e14f8b26118e94f3
-- spec/dummy/tmp/cache/assets/development/sprockets/e71d75c9c50c9552b2c6a42957e853fd
-- spec/dummy/tmp/cache/assets/development/sprockets/fa138ab5e008fb2d4c75be6c6558677b

data/spec/dummy/doc/api/access_tokens/generating_an_access_token.json

@@ -1,47 +0,0 @@
-{
-  "resource": "Access Tokens",
-  "http_method": "POST",
-  "route": "/api/oauth/token.json",
-  "description": "Generating an access token",
-  "explanation": "        Before any API requests can be fulfilled a valid oauth access token must be requested. This token is required to be provided in the Authorization header as <code>Bearer [access_token]</code> for all other API requests.<br/><br/>\n        A Client ID and Secret Key will be issued for your specific client application which will be used to retrieve your token.<br/><br/>\n        If an unknown or invalid token is provided to any API request, a 401 status is returned with additional messaging.<br/><br/>\n",
-  "parameters": [
-    {
-      "required": true,
-      "name": "client_id",
-      "description": "Client ID (as provided)"
-    },
-    {
-      "required": true,
-      "name": "client_secret",
-      "description": "Client Secret (as provided)"
-    },
-    {
-      "required": true,
-      "Expected": "client_credentials",
-      "name": "grant_type",
-      "description": "Grant Type"
-    }
-  ],
-  "requests": [
-    {
-      "request_method": "POST",
-      "request_path": "/api/oauth/token.json",
-      "request_body": "{\"client_id\":\"ed76da6a68dda8c08cf047ba2bb6efc4b68954ce7c8cb7f697dab3e74848bf83\",\"client_secret\":\"882dc99d1971589ea74390be04d32a926d7c67e58ddb8683d92236bb9125381a\",\"grant_type\":\"client_credentials\"}",
-      "request_headers": {
-        "Content-Type": "application/json",
-        "Accept": "application/json",
-        "Host": "example.org",
-        "Cookie": ""
-      },
-      "request_query_parameters": {
-      },
-      "request_content_type": "application/json",
-      "response_status": 200,
-      "response_status_text": "OK",
-      "response_body": "{\"access_token\":\"684a867ac0faae326680cb642de78c0a097e6830350b8f47d2b8eed5338dcb21\",\"token_type\":\"bearer\",\"expires_in\":7200,\"refresh_token\":null,\"scope\":\"\"}",
-      "response_headers": {"Content-Type":"application/json; charset=utf-8","Cache-Control":"no-store","Pragma":"no-cache","ETag":"\"990747d7d337812e5014c730d1c67922\"","X-Request-Id":"86f83f85-b0e3-4e40-8d41-859b9f4bf829","X-Runtime":"0.093011","Content-Length":"155"},
-      "response_content_type": "application/json; charset=utf-8",
-      "curl": null
-}
-  ]
-}