nexmo-oas-renderer 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd8d4b2e48a2f59827cedcc768e575bfd2c3cb017a956fda2f1229737c56ffe0
-  data.tar.gz: 40cd40d5fca9582ea435fb73046f147275f98d0c2e97f9c9d842afe27a5a4472
+  metadata.gz: 19ccae4e6d539f56ca8ca52481c61af67998c187b0ac5834c8993ccdd8b0675d
+  data.tar.gz: 46e60565d3cd1753aa511e867bd3e4f59f0199d08a96e4ab14fde7b6be9d9e11
 SHA512:
-  metadata.gz: 28e38f0b3ee339407c713b27479973be7ddd5e298a4a71a4910ca5e51ffee8d75ca579903941662cf2d7114543be2f9f51016e67f3028ae14c59bbadfd0a83d2
-  data.tar.gz: d9bac1035bda4b54418617e29c626b2efa39410cc772eab34faa5a719abee6864d2ca753af0225fd01df4925606e30c612c763a90d17bb56af5be7b00941c2b0
+  metadata.gz: d86d119465ca5d726529c17c22f0c59ce1f103bb14089f3c25a698e154d72a381e5d11cd04620abe3dd828bb8ce8e1bdba972e283ddf088735b0e788b4f858a7
+  data.tar.gz: 238a727261fca54fe7f18513265cdb33f2d63db6edee9bfeb1afc8dd26fdf3f4a48ca6223da74582292a5b3345f5a7175c95e8b336bfeb5fa06c99dbd2f20b09

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (0.5.2)
+    nexmo-oas-renderer (0.5.4)
       activemodel (~> 5.2)
       activesupport (~> 5.2)
       banzai (~> 0.1.2)
       dotenv (~> 2.7)
       neatjson (~> 0.8)
-      oas_parser (= 0.22.1)
+      oas_parser (= 0.22.2)
       octicons_helper (~> 8.2)
       redcarpet (= 3.4.0)
       rouge (= 2.0.7)
@@ -97,7 +97,7 @@ GEM
     nio4r (2.5.1)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.22.1)
+    oas_parser (0.22.2)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)

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

@@ -118,8 +118,10 @@ module Nexmo
             @document = 'verify/templates'
           elsif params[:code_language] == 'ncco'
             @document = 'voice/ncco'
-          else
+          elsif CodeLanguage.exists?(params[:code_language])
             @document = params[:document]
+          else
+            @document = "#{params[:document]}/#{params[:code_language]}"
           end
         end
 

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

@@ -12,11 +12,16 @@ module Nexmo
             end
 
             def css_classes
-              classes = ['Vlt-tabs__link']
+              classes = ['tab-sync Vlt-tabs__link']
               classes << 'Vlt-tabs__link_active' if @index.zero?
               classes.join(' ')
             end
 
+            def data_tab_link
+              return nil unless @schema['x-tab-id']
+              @schema['x-tab-id']
+            end
+
             def content
               @schema['description'] || "Response #{@index + 1}"
             end

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

@@ -17,6 +17,7 @@ module Nexmo
 
           def tab_links
             @tab_links ||= @response.split_schemas(@format).map.with_index do |schema, index|
+              schema = handle_all_of(schema)
               ResponseTab::Link.new(
                 index: index,
                 schema: schema
@@ -26,6 +27,7 @@ module Nexmo
 
           def tab_panels
             @tab_panels ||= @response.split_schemas(@format).map.with_index do |schema, index|
+              schema = handle_all_of(schema)
               ResponseTab::Panel.new(
                 schema: schema,
                 index: index,
@@ -35,6 +37,16 @@ module Nexmo
               )
             end
           end
+
+          def handle_all_of(schema)
+            if schema['allOf']
+              schema['allOf'].each do |p|
+                schema.deep_merge!(p)
+              end
+              schema.delete('allOf')
+            end
+            schema
+          end
         end
       end
     end

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

@@ -16,4 +16,16 @@ document.addEventListener("DOMContentLoaded", function() {
     });
   });
 
+  // Handle people clicking on oneOf tabs by changing every one on the page
+  var oneOfTabs = document.querySelectorAll('[data-tab-link]');
+    Array.from(oneOfTabs).forEach(function(element) {
+        element.addEventListener('click', function (event) {
+          var link = event.target.getAttribute('data-tab-link');
+          var matchingTabs = document.querySelectorAll('[data-tab-link="'+link+'"]');
+            Array.from(matchingTabs).forEach(function(element) {
+              element.click();
+            });
+        });
+    });
+
 });

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

@@ -1,7 +1,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = "0.5.2"
+      VERSION = "0.5.4"
     end
   end
 end

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

@@ -10,6 +10,7 @@
         <code class="Vlt-badge Vlt-badge--large Nxd-method-badge Nxd-method-badge--<%= endpoint.method %>"><%= endpoint.method.upcase %></code>
         <code class="Vlt-badge Vlt-badge--large Vlt-badge--grey">
           <% servers = endpoint.path.servers ? endpoint.path.servers : endpoint.definition.servers %>
+          <% raise "`servers` parameter not provided at either the path level or document root" unless servers.size.positive? %>
           <span><%= servers[0]['url'] %></span><%= endpoint.path.path.gsub(/\{(.+?)\}/, '<span class="api-path-parameter">:\1</span>') %>
         </code>
       </div>

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

@@ -20,6 +20,7 @@
         <% end %>
 
         <% endpoints.each do |endpoint| %>
+          <% raise "Missing `operationId` on #{endpoint.path.path} path" unless endpoint.operationId %>
           <li>
             <a href="#<%= endpoint.operationId %>" class="Vlt-sidemenu__link">
               <svg class="Vlt-green"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-code" /></svg>

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

@@ -137,11 +137,16 @@
             </td>
           <% end %>
 
-          <% if parameter.collection? %>
+          <%
+            should_render_row = false
+            should_render_row = should_render_row || parameter.subproperties_are_one_of_many?
+            should_render_row = should_render_row || (parameter.properties && parameter.object? && parameter.properties.size.positive?)
+          %>
+          <% if parameter.collection? && should_render_row %>
+
             <tr class="Vlt-table__row--nohighlight">
               <td colspan="4">
                 <% if parameter.subproperties_are_one_of_many? %>
-
                   <div style="margin-left: 20px;">
                     <h4>Any one of the following:</h4>
                     <% parameter.properties.each do |property| %>
@@ -150,7 +155,7 @@
                     <% end %>
                   </div>
                 <% else %>
-                  <% if parameter.properties && parameter.object? %>
+                  <% if parameter.properties && parameter.object? && parameter.properties.size.positive? %>
                     <%= erb :'open_api/_parameters', locals: { parameters: parameter.properties, model: model, format: format, callback: callback } %>
                   <% end %>
                 <% end %>

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

@@ -42,9 +42,6 @@
         <% end %>
 
 
-
-
-
         <% if value['items'] # If this is an array, we need to show the structure of the children %>
 
           <% if value['items']['oneOf'] || value['items']['anyOf'] # If it's a oneOf/anyOf, we need tabs! %>
@@ -54,8 +51,8 @@
                 qualifier = 'one'
                 key = 'oneOf'
               else
-                  qualifier = 'any'
-                  key = 'anyOf'
+                qualifier = 'any'
+                key = 'anyOf'
               end
 
               schemas = value['items'][key].map do |item|
@@ -71,55 +68,63 @@
             <% schemas = [value] %>
           <% end %>
 
-          <% if schemas %>
-            <% needs_tabs = schemas.size > 1 %>
-            </td>
-            </tr>
+        <% else %>
+          <% schemas = [value] if value['properties'] %>
+        <% end %>
 
-            <tr class="Vlt-table__row--nohighlight">
-              <td colspan="2">
+        <% if schemas %>
+          <% needs_tabs = schemas.size > 1 %>
+          </td>
+          </tr>
 
-                <% if needs_tabs %>
-                  <div class="Vlt-callout Vlt-callout--shoutout">
-                    <i></i>
-                    <div class="Vlt-callout__content">
-                      This array contains <strong><%= qualifier %></strong> of the following objects:
-                    </div>
-                  </div>
-                  <div class="Vlt-tabs js-format">
-                    <div class="Vlt-tabs__header" role="tablist" aria-label="Responses">
-                      <% schemas.each_with_index do |schema, index| %>
-                        <div class="Vlt-tabs__link <%= index == 0 ? 'Vlt-tabs__link_active' : '' %>">
-                          <%= schema['description'] %>
-                        </div>
-                      <% end %>
-                    </div>
-                    <div class="Vlt-tabs__content">
-                <% end %>
+          <tr class="Vlt-table__row--nohighlight">
+            <td colspan="2">
 
-                  <% schemas.each_with_index do |value, index| %>
-                    <div class="Vlt-tabs__panel <%= index == 0 ? 'Vlt-tabs__panel_active' : '' %>">
-                      <div class="Vlt-table Vlt-table--data Vlt-table--bordered">
-                        <table>
-                          <thead>
-                          <tr>
-                            <th>Field</th>
-                            <th>Description</th>
-                          </tr>
-                          </thead>
-                          <tbody>
-                          <%= erb :'open_api/_response_description_parameters', locals: { endpoint: endpoint, schema: value, parent: responseFieldId } %>
-                          </tbody>
-                        </table>
+              <% if needs_tabs %>
+                <div class="Vlt-callout Vlt-callout--shoutout">
+                  <i></i>
+                  <div class="Vlt-callout__content">
+                    This array contains <strong><%= qualifier %></strong> of the following objects:
+                  </div>
+                </div>
+                <div class="Vlt-tabs js-format">
+                  <div class="Vlt-tabs__header" role="tablist" aria-label="Responses">
+                    <% schemas.each_with_index do |schema, index| %>
+                      <div
+                        class="Vlt-tabs__link <%= index == 0 ? 'Vlt-tabs__link_active' : '' %> <%= schema['x-tab-id'] ? "tab-sync" : '' %>"
+                        <% if schema['x-tab-id'] %>
+                          data-tab-link="<%= schema['x-tab-id'] %>"
+                          <% end %>
+                      >
+                        <%= schema['description'] %>
                       </div>
-                    </div>
-                  <% end %>
-
-                <% if needs_tabs %>
+                    <% end %>
                   </div>
+                  <div class="Vlt-tabs__content">
+              <% end %>
+
+              <% schemas.each_with_index do |value, index| %>
+                <div class="Vlt-tabs__panel <%= index == 0 ? 'Vlt-tabs__panel_active' : '' %>">
+                  <div class="Vlt-table Vlt-table--data Vlt-table--bordered">
+                    <table>
+                      <thead>
+                      <tr>
+                        <th>Field</th>
+                        <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <%= erb :'open_api/_response_description_parameters', locals: { endpoint: endpoint, schema: value, parent: responseFieldId } %>
+                      </tbody>
+                    </table>
                   </div>
-                <% end %>
-          <% end %>
+                </div>
+              <% end %>
+
+              <% if needs_tabs %>
+                </div>
+                </div>
+              <% end %>
         <% end %>
         </td>
         </tr>

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

@@ -3,7 +3,7 @@
 <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 class='<%= link.css_classes %>'>
+      <div class='<%= link.css_classes %>' <% if link.data_tab_link %>data-tab-link="<%= link.data_tab_link %>"<% end %>>
         <%= link.content %>
       </div>
     <% end %>

data/nexmo-oas-renderer.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'sinatra', '~> 2.0'
   spec.add_runtime_dependency 'shotgun', '~> 0.9'
   spec.add_runtime_dependency 'rouge', '2.0.7'
-  spec.add_runtime_dependency 'oas_parser', '0.22.1'
+  spec.add_runtime_dependency 'oas_parser', '0.22.2'
   spec.add_runtime_dependency 'neatjson', '~> 0.8'
   spec.add_runtime_dependency 'activesupport', '~> 5.2'
   spec.add_runtime_dependency 'banzai', '~> 0.1.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo-oas-renderer
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.1
+        version: 0.22.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.22.1
+        version: 0.22.2
 - !ruby/object:Gem::Dependency
   name: neatjson
   requirement: !ruby/object:Gem::Requirement
@@ -403,8 +403,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: OpenAPI Specification renderer.