station 0.0.113 → 0.0.114

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/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,53 @@
+class OrbitFeedbackNotifier
+  CONFIG = YAML.load_file("#{Rails.configuration.docs_base_path}/config/business_info.yml")
+
+  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',
+        source_host: CONFIG['base_url'],
+        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

@@ -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/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"
@@ -39,7 +38,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 +60,6 @@ $(document).ready(function() {
   Scroll()
   CodeSnippetEvents()
   new Sidenav()
-  Spotlight()
   new Careers
   new LocaleSwitcher
 

data/lib/nexmo_developer/config/routes.rb

@@ -57,8 +57,6 @@ Rails.application.routes.draw do
 
   get '(/:locale)/documentation', to: 'static#documentation', constraints: LocaleConstraint.new, as: :documentation
 
-  post '/spotlight', to: 'static#spotlight'
-
   get '/community/slack', to: 'slack#join'
   post '/community/slack', to: 'slack#invite'
 

data/lib/nexmo_developer/lib/tasks/cache.rake

@@ -1,6 +1,6 @@
 namespace :cache do
   desc "Clear Rails' redis cache"
-  task 'clear': :environment do
+  task clear: :environment do
     Rails.cache.clear
   end
 end

data/lib/nexmo_developer/lib/tasks/careers.rake

@@ -1,6 +1,6 @@
 namespace :careers do
   desc 'Expire careers cache'
-  task 'expire_cache': :environment do
+  task expire_cache: :environment do
     p 'Expiring cache...'
     Greenhouse.expire_cache
     p 'Done'

data/lib/nexmo_developer/lib/tasks/ci.rake

@@ -2,7 +2,7 @@ require_relative '../common_errors'
 
 namespace :ci do
   desc 'Verify all pages to make sure that no exceptions are thrown'
-  task 'verify_pages': :environment do
+  task verify_pages: :environment do
     document_paths =
       [
         "#{Rails.configuration.docs_base_path}/_documentation/en/**/*.md",
@@ -24,7 +24,7 @@ namespace :ci do
   end
 
   desc 'Verify side navigation to make sure every page has valid YAML metadata'
-  task 'verify_navigation': :environment do
+  task verify_navigation: :environment do
     session = ActionDispatch::Integration::Session.new(Rails.application)
     res = session.get '/documentation'
 
@@ -35,7 +35,7 @@ namespace :ci do
   end
 
   desc 'Render all OAS based API references'
-  task 'verify_oas_reference': :environment do
+  task verify_oas_reference: :environment do
     session = ActionDispatch::Integration::Session.new(Rails.application)
     OpenApiConstraint.list.each do |name|
       res = session.get "/api/#{name}"
@@ -48,7 +48,7 @@ namespace :ci do
   end
 
   desc 'Ensure all OAS error URLS resolve'
-  task 'verify_error_urls_resolve': :environment do
+  task verify_error_urls_resolve: :environment do
     session = ActionDispatch::Integration::Session.new(Rails.application)
     session.host! 'localhost' unless Rails.env.test?
 
@@ -114,7 +114,7 @@ namespace :ci do
     end
   end
 
-  task 'check_word_blocklist': :environment do
+  task check_word_blocklist: :environment do
     markdown_files =
       [
         "#{Rails.configuration.docs_base_path}/_documentation/en/**/*.md",
@@ -145,7 +145,7 @@ namespace :ci do
     end
   end
 
-  task 'check_ruby_version': :environment do
+  task check_ruby_version: :environment do
     # We treat .ruby-version as the canonical source
     ruby_version = File.read('.ruby-version').strip
 
@@ -154,7 +154,7 @@ namespace :ci do
     gemfile_version = gemfile.match(/RUBY VERSION.*ruby (\d+\.\d+\.\d+).*BUNDLED WITH/m)[1].strip
 
     # How about Docker?
-    docker = File.read('Dockerfile')
+    docker = File.read('../../Dockerfile')
     docker_version = docker.match(/FROM ruby:(\d+\.\d+\.\d+).*/)[1].strip
 
     errors = []

data/lib/nexmo_developer/lib/tasks/diff.rake

@@ -1,6 +1,6 @@
 namespace :diff do
   desc 'Build files for comparison'
-  task 'execute': :environment do
+  task execute: :environment do
     puts 'Building base'.colorize(:yellow)
     Rake::Task['diff:build:base'].invoke
 
@@ -15,24 +15,24 @@ namespace :diff do
   end
 
   desc 'Build files for comparison'
-  task 'build:base': :environment do
+  task 'build:base' => :environment do
     Diff.generate(mode: 'base')
   end
 
   desc 'Build files for comparison'
-  task 'build:compare': :environment do
+  task 'build:compare' => :environment do
     Diff.generate(mode: 'compare')
   end
 
   desc 'Build files for comparison'
-  task 'compare:cli': :environment do
+  task 'compare:cli' => :environment do
     diff = Diff.new
     diff.diff(:color)
     diff.report_cli
   end
 
   desc 'Build files for comparison'
-  task 'compare:pr': :environment do
+  task 'compare:pr' => :environment do
     diff = Diff.new
     diff.diff(:text)
     diff.report_pull_request

data/lib/nexmo_developer/lib/tasks/documentation.rake

@@ -1,6 +1,6 @@
 namespace :documentation do
   desc 'Verify all pages have meta_title and description keys'
-  task 'check_keys': :environment do
+  task check_keys: :environment do
     documentation_path = "#{Rails.configuration.docs_base_path}/_documentation/**/*.md"
     documents = []
 

data/lib/nexmo_developer/lib/tasks/generate_search_terms.rake

@@ -21,7 +21,7 @@ namespace :search_terms do
   end
 
   desc 'Clear the index in Algolia'
-  task 'algolia:clear': :environment do
+  task 'algolia:clear' => :environment do
     unless ENV['ALGOLIA_APPLICATION_ID']
       puts 'Not rebuilding search index, Algolia Application ID not set'
       next
@@ -32,7 +32,7 @@ namespace :search_terms do
   end
 
   desc 'Refresh the Algolia index'
-  task 'algolia:refresh': :environment do
+  task 'algolia:refresh' => :environment do
     Rake::Task['search_terms:algolia:clear'].invoke
     Rake::Task['search_terms:algolia:generate'].invoke
   end

data/lib/nexmo_developer/lib/tasks/links.rake

@@ -2,7 +2,7 @@ require 'terminal-table'
 
 namespace :links do
   desc 'Generate a report of all links FROM a given page'
-  task 'report_outbound': :environment do
+  task report_outbound: :environment do
     ARGV.each { |a| task a.to_sym }
     filter = ARGV[1]
     table = Terminal::Table.new do |t|
@@ -18,7 +18,7 @@ namespace :links do
   end
 
   desc 'Generate a report of all links TO a given page'
-  task 'report_inbound': :environment do
+  task report_inbound: :environment do
     ARGV.each { |a| task a.to_sym }
     filter = ARGV[1]
     table = Terminal::Table.new do |t|
@@ -34,21 +34,21 @@ namespace :links do
   end
 
   desc 'Show all pages with no outbound links'
-  task 'no_links_outbound': :environment do
+  task no_links_outbound: :environment do
     get_links_on_a_page("#{Rails.configuration.docs_base_path}/_documentation/**/*.md").each do |from, to|
       puts from if to.empty?
     end
   end
 
   desc 'Show all pages with no inbound links'
-  task 'no_links_inbound': :environment do
+  task no_links_inbound: :environment do
     get_links_to_a_page("#{Rails.configuration.docs_base_path}/_documentation/**/*.md").each do |to, from|
       puts to if from.empty?
     end
   end
 
   desc 'Generate graph of all links out of pages'
-  task 'graph_outbound': :environment do
+  task graph_outbound: :environment do
     ARGV.each { |a| task a.to_sym }
     filter = ARGV[1]
     additional_title = ''
@@ -69,7 +69,7 @@ namespace :links do
   end
 
   desc 'Generate graph of all links to pages'
-  task 'graph_inbound': :environment do
+  task graph_inbound: :environment do
     ARGV.each { |a| task a.to_sym }
     filter = ARGV[1]
     additional_title = ''