nexmo-oas-renderer 2.2.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a463231ba72ba74bc9a6555449eb2d2cba6155c32a2506235b04b8bf332678b
-  data.tar.gz: 9c8ed923712ff7e677c6f36b532e77fb41ef6120057d52635f7b1a892102aacc
+  metadata.gz: 329535118b6e5e736d931e461902f10a14a96379a68898eb767f028e3144cd60
+  data.tar.gz: ad0abd7f6ca82cd40851972514e2891facc7c3d71a037b3b3a600c90076a2731
 SHA512:
-  metadata.gz: b3e4c30d89a5cc22fd66491751235b49d4b56a5a63ce8e9a3d303e8c4989f5e3a47cc8964c5d78b6cc4f1d33467e1ca83065a00e399fcfc076607a81633b7c3e
-  data.tar.gz: df6590d1e2de8eb3771dcec2c0cf3617a7453e81e83a34318989d2f42d0513032dfd5c4a35ea3f991a8d1785f6871f6b800e5fb79a863f4c8890ebff89cd2754
+  metadata.gz: 5957e08812155be2c049151b14bfe784987ec5738569dcedd30d5464f9f597176e5afeb80dd545421fa684790e941accd4dff8f5bc23993074102351129d435c
+  data.tar.gz: a42ed3a17078f74e6b6d5ebe97b161f14c05e25d95758bb6d81c55686d1e2a8dc18dfd8133c8bd5ca27cc777eb571de6ada3923316b1eff2161b5741f273a40c

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec
+    - name: Run rubocop
+      run: bundle exec rubocop

data/.github/workflows/pull_request-review.yml

@@ -0,0 +1,14 @@
+name: Review App
+on:
+  pull_request_target:
+    types: [opened, reopened, synchronize, labeled, closed]
+jobs:
+  create-review-app:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create Review App
+        uses: mheap/github-action-pr-heroku-review-app@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          HEROKU_PIPELINE_ID: ${{ secrets.HEROKU_PIPELINE_ID }}
+          HEROKU_API_TOKEN: ${{ secrets.HEROKU_API_TOKEN }}

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.6
+FROM ruby:2.7.2
 COPY . /
 RUN gem install bundler
 RUN bundle install

data/Gemfile.lock

@@ -1,16 +1,15 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (2.2.0)
+    nexmo-oas-renderer (2.6.0)
       activemodel (~> 6.0)
       activesupport (~> 6.0)
       banzai (~> 0.1.2)
       dotenv (~> 2.7)
       neatjson (~> 0.8)
-      nexmo_markdown_renderer (~> 0.3)
+      nexmo_markdown_renderer (~> 0.8)
       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)
@@ -18,56 +17,56 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.2)
-      actionpack (= 6.0.3.2)
+    actioncable (6.0.3.4)
+      actionpack (= 6.0.3.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activejob (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      activestorage (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionmailbox (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      actionview (= 6.0.3.2)
-      activejob (= 6.0.3.2)
+    actionmailer (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.2)
-      actionview (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      activestorage (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actiontext (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    activejob (6.0.3.4)
+      activesupport (= 6.0.3.4)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activestorage (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activejob (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activestorage (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
       marcel (~> 0.3.1)
-    activesupport (6.0.3.2)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -78,20 +77,20 @@ GEM
     ast (2.4.1)
     banzai (0.1.3)
     builder (3.2.4)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     crass (1.0.6)
     deep_merge (1.2.1)
     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)
     hash-deep-merge (0.1.1)
-    i18n (1.8.3)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -101,25 +100,26 @@ GEM
     method_source (1.0.0)
     mimemagic (0.3.5)
     mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    mini_portile2 (2.5.0)
+    minitest (5.14.2)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-contrib (1.1.1)
       hansi (~> 0.2.0)
       mustermann (= 1.1.1)
     neatjson (0.9)
-    nexmo_markdown_renderer (0.4.1)
+    nexmo_markdown_renderer (0.8.0)
+      actionview (~> 6.0)
       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.9)
-      mini_portile2 (~> 2.4.0)
+    nio4r (2.5.4)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     oas_parser (0.25.1)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
@@ -128,43 +128,39 @@ GEM
       hash-deep-merge
       mustermann-contrib (~> 1.1.1)
       nokogiri
-    octicons (8.5.0)
-      nokogiri (>= 1.6.3.1)
-    octicons_helper (8.5.0)
-      octicons (= 8.5.0)
-      rails
     parallel (1.19.2)
     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
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.2)
-      actioncable (= 6.0.3.2)
-      actionmailbox (= 6.0.3.2)
-      actionmailer (= 6.0.3.2)
-      actionpack (= 6.0.3.2)
-      actiontext (= 6.0.3.2)
-      actionview (= 6.0.3.2)
-      activejob (= 6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      activestorage (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    rails (6.0.3.4)
+      actioncable (= 6.0.3.4)
+      actionmailbox (= 6.0.3.4)
+      actionmailer (= 6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actiontext (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       bundler (>= 1.3.0)
-      railties (= 6.0.3.2)
+      railties (= 6.0.3.4)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
@@ -173,7 +169,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)
@@ -218,7 +214,7 @@ GEM
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
@@ -228,10 +224,10 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    websocket-driver (0.7.2)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.3.1)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby

data/Procfile

@@ -0,0 +1 @@
+web: bundle exec ./exe/nexmo-oas-renderer

data/README.md

@@ -1,4 +1,8 @@
 # Nexmo OAS Renderer
+
+![Build Status](https://github.com/Nexmo/nexmo-oas-renderer/workflows/CI/badge.svg)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
+
 Sinatra application that provides a preview of how the OAS documents will be rendered within [Nexmo Developer](https://developer.nexmo.com/).
 
 * [Dependencies](#requirements)

data/app.json

@@ -0,0 +1,15 @@
+{
+  "buildpacks": [{ "url": "heroku/ruby" }],
+  "env": {
+    "RACK_ENV": "production",
+    "RAILS_ENV": "production",
+    "OAS_PATH": "samples"
+  },
+  "stack": "heroku-18",
+  "formation": {
+    "web": {
+      "quantity": 1,
+      "size": "free"
+    }
+  }
+}

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

@@ -13,6 +13,7 @@ require_relative './presenters/open_api_specification'
 require_relative './presenters/navigation'
 require_relative './presenters/request_body_raw'
 require_relative './presenters/response_tabs'
+require_relative './presenters/content_switcher'
 require_relative './helpers/render'
 require_relative './helpers/navigation'
 require_relative './helpers/summary'

data/lib/nexmo/oas/renderer/helpers/render.rb

@@ -15,7 +15,7 @@ module Nexmo
             if args.length > 2
               super
             else
-              ApplicationController.renderer.render(*args)
+              ApplicationController.renderer.new(request.env).render(*args)
             end
           end
         end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Nexmo
+  module OAS
+    module Renderer
+      module Presenters
+        class ContentSwitcher
+          attr_reader :panels
+
+          def initialize(format:, label: nil, theme_light:, force_type: nil)
+            @format = format
+            @panels = []
+            @label = label
+            @force_type = force_type
+            @theme_light = theme_light
+          end
+
+          def add_content(title:, content:, tab_id:, active:)
+            @panels.push({
+                             'title' => title,
+                             'content' => content,
+                             'x-tab-id' => tab_id,
+                             'active' => active,
+                         })
+          end
+
+          def render
+            type = 'tabs'
+            type = 'dropdown' if @panels.length >= 8
+
+            type = @force_type if @force_type
+
+            [:"open_api/content_switcher/_#{type}", locals: {
+                panels: @panels,
+                format: @format,
+                label: @label,
+                switcher: self,
+                theme_light: @theme_light,
+            }]
+          end
+
+          def id
+            @id ||= "s-#{SecureRandom.hex}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module Nexmo
     module Renderer
       module Presenters
         class ResponseTabs
-          attr_reader :format
+          attr_reader :format, :switcher
 
           def initialize(format, response, content, endpoint, theme_light: nil)
             @format   = format
@@ -16,6 +16,7 @@ module Nexmo
             @content  = content
             @endpoint = endpoint
             @theme_light = theme_light
+            @switcher ||= @response.schema(@format)['x-switcher']
           end
 
           def tab_links
@@ -31,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/public/assets/javascripts/nexmo-oas-renderer.js

@@ -20,6 +20,14 @@ document.addEventListener("DOMContentLoaded", function() {
       var matchingTabs = document.querySelectorAll('[data-tab-link="' + link + '"]');
       Array.from(matchingTabs).forEach(function (element) {
         element.dispatchEvent(new Event('toggle'));
+
+        // Switch anything that's in a dropdown
+        if (element.parentNode.className.indexOf("Vlt-dropdown__panel__content") !== -1) {
+          // This is *very* structure dependent, but also the most compatible way to handle it
+          var panel = element.parentNode.parentNode;
+          var titleNodes = Array.from(panel.previousSibling.previousSibling.firstChild.childNodes);
+          titleNodes[1].textContent = element.textContent;
+        }
       });
     });
   });

data/lib/nexmo/oas/renderer/public/assets/javascripts/volta.dropdown.js

@@ -0,0 +1,145 @@
+/**
+ * Copyright (c) 2001-present, Vonage.
+ *
+ * Dropdowns (requires core)
+ */
+
+'use strict';
+
+Volta.dropdown = function () {
+	var _class = {
+		wrapper: 'Vlt-dropdown',
+		block: 'Vlt-dropdown__block',
+		btn: 'Vlt-dropdown__trigger',
+		btnLegacy: 'Vlt-dropdown__btn',
+		dismissed: 'Vlt-callout--dismissed',
+		expanded: 'Vlt-dropdown--expanded',
+		label: 'Vlt-dropdown__label',
+		link: 'Vlt-dropdown__link',
+		noCloseLink: 'Vlt-dropdown__link--noclose',
+		noCloseBlock: 'Vlt-dropdown__block--noclose',
+		panel: 'Vlt-dropdown__panel',
+		panelContent: 'Vlt-dropdown__panel__content',
+		selection: 'Vlt-dropdown__selection',
+		switch: 'Vlt-switch',
+		switchSlider: 'Vlt-switch__slider'
+	}
+
+	function Dropdown() {}
+
+	Dropdown.prototype = {
+		init: function(element, supressClickHandler) {
+			this.dropdown = element;
+			this.selection = this.dropdown.querySelector('.' + _class.selection);
+			this.isSelectionVisible = !!this.selection;
+			this.btn = this.dropdown.querySelector('.' + _class.btn) || this.dropdown.querySelector('.' + _class.btnLegacy);
+			this._suppress = supressClickHandler;
+
+			if(!this._suppress) {
+				this._addEventListener();
+			}
+		},
+		_addEventListener: function(){
+			var openHandler = this.open.bind(this);
+			this.dropdown.addEventListener('click', openHandler, { once: true })
+		},
+		close: function(text) {
+			if(text) {
+				this._setDropdownSelectionText(text);
+			}
+			this.dropdown.classList.remove(_class.expanded);
+
+			if(!this._suppress){
+				this._addEventListener();
+			}
+
+		},
+		_closeEventHandler: undefined,
+		_closeEvent: function(e) {
+			var targetIsPanel = Volta._hasClass(e.target, _class.panel);
+			var parentIsPanel = Volta._closest(e.target, '.' + _class.panelContent, _class.panel) !== null;
+			var parentLink = Volta._closest(e.target, '.' + _class.link, _class.wrapper);
+			var parentIsLink = parentLink && parentLink.length === 1;
+			var isSwitchSlider = Volta._hasClass(e.target, _class.switchSlider);
+			var isParentSwitch = Volta._closest(e.target,'.' + _class.switch, _class.link);
+			var isNoClose = Volta._hasClass(e.target, _class.noCloseLink) || Volta._hasClass(e.target, _class.noCloseBlock);
+			var isNoCloseParent = Volta._closest(e.target,'.' + _class.noCloseLink, _class.link) || Volta._closest(e.target,'.' + _class.noCloseBlock, _class.noCloseBlock);
+			var isInput = e.target instanceof HTMLInputElement;
+
+			if(!targetIsPanel && !parentIsPanel && !parentIsLink && !isNoClose && !isInput && !isNoCloseParent) {
+				e.preventDefault();
+				e.stopPropagation();
+			}
+
+			if(isSwitchSlider || isParentSwitch || isNoClose || isInput || isNoCloseParent) {
+				return null;
+			}
+
+			var text;
+			if(parentIsPanel && Volta._hasClass(e.target, _class.label)) {
+				text = e.target.innerHTML;
+			} else if (parentIsPanel) {
+				var label = e.target.querySelector('.' + _class.label);
+				if(label) {
+					text = label.innerHTML;
+				}
+			}
+
+			this.close(text);
+
+			document.querySelector('body').removeEventListener('click', this._closeEventHandler );
+		},
+		open: function(event) {
+			if(event) {
+				event.preventDefault();
+				event.stopPropagation();
+			}
+
+			this.dropdown.classList.add(_class.expanded);
+
+			if(!this._suppress){
+				this._closeEventHandler = this._closeEvent.bind(this);
+				document.querySelector('body').addEventListener('click', this._closeEventHandler );
+			}
+		},
+		_setDropdownSelectionText: function(text) {
+			if(this.isSelectionVisible) {
+				this.selection.innerText = text;
+			} else {
+				this.btn.innerText = text;
+				this.btn.value = text;
+			}
+		},
+		_suppress: false
+	}
+
+	return {
+		create: create,
+		init: attachDropdownHandlers
+	}
+
+	/**
+	 *	@public
+	 *
+	 *	@description Attach a listeners to dropdowns
+	 */
+	function attachDropdownHandlers() {
+		document.querySelectorAll('.' + _class.wrapper).forEach(attachHandler);
+
+		function attachHandler(dropdown) {
+			create(dropdown);
+		}
+	}
+
+	/**
+	 *	@private
+	 *
+	 *	@description Create a dropdown element
+	 *  @param {HTMLElement} element
+ 	 */
+	function create(element){
+		var dropdown = Object.create(Dropdown.prototype, {})
+		dropdown.init(element);
+		return dropdown;
+	}
+}();

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

@@ -53,6 +53,7 @@
   .oas-wrapper .oas-parameter-description {
     margin-left: 16px; }
   .oas-wrapper .oas-parameter-meta {
+    padding-bottom: 2px;
     border-bottom: 1px solid #ccc;
     margin-bottom: 4px; }
   .oas-wrapper .oas-parameter-nested {

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

@@ -3,7 +3,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = '2.2.0'
+      VERSION = '2.6.0'
     end
   end
 end

data/lib/nexmo/oas/renderer/views/layouts/_javascripts.erb

@@ -5,10 +5,11 @@
 <script src="/assets/javascripts/volta.accordion.js"></script>
 <script src="/assets/javascripts/volta.tabs.js"></script>
 <script src="/assets/javascripts/volta.modal.js"></script>
+<script src="/assets/javascripts/volta.dropdown.js"></script>
 <script src="/assets/javascripts/volta.tooltip.js"></script>
 <script src="/assets/javascripts/nexmo-oas-renderer.js?a=1"></script>
 <script src="/assets/javascripts/components/format.js"></script>
 <script type="text/javascript">
-  Volta.init(["accordion", "tab", "modal", "tooltip"]);
+  Volta.init(["accordion", "tab", "modal", "tooltip", "dropdown"]);
   new Format
 </script>

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>
 
@@ -39,6 +39,20 @@
       </div>
     </div>
 
+
+    <% if @specification.groups.size > 1 %>
+      <h4>Jump to:</h4>
+      <div style="margin-bottom: 30px; padding: 8px;">
+      <% @specification.groups.each do |name, endpoints| %>
+        <% if name %>
+          <% group = definition.raw['tags'].detect { |tag| tag['name'].capitalize == name.capitalize } %>
+          <p><a href="#<%= group['name'].parameterize %>"><%= group['name'] %> &raquo;</a></p>
+          <p class="Vlt-grey-darker"><%= group['description']&.render_markdown %></p>
+        <% end %>
+      <% end %>
+      </div>
+    <% end %>
+
     <%
       # If there's only one group, everything is untagged
       if @specification.groups.size === 1

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

@@ -39,9 +39,10 @@
 
     <%
       # This can likely be better done as a presenter, but it works for now
-      schema = endpoint.request_body.content[format]['schema']['oneOf']
+      request = endpoint.request_body.content[format]['schema']
+      schema = request['oneOf']
       %>
-      <%= erb :'open_api/_tabbed_parameters', locals: { body: endpoint.request_body, schema: schema, format: format, callback: callback } %>
+      <%= erb :'open_api/_tabbed_parameters', locals: { body: endpoint.request_body, request: request, schema: schema, format: format, callback: callback } %>
     <%
     end
   end

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

@@ -58,13 +58,21 @@
         <% if parameter.required %>
           <span class="constraint">Required</span>
         <% end %>
-
         <% if parameter.minimum || parameter.raw['minLength'] %>
           | <span class="constraint">Min:</span> <%= parameter.minimum || parameter.raw['minLength'] %>
         <% end %>
         <% if parameter.maximum || parameter.raw['maxLength'] %>
           | <span class="constraint">Max:</span> <%= parameter.maximum || parameter.raw['maxLength'] %>
         <% end %>
+        <% if parameter.default || parameter.raw['default'] %>
+          | <span class="constraint">Default:</span> <%= parameter.default || parameter.raw['default'] %>
+        <% end %>
+        <% if parameter.raw['deprecated'] %>             
+          | <span class="constraint">DEPRECATED</span> <span>: This field has been deprecated. </span>          
+        <% end %>
+        <% if parameter.raw['x-replace-with']%>            
+            <span> <%= 'Please use ' + '<code>'+ parameter.raw['x-replace-with'] + '</code>' + ' instead.' %> </span>
+        <% end %>
       </div>
 
       <%= (parameter.description || parameter.schema['description'] || '').render_markdown %>

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

@@ -1,18 +1,16 @@
-<% tabs = Nexmo::OAS::Renderer::Presenters::ResponseTabs.new(format, response, content, endpoint, theme_light: @theme_light) %>
+<%
+  tabs = Nexmo::OAS::Renderer::Presenters::ResponseTabs.new(format, response, content, endpoint, theme_light: @theme_light)
 
-<div class='Vlt-tabs js-format' data-format='<%= tabs.format %>'>
-  <div class='Vlt-tabs__header' role='tablist' aria-label='Responses'>
-    <% tabs.tab_links.each do |link| %>
-      <div role='tab' class='<%= link.css_classes %>' <% if link.data_tab_link %>data-tab-link="<%= link.data_tab_link %>"<% end %>>
-        <%= link.content %>
-      </div>
-    <% end %>
-  </div>
-  <div class='Vlt-tabs__content'>
-    <% tabs.tab_panels.each do |panel| %>
-      <div class='<%= panel.css_classes %>'>
-        <%= erb *panel.content %>
-      </div>
-    <% end %>
-  </div>
-</div>
+  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
+    )
+  end
+%>
+
+<%= erb *switcher.render %>

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

@@ -12,8 +12,7 @@
     s
   end
 
-
-  panels = []
+  switcher = Nexmo::OAS::Renderer::Presenters::ContentSwitcher.new(label: "Request Details", format: format, force_type: request['x-switcher'], theme_light: @theme_light)
 
   schemas.each_with_index do |schema, index|
     if schema['properties']
@@ -25,40 +24,21 @@
       end
     end
 
-    panels.push({
-      'description' => schema['title'] || schema['description'],
-      'parameters' => schema['properties'],
-      'oneOf' => schema['oneOf'],
-      'x-tab-id' => schema['x-tab-id'] || schema['title'].parameterize,
-      'active' => index == 0
-    })
+
+    if schema['oneOf']
+      content = (erb :'open_api/_tabbed_parameters', locals: { body: body, request: schema, schema: schema['oneOf'], format: format, callback: callback })
+    else
+      content = (erb :'open_api/_parameters', locals: { parameters: schema['properties'], callback: callback })
+    end
+
+    switcher.add_content(
+      title: schema['title'] || schema['description'],
+      content: content,
+      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 role="tab" 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>
+<%= erb *switcher.render %>
 

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

@@ -0,0 +1,24 @@
+<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 ? "#{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| %>
+        <div role="tab" data-tab-link="<%= panel['x-tab-id'] || panel['title'].parameterize %>" class="Vlt-dropdown__link Vlt-dropdown__label Vlt-js-tabs__link"><%= panel['title'] %></div>
+      <% end %>
+    </div>
+  </div>
+</div>
+
+
+<div class="js-format" data-format="<%= format %>">
+  <div id="<%= switcher.id %>" class="Vlt-js-tabs__content">
+    <% panels.each do |panel| %>
+      <div class="Vlt-js-tabs__panel <%= panel['active'] ? 'Vlt-js-tabs__panel_active' : '' %>">
+        <%= panel['content'] %>
+      </div>
+    <% end %>
+  </div>
+</div>
+

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

@@ -0,0 +1,18 @@
+<div class="Vlt-tabs js-format" data-format="<%= format %>">
+  <div class="Vlt-tabs__header" role="tablist" aria-label="<%= label %>">
+    <% panels.each do |panel| %>
+      <div role="tab" data-tab-link="<%= panel['x-tab-id'] || panel['title'].parameterize %>" class="Vlt-tabs__link <%= panel['active'] ? 'Vlt-tabs__link_active' : '' %>">
+        <%= panel['title'] %>
+      </div>
+    <% end %>
+  </div>
+  <div class="Vlt-tabs__content">
+    <% panels.each do |panel| %>
+      <div class="Vlt-tabs__panel <%= panel['active'] ? 'Vlt-tabs__panel_active' : '' %>">
+        <%= panel['content'] %>
+      </div>
+    <% end %>
+  </div>
+</div>
+
+

data/nexmo-oas-renderer.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|samples)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -36,10 +36,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'banzai', '~> 0.1.2'
   spec.add_runtime_dependency 'dotenv', '~> 2.7'
   spec.add_runtime_dependency 'neatjson', '~> 0.8'
-  spec.add_runtime_dependency 'nexmo_markdown_renderer', '~> 0.3'
+  spec.add_runtime_dependency 'nexmo_markdown_renderer', '~> 0.8'
   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.2.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: oas_parser
   requirement: !ruby/object:Gem::Requirement
@@ -108,34 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.25.1
-- !ruby/object:Gem::Dependency
-  name: octicons_helper
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     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
@@ -243,19 +229,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
+- ".github/workflows/ci.yml"
+- ".github/workflows/pull_request-review.yml"
 - ".github/workflows/push-docker-publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- Procfile
 - README.md
 - Rakefile
+- app.json
 - bin/console
 - bin/setup
 - exe/nexmo-oas-renderer
@@ -271,6 +260,7 @@ files:
 - lib/nexmo/oas/renderer/helpers/summary.rb
 - lib/nexmo/oas/renderer/helpers/url.rb
 - lib/nexmo/oas/renderer/presenters/api_specification.rb
+- lib/nexmo/oas/renderer/presenters/content_switcher.rb
 - lib/nexmo/oas/renderer/presenters/endpoint.rb
 - lib/nexmo/oas/renderer/presenters/groups.rb
 - lib/nexmo/oas/renderer/presenters/navigation.rb
@@ -300,6 +290,7 @@ files:
 - lib/nexmo/oas/renderer/public/assets/javascripts/tooltip.min.js
 - lib/nexmo/oas/renderer/public/assets/javascripts/volta.accordion.js
 - lib/nexmo/oas/renderer/public/assets/javascripts/volta.core.js
+- lib/nexmo/oas/renderer/public/assets/javascripts/volta.dropdown.js
 - lib/nexmo/oas/renderer/public/assets/javascripts/volta.modal.js
 - lib/nexmo/oas/renderer/public/assets/javascripts/volta.tabs.js
 - lib/nexmo/oas/renderer/public/assets/javascripts/volta.tooltip.js
@@ -366,6 +357,8 @@ files:
 - lib/nexmo/oas/renderer/views/open_api/_tabbed_parameters.erb
 - lib/nexmo/oas/renderer/views/open_api/_tabbed_single_parameter.erb
 - lib/nexmo/oas/renderer/views/open_api/_webhooks.erb
+- lib/nexmo/oas/renderer/views/open_api/content_switcher/_dropdown.erb
+- lib/nexmo/oas/renderer/views/open_api/content_switcher/_tabs.erb
 - lib/nexmo/oas/renderer/views/open_api/show.erb
 - lib/nexmo/oas/renderer/views/static/404.erb
 - nexmo-oas-renderer.gemspec

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-script:
-  - bundle exec rspec
-  - bundle exec rubocop