nexmo-oas-renderer 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00f797762078297ac1632725fe728aab33b5a68364caa863b2b54b43bd096165
-  data.tar.gz: ea24290dc26cd7702983483eabaa109763945aba8123e320184e3dbc29ae937a
+  metadata.gz: c1e2c40dc6ad77e8425946eb53d32fa96d098c8e0d68596584a44ec21b93700a
+  data.tar.gz: 632e53a21620f471638f84261a72776ca4fad8c866758dfc55f5483dcb85c0d8
 SHA512:
-  metadata.gz: 7335fcca6e5e5e6a4b60bdba1dc1d4de476af604b2959a064c0f2629dec6080ff465a8d42e6d63d416f78621faeb60a483c2d1ce2e2f5b7c943fd4fa859670f4
-  data.tar.gz: 244665e2f2beb611e8ecbe6a9d8e34d412a09eff037e0390af7593fbecca0fbb9f1af60e7caed6ed1d5546c4f5c3ac6d816bc1cba6014bf79a958760f8af111e
+  metadata.gz: d53d87fc449ab535f1c5cfd03c9cf815b6ac908f9ee847c515f662183141d264ae2154ee0da6eb1b1020bd91dac9a9d030e1b828fb5984b827de1305c4d0c657
+  data.tar.gz: 36a869d2c7397124d567eb86466f5e090b1060b4e709da50160c277a3379332979f90748b51b865a95b6dc802b7f16520ea3fd3bfa2b815adb9c2ce1f448bdea

data/.env.example

@@ -1,2 +1 @@
 OAS_PATH='../api-specification'
-OAS_CI=true

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.6.3
+* Remove the need to have a `definitions` folder, just specify the correct path in `OAS_PATH`
+* Remove OAS constraints, since they are not needed to run this standalone
+
 # 0.6.0
 * Upgraded to Rails 6
 

data/README.md

@@ -70,7 +70,6 @@ and assign values to the corresponding variables.
 
 #### Note
 The env variable `OAS_PATH` indicates the path to the documents that will be rendered.
-Set `OAS_CI` to true to treat all the OAS docs under `OAS_PATH` as valid.
 
 ## Contributing
 We ❤️ contributions from everyone! [Bug reports](https://github.com/Nexmo/nexmo-oas-renderer/issues), [bug fixes](https://github.com/Nexmo/nexmo-oas-renderer/pulls) and feedback on the library is always appreciated. Look at the [Contributor Guidelines](https://github.com/Nexmo/nexmo-oas-renderer/blob/master/CONTRIBUTING.md) for more information and please follow the [GitHub Flow](https://guides.github.com/introduction/flow/index.html).

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

@@ -4,7 +4,6 @@ require 'active_support/core_ext/array/conversions'
 require 'active_support/core_ext/string/output_safety'
 require 'active_model'
 
-require_relative'./constraints/redirector'
 require_relative'./decorators/response_parser_decorator'
 require_relative'./pipelines/markdown_pipeline'
 require_relative'./presenters/api_specification'
@@ -15,7 +14,7 @@ require_relative'./helpers/render'
 require_relative'./helpers/navigation'
 require_relative'./helpers/summary'
 require_relative'./helpers/url'
-
+require_relative './services/code_language_api'
 require_relative'./lib/core_ext/string'
 
 require 'dotenv/load'
@@ -62,8 +61,16 @@ module Nexmo
         end
 
         def check_redirect!
-          redirect_path = Constraints::Redirector.find(request)
-          redirect(redirect_path) if redirect_path
+          if defined?(NexmoDeveloper::Application)
+            redirect_path = Redirector.find(request)
+            redirect(redirect_path) if redirect_path
+          end
+        end
+
+        def check_oas_constraints!(definition)
+          if defined?(NexmoDeveloper::Application)
+            pass unless OpenApiConstraint.match?(definition)
+          end
         end
 
         error Errno::ENOENT do
@@ -73,7 +80,7 @@ module Nexmo
 
         unless defined?(NexmoDeveloper::Application)
           get '/' do
-            prefix = "#{API.oas_path}/definitions"
+            prefix = "#{API.oas_path}"
             @definitions = Dir.glob("#{prefix}/**/*.yml").map do |d|
               d.gsub("#{prefix}/", '').gsub('.yml', '')
             end.sort.reject { |d| d.include? 'common/' }
@@ -95,7 +102,7 @@ module Nexmo
 
           parameters = parse_params(params[:definition])
           definition = [parameters[:definition], parameters[:version]].compact.join('.')
-          pass if !Constraints::OpenApi.match?(definition)
+          check_oas_constraints!(definition)
 
           @specification = Presenters::OpenApiSpecification.new(
             definition_name: definition,

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

@@ -26,12 +26,12 @@ module Nexmo
           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
             @definition_errors ||= MarkdownPipeline.new.call(
-              File.read("#{API.oas_path}/../errors/#{@definition_name}.md")
+              File.read("#{API.oas_path}/../../errors/#{@definition_name}.md")
             ) if errors?
           end
 

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

@@ -1,5 +1,3 @@
-require_relative '../constraints/open_api'
-
 module Nexmo
   module OAS
     module Renderer
@@ -23,15 +21,27 @@ module Nexmo
 
           def available_versions
             @available_versions ||= begin
-                                      versions = Constraints::OpenApi.find_all_versions(base_name)
-                                      # Add in anything in the old /_api folder
-                                      if File.exist?("_api/#{base_name}.md")
-                                        versions.push({ 'version' => '1', 'name' => base_name })
+                                      matches = definitions.select do |definition|
+                                        definition.starts_with?(base_name) && !definition.include?("#{base_name}/")
                                       end
 
-                                      versions.sort_by! { |v| v['version'] }
+                                      matches.map do |definition|
+                                        name = definition.chomp('.yml')
+                                        m = /\.v(\d+)/.match(name)
+                                        next { 'version' => '1', 'name' => name } unless m
+                                        { 'version' => m[1], 'name' => name }
+
+                                      end.sort_by { |v| v['version'] }
                                     end
           end
+
+          def definitions
+            @definitions ||= begin
+                               Dir.glob("#{API.oas_path}/definitions/**/*.yml").map do |file|
+                                 definition = file.sub("#{API.oas_path}/definitions/", '').chomp('.yml')
+                               end
+                             end
+          end
         end
 
       end

data/lib/nexmo/oas/renderer/services/open_api_definition_resolver.rb

@@ -21,7 +21,7 @@ module Nexmo
         end
 
         def self.path(name, format)
-          "#{API.oas_path}/definitions/#{name}.#{format}"
+          "#{API.oas_path}/#{name}.#{format}"
         end
 
         def self.resolve(path)

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

@@ -1,7 +1,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = "0.6.2"
+      VERSION = "0.6.3"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo-oas-renderer
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -247,9 +247,6 @@ files:
 - lib/nexmo/oas/renderer/config.ru
 - lib/nexmo/oas/renderer/config/code_languages.yml
 - lib/nexmo/oas/renderer/config/dynamic_content.yml
-- lib/nexmo/oas/renderer/config/redirects.yml
-- lib/nexmo/oas/renderer/constraints/open_api.rb
-- lib/nexmo/oas/renderer/constraints/redirector.rb
 - lib/nexmo/oas/renderer/decorators/response_parser_decorator.rb
 - lib/nexmo/oas/renderer/filters/anchor.rb
 - lib/nexmo/oas/renderer/filters/audio.rb
@@ -403,8 +400,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.

data/lib/nexmo/oas/renderer/config/redirects.yml

@@ -1,8 +0,0 @@
-"/api/voice/ncco": "/voice/voice-api/ncco-reference"
-"/api/account/secret-management": "/api/account#secret-management"
-"/api/developer": "/api/numbers"
-"/api/developer/numbers": "/api/numbers"
-"/api/developer/account": "/api/account"
-"/api/messages": "/api/developer/messages"
-
-"/api/stitch": "/api/conversation"

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

@@ -1,85 +0,0 @@
-require_relative '../services/code_language_api'
-
-module Nexmo
-  module OAS
-    module Renderer
-      module Constraints
-        class OpenApi
-
-          OPEN_API_PRODUCTS = %w[
-            sms
-            media
-            number-insight
-            conversation
-            conversation.v2
-            messages-olympus
-            dispatch
-            redact
-            audit
-            voice.v2
-            voice
-            account
-            external-accounts
-            numbers
-            verify
-            vonage-business-cloud/account
-            vonage-business-cloud/extension
-            vonage-business-cloud/reports
-            vonage-business-cloud/user
-            vonage-business-cloud/vgis
-            application
-            application.v2
-            conversion
-            subaccounts
-            developer/messages
-            reports
-          ].freeze
-
-          def self.match?(definition, code_language = nil)
-            return true if ENV['OAS_CI']
-            if code_language.nil?
-              products_with_code_language[:definition].match?(definition)
-            else
-              products_with_code_language[:definition].match?(definition) &&
-                products_with_code_language[:code_language].match?(code_language)
-            end
-          end
-
-          def self.list
-            OPEN_API_PRODUCTS
-          end
-
-          def self.products
-            { definition: Regexp.new("^(#{OPEN_API_PRODUCTS.join('|')})$") }
-          end
-
-          def self.errors_available
-            all = OPEN_API_PRODUCTS.dup.concat(['application'])
-            { definition: Regexp.new(all.join('|')) }
-          end
-
-          def self.products_with_code_language
-            products.merge(CodeLanguageAPI.route_constraint)
-          end
-
-          def self.find_all_versions(name)
-            # Remove the .v2 etc if needed
-            name = name.gsub(/(\.v\d+)/, '')
-
-            matches = OPEN_API_PRODUCTS.select do |s|
-              s.start_with?(name) && !s.include?("#{name}/")
-            end
-
-            matches = matches.map do |s|
-              m = /\.v(\d+)/.match(s)
-              next { 'version' => '1', 'name' => s } unless m
-              { 'version' => m[1], 'name' => s }
-            end
-
-            matches.sort_by { |v| v['version'] }
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-require 'yaml'
-
-module Nexmo
-  module OAS
-    module Renderer
-      module Constraints
-        class Redirector
-          REDIRECTS = YAML.load_file(File.expand_path("../config/redirects.yml", __dir__)) || {}
-
-          def self.find(request)
-            REDIRECTS[request.path] || false
-          end
-        end
-      end
-    end
-  end
-end