station 0.0.0 → 0.0.93

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

@@ -0,0 +1,33 @@
+class ApiController < ApplicationController
+  before_action :set_document
+  before_action :set_navigation
+
+  private
+
+  def set_code_language
+    return if request.params[:code_language] == 'templates'
+
+    super
+  end
+
+  def set_navigation
+    @navigation = :api
+
+    # If side navigation is not present then the navigation_from_content helper will be used
+    @side_navigation = "api/#{@document}"
+  end
+
+  def set_product
+    @product = params[:product]
+  end
+
+  def set_document
+    if params[:code_language] == 'templates'
+      @document = 'verify/templates'
+    elsif params[:code_language] == 'ncco'
+      @document = 'voice/ncco'
+    else
+      @document = params[:document]
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+class ApiErrorsController < ApplicationController
+  before_action :error_config
+  before_action :validate_subapi
+
+  def index
+    @errors_title = 'Generic Errors'
+    @errors = generic_errors
+    @scoped_errors = @error_config['products'].map do |key, config|
+      {
+        key: key,
+        config: config,
+        errors: scoped_errors(key),
+      }
+    end
+  end
+
+  def index_scoped
+    oas = params[:definition]
+    # At some point, the subaccounts OAS docs should move in to the account OAS docs
+    oas = params[:subapi] if params[:subapi] == 'subaccounts'
+
+    @errors_title = @error_config['products'][oas]['title']
+    @hide_rfc7807_header = @error_config['products'][oas]['hide_rfc7807_header']
+    @errors = scoped_errors(oas)
+    render 'index'
+  end
+
+  def show
+    if params[:definition]
+      @error = scoped_error(params[:definition], params[:id])
+    else
+      @error = ApiError.new(@error_config['generic_errors'][params[:id]])
+    end
+  end
+
+  private
+
+  def generic_errors
+    errors = @error_config
+    ApiError.parse_config(errors['generic_errors'])
+  end
+
+  def scoped_errors(definition)
+    # Find all versions of an API and show the details
+    definitions = OpenApiConstraint.list.select do |name|
+      name == definition || /#{definition}\.v(\d+)/.match(name)
+    end
+
+    # Load the errors from all versions
+    errors = {}
+    definitions.each do |d|
+      definition = OpenApiDefinitionResolver.find(d)
+      errors = errors.deep_merge(definition.raw['x-errors']) if definition.raw['x-errors']
+    end
+
+    ApiError.parse_config(errors)
+  end
+
+  def scoped_error(definition, id)
+    definition = OpenApiDefinitionResolver.find(definition)
+    error = definition.raw['x-errors'][id]
+    ApiError.new(error)
+  end
+
+  def error_config
+    @error_config ||= LoadConfig.load_file('config/api-errors.yml')
+  end
+
+  def validate_subapi
+    # If there is no subapi specified, everything is fine
+    return unless params[:subapi]
+
+    # We used to have some OAS documents that have since been merged in to the top
+    # level OAS documents, but we still need to support the old URLs
+    # e.g. account/secret-management
+    allowed_subapis = {
+      'account' => ['secret-management', 'subaccounts'],
+    }
+
+    render_not_found unless allowed_subapis[params[:definition]]&.include? params[:subapi]
+  end
+end

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

@@ -0,0 +1,93 @@
+class ApplicationController < ActionController::Base
+  include ApplicationHelper
+
+  helper_method :page_title
+
+  rescue_from Errno::ENOENT, with: :not_found
+  rescue_from Nexmo::Markdown::DocFinder::MissingDoc, with: :not_found
+  rescue_from ActiveRecord::RecordNotFound, with: :not_found
+  protect_from_forgery with: :exception
+
+  http_basic_authenticate_with name: ENV['USERNAME'], password: ENV['PASSWORD'], if: :requires_authentication?
+
+  before_action :set_notices
+  before_action :set_code_language
+  before_action :set_feedback_author
+  before_action :set_locale
+
+  def not_found(exception = nil)
+    redirect = Redirector.find(request)
+    if redirect
+      redirect_to redirect
+    else
+      NotFoundNotifier.notify(request, exception)
+      not_found_search_results if search_enabled?
+      render_not_found
+    end
+  end
+
+  def authenticate_admin!
+    return redirect_to new_user_session_path unless user_signed_in?
+
+    redirect_to root_path unless current_user.admin?
+  end
+
+  private
+
+  def requires_authentication?
+    ENV['USERNAME'] && ENV['PASSWORD']
+  end
+
+  def set_code_language
+    return unless request.params[:code_language]
+
+    @code_language = Nexmo::Markdown::CodeLanguage.find(request.params[:code_language])
+  end
+
+  # rubocop:disable Naming/MemoizedInstanceVariableName
+  def set_notices
+    @notices ||= LoadConfig.load_file('config/notices.yml') || {}
+  end
+  # rubocop:enable Naming/MemoizedInstanceVariableName
+
+  def set_feedback_author
+    return unless cookies[:feedback_author_id]
+
+    @feedback_author = Feedback::Author.select(:email).find_by(id: cookies[:feedback_author_id])
+  end
+
+  def not_found_search_results
+    parameters = ALGOLIA_CONFIG.keys.map do |index|
+      {
+        index_name: index,
+        query: request.path.split('/').last.titleize,
+        hitsPerPage: 5,
+      }
+    end
+
+    @results = Algolia.multiple_queries(parameters)
+    @results = JSON.parse(@results.to_json, object_class: OpenStruct).results
+  end
+
+  def render_not_found
+    render 'static/404', status: :not_found, formats: [:html]
+  end
+
+  def set_locale
+    I18n.locale = params[:locale] || session[:locale] || locale_from_domain
+  rescue I18n::InvalidLocale
+    I18n.locale = I18n.default_locale
+  end
+
+  def locale_from_domain
+    if Rails.env.production?
+      request.host == 'developer.nexmocn.com' ? 'cn' : 'en'
+    else
+      I18n.default_locale
+    end
+  end
+
+  def page_title
+    @page_title ||= PageTitle.new(@product, @document_title).title
+  end
+end

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

@@ -0,0 +1,9 @@
+class CareersController < ApplicationController
+  def index
+    @careers_by_department = Greenhouse
+                             .careers
+                             .each_with_object(Hash.new { |h, k| h[k] = [] }) do |career, hash|
+                               career.department_codes.each { |code| hash[code] << career }
+                             end
+  end
+end

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

@@ -0,0 +1,216 @@
+class DashboardController < ApplicationController
+  before_action :authenticate_admin!
+  before_action :set_additional_scripts
+
+  def stats
+    @feedbacks = Feedback::Feedback.created_between(created_after, created_before)
+
+    @feedbacks = @feedbacks.joins(:resource).where(feedback_resources: { product: product }) if product
+  end
+
+  def stats_summary
+    return unless created_after || created_before
+
+    @feedbacks = Feedback::Feedback.created_between(created_after, created_before).joins(:resource)
+
+    grouped_results = @feedbacks.group(["DATE_TRUNC('month', feedback_feedbacks.created_at)", 'feedback_resources.product', 'feedback_feedbacks.sentiment']).count(:id)
+
+    # Reformat in to something usable
+    @summary = {}
+    grouped_results.each do |meta, count|
+      month = meta[0]
+      prod = meta[1] # Can't call it product due to the method defined in this class
+      sentiment = meta[2]
+      next unless prod # We have some feedback from non-product pages. Let's ignore that for now
+
+      @summary[prod] = @summary[prod] || {}
+      @summary[prod][month] = @summary[prod][month] || {}
+      @summary[prod][month][sentiment] = count
+    end
+
+    # Sort by product, then by month
+    @summary = @summary.sort.to_h
+
+    @summary.each do |product, data|
+      @summary[product] = data.sort.to_h
+    end
+  end
+
+  def coverage
+    @supported_languages = %w[
+      curl
+      csharp
+      java
+      node
+      php
+      python
+      ruby
+      json
+      xml
+    ]
+    @product = product
+
+    @complete_coverage = {}
+
+    coverage_from_yaml if ['all', 'yaml'].include?(only)
+    coverage_from_files if ['all', 'file'].include?(only)
+    coverage_from_unsupported
+
+    ignore_languages.each do |lang|
+      @supported_languages.delete(lang)
+    end
+
+    if hide_response
+      @supported_languages.delete('json')
+      @supported_languages.delete('xml')
+    end
+
+    @toplevel_summary = {}
+    @complete_coverage.each do |toplevel, blocks|
+      @toplevel_summary[toplevel] = { 'blocks' => 0, 'langs' => {} } unless @toplevel_summary[toplevel]
+      blocks.each do |_section, entries|
+        entries.each do |_name, languages|
+          @toplevel_summary[toplevel]['blocks'] += 1
+          @supported_languages.each do |lang|
+            @toplevel_summary[toplevel]['langs'][lang] = 0 unless @toplevel_summary[toplevel]['langs'][lang]
+            @toplevel_summary[toplevel]['langs'][lang] += 1 if languages[lang]
+          end
+        end
+      end
+    end
+
+    # Remove non-GA features
+    if params[:show_ga_only]
+      params[:ignore_products] = 'conversation,messages,dispatch,audit,vonage-business-cloud'
+    end
+    params[:ignore_products]&.split(',')&.each do |key|
+      @complete_coverage.delete(key)
+      @toplevel_summary.delete(key)
+    end
+
+    # Calculate the overall summary
+    @overall_summary = { 'blocks' => 0, 'langs' => {} }
+    @supported_languages.each do |lang|
+      @overall_summary['langs'][lang] = 0
+    end
+
+    @toplevel_summary.each do |_title, summary|
+      @overall_summary['blocks'] += summary['blocks']
+      summary['langs'].each do |lang, value|
+        @overall_summary['langs'][lang] += value
+      end
+    end
+  end
+
+  private
+
+  def set_additional_scripts
+    @additional_scripts = ['stats']
+  end
+
+  def ignore_languages
+    return params[:ignore].split(',') if params[:ignore].present?
+
+    []
+  end
+
+  def only
+    return params[:only] if params[:only].present?
+
+    'all'
+  end
+
+  def product
+    params[:product].presence
+  end
+
+  def created_before
+    @created_before ||= params[:created_before] if params[:created_before].present?
+  end
+
+  def created_after
+    @created_after ||= params[:created_after] if params[:created_after].present?
+  end
+
+  def hide_response
+    params[:hide_response].presence
+  end
+
+  def coverage_from_unsupported
+    Dir.glob("#{Rails.configuration.docs_base_path}/_examples/**/.unsupported.yml").each do |e|
+      relative_path = e.gsub("#{Rails.configuration.docs_base_path}/_examples/", '')
+      parts = relative_path.split('/')
+      parts.insert(1, 'top-level') if parts.count < 4
+      parts = parts[0..-2]
+      next if parts[0] == 'migrate'
+
+      excluded_content = YAML.load_file(e)
+
+      x = @complete_coverage
+      parts.each do |key, _value|
+        x[key] = {} unless x[key]
+        x = x[key]
+      end
+      excluded_content.each do |language|
+        x[language] = {
+          'type' => 'unsupported',
+        }
+      end
+    end
+  end
+
+  def coverage_from_yaml
+    Dir.glob("#{Rails.configuration.docs_base_path}/_examples/**/*.yml").each do |e|
+      relative_path = e.gsub("#{Rails.configuration.docs_base_path}/_examples/", '')
+      source_path = "_examples/#{relative_path}"
+      parts = relative_path.split('/')
+      parts.insert(1, 'top-level') if parts.count < 4
+      source = parts[-1]
+      parts = parts[0..-2]
+      next if parts[0] == 'migrate'
+
+      x = @complete_coverage
+      parts.each do |key, _value|
+        x[key] = {} unless x[key]
+        x = x[key]
+      end
+
+      language = source.gsub('.yml', '').downcase
+      x[language] = {
+        'source' => "_examples/#{relative_path}",
+        'source_path' => source_path,
+        'type' => 'yaml',
+      }
+    end
+  end
+
+  def coverage_from_files
+    Dir.glob("#{Rails.configuration.docs_base_path}/_examples/**/*").each do |e|
+      relative_path = e.gsub("#{Rails.configuration.docs_base_path}/_examples/", '')
+      next unless File.file?(e)
+      next if File.extname(e) == '.md' # Markdown files are handled by the config coverage
+      next if File.extname(e) == '.yml' # Yaml files are handled by yaml coverage
+
+      source_path = e.clone
+      parts = relative_path.split('/')
+      language = parts.pop
+
+      parts.insert(1, 'top-level') if parts.count < 3
+
+      parts = [parts[0], parts[1], parts[2..-1].join('/')] if parts.count > 3
+      next if parts[0] == 'migrate'
+
+      x = @complete_coverage
+      parts.each do |key, _value|
+        x[key] = {} unless x[key]
+        x = x[key]
+      end
+
+      x[language.downcase] = {
+        'source' => "_examples/#{relative_path}",
+        'source_path' => source_path,
+        'type' => 'file',
+      }
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+class ExtendController < ApplicationController
+  before_action :set_navigation
+
+  def index
+    document_paths = Dir.glob("#{Rails.configuration.docs_base_path}/_extend/**/*.md")
+
+    @extensions = document_paths.map do |document_path|
+      document = File.read(document_path)
+      frontmatter = YAML.safe_load(document)
+      next unless frontmatter['published']
+
+      title = frontmatter['title']
+      description = frontmatter['description']
+      tags = frontmatter['tags'] || []
+      image = frontmatter['image'] || ''
+      route = File.basename(document_path, '.*')
+      { title: title, description: description, tags: tags, image: image, route: route }
+    end.compact
+
+    render layout: 'landing'
+  end
+
+  def show
+    document_path = "#{Rails.configuration.docs_base_path}/_extend/#{params[:title]}.md"
+
+    document = File.read(document_path)
+    body = Nexmo::Markdown::Renderer.new.call(document)
+    frontmatter = YAML.safe_load(document)
+    title = frontmatter['title']
+    description = frontmatter['description']
+    tags = frontmatter['tags'] || []
+    image = frontmatter['image'] || ''
+    cta = frontmatter['cta'] || 'Use This'
+    link = frontmatter['link'] || ''
+    @extension = { title: title, body: body, image: image, description: description, tags: tags, link: link, cta: cta }
+
+    render layout: 'page'
+  end
+
+  private
+
+  def set_navigation
+    @navigation = :extend
+  end
+end