nexmo-oas-renderer 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b851f13c8369bb28d71c4b0c6ec1fd9f000727b5eb361da8740fa7bae22e74db
-  data.tar.gz: 5c516341b40d8dc5b0992456539367489b3298c08882a1aa425d8a5ed28331cd
+  metadata.gz: 3dd76a267e84f8ccf3b0b8ce454b0da5b9f8096245017fa28506579dc40959d8
+  data.tar.gz: 96243f54b8c1abd5c35476878da7d58963537ffc6359435b94a5d00448ca10d5
 SHA512:
-  metadata.gz: c65dea2d20a585ba768cd3898c20e90c8684e14631ebab025a7a8f381576cd4d7b3d9732b78985a249b74c31a1bcb2bd23a2840b9d2fe750a3fe0c17f45a1c4d
-  data.tar.gz: b7ebc350a3aec9cbc0e208b51051b2d8a7b6871f8a2e5cab0b56c243a96f269504ce49587cb66f2ecbcb8a0318869b9dc9c9e1cdbcc866f1d129ec381d2c16d8
+  metadata.gz: 11dfc1c031f31f027e605763d24149b4f4d423b086eb9ebad6968c4dc8bdfcd00460441771f7a88f43ec31fe688d1c392dfa6117f708e8989c425cdbc2d414ff
+  data.tar.gz: 713bd7323c2a24f2e3ae7a7c20fe2b815fafd316760f04e1f7d7713677fc28beba871c7efc35b76c804c41c6e576c3f71192273f147e1fd5848536a304081957

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.8.0
+* Fix an issue when the description is `nil`
+* Include nexmo-markdown-renderer
+* Remove white box surrounding HTTP responses
+* Allow multi-depth `oneOf` definitions
+* Render endpoint's description as markdown
+
 # 0.7.1
 * Use schema's description when there isn't one at the parameter level
 

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (0.7.0)
+    nexmo-oas-renderer (0.8.0)
       activemodel (~> 6.0)
       activesupport (~> 6.0)
       banzai (~> 0.1.2)
       dotenv (~> 2.7)
       neatjson (~> 0.8)
+      nexmo_markdown_renderer (>= 0.0.3)
       oas_parser (~> 0.23)
       octicons_helper (~> 8.2)
       redcarpet (= 3.4.0)
@@ -83,7 +84,7 @@ GEM
     diff-lcs (1.3)
     dotenv (2.7.5)
     erubi (1.9.0)
-    ffi (1.11.3)
+    ffi (1.12.2)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     hansi (0.2.0)
@@ -107,6 +108,14 @@ GEM
       hansi (~> 0.2.0)
       mustermann (= 1.0.3)
     neatjson (0.9)
+    nexmo_markdown_renderer (0.0.3)
+      activemodel (~> 6.0)
+      banzai (~> 0.1.2)
+      i18n (~> 1.7)
+      nokogiri (~> 1.10)
+      octicons_helper (~> 8.2)
+      redcarpet (~> 3.4)
+      rouge (~> 2.0.7)
     nio4r (2.5.2)
     nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
@@ -123,9 +132,9 @@ GEM
     octicons_helper (8.5.0)
       octicons (= 8.5.0)
       rails
-    public_suffix (4.0.1)
+    public_suffix (4.0.3)
     rack (2.0.8)
-    rack-protection (2.0.7)
+    rack-protection (2.0.8.1)
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -157,7 +166,7 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rake (10.5.0)
     rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
+    rb-inotify (0.10.1)
       ffi (~> 1.0)
     redcarpet (3.4.0)
     rouge (2.0.7)
@@ -181,10 +190,10 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
     shotgun (0.9.2)
       rack (>= 1.0)
-    sinatra (2.0.7)
+    sinatra (2.0.8.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.7)
+      rack-protection (= 2.0.8.1)
       tilt (~> 2.0)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)

data/lib/nexmo/oas/renderer/app.rb

@@ -3,9 +3,9 @@ require 'active_support'
 require 'active_support/core_ext/array/conversions'
 require 'active_support/core_ext/string/output_safety'
 require 'active_model'
+require 'nexmo_markdown_renderer'
 
 require_relative'./decorators/response_parser_decorator'
-require_relative'./pipelines/markdown_pipeline'
 require_relative'./presenters/api_specification'
 require_relative'./presenters/open_api_specification'
 require_relative'./presenters/navigation'
@@ -14,8 +14,6 @@ require_relative'./helpers/render'
 require_relative'./helpers/navigation'
 require_relative'./helpers/summary'
 require_relative'./helpers/url'
-require_relative './services/code_language_api'
-require_relative'./lib/core_ext/string'
 
 require 'dotenv/load'
 
@@ -129,7 +127,7 @@ module Nexmo
             @document = 'verify/templates'
           elsif params[:code_language] == 'ncco'
             @document = 'voice/ncco'
-          elsif CodeLanguage.exists?(params[:code_language])
+          elsif ::Nexmo::Markdown::CodeLanguage.exists?(params[:code_language])
             @document = params[:document]
           else
             @document = "#{params[:document]}/#{params[:code_language]}"

data/lib/nexmo/oas/renderer/presenters/api_specification.rb

@@ -36,7 +36,7 @@ module Nexmo
           def content
             options = {}
             options.merge(code_language: @code_language) if @code_language
-            @content ||= MarkdownPipeline.new(options).call(document)
+            @content ||= Nexmo::Markdown::Renderer.new(options).call(document)
           end
         end
       end

data/lib/nexmo/oas/renderer/presenters/open_api_specification.rb

@@ -30,7 +30,7 @@ module Nexmo
           end
 
           def definition_errors
-            @definition_errors ||= MarkdownPipeline.new.call(
+            @definition_errors ||= Nexmo::Markdown::Renderer.new.call(
               File.read("#{API.oas_path}/../../errors/#{@definition_name}.md")
             ) if errors?
           end

data/lib/nexmo/oas/renderer/public/assets/stylesheets/nexmo-oas-renderer.css

@@ -88,7 +88,7 @@ body {
     top: 30px;
     position: sticky;
     display: block;
-    overflow: scroll; }
+    overflow: auto; }
   .Nxd-api__code {
     background: #e7ebee;
     border-bottom: 1px solid #f8fafc;

data/lib/nexmo/oas/renderer/version.rb

@@ -1,7 +1,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = "0.7.1"
+      VERSION = "0.8.0"
     end
   end
 end

data/lib/nexmo/oas/renderer/views/open_api/_model.erb

@@ -2,7 +2,7 @@
   <div class="Vlt-col Vlt-col--2of3 Nxd-api__docs">
     <div>
       <h2 id="<%= group['name'].parameterize %>" class='Vlt-grey-dark'><%= group['name'] %></h2>
-      <p class: "Vlt-grey-darker"><%= group['description'] %></p>
+      <p class: "Vlt-grey-darker"><%= group['description']&.render_markdown %></p>
 
       <% if group['schema'] %>
         <% group['schema'].each do |format, schema| %>

data/lib/nexmo/oas/renderer/views/open_api/_parameter_groups.erb

@@ -49,41 +49,11 @@
 
     <%
       # This can likely be better done as a presenter, but it works for now
-      panels = []
-      endpoint.request_body.split_properties_for_format(format).each_with_index do |parameters, index|
-        description = 'Request body'
-        c = parameters[0].schema
-        description = c['description'] if c['description']
-        if c['allOf']
-          c['allOf'].each_with_index do |current, index|
-            description = c[index]['description'] if c[index]['description']
-          end
-        end
-
-        panels.push({
-          'description' => description,
-          'parameters' => parameters,
-          'x-tab-id' => c['x-tab-id'],
-          'active' => index == 0
-        })
-      end
-    %>
+      schema = endpoint.request_body.content[format]['schema']['oneOf']
+      %>
+      <%= erb :'open_api/_tabbed_parameters', locals: { body: endpoint.request_body, schema: schema, format: format, callback: callback } %>
+    <%
+    end
+  end
+%>
 
-    <div class="Vlt-tabs js-format" data-format="<%= format %>">
-      <div class="Vlt-tabs__header" role="tablist" aria-label="Responses">
-        <% panels.each do |panel| %>
-        <div data-tab-link="<%= panel['x-tab-id'] %>" class="Vlt-tabs__link <%= panel['active'] ? 'Vlt-tabs__link_active' : '' %>">
-          <%= panel['description'] %>
-        </div>
-        <% end %>
-      </div>
-      <div class="Vlt-tabs__content">
-        <% panels.each do |panel| %>
-          <div class="Vlt-tabs__panel <%= panel['active'] ? 'Vlt-tabs__panel_active' : '' %>">
-            <%= erb :'open_api/_parameters', locals: { parameters: panel['parameters'], callback: callback } %>
-          </div>
-        <% end %>
-      </div>
-    </div>
-  <% end %>
-<% end %>

data/lib/nexmo/oas/renderer/views/open_api/_tabbed_parameters.erb

@@ -0,0 +1,53 @@
+<%
+  # Handle any cases where the top level of the oneOf is an allOf
+  schemas = schema.map { |s| body.handle_all_of(s) }
+
+  panels = []
+
+  schemas.each_with_index do |schema, index|
+    if schema['properties']
+      schema['properties'] = schema['properties'].map do |name, definition|
+        OasParser::Property.new(self, schema, name, definition)
+      end
+      .sort_by do |prop|
+        prop.required ? -1 : 1
+      end
+    end
+
+    panels.push({
+      'description' => schema['title'] || schema['description'],
+      'parameters' => schema['properties'],
+      'oneOf' => schema['oneOf'],
+      'x-tab-id' => schema['x-tab-id'],
+      'active' => index == 0
+    })
+  end
+%>
+
+<div class="Vlt-tabs js-format" data-format="<%= format %>">
+  <div class="Vlt-tabs__header" role="tablist" aria-label="Responses">
+    <% panels.each do |panel| %>
+      <div data-tab-link="<%= panel['x-tab-id'] %>" class="Vlt-tabs__link <%= panel['active'] ? 'Vlt-tabs__link_active' : '' %>">
+        <%= panel['description'] %>
+      </div>
+    <% end %>
+  </div>
+  <div class="Vlt-tabs__content">
+    <% panels.each do |panel| %>
+      <div class="Vlt-tabs__panel <%= panel['active'] ? 'Vlt-tabs__panel_active' : '' %>">
+      <%
+        # Nested oneOf?
+        if panel['oneOf']
+          %>
+          <%= erb :'open_api/_tabbed_parameters', locals: { body: body, schema: panel['oneOf'], format: format, callback: callback } %>
+        <%
+        else
+        %>
+
+        <%= erb :'open_api/_parameters', locals: { parameters: panel['parameters'], callback: callback } %>
+      <% end %>
+      </div>
+    <% end %>
+  </div>
+</div>
+

data/nexmo-oas-renderer.gemspec

@@ -43,6 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'sass', '~> 3.1'
   spec.add_runtime_dependency 'activemodel', '~> 6.0'
   spec.add_runtime_dependency "dotenv", "~> 2.7"
+  spec.add_runtime_dependency 'nexmo_markdown_renderer', '>= 0.0.3'
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo-oas-renderer
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: nexmo_markdown_renderer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -250,48 +264,10 @@ files:
 - lib/nexmo/oas/renderer/config/code_languages.yml
 - lib/nexmo/oas/renderer/config/dynamic_content.yml
 - lib/nexmo/oas/renderer/decorators/response_parser_decorator.rb
-- lib/nexmo/oas/renderer/filters/anchor.rb
-- lib/nexmo/oas/renderer/filters/audio.rb
-- lib/nexmo/oas/renderer/filters/block_escape.rb
-- lib/nexmo/oas/renderer/filters/break.rb
-- lib/nexmo/oas/renderer/filters/code.rb
-- lib/nexmo/oas/renderer/filters/code_snippet.rb
-- lib/nexmo/oas/renderer/filters/code_snippet_list.rb
-- lib/nexmo/oas/renderer/filters/code_snippets.rb
-- lib/nexmo/oas/renderer/filters/collapsible.rb
-- lib/nexmo/oas/renderer/filters/columns.rb
-- lib/nexmo/oas/renderer/filters/concept_list.rb
-- lib/nexmo/oas/renderer/filters/dynamic_content.rb
-- lib/nexmo/oas/renderer/filters/external_link.rb
-- lib/nexmo/oas/renderer/filters/frontmatter.rb
-- lib/nexmo/oas/renderer/filters/heading.rb
-- lib/nexmo/oas/renderer/filters/icon.rb
-- lib/nexmo/oas/renderer/filters/indent.rb
-- lib/nexmo/oas/renderer/filters/inline_escape.rb
-- lib/nexmo/oas/renderer/filters/js_sequence_diagram.rb
-- lib/nexmo/oas/renderer/filters/label.rb
-- lib/nexmo/oas/renderer/filters/language.rb
-- lib/nexmo/oas/renderer/filters/markdown.rb
-- lib/nexmo/oas/renderer/filters/modal.rb
-- lib/nexmo/oas/renderer/filters/partial.rb
-- lib/nexmo/oas/renderer/filters/php_inliner.rb
-- lib/nexmo/oas/renderer/filters/screenshot.rb
-- lib/nexmo/oas/renderer/filters/tab.rb
-- lib/nexmo/oas/renderer/filters/techio.rb
-- lib/nexmo/oas/renderer/filters/tooltip.rb
-- lib/nexmo/oas/renderer/filters/tutorial_link.rb
-- lib/nexmo/oas/renderer/filters/tutorials.rb
-- lib/nexmo/oas/renderer/filters/unfreeze.rb
-- lib/nexmo/oas/renderer/filters/user_personalization.rb
 - lib/nexmo/oas/renderer/helpers/navigation.rb
 - lib/nexmo/oas/renderer/helpers/render.rb
 - lib/nexmo/oas/renderer/helpers/summary.rb
 - lib/nexmo/oas/renderer/helpers/url.rb
-- lib/nexmo/oas/renderer/lib/core_ext/string.rb
-- lib/nexmo/oas/renderer/lib/redcarpet.rb
-- lib/nexmo/oas/renderer/models/code_snippet.rb
-- lib/nexmo/oas/renderer/models/tutorial.rb
-- lib/nexmo/oas/renderer/pipelines/markdown_pipeline.rb
 - lib/nexmo/oas/renderer/presenters/api_specification.rb
 - lib/nexmo/oas/renderer/presenters/endpoint.rb
 - lib/nexmo/oas/renderer/presenters/groups.rb
@@ -344,20 +320,11 @@ files:
 - lib/nexmo/oas/renderer/public/assets/stylesheets/volta.min.css
 - lib/nexmo/oas/renderer/public/assets/symbol/volta-icons.svg
 - lib/nexmo/oas/renderer/public/favicon.ico
-- lib/nexmo/oas/renderer/services/code_language_api.rb
 - lib/nexmo/oas/renderer/services/oas_parser.rb
 - lib/nexmo/oas/renderer/services/open_api_definition_resolver.rb
 - lib/nexmo/oas/renderer/version.rb
 - lib/nexmo/oas/renderer/views/api/index.erb
 - lib/nexmo/oas/renderer/views/api/show.erb
-- lib/nexmo/oas/renderer/views/code_snippets/_application_messages_dispatch.html.erb
-- lib/nexmo/oas/renderer/views/code_snippets/_application_rtc.html.erb
-- lib/nexmo/oas/renderer/views/code_snippets/_application_voice.html.erb
-- lib/nexmo/oas/renderer/views/code_snippets/_code_only.html.erb
-- lib/nexmo/oas/renderer/views/code_snippets/_configure_client.html.erb
-- lib/nexmo/oas/renderer/views/code_snippets/_dependencies.html.erb
-- lib/nexmo/oas/renderer/views/code_snippets/_write_code.html.erb
-- lib/nexmo/oas/renderer/views/code_snippets/list/plain.html.erb
 - lib/nexmo/oas/renderer/views/concepts/list/plain.html.erb
 - lib/nexmo/oas/renderer/views/layouts/_head.erb
 - lib/nexmo/oas/renderer/views/layouts/_javascripts.erb
@@ -375,12 +342,9 @@ files:
 - lib/nexmo/oas/renderer/views/open_api/_response_descriptions.erb
 - lib/nexmo/oas/renderer/views/open_api/_response_fields.erb
 - lib/nexmo/oas/renderer/views/open_api/_response_tabs.erb
+- lib/nexmo/oas/renderer/views/open_api/_tabbed_parameters.erb
 - lib/nexmo/oas/renderer/views/open_api/show.erb
 - lib/nexmo/oas/renderer/views/static/404.erb
-- lib/nexmo/oas/renderer/views/tutorials/_index.html.erb
-- lib/nexmo/oas/renderer/views/tutorials/index.html.erb
-- lib/nexmo/oas/renderer/views/tutorials/list/plain.html.erb
-- lib/nexmo/oas/renderer/views/tutorials/show.html.erb
 - nexmo-oas-renderer.gemspec
 homepage: https://github.com/Nexmo/nexmo-oas-renderer
 licenses:

data/lib/nexmo/oas/renderer/filters/anchor.rb

@@ -1,17 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Anchor < Banzai::Filter
-          def call(input)
-            input.gsub(/^[\u{2693}](.+?)\n/) do
-              <<~HEREDOC
-                <a name="#{$1.parameterize}"></a>
-              HEREDOC
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/audio.rb

@@ -1,21 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Audio < Banzai::Filter
-          def call(input)
-            input.gsub(/[u{🔈}]\[(.+?)\]/) do
-              audio = <<~HEREDOC
-                <audio controls>
-                  <source src="#{$1}" type="audio/mpeg">
-                </audio>
-              HEREDOC
-
-              "FREEZESTART#{Base64.urlsafe_encode64(audio)}FREEZEEND"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/block_escape.rb

@@ -1,24 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class BlockEscape < Banzai::Filter
-          def call(input)
-            # Freeze to prevent Markdown formatting
-            input.gsub(/````\n(.+?)````/m) do |_s|
-              lexer = Rouge::Lexer.find('text')
-              formatter = Rouge::Formatters::HTML.new
-              highlighted_source = formatter.format(lexer.lex($1))
-
-              output = <<~HEREDOC
-                <pre class="highlight #{lexer.tag}"><code>#{highlighted_source}</code></pre>
-              HEREDOC
-
-              "FREEZESTART#{Base64.urlsafe_encode64(output)}FREEZEEND"
-            end
-          end
-        end
-      end
-    end
-  end
-end