station 0.0.0 → 0.0.100

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

@@ -0,0 +1,71 @@
+class SidenavSubitem < SidenavItem
+  include Rails.application.routes.url_helpers
+
+  def title
+    @title ||= TitleNormalizer.call(@folder)
+    raise "Missing 'title' in frontmatter for #{@folder[:path]}" unless @title
+
+    @title
+  end
+
+  def show_link?
+    @folder[:is_file?] || @folder[:is_tabbed?]
+  end
+
+  def collapsible?
+    @options['collapsible'].nil? || @options['collapsible']
+  end
+
+  def url
+    @url ||= @folder[:external_link] || build_url
+  end
+
+  def build_url
+    if @folder[:root] == Tutorial.tutorials_path
+      url_for(
+        tutorial_name: Navigation.new(@folder).path_to_url,
+        controller: :tutorial,
+        action: :index,
+        product: @folder[:product],
+        only_path: true,
+        locale: locale
+      )
+    elsif @folder[:root] == "#{Rails.configuration.docs_base_path}/_use_cases"
+      url_for(
+        document: Navigation.new(@folder).path_to_url,
+        controller: controller,
+        action: :show,
+        only_path: true,
+        locale: locale
+      )
+    elsif @folder[:path].starts_with?('app/views')
+      navigation = Navigation.new(@folder)
+      url_for(
+        controller: :markdown,
+        action: :show,
+        document: navigation.document,
+        namespace: namespace,
+        only_path: true,
+        locale: locale
+      )
+    else
+      navigation = Navigation.new(@folder)
+      url_for(
+        controller: :markdown,
+        action: :show,
+        document: navigation.document,
+        product: navigation.product,
+        only_path: true,
+        locale: locale
+      )
+    end
+  end
+
+  def controller
+    if @folder[:path].starts_with?("#{Rails.configuration.docs_base_path}/_documentation")
+      :markdown
+    elsif @folder[:path].starts_with?("#{Rails.configuration.docs_base_path}/_use_cases")
+      :use_case
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+class TitleNormalizer
+  def self.call(folder)
+    new(folder).normalize
+  end
+
+  def initialize(folder)
+    @folder = folder
+  end
+
+  def normalize
+    if @folder[:is_task?] || @folder[:is_tabbed?]
+      @folder[:title]
+    elsif @folder[:is_file?]
+      frontmatter['navigation'] || frontmatter['title']
+    else
+      I18n.t("menu.#{@folder[:title]}")
+    end
+  end
+
+  private
+
+  def frontmatter
+    @frontmatter ||= YAML.load_file(@folder[:path])
+  end
+end

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

@@ -0,0 +1,23 @@
+class Topnav
+  CONFIG = "#{Rails.configuration.docs_base_path}/config/top_navigation.yml".freeze
+
+  def initialize(navigation)
+    @navigation = navigation
+
+    after_initialize!
+  end
+
+  def items
+    @items ||= begin
+      YAML.safe_load(File.open(CONFIG)).map do |name, url|
+        TopnavItem.new(name, url, @navigation)
+      end
+    end
+  end
+
+  private
+
+  def after_initialize!
+    raise 'You must provide a config/top_navigation.yml file in your documentation path.' unless File.exist?(CONFIG)
+  end
+end

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

@@ -0,0 +1,19 @@
+class TopnavItem
+  attr_reader :url
+
+  def initialize(name, url, navigation)
+    @name       = name
+    @url        = url
+    @navigation = navigation.to_s
+  end
+
+  def title
+    @title ||= I18n.t("layouts.partials.header.#{@name.downcase}")
+  end
+
+  def css_classes
+    classes = ['Vlt-tabs__link']
+    classes << 'Vlt-tabs__link_active' if @navigation == @name.downcase
+    classes.join(' ')
+  end
+end

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

@@ -0,0 +1,99 @@
+class TutorialListItem
+  attr_accessor :product
+  attr_reader :path
+
+  def initialize(path)
+    @path = path
+  end
+
+  def tutorial
+    @tutorial ||= Tutorial.load(File.basename(@path, '.yml'), nil)
+  end
+
+  def subtitle
+    products
+      .map { |product| Product.normalize_title(product) }
+      .sort
+      .to_sentence
+  end
+
+  def languages
+    @languages ||= tutorial.available_code_languages.map(&:downcase)
+  end
+
+  def root
+    "#{Rails.configuration.docs_base_path}/config/tutorials"
+  end
+
+  def filename
+    File.basename(@path, '.yml')
+  end
+
+  def external_link
+    tutorial.metadata.external_link
+  end
+
+  def title
+    tutorial.metadata.title
+  end
+
+  def description
+    tutorial.metadata.description
+  end
+
+  def products # rubocop:disable Rails/Delegate
+    tutorial.products
+  end
+
+  # rubocop:disable Naming/PredicateName
+  def is_file?
+    true
+  end
+
+  def is_task?
+    true
+  end
+  # rubocop:enable Naming/PredicateName
+
+  def first_step
+    return if tutorial.metadata.external_link
+
+    tutorial.first_step
+  end
+
+  def product_url
+    "/#{I18n.locale}/#{products.join('')}/tutorials"
+  end
+
+  def url
+    external_link || "/#{I18n.locale}/#{products.join('')}/tutorials/#{filename}/#{first_step}"
+  end
+
+  def available_languages
+    languages.map do |language|
+      OpenStruct.new(
+        language: language,
+        label: Nexmo::Markdown::CodeLanguage.find(language).label,
+        url: external_link || "/#{products.join('')}/tutorials/#{filename}/#{first_step}/#{language}"
+      )
+    end
+  end
+
+  def as_json
+    {
+      root: root,
+      path: path,
+      filename: filename,
+      external_link: external_link,
+      first_step: first_step,
+      languages: languages,
+      title: title,
+      description: description,
+      products: products,
+      subtitle: subtitle,
+      is_file?: is_file?,
+      is_task?: is_task?,
+      product: product,
+    }
+  end
+end

data/lib/nexmo_developer/app/screenshots/webhook-url-for-delivery-receipt.js

@@ -0,0 +1,44 @@
+const puppeteer = require('puppeteer');
+const fs = require('fs');
+const sha1File = require('sha1-file');
+require('dotenv').config();
+
+if (!fs.existsSync('./public/assets/screenshots')){
+  fs.mkdirSync('./public/assets/screenshots');
+}
+
+(async () => {
+  const browser = await puppeteer.launch();
+  const page = await browser.newPage();
+  await page.setViewport({ width: 800, height: 500 })
+  await page.goto('https://dashboard.nexmo.com/sign-in');
+
+  await page.waitForSelector('input[name=username]')
+  await page.type('input[name=username]', process.env.NEXMO_USERNAME)
+  await page.type('input[name=password]', process.env.NEXMO_PASSWORD)
+  await page.click('#btn_login')
+
+  await page.waitForSelector('#nav-expander')
+  await page.goto('https://dashboard.nexmo.com/settings');
+
+  await page.waitForSelector('#nav-expander')
+  await page.click('#httpBaseUrlForDnPost')
+
+  await page.addStyleTag({
+    content: `
+      #sysId, #password, #signatureSecret {
+        filter: blur(5px);
+      }
+    `
+  })
+
+  await page.screenshot({ path: 'public/assets/screenshots/tmp.png' })
+
+  const sha = sha1File('public/assets/screenshots/tmp.png')
+  const newPath = `public/assets/screenshots/${sha}.png`
+  fs.renameSync('public/assets/screenshots/tmp.png', newPath)
+
+  await browser.close();
+
+  console.log(newPath);
+})();

data/lib/nexmo_developer/app/screenshots/webhook-url-for-inbound-message.js

@@ -0,0 +1,44 @@
+const puppeteer = require('puppeteer')
+const fs = require('fs')
+const sha1File = require('sha1-file')
+require('dotenv').config()
+
+if (!fs.existsSync('./public/assets/screenshots')){
+  fs.mkdirSync('./public/assets/screenshots')
+}
+
+(async () => {
+  const browser = await puppeteer.launch()
+  const page = await browser.newPage()
+  await page.setViewport({ width: 800, height: 500 })
+  await page.goto('https://dashboard.nexmo.com/sign-in')
+
+  await page.waitForSelector('input[name=username]')
+  await page.type('input[name=username]', process.env.NEXMO_USERNAME)
+  await page.type('input[name=password]', process.env.NEXMO_PASSWORD)
+  await page.click('#btn_login')
+
+  await page.waitForSelector('#nav-expander')
+  await page.goto('https://dashboard.nexmo.com/settings')
+
+  await page.waitForSelector('#nav-expander')
+  await page.click('#httpBaseUrlForMoPost')
+
+  await page.addStyleTag({
+    content: `
+      #sysId, #password, #signatureSecret {
+        filter: blur(5px)
+      }
+    `
+  })
+
+  await page.screenshot({ path: 'public/assets/screenshots/tmp.png' })
+
+  const sha = sha1File('public/assets/screenshots/tmp.png')
+  const newPath = `public/assets/screenshots/${sha}.png`
+  fs.renameSync('public/assets/screenshots/tmp.png', newPath)
+
+  await browser.close()
+
+  console.log(newPath)
+})()

data/lib/nexmo_developer/app/services/diff.rb

@@ -0,0 +1,146 @@
+require 'diffy'
+
+class Diff
+  def self.generate(mode:)
+    document_paths = {
+      documentation: {
+        documents: Dir.glob("#{Rails.configuration.docs_base_path}/_documentation/**/*.md"),
+        origin: Pathname.new("#{Rails.configuration.docs_base_path}/_documentation"),
+        base_url_path: '',
+      },
+      api: {
+        documents: Dir.glob("#{Rails.configuration.docs_base_path}/_api/**/*.md"),
+        origin: Pathname.new("#{Rails.configuration.docs_base_path}/_api"),
+        base_url_path: '/api',
+      },
+      tutorials: {
+        documents: Dir.glob("#{Rails.configuration.docs_base_path}/_use_cases/**/*.md"),
+        origin: Pathname.new("#{Rails.configuration.docs_base_path}/_use_cases"),
+        base_url_path: '/tutorials',
+      },
+    }
+
+    document_paths.each do |_, config|
+      config[:documents].map do |document_path|
+        document_path = Pathname.new(document_path)
+        relative_path = "#{config[:base_url_path]}/#{document_path.relative_path_from(config[:origin])}".gsub('.md', '')
+        path = "#{Rails.root}/tmp/diff/#{mode}/#{relative_path}.html"
+        directory = File.dirname(path)
+        FileUtils.mkdir_p(directory) unless File.directory?(directory)
+
+        begin
+          document = File.read(document_path)
+          body_html = Nexmo::Markdown::Renderer.new.call(document)
+          document = Nokogiri::HTML::DocumentFragment.parse(body_html)
+
+          ['id', 'data-tabs-content', 'data-id', 'data-open', 'data-collapsible-id'].each do |attribute|
+            document.css("[#{attribute}]").each do |element|
+              element[attribute] = nil
+            end
+          end
+
+          document.css('.tabs a').each do |element|
+            element['href'] = nil
+          end
+
+          File.open(path, 'w') do |file|
+            file.write document.to_html
+          end
+        rescue StandardError
+          Rails.logger.error("File failed to generate - #{relative_path}".colorize(:yellow))
+          File.open(path, 'w') do |file|
+            file.write <<~HEREDOC
+              ###############################################################################
+              File failed to generate. Likely due to a dependent file being moved or removed.
+              ###############################################################################
+            HEREDOC
+          end
+        end
+      end
+    end
+  end
+
+  def diff(mode)
+    return @output if @output
+
+    @output = []
+
+    Dir.glob("#{Rails.root}/tmp/diff/base/**/*.html") do |base_document_path|
+      compare_document_path = base_document_path.sub("#{Rails.root}/tmp/diff/base/", "#{Rails.root}/tmp/diff/compare/")
+
+      base_document = File.read(base_document_path)
+      compare_document = File.read(compare_document_path)
+      path = base_document_path.sub("#{Rails.root}/tmp/diff/base", '').sub('.html', '')
+
+      diff_response = Diffy::Diff.new(base_document, compare_document, context: 0).to_s(mode)
+
+      unless diff_response.empty? || diff_response == "\n"
+        @output << {
+          path: path,
+          diff: diff_response,
+        }
+      end
+    end
+
+    @output.reject!(&:empty?)
+  end
+
+  def report_cli
+    if @output.any?
+      Rails.logger.info("#{@output.size} changes detected".colorize(:light_red))
+      @output.reject.each do |result|
+        Rails.logger.info(
+          <<~HEREDOC
+            #{result[:path]}
+             #{result[:diff]}
+
+
+          HEREDOC
+        )
+      end
+
+      exit 1 # rubocop:disable Rails/Exit
+    else
+      Rails.logger.info('No changes detected'.colorize(:green))
+    end
+  end
+
+  def report_pull_request
+    if @output.any?
+      time = Time.new.to_i
+      branch = "code-example-update-#{time}"
+      Rails.logger.info("Checking out new branch - #{branch}".colorize(:yellow))
+      system "git checkout -b #{branch}"
+      Rails.logger.info('Adding repo files'.colorize(:yellow))
+      system 'git add .repos'
+      Rails.logger.info('Commiting changes'.colorize(:yellow))
+      system "git commit -m 'Automated: Updating code examples'"
+      Rails.logger.info('Pushing'.colorize(:yellow))
+      system "git push git@github.com:Nexmo/nexmo-developer.git #{branch}"
+
+      body = "#{@output.size} changes detected\n\n"
+      @output.reject.each do |result|
+        body << <<~HEREDOC
+          - [ ] `#{result[:path]}`
+
+          ```diff
+          #{result[:diff]}
+          ```
+
+        HEREDOC
+      end
+
+      Rails.logger.info("Notifying Nexmo Developer of branch - #{branch}".colorize(:yellow))
+      RestClient.post ENV['OPEN_PULL_REQUEST_ENDPOINT'], {
+        'branch' => branch,
+        'body' => body,
+        'secret' => ENV['CI_SECRET'],
+      }.to_json, {
+        content_type: :json,
+        accept: :json,
+      }
+    else
+      Rails.logger.info('No changes detected'.colorize(:green))
+    end
+  end
+end