station 0.0.107 → 0.0.112

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/static_controller.rb

@@ -113,17 +113,9 @@ class StaticController < ApplicationController
   end
 
   def robots
-    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'
+    respond_to do |format|
+      format.any { render plain: 'robots', layout: false, content_type: 'text/plain' }
+    end
   end
 
   def team

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/presenters/improve_page_presenter.rb

@@ -7,13 +7,14 @@ class ImprovePagePresenter
     @github_url ||= "https://github.com/#{docs_repo}/blob/#{ENV.fetch('branch', 'master')}/#{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
+    @document_path&.gsub!("#{Rails.configuration.docs_base_path}/", '')
+    @document_path.start_with?('app/') ? @document_path.prepend('lib/nexmo_developer/') : @document_path
   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/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/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/contribute/guides/markdown-guide.md

@@ -126,6 +126,16 @@ 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.
@@ -134,14 +144,32 @@ They auto-magically color when you use verbs like [POST] or [DELETE]
 |
 | 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.
+|
+| 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:

data/lib/nexmo_developer/app/views/dashboard/stats.html.erb

@@ -70,7 +70,7 @@
     { name: 'Neutral', color: '#e1e2e6', data: @feedbacks.neutral.group_by_week('feedback_feedbacks.created_at').count },
     { name: 'Negative', color: '#ea5353', data: @feedbacks.negative.group_by_week('feedback_feedbacks.created_at').count },
   ],
-  stacked: true
+  stacked: true, defer: true
 ) %>
 
 <%
@@ -109,7 +109,7 @@
     { name: 'Neutral', color: '#e1e2e6', data: neutral },
     { name: 'Negative', color: '#ea5353', data: negative },
   ],
-  stacked: true
+  stacked: true, defer: true
 ) %>
 
 <hr>

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

@@ -76,11 +76,6 @@
   <%= javascript_include_tag 'application', defer: true %>
 
   <%= javascript_packs_with_chunks_tag 'application', defer: true %>
-  <% if @additional_scripts %>
-    <% @additional_scripts.each do |script| %>
-      <%= javascript_include_tag script %>
-    <% end %>
-  <% end %>
 
   <% if ENV['ENVIRONMENT_SCRIPTS'] %>
     <%= ENV['ENVIRONMENT_SCRIPTS'].html_safe %>

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>