station 0.0.0 → 0.0.93

data/lib/nexmo_developer/db/seeds.rb

@@ -0,0 +1,70 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create!([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create!(name: 'Luke', movie: movies.first)
+
+unless Rails.env.test?
+  User.create!(email: 'api.admin@vonage.com', password: 'development', admin: true)
+end
+
+Event.create!({
+  title: 'Small business hackathon',
+  starts_at: Time.zone.parse('2020-03-04'),
+  ends_at: Time.zone.parse('2020-03-05'),
+  url: 'http://www.smallbizhack.com/',
+  description: 'Hack to create new innovations that help small businesses save time so they can get back to their passions',
+  city: 'Mountain View',
+  country: 'US',
+})
+
+Event.create!({
+  title: 'Forward JS',
+  starts_at: Time.zone.parse('2020-03-01'),
+  ends_at: Time.zone.parse('2020-03-01'),
+  url: 'https://forwardjs.com/',
+  description: 'Illuminating lectures, & enlightening workshops',
+  city: 'Ottawa',
+  country: 'CA',
+})
+
+Event.create!({
+  title: 'Render',
+  starts_at: Time.zone.parse('2020-03-30'),
+  ends_at: Time.zone.parse('2020-03-31'),
+  url: 'http://2020.render-conf.com/',
+  description: 'A 2-day conference for front-end developers',
+  city: 'Oxford',
+  country: 'GB',
+})
+
+devrel_con = Event.create!({
+  title: 'DevRelCon London 2016',
+  starts_at: Time.zone.parse('2016-12-07'),
+  ends_at: Time.zone.parse('2016-12-07'),
+  url: 'https://london-2016.devrel.net/',
+  description: 'A one day conference about developer relations, developer experience and developer marketing. December 7th 2016, London.',
+  city: 'London',
+  country: 'GB',
+})
+
+Session.create!({
+  title: 'Introduction to the AAARRRP devrel strategy framework',
+  description: 'Building a DevRel programme is hard. What are the goals of the programme, how do they align with the company goals, what activities should the new Developer Relations team undertake, how do those activities help other departments within the company and how should the success of the team be measured?',
+  author: 'Phil Leggetter',
+  event: devrel_con,
+  video_url: 'https://www.youtube.com/watch?v=i7EZDYYfFmc',
+  published: true,
+})
+
+Session.create!({
+  title: 'How to Proxy Voice Calls on Phones and In-app with the Nexmo Voice API, Kotlin, and WebRTC',
+  description: 'In this coding session, Aaron Bassett creates a traditional PSTN proxy in Kotlin, which he uses to connect two telephone endpoints while keeping both sides of the call anonymous.',
+  author: 'Aaron Bassett',
+  event: devrel_con,
+  video_url: 'https://www.youtube.com/watch?v=pHf9Df3Ns2U',
+  published: true,
+})
+

data/lib/nexmo_developer/docker-compose.yml

@@ -0,0 +1,43 @@
+version: '3'
+services:
+  db:
+    image: postgres
+    environment:
+      - POSTGRES_HOST_AUTH_METHOD=trust
+  web:
+    image: nexmodeveloper_app
+    build: .
+    command: bundle exec rails s -p 3000 -b '0.0.0.0'
+    volumes:
+      - .:/app
+      - /app/node_modules
+    ports:
+      - "3000:3000"
+    depends_on:
+      - clean
+      - update
+      - db
+    environment:
+      - OAS_PATH=_open_api/api_specs/definitions
+      - DOCS_BASE_PATH=.
+      - POSTGRES_HOST=db
+      - POSTGRES_USERNAME=postgres
+      - RAILS_ENV=development
+      - RACK_ENV=development
+  clean:
+    image: nexmodeveloper_app
+    build: .
+    command: bash -c "rm -Rf public/packs && rm -f /app/tmp/pids/server.pid"
+    volumes:
+      - .:/app
+  update:
+    image: nexmodeveloper_app
+    build: .
+    command: bash -c "rake db:setup"
+    volumes:
+      - .:/app
+    depends_on:
+      - db
+    environment:
+      - POSTGRES_HOST=db
+      - POSTGRES_USERNAME=postgres

data/lib/nexmo_developer/lib/common_errors.rb

@@ -0,0 +1,5 @@
+class CommonErrors
+  def self.check_for_migration_error(body)
+    raise 'DB Migration is pending. Please run RAILS_ENV=development bin/rake db:migrate' if body&.downcase&.include?('migrations are pending')
+  end
+end

data/lib/nexmo_developer/lib/tasks/cache.rake

@@ -0,0 +1,6 @@
+namespace :cache do
+  desc "Clear Rails' redis cache"
+  task 'clear': :environment do
+    Rails.cache.clear
+  end
+end

data/lib/nexmo_developer/lib/tasks/careers.rake

@@ -0,0 +1,8 @@
+namespace :careers do
+  desc 'Expire careers cache'
+  task 'expire_cache': :environment do
+    p 'Expiring cache...'
+    Greenhouse.expire_cache
+    p 'Done'
+  end
+end

data/lib/nexmo_developer/lib/tasks/ci.rake

@@ -0,0 +1,171 @@
+require_relative '../common_errors'
+
+namespace :ci do
+  desc 'Verify all pages to make sure that no exceptions are thrown'
+  task 'verify_pages': :environment do
+    document_paths =
+      [
+        "#{Rails.configuration.docs_base_path}/_documentation/en/**/*.md",
+        "#{Rails.configuration.docs_base_path}/_api/**/*.md",
+        "#{Rails.configuration.docs_base_path}/_tutorials/**/*.md",
+      ]
+
+    document_paths.each do |path|
+      Dir.glob(path).each do |filename|
+        document = File.read(filename)
+        begin
+          Nexmo::Markdown::Renderer.new.call(document)
+        rescue StandardError => e
+          puts "Error whilst processing #{filename}"
+          raise e
+        end
+      end
+    end
+  end
+
+  desc 'Verify side navigation to make sure every page has valid YAML metadata'
+  task 'verify_navigation': :environment do
+    session = ActionDispatch::Integration::Session.new(Rails.application)
+    res = session.get '/documentation'
+
+    # Check for migration pending error
+    CommonErrors.check_for_migration_error(session.body)
+
+    raise 'Error rendering documentation index page' if res == 500
+  end
+
+  desc 'Render all OAS based API references'
+  task 'verify_oas_reference': :environment do
+    session = ActionDispatch::Integration::Session.new(Rails.application)
+    OpenApiConstraint.list.each do |name|
+      res = session.get "/api/#{name}"
+
+      # Check for migration pending error
+      CommonErrors.check_for_migration_error(session.body)
+
+      raise "Error rendering /api/#{name} OAS page" if res == 500
+    end
+  end
+
+  desc 'Ensure all OAS error URLS resolve'
+  task 'verify_error_urls_resolve': :environment do
+    session = ActionDispatch::Integration::Session.new(Rails.application)
+    session.host! 'localhost' unless Rails.env.test?
+
+    errors = []
+
+    OpenApiConstraint.list.each do |name|
+      definition = OpenApiDefinitionResolver.find(name)
+
+      definition.endpoints.each do |endpoint|
+        endpoint.responses.each do |response|
+          next if response.code[0] == '2' # Successes don't have error messages
+
+          response.formats.each do |format|
+            schema = response.schema(format)
+
+            # Turn everything in to an array to simplify things
+            if schema['oneOf']
+              properties = schema['oneOf']
+            else
+              properties = [schema['properties']]
+            end
+
+            properties.each do |property|
+              type = property['type']
+
+              # Skip if it's an old-style error
+              next unless type
+
+              # Grab the example URL
+              example = type['example']
+
+              # If it has an example field, and it's a link to NDP
+              if example&.starts_with?('https://developer.nexmo.com/api-errors')
+
+                # Extract the error
+                error = example.split('#')[1]
+
+                # Remove the production prefix
+                path = example.gsub('https://developer.nexmo.com', '')
+
+                # Get the page
+                session.get path
+
+                next if path.include?('/subaccounts')
+
+                # Check for migration pending error
+                CommonErrors.check_for_migration_error(session.body)
+
+                # Make sure it includes the correct ID
+                errors.push({ 'document' => name, 'path' => path }) unless session.response.body.include?("<tr id=\"#{error}\">")
+              end
+            end
+          end
+        end
+      end
+    end
+
+    if errors.length.positive?
+      errors = errors.map do |e|
+        "#{e['path']} (#{e['document']})"
+      end.uniq
+      raise "Missing Errors:\n\n#{errors.join("\n")}"
+    end
+  end
+
+  task 'check_word_blocklist': :environment do
+    markdown_files =
+      [
+        "#{Rails.configuration.docs_base_path}/_documentation/en/**/*.md",
+        "#{Rails.configuration.docs_base_path}/_api/**/*.md",
+        "#{Rails.configuration.docs_base_path}/_tutorials/**/*.md",
+        "#{Rails.configuration.docs_base_path}/_partials/*.md",
+        "#{Rails.configuration.docs_base_path}/_partials/**/*.md",
+        "#{Rails.configuration.docs_base_path}/_modals/**/*.md",
+      ]
+
+    block_list = File.read('.disallowed_words').split("\n")
+
+    errors = []
+    markdown_files.each do |path|
+      Dir.glob(path).each do |filename|
+        block_list.each do |word|
+          word = word.downcase
+          document = File.read(filename).downcase
+          if document.include? word
+            errors.push("#{word} found in #{filename.gsub("#{Rails.configuration.docs_base_path}/", '')}")
+          end
+        end
+      end
+    end
+
+    if errors.length.positive?
+      raise "Blocked words found:\n\n#{errors.join("\n")}"
+    end
+  end
+
+  task 'check_ruby_version': :environment do
+    # We treat .ruby-version as the canonical source
+    ruby_version = File.read('.ruby-version').strip
+
+    # Does our Gemfile match
+    gemfile = File.read('Gemfile.lock')
+    gemfile_version = gemfile.match(/RUBY VERSION.*ruby (\d+\.\d+\.\d+).*BUNDLED WITH/m)[1].strip
+
+    # How about Docker?
+    docker = File.read('Dockerfile')
+    docker_version = docker.match(/FROM ruby:(\d+\.\d+\.\d+).*/)[1].strip
+
+    errors = []
+
+    errors.push("Gemfile.lock (#{gemfile_version}) does not match .ruby-version (#{ruby_version})") if gemfile_version != ruby_version
+    errors.push("Dockerfile (#{docker_version}) does not match .ruby-version (#{ruby_version})") if docker_version != ruby_version
+
+    if errors.length.positive?
+      abort("Ruby version mismatch found:\n\n#{errors.join("\n")}")
+    end
+  end
+
+  task all: %i[verify_pages verify_navigation verify_oas_reference verify_error_urls_resolve check_word_blocklist]
+end

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