station 0.0.113 → 0.0.120

data/lib/nexmo_developer/Runbook.md

@@ -4,7 +4,7 @@ Nexmo Developer is a simple Rails application with a mounted Sinatra app that ha
 
 # Deployment
 
-NDP is hosted in Heroku and is automatically deployed every time a branch is merged into master via a Github integration.
+NDP is hosted in Heroku and is automatically deployed every time a branch is merged into main via a Github integration.
 In case you want to force a deploy, you can always deploy NDP from [Heroku's dashboard](https://dashboard.heroku.com/apps/nexmo-developer).
 
 ## Required Resources
@@ -39,7 +39,7 @@ In case NDP is Down:
 
 * Check if [Heroku](https://status.heroku.com/) is having an outage. Unfortunately, if that is the case then there isn't much you can do about it (at least for now).
 * Otherwise, check the [logs](#logs) or [Bugsnag](#error-monitoring-and-reporting) to see if any issues show up and try to reproduce it locally.
-If the issue is related to the latest deploy, just revert the offending commits and the deploy again while you work on a fix. Once a fix is ready, open a Pull Request, make sure that it works in the corresponding Review App and finally after all the checks pass merge it into master.
+If the issue is related to the latest deploy, just revert the offending commits and the deploy again while you work on a fix. Once a fix is ready, open a Pull Request, make sure that it works in the corresponding Review App and finally after all the checks pass merge it into main.
 
 # Available configuration options
 
@@ -53,7 +53,7 @@ To enable the Search form locally, the `ALGOLIA_SEARCH_KEY` environment variable
 
 # Common issues when running NDP locally
 
-NDP can be run locally either directly or using Docker, for more information about how to run it see the [Readme](https://github.com/Nexmo/nexmo-developer/blob/master/README.md#running-locally). When using docker, re-building the image should fix the following issues
+NDP can be run locally either directly or using Docker, for more information about how to run it see the [Readme](https://github.com/Nexmo/nexmo-developer/blob/main/README.md#running-locally). When using docker, re-building the image should fix the following issues
 
 * `Could not find definition '<insert_file_here>' in '<path>'`: set the right `OAS_PATH`  in `.env`, check `.env.example` for the default value.
 
@@ -66,4 +66,4 @@ NDP can be run locally either directly or using Docker, for more information abo
 
 * Webpacker errors:
     * `The engine "node" is incompatible with this module. Expected version...` We use [nvm](https://github.com/nvm-sh/nvm) as node's version manage, check that the right version of node is installed (specified in `.nvmrc`) and run `nvm use <version>`.
-    * Make sure that all the packages are install by running `yarn install`
+    * Make sure that all the packages are installed by running `yarn install`

data/lib/nexmo_developer/app/controllers/jobs_controller.rb

@@ -8,19 +8,19 @@ class JobsController < ApplicationController
       if params['ref'] == 'refs/heads/master'
         url = "https://api.travis-ci.org/repo/#{ENV['TRAVIS_REPO_ID']}/requests"
         RestClient.post(url, {
-          "request": {
-            "branch": 'master',
-            "config": {
-              "script": 'bundle exec rake diff:execute',
-              "env": {
-                "SSH_KEY_REQUIRED": true,
+          request: {
+            branch: 'master',
+            config: {
+              script: 'bundle exec rake diff:execute',
+              env: {
+                SSH_KEY_REQUIRED: true,
               },
             },
           },
         }.to_json, {
           content_type: :json,
           accept: :json,
-          'Authorization': "token #{ENV['TRAVIS_TOKEN']}",
+          Authorization: "token #{ENV['TRAVIS_TOKEN']}",
           'Travis-API-Version': '3',
         })
 

data/lib/nexmo_developer/app/controllers/static_controller.rb

@@ -45,6 +45,8 @@ class StaticController < ApplicationController
       migrate_tropo
     end
 
+    @frontmatter = @landing_config
+    @document_title = @landing_config['title']
     @navigation = yaml_name.to_sym
     render layout: 'landing'
   end
@@ -145,19 +147,6 @@ class StaticController < ApplicationController
     end
   end
 
-  def spotlight
-    response = RestClient.post(
-      'https://hooks.zapier.com/hooks/catch/1936493/oyzjr4i/',
-      params.permit(:name, :email_address, :background, :outline, :previous_content).to_h
-    )
-
-    if response.code == 200
-      head :ok
-    else
-      head :unprocessable_entity
-    end
-  end
-
   def blog_cookie
     # This is the first touch time so we only want to set it if it's not already set
     set_utm_cookie('ft', Time.now.getutc.to_i) unless cookies[:ft]

data/lib/nexmo_developer/app/models/feedback/feedback.rb

@@ -26,6 +26,8 @@ module Feedback
     end
 
     def notify
+      OrbitFeedbackNotifier.call(self) if !owner.nil? && owner.email.present?
+
       return unless ENV['SLACK_WEBHOOK']
 
       FeedbackSlackNotifier.call(self)

data/lib/nexmo_developer/app/models/tutorial/file_loader.rb

@@ -9,13 +9,7 @@ class Tutorial::FileLoader
   end
 
   def path
-    @path ||= Nexmo::Markdown::DocFinder.find(
-      root: root,
-      document: doc_name,
-      language: ::I18n.locale,
-      code_language: code_language,
-      format: format
-    ).path
+    @path ||= doc.path
   end
 
   def content
@@ -25,4 +19,14 @@ class Tutorial::FileLoader
   def yaml
     @yaml ||= YAML.safe_load(content)
   end
+
+  def doc
+    @doc ||= Nexmo::Markdown::DocFinder.find(
+      root: root,
+      document: doc_name,
+      language: ::I18n.locale,
+      code_language: code_language,
+      format: format
+    )
+  end
 end

data/lib/nexmo_developer/app/models/tutorial/task.rb

@@ -1,5 +1,7 @@
 class Tutorial::Task
-  attr_reader :name, :code_language, :current_step
+  extend ActiveModel::Naming
+
+  attr_reader :name, :code_language, :current_step, :errors
 
   delegate :yaml, :path, to: :@file_loader
 
@@ -10,6 +12,8 @@ class Tutorial::Task
     @code_language = code_language
     @current_step = current_step
     @file_loader = load_file!
+
+    @errors = ActiveModel::Errors.new(self)
   end
 
   def load_file!
@@ -21,6 +25,14 @@ class Tutorial::Task
     )
   end
 
+  def validate!
+    unless ['introduction', 'conclusion', 'prerequisites'].include? name
+      path.present?
+    end
+  rescue ::Nexmo::Markdown::DocFinder::MissingDoc => _e
+    @errors.add(:name, message: "could not find the file: #{name}")
+  end
+
   def active?
     @name == @current_step
   end
@@ -55,4 +67,18 @@ class Tutorial::Task
   def description
     @description || yaml['description']
   end
+
+  # The following methods are needed for validation
+
+  def read_attribute_for_validation(attr)
+    send(attr)
+  end
+
+  def self.human_attribute_name(attr, _options = {})
+    attr
+  end
+
+  def self.lookup_ancestors
+    [self]
+  end
 end

data/lib/nexmo_developer/app/presenters/head.rb

@@ -26,11 +26,15 @@ class Head
   end
 
   def title
-    @title ||= config.fetch('title') do
+    @title ||= title_from_frontmatter || config.fetch('title') do
       raise "You must provide a 'title' parameter in header_meta.yml"
     end
   end
 
+  def title_from_frontmatter
+    @frontmatter && (@frontmatter['meta_title'] || @frontmatter['title'])
+  end
+
   def description
     @description ||= Description.new(config: config, frontmatter: frontmatter).description
   end

data/lib/nexmo_developer/app/presenters/improve_page_presenter.rb

@@ -4,7 +4,7 @@ class ImprovePagePresenter
   end
 
   def github_url
-    @github_url ||= "https://github.com/#{docs_repo}/blob/#{ENV.fetch('branch', 'master')}/#{path_to_url}"
+    @github_url ||= "https://github.com/#{docs_repo}/blob/#{ENV.fetch('branch', 'main')}/#{path_to_url}"
   end
 
   def docs_repo

data/lib/nexmo_developer/app/services/orbit_feedback_notifier.rb

@@ -0,0 +1,50 @@
+class OrbitFeedbackNotifier
+  def self.call(feedback)
+    new(feedback).post!
+  end
+
+  def initialize(feedback)
+    @feedback = feedback
+  end
+
+  def params
+    @params ||= {
+      id: @feedback.id,
+      email: @feedback.owner.email,
+      resource: "Offered #{@feedback.sentiment} feedback on #{@feedback.resource.uri}",
+    }
+  end
+
+  def uri
+    @uri ||= URI("https://app.orbit.love/api/v1/#{ENV['ORBIT_WORKSPACE_ID']}/activities")
+  end
+
+  def post!
+    return unless ENV['ORBIT_WORKSPACE_ID']
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    req = Net::HTTP::Post.new(uri)
+    req['Accept'] = 'application/json'
+    req['Content-Type'] = 'application/json'
+    req['Authorization'] = "Bearer #{ENV['ORBIT_API_KEY']}"
+
+    req.body = {
+      activity: {
+        activity_type: 'adp:feedback',
+        key: "adp-feedback-#{params[:id]}",
+        title: 'Offered feedback on ADP',
+        description: params[:resource],
+        occurred_at: Time.zone.now.iso8601,
+      },
+      identity: {
+        source: 'email',
+        email: params[:email],
+      },
+    }
+
+    req.body = req.body.to_json
+
+    http.request(req)
+  end
+end

data/lib/nexmo_developer/app/services/translator/files_list_coordinator.rb

@@ -13,7 +13,7 @@ module Translator
     end
 
     def files
-      @files ||= `(git fetch origin master:master) && (git log --since="#{@days} days" --name-only --oneline --diff-filter=ACM --pretty=format: master #{Rails.configuration.docs_base_path}/_documentation/en #{Rails.configuration.docs_base_path}/_tutorials/en #{Rails.configuration.docs_base_path}/_use_cases/en) | uniq | awk 'NF'`.split("\n")
+      @files ||= `(git fetch origin main:main) && (git log --since="#{@days} days" --name-only --oneline --diff-filter=ACM --pretty=format: main #{Rails.configuration.docs_base_path}/_documentation/en #{Rails.configuration.docs_base_path}/_tutorials/en #{Rails.configuration.docs_base_path}/_use_cases/en) | uniq | awk 'NF'`.split("\n")
     end
 
     def process_files(files)

data/lib/nexmo_developer/app/views/contribute/guides/landing-pages.md

@@ -544,13 +544,3 @@ The `warning_callout` content block provides an element to render a warning mess
     content: # Warning message goes here
 
 ```
-
-### Write for Nexmo
-
-The `write_for_nexmo` content block will provide a call to action element to Write for Nexmo with a Developer Spotlight graphic on the left-hand side and text advertising the Write for Nexmo program on the left-hand side.
-
-```yaml
-
-- type: write_for_nexmo
-
-```

data/lib/nexmo_developer/app/views/contribute/guides/markdown-guide.md

@@ -102,7 +102,7 @@ Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia od
 
 **Inline styles**
 
-Text can be **bold**, _italic_ or **_bold and italic_**. You could use ~~strikethrough~~ but please don't.
+Text can be **bold**, *italic* or ***bold and italic***. You could use ~~strikethrough~~ but please don't.
 
 You can define inline `code block` with backticks.
 
@@ -122,7 +122,7 @@ They auto-magically color when you use verbs like [POST] or [DELETE]
 |
 | Here is some hidden content.
 |
-| Markdown _still_ works `here`!
+| Markdown *still* works `here`!
 |
 | Nullam id dolor id nibh ultricies vehicula ut id elit. Donec ullamcorper nulla non metus auctor fringilla. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.
 
@@ -131,7 +131,7 @@ They auto-magically color when you use verbs like [POST] or [DELETE]
 |
 | Here is some hidden content.
 |
-| Markdown _still_ works `here`!
+| Markdown *still* works `here`!
 |
 | Nullam id dolor id nibh ultricies vehicula ut id elit. Donec ullamcorper nulla non metus auctor fringilla. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.
 ````
@@ -359,44 +359,6 @@ If you are adding support for a changed header this would normally go above the
 
 [Go to the anchor](#anchor-example). I've placed at the top of this document.
 
-## Screenshots
-
-Webpage screenshots can be scripted so that they only require sourcing once. Define a screenshot as such:
-
-````
-```screenshot
-script: app/screenshots/webhook-url-for-delivery-receipt.js
-```
-````
-
-Run the following command:
-
-```
-$ rake screenshots:new
-```
-
-This changes the original source document to add an `image` value pointing to the screenshot:
-
-````
-```screenshot
-script: app/screenshots/webhook-url-for-delivery-receipt.js
-image: public/assets/screenshots/da5f952d465355c19eb888fa1049844b31e090c2.png
-```
-````
-
-You can also update all examples by running the following command:
-
-```
-$ rake screenshots:all
-```
-
-Here is the example of the final rendered output:
-
-```screenshot
-script: app/screenshots/webhook-url-for-delivery-receipt.js
-image: public/assets/screenshots/da5f952d465355c19eb888fa1049844b31e090c2.png
-```
-
 ## Audio (custom plugin)
 
 The HTML `<audio>` element can be utilised in Markdown with the following syntax:

data/lib/nexmo_developer/app/views/contribute/guides/platform.md

@@ -145,7 +145,6 @@ Frontmatter | No | [Implicit] | Strips frontmatter from documents
 PHPInliner | No | [Implicit] | Fixes a quirk with our code parser that requires PHP code to have `<?php` at the start. This filter adds an option onto PHP code examples that makes this not required.
 InlineEscape | No | [Extended] | Allows for escaping of inline code where normally the internals would be processes by the markdown. For example this isn't turned into a ``[label]`` when surrounded by two backticks.
 BlockEscape | No | [Extended] | Allows for escaping of code fences where normally the internals would be processes by the markdown.
-Screenshot | No | [Plugin] | Allows for screenshots be put into documentation that are captured by a headless browser so they can be easily refreshed.
 Anchor | No | [Extended] | Useful for when a title changes, an explicit anchor can be added and renders a non-visible anchor link to the same content.
 Audio | No | [Extended] | Used to embed audio examples using the `<audio>` element.
 Tooltip | No | [Extended] | Allows for ^[Toolips](Hello world!) to be added with a markdown-style syntax.

data/lib/nexmo_developer/app/views/layouts/documentation.html.erb

@@ -5,6 +5,12 @@
   <body class="Nxd-template" data-push-state-root="<%= canonical_path %>">
     <%= render partial: 'layouts/partials/header' %>
     <div id="Vlt-sidenav" class="Vlt-sidenav Nxd-sidenav Vlt-sidenav--animate Vlt-sidenav--rounded">
+      <div class="Vlt-sidenav__block Vlt-sidenav__block--logo">
+        <div id="Vlt-sidenav-collapse-trigger" class="Vlt-sidenav__collapse">
+          <svg class="Vlt-sidenav__collapse__close"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-chevron-left"></use></svg>
+          <svg class="Vlt-sidenav__collapse__open"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-menu"></use></svg>
+        </div>
+      </div>
       <div class="Vlt-sidenav__scroll">
         <nav class="sidenav" id="sidenav" data-active="<%= active_sidenav_item %>" aria-label="Documentation">
           <% cache_unless params[:namespace].present?, ['sidenav', I18n.locale] do %>

data/lib/nexmo_developer/app/views/layouts/partials/_sidenav_subitem.html.erb

@@ -14,6 +14,9 @@
     <% end %>
   <% elsif sidenav_subitem.collapsible? %>
     <li class="js--collapsible navigation-item--<%= sidenav_subitem.title.parameterize %> navigation-item">
+      <% if sidenav_subitem.label? %>
+        <%= link_to(sidenav_subitem.label, sidenav_subitem.link_url, class: "#{sidenav_subitem.css_classes}", role: 'link') %>
+      <% end %>
       <a class="Vlt-sidemenu__trigger" href="/concepts" role="link">
         <span class="Vlt-sidemenu__label"><%= sidenav_subitem.title %></span>
       </a>

data/lib/nexmo_developer/app/webpacker/javascript/components/jwt_generator/JwtGenerator.vue

@@ -146,7 +146,7 @@ export default {
       } else if (this.applicationId) {
         message = 'Next, provide a Private Key';
       } else {
-        message = '<h4>Use your <code>private key</code> and <code>application_id</code> to create a JWT for your Nexmo Application</h4>The JWT is generated on the client-side so your private key <strong>never leaves your browser</strong>.';
+        message = '<h4>Use your <code>private key</code> and <code>application_id</code> to create a JWT for your Vonage Application</h4>The JWT is generated on the client-side so your private key <strong>never leaves your browser</strong>.';
       }
       return message;
     },

data/lib/nexmo_developer/app/webpacker/javascript/sidenav/index.js

@@ -170,6 +170,7 @@ export default class Sidenav {
     this.domNode = document.getElementById('sidenav');
     this.mobileTrigger = document.getElementById('Vlt-sidenav-mobile-trigger');
     this.container = document.getElementById('Vlt-sidenav');
+    this.collapseTrigger = document.getElementById('Vlt-sidenav-collapse-trigger');
 
     if (this.domNode) {
       this.buildMenu();
@@ -185,6 +186,7 @@ export default class Sidenav {
     this.domNode.addEventListener('menuClosed', this.closeOpenedMenu.bind(this));
     this.mobileTrigger.addEventListener('click', this.mobileHandler.bind(this));
     this.mobileTrigger.addEventListener('touchstart', this.mobileHandler.bind(this));
+    this.collapseTrigger.addEventListener('click', this.collapseHandler.bind(this));
 
     document.querySelector('body').addEventListener('click', this.closeMobileMenu.bind(this));
     document.querySelector('body').addEventListener('touchstart', this.closeMobileMenu.bind(this));
@@ -242,6 +244,21 @@ export default class Sidenav {
     }
   }
 
+  collapseHandler(event) {
+    event.preventDefault();
+    event.stopPropagation();
+
+    this.container.classList.add('Vlt-sidenav--animate');
+
+    if (this.container.classList.contains('Vlt-sidenav_visible')) {
+      this.container.classList.remove('Vlt-sidenav_visible');
+    } else if (this.container.classList.contains('Vlt-sidenav--collapsed')) {
+      this.container.classList.remove('Vlt-sidenav--collapsed');
+    } else {
+      this.container.classList.add('Vlt-sidenav--collapsed');
+    }
+  }
+
   closeMobileMenu(event) {
     if (!this.domNode.contains(event.target)) {
       this.container.classList.remove('Vlt-sidenav_visible');

data/lib/nexmo_developer/app/webpacker/packs/application.js

@@ -7,7 +7,6 @@
 // To reference this file, add <%= javascript_pack_tag 'application' %> to the appropriate
 // layout file, like app/views/layouts/application.html.erb
 
-import '@babel/polyfill'
 import '@vonagevolta/volta2/js/addons/prism'
 
 import Rails from "@rails/ujs"
@@ -20,8 +19,7 @@ require.context('../fonts', true);
 require.context('@vonagevolta/volta2/images/logos', true)
 require.context('@vonagevolta/volta2/dist/symbol', true)
 
-require('chartkick');
-require('chart.js');
+require('chartkick/chart.js');
 require('jquery');
 require('clipboard');
 require('underscore');
@@ -39,7 +37,6 @@ import GithubCards from '../javascript/github_cards'
 import VoltaTabbedExamples from '../javascript/volta_tabbed_examples'
 import Format from '../javascript/format'
 import Scroll from '../javascript/scroll'
-import Spotlight from '../javascript/spotlight'
 import Notices from '../javascript/notices'
 import Feedback from '../javascript/components/feedback/Feedback.vue'
 import JwtGenerator from '../javascript/components/jwt_generator/JwtGenerator.vue'
@@ -62,7 +59,6 @@ $(document).ready(function() {
   Scroll()
   CodeSnippetEvents()
   new Sidenav()
-  Spotlight()
   new Careers
   new LocaleSwitcher