nexmo_markdown_renderer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cdefdb4aeb9fcc3285946cbe7f98a230e0d0d59d22d979fd3cb96671a800b940
+  data.tar.gz: 0b9cb71b1374181a53af2066771201f540c2acb350392a9a8021321d69ecfb12
+SHA512:
+  metadata.gz: 841558e3b4b185ffeb0360b9702367e0fdfba2c689f360ba19f913cefc2ae5f9b98b2494b11d4f057e862e380520d77904e322e89e2169486c4c6c7be94e763f
+  data.tar.gz: b31e7270ba47a9ee772ddc47574eaa5a5a526c9deceec85c6cc0d89d794633c682bd33bd126a8372c9ce09bf432738181c0c95f75c573642f8107909866fa4a4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 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,54 @@
+# Nexmo Markdown Renderer
+
+[![Build Status](https://api.travis-ci.org/Nexmo/nexmo-markdown-renderer.svg?branch=master)](https://travis-ci.org/Nexmo/nexmo-markdown-renderer/)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
+
+This gem facilitates the presentation of markdown documents in a Rails app by applying custom filters for tabs, code snippets, icons, indentation and more. It is used in the [Nexmo Developer Platform](https://developer.nexmo.com).
+
+* [Installation and Usage](#installation-and-usage)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Installation and Usage
+
+To use this gem you must install it in your application's Gemfile:
+
+```ruby
+gem 'nexmo-markdown-renderer'
+```
+
+Then run `bundle install` to install it.
+
+The gem requires an environment variable to be set of `DOCS_BASE_PATH` that should point to the top level directory of your markdown content to be rendered. For example:
+
+```
+DOCS_BASE_PATH = '/path/to/markdown`
+```
+
+Once you have installed it, you can use it by instantiating an instance of it by passing in the options you require:
+
+```ruby
+content = Nexmo::Markdown::Renderer.new()
+```
+
+Once you have instantiated an instance, you can then invoke the `#call` method with the markdown you wish to render. You can either point to a file or pass in the markdown directly:
+
+Passing in the markdown directly:
+
+```ruby
+rendered = content.call( "with markdown" )
+```
+
+Passing in a markdown file:
+
+```ruby
+rendered = content.call("/_documentation/example/example_markdown.md")
+```
+
+## Contributing
+
+We ❤️ contributions from everyone! [Bug reports](https://github.com/Nexmo/nexmo-markdown-renderer/issues), [bug fixes](https://github.com/Nexmo/nexmo-markdown-renderer/pulls) and feedback on the gem is always appreciated. Look at the [Contributor Guidelines](https://github.com/Nexmo/nexmo-markdown-renderer/blob/master/CONTRIBUTING.md) for more information.
+
+## License
+
+This project is under the [MIT LICENSE](https://github.com/Nexmo/nexmo-markdown-renderer/blob/master/LICENSE.txt)

data/config/code_languages.yml

@@ -0,0 +1,138 @@
+terminal_programs:
+  curl:
+    weight: 1
+    label: cURL
+    lexer: sh
+    icon: curl
+    run_command: 'sh {filename}'
+  cli:
+    label: CLI
+    lexer: sh
+    linkable: false
+
+languages:
+  javascript:
+    weight: 2
+    label: JavaScript
+    lexer: javascript
+    icon: javascript
+    dependencies:
+      - 'nexmo'
+
+  node:
+    weight: 2
+    label: Node.js
+    lexer: javascript
+    icon: node
+    dependencies:
+      - 'nexmo'
+    run_command: 'node {filename}'
+
+  java:
+    weight: 3
+    label: Java
+    lexer: java
+    unindent: true
+    icon: java
+    dependencies:
+      - 'com.nexmo:client:@latest'
+
+  dotnet:
+    weight: 4
+    label: .NET
+    lexer: c#
+    unindent: true
+    icon: dotnet
+    dependencies:
+      - 'Nexmo.Csharp.Client'
+  csharp:
+    weight: 4
+    label: .NET
+    lexer: c#
+    unindent: true
+    icon: dotnet
+    dependencies:
+      - 'Nexmo.Csharp.Client'
+
+  php:
+    weight: 5
+    label: PHP
+    lexer: php
+    icon: php
+    dependencies:
+      - 'nexmo/client'
+    run_command: 'php {filename}'
+
+  python:
+    weight: 6
+    label: Python
+    lexer: python
+    icon: python
+    dependencies:
+      - 'nexmo'
+    run_command: 'python {filename}'
+
+  ruby:
+    weight: 7
+    label: Ruby
+    lexer: ruby
+    icon: ruby
+    dependencies:
+      - 'nexmo'
+    run_command: 'ruby {filename}'
+
+  kotlin:
+    weight: 8
+    label: Kotlin
+    lexer: java
+    icon: android
+    dependencies: []
+
+  android:
+    weight: 9
+    label: Java
+    lexer: java
+    icon: android
+    dependencies: []
+
+  swift:
+    weight: 10
+    label: Swift
+    lexer: swift
+    icon: ios
+    dependencies: []
+
+  objective_c:
+    weight: 11
+    label: Objective-C
+    lexer: ObjectiveC
+    icon: ios
+    dependencies: []
+
+platforms:
+  ios:
+    languages:
+      - swift
+      - objective_c
+  android:
+    languages:
+      - java
+  web:
+    languages:
+      - javascript
+
+data:
+  ncco:
+    label: NCCO
+    lexer: json
+    linkable: false
+  json:
+    weight: 1
+    label: JSON
+    lexer: json
+    linkable: false
+  xml:
+    weight: 2
+    label: XML
+    lexer: xml
+    linkable: false

data/config/dynamic_content.yml

@@ -0,0 +1 @@
+dynamic_content_example: the future

data/config/locales/en.yml

@@ -0,0 +1,176 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `::I18n.t`:
+#
+#     ::I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   'true': 'foo'
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+
+  menu:
+    message-search: Message Search
+    messaging: Messaging
+    voice: Voice
+    voice-api: Voice API
+    sip: SIP
+    account: Account
+    number-insight: Number Insight
+    stitch: Stitch
+    client-sdk: Client SDK
+    conversation: Conversation
+    user: User
+    member: Member
+    event: Event
+    leg: Leg
+    in-app-messaging: In-App Messaging
+    in-app-voice: In-App Voice
+    in-app-video: In-App Video
+    messages: Messages API
+    dispatch: Dispatch API
+    reports: Reports
+    us-short-codes: US Short Codes
+    sms: SMS
+    mms: MMS
+    guides: Guides
+    quickstarts: Quickstarts
+    tutorials: Tutorials
+    conversion-api: Conversion API
+    concepts: Concepts
+    code-snippets: Code Snippets
+    verify: Verify
+    configure: Configure
+    contribute: Contribute
+    structure: Structure
+    sdk-documentation: SDK Documentation
+    android: Android
+    ios: iOS
+    javascript: JavaScript
+    javascript-quickstart: JS Quickstart
+    redact: Redact
+    audit: Audit
+    numbers: Numbers
+    secret-management: Secret Management
+    external-accounts: External Accounts API
+    vonage-business-cloud: Vonage Business Cloud
+    smart-numbers: Smart Numbers
+    integration-suite: Vonage Integration Suite
+    vbc-apis: VBC APIs
+    account-api: Account API
+    extension-api: Extension API
+    reports-api: Reports API
+    user-api: User API
+    call-recording-api: Call Recording API
+    getting-started: Getting Started
+    setup: Setup
+    configuration: Configuration
+
+    administration: Administration
+    tasks: Tasks
+    application: Application
+    product-lifecycle: Product Lifecycle
+    whatsapp: WhatsApp
+    messenger: Facebook Messenger
+    viber: Viber Service Messages
+    subaccounts: Subaccounts (Beta)
+    use-cases: Use Cases
+  layouts:
+    partials:
+      header:
+        documentation: Documentation
+        tutorials: Tutorials
+        api-reference: API Reference
+        sdks-and-tools: SDKs & Tools
+        community: Community
+        extend: Extend
+        hiring: We're hiring
+        support: Support
+        sign-in: Sign In
+        try-it: Try it free
+        get_an_api_key: Get an API key
+        start_building: Start building for free
+
+  code_snippets:
+    copy_to_clipboard: Copy to Clipboard
+    use_your_app: Use your existing application
+    create_an_app: Create an application
+    install_the_cli: Install the CLI
+    nexmo_application_contains_html: >-
+      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>.
+    once_you_have_the_cli_installed_html: >-
+      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
+    nexmo_needs_to_connect_html: >-
+      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.
+    write_code:
+      view_full_source: View full source
+      write_the_code: Write the code
+    configure_client:
+      initialize_dependencies: Initialize your dependencies
+    application_messages_dispatch:
+      no_application_html: 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>.
+    application_rtc:
+      use_your_existing_app: Or to use your existing Nexmo application
+      use_an_app_to_authenticate: You will need to use an existing Nexmo application and authenticate a User in order to achieve results here.
+      see_the_docs_html: >-
+        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.
+      alternatively_you_can_review_html: >-
+        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>.
+
+  filters:
+    generate_your_jwt: Generate your JWT
+    install_dependencies: Install dependencies
+    prerequisites: Prerequisites
+
+  services:
+    code_snippet_renderer:
+      add_instructions_to_file: 'Add the following to `%{file}`:'
+      add_instructions_to_code: 'Add the following to your code:'
+      create_instructions: 'Create a file named `%{filename}` and add the following code:'
+      run_command: >-
+        ## Run your code
+          Save this file to your machine and run it:
+            <pre class='highlight bash run-command'><code>%{command}</code></pre>
+
+      curl:
+        only_permitted_dependency: The only permitted curl dependency is `jwt`
+        text: >-
+          Execute the following command at your terminal prompt to create the <a href="/concepts/guides/authentication#json-web-tokens-jwt">JWT</a> for authentication:
+      java:
+        add_instructions: 'Add the following to the `main` method of the `%{file}` class:'
+        create_instructions: 'Create a class named `%{file}` and add the following code to the `main` method:'
+        run_command: >-
+          ## Run your code
+            We can use the `application` plugin for Gradle to simplify the running of our application.
+             Update your `build.gradle` with the following:
+
+             ```groovy
+            apply plugin: 'application'
+            mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''
+            ```
+
+            Run the following `gradle` command to execute your application, replacing `%{chomped_package}` with the package containing `%{file}`:
+
+            <pre class="highlight bash run-command"><code>gradle run -Pmain=%{main}</code></pre>

data/lib/nexmo_markdown_renderer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+GEM_ROOT = File.expand_path("../..", __FILE__)
+require 'banzai'
+require 'octicons_helper'
+require 'nokogiri'
+require 'open-uri'
+require 'active_model'
+require 'i18n'
+require 'nexmo_markdown_renderer/initializers/redcarpet'
+require 'nexmo_markdown_renderer/initializers/i18n'
+require 'nexmo_markdown_renderer/core_ext/string'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/base'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/android'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/curl'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/dotnet'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/java'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/javascript'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/kotlin'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/objective_c'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/php'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/python'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/ruby'
+require 'nexmo_markdown_renderer/services/code_snippet_renderer/swift'
+Dir[File.join(__dir__, 'nexmo_markdown_renderer/services', '*.rb')].each { |file| require_relative file }
+Dir[File.join(__dir__, 'nexmo_markdown_renderer/models', '*.rb')].each { |file| require_relative file }
+Dir[File.join(__dir__, 'nexmo_markdown_renderer/filters', '*.rb')].each { |file| require_relative file }
+Dir[File.join(__dir__, 'nexmo_markdown_renderer/filters/i18n', '*.rb')].each { |file| require_relative file }
+require_relative 'nexmo_markdown_renderer/markdown_renderer'

data/lib/nexmo_markdown_renderer/cli.rb

@@ -0,0 +1,13 @@
+require "thor"
+require_relative "../nexmo_markdown_renderer"
+require_relative "./initializers/doc_finder"
+
+module Nexmo::Markdown
+  class CLI < Thor
+
+    desc "renders FILE", "passes FILE throught the pipeline and renders it as html"
+    def render(file)
+      puts Nexmo::Markdown::Renderer.new.call(File.read("#{ENV['DOCS_BASE_PATH']}/#{file}")).to_s
+    end
+  end
+end