station 0.0.109 → 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/assets/config/manifest.js

@@ -1,5 +1,2 @@
-//= link_tree ../images
-//= link_directory ../regex .rb
 //= link application.js
-//= link application.css
-//= link stats.js
+//= link application.css

data/lib/nexmo_developer/app/assets/javascripts/application.js

@@ -1,3 +1,4 @@
+
 // This is a manifest file that'll be compiled into application.js, which will include all the files
 // listed below.
 //
@@ -10,10 +11,4 @@
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
-//= require jquery
-//= require jquery-scrolltofixed
-//= require clipboard
-//= require underscore
-//= require gmaps/google
-//= require javascripts/nexmo-oas-renderer
-//= require mermaid
+//= require javascripts/nexmo-oas-renderer

data/lib/nexmo_developer/app/assets/stylesheets/application.css

@@ -1 +1 @@
-//= require stylesheets/nexmo-oas-renderer
+//= require stylesheets/nexmo-oas-renderer

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

@@ -1,6 +1,5 @@
 class DashboardController < ApplicationController
   before_action :authenticate_admin!
-  before_action :set_additional_scripts
 
   def stats
     @feedbacks = Feedback::Feedback.created_between(created_after, created_before)
@@ -104,10 +103,6 @@ class DashboardController < ApplicationController
 
   private
 
-  def set_additional_scripts
-    @additional_scripts = ['stats']
-  end
-
   def ignore_languages
     return params[:ignore].split(',') if params[:ignore].present?
 

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
@@ -113,7 +115,9 @@ class StaticController < ApplicationController
   end
 
   def robots
-    render 'robots.txt'
+    respond_to do |format|
+      format.any { render plain: 'robots', layout: false, content_type: 'text/plain' }
+    end
   end
 
   def team
@@ -143,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,16 +4,19 @@ 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
 
-  private
-
-  def path_to_url
-    @document_path&.gsub("#{Rails.configuration.docs_base_path}/", '')
+  def docs_repo
+    @docs_repo ||= begin
+      path_to_url.start_with?('lib/nexmo_developer/app/') ? 'nexmo/station' : YAML.safe_load(File.open("#{Rails.configuration.docs_base_path}/config/business_info.yml"))['docs_repo']
+    end
   end
 
-  def docs_repo
-    @docs_repo ||= YAML.safe_load(File.open("#{Rails.configuration.docs_base_path}/config/business_info.yml"))['docs_repo']
+  def path_to_url
+    @path_to_url ||= begin
+      @document_path&.gsub!("#{Rails.configuration.docs_base_path}/", '')
+      @document_path.start_with?('app/views') ? @document_path.prepend('lib/nexmo_developer/') : @document_path
+    end
   end
 end

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/services/translator/smartling/api/download_file.rb

@@ -18,7 +18,12 @@ module Translator
         def uri
           @uri ||= begin
             uri = URI("https://api.smartling.com/files-api/v2/projects/#{@project_id}/locales/#{@locale_id}/file")
-            uri.query = URI.encode_www_form({ 'fileUri' => @file_uri, 'retrievalType' => 'published' })
+            uri.query = URI.encode_www_form(
+              {
+                'fileUri' => @file_uri,
+                'retrievalType' => 'published',
+              }
+            )
             uri
           end
         end

data/lib/nexmo_developer/app/services/translator/smartling/api/file_status.rb

@@ -31,7 +31,13 @@ module Translator
         end
 
         def return_value
-          @return_value ||= response_body['response']['data']['items'].map { |item| item['localeId'] }
+          @return_value ||= begin
+            total_word_count = response_body['response']['data']['totalWordCount']
+            total_string_count = response_body['response']['data']['totalStringCount']
+            response_body['response']['data']['items'].map do |item|
+              item['localeId'] if total_word_count == item['completedWordCount'] && total_string_count == item['completedStringCount']
+            end.compact
+          end
         end
 
         def to_s

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

@@ -35,7 +35,7 @@ module Translator
         dir_path = pathname.dirname.to_s == '.' ? '' : "/#{pathname.dirname}"
         "#{Rails.configuration.docs_base_path}/config/tutorials/#{locale}#{dir_path}"
       elsif filename.starts_with? '_tutorials'
-        pathname = Pathname.new(filename.gsub("_tutorials/#{I18n.default_locale}/", ''))
+        pathname = Pathname.new(filename.gsub('_tutorials/', ''))
         dir_path = pathname.dirname.to_s == '.' ? '' : "/#{pathname.dirname}"
         "#{Rails.configuration.docs_base_path}/_tutorials/#{locale}#{dir_path}"
       else

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

@@ -126,6 +126,25 @@ They auto-magically color when you use verbs like [POST] or [DELETE]
 |
 | 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.
 
+````
+| ### Click me
+|
+| Here is some hidden content.
+|
+| 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.
+````
+
+| ### Alpha
+|
+| Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Donec id elit non mi porta gravida at eget metus. Sed posuere consectetur est at lobortis. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec ullamcorper nulla non metus auctor fringilla.
+|
+| Donec id elit non mi porta gravida at eget metus. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Nulla vitae elit libero, a pharetra augue. Donec sed odio dui. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Cras mattis consectetur purus sit amet fermentum.
+|
+| Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Donec id elit non mi porta gravida at eget metus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Aenean lacinia bibendum nulla sed consectetur. Nullam quis risus eget urna mollis ornare vel eu leo.
+
+````
 | ### Alpha
 |
 | Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Donec id elit non mi porta gravida at eget metus. Sed posuere consectetur est at lobortis. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec ullamcorper nulla non metus auctor fringilla.
@@ -133,15 +152,24 @@ They auto-magically color when you use verbs like [POST] or [DELETE]
 | Donec id elit non mi porta gravida at eget metus. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Nulla vitae elit libero, a pharetra augue. Donec sed odio dui. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Cras mattis consectetur purus sit amet fermentum.
 |
 | Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Donec id elit non mi porta gravida at eget metus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Aenean lacinia bibendum nulla sed consectetur. Nullam quis risus eget urna mollis ornare vel eu leo.
+````
 
 **Tooltips (custom plugin)**
 
 Find out ^[more](Tooltips are useful for when you have more information to convey, but don't want to break context.).
 
+````
+Find out ^[more](Tooltips are useful for when you have more information to convey, but don't want to break context.).
+````
+
 ## Images
 
 ![Please always add alt-text](https://media.giphy.com/media/pDTLSpqNvNxlu/giphy.gif)
 
+````
+![Please always add alt-text](https://media.giphy.com/media/pDTLSpqNvNxlu/giphy.gif)
+````
+
 > Images should be used sparingly, try to avoid using screenshots that might go out of date.
 >
 > Also... Please ALWAYS write descriptive alt text.
@@ -183,8 +211,6 @@ See our detailed [code examples guide](/contribute/guides/code-examples) for adv
 ## Tables
 
 > Pipes should only be between cells. Two hyphens `--` should be used to 'underline' the headings.
->
-> You'll have to view the `markdown-guide.md` source to see how since showing you the syntax would result in it being processed.
 
 | Key          | Description                                                                                |
 | ------------ | ------------------------------------------------------------------------------------------ |
@@ -192,6 +218,14 @@ See our detailed [code examples guide](/contribute/guides/code-examples) for adv
 | `API_KEY`    | You can find this in your [account overview](https://dashboard.nexmo.com/account-overview) |
 | `API_SECRET` | You can find this in your [account overview](https://dashboard.nexmo.com/account-overview) |
 
+````
+| Key          | Description                                                                                |
+| ------------ | ------------------------------------------------------------------------------------------ |
+| `TO_NUMBER`  | The number you are sending the SMS to                                                      |
+| `API_KEY`    | You can find this in your [account overview](https://dashboard.nexmo.com/account-overview) |
+| `API_SECRET` | You can find this in your [account overview](https://dashboard.nexmo.com/account-overview) |
+````
+
 ## Tabbed Content (custom plugin)
 
 To use the tabbed content block, add a section like this to your markdown to point out where the directory holding the examples is:
@@ -325,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.