station 0.0.0 → 0.0.93

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

data/lib/nexmo_developer/lib/tasks/smartling.rake

@@ -0,0 +1,65 @@
+namespace :smartling do
+  desc 'Update a translation file for a given locale'
+  task :update_translation, %i[file locale] => [:environment] do |_, args|
+    smartling = SmartlingAPI.new(
+      user_id: ENV['SMARTLING_USER_ID'],
+      user_secret: ENV['SMARTLING_USER_SECRET'],
+      project_id: ENV['SMARTLING_PROJECT_ID']
+    )
+
+    puts 'Updating the file...'
+    smartling.download_translated(filename: args[:file], locale: args[:locale])
+    puts 'Done!'
+  end
+
+  desc 'Upload a file'
+  task :upload_file, %i[file locale] => [:environment] do |_, args|
+    # be rake "smartling:upload_file[_documentation/en/messages/overview.md,en]"
+    smartling = SmartlingAPI.new(
+      user_id: ENV['SMARTLING_USER_ID'],
+      user_secret: ENV['SMARTLING_USER_SECRET'],
+      project_id: ENV['SMARTLING_PROJECT_ID']
+    )
+
+    puts 'Uploading the file...'
+    smartling.upload(args[:file])
+    puts 'Done!'
+  end
+
+  desc 'Downloading a translation for a given locale'
+  task :download_translation, %i[file locale type] => [:environment] do |_, args|
+    # be rake "smartling:download_translation[_documentation/en/messages/overview.md,en-US,pseudo]"
+    smartling = SmartlingAPI.new(
+      user_id: ENV['SMARTLING_USER_ID'],
+      user_secret: ENV['SMARTLING_USER_SECRET'],
+      project_id: ENV['SMARTLING_PROJECT_ID']
+    )
+
+    puts 'Downloading the translation...'
+    smartling.download_translated(filename: args[:file], locale: args[:locale], type: args[:type])
+    puts 'Done!'
+  end
+
+  desc 'Check for new translations by locale and download them'
+  task 'download': :environment do
+    puts 'Checking for completed translations and downloading them'
+
+    Translator::SmartlingDownloader.new.call
+
+    puts 'Done!'
+  end
+
+  desc 'Upload recently modified docs to Smartling for translation'
+  task :upload, %i[paths frequency] => [:environment] do |_, args|
+    # RAILS_ENV=production RAILS_LOG_TO_STDOUT=1 be nexmo-developer --docs=`pwd` --rake-smartling-upload  15 messages/test.md messages/external-accounts/overview.md
+    puts "Uploading files to Smartling with a translation frequency of #{args[:frequency]} days..."
+    puts args[:paths].join("\n")
+
+    Translator::TranslatorCoordinator.new(
+      paths: args[:paths],
+      frequency: args[:frequency]
+    ).create_smartling_jobs!
+
+    puts 'Done!'
+  end
+end

data/lib/nexmo_developer/lib/tasks/test.rake

@@ -0,0 +1,22 @@
+require 'pty'
+
+# Add additional test suite definitions to the default test task here
+namespace :test do
+  desc 'Crawl'
+  task crawl: :environment do
+    if ENV['PORT']
+      system("rawler 127.0.0.1:#{ENV['PORT']} --local --wait 0 --ignore-fragments")
+    else
+      system('rawler developer.dev --local --wait 0 --ignore-fragments')
+    end
+
+    exit $CHILD_STATUS.exitstatus unless $CHILD_STATUS.exitstatus.zero?
+  end
+
+  desc 'Run all tests'
+  task all: :environment do
+    Rake::Task['test:rubocop'].invoke
+    Rake::Task['spec'].invoke
+    Rake::Task['test:crawl'].invoke
+  end
+end

data/lib/nexmo_developer/nexmo_developer.rb

@@ -0,0 +1 @@
+require_relative 'version'

data/lib/nexmo_developer/public/404.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/lib/nexmo_developer/public/422.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>