station 0.0.93 → 0.0.101

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6afd924d4cffe55394126dd3860edc66bd5ea1c3cb8f11391db094c3d5f88218
-  data.tar.gz: 455ed9a2fea84dafc95fcf8f4fba3db64bb0b554326608b9c8b5506cdccaf5aa
+  metadata.gz: 64bf1507199f0467d7ac42ef46aa922b15d53e141fd745fdbc3c0a69fd4efda6
+  data.tar.gz: 97c0cdb2f92ee2d32c69486efba81d50cf9cbdfedbb642547a0281d6ac38efc1
 SHA512:
-  metadata.gz: 00c95fa2ee3520828c74b81d39729d94074a4f80c54a1aa54992a6f8d7332c2fc776c311d8eced8e08b9090106bec63195c6b53a11474799bc9f8d0a1f3bf56a
-  data.tar.gz: 488cfab84f13a23c7bfb394746da85e5929530870dbf0538b928107ba96076a74337a339179af8152ab52c860eea7cf60df2f0353dc226da2cd1eda5305334fa
+  metadata.gz: a9edf65ea65cd4cad757672e746b2b0d3bec273190f152af2789ef34fd4f13f49604ed4d63dde4c45b83905ece33f56dd059ed2a061a10d0e8c4d38c1b07c06a
+  data.tar.gz: 884ed537ecaf8e7715a2569bf7188df61d5fc6e0bb4a01fb7c3a6247386d99b9aa918ef5debfadacfd453b33835f1adef8c8b27e21827e377826f50d43bccae3

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.5.8-alpine AS build-env
+FROM ruby:2.7.2-alpine AS build-env
 ARG RAILS_ROOT=/station
 ARG BUILD_PACKAGES="build-base curl-dev git"
 ARG DEV_PACKAGES="postgresql-dev yaml-dev zlib-dev nodejs yarn"
@@ -19,11 +19,12 @@ COPY lib/nexmo_developer/Gemfile* package.json yarn.lock $RAILS_ROOT/
 RUN bundle config --global frozen 1 \
     && gem update --system \
     && gem install bundler
+
 RUN bundle install --without development:test:assets -j4 --retry 3 --path=vendor/bundle \
     # Remove unneeded files (cached *.gem, *.o, *.c)
-    && rm -rf vendor/bundle/ruby/2.5.0/cache/*.gem \
-    && find vendor/bundle/ruby/2.5.0/gems/ -name "*.c" -delete \
-    && find vendor/bundle/ruby/2.5.0/gems/ -name "*.o" -delete
+    && rm -rf vendor/bundle/ruby/2.7.0/cache/*.gem \
+    && find vendor/bundle/ruby/2.7.0/gems/ -name "*.c" -delete \
+    && find vendor/bundle/ruby/2.7.0/gems/ -name "*.o" -delete
 
 # Install node dependencies
 RUN yarn install --frozen-lockfile
@@ -36,7 +37,7 @@ RUN bundle exec rake assets:precompile
 RUN rm -rf node_modules tmp/cache vendor/assets spec
 
 ################ Build step done ###############
-FROM ruby:2.5.8-alpine
+FROM ruby:2.7.2-alpine
 ARG RAILS_ROOT=/station
 
 ENV RACK_ENV production

data/Gemfile

@@ -1,2 +1,2 @@
 source 'https://rubygems.org'
-ruby '2.5.8'
+ruby '2.7.2'

data/Gemfile.lock

@@ -8,7 +8,7 @@ PLATFORMS
 DEPENDENCIES
 
 RUBY VERSION
-   ruby 2.5.8p224
+   ruby 2.7.2p137
 
 BUNDLED WITH
    2.1.4

data/bin/nexmo-developer

@@ -3,6 +3,7 @@ require 'optparse'
 
 clear_cache = false
 rake_ci = false
+run_migrations = false
 rake_smartling_download = false
 rake_smartling_upload = false
 
@@ -26,6 +27,9 @@ docs_path = OptionParser.new do |opts|
   opts.on("--clear-cache", "Clear Rails cache") do
     clear_cache = true
   end
+  opts.on("--run-migrations", "Runs db migrations") do
+    run_migrations = true
+  end
   opts.on("--rake-ci", "Runs ci tasks") do
     rake_ci = true
   end
@@ -87,23 +91,27 @@ require 'rake'
 require 'config/application'
 require 'rails/command'
 
+Rails.application.load_tasks
+
 if clear_cache
   puts "Clearing Rails cache..."
   Rails::Command.invoke 'runner', ['Rails.cache.clear']
 end
 
+if run_migrations
+  puts "Running migrations..."
+  Rails::Command.invoke 'runner', ["Rake::Task['db:migrate'].invoke"]
+end
+
 if rake_ci
   puts 'Running Rake tasks...'
-  Rails.application.load_tasks
   Rails::Command.invoke 'runner', ["Rake::Task['db:setup'].invoke"]
   Rails::Command.invoke 'runner', ["Rake::Task['ci:all'].invoke"]
 elsif rake_smartling_download
   puts 'Running Smartling download check...'
-  Rails.application.load_tasks
   Rails::Command.invoke 'runner', ["Rake::Task['smartling:download'].invoke"]
 elsif rake_smartling_upload
   puts 'Running Smartling upload process...'
-  Rails.application.load_tasks
 
   frequency, *paths = ARGV
   Rails::Command.invoke 'runner', ["Rake::Task['smartling:upload'].invoke(#{paths}, #{frequency})"]

data/lib/nexmo_developer/.rubocop.yml

@@ -271,3 +271,6 @@ Rails/SquishedSQLHeredocs:
 
 Rails/WhereNot:
   Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: false

data/lib/nexmo_developer/.ruby-version

@@ -1 +1 @@
-2.5.8
+2.7.2

data/lib/nexmo_developer/Dockerfile

@@ -1,5 +1,5 @@
 # Base image:
-FROM ruby:2.5.8
+FROM ruby:2.7.2
 
 # Install dependencies
 RUN apt-get update -qq && apt-get install -y build-essential libpq-dev lsof

data/lib/nexmo_developer/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-ruby '2.5.8'
+ruby '2.7.2'
 
 git_source(:github) do |repo_name|
   repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
@@ -74,7 +74,7 @@ gem 'icalendar', require: false
 gem 'neatjson'
 
 # Faker, a port of Data::Faker from Perl, is used to easily generate fake data: names, addresses, phone numbers, etc.
-gem 'faker', '2.14.0', require: false
+gem 'faker', '2.15.1', require: false
 
 # factory_girl_rails provides integration between factory_girl and rails 3 or newer (currently just automatic factory definition loading)
 gem 'factory_bot_rails', '6.1.0', require: false
@@ -110,7 +110,7 @@ gem 'bootsnap', require: false
 gem 'diffy', require: false
 
 # Automatic Ruby code style checking tool. Aims to enforce the community-driven Ruby Style Guide.
-gem 'rubocop', '~> 1.2.0', require: false
+gem 'rubocop', '~> 1.4.1', require: false
 gem 'rubocop-rails', '~> 2.8', require: false
 
 # Volta needs a CSS autoprefixer
@@ -129,9 +129,9 @@ gem 'lograge'
 gem 'countries'
 gem 'country_select', '~> 4.0'
 
-gem 'nexmo-oas-renderer', '~> 2.4.0', require: false
+gem 'nexmo-oas-renderer', '~> 2.4.1', require: false
 
-gem 'nexmo_markdown_renderer', '~> 0.5'
+gem 'nexmo_markdown_renderer', '~> 0.6'
 
 gem 'smartling'
 

data/lib/nexmo_developer/Gemfile.lock

@@ -163,7 +163,7 @@ GEM
     em-websocket (0.5.2)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
-    erubi (1.9.0)
+    erubi (1.10.0)
     eventmachine (1.2.7)
     execjs (2.7.0)
     factory_bot (6.1.0)
@@ -171,7 +171,7 @@ GEM
     factory_bot_rails (6.1.0)
       factory_bot (~> 6.1.0)
       railties (>= 5.0.0)
-    faker (2.14.0)
+    faker (2.15.1)
       i18n (>= 1.6, < 2)
     faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
@@ -258,7 +258,7 @@ GEM
       activerecord
       kaminari-core (= 1.2.1)
     kaminari-core (1.2.1)
-    listen (3.3.0)
+    listen (3.3.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lograge (0.11.2)
@@ -294,8 +294,8 @@ GEM
     neatjson (0.9)
     nenv (0.3.0)
     netrc (0.11.0)
-    newrelic_rpm (6.13.1)
-    nexmo-oas-renderer (2.4.0)
+    newrelic_rpm (6.14.0)
+    nexmo-oas-renderer (2.4.1)
       activemodel (~> 6.0)
       activesupport (~> 6.0)
       banzai (~> 0.1.2)
@@ -308,7 +308,7 @@ GEM
       sass (~> 3.1)
       shotgun (~> 0.9)
       sinatra (~> 2.0)
-    nexmo_markdown_renderer (0.5.0)
+    nexmo_markdown_renderer (0.6.0)
       activemodel (~> 6.0)
       banzai (~> 0.1.2)
       i18n (~> 1.7)
@@ -340,7 +340,7 @@ GEM
       sawyer (~> 0.8.0, >= 0.5.3)
     oj (3.10.15)
     orm_adapter (0.5.0)
-    parallel (1.19.2)
+    parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
     pg (1.2.3)
@@ -398,7 +398,7 @@ GEM
     recaptcha (5.6.0)
       json
     redcarpet (3.4.0)
-    redis (4.2.2)
+    redis (4.2.5)
     regexp_parser (1.8.2)
     request_store (1.5.0)
       rack (>= 1.4)
@@ -437,13 +437,13 @@ GEM
     rspec-snapshot (0.1.2)
       rspec (> 3.0.0)
     rspec-support (3.10.0)
-    rubocop (1.2.0)
+    rubocop (1.4.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 1.0.1)
+      rubocop-ast (>= 1.1.1)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-ast (1.1.1)
@@ -529,7 +529,7 @@ GEM
       activemodel (>= 6.0.0)
       bindex (>= 0.4.0)
       railties (>= 6.0.0)
-    webmock (3.9.5)
+    webmock (3.10.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -573,7 +573,7 @@ DEPENDENCIES
   diffy
   dotenv-rails
   factory_bot_rails (= 6.1.0)
-  faker (= 2.14.0)
+  faker (= 2.15.1)
   ffi (>= 1.9.24)
   geocoder
   gmaps4rails
@@ -589,8 +589,8 @@ DEPENDENCIES
   lograge
   neatjson
   newrelic_rpm
-  nexmo-oas-renderer (~> 2.4.0)
-  nexmo_markdown_renderer (~> 0.5)
+  nexmo-oas-renderer (~> 2.4.1)
+  nexmo_markdown_renderer (~> 0.6)
   nokogiri (~> 1.10.9)
   octokit
   pg (~> 1.2)
@@ -605,7 +605,7 @@ DEPENDENCIES
   rspec-collection_matchers
   rspec-rails (~> 4.0)
   rspec-snapshot (~> 0.1.2)
-  rubocop (~> 1.2.0)
+  rubocop (~> 1.4.1)
   rubocop-rails (~> 2.8)
   ruby-progressbar
   sassc-rails (~> 2.1)
@@ -624,7 +624,7 @@ DEPENDENCIES
   woothee
 
 RUBY VERSION
-   ruby 2.5.8p224
+   ruby 2.7.2p137
 
 BUNDLED WITH
    2.1.4

data/lib/nexmo_developer/Guardfile

@@ -5,7 +5,7 @@
 # directories %w(app lib config test spec features) \
 #  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
 
-## Note: if you are using the `directories` clause above and you are not
+## NOTE: if you are using the `directories` clause above and you are not
 ## watching the project directory ('.'), then you will want to move
 ## the Guardfile to a watched dir and symlink it back, e.g.
 #
@@ -54,7 +54,7 @@ guard 'livereload' do
   watch(%r{config/locales/.+\.yml})
 end
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'

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

@@ -197,7 +197,7 @@ class DashboardController < ApplicationController
 
       parts.insert(1, 'top-level') if parts.count < 3
 
-      parts = [parts[0], parts[1], parts[2..-1].join('/')] if parts.count > 3
+      parts = [parts[0], parts[1], parts[2..].join('/')] if parts.count > 3
       next if parts[0] == 'migrate'
 
       x = @complete_coverage

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

@@ -62,11 +62,11 @@ class TutorialListItem
   end
 
   def product_url
-    "/#{I18n.locale}/#{products.join('')}/tutorials"
+    "/#{I18n.locale}/#{products.join}/tutorials"
   end
 
   def url
-    external_link || "/#{I18n.locale}/#{products.join('')}/tutorials/#{filename}/#{first_step}"
+    external_link || "/#{I18n.locale}/#{products.join}/tutorials/#{filename}/#{first_step}"
   end
 
   def available_languages
@@ -74,7 +74,7 @@ class TutorialListItem
       OpenStruct.new(
         language: language,
         label: Nexmo::Markdown::CodeLanguage.find(language).label,
-        url: external_link || "/#{products.join('')}/tutorials/#{filename}/#{first_step}/#{language}"
+        url: external_link || "/#{products.join}/tutorials/#{filename}/#{first_step}/#{language}"
       )
     end
   end

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

@@ -28,19 +28,19 @@ navigation_weight: 3
 
 The purpose of the metadata is to provide useful information in the following areas:
 
-* Algolia search results (that is when you search in NDP)
-* Google (and other external search engine) search results
-* Information for the navbar (also sometimes called the table of contents or TOC)
+-   Algolia search results (that is when you search in NDP)
+-   Google (and other external search engine) search results
+-   Information for the navbar (also sometimes called the table of contents or TOC)
 
 The meta data items that can be used are described in the following table:
 
-Metadata | HTML generated | Description
-----|----|----
-`title` | N/A | This is the title for the topic that will be displayed in the navbar. This main be different to that display at the top of the topic. It is displayed in the Algolia search results when you search NDP.
-`description` | N/A | This is the short description for the topic. It is displayed in the Algolia search results when you search NDP. It should indicate the nature of the content of the topic.
-`meta_title` | `<head><title>The title</title>...</head>` | Used for SEO in external search engine results. This should be more descriptive than the `title` to provide additional context in the absence of the navbar. [Further reading](https://moz.com/learn/seo/title-tag).
-`meta_description` | `<head><meta name="description" content="The description">...</head>` | Used in external search engine results. Provides SEO. Should be no more than 160 characters. [Further reading](https://moz.com/learn/seo/meta-description).
-`navigation_weight` | N/A | A hint to position the topic in the navbar where a particular position is preferred. The lower the number used the higher in the navbar the item will appear. Overrides information defined in `config/navigation.yml`. In most cases you only need to add a `navigation_weight` item if your topic is not automatically displayed in your preferred position in the navbar.
+| Metadata            | HTML generated                                                        | Description                                                                                                                                                                                                                                                                                                                                                                  |
+| ------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `title`             | N/A                                                                   | This is the title for the topic that will be displayed in the navbar. This main be different to that display at the top of the topic. It is displayed in the Algolia search results when you search NDP.                                                                                                                                                                     |
+| `description`       | N/A                                                                   | This is the short description for the topic. It is displayed in the Algolia search results when you search NDP. It should indicate the nature of the content of the topic.                                                                                                                                                                                                   |
+| `meta_title`        | `<head><title>The title</title>...</head>`                            | Used for SEO in external search engine results. This should be more descriptive than the `title` to provide additional context in the absence of the navbar. [Further reading](https://moz.com/learn/seo/title-tag).                                                                                                                                                         |
+| `meta_description`  | `<head><meta name="description" content="The description">...</head>` | Used in external search engine results. Provides SEO. Should be no more than 160 characters. [Further reading](https://moz.com/learn/seo/meta-description).                                                                                                                                                                                                                  |
+| `navigation_weight` | N/A                                                                   | A hint to position the topic in the navbar where a particular position is preferred. The lower the number used the higher in the navbar the item will appear. Overrides information defined in `config/navigation.yml`. In most cases you only need to add a `navigation_weight` item if your topic is not automatically displayed in your preferred position in the navbar. |
 
 ### Example
 
@@ -62,15 +62,15 @@ When using `title` bear in mind that while something like "Overview" may be fine
 
 Ideally task (step) or other active topics should include a gerund. For example:
 
-* Installing the Vonage Command Line Interface (CLI)
+-   Installing the Vonage Command Line Interface (CLI)
 
 Topics providing reference information would have a noun-based title, for example:
 
-* The Conversation object
+-   The Conversation object
 
 To provide greater context in external search results a corresponding `meta_title` might contain much more specific information, for example:
 
-* The Vonage Conversation API Conversation object
+-   The Vonage Conversation API Conversation object
 
 ### Writing an effective `description`
 
@@ -89,7 +89,9 @@ This appears in external search engine results. While navbar titles such as "Ove
 **Headings**
 
 # I am a H1
+
 ## I am a H2
+
 ### I am a H3
 
 > Custom extension: Headings have their own slugified ID's for deep linking. For example the `h1` has an ID of `i-am-a-h1`
@@ -100,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.
 
@@ -152,13 +154,13 @@ Find out ^[more](Tooltips are useful for when you have more information to conve
 >
 > Indentations are 4 spaces.
 
-* Alpha
-* Bravo
-    * Charlie
-    * Delta
-        * Echo
-    * Foxtrot
-* Golf
+-   Alpha
+-   Bravo
+    -   Charlie
+    -   Delta
+        -   Echo
+    -   Foxtrot
+-   Golf
 
 **Ordered Lists**
 
@@ -171,7 +173,7 @@ Find out ^[more](Tooltips are useful for when you have more information to conve
     1. Three
     2. Four
         1. Five
-    1. Six
+    3. Six
 3. Seven
 
 ## Code
@@ -184,11 +186,11 @@ See our detailed [code examples guide](/contribute/guides/code-examples) for adv
 >
 > 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
--- | --
-`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)
+| 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)
 
@@ -229,10 +231,10 @@ Note that `tabbed` is set to `true` for tabbed folder content.
 
 Example files can be found in the folder `_documentation/en/client-sdk/setup/add-sdk-to-your-app`:
 
-* `.config.yml`
-* `android.md`
-* `ios.md`
-* `javascript.md`
+-   `.config.yml`
+-   `android.md`
+-   `ios.md`
+-   `javascript.md`
 
 The rendered output can be found [here](/client-sdk/setup/add-sdk-to-your-app/javascript).
 
@@ -288,21 +290,21 @@ Andrew->>China: I am good thanks!
 
 Inline [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) support, using both primary language tags and subtags, is provided using the following syntax.
 
-Language | Key | Text
--- | -- | --
-English | none | Hello World
-Spanish | `es` | [Hola Mundo](lang: 'es')
-French | `fr` | [Bonjour le monde](lang: 'fr')
-Brazilian Portuguese | `pt-BR` | [Olá Mundo](lang: 'pt-BR')
-Hebrew | `il` | [שלום עולם](lang: 'il')
+| Language             | Key     | Text                           |
+| -------------------- | ------- | ------------------------------ |
+| English              | none    | Hello World                    |
+| Spanish              | `es`    | [Hola Mundo](lang: "es")       |
+| French               | `fr`    | [Bonjour le monde](lang: "fr") |
+| Brazilian Portuguese | `pt-BR` | [Olá Mundo](lang: "pt-BR")     |
+| Hebrew               | `il`    | [שלום עולם](lang: "il")        |
 
 ## Anchors (custom plugin)
 
 Adding custom anchors and retaining support for old headings can be done as such:
 
-````
+```
 ⚓ This is the old heading
-````
+```
 
 This would produce the following HTML:
 
@@ -312,12 +314,12 @@ This would produce the following HTML:
 
 If you are adding support for a changed header this would normally go above the old heading as such:
 
-````
+```
 ⚓ Send with Short Message Service
 ⚓ Send with SMS
 
 # Sending an SMS
-````
+```
 
 ### Example
 
@@ -365,9 +367,9 @@ image: public/assets/screenshots/da5f952d465355c19eb888fa1049844b31e090c2.png
 
 The HTML `<audio>` element can be utilised in Markdown with the following syntax:
 
-````
+```
 🔈[https://developer.nexmo.com.s3.amazonaws.com/assets/ssml/06-phonemes.mp3]
-````
+```
 
 This produces the following output:
 
@@ -377,9 +379,9 @@ This produces the following output:
 
 You can use syntax such as:
 
-````
+```
 Welcome to [~dynamic_content_example~]
-````
+```
 
 This will render as:
 
@@ -405,7 +407,7 @@ Alternatively, you can specify the concepts to list manually if you need to show
 
 ````
 ```concept_list
-concepts: 
+concepts:
   - voice/voice-api/call-flow
   - messaging/sms/delivery-receipts
 ```
@@ -414,7 +416,27 @@ concepts:
 This produces the following output:
 
 ```concept_list
-concepts: 
+concepts:
   - voice/voice-api/call-flow
   - messaging/sms/delivery-receipts
 ```
+
+## Snippet Variables (custom plugin)
+
+When writing a code snippet, you may need to define variables that the snippet will use and provide a description of each. The description will be shown in the selected language if a translation is available.
+
+The variables are defined in `config/code_snippet_variables.yml`
+
+````
+```snippet_variables
+- NEXMO_API_KEY
+- TO_NUMBER
+```
+````
+
+Produces the following output:
+
+```snippet_variables
+- NEXMO_API_KEY
+- TO_NUMBER
+```