station 0.0.0 → 0.0.100

data/lib/nexmo_developer/lib/tasks/diff.rake

@@ -0,0 +1,40 @@
+namespace :diff do
+  desc 'Build files for comparison'
+  task 'execute': :environment do
+    puts 'Building base'.colorize(:yellow)
+    Rake::Task['diff:build:base'].invoke
+
+    puts 'Updating repos'.colorize(:yellow)
+    Rake::Task['repos:pull'].invoke
+
+    puts 'Building comparison'.colorize(:yellow)
+    Rake::Task['diff:build:compare'].invoke
+    puts 'Comparing'.colorize(:yellow)
+
+    Rake::Task['diff:compare:pr'].invoke
+  end
+
+  desc 'Build files for comparison'
+  task 'build:base': :environment do
+    Diff.generate(mode: 'base')
+  end
+
+  desc 'Build files for comparison'
+  task 'build:compare': :environment do
+    Diff.generate(mode: 'compare')
+  end
+
+  desc 'Build files for comparison'
+  task 'compare:cli': :environment do
+    diff = Diff.new
+    diff.diff(:color)
+    diff.report_cli
+  end
+
+  desc 'Build files for comparison'
+  task 'compare:pr': :environment do
+    diff = Diff.new
+    diff.diff(:text)
+    diff.report_pull_request
+  end
+end

data/lib/nexmo_developer/lib/tasks/documentation.rake

@@ -0,0 +1,18 @@
+namespace :documentation do
+  desc 'Verify all pages have meta_title and description keys'
+  task 'check_keys': :environment do
+    documentation_path = "#{Rails.configuration.docs_base_path}/_documentation/**/*.md"
+    documents = []
+
+    Dir.glob(documentation_path).each do |filename|
+      document = YAML.safe_load(File.read(filename))
+      meta_title = document['meta_title']
+      description = document['description']
+      if meta_title.blank? || description.blank?
+        documents.push(filename.split('/_documentation')[1])
+      end
+    end
+    count = documents.count
+    raise "The following #{count} documents are missing either a 'meta_title' or 'description' key:\n#{documents.join("\n")}" if count.positive?
+  end
+end

data/lib/nexmo_developer/lib/tasks/generate_search_terms.rake

@@ -0,0 +1,39 @@
+require 'algoliasearch'
+
+namespace :search_terms do
+  desc 'Publish search terms to Algolia'
+  task 'algolia:generate', %i[locale] => :environment do |_, args|
+    unless ENV['ALGOLIA_APPLICATION_ID']
+      puts 'Not rebuilding search index, Algolia Application ID not set'
+      next
+    end
+
+    Algolia.init(application_id: ENV['ALGOLIA_APPLICATION_ID'], api_key: ENV['ALGOLIA_API_KEY'])
+    index = Algolia::Index.new "#{Rails.env}_nexmo_developer"
+    search_articles = SearchTerms.generate(args.fetch(:locale, I18n.default_locale))
+
+    search_articles.each do |search_article|
+      index.add_object(search_article)
+    rescue Algolia::AlgoliaProtocolError
+      # puts search_article
+      puts "#{search_article[:document_path]} could not be processed"
+    end
+  end
+
+  desc 'Clear the index in Algolia'
+  task 'algolia:clear': :environment do
+    unless ENV['ALGOLIA_APPLICATION_ID']
+      puts 'Not rebuilding search index, Algolia Application ID not set'
+      next
+    end
+    Algolia.init(application_id: ENV['ALGOLIA_APPLICATION_ID'], api_key: ENV['ALGOLIA_API_KEY'])
+    index = Algolia::Index.new "#{Rails.env}_nexmo_developer"
+    index.clear_index
+  end
+
+  desc 'Refresh the Algolia index'
+  task 'algolia:refresh': :environment do
+    Rake::Task['search_terms:algolia:clear'].invoke
+    Rake::Task['search_terms:algolia:generate'].invoke
+  end
+end

data/lib/nexmo_developer/lib/tasks/links.rake

@@ -0,0 +1,135 @@
+require 'terminal-table'
+
+namespace :links do
+  desc 'Generate a report of all links FROM a given page'
+  task 'report_outbound': :environment do
+    ARGV.each { |a| task a.to_sym }
+    filter = ARGV[1]
+    table = Terminal::Table.new do |t|
+      get_links_on_a_page("#{Rails.configuration.docs_base_path}/_documentation/**/*.md").each do |from, to|
+        next if filter && from.exclude?(filter)
+
+        t << [from.split(%r{(.{25,1000}/)}).join("\n").strip, to.join("\n")]
+        t << :separator
+      end
+    end
+    table.headings = ['From', 'To']
+    puts table
+  end
+
+  desc 'Generate a report of all links TO a given page'
+  task 'report_inbound': :environment do
+    ARGV.each { |a| task a.to_sym }
+    filter = ARGV[1]
+    table = Terminal::Table.new do |t|
+      get_links_to_a_page("#{Rails.configuration.docs_base_path}/_documentation/**/*.md").each do |to, from|
+        next if filter && to.exclude?(filter)
+
+        t << [to, from.join("\n")]
+        t << :separator
+      end
+    end
+    table.headings = ['To', 'From']
+    puts table
+  end
+
+  desc 'Show all pages with no outbound links'
+  task 'no_links_outbound': :environment do
+    get_links_on_a_page("#{Rails.configuration.docs_base_path}/_documentation/**/*.md").each do |from, to|
+      puts from if to.empty?
+    end
+  end
+
+  desc 'Show all pages with no inbound links'
+  task 'no_links_inbound': :environment do
+    get_links_to_a_page("#{Rails.configuration.docs_base_path}/_documentation/**/*.md").each do |to, from|
+      puts to if from.empty?
+    end
+  end
+
+  desc 'Generate graph of all links out of pages'
+  task 'graph_outbound': :environment do
+    ARGV.each { |a| task a.to_sym }
+    filter = ARGV[1]
+    additional_title = ''
+    additional_title = "containing '#{filter}'" if filter
+    puts 'digraph {'
+    get_links_on_a_page("#{Rails.configuration.docs_base_path}/_documentation/**/*.md").each do |from, to|
+      next if filter && from.exclude?(filter)
+
+      to.each do |l|
+        puts "\"#{from}\" -> \"#{l}\""
+      end
+    end
+    puts <<~HEREDOC
+      labelloc="t";
+      label="Links FROM pages #{additional_title}";
+    HEREDOC
+    puts '}'
+  end
+
+  desc 'Generate graph of all links to pages'
+  task 'graph_inbound': :environment do
+    ARGV.each { |a| task a.to_sym }
+    filter = ARGV[1]
+    additional_title = ''
+    additional_title = "containing '#{filter}'" if filter
+    puts 'digraph {'
+    get_links_to_a_page("#{Rails.configuration.docs_base_path}/_documentation/**/*.md").each do |to, from|
+      next if filter && to.exclude?(filter)
+
+      from.each do |l|
+        puts "\"#{l}\" -> \"#{to}\""
+      end
+    end
+    puts <<~HEREDOC
+      labelloc="t";
+      label="Links TO pages #{additional_title}";
+    HEREDOC
+    puts '}'
+  end
+end
+
+def get_links_on_a_page(path)
+  all_links = {}
+  get_all_links(path) do |current_page, links|
+    all_links[current_page] = links
+  end
+
+  all_links
+end
+
+def get_links_to_a_page(path)
+  all_links = {}
+  get_all_links(path) do |current_page, links|
+    links.each do |l|
+      all_links[l] ||= []
+      all_links[l].push(current_page)
+    end
+  end
+
+  all_links
+end
+
+def get_all_links(path)
+  Dir.glob(path).first(10000).each do |filename|
+    # Generate the resultant HTML
+    document = File.read(filename)
+    output = Nexmo::Markdown::Renderer.new.call(document)
+
+    # Get our current URL
+    current_page = filename.gsub("#{Rails.configuration.docs_base_path}/_documentation", '').gsub(/\.md$/, '')
+    # Load all links on the page
+    links = get_links_from_html(output)
+
+    yield(current_page, links)
+  end
+end
+
+def get_links_from_html(html)
+  Nokogiri::HTML(html).css('a')
+          .map { |link| link.attr('href') }
+          .compact
+          .reject { |link| link.start_with?('#', 'http', 'mailto:') }
+          .uniq
+end

data/lib/nexmo_developer/lib/tasks/move.rake

@@ -0,0 +1,58 @@
+require 'yaml'
+desc 'Move content from one location to another. (Be careful with this one)'
+task move: :environment do
+  ARGV.each { |a| task a.to_sym }
+
+  from = ARGV[1]
+  to = ARGV[2]
+
+  raise 'Usage: rake move <from> <to>' unless from && to
+
+  to_dir, = File.split(to)
+
+  # Make sure it starts with _documentation
+  documentation_folder = "#{Rails.configuration.docs_base_path}/_documentation/"
+  raise "'from' must start with '#{documentation_folder}'" unless from[0..documentation_folder.length - 1] == documentation_folder
+  raise "'to' must start with '#{documentation_folder}'" unless to[0..documentation_folder.length - 1] == documentation_folder
+
+  raise "You tried to move files from a location that doesn't exist (#{from})" unless File.exist? from
+  raise "You tried to move files to a location that doesn't exist (#{to})" unless File.exist? to_dir
+  raise "You tried to move files to a location that already exists (#{to})" if File.exist? to
+
+  # Load up our redirect file
+  path = "#{Rails.root}/config/automatic-redirects.yml"
+  document = File.read(path)
+  redirects = YAML.safe_load(document) || {}
+
+  # Add a top level redirect
+  add_redirect(documentation_folder, from, to, redirects)
+
+  # Iterate over every file in there and build up a list
+  Dir.glob("#{from}/**/*").each do |filename|
+    target = filename.gsub(from, to)
+    add_redirect(documentation_folder, filename, target, redirects)
+  end
+
+  # Actually move the files
+  FileUtils.mv(from, to)
+
+  File.write(path, redirects.to_yaml)
+rescue StandardError => e
+  puts e
+  exit(1)
+end
+
+def add_redirect(documentation_folder, from, to, redirects)
+  # Strip off the leading _documentation as that never shows in the URL
+  from = from.gsub(documentation_folder, '')
+  to = to.gsub(documentation_folder, '')
+
+  puts "#{from} => #{to}"
+
+  ext = File.extname(from)
+  from = from.gsub(ext, '')
+  to = to.gsub(ext, '')
+
+  # Also strip off any file types
+  redirects[from] = to
+end

data/lib/nexmo_developer/lib/tasks/repos.rake

@@ -0,0 +1,57 @@
+require 'colorize'
+require 'ruby-progressbar'
+
+namespace :repos do
+  desc 'Pull repos to local'
+  task pull: :environment do
+    ARGV.each { |a| task a.to_sym }
+
+    repos = []
+
+    if ARGV[1]
+      repo = Repo.new(branch: ARGV[2])
+      if Repo.valid_url? ARGV[1]
+        repo.url = ARGV[1]
+      else
+        repo.repo = ARGV[1]
+      end
+      repos << repo
+    else
+      repos = YAML.load_file("#{Rails.root}/config/repos.yml").map do |namespace, config|
+        Repo.new({ namespace: namespace }.merge(config))
+      end
+    end
+
+    progressbar = ProgressBar.create(total: repos.count)
+
+    warnings = []
+
+    # rubocop:disable Style/CombinableLoops
+    repos.each do |r|
+      if r.path
+        if File.directory?("#{Rails.root}/#{r.path}")
+          warnings << "A path has been used for #{r.namespace}. This should be removed or commented out and rake repos:pull run again before committing"
+        else
+          puts "Path #{r.path} provided for #{r.namespace} but does not exist. Can not continue.".colorize(:light_red)
+          exit 1
+        end
+      end
+    end
+
+    repos.each do |r|
+      system "rm -rf #{r.directory} 2>&1", out: File::NULL
+
+      if r.path
+        system "ln -s #{Rails.root}/#{r.path} #{r.directory}", out: File::NULL
+      else
+        system "git clone --depth=1 #{r.url} -b #{r.branch} #{r.directory} 2>&1", out: File::NULL
+        system "rm -rf #{r.directory}/.git 2>&1", out: File::NULL
+      end
+
+      progressbar.increment
+    end
+    # rubocop:enable Style/CombinableLoops
+
+    warnings.each { |warning| puts warning.colorize(:light_yellow) }
+  end
+end

data/lib/nexmo_developer/lib/tasks/screenshots.rake

@@ -0,0 +1,11 @@
+namespace :screenshots do
+  desc 'Update all automated screenshots'
+  task all: :environment do
+    Screenshot.update_all
+  end
+
+  desc 'Create new screenshots'
+  task new: :environment do
+    Screenshot.update_new
+  end
+end

data/lib/nexmo_developer/lib/tasks/section.rake

@@ -0,0 +1,146 @@
+require 'yaml'
+namespace :section do
+  desc 'Bootstrap a new section'
+  task create: :environment do
+    ARGV.each { |a| task a.to_sym }
+    section_name = ARGV[1]
+    current_dir = Dir.pwd
+    slug = section_name.parameterize
+
+    base_url = "#{current_dir}/_documentation/#{slug}"
+
+    if File.exist? base_url
+      warning = "The section '#{section_name}' already exists. Stopping generation"
+      puts warning.colorize(:red)
+      next
+    end
+
+    # Create our folders
+    FileUtils.mkdir_p base_url
+    FileUtils.mkdir_p "#{base_url}/code-snippets"
+    FileUtils.mkdir_p "#{base_url}/guides"
+
+    # Create some placeholder content
+    File.write("#{base_url}/overview.md", overview_content(section_name, slug))
+    File.write("#{base_url}/api-reference.md", api_reference_content)
+    File.write("#{base_url}/code-snippets/block-title.md", code_snippet_content(section_name, slug))
+    File.write("#{base_url}/guides/guide-title.md", guide_content(section_name, slug))
+
+    # Create the initial translation for the sidebar
+    locale_path = "#{current_dir}/config/locales/en.yml"
+    locale = YAML.load_file(locale_path)
+    locale['en']['menu'][slug] = section_name
+    File.write(locale_path, locale.to_yaml)
+
+    # Create the redirect from /{section_name} to /{section_name}/overview
+    redirect_path = "#{current_dir}/config/redirects.yml"
+    redirect = YAML.load_file(redirect_path)
+    redirect["/#{slug}"] = "/#{slug}/overview"
+    File.write(redirect_path, redirect.to_yaml)
+  end
+end
+
+def overview_content(section_name, slug)
+  <<~HEREDOC
+    ---
+    title: Overview
+    ---
+
+    # Overview
+
+    Nexmo's #{section_name} API allows you to...
+
+    * Selling point one
+    * Selling point two
+    * Selling point three
+
+    ## Contents
+
+    In this document you can learn about:
+
+    * [Nexmo #{section_name} Concepts](#concepts)
+    * [How to Get Started with the #{section_name} API](#getting-started)
+    * [Code Snippets](#code-snippets)
+    * [Guides](#guides)
+    * [Use Cases](#use-cases)
+    * [Reference](#reference)
+
+    ## Concepts
+
+    * [Title](/url/goes/here)
+
+    ## Getting Started
+
+    * [Title](/url/goes/here)
+
+    ## Code Snippets
+
+    * [Title](/url/goes/here)
+
+    ## Guides
+
+    * [Title](/url/goes/here)
+
+    ## Tutorials
+
+    * [Title](/url/goes/here)
+
+    ## Reference
+
+    * [#{section_name} API Reference](/api/#{slug})
+
+  HEREDOC
+end
+
+def code_snippet_content(section_name, slug)
+  <<~HEREDOC
+    ---
+    title: Snippet Title
+    description: How do to this cool thing with the Nexmo #{section_name} API
+    navigation_weight: 1
+    ---
+
+    # Title Goes Here
+
+    The #{section_name} API is great. So great that we're going to show you how
+    it works right now!
+
+    Sign up for an account and replace the following variables in the example below:
+
+    Key |	Description
+    -- | --
+    `TO_NUMBER` |	The number you are sending a #{section_name} to in E.164  format. For example `447700900000`.
+    `NEXMO_API_KEY` | You can find this in your account overview
+    `NEXMO_API_SECRET` | You can find this in your account overview
+
+    ```tabbed_content
+    source: '_examples/#{slug}/code-snippet-name-here'
+    ```
+  HEREDOC
+end
+
+def guide_content(section_name, _slug)
+  <<~HEREDOC
+    ---
+    title: #{section_name} Guide Title
+    ---
+
+    # #{section_name} Guide Here
+
+    This is a placeholder page. Please update it with real content or delete this
+    file
+  HEREDOC
+end
+
+def api_reference_content
+  <<~HEREDOC
+    ---
+    title: API Reference
+    ---
+
+    # API Reference
+
+    This page is never rendered, it is used as a placeholder to generate
+    the necessary navigation item.
+  HEREDOC
+end