nexmo-oas-renderer 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76599ec305ebd6c8c31bb6ef59866f9ee4973dbb58e5214517e74c522357398e
-  data.tar.gz: f0b864fa9c8751ddf292728f492d0f0b920b751fa2898ab6c5b6a3694b192bb8
+  metadata.gz: 370c5844bff4cc86ca8a558fe2d1f0dcc54103440325e836c3b9fb1043ab7c92
+  data.tar.gz: e62da1e342e6a00571750c398ec673e6ffb01252afa50c360e0a4cc3ea568ff2
 SHA512:
-  metadata.gz: d97b6959b622e3c407d385af7e54af0690a34ae6ef6720dee5e75c3db05850c3b3a37b1d60f6e1826c10d76584bcd56dfddde8a3d0055aba9fae9c529f6275a6
-  data.tar.gz: a30ee39bf768f4c3d04adbe43bc5127db3d9af982bd90cf457481868c8154bef574219ab7a0e04525ae76990212f80b1a76301863ebe4e03d0d885ff180b65fc
+  metadata.gz: 4332086bfd477d6d137e16943b014487788f24a78125ce7f23e0b05f9e81debc09709415c7e734050e41c4e43b1a354a8292dcff8e89213c19ea868c0a5510ff
+  data.tar.gz: f6f1dd5a4545f2be0fa1381596577514a530c3623a070f9b69a48e17ef7ae209b6058ad0b66f1fc5cafca526a438ce5b4be8172cfb5542411ccb5797ad4bc7bb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (2.4.0)
+    nexmo-oas-renderer (2.5.0)
       activemodel (~> 6.0)
       activesupport (~> 6.0)
       banzai (~> 0.1.2)
@@ -10,7 +10,7 @@ PATH
       nexmo_markdown_renderer (~> 0.3)
       oas_parser (~> 0.25.1)
       octicons_helper (~> 8.2)
-      redcarpet (= 3.4.0)
+      redcarpet (= 3.5.1)
       sass (~> 3.1)
       shotgun (~> 0.9)
       sinatra (~> 2.0)
@@ -84,7 +84,7 @@ GEM
     diff-lcs (1.4.2)
     dotenv (2.7.6)
     erubi (1.9.0)
-    ffi (1.13.1)
+    ffi (1.14.2)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     hansi (0.2.0)
@@ -101,7 +101,7 @@ GEM
     method_source (1.0.0)
     mimemagic (0.3.5)
     mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
+    mini_portile2 (2.5.0)
     minitest (5.14.2)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
@@ -109,7 +109,7 @@ GEM
       hansi (~> 0.2.0)
       mustermann (= 1.1.1)
     neatjson (0.9)
-    nexmo_markdown_renderer (0.5.0)
+    nexmo_markdown_renderer (0.7.5)
       activemodel (~> 6.0)
       banzai (~> 0.1.2)
       i18n (~> 1.7)
@@ -118,8 +118,9 @@ GEM
       redcarpet (~> 3.4)
       rouge (~> 2.0.7)
     nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     oas_parser (0.25.1)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
@@ -137,6 +138,7 @@ GEM
     parser (2.7.1.4)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
+    racc (1.5.2)
     rack (2.2.3)
     rack-protection (2.1.0)
       rack
@@ -173,7 +175,7 @@ GEM
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    redcarpet (3.4.0)
+    redcarpet (3.5.1)
     regexp_parser (1.7.1)
     rexml (3.2.4)
     rouge (2.0.7)

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

@@ -5,7 +5,9 @@ module Nexmo
     module Renderer
       module Presenters
         class ContentSwitcher
-          def initialize(format:, label:, theme_light:, force_type: nil)
+          attr_reader :panels
+
+          def initialize(format:, label: nil, theme_light:, force_type: nil)
             @format = format
             @panels = []
             @label = label

data/lib/nexmo/oas/renderer/presenters/response_tab/panel.rb

@@ -24,6 +24,10 @@ module Nexmo
             end
 
             def content
+              if @content.is_a?(Nexmo::OAS::Renderer::Presenters::ContentSwitcher)
+                return @content.render
+              end
+
               if @content == :responses
                 Nexmo::OAS::Renderer::ResponseParserDecorator
                   .new(@schema)

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

@@ -32,17 +32,50 @@ module Nexmo
           def tab_panels
             @tab_panels ||= @response.split_schemas(@format).map.with_index do |schema, index|
               schema = handle_all_of(schema)
+              examples = examples_for_schema(schema)
               ResponseTab::Panel.new(
                 schema: schema,
                 index: index,
                 format: @format,
-                content: @content,
+                content: examples || @content,
                 endpoint: @endpoint,
                 theme_light: @theme_light
               )
             end
           end
 
+          def examples_for_schema(schema)
+            # If there are any examples, show them
+            examples = @response.raw.dig('content', @format, 'examples')
+            return nil unless @content == :responses && @format == 'application/json' && examples
+
+            example_switcher = Nexmo::OAS::Renderer::Presenters::ContentSwitcher.new(format: format, force_type: 'dropdown', theme_light: @theme_light)
+
+            has_visible_panel = false
+            examples.each_with_index do |v, _k|
+              # Only if the example key is listed in x-examples in the schema
+              next unless schema['x-examples']&.include?(v[0])
+
+              response = JSON.neat_generate(v[1], {
+                  wrap: true,
+                  after_colon: 1,
+              })
+
+              content = <<~HEREDOC
+                <pre class="pre-wrap language-json #{@theme_light ? 'Vlt-prism--dark' : ''} Vlt-prism--copy-disabled"><code>#{response}</code></pre>
+              HEREDOC
+
+              example_switcher.add_content(
+                title: v[0].titleize,
+                content: content,
+                tab_id: v[0],
+                active: !has_visible_panel
+              )
+              has_visible_panel = true
+            end
+            return example_switcher if example_switcher.panels.size.positive?
+          end
+
           def handle_all_of(schema)
             if schema['allOf']
               schema['allOf'].each do |p|

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

@@ -3,7 +3,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = '2.4.1'
+      VERSION = '2.5.0'
     end
   end
 end

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

@@ -1,6 +1,6 @@
 <div class="Vlt-grid">
   <div class="Vlt-col oas-left-panel header-row" style="padding-top:20px;">
-    <a href="<%= @theme_link %>" class="Vlt-switch Vlt-switch--secondary" style="float:right;">
+    <a href="<%= @theme_link %>" class="Vlt-switch Vlt-switch--secondary" style="float:right;" title="colour theme switcher">
         <span class="Vlt-switch__slider"></span>
     </a>
 

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

@@ -4,12 +4,12 @@
   switcher = Nexmo::OAS::Renderer::Presenters::ContentSwitcher.new(label: "Response Example", format: format, force_type: tabs.switcher, theme_light: @theme_light)
 
   tabs.tab_links.each_with_index do |v,k|
-     switcher.add_content(
-       title: v.content,
-       content: (erb *tabs.tab_panels[k].content),
-       tab_id: v.data_tab_link,
-       active: k == 0
-     )
+    switcher.add_content(
+      title: v.content,
+      content: (erb *tabs.tab_panels[k].content),
+      tab_id: v.data_tab_link,
+      active: k == 0
+    )
   end
 %>
 

data/lib/nexmo/oas/renderer/views/open_api/content_switcher/_dropdown.erb

@@ -1,5 +1,7 @@
 <div class="Vlt-dropdown Vlt-dropdown--full-width">
-  <div class="Vlt-dropdown__trigger Vlt-dropdown__trigger--btn"><button class="Vlt-btn Vlt-btn--<%= (theme_light ? "secondary" : "tertiary") %>"><%= label %>: <span class="Vlt-dropdown__selection"><%= panels[0]['title'] %></span></button></div>
+  <div class="Vlt-dropdown__trigger Vlt-dropdown__trigger--btn"><button class="Vlt-btn Vlt-btn--<%= (theme_light ? "secondary" : "tertiary") %>">
+    <%= label ? "#{label}: " : ""%><span class="Vlt-dropdown__selection"><%= panels[0]['title'] %></span>
+  </button></div>
   <div class="Vlt-dropdown__panel">
     <div data-tab-content="<%= switcher.id %>" class="Vlt-dropdown__panel__content">
       <% panels.each do |panel| %>

data/nexmo-oas-renderer.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'nexmo_markdown_renderer', '~> 0.3'
   spec.add_runtime_dependency 'oas_parser', '~> 0.25.1'
   spec.add_runtime_dependency 'octicons_helper', '~> 8.2'
-  spec.add_runtime_dependency 'redcarpet', '3.4.0'
+  spec.add_runtime_dependency 'redcarpet', '3.5.1'
   spec.add_runtime_dependency 'sass', '~> 3.1'
   spec.add_runtime_dependency 'shotgun', '~> 0.9'
   spec.add_runtime_dependency 'sinatra', '~> 2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo-oas-renderer
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Fabian Rodriguez
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +234,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.86'
-description: 
+description:
 email:
 - fabian.rodriguez@vonage.com
 executables:
@@ -382,7 +382,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Nexmo/nexmo-oas-renderer
   source_code_uri: https://github.com/Nexmo/nexmo-oas-renderer
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -397,8 +397,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: OpenAPI Specification renderer.
 test_files: []