station 0.0.0 → 0.0.100

data/lib/nexmo_developer/app/models/tutorial/prerequisite.rb

@@ -0,0 +1,31 @@
+class Tutorial::Prerequisite
+  delegate :content, :yaml, to: :@file_loader
+
+  def initialize(current_step:, code_language:, name:)
+    @current_step  = current_step
+    @code_language = code_language
+    @name          = name
+    @file_loader   = load_file!
+  end
+
+  def title
+    @title ||= yaml['title']
+  end
+
+  def description
+    @description ||= yaml['description']
+  end
+
+  def active?
+    @name == @current_step
+  end
+
+  def load_file!
+    Tutorial::FileLoader.new(
+      root: Tutorial.task_content_path,
+      code_language: nil,
+      doc_name: @name,
+      format: 'md'
+    )
+  end
+end

data/lib/nexmo_developer/app/models/tutorial/task.rb

@@ -0,0 +1,45 @@
+class Tutorial::Task
+  attr_reader :name, :title, :description, :current_step
+
+  def initialize(name:, title:, description:, current_step:)
+    @name         = name
+    @title        = title
+    @description  = description
+    @current_step = current_step
+  end
+
+  def active?
+    @name == @current_step
+  end
+
+  def self.make_from(name:, code_language:, current_step:)
+    file_loader = Tutorial::FileLoader.new(
+      root: Tutorial.task_content_path,
+      doc_name: name,
+      code_language: code_language,
+      format: 'md'
+    )
+
+    new(
+      name: name,
+      title: file_loader.yaml['title'],
+      description: file_loader.yaml['description'],
+      current_step: current_step
+    )
+  end
+
+  def ==(other)
+    name == other.name &&
+      title == other.title &&
+      description == other.description &&
+      current_step == other.current_step
+  end
+
+  def eql?(other)
+    self == other
+  end
+
+  def hash
+    name.hash ^ title.hash ^ description.hash ^ current_step.hash
+  end
+end

data/lib/nexmo_developer/app/models/usage.rb

@@ -0,0 +1,5 @@
+module Usage
+  def self.table_name_prefix
+    'usage_'
+  end
+end

data/lib/nexmo_developer/app/models/usage/code_snippet_event.rb

@@ -0,0 +1,7 @@
+module Usage
+  class CodeSnippetEvent < ApplicationRecord
+    scope :created_after, ->(date) { where('usage_code_snippet_events.created_at >= ?', date) if date.present? }
+    scope :created_before, ->(date) { where('usage_code_snippet_events.created_at <= ?', date) if date.present? }
+    scope :created_between, ->(start_date, end_date) { created_after(start_date).created_before(end_date) }
+  end
+end

data/lib/nexmo_developer/app/models/user.rb

@@ -0,0 +1,14 @@
+class User < ApplicationRecord
+  # Include default devise modules. Others available are:
+  # :confirmable, :lockable, :timeoutable and :omniauthable
+  devise :database_authenticatable, :rememberable, :trackable
+
+  before_create :generate_nexmo_developer_api_secret
+
+  def generate_nexmo_developer_api_secret
+    loop do
+      self.nexmo_developer_api_secret = SecureRandom.hex
+      break unless User.exists?(nexmo_developer_api_secret: nexmo_developer_api_secret)
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+class Card
+  COLOUR = {
+    'Voice' => 'orange',
+    'SMS' => 'purple',
+    'Dispatch' => 'green',
+    'Messages' => 'indigo',
+    'Client SDK' => 'red',
+    'Conversation' => 'red',
+    'Number Insight' => 'grey',
+    'Verify' => 'yellow',
+    'voice' => 'orange',
+    'messaging/sms' => 'purple',
+    'dispatch' => 'green',
+    'messages' => 'indigo',
+    'client-sdk' => 'red',
+    'conversation' => 'red',
+    'number-insight' => 'grey',
+    'verify' => 'yellow',
+  }.freeze
+end

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

@@ -0,0 +1,40 @@
+class Career
+  HEADING_TAG_LIST = %w[h1 h2 h3 h4 h5 h6].freeze
+  DEPARTMENTS = YAML.safe_load(File.read("#{Rails.configuration.docs_base_path}/config/greenhouse_departments.yml"))
+
+  def initialize(career)
+    @career = career
+  end
+
+  def title
+    @career[:title]
+  end
+
+  def location
+    @career.dig(:location, :name)
+  end
+
+  def department_codes
+    @department_codes ||= @career[:departments].pluck(:id) # rubocop:disable Rails/PluckId
+  end
+
+  def description
+    content = CGI.unescapeHTML(@career[:content])
+
+    # If it starts with a header, strip it out
+    document = Nokogiri::HTML::DocumentFragment.parse(content)
+    first_child = document.children[0]
+    first_child.remove if HEADING_TAG_LIST.include?(first_child.name)
+
+    document.to_html
+  end
+
+  def url
+    @career[:absolute_url]
+  end
+
+  def devrel?
+    @career[:departments].any? { |d| d[:id] == Greenhouse::DEPARTMENT_ID } &&
+      @career[:title].downcase.match?(Regexp.union(Greenhouse::TITLES))
+  end
+end

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

@@ -0,0 +1,31 @@
+class FeedbackPresenter
+  def initialize(canonical_url, params)
+    @canonical_url = canonical_url
+    @params        = params
+  end
+
+  def props
+    config.merge(
+      'source' => @canonical_url,
+      'configId' => feedback_config.id,
+      'codeLanguage' => @params[:code_language],
+      'codeLanguageSetByUrl' => @params[:code_language].present?
+    )
+  end
+
+  def show_feedback?
+    File.exist?(config_file_path)
+  end
+
+  def config
+    @config ||= YAML.safe_load(File.read(config_file_path))
+  end
+
+  def config_file_path
+    "#{Rails.configuration.docs_base_path}/config/feedback.yml"
+  end
+
+  def feedback_config
+    @feedback_config ||= Feedback::Config.find_or_create_config(config)
+  end
+end

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

@@ -0,0 +1,88 @@
+class Footer
+  attr_reader :items
+
+  def initialize(items: nil)
+    @items = items
+
+    after_initialize!
+  end
+
+  def footer_from_config(config)
+    config = YAML.safe_load(open_config(config))
+    {
+      name: config['name'],
+      subtitle: config['subtitle'],
+      logo_path: config['assets']['footer_logo']['path'],
+      logo_alt: config['assets']['footer_logo']['alt'],
+      status: config['footer']['links']['status'],
+      social_links: config['footer']['links']['social'],
+      navigation_links: config['footer']['links']['navigation'],
+      support_links: config['footer']['links']['support'],
+    }
+  end
+
+  def self.navigation_category_titleize(title)
+    if title.include?('-')
+      title_split = title.split('-').map do |word|
+        word == 'api' ? word.upcase : word.titleize
+      end
+      title = title_split.join(' ')
+    else
+      title = title.titleize
+    end
+    title
+  end
+
+  def self.navigation_link(link)
+    link.values.join(' ')
+  end
+
+  def self.navigation_link_text(link)
+    text = link.keys.join(' ')
+    if text.include?('-')
+      link_split = text.split('-').map do |word|
+        if word == 'api'
+          word.upcase
+        elsif word == 'apis'
+          'APIs'
+        else
+          word.titleize
+        end
+      end
+      link = link_split.join(' ')
+    elsif text == 'sms'
+      link = text.upcase
+    else
+      link = text.titleize
+    end
+    link
+  end
+
+  def self.support_link(link)
+    if link.include?('@')
+      "mailto:#{link}"
+    else
+      link
+    end
+  end
+
+  def self.support_link_text(link)
+    link.titleize
+  end
+
+  def open_config(config)
+    File.open(config)
+  end
+
+  def config_exist?(path)
+    File.exist?(path)
+  end
+
+  private
+
+  def after_initialize!
+    raise 'You must provide a config/business_info.yml file in your documentation path.' unless config_exist?("#{Rails.configuration.docs_base_path}/config/business_info.yml")
+
+    @items = footer_from_config("#{Rails.configuration.docs_base_path}/config/business_info.yml")
+  end
+end

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

@@ -0,0 +1,96 @@
+class Head
+  class Description
+    def initialize(config:, frontmatter:)
+      @config      = config
+      @frontmatter = frontmatter
+    end
+
+    def description
+      @description ||= from_frontmatter || @config.fetch('description') do
+        raise "You must provide a 'description' parameter in header_meta.yml"
+      end
+    end
+
+    def from_frontmatter
+      @frontmatter && (@frontmatter['meta_description'] || @frontmatter['description'])
+    end
+  end
+
+  attr_reader :config, :frontmatter
+
+  def initialize(frontmatter = nil)
+    @frontmatter = frontmatter
+
+    after_initialize!
+    validate_files_presence!
+  end
+
+  def title
+    @title ||= config.fetch('title') do
+      raise "You must provide a 'title' parameter in header_meta.yml"
+    end
+  end
+
+  def description
+    @description ||= Description.new(config: config, frontmatter: frontmatter).description
+  end
+
+  def google_site_verification
+    @google_site_verification ||= config['google-site-verification']
+  end
+
+  def application_name
+    @application_name ||= config['application-name']
+  end
+
+  def favicon
+    'meta/favicon.ico'
+  end
+
+  def favicon_32_squared
+    'meta/favicon-32x32.png'
+  end
+
+  def manifest
+    'meta/manifest.json'
+  end
+
+  def safari_pinned_tab
+    'meta/safari-pinned-tab.svg'
+  end
+
+  def mstile_144_squared
+    'meta/mstile-144x144.png'
+  end
+
+  def apple_touch_icon
+    'meta/apple-touch-icon.png'
+  end
+
+  def og_image
+    @og_image ||= "meta/#{config['og-image']}"
+  end
+
+  def og_image_width
+    @og_image_width ||= config['og-image-width']
+  end
+
+  def og_image_height
+    @og_image_height ||= config['og-image-height']
+  end
+
+  private
+
+  def after_initialize!
+    config_path = "#{Rails.configuration.docs_base_path}/config/header_meta.yml"
+    raise 'You must provide a config/header_meta.yml file in your documentation path.' unless File.exist?(config_path)
+
+    @config = YAML.safe_load(File.open(config_path))
+  end
+
+  def validate_files_presence!
+    %i[favicon favicon_32_squared manifest safari_pinned_tab mstile_144_squared apple_touch_icon og_image].each do |file|
+      raise "You must provide a #{send(file).sub('meta/', '')} file inside the public/meta directory" unless File.exist?("#{Rails.configuration.docs_base_path}/public/#{send(file)}")
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+class Header
+  def initialize
+    after_initialize!
+  end
+
+  def logo_path
+    @logo_path ||= config['assets']['header_logo']['path']
+  end
+
+  def small_logo_path
+    @small_logo_path ||= config['assets']['header_logo']['small_path'] ||
+                         config['assets']['header_logo']['path']
+  end
+
+  def logo_alt
+    @logo_alt ||= config['assets']['header_logo']['alt']
+  end
+
+  def name
+    @name ||= config['name']
+  end
+
+  def subtitle
+    @subtitle ||= config['subtitle']
+  end
+
+  def hiring_link?
+    hiring_display
+  end
+
+  def sign_up_path
+    @sign_up_path ||= config['header']['links']['sign-up']['path']
+  end
+
+  def sign_up_text
+    @sign_up_text ||= config['header']['links']['sign-up']['text']
+  end
+
+  private
+
+  def after_initialize!
+    raise 'You must provide a config/business_info.yml file in your documentation path.' unless File.exist?("#{Rails.configuration.docs_base_path}/config/business_info.yml")
+  end
+
+  def config
+    @config ||= YAML.safe_load(
+      File.open("#{Rails.configuration.docs_base_path}/config/business_info.yml")
+    )
+  end
+
+  def hiring_display
+    raise 'You must provide a true or false value for the hiring display parameter inside the header section of the config/business_info.yml file' unless config['header']['hiring'].try(:has_key?, 'display')
+
+    config['header']['hiring']['display']
+  end
+end