apitome 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03db784396e463e2e3117c3876221da9501bdf370b2b31d64af0aeb20832f6a7
-  data.tar.gz: 2c44ee118c18033c0ff752156b34501bc915afa2f1ff14db11bdd48cb63ad899
+  metadata.gz: efbf3bab00d3066329b5e4e13d06759c955126affdf49134524c53ca598e4cd7
+  data.tar.gz: 17eb4bdfe7ae58f73bc61a60e20e2326e8315c332992b63f43e3c5b28354b968
 SHA512:
-  metadata.gz: 2ad3ae73aac6bc4fda71089236cc5b1387ace99b0289777249da6cd0c5e44efb3e99d07d2107006a23149b902dc5890835b18fd9034c34759054436a1dd0731e
-  data.tar.gz: c565e5d1a99fc2157d7892bdd7bed7d8bf353c6472c234c8ac7468d0fc8eb50dc8511ee96a115b071343ddb61cf93bd71284644b2da72e5a26c872489f63ec83
+  metadata.gz: 50602b8235b8f3f6bc3499526044853f478a353de18d2117e135f749bf76aeb3222283a60613a6dc88a20b8118f15790b5f3a44e8fb7edd0b1b203194f1a77a8
+  data.tar.gz: 5e1c5b4dd2ecdd6db82f120a96ff7132defea2cf9e642acab80272f7821a854cd9b4f78e8e266bdb1a81b015033997073707419a390b4a32d3e44856fc148fbb

data/README.md

@@ -5,7 +5,7 @@ Apitome
 [![Build Status](https://img.shields.io/travis/jejacks0n/apitome.svg)](https://travis-ci.org/jejacks0n/apitome)
 [![Maintainability](https://api.codeclimate.com/v1/badges/eb8dd1c22f1da11b6c02/maintainability)](https://codeclimate.com/github/jejacks0n/apitome/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/eb8dd1c22f1da11b6c02/test_coverage)](https://codeclimate.com/github/jejacks0n/apitome/test_coverage)
-[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
 
 Apitome is a API documentation tool for Rails built on top of the great RSpec DSL included in
 [rspec_api_documentation](https://github.com/zipmark/rspec_api_documentation) (RAD). It's designed to display the
@@ -166,8 +166,8 @@ documentation for each configuration directive. Otherwise you can get a refreshe
 
 ## Customization
 You can put custom views and partials in your own `views/apitome/docs` -- check
-[here for examples](tree/master/app/views/apitome/docs). You can put any partial in your own path and they will be
-overridden.
+[here for examples](https://github.com/jejacks0n/apitome/tree/master/app/views/apitome/docs). You can put any
+partial in your own path and they will be overridden.
 
 Additional customization can come in the form of providing custom css and javascript. You can do this by creating the
 files you want (that often times require the default assets in the gem), and then configure Apitome to use those instead

data/app/controllers/apitome/docs_controller.rb

@@ -3,7 +3,7 @@ require "open-uri"
 class Apitome::DocsController < Object.const_get(Apitome.configuration.parent_controller)
   layout Apitome.configuration.layout
 
-  helper_method *[
+  helper_method(*[
     :resources,
     :example,
     :formatted_body,
@@ -13,7 +13,7 @@ class Apitome::DocsController < Object.const_get(Apitome.configuration.parent_co
     :set_example,
     :id_for,
     :rendered_markdown
-  ]
+  ])
 
   def index
   end
@@ -62,7 +62,7 @@ class Apitome::DocsController < Object.const_get(Apitome.configuration.parent_co
       if Apitome.configuration.remote_url && Apitome.configuration.http_basic_authentication
         { http_basic_authentication: Apitome.configuration.http_basic_authentication }
       else
-        {}
+        nil
       end
     end
 
@@ -80,14 +80,19 @@ class Apitome::DocsController < Object.const_get(Apitome.configuration.parent_co
     end
 
     def formatted_body(body, type)
+      return body if body == " "
+      return body if body == "[binary data]" # see https://github.com/zipmark/rspec_api_documentation/blob/560c3bdc7bd5581e7c223334390221ecfc910be8/lib/rspec_api_documentation/client_base.rb#L88-L96
       if type =~ /json/ && body.present?
         JSON.pretty_generate(JSON.parse(body))
       else
         body
       end
-    rescue JSON::ParserError
-      return body if body == " "
-      raise JSON::ParserError
+    rescue => e
+      if Apitome.configuration.formatted_body_error_handler
+        Apitome.configuration.formatted_body_error_handler.call(e, body, type)
+      else
+        raise
+      end
     end
 
     def param_headers(params)

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

@@ -8,15 +8,26 @@
   <div id="<%= "request-#{index}" %>">
     <h3><%= t(:request, scope: :apitome) %></h3>
     <div class="request">
+      <% begin %>
       <%= 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'] %>
+      <%
+        rescue => e
+          if Apitome.configuration.example_error_handler
+            Apitome.configuration.example_error_handler.call(e, "request", request)
+          else
+            raise
+          end
+        end
+      %>
     </div>
 
     <h3><%= t(:response, scope: :apitome) %></h3>
     <div class="response">
+      <% begin %>
       <%- if Apitome.configuration.simulated_response %>
         <%= link_to('Simulated Response', simulated_path(example[:link])) if example[:link].present? %>
       <%- end %>
@@ -24,6 +35,15 @@
       <%= 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'] %>
+      <%
+        rescue => e
+          if Apitome.configuration.example_error_handler
+            Apitome.configuration.example_error_handler.call(e, "response", request)
+          else
+            raise
+          end
+        end
+      %>
     </div>
   </div>
 <% end %>

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

@@ -11,7 +11,7 @@
         <tr>
           <td class="name">
             <% if param['scope'] %>
-              <%= "#{param['scope']}[#{param['name']}]" %>
+              <%= "#{format_scope(param['scope'])}[#{param['name']}]" %>
             <% else %>
               <%= param['name'] %>
             <% end %>

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

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

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

@@ -6,6 +6,6 @@
   </section>
 <% end %>
 <% if Apitome.configuration.single_page %>
-    <a href="#top" id="scroll-to-top" class="hidden btn btn-primary">Back to Top</a>
+  <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 %>
+<%= render "all_examples" if Apitome.configuration.single_page %>

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

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

@@ -10,12 +10,12 @@
 <body class="<%= Apitome.configuration.single_page ? "single-page" : "" %>">
 
 <div class="container">
-  <%= render 'header' %>
+  <%= 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' %>
+          <%= render "navigation" %>
         </div>
       </div>
       <div class="col-md-8" role="main">

data/lib/apitome/configuration.rb

@@ -4,7 +4,7 @@ module Apitome
   class Configuration
     include Singleton
 
-    cattr_accessor *[
+    cattr_accessor(*[
       :mount_at,
       :root,
       :doc_path,
@@ -21,7 +21,9 @@ module Apitome
       :http_basic_authentication,
       :precompile_assets,
       :simulated_response,
-    ]
+      :formatted_body_error_handler,
+      :example_error_handler,
+    ])
 
     @@mount_at = "/api/docs"
     @@root = nil # will default to Rails.root if left unset
@@ -39,6 +41,8 @@ module Apitome
     @@http_basic_authentication = nil
     @@precompile_assets = true
     @@simulated_response = true
+    @@formatted_body_error_handler = nil
+    @@example_error_handler = nil
 
     def self.root=(path)
       @@root = Pathname.new(path.to_s) if path.present?
@@ -51,5 +55,6 @@ module Apitome
   def self.configure
     yield @@configuration
   end
+
   singleton_class.send(:alias_method, :setup, :configure)
 end

data/lib/apitome/version.rb

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

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

@@ -46,7 +46,7 @@ Apitome.configure do |config|
 
   # You can specify how urls are formatted using a Proc or other callable object.  Your proc will be called with a
   # resource name or link, giving you the opportunity to modify it as necessary for in the documentation url.
-  config.url_formatter = -> (str) { str.gsub(/\.json$/, '').underscore.gsub(/[^0-9a-z\:]+/i, '-') }
+  config.url_formatter = -> (str) { str.gsub(/\.json$/, '').underscore.gsub(/[^[:word:]]/, '-') }
 
   # You can setup the docs to be loaded from a remote URL if they are not available in the application environment. This
   # URL is used as the base location and should be set to where the readme is located. If left nil, local is assumed.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apitome
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - jejacks0n
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-13 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -52,8 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: API documentation renderer for Rails using RSpec API Documentation JSON
-  output
+description: Present clean and usable API documentation generated from RSpec API Documentation
+  JSON output.
 email:
 - jejacks0n@gmail.com
 executables: []
@@ -183,13 +183,13 @@ homepage: https://github.com/jejacks0n/apitome
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -198,8 +198,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: 'Apitome: /iˈpitəmē/ An API documentation reader RSpec API Documentation'
 test_files: []