nexmo-oas-renderer 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 386fdf3ed82834c48d914044ebb508731c1ffd11ece58c938838b701f03e740f
-  data.tar.gz: 8114c77db9d427c1b91b14eec1b3a81dbe2cb23ac7e1bb12bb771a30aa36f519
+  metadata.gz: 96566dc3b7c32b1faaf58490da59a44cd5d84bf7d31bc2e96c63fa83bbb0e2b2
+  data.tar.gz: 54c7eec75b23ce13faf82a4ef6f04d1166bbbba744334f947eab3f627d785071
 SHA512:
-  metadata.gz: ba72d949b949515c93413986307d1a9566ee6462d1c78ef2d2bbbad934fe4be8b614d50f71b4277729fabe8b87783783a49a19d4cc7107d05cf95686338751a5
-  data.tar.gz: d1d25d488466021faf651bba03ef7d29932dc7bb48dbff824b53394f809e29b148909fd568fdd4bf0289577a8cc2e83ad9efa3938ac9d40d2d6fde4f7d0dee96
+  metadata.gz: a354aee9de2e810dd12b667af8c91d1ee44e6d4f95369c4f653fe3eb03329c215e29db6123b7746238dc51ebae9dd2206614331c2a110dcc6094e4a22b417afb
+  data.tar.gz: 5d045bc34c210e9989b94a744962f58b1d1d93ed91c29d3b2f6c167407fdd1f375f3ecf3708ac8f17a2f38e8548bde094770e1e5b7adf092b18881a83745da39

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (0.4.1)
+    nexmo-oas-renderer (0.5.0)
       activemodel (~> 5.2)
       activesupport (~> 5.2)
       banzai (~> 0.1.2)
       dotenv (~> 2.7)
       neatjson (~> 0.8)
-      oas_parser (= 0.18.1)
+      oas_parser (= 0.21.1)
       octicons_helper (~> 8.2)
       redcarpet (= 3.4.0)
       rouge (= 2.0.7)
@@ -74,6 +74,7 @@ GEM
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     hansi (0.2.0)
+    hash-deep-merge (0.1.1)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     loofah (2.2.3)
@@ -96,11 +97,12 @@ GEM
     nio4r (2.5.1)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.18.1)
+    oas_parser (0.21.1)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)
       deep_merge (~> 1.2.1)
+      hash-deep-merge
       mustermann-contrib (~> 1.0.3s)
       nokogiri
     octicons (8.5.0)

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

@@ -81,6 +81,15 @@ module Nexmo
           end
         end
 
+        def set_code_language
+          return if params[:code_language] == 'templates'
+          @code_language = params[:code_language]
+        end
+
+        before do
+          set_code_language
+        end
+
         get '(/api)/*definition' do
           check_redirect!
 
@@ -104,8 +113,23 @@ module Nexmo
           end
         end
 
-        get '(/api)/*document' do
-          @specification = Presenters::ApiSpecification.new(document_name: params[:document])
+        def set_document
+          if params[:code_language] == 'templates'
+            @document = 'verify/templates'
+          elsif params[:code_language] == 'ncco'
+            @document = 'voice/ncco'
+          else
+            @document = params[:document]
+          end
+        end
+
+        get '(/api)/*document(/:code_language)' do
+          set_document
+
+          @specification = Presenters::ApiSpecification.new(
+            document_name: @document,
+            code_language: @code_language
+          )
 
           @navigation = Presenters::Navigation.new(
             content: @specification.content,

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

@@ -8,7 +8,7 @@ module Nexmo
           end
 
           def canonical_path
-            request.path.chomp("/#{params[:code_language]}")
+            request.path.chomp("/#{@code_language}")
           end
         end
       end

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

@@ -4,8 +4,9 @@ module Nexmo
       module Presenters
         class ApiSpecification
 
-          def initialize(document_name:)
+          def initialize(document_name:, code_language: nil)
             @document_name = document_name
+            @code_language = code_language
           end
 
           def side_navigation
@@ -33,7 +34,9 @@ module Nexmo
           end
 
           def content
-            @content ||= MarkdownPipeline.new.call(document)
+            options = {}
+            options.merge(code_language: @code_language) if @code_language
+            @content ||= MarkdownPipeline.new(options).call(document)
           end
         end
       end

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

@@ -1,7 +1,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = "0.4.1"
+      VERSION = "0.5.0"
     end
   end
 end

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

@@ -42,9 +42,47 @@
       <%= erb :'open_api/_parameters', locals: { parameters: params, callback: callback } %>
     <% end %>
   <% else %>
-    <% endpoint.request_body.split_properties_for_format(format).each_with_index do |parameters, index| %>
-      <h4><%= parameters[0].schema['oneOf'][index]['description'] %></h4>
-      <%= erb :'open_api/_parameters', locals: { parameters: parameters, callback: callback } %>
-    <% end %>
+
+    <%
+      # 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['oneOf'][index]
+        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,
+          '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 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' : '' %>">
+            <h4>
+              <%= panel['description'] %>
+              <span class="Vlt-badge Vlt-badge--blue"><%= format %></span>
+            </h4>
+            <%= erb :'open_api/_parameters', locals: { parameters: panel['parameters'], callback: callback } %>
+          </div>
+        <% end %>
+      </div>
+    </div>
   <% end %>
 <% 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.18.1'
+  spec.add_runtime_dependency 'oas_parser', '0.21.1'
   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.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2019-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.21.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.21.1
 - !ruby/object:Gem::Dependency
   name: neatjson
   requirement: !ruby/object:Gem::Requirement