nexmo-oas-renderer 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33d82e91aa8c7ea219e55e9aa1da6b43c2122413052740fe9d54979bf199e779
-  data.tar.gz: 53bdc5fca0292fbb876dd0e74a92ae80d6514b21360589313dc9e1dd21a94d8a
+  metadata.gz: 7c0e7a8af2769d4a4ebd3984ac00658f0d02a22a3680136bd04253cbbaf270a3
+  data.tar.gz: 0e40b9e68b9255c70178a4140c31fe47a5c5bbae71d8a8a6170ae10452a16fb9
 SHA512:
-  metadata.gz: e9e50101f2a4a4ad0144ccf926398d9b88556530207c6fad9f05adbe2e0f702ddb14040b03155cabfd7d547cad77edb5c551a919771f29b5846ac3a24dde5ab7
-  data.tar.gz: cb226f3f063770cbf882f0d834d088f21f86a4f3a9f3e4c340088a203b40ed0006201a61e9d973e8fbc79ccab8a9397cc59b5fa145c0f76f2b4a068469967ab4
+  metadata.gz: 3220559808b157b8cdbad65e9538569d6edc0dfeb06bca8caafed1ae0b63b47d3f3e5b9e08b6261f77b27efaf1eea50efdc454fa8a52402b449fa3eacb892a71
+  data.tar.gz: 8573dc0aaa3412c81f5b2ca29d80611d92e410948cc1f0da1067a786d33c11b11976cf00bbcbe212dc456d53170dbcac51c65866d9a97c27c6ea419474ee65a1

data/.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 .sass-cache/
 .byebug_history
-public/stylesheets/*.css*
+lib/nexmo/oas/renderer/public/assets/stylesheets/sass/*.css
+lib/nexmo/oas/renderer/public/assets/stylesheets/sass/*.css.map
 .env

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (0.3.6)
+    nexmo-oas-renderer (0.4.0)
       activemodel (~> 5.2)
       activesupport (~> 5.2)
       banzai (~> 0.1.2)
@@ -68,7 +68,7 @@ GEM
     crass (1.0.4)
     deep_merge (1.2.1)
     diff-lcs (1.3)
-    dotenv (2.7.4)
+    dotenv (2.7.5)
     erubi (1.8.0)
     ffi (1.11.1)
     globalid (0.4.2)
@@ -92,7 +92,7 @@ GEM
     mustermann-contrib (1.0.3)
       hansi (~> 0.2.0)
       mustermann (= 1.0.3)
-    neatjson (0.8.4)
+    neatjson (0.9)
     nio4r (2.4.0)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
@@ -110,7 +110,7 @@ GEM
       rails
     public_suffix (3.1.1)
     rack (2.0.7)
-    rack-protection (2.0.5)
+    rack-protection (2.0.7)
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -130,7 +130,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
+    rails-html-sanitizer (1.2.0)
       loofah (~> 2.2, >= 2.2.2)
     railties (5.2.3)
       actionpack (= 5.2.3)
@@ -164,10 +164,10 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
     shotgun (0.9.2)
       rack (>= 1.0)
-    sinatra (2.0.5)
+    sinatra (2.0.7)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.5)
+      rack-protection (= 2.0.7)
       tilt (~> 2.0)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -27,6 +27,11 @@ And simply run the executable with the corresponding env variables set (see [Not
 $ nexmo-oas-renderer
 ```
 
+Or, if you want to make code changes, just run the following command which will start the web server on http://localhost:9393:
+``` shell
+OAS_PATH=... bundle exec shotgun lib/nexmo/oas/renderer/config.ru
+```
+
 ### Mounted into a Rails Application
 
 Add this to your application's `Gemfile`:

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

@@ -10,6 +10,7 @@ require_relative'./pipelines/markdown_pipeline'
 require_relative'./presenters/api_specification'
 require_relative'./presenters/open_api_specification'
 require_relative'./presenters/navigation'
+require_relative'./presenters/response_tabs'
 require_relative'./helpers/render'
 require_relative'./helpers/navigation'
 require_relative'./helpers/summary'

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

@@ -11,7 +11,7 @@ module Nexmo
                 link['target'] = '_blank'
                 if link.css('svg').empty?
                   link.add_child <<~HEREDOC
-                    &nbsp;<svg class="Vlt-icon Vlt-icon--smaller Vlt-icon--text-bottom Vlt-blue-dark"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-open"></use></svg>
+                    &nbsp;<svg class="Vlt-icon Vlt-icon--smaller Vlt-icon--text-bottom Vlt-blue-dark"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-open"></use></svg>
                   HEREDOC
                 end
               end

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

@@ -21,7 +21,7 @@ module Nexmo
 
               heading.prepend_child <<~HEREDOC
                 <a href="##{parameterized_heading}" class="heading-permalink">
-                  <svg class="Vlt-grey"><use xlink:href=\"/symbol/volta-icons.svg#Vlt-icon-link\" /></svg>
+                  <svg class="Vlt-grey"><use xlink:href=\"/assets/symbol/volta-icons.svg#Vlt-icon-link\" /></svg>
                 </a>
               HEREDOC
             end

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

@@ -4,12 +4,12 @@ module Nexmo
       module Filters
         class Icon < Banzai::Filter
           def call(input)
-            input.gsub!('✅', '<svg class="Vlt-green Vlt-icon Vlt-icon--small"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-check" /></svg>')
-            input.gsub!('❌', '<svg class="Vlt-red Vlt-icon Vlt-icon--small"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-cross" /></svg>')
+            input.gsub!('✅', '<svg class="Vlt-green Vlt-icon Vlt-icon--small"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-check" /></svg>')
+            input.gsub!('❌', '<svg class="Vlt-red Vlt-icon Vlt-icon--small"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-cross" /></svg>')
 
             input.gsub!(/\[icon="(.+?)"\]/) do
               <<~HEREDOC
-                <svg class="Vlt-green Vlt-icon Vlt-icon--small"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-#{$1}" /></svg>
+                <svg class="Vlt-green Vlt-icon Vlt-icon--small"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-#{$1}" /></svg>
               HEREDOC
             end
 

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

@@ -8,7 +8,7 @@ module Nexmo
               tooltip = <<~HEREDOC
                 <span class="Vlt-tooltip Vlt-tooltip--top" title="#{$2}" tabindex="0">
                   #{$1}&nbsp;
-                  <svg class="Vlt-icon Vlt-icon--smaller Vlt-icon--text-bottom Vlt-blue" aria-hidden="true"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-help-negative"/></svg>
+                  <svg class="Vlt-icon Vlt-icon--smaller Vlt-icon--text-bottom Vlt-blue" aria-hidden="true"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-help-negative"/></svg>
                 </span>
               HEREDOC
 

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

@@ -0,0 +1,28 @@
+module Nexmo
+  module OAS
+    module Renderer
+      module Presenters
+        module ResponseTab
+          class Link
+            attr_reader :index
+
+            def initialize(index:, schema:)
+              @index  = index
+              @schema = schema
+            end
+
+            def css_classes
+              classes = ['Vlt-tabs__link']
+              classes << 'Vlt-tabs__link_active' if @index.zero?
+              classes.join(' ')
+            end
+
+            def content
+              @schema['description'] || "Response #{@index + 1}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Nexmo
+  module OAS
+    module Renderer
+      module Presenters
+        module ResponseTab
+          class Panel
+            attr_reader :index
+
+            def initialize(schema:, index:, format:, content:)
+              @schema  = schema
+              @index   = index
+              @format  = format
+              @content = content
+            end
+
+            def css_classes
+              classes = ['Vlt-tabs__panel']
+              classes << 'Vlt-tabs__panel_active' if @index.zero?
+              classes.join(' ')
+            end
+
+            def content
+              if @content == :responses
+                Nexmo::OAS::Renderer::ResponseParserDecorator.
+                  new(@schema).
+                  html(@format, xml_options: @schema['xml'])
+              else
+                [:'open_api/_response_fields', locals: {
+                  schema: @schema,
+                  index: @index,
+                  format: @format,
+                }]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require_relative './response_tab/link'
+require_relative './response_tab/panel'
+
+module Nexmo
+  module OAS
+    module Renderer
+      module Presenters
+        class ResponseTabs
+          attr_reader :format
+
+          def initialize(format, response, content)
+            @format   = format
+            @response = response
+            @content  = content
+          end
+
+          def tab_links
+            @tab_links ||= @response.split_schemas(@format).map.with_index do |schema, index|
+              ResponseTab::Link.new(
+                index: index,
+                schema: schema
+              )
+            end
+          end
+
+          def tab_panels
+            @tab_panels ||= @response.split_schemas(@format).map.with_index do |schema, index|
+              ResponseTab::Panel.new(
+                schema: schema,
+                index: index,
+                format: @format,
+                content: @content
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nexmo/oas/renderer/public/assets/javascripts/application.js

@@ -0,0 +1,19 @@
+document.addEventListener("DOMContentLoaded", function() {
+
+  // Toggle text on accordion button for response fields
+  let responseDescriptionTogglers = document.getElementsByClassName('response-description-toggle');
+
+  [...responseDescriptionTogglers].forEach(function(element) {
+    element.addEventListener('click', function(event) {
+      let text = event.target.textContent;
+      let newText;
+      if (text.indexOf('View') != -1) {
+        newText = text.replace("View", "Hide");
+      } else {
+        newText = text.replace("Hide", "View");
+      }
+      event.target.textContent = newText;
+    });
+  });
+
+});

data/lib/nexmo/oas/renderer/public/assets/javascripts/components/scroll.js

@@ -0,0 +1,21 @@
+class Scroll {
+  constructor() {
+    const self = this;
+    const body = document.getElementsByClassName('Vlt-main')[0];
+
+    document.addEventListener('DOMContentLoaded', function() {
+      body.addEventListener('scroll', self.onScroll);
+    });
+  }
+
+  onScroll(event) {
+    const scrollTop = event.target.scrollTop;
+    const codeNav = document.getElementsByClassName('Nxd-api__code__header')[0];
+
+    if (scrollTop > 70 && codeNav) {
+      codeNav.classList.add('Nxd-api__code__header--sticky');
+    } else if (codeNav) {
+      codeNav.classList.remove('Nxd-api__code__header--sticky');
+    }
+  }
+}

data/lib/nexmo/oas/renderer/public/assets/stylesheets/sass/api.scss

@@ -1,3 +1,6 @@
+@import "./variables";
+@import "./mediaqueries";
+
 .Nxd-content {
   display: flex;
 }
@@ -57,6 +60,13 @@
     padding-left: $unit2;
   }
 
+  &__responses {
+    top: 30px;
+    position: sticky;
+    display: block;
+    overflow: scroll;
+  }
+
   &__code {
     background: $grey-light;
     border-bottom: 1px solid $grey-lighter;
@@ -77,7 +87,7 @@
 
       &--sticky {
         position: fixed;
-        top: 135px;
+        top: 30px;
         width: 27.5%;
         z-index: 1000;
 

data/lib/nexmo/oas/renderer/public/assets/stylesheets/sass/core.scss

@@ -1,3 +1,7 @@
+@import "./variables";
+@import "./nexmo";
+@import "./mediaqueries";
+
 * {
   box-sizing: border-box;
   font-smoothing: antialiased;