nexmo-oas-renderer 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ef85a4f776e2b1f85ffd89b8894ccff850c4624bd0003ab3375c98f6241c83e
-  data.tar.gz: 63b832190838494990ac78c554260f5fe560898a6c9dcef8deb1452cd8526d2a
+  metadata.gz: 61ed0dc132ea2e036d74356190d452e7930585ab72c15f06e699f8c23edbb0f6
+  data.tar.gz: 5a2d2d38e8b9053b1445f85e31e37f21c0777b62f61cf2a33ae725ff3d7ad2c0
 SHA512:
-  metadata.gz: 269f8cf5678c091bed1edc752c4cf87558546090c7c65f8a0a2f3045caffd3312ff23d24e66f1a10244693dc369eaae714ebfe44a556af44f2a6d6ff5c5f91db
-  data.tar.gz: 59d071880e4fb551817a8c64b0a56a758bcb3241c1c81072df82e411aa23067ff8258e478c35b61691fdeb9c0f3eca501d550eda1da4a8ac799f7e07d4092045
+  metadata.gz: 734bfb200fa5eff30b5da856b3ac0809a49687b04cb865dc9dc279dc5f12eebc78d44a0413a83488855eb4169bbd280d3ff559e135d3fdf36fba758744347bac
+  data.tar.gz: 25551f90bbb9be46b994994497bb7d3d25bc5c9f3c3754695c25670994d1e52ea040bae927401feec9c386cd3896b880138226581337d388b735c7cd72f2e583

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (0.2.2)
+    nexmo-oas-renderer (0.3.0)
       activemodel (~> 5.2)
       activesupport (~> 5.2)
       banzai (~> 0.1.2)
@@ -67,6 +67,7 @@ GEM
     concurrent-ruby (1.1.5)
     crass (1.0.4)
     deep_merge (1.2.1)
+    diff-lcs (1.3)
     dotenv (2.7.4)
     erubi (1.8.0)
     ffi (1.11.1)
@@ -143,6 +144,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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
     sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
@@ -178,6 +192,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   nexmo-oas-renderer!
   rake (~> 10.0)
+  rspec (~> 3.8)
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/lib/nexmo/oas/renderer/constraints/open_api.rb

@@ -26,7 +26,6 @@ module Nexmo
             vonage-business-cloud/user
             vonage-business-cloud/vgis
             application.v2
-            conversion
           ].freeze
 
           def self.match?(definition, code_language = nil)

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

@@ -0,0 +1,19 @@
+require_relative './response_format'
+
+module Nexmo
+  module OAS
+    module Renderer
+      module Presenters
+        class Endpoint
+          def initialize(endpoint)
+            @endpoint = endpoint
+          end
+
+          def formats
+            @formats ||= ResponseFormat.new(@endpoint.responses).extract
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,6 @@
 require 'forwardable'
+require_relative './endpoint'
+require_relative './response_format'
 require_relative './groups'
 require_relative './versions'
 require_relative '../services/open_api_definition_resolver'
@@ -23,28 +25,8 @@ module Nexmo
             @groups           = Groups.new(definition)
           end
 
-          def display_initialization?
-            initialization? && initialization_content && initialization_config
-          end
-
-          def initialization?
-            File.file? "#{API.oas_path}/../initialization/#{@definition_name}.md"
-          end
-
-          def initialization_content
-            @initialization_content ||= MarkdownPipeline.new.call(
-              File.read("#{API.oas_path}/../initialization/#{@definition_name}.md")
-            ) if initialization?
-          end
-
-          def initialization_config
-            @initialization_config ||= YAML.safe_load(
-              File.read("#{API.oas_path}/../initialization/#{@definition_name}.md")
-            ) if initialization?
-          end
-
           def errors?
-              File.exist?("#{API.oas_path}/../errors/#{@definition_name}.md")
+            File.exist?("#{API.oas_path}/../errors/#{@definition_name}.md")
           end
 
           def definition_errors
@@ -60,8 +42,17 @@ module Nexmo
           def auto_expand_responses
             @expand_responses
           end
-        end
 
+          def formats
+            @formats ||= ResponseFormat.to_dropdown(endpoints.flat_map(&:formats).uniq)
+          end
+
+          private
+
+          def endpoints
+            @endpoints ||= definition.endpoints.map { |e| Endpoint.new(e) }
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,27 @@
+module Nexmo
+  module OAS
+    module Renderer
+      module Presenters
+        class ResponseFormat
+          MAPPINGS = {
+            'application/json' => 'JSON',
+            'application/xml' => 'XML',
+            'text/xml' => 'XML',
+          }
+
+          def self.to_dropdown(formats)
+            MAPPINGS.slice(*formats)
+          end
+
+          def initialize(responses)
+            @responses = responses
+          end
+
+          def extract
+            @formats ||= @responses.flat_map(&:formats).uniq
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = "0.2.2"
+      VERSION = "0.3.0"
     end
   end
 end

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

@@ -28,8 +28,8 @@
                 <span class="flag flag--strong">Required</span>
               <% end %>
 
-              <% if @specification.initialization_config && @specification.initialization_config['formats'] %>
-                <% if @specification.initialization_config['formats'].include? 'text/xml' %>
+              <% if @specification.formats.any? %>
+                <% if @specification.formats.include?('text/xml') %>
                   <span class="js-format" data-format="text/xml">
                     <% if parameter.is_xml_attribute? %>
                       | <span class="flag">Attribute</span>

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

@@ -39,19 +39,16 @@
       </div>
       <div class="Vlt-col Vlt-col--1of3 Nxd-api__code Nxd-api__code--install">
 
-        <% if @specification.display_initialization? %>
+        <% if @specification.formats.any? %>
           <div class="Nxd-api__code__header">
-            <% if @specification.initialization_config && @specification.initialization_config['formats'] %>
-              <div class="Vlt-native-dropdown">
-                <select class="js-format-selector">
-                  <% @specification.initialization_config['formats'].each do |value, name| %>
-                    <option value="<%= value %>"><%= name %></option>
-                  <% end %>
-                </select>
-              </div>
-            <% end %>
+            <div class="Vlt-native-dropdown">
+              <select class="js-format-selector">
+                <% @specification.formats.each do |value, name| %>
+                  <option value="<%= value %>"><%= name %></option>
+                <% end %>
+              </select>
+            </div>
           </div>
-          <%= @specification.initialization_content %>
         <% end %>
 
         <% if @specification.available_versions && @specification.available_versions.count > 1 %>

data/nexmo-oas-renderer.gemspec

@@ -46,4 +46,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo-oas-renderer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -206,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 description: 
 email:
 - fabian.rodriguez@vonage.com
@@ -216,6 +230,7 @@ extra_rdoc_files: []
 files:
 - ".env.example"
 - ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -279,9 +294,11 @@ files:
 - lib/nexmo/oas/renderer/models/tutorial.rb
 - lib/nexmo/oas/renderer/pipelines/markdown_pipeline.rb
 - lib/nexmo/oas/renderer/presenters/api_specification.rb
+- lib/nexmo/oas/renderer/presenters/endpoint.rb
 - lib/nexmo/oas/renderer/presenters/groups.rb
 - lib/nexmo/oas/renderer/presenters/navigation.rb
 - lib/nexmo/oas/renderer/presenters/open_api_specification.rb
+- lib/nexmo/oas/renderer/presenters/response_format.rb
 - lib/nexmo/oas/renderer/presenters/versions.rb
 - lib/nexmo/oas/renderer/public/assets/fonts/Lato-Black.woff
 - lib/nexmo/oas/renderer/public/assets/fonts/Lato-Black.woff2