nexmo-oas-renderer 0.7.1 → 0.8.0

data/lib/nexmo/oas/renderer/filters/unfreeze.rb

@@ -1,20 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Unfreeze < Banzai::Filter
-          def call(input)
-            input.gsub!('FREEZESTARTFREEZEEND', '')
-            input.gsub!('<p>FREEZESTART', 'FREEZESTART')
-            input.gsub!('FREEZEEND</p>', 'FREEZEEND')
-
-            input.gsub!(/FREEZESTART(.+?)FREEZEEND/m) do |_s|
-              Base64.urlsafe_decode64($1).force_encoding(Encoding::UTF_8)
-            end
-            input
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/user_personalization.rb

@@ -1,43 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class UserPersonalization < Banzai::Filter
-          def call(input)
-            return input unless options[:current_user]
-            return input if options[:current_user].api_key.blank?
-            return input if options[:current_user].api_secret.blank?
-
-            @input = input
-            document.css('pre code').each do |code|
-              html = code.to_s
-
-              html.gsub!(/(['|"])?NEXMO_API_(KEY|SECRET)['|"]?/) do
-                quote = $1 || "'"
-                value = (
-                  case $2
-                when 'KEY' then options[:current_user].api_key
-                when 'SECRET' then options[:current_user].api_secret
-                end
-                )
-                "#{quote}#{value}#{quote}"
-              end
-
-              html.gsub!('NEXMO_API_SECRET', "'#{options[:current_user].api_secret}'")
-
-              code.replace(html)
-            end
-
-            @document.to_html
-          end
-
-          private
-
-          def document
-            @document ||= Nokogiri::HTML::DocumentFragment.parse(@input)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/lib/core_ext/string.rb

@@ -1,14 +0,0 @@
-class String
-  def render_markdown(options = {})
-    Nexmo::OAS::Renderer::MarkdownPipeline.new(options).call(self).html_safe
-  end
-
-  def unindent
-    indent = squeeze("\n").lines.map { |line| line.index(/[^\s]/) }.compact.min || 0
-    gsub(/^[[:blank:]]{#{indent}}/, '')
-  end
-
-  def unindent!
-    replace(unindent)
-  end
-end

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

@@ -1,14 +0,0 @@
-require 'redcarpet'
-require 'rouge'
-require 'rouge/plugins/redcarpet'
-
-
-module Nexmo
-  module OAS
-    module Renderer
-      class HTML < Redcarpet::Render::HTML
-        include Rouge::Plugins::Redcarpet
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/models/code_snippet.rb

@@ -1,75 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Models
-        class CodeSnippet
-          include ActiveModel::Model
-          attr_accessor :title, :product, :category, :navigation_weight, :document_path, :url
-
-          def self.by_product(product)
-            all.select do |block|
-              block.product == product
-            end
-          end
-
-          def self.all
-            blocks = files.map do |document_path|
-              document = File.read(document_path)
-              product = extract_product(document_path)
-
-              frontmatter = YAML.safe_load(document)
-
-              new({
-                title: frontmatter['title'],
-                navigation_weight: frontmatter['navigation_weight'] || 999,
-                product: product,
-                document_path: document_path,
-                category: extract_category(document_path),
-                url: generate_url(document_path),
-              })
-            end
-
-            blocks.sort_by(&:navigation_weight)
-          end
-
-          def self.generate_url(path)
-            '/' + path.gsub("#{origin}/", '').gsub('.md', '')
-          end
-
-          def self.extract_product(path)
-            # Remove the prefix
-            path = path.gsub!("#{origin}/", '')
-
-            # Each file is in the form code-snippets/<title>.md, so let's remove everything after code-snippets
-            path = path.gsub(%r{/code-snippets/.*}, '')
-
-            path
-          end
-
-          def self.extract_category(path)
-            # Remove the prefix
-            path = path.gsub("#{origin}/", '')
-
-            # Each file is in the form code-snippets/<title>.md, so let's capture everything after code-snippets
-            path = path.gsub(%r{.*/code-snippets/(.*)$}, '\1')
-
-            parts = path.split('/')
-            parts = parts[0...-1]
-
-            return nil if parts.empty?
-
-            parts.join('/').tr('-', ' ').humanize
-          end
-
-          def self.files
-            Dir.glob("#{origin}/**/code-snippets/**/*.md")
-          end
-
-          def self.origin
-            "_documentation"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/models/tutorial.rb

@@ -1,83 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Models
-        class Tutorial
-
-          include ActiveModel::Model
-          attr_accessor :title, :description, :external_link, :products, :document_path, :languages
-
-          def body
-            File.read(document_path)
-          end
-
-          def path
-            return external_link if external_link
-            "/tutorials/#{document_path.relative_path_from(self.class.origin)}".gsub('.md', '')
-          end
-
-          def subtitle
-            normalized_products = products.map do |product|
-              normalise_product_title(product)
-            end
-
-            normalized_products.sort.to_sentence
-          end
-
-          def normalise_product_title(product)
-            return 'SMS' if product == 'messaging/sms'
-            return 'Voice' if product == 'voice/voice-api'
-            return 'Number Insight' if product == 'number-insight'
-            return 'Messages' if product == 'messages'
-            return 'Dispatch' if product == 'dispatch'
-            return 'Client SDK' if product == 'client-sdk'
-            product.camelcase
-          end
-
-          def self.by_product(product, tutorials = [])
-            tutorials = all if tutorials.empty?
-            tutorials.select do |tutorial|
-              tutorial.products.include? product
-            end
-          end
-
-          def self.by_language(language, tutorials = [])
-            language = language.downcase
-            tutorials = all if tutorials.empty?
-
-            tutorials.select do |tutorial|
-              tutorial.languages.map(&:downcase).include? language
-            end
-          end
-
-          def self.origin
-            Pathname.new("_tutorials")
-          end
-
-          def self.all
-            files.map do |document_path|
-              document_path = Pathname.new(document_path)
-              document = File.read(document_path)
-              frontmatter = YAML.safe_load(document)
-
-              new({
-                title: frontmatter['title'],
-                description: frontmatter['description'],
-                external_link: frontmatter['external_link'],
-                products: frontmatter['products'].split(',').map(&:strip),
-                languages: frontmatter['languages'] || [],
-                document_path: document_path,
-              })
-            end
-          end
-
-          private
-
-          private_class_method def self.files
-            Dir.glob("#{origin}/**/*.md")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/pipelines/markdown_pipeline.rb

@@ -1,52 +0,0 @@
-require 'banzai'
-
-Dir[File.join(__dir__, '../filters', '*.rb')].each { |f| require_relative f }
-
-module Nexmo
-  module OAS
-    module Renderer
-      class MarkdownPipeline < Banzai::Pipeline
-        def initialize(options = {})
-          super(
-            # As Markdown
-            Filters::Frontmatter,
-            Filters::PHPInliner,
-            Filters::InlineEscape,
-            Filters::BlockEscape,
-            Filters::Screenshot,
-            Filters::Anchor,
-            Filters::Audio,
-            Filters::DynamicContent,
-            Filters::Tooltip,
-            Filters::Collapsible,
-            Filters::Tab.new(options),
-            Filters::CodeSnippets.new(options),
-            Filters::CodeSnippet.new(options),
-            Filters::Code,
-            Filters::Indent,
-            Filters::Modal,
-            Filters::JsSequenceDiagram,
-            Filters::Partial.new(options),
-            Filters::Techio,
-            Filters::Tutorials,
-            Filters::CodeSnippetList,
-            Filters::ConceptList,
-            Filters::Language,
-            Filters::Columns,
-            Filters::Markdown.new(options),
-
-            # As HTML
-            Filters::UserPersonalization.new(options),
-            Filters::Heading,
-            Filters::Label.new(options),
-            Filters::Break,
-            Filters::Unfreeze,
-            Filters::Icon,
-            Filters::ExternalLink,
-            Filters::TutorialLink
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,98 +0,0 @@
-require 'rouge'
-
-module Nexmo
-  module OAS
-    module Renderer
-      class CodeLanguageAPI
-        attr_accessor :key, :label, :type, :dependencies, :unindent, :icon, :run_command
-        attr_writer :weight, :linkable, :languages, :lexer
-
-        def initialize(attributes = {})
-          @key          = attributes["key"]
-          @label        = attributes["label"]
-          @type         = attributes["type"]
-          @dependencies = attributes["dependencies"]
-          @unindent     = attributes["unindent"]
-          @icon         = attributes["icon"]
-          @run_command  = attributes["run_command"]
-          @lexer        = attributes["lexer"]
-          @languages    = attributes["languages"]
-          @weight       = attributes["weight"]
-          @linkable     = attributes["linkable"]
-        end
-
-        def weight
-          @weight || 999
-        end
-
-        def linkable?
-          return true if @linkable.nil?
-          @linkable
-        end
-
-        def lexer
-          return Rouge::Lexers::PHP.new({ start_inline: true }) if @lexer == 'php'
-          Rouge::Lexer.find(@lexer) || Rouge::Lexer.find('text')
-        end
-
-        def languages
-          @languages ||= []
-          @languages.map do |language|
-            self.class.find(language)
-          end
-        end
-
-        def self.languages
-          where_type('languages')
-        end
-
-        def self.frameworks
-          where_type('platforms')
-        end
-
-        def self.terminal_programs
-          where_type('terminal_programs')
-        end
-
-        def self.data
-          where_type('data')
-        end
-
-        def self.all
-          languages + frameworks + terminal_programs + data
-        end
-
-        def self.find(key)
-          raise 'Key is missing' unless key
-          code_language = all.detect { |lang| lang.key == key }
-          raise "Language #{key} does not exist." unless code_language
-          code_language
-        end
-
-        def self.linkable
-          all.select(&:linkable?)
-        end
-
-        def self.match?(code_language)
-          return true if code_language.nil?
-
-          route_constraint[:code_language].match?(code_language)
-        end
-
-        def self.route_constraint
-          { code_language: Regexp.new("^(#{linkable.map(&:key).compact.join('|')})$") }
-        end
-
-        private_class_method def self.where_type(type)
-          config[type].map do |key, attributes|
-            new(attributes.merge({ "key" => key, "type" => type }))
-          end
-        end
-
-        private_class_method def self.config
-          @config ||= YAML.load_file("#{API.root}/config/code_languages.yml")
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/views/code_snippets/_application_messages_dispatch.html.erb

@@ -1,9 +0,0 @@
-<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis">
-  <h5 class="Vlt-js-accordion__trigger Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
-    <%= app['use_existing'] ? 'Use your existing application' : 'Create an application' %>
-  </h5>
-
-  <div id="acc<%=id %>"  class="Vlt-js-accordion__content Vlt-accordion__content Vlt-accordion__content--noborder">
-    If you do not have an application you can <a href="/messages/code-snippets/create-an-application">create one</a>. Make sure you also <a href="/messages/code-snippets/configure-webhooks">configure your webhooks</a>.
-  </div>
-</div>

data/lib/nexmo/oas/renderer/views/code_snippets/_application_rtc.html.erb

@@ -1,41 +0,0 @@
-<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis">
-    <h5 class="Vlt-js-accordion__trigger Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
-        Create an application
-    </h5>
-
-    <div id="acc<%=id %>" class="Vlt-js-accordion__content Vlt-accordion__content Vlt-accordion__content--noborder">
-        <p>A Nexmo application contains the required configuration for your project. You can create an application
-            using the <a href="https://github.com/Nexmo/nexmo-cli">Nexmo CLI</a> (see below) or <a href="https://dashboard.nexmo.com/voice/create-application">via
-                the dashboard</a>. To learn more about applications <a href="/concepts/guides/applications">see our
-                Nexmo concepts guide</a>.</p>
-        <h4>Install the CLI</h4>
-        <pre class="highlight shell"><code>$ npm install -g nexmo-cli</code></pre>
-
-        <h4>Create an application</h4>
-        <p>Once you have the CLI installed you can use it to create a Nexmo application. Run the following command and
-            make a note of the application ID that it returns. This is the value to use in <code>NEXMO_APPLICATION_ID</code>
-            in the example below. It will also create <code>private.key</code> in the current directory which you will
-            need in the <em>Initialize your dependencies</em> step</p>
-
-        <% unless app['disable_ngrok'] %>
-        <p>Nexmo needs to connect to your local machine to access your <code>answer_url</code>. We recommend using <a
-                href="https://www.nexmo.com/blog/2017/07/04/local-development-nexmo-ngrok-tunnel-dr/">ngrok</a> to do
-            this. Make sure to change <code>demo.ngrok.io</code> in the examples below to your own ngrok URL.</p>
-        <% end %>
-
-        <pre class="highlight shell"><code>$ nexmo app:create "<%=app['name'] %>" <%=app['answer_url'] %> <%=app['event_url'] %> --keyfile=private.key --type=rtc</code></pre>
-        
-        <h4>Or to use your existing Nexmo application</h4>
-
-        <p>You will need to use an existing Nexmo application and
-            authenticate a User in order to achieve results here.</p>
-        <p>See the <a href="https://developer.nexmo.com/conversation/overview">Conversation API docs</a>
-            for information
-            on how to create an Application and Users on your backend server.</p>
-        <p>Alternatively you can review the <a href="https://developer.nexmo.com/tutorials/client-sdk-generate-test-credentials">tutorial
-                on getting started with generating an Application and
-                credentials</a>.</p>
-    </div>
-
-
-</div>