station 0.0.104 → 0.0.109

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

@@ -116,16 +116,6 @@ class StaticController < ApplicationController
     render 'robots.txt'
   end
 
-  def podcast
-    # Get URL and split the / to retrieve the landing page name
-    yaml_name = request.fullpath.split('/')[1]
-
-    # Load the YAML for that particular page
-    @content = YAML.load_file("#{Rails.root}/config/landing_pages/#{yaml_name}.yml")
-
-    render layout: 'landing'
-  end
-
   def team
     @team ||= LoadConfig.load_file('config/team.yml')
     @careers = Greenhouse.devrel_careers

data/lib/nexmo_developer/app/helpers/application_helper.rb

@@ -34,6 +34,8 @@ module ApplicationHelper
   end
 
   def canonical_base
+    return "https://#{ENV['HEROKU_APP_NAME']}.herokuapp.com" if ENV['HEROKU_APP_NAME']
+
     canonical_base_from_config || request.base_url
   end
 

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

@@ -84,20 +84,18 @@ class Tutorial
     subtasks[current_task_index - 1]
   end
 
+  def tasks
+    @tasks ||= (yaml['tasks'] || []).map do |t|
+      Task.make_from(
+        name: t,
+        code_language: code_language,
+        current_step: current_step
+      )
+    end
+  end
+
   def subtasks
     @subtasks ||= begin
-      tasks = []
-
-      (yaml['tasks'] || []).map do |t|
-        tasks.push(
-          Task.make_from(
-            name: t,
-            code_language: code_language,
-            current_step: current_step
-          )
-        )
-      end
-
       tasks.unshift(prerequisite_task)
       tasks.unshift(introduction_task)
       tasks.push(conclusion_task)

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

@@ -1,5 +1,7 @@
 class Tutorial::Prerequisite
-  delegate :content, :yaml, to: :@file_loader
+  attr_reader :name
+
+  delegate :content, :yaml, :path, to: :@file_loader
 
   def initialize(current_step:, code_language:, name:)
     @current_step  = current_step

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

@@ -1,11 +1,24 @@
 class Tutorial::Task
-  attr_reader :name, :title, :description, :current_step
+  attr_reader :name, :code_language, :current_step
 
-  def initialize(name:, title:, description:, current_step:)
+  delegate :yaml, :path, to: :@file_loader
+
+  def initialize(name:, current_step:, code_language: nil, title: nil, description: nil)
     @name         = name
     @title        = title
     @description  = description
+    @code_language = code_language
     @current_step = current_step
+    @file_loader = load_file!
+  end
+
+  def load_file!
+    Tutorial::FileLoader.new(
+      root: Tutorial.task_content_path,
+      doc_name: @name,
+      code_language: @code_language,
+      format: 'md'
+    )
   end
 
   def active?
@@ -13,17 +26,9 @@ class Tutorial::Task
   end
 
   def self.make_from(name:, code_language:, current_step:)
-    file_loader = Tutorial::FileLoader.new(
-      root: Tutorial.task_content_path,
-      doc_name: name,
-      code_language: code_language,
-      format: 'md'
-    )
-
     new(
       name: name,
-      title: file_loader.yaml['title'],
-      description: file_loader.yaml['description'],
+      code_language: code_language,
       current_step: current_step
     )
   end
@@ -42,4 +47,12 @@ class Tutorial::Task
   def hash
     name.hash ^ title.hash ^ description.hash ^ current_step.hash
   end
+
+  def title
+    @title || yaml['title']
+  end
+
+  def description
+    @description || yaml['description']
+  end
 end

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

@@ -0,0 +1,90 @@
+module Translator
+  class FilesListCoordinator
+    def self.call(attrs = {})
+      new(attrs).call
+    end
+
+    def initialize(days:)
+      @days = days
+    end
+
+    def call
+      process_files(files)
+    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")
+    end
+
+    def process_files(files)
+      files.each_with_object([]) do |file, list|
+        if file.include?('_documentation')
+          list << file if translatable_doc_file?(file)
+        elsif file.include?('_use_cases')
+          list << file if translatable_use_case_file?(file)
+        elsif file.include?('_tutorials')
+          list << file if translatable_tutorial_file?(file)
+        else
+          raise ArgumentError, "The following file did not match documentation, use cases or tutorials: #{file}"
+        end
+      end
+    end
+
+    def translatable_doc_file?(file)
+      return nil unless File.exist?("#{Rails.configuration.docs_base_path}/#{file}")
+
+      allowed_products.any? do |product|
+        product['path'].include?(file.split('/')[2])
+      end
+    end
+
+    def translatable_use_case_file?(file)
+      return nil unless File.exist?("#{Rails.configuration.docs_base_path}/#{file}")
+
+      allowed_products.any? do |product|
+        use_case_product(file).include?(product['path'])
+      end
+    end
+
+    def use_case_product(file)
+      @use_case_product = YAML.safe_load(File.read("#{Rails.configuration.docs_base_path}/#{file}"))['products']
+
+      @use_case_product
+    end
+
+    def translatable_tutorial_file?(file)
+      return nil unless File.exist?("#{Rails.configuration.docs_base_path}/#{file}")
+
+      allowed_tutorial_files.any? do |tutorial|
+        tutorial.include?(file)
+      end
+    end
+
+    def allowed_products
+      @allowed_products ||= YAML.safe_load(File.read("#{Rails.configuration.docs_base_path}/config/products.yml"))['products'].select { |product| product['translate'] == true }
+    end
+
+    def allowed_tutorial_files
+      file_names = []
+      tutorials_list = []
+
+      TutorialList.all.each do |item|
+        allowed_products.each do |product|
+          tutorials_list << item if item.products.to_s.include?(product['path'])
+        end
+      end
+
+      tutorials_list.each do |item|
+        item.tutorial.prerequisites&.each do |prereq|
+          file_names << prereq.path
+        end
+
+        item.tutorial.tasks&.each do |task|
+          file_names << task.path
+        end
+      end
+
+      file_names.uniq
+    end
+  end
+end

data/lib/nexmo_developer/app/views/admin/feedbacks/_steps.html.erb

@@ -35,7 +35,7 @@
       <% step['fields'].each_with_index do |field, field_index| %>
         <div>
           <b><%= field['label'] %>:</b>
-          <small><%= feedback.steps[step_index][field['name']] %></small>
+          <small><%= feedback.steps[step_index].try(:[], field['name']) %></small>
         </div>
       <% end %>
     <% end %>

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

@@ -6,7 +6,7 @@
 
 
     <div class="Nxd-logo Vlt-white" id="footer-logo">
-      <a href="/" id="logo" class="Nxd-logo__image">
+      <a href="/" class="Nxd-logo__image">
         <%= image_tag info[:logo_path], alt: info[:logo_alt] %>
       </a>
       <hr class="Nxd-product__separator">
@@ -17,7 +17,7 @@
     </div>
 
       <% if info[:status] %>
-        <a href=<%= info[:status]['path'] %> target="_blank" class="Vlt-badge-combined">
+        <a href=<%= info[:status]['path'] %> target="_blank" class="Vlt-badge-combined" rel="noopener">
           <span class="Vlt-badge Vlt-white Nxd-api-badge"><%= info[:status]['text'] %></span><span class="Vlt-badge Vlt-badge--purple Nxd-api-status">Loading</span>
         </a>
       <% end %>
@@ -25,7 +25,7 @@
       <% if info[:social_links] %>
         <div id="footer-social-links">
           <% info[:social_links].each do |target, url| %>
-            <a href=<%= url %> class="footer-link" target="_blank"><i class="icon icon-<%= target %>"></i></a>
+            <a href=<%= url %> class="footer-link" target="_blank" rel="noopener" title="<%= target %>"><i class="icon icon-<%= target %>"></i></a>
           <% end %>
         </div>
       <% end %>
@@ -43,7 +43,7 @@
     <div id="footer-support">
       <h5>Support</h5>
       <% info[:support_links].each do |name, url| %>
-        <a href=<%= Footer.support_link(url) %> target="_blank"><%= Footer.support_link_text(name) %></a>
+        <a href=<%= Footer.support_link(url) %> target="_blank" rel="noopener"><%= Footer.support_link_text(name) %></a>
       <% end %>
     </div>
   </div>

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

@@ -1,4 +1,4 @@
-<% head = Head.new %>
+<% head = Head.new(@frontmatter) %>
 
 <head>
   <meta charset="utf-8" />
@@ -73,7 +73,7 @@
 
   <link rel="canonical" href="<%= canonical_url %>">
 
-  <%= javascript_include_tag 'application' %>
+  <%= javascript_include_tag 'application', defer: true %>
 
   <%= javascript_packs_with_chunks_tag 'application', defer: true %>
   <% if @additional_scripts %>
@@ -86,8 +86,8 @@
     <%= ENV['ENVIRONMENT_SCRIPTS'].html_safe %>
   <% end %>
 
-  <%= stylesheet_pack_tag 'application' %>
-  <%= stylesheet_link_tag 'application' %>
+  <%= stylesheet_pack_tag 'application', preload: true %>
+  <%= stylesheet_link_tag 'application', preload: true %>
 
   <%= javascript_include_tag 'https://www.google.com/recaptcha/api.js', async: true, defer: true %>
 

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

@@ -2,7 +2,7 @@
 <%= render partial: 'layouts/partials/post-body-tags' %>
 
 <div class="Nxd-header">
-  <header id="header" class="Nxd-header__main" tabindex="2">
+  <header id="header" class="Nxd-header__main">
     <a tabindex="0" id="skip-to-navigation" href="#sidenav-first" class="Vlt-btn Vlt-btn--outline Vlt-btn--primary Vlt-btn--app">Skip to navigation</a>
     <a tabindex="0" id="skip-to-content" href="#primary-content" class="Vlt-btn Vlt-btn--outline Vlt-btn--primary Vlt-btn--app">Skip to content</a>
     <div class="Nxd-logo">
@@ -15,7 +15,7 @@
           <small><%= header.subtitle %></small>
         </div>
       </a>
-      <a href="/" id="logo" class="Nxd-logo__image Vlt-S-only">
+      <a href="/" id="logo-small" class="Nxd-logo__image Vlt-S-only">
         <%= image_tag header.small_logo_path, alt: header.logo_alt %>
       </a>
       <% if header.hiring_link? %>
@@ -38,7 +38,7 @@
   </header>
 
   <nav id="subnav" class="Nxd-header__sub">
-    <a id="Vlt-sidenav-mobile-trigger"><svg><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-menu"></use></svg></a>
+    <button id="Vlt-sidenav-mobile-trigger" class="Vlt-btn Vlt-btn--link"><svg><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-menu"></use></svg></button>
 
     <div class="Nxd-header__sub__menu">
       <% Topnav.new(@navigation).items.each do |item| %>

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

@@ -8,7 +8,7 @@
           <svg class="Vlt-icon Vlt-black">
             <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-github" />
           </svg>
-          <a href="<%= presenter.github_url %>" target="_blank" class="Vlt-text-link Vlt-black">Improve this page</a>
+          <a href="<%= presenter.github_url %>" target="_blank" class="Vlt-text-link Vlt-black" rel="noopener">Improve this page</a>
         </span>
       </div>
     </div>

data/lib/nexmo_developer/app/views/static/_products.html.erb

@@ -1,31 +1,34 @@
 <div class="Nxd-products-list">
   <div class="Vlt-grid Vlt-grid--center Vlt-grid--margin-top2">
+
+
     <div class="Vlt-col Vlt-col--1of3 Vlt-col--M-1of2">
       <div class="Vlt-card Vlt-article--reverse Vlt-card--image Nxd-card--products">
         <div class="Vlt-card__content">
           <svg class="Vlt-icon Vlt-icon--larger Vlt-purple-dark"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-message" /></svg>
-          <div class="Nxd-card--product__subtitle"><small>SEND AND RECEIVE</small></div>
-
+          <div class="Nxd-card--product__subtitle"><small>PRODUCT AREA</small></div>
           <h2>
             <a href="/messaging/sms/overview">
-              SMS
+              PRODUCT NAME
             </a>
           </h2>
           <nav>
-            <a href="/messaging/sms/overview"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
+            <a href="#"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
                                                    aria-hidden="true">
-                <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-home" /></svg>Overview</a>
-            <a href="/messaging/sms/guides"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
+                <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-home" /></svg>Product Topic 1</a>
+            <a href="#"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
                                                  aria-hidden="true">
-                <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-books" /></svg>Guides</a>
-            <a href="/messaging/sms/code-snippets"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
+                <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-books" /></svg>Product Topic 2</a>
+            <a href="#"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
                                                         aria-hidden="true">
-                <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-code" /></svg>Code Snippets</a>
-            <a href="/messaging/sms/tutorials"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
+                <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-code" /></svg>Product Topic 3</a>
+            <a href="#"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
                                                     aria-hidden="true">
                 <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-mockup" /></svg>Tutorials</a>
             <hr class="hr--short">
-            <a href="/api/sms">API Reference</a>
+            <a href="https://nexmo.github.io/station/How-To-Use#customization-options">
+              To modify this view, copy <a href="https://raw.githubusercontent.com/Nexmo/station/master/lib/nexmo_developer/app/views/static/_products.html.erb">the file</a> to your `custom/views/static` folder and customize the copied file.
+            </a>
           </nav>
         </div>
       </div>
@@ -67,7 +70,7 @@
           <svg class="Vlt-icon Vlt-icon--larger Vlt-purple-dark"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-video" /></svg>
           <div class="Nxd-card--product__subtitle"><small>PROGRAMMABLE</small></div>
           <h2>
-            <a target="_blank" href="https://tokbox.com/developer/">
+            <a target="_blank" href="https://tokbox.com/developer/" rel="noopener">
               Video
             </a>
             <small class="Vlt-grey-dark" style="font-size:1.4rem; font-weight:normal;">
@@ -77,20 +80,20 @@
             </small>
           </h2>
           <nav>
-            <a target="_blank" href="https://tokbox.com/developer/guides/basics/"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
+            <a target="_blank" href="https://tokbox.com/developer/guides/basics/" rel="noopener"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
                                                                                        aria-hidden="true">
                 <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-home" /></svg>Overview</a>
-            <a target="_blank" href="https://tokbox.com/developer/guides/"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
+            <a target="_blank" href="https://tokbox.com/developer/guides/" rel="noopener"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
                                                                                 aria-hidden="true">
                 <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-books" /></svg>Guides</a>
-            <a target="_blank" href="https://tokbox.com/developer/samples/"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
+            <a target="_blank" href="https://tokbox.com/developer/samples/" rel="noopener"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
                                                                                  aria-hidden="true">
                 <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-code" /></svg>Code Snippets</a>
-            <a target="_blank" href="https://tokbox.com/developer/tutorials/"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
+            <a target="_blank" href="https://tokbox.com/developer/tutorials/" rel="noopener"><svg class="Vlt-icon Vlt-icon--small Vlt-icon--text-bottom Vlt-gray-darker"
                                                                                    aria-hidden="true">
                 <use xlink:href="/symbol/volta-icons.svg#Vlt-icon-mockup" /></svg>Tutorials</a>
             <hr class="hr--short">
-            <a target="_blank" href="https://tokbox.com/developer/sdks/client/">API Reference</a>
+            <a target="_blank" href="https://tokbox.com/developer/sdks/client/" rel="noopener">API Reference</a>
           </nav>
         </div>
       </div>

data/lib/nexmo_developer/app/views/static/landing.html.erb

@@ -2,8 +2,8 @@
 
   <div class="row">
     <div class="center">
-      <h1 class="Vlt-title--margin-top2">Connected Code</h1>
-      <p class="p-large">Everything you need to build connected applications with Vonage APIs</p>
+      <h1 class="Vlt-title--margin-top2">Default Entry Page</h1>
+      <p class="p-large">This is the default landing page for a developer portal running on Station.</p>
     </div>
     <div class="columns small-12">
       <a name="products"></a>
@@ -17,10 +17,10 @@
             <h2>
               <a href="/tools">
                 <div><svg class="Vlt-icon Vlt-icon--large Vlt-purple-dark"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-design-tools"/></svg></div>
-                SDKs &amp; Tools
+                Featured Topic 1
               </a>
             </h2>
-            <p>The Nexmo libraries allow you to get up and running with<br>Nexmo APIs quickly in your language of choice.</p>
+            <p>You can choose to highlight an area of your portal on the landing page.</p>
           </div>
         </div>
         <div class="Vlt-col Vlt-col--M-1of2">
@@ -28,10 +28,10 @@
             <h2>
               <a href="/community">
                 <div><svg class="Vlt-icon Vlt-icon--large Vlt-purple-dark"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-group"/></svg></div>
-                Community
+                Featured Topic 2
               </a>
             </h2>
-            <p>Find out about our talks, community hacks,<br>and what events we'll be at.</p>
+            <p>You can highlight more than one area.</p>
           </div>
         </div>
       </div>
@@ -39,8 +39,8 @@
       <hr class="hr--tall">
 
       <div class="center">
-        <h3>Do you have a question?</h3>
-        <p class="p-large">We're always here to help. Check out our <a href="https://help.nexmo.com">support FAQs</a>, contact our super helpful <a href="https://help.nexmo.com/hc/en-us/requests/new">support team</a> or get in touch on <a href="http://stackoverflow.com/questions/tagged/nexmo">Stack Overflow</a>.<br />Your data will be treated in accordance with our <a href="https://www.nexmo.com/privacy-policy">Privacy Policy</a>, which sets out the rights you have in respect of your data.</p>
+        <h3>Modifying This Content</h3>
+        <p class="p-large">To modify this content you can copy <a href="https://raw.githubusercontent.com/Nexmo/station/master/lib/nexmo_developer/app/views/static/landing.html.erb">this file</a> to the `custom/views/static` folder in your documentation folder and modify that copy. More detailed instructions to create your own landing page can be found on the <a href="https://nexmo.github.io/station/How-To-Use#customization-options">Station documentation</a>.</p>
       </div>
     </div>
   </div>