nexmo-oas-renderer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6beab21d8740f78831e7bba38afdc63069fd4febe1592f8f66e41695c59b6c68
+  data.tar.gz: 1718a8b238ea7a4aab0fd538cb0249588463a5b66b06eccc37f7f9c355b8e484
+SHA512:
+  metadata.gz: de94333a3c2cc2af75dd092adaa2ae639f98e5f3bc4e3fc23055ac4866a3b237bc6a7d3bedacaf769896db7a77a038ed5758f299814c1eb08bad6edbdab8150a
+  data.tar.gz: cd6e3abb06560e9f4c7eb305d1869a1f8ca488c61e7f6bbc47f0b640d2ad8d7ea70e4ebe681810f640d9288e0452a3e72aa97f3d0bbee03828583bdc435610c9

data/.env.example

@@ -0,0 +1 @@
+OAS_PATH='../nexmo-developer'

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.sass-cache/
+.byebug_history
+public/stylesheets/*.css*
+.env

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 0.1.0
+* First version!

data/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contributing
+
+Thanks for considering contributing to Nexmo OAS Renderer! From typos, to sample code, tutorials and beyond, we truly appreciate and welcome input from everyone.
+
+You can read all about our markdown additions, writing style guide and standard placeholders on our [Contributing page](https://developer.nexmo.com/contribute/overview). Once you have a change to share with us, read on ...
+
+## Git process
+
+This project uses [GitHub Flow](https://guides.github.com/introduction/flow/index.html). We are happy to have issues opened for discussion, but we don't require an issue to be created before a pull request is opened. When you have a change you want us to consider:
+
+* Create a new branch on your own fork, from an up-to-date master branch.
+* Make the changes on that new branch.
+* Open a pull request for us, making sure to tell us what you changed and why in the pull request title and description.  Pull requests without a meaningful title and a completed template may be closed.
+
+If you need more information about how to do any of the above, we recommend the [GitHub Help pages](https://help.github.com/), which are indeed very helpful.
+
+Tips:
+
+* Keep it small! Small changes are easy to review and more likely to be accepted. More involved changes probably need discussion first.
+* Tell us _what_ changed and _why_. This helps us to understand the change and get the right people to review it.
+
+### For maintainers/reviewers
+
+* If you know who can review a particular pull request, tag those people. Tagging a few can be useful as we're in different timezones and can often be travelling.
+* Review with an eye to accuracy and maintainability as well as correctness. Ask yourself "do we want this change?" and "will users find this information here, could it be added to existing docs?" as well as "is everything spelled correctly?"
+* Before accepting a change, check that the markdown renders as expected, and the code runs ... this probably means either pulling the code down to your development platform or deploying a review application.
+* If changes are needed, then either:
+  - make the changes yourself (especially for minor or editorial changes).
+  - set your review as "changes requested" and comment for what is needed to make this pull request ready to accept.
+* If everything is good then go ahead and approve the pull request.
+* Now merge the pull request! If the change is good to go, then it should go (unless there are special circumstances of course). In the main, anyone can merge an accepted pull request at the earliest opportunity.
+* Delete the branch if it's on our repo.
+
+## Work in Progress [WIP]
+
+* Please feel free to open a pull request when you are at the early stages of working on something. Put "[WIP]" in the title so we know it's not ready yet.
+* Work in progress has a cost, merging things that have been branched for a long time can be harder work and cause more issues than smaller changes that can be completed quickly. Please consider whether to start a task that you can't finish in the time you have available.
+* Inactive pull requests will be closed. When you are ready to complete the work, please rebase your branch and open a new pull request.
+
+## GitHub Pull Request Labels
+
+We use a few different labels for our pull request workflows:
+
+* `don't merge` for things that might need external review, or where it needs to be merged on a specific date, or to clearly note that things are not ready yet!
+* `help wanted` when anyone is welcome to dive in.
+* `stale` when the pull request is abandoned and will soon be closed.

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nexmo-oas-renderer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,183 @@
+PATH
+  remote: .
+  specs:
+    nexmo-oas-renderer (0.1.0)
+      activemodel (~> 5.2)
+      activesupport (~> 5.2)
+      banzai (~> 0.1.2)
+      neatjson (~> 0.8)
+      oas_parser (= 0.18.1)
+      octicons_helper (~> 8.2)
+      redcarpet (= 3.4.0)
+      rouge (= 2.0.7)
+      sass (~> 3.1)
+      shotgun (~> 0.9)
+      sinatra (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    arel (9.0.0)
+    banzai (0.1.3)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    deep_merge (1.2.1)
+    dotenv (2.7.2)
+    erubi (1.8.0)
+    ffi (1.11.1)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    hansi (0.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      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)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    mustermann (1.0.3)
+    mustermann-contrib (1.0.3)
+      hansi (~> 0.2.0)
+      mustermann (= 1.0.3)
+    neatjson (0.8.4)
+    nio4r (2.3.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    oas_parser (0.18.1)
+      activesupport (>= 4.0.0)
+      addressable (~> 2.3)
+      builder (~> 3.2.3)
+      deep_merge (~> 1.2.1)
+      mustermann-contrib (~> 1.0.3s)
+      nokogiri
+    octicons (8.5.0)
+      nokogiri (>= 1.6.3.1)
+    octicons_helper (8.5.0)
+      octicons (= 8.5.0)
+      rails
+    public_suffix (3.0.3)
+    rack (2.0.7)
+    rack-protection (2.0.5)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    redcarpet (3.4.0)
+    rouge (2.0.7)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    shotgun (0.9.2)
+      rack (>= 1.0)
+    sinatra (2.0.5)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.5)
+      tilt (~> 2.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tilt (2.0.9)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  dotenv (~> 2.7)
+  nexmo-oas-renderer!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nexmo Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Nexmo OAS Renderer
+Sinatra application that provides a preview of how the OAS documents will be rendered within [Nexmo Developer](https://developer.nexmo.com/).
+
+* [Dependencies](#requirements)
+* [Installation and Usage](#installation-and-usage)
+    * [As a standalone application](#as-a-standalone-application)
+    * [Mounted into a Rails application](#mounted-into-a-rails-application)
+    * [Specifying the path to the documents](#specifying-the-path-to-the-documents)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Dependencies
+
+
+## Installation and Usage
+
+### As a standalone application
+
+Install the gem:
+
+``` shell
+$ gem install nexmo-oas-renderer
+```
+
+And simply run the executable:
+``` shell
+$ nexmo-oas-renderer
+```
+
+### Mounted into a Rails Application
+
+Add this to your application's `Gemfile`:
+
+```
+gem 'nexmo-oas-renderer', require: false
+```
+
+And then run `bundle install`.
+
+Require the gem in `config/environment.rb` as follows:
+
+``` ruby
+# Load the Rails application.
+require_relative 'application'
+
+require 'nexmo/oas/renderer'
+
+# Initialize the Rails application.
+Rails.application.initialize!
+```
+
+And finally mount the Sinatra app into your Rails application by adding the following line to `config/routes.rb`:
+
+``` ruby
+mount Nexmo::OAS::Renderer::API, at: '/api'
+```
+
+### Specifying the path to the documents
+
+This gem uses [dotenv](https://github.com/bkeepers/dotenv) to handle environment variables, so you should copy the `.env.example` provided by running:
+``` shell
+$ cp .env.example .env
+```
+and assign values to the corresponding variables.
+
+#### Note
+The app won't boot if the env variable `OAS_PATH` is not set. This variable indicates the path to the documents that will be rendered.
+
+## 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).
+
+## License
+This project is under the [MIT LICENSE](https://github.com/Nexmo/nexmo-oas-renderer/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nexmo/oas/renderer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/nexmo-oas-renderer

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'nexmo/oas/renderer'
+
+Nexmo::OAS::Renderer::API.run!

data/lib/nexmo/oas/engine.rb

@@ -0,0 +1,9 @@
+module Nexmo
+  module OAS
+    module Renderer
+      class Engine < ::Rails::Engine
+        config.assets.paths << "#{config.root}/lib/nexmo/oas/renderer/public/assets"
+      end
+    end
+  end
+end

data/lib/nexmo/oas/renderer.rb

@@ -0,0 +1,13 @@
+require "nexmo/oas/renderer/version"
+require "nexmo/oas/renderer/app"
+
+if defined?(NexmoDeveloper::Application)
+  require "nexmo/oas/engine"
+end
+
+module Nexmo
+  module OAS
+    module Renderer
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+require 'sinatra/base'
+require 'active_support'
+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'
+require_relative'./presenters/open_api_specification'
+require_relative'./presenters/navigation'
+require_relative'./helpers/render'
+require_relative'./helpers/navigation'
+require_relative'./helpers/summary'
+require_relative'./helpers/url'
+
+require_relative'./lib/core_ext/string'
+
+require 'dotenv/load'
+
+module Nexmo
+  module OAS
+    module Renderer
+      class API < Sinatra::Base
+
+        Tilt.register Tilt::ERBTemplate, 'html.erb'
+
+        if defined?(NexmoDeveloper::Application)
+          view_paths = [views, NexmoDeveloper::Application.root.join("app", "views")]
+          set :views, view_paths
+        end
+
+        set :mustermann_opts, { type: :rails }
+        set :show_exceptions, :after_handler
+        set :oas_path, (ENV['OAS_PATH'] || '.')
+
+        helpers do
+          include Helpers::Render
+          include Helpers::Navigation
+          include Helpers::Summary
+          include Helpers::URL
+        end
+
+        def parse_params(extension)
+          extensions = extension.split('.')
+          case extensions.size
+          when 1
+            { definition: extensions.first}
+          when 2
+            if extensions.second.match? /v\d+/
+              { definition: extensions.first, version: extensions.second }
+            else
+              { definition: extensions.first, format: extensions.second }
+            end
+          when 3
+            { definition: extensions.first, version: extensions.second, format: extensions.last }
+          else
+            {}
+          end
+        end
+
+        def check_redirect!
+          redirect_path = Constraints::Redirector.find(request)
+          redirect(redirect_path) if redirect_path
+        end
+
+        error Errno::ENOENT do
+          layout = defined?(NexmoDeveloper::Application) ? :'layouts/api.html' : false
+          not_found erb :'static/404', layout: layout
+        end
+
+        get '(/api)/*definition' do
+          check_redirect!
+
+          parameters = parse_params(params[:definition])
+          definition = [parameters[:definition], parameters[:version]].compact.join('.')
+          pass if !Constraints::OpenApi.match?(definition)
+
+          @specification = Presenters::OpenApiSpecification.new(
+            definition_name: definition,
+            expand_responses: params.fetch(:expandResponses, nil),
+          )
+
+          if ['yml', 'json'].include?(parameters[:format])
+            send_file @specification.definition.path, disposition: :attachment
+          else
+            if defined?(NexmoDeveloper::Application)
+              erb :'open_api/show', layout: :'layouts/page-full.html'
+            else
+              erb :'open_api/show', layout: :'layouts/open_api'
+            end
+          end
+        end
+
+        get '(/api)/*document' do
+          @specification = Presenters::ApiSpecification.new(document_name: params[:document])
+
+          @navigation = Presenters::Navigation.new(
+            content: @specification.content,
+            title: @specification.side_navigation_title,
+          )
+
+          if defined?(NexmoDeveloper::Application)
+            @content = @navigation.content
+            @side_navigation_title = @navigation.title
+
+            erb :'api/show', layout: :'layouts/api.html'
+          else
+            erb :'api/show', layout: :'layouts/api'
+          end
+        end
+      end
+    end
+  end
+end