nexmo-oas-renderer 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c40a422720fac8d82bc5fe95e26eacbedddbadf7726e827130918b8792d30087
-  data.tar.gz: b85c27157e96bb937467fc5c190abadd629c4768dacddb5fc151813d0f64d06b
+  metadata.gz: 691cea5c58db9e4302f16eeb56da4d2b8acc182d7849394b55e540d25cbef01e
+  data.tar.gz: f83955f0c99f81b184551666c82d4825ed6651801c2a485f482125191c9b7bcf
 SHA512:
-  metadata.gz: fe8c5c7740c053c1e4617ae2f476b2cc22ef390a95511f75ed7a002789d64e57a44861d4f46976f62f320686e85c47ab58457bb1af7c999ac1f95f57dfd24b67
-  data.tar.gz: ed2ccdb482d8eb5057887ea55ad9b2b6997941ba51c6672ee807e574fbc9abe9b6ff182d01671f73e748afd6bf037047509cb4f60d48566bfeb841ec6d6b8031
+  metadata.gz: aaa967c7b0c411b2da091ad3ad1e4916c198bb545417b453ebd16646fa57db88d7b29b94a2907349fa077d6108438e775a3e8c41644150fa5e187c130a64d7f7
+  data.tar.gz: 5b952135e2310ef7dcebf6de690df94aae5d7c86ec2ee190792a225ed566495c86d19a4677ec2eee353b24bd741d86e2c5f557b8e3c20905475c80a0e11144a1

data/.travis.yml

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

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (0.9.0)
+    nexmo-oas-renderer (0.10.0)
       activemodel (~> 6.0)
       activesupport (~> 6.0)
       banzai (~> 0.1.2)
       dotenv (~> 2.7)
       neatjson (~> 0.8)
       nexmo_markdown_renderer (~> 0.2)
-      oas_parser (~> 0.24)
+      oas_parser (~> 0.25.1)
       octicons_helper (~> 8.2)
       redcarpet (= 3.4.0)
       rouge (= 2.0.7)
@@ -19,56 +19,56 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.2.1)
-      actionpack (= 6.0.2.1)
+    actioncable (6.0.2.2)
+      actionpack (= 6.0.2.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionmailbox (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       mail (>= 2.7.1)
-    actionmailer (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      actionview (= 6.0.2.1)
-      activejob (= 6.0.2.1)
+    actionmailer (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.2.1)
-      actionview (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionpack (6.0.2.2)
+      actionview (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       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.2.1)
-      actionpack (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actiontext (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       nokogiri (>= 1.8.5)
-    actionview (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionview (6.0.2.2)
+      activesupport (= 6.0.2.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    activejob (6.0.2.2)
+      activesupport (= 6.0.2.2)
       globalid (>= 0.3.6)
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activerecord (6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activestorage (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activestorage (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
       marcel (~> 0.3.1)
-    activesupport (6.0.2.1)
+    activesupport (6.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -91,14 +91,14 @@ GEM
     hash-deep-merge (0.1.1)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    loofah (2.4.0)
+    loofah (2.5.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
-    method_source (0.9.2)
+    method_source (1.0.0)
     mimemagic (0.3.4)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
@@ -109,7 +109,7 @@ GEM
       hansi (~> 0.2.0)
       mustermann (= 1.1.1)
     neatjson (0.9)
-    nexmo_markdown_renderer (0.2.0)
+    nexmo_markdown_renderer (0.3.0)
       activemodel (~> 6.0)
       banzai (~> 0.1.2)
       i18n (~> 1.7)
@@ -120,7 +120,7 @@ GEM
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.24.0)
+    oas_parser (0.25.1)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)
@@ -133,35 +133,35 @@ GEM
     octicons_helper (8.5.0)
       octicons (= 8.5.0)
       rails
-    public_suffix (4.0.3)
+    public_suffix (4.0.4)
     rack (2.2.2)
     rack-protection (2.0.8.1)
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.2.1)
-      actioncable (= 6.0.2.1)
-      actionmailbox (= 6.0.2.1)
-      actionmailer (= 6.0.2.1)
-      actionpack (= 6.0.2.1)
-      actiontext (= 6.0.2.1)
-      actionview (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    rails (6.0.2.2)
+      actioncable (= 6.0.2.2)
+      actionmailbox (= 6.0.2.2)
+      actionmailer (= 6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actiontext (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       bundler (>= 1.3.0)
-      railties (= 6.0.2.1)
+      railties (= 6.0.2.2)
       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.2.1)
-      actionpack (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    railties (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
@@ -171,19 +171,19 @@ GEM
       ffi (~> 1.0)
     redcarpet (3.4.0)
     rouge (2.0.7)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     ruby2_keywords (0.0.2)
     sass (3.7.4)
       sass-listen (~> 4.0.0)
@@ -207,7 +207,7 @@ GEM
     thor (1.0.1)
     thread_safe (0.3.6)
     tilt (2.0.10)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)

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

@@ -51,7 +51,7 @@
     top: 30px;
     position: sticky;
     display: block;
-    overflow: scroll;
+    overflow: auto;
   }
 
   &__code {

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

@@ -1,7 +1,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = "0.9.0"
+      VERSION = "0.10.0"
     end
   end
 end

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

@@ -20,8 +20,7 @@
       <div class="Vlt-badge-combined">
         <code class="Vlt-badge Vlt-white Vlt-badge--large Nxd-method-badge Nxd-method-badge--<%= endpoint.method %>"><%= endpoint.method.upcase %></code>
         <code class="Vlt-badge Vlt-badge--large Vlt-bg-grey-lighter Vlt-black">
-          <span class="api-path-host">https://example.com</span>
-          <%= (endpoint.raw['x-example-path'] || '/webhooks/event').gsub(/\{(.+?)\}/, '<span class="api-path-parameter">:\1</span>') %>
+          <span class="api-path-host">https://example.com</span><%= (endpoint.raw['x-example-path'] || '/webhooks/event').gsub(/\{(.+?)\}/, '<span class="api-path-parameter">:\1</span>') %>
         </code>
       </div>
 

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

@@ -48,6 +48,17 @@
           <% end %>
         <% end %>
 
+        <% definition.webhooks.each do |webhook| %>
+          <% webhook.endpoints.each do |endpoint| %>
+            <li>
+              <a href="#<%= webhook.name %>" class="Vlt-sidemenu__link">
+                <svg class="Vlt-grey-darker"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-mind-map" /></svg>
+                <span class="Vlt-sidemenu__label"><%= endpoint.summary %></span>
+              </a>
+            </li>
+          <% end %>
+        <% end %>
+
         <% if definition.raw['x-webhooks'] %>
           <% definition.raw['x-webhooks'].each do |name, definition| %>
             <% callback = OasParser::Callback.new(self, name, definition) %>

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

@@ -82,12 +82,38 @@
       <% end %>
     <% end %>
 
+    <% if @specification.definition.raw['x-webhooks'] || definition.webhooks.size.positive? %>
+    <div class="Vlt-grid">
+      <div class="Vlt-col Vlt-col--2of3 Nxd-api__docs">
+        <div>
+          <h2>Webhooks</h2>
+          <p>
+            Webhooks are an extension of an API, but instead of your code requesting data, the API sends data to you. The data arrives in a web request to your application.
+          </p>
+          <p>To learn more about webhooks, see our <a href="/concepts/guides/webhooks">webhooks documentation</a></p>
+
+          <p>This API may send any of the webhooks documented below to the URL that you have configured. You must repond with a `200` or `204` HTTP response, or the requests will be retried</p>
+          <br />
+        </div>
+      </div>
+
+      <div class="Vlt-col Vlt-col--1of3 Nxd-api__code">
+      </div>
+    </div>
+    <% end %>
+
     <% if @specification.definition.raw['x-webhooks'] %>
       <% @specification.definition.raw['x-webhooks'].each do |name, definition| %>
         <%= erb :'open_api/_callback', locals: { callback: OasParser::Callback.new(self, name, definition), webhook: true } %>
       <% end %>
     <% end %>
 
+    <% definition.webhooks.each do |webhook| %>
+      <% webhook.endpoints.each do |endpoint| %>
+        <%= erb :'open_api/_callback_endpoint', locals: { webhook: webhook, endpoint: endpoint } %>
+      <% end %>
+    <% end %>
+
     <% if @specification.definition_errors %>
       <div class="Vlt-grid" id="errors">
         <div class="Vlt-col Vlt-col--2of3 Nxd-api__docs">

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.24'
+  spec.add_runtime_dependency 'oas_parser', '~> 0.25.1'
   spec.add_runtime_dependency 'neatjson', '~> 0.8'
   spec.add_runtime_dependency 'activesupport', '~> 6.0'
   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.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: 0.25.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: 0.25.1
 - !ruby/object:Gem::Dependency
   name: neatjson
   requirement: !ruby/object:Gem::Requirement
@@ -246,6 +246,7 @@ files:
 - ".github/workflows/push-docker-publish.yml"
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Dockerfile
@@ -377,7 +378,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: OpenAPI Specification renderer.