station 0.0.0 → 0.0.93

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

@@ -0,0 +1,113 @@
+class TutorialController < ApplicationController
+  before_action :set_navigation
+  before_action :set_tutorial_step
+  before_action :set_tutorial, except: %i[list single]
+  before_action :check_tutorial_step, except: %i[list single]
+  before_action :set_sidenav
+  before_action :canonical_redirect, only: %i[list index]
+
+  def list
+    @product = params['product']
+    @code_language = params['code_language']
+
+    if @product
+      @tutorials = TutorialList.tasks_for_product(@product)
+    else
+      @tutorials = TutorialList.all
+    end
+    @tutorials = @tutorials.select { |t| t.languages.include?(@code_language) } if @code_language
+
+    @document_title = 'Tutorials'
+
+    render layout: 'page'
+  end
+
+  def index
+    if @tutorial_step == 'prerequisites'
+      @content = render_to_string(partial: 'prerequisites', layout: false)
+    else
+      @content = Nexmo::Markdown::Renderer.new({
+        code_language: @code_language,
+        current_user: current_user,
+      }).call(@tutorial.content_for(@tutorial_step))
+    end
+
+    # If it's an intro/conclusion we can't link to a specific task, so make sure that
+    # we're linking to a non-product tutorial link as the canonical link
+    if ['introduction', 'conclusion'].include?(@tutorial_step)
+      @canonical_url = helpers.canonical_base + request.original_fullpath.gsub(%r{^/#{params[:product]}}, '')
+    else
+      # Otherwise it's a single step, which we can link to
+      @canonical_url = "#{helpers.canonical_base}/task/#{@tutorial_step}"
+    end
+
+    render layout: 'documentation'
+  end
+
+  def single
+    path = "#{Rails.configuration.docs_base_path}/_tutorials/#{I18n.default_locale}/#{params[:tutorial_step]}.md"
+    @content = File.read(path)
+    @content = Nexmo::Markdown::Renderer.new({
+                                      code_language: @code_language,
+                                      current_user: current_user,
+                                    }).call(@content)
+    render layout: 'documentation'
+  end
+
+  private
+
+  def set_navigation
+    @navigation = :tutorials
+  end
+
+  def set_sidenav
+    @sidenav = Sidenav.new(
+      namespace: params[:namespace],
+      locale: params[:locale],
+      request_path: request.path,
+      navigation: @navigation,
+      code_language: params[:code_language],
+      product: params[:product]
+    )
+  end
+
+  def set_tutorial
+    @tutorial_name = params[:tutorial_name]
+    render_not_found unless @tutorial_name
+    @tutorial = Tutorial.load(
+      @tutorial_name,
+      @tutorial_step,
+      params[:product],
+      params[:code_language]
+    )
+  end
+
+  def set_tutorial_step
+    return unless params[:tutorial_step]
+
+    @tutorial_step = params[:tutorial_step]
+  end
+
+  def check_tutorial_step
+    # If we don't have a current tutorial step, redirect to the first available page
+    return if @tutorial_step
+
+    redirect_to url_for(
+      controller: :tutorial,
+      action: action_name,
+      product: @tutorial.current_product,
+      tutorial_name: @tutorial.name,
+      tutorial_step: @tutorial.first_step,
+      code_language: @tutorial.code_language
+    )
+  end
+
+  def canonical_redirect
+    return if params[:locale].nil? && session[:locale].nil?
+    return if params[:locale] && params[:locale] != I18n.default_locale.to_s
+    return if session[:locale] && session[:locale] != I18n.default_locale.to_s
+    return if params[:locale].nil? && session[:locale] == I18n.default_locale.to_s
+
+    redirect_to request.path.gsub("/#{I18n.locale}", '')
+  end
+end

data/lib/nexmo_developer/app/controllers/usage/ab_result_controller.rb

@@ -0,0 +1,10 @@
+module Usage
+  class AbResultController < ApplicationController
+    skip_before_action :verify_authenticity_token
+
+    def create
+      ab_finished(params['t'].to_sym)
+      render json: {}
+    end
+  end
+end

data/lib/nexmo_developer/app/controllers/usage/code_snippet_controller.rb

@@ -0,0 +1,19 @@
+module Usage
+  class CodeSnippetController < ApplicationController
+    skip_before_action :verify_authenticity_token
+
+    def create
+      event = ::Usage::CodeSnippetEvent.new(
+        language: params['language'],
+        snippet: params['snippet'],
+        action: params['event'],
+        section: params['section'],
+        ip: request.remote_ip
+      )
+
+      event.save!
+
+      render json: event
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+class UseCaseController < ApplicationController
+  before_action :set_navigation
+  before_action :canonical_redirect, only: %i[index show]
+
+  def index
+    @product = params['product']
+    @language = params['code_language']
+    @use_cases = Nexmo::Markdown::UseCase.all
+
+    @use_cases = Nexmo::Markdown::UseCase.by_product(@product, @use_cases) if @product
+    @use_cases = Nexmo::Markdown::UseCase.by_language(@language, @use_cases) if @language
+
+    @document_title = 'Use Cases'
+
+    render layout: 'page'
+  end
+
+  def show
+    # Read document
+    @document_path = Nexmo::Markdown::DocFinder.find(
+      root: "#{Rails.configuration.docs_base_path}/_use_cases",
+      document: params[:document],
+      language: I18n.locale,
+      code_language: params[:code_language]
+    ).path
+    @document = File.read(@document_path)
+
+    # Parse frontmatter
+    @frontmatter = YAML.safe_load(@document)
+
+    @document_title = @frontmatter['title']
+    @product = @frontmatter['products']
+
+    @content = Nexmo::Markdown::Renderer.new(
+      code_language: @code_language,
+      locale: params[:locale]
+    ).call(@document)
+
+    @sidenav = Sidenav.new(
+      namespace: params[:namespace],
+      locale: params[:locale],
+      request_path: request.path,
+      navigation: @navigation,
+      code_language: params[:code_language],
+      product: @product
+    )
+
+    render layout: 'documentation'
+  end
+
+  private
+
+  def set_navigation
+    @navigation = 'use-cases'
+  end
+
+  def canonical_redirect
+    return if params[:locale].nil? && session[:locale].nil?
+    return if params[:locale] && params[:locale] != I18n.default_locale.to_s
+    return if session[:locale] && session[:locale] != I18n.default_locale.to_s
+    return if params[:locale].nil? && session[:locale] == I18n.default_locale.to_s
+
+    redirect_to request.path.gsub("/#{I18n.locale}", '')
+  end
+end

data/lib/nexmo_developer/app/extensions/nokogiri/html/document.rb

@@ -0,0 +1,23 @@
+module Nokogiri
+  module HTML
+    class Document
+      def split_html
+        sections = []
+
+        css('body').children.each_with_index do |child, index|
+          if index.zero? || %w[h1 h2 h3 h4 h5 h6].include?(child.name)
+            sections << [child]
+          else
+            sections.last << child unless child.text == "\n"
+          end
+        end
+
+        sections.map! do |section|
+          Nokogiri::HTML(section.map(&:to_html).join)
+        end
+
+        sections
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+module ApplicationHelper
+  if ENV['DOCS_BASE_PATH']
+    CONFIG = YAML.load_file("#{Rails.configuration.docs_base_path}/config/business_info.yml")
+  else
+    CONFIG = {}.freeze
+  end
+
+  def search_enabled?
+    defined?(ALGOLIA_CONFIG) && ENV['ALGOLIA_SEARCH_KEY']
+  end
+
+  def theme
+    return unless ENV['THEME']
+
+    "theme--#{ENV['THEME']}"
+  end
+
+  def active_sidenav_item
+    if params[:tutorial_name]
+      url_for(controller: :tutorial, action: :index, product: params[:product], tutorial_name: params[:tutorial_name])
+    else
+      request.path.chomp("/#{params[:code_language]}")
+    end
+  end
+
+  def canonical_path
+    request.path.chomp("/#{params[:code_language]}")
+  end
+
+  def canonical_url
+    return @canonical_url if @canonical_url
+
+    canonical_path.prepend(canonical_base)
+  end
+
+  def canonical_base
+    canonical_base_from_config || request.base_url
+  end
+
+  def dashboard_cookie(campaign)
+    # 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]
+
+    # These are the things we'll be tracking through the customer dashboard
+    set_utm_cookie('utm_source', 'developer.nexmo.com')
+    set_utm_cookie('utm_medium', 'referral')
+    set_utm_cookie('utm_campaign', campaign)
+
+    # We don't use term or content as it's not paid, but they may have been set by other things
+    # If they were, delete them so our data isn't tainted
+    cookies.delete('utm_term', domain: :all)
+    cookies.delete('utm_content', domain: :all)
+  end
+
+  def set_utm_cookie(name, value)
+    cookies[name] = {
+      value: value,
+      expires: 1.year.from_now,
+      domain: :all,
+    }
+  end
+
+  def canonical_base_from_config
+    CONFIG['base_url']
+  end
+end

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

@@ -0,0 +1,9 @@
+module DateRangeHelper
+  def date_range(start_date, end_date)
+    starts = start_date.strftime('%-d %B %Y')
+    ends = end_date.strftime('%-d %B %Y')
+    return starts if start_date == end_date
+
+    "#{starts} - #{ends}"
+  end
+end

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

@@ -0,0 +1,56 @@
+HEADING_TAG_DEPTHS = {
+  'h0' => 0,
+  'h1' => 1,
+  'h2' => 2,
+  'h3' => 3,
+  'h4' => 4,
+  'h5' => 5,
+  'h6' => 6,
+}.freeze
+
+module NavigationHelper
+  def navigation_from_content(content:, title: nil)
+    content = "<h0 class='injected'>#{title}</h0>\n" + content if title
+    document = build_document(content)
+
+    nodes = ['<ul class="Vlt-sidemenu Vlt-sidemenu--flat navigation js-navigation">']
+    last_node = nil
+
+    document.css('.reveal').remove
+
+    document.css('h0,h2,h3,h4,h5,h6').each do |heading|
+      # If it's a header within tabbed content (including Code Snippets) we don't want to treat
+      # the header as a navigation item in the sidebar
+      next unless heading.ancestors('.Vlt-tabs').empty?
+
+      # Same with callouts
+      next unless heading.ancestors('.Vlt-callout').empty?
+
+      if last_node.nil? || heading.name == last_node.name
+        # Do nothing (cleaner than adding wrapping further conditions)
+      elsif heading.name >= last_node.name # e.g. h2 -> h3
+        nodes << '<ul>'
+      else # e.g. h4 -> h2
+        (HEADING_TAG_DEPTHS[last_node.name] - HEADING_TAG_DEPTHS[heading.name]).times do
+          nodes << '</li></ul>'
+        end
+      end
+
+      nodes << <<~HEREDOC
+        <li>
+          <a class="Vlt-sidemenu__link" href="##{heading.attributes['id']}" data-scrollspy-id="#{heading['data-id']}">
+            #{heading.text}
+          </a>
+      HEREDOC
+      last_node = heading
+    end
+    nodes << '</li></ul>'
+    nodes.join("\n").html_safe
+  end
+
+  private
+
+  def build_document(content)
+    Nokogiri::HTML::DocumentFragment.parse(content)
+  end
+end

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

@@ -0,0 +1,5 @@
+module ParameterValuesHelper
+  def parameter_values(enum)
+    to_sentence(enum.map { |value| tag.code(value) }, last_word_connector: ' or ', two_words_connector: ' or ')
+  end
+end

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

@@ -0,0 +1,20 @@
+module VideoHelper
+  def video_embed_url(video_url)
+    if video_url.include? 'youtube'
+      video_id = video_url.match(/v=(.{11})/)[1]
+      return "https://www.youtube.com/embed/#{video_id}?showinfo=0"
+    end
+
+    if video_url.include? 'vimeo'
+      video_id = video_url.match(/(\d{7,})/)[1]
+      return "https://player.vimeo.com/video/#{video_id}"
+    end
+
+    video_url
+  end
+
+  def featured_video
+    # Any of the latest 3 videos can be "featured"
+    Session.where(published: true).order(created_at: 'desc').limit(3).sample
+  end
+end

data/lib/nexmo_developer/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/lib/nexmo_developer/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/lib/nexmo_developer/app/middleware/nexmo_developer/building_block_redirect.rb

@@ -0,0 +1,18 @@
+module NexmoDeveloper
+  class BuildingBlockRedirect
+    def initialize(app)
+      @app = app
+    end
+
+    def redirect(location)
+      [301, { 'Location' => location, 'Content-Type' => 'text/html' }, ['Moved Permanently']]
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      return redirect(req.path.gsub('/building-blocks/', '/code-snippets/')) if req.path.include? '/building-blocks/'
+
+      @app.call(env)
+    end
+  end
+end

data/lib/nexmo_developer/app/middleware/nexmo_developer/visitor_id.rb

@@ -0,0 +1,13 @@
+module NexmoDeveloper
+  class VisitorId
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      req.session['visitor_id'] ||= "G-#{SecureRandom.alphanumeric(8)}"
+      @app.call(env)
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+class ApiError
+  include ActiveModel::Model
+  attr_accessor :id, :description, :resolution, :link_url
+  attr_writer :link_text
+
+  def link_text
+    @link_text || 'Find out more'
+  end
+
+  def link=(link)
+    @link_text = link['text']
+    @link_url = link['url']
+  end
+
+  def link
+    return nil unless @link_text && @link_url
+
+    OpenStruct.new({
+      text: @link_text,
+      url: @link_url,
+    })
+  end
+
+  def self.parse_config(errors)
+    return [] if errors.blank?
+
+    errors.map do |id, config|
+      ApiError.new({ id: id }.merge(config))
+    end
+  end
+end