station 0.0.0 → 0.0.100

data/lib/nexmo_developer/app/services/translator/smartling/token_generator.rb

@@ -0,0 +1,16 @@
+module Translator
+  module Smartling
+    class TokenGenerator
+      def self.client
+        @client ||= ::Smartling::Api.new(
+          userId: ENV['SMARTLING_USER_ID'],
+          userSecret: ENV['SMARTLING_USER_SECRET']
+        )
+      end
+
+      def self.token
+        @token ||= client.token
+      end
+    end
+  end
+end

data/lib/nexmo_developer/app/services/translator/smartling_coordinator.rb

@@ -0,0 +1,56 @@
+module Translator
+  class SmartlingCoordinator
+    def self.call(attrs = {})
+      new(attrs).call
+    end
+
+    def initialize(requests:, frequency:)
+      @requests  = requests
+      @frequency = frequency
+    end
+
+    def call
+      # One Smartling Job per locale
+      requests_by_locale.map do |locale, requests|
+        job_id = create_job(locale)
+
+        next unless job_id
+
+        batch_id = create_batch(job_id, requests)
+
+        next unless batch_id
+
+        requests.map { |r| upload_file_to_batch(batch_id, r) }
+      end
+    end
+
+    def requests_by_locale
+      @requests_by_locale ||= @requests.group_by(&:locale)
+    end
+
+    def due_date
+      @due_date ||= (Time.zone.now + @frequency.days).to_s(:iso8601)
+    end
+
+    def create_job(locale)
+      Translator::Smartling::ApiRequestsGenerator.create_job(
+        locales: [locale],
+        due_date: due_date
+      )
+    end
+
+    def create_batch(job_id, requests)
+      Translator::Smartling::ApiRequestsGenerator.create_batch(
+        job_id: job_id,
+        requests: requests
+      )
+    end
+
+    def upload_file_to_batch(batch_id, translation_request)
+      Translator::Smartling::ApiRequestsGenerator.upload_file(
+        batch_id: batch_id,
+        translation_request: translation_request
+      )
+    end
+  end
+end

data/lib/nexmo_developer/app/services/translator/smartling_downloader.rb

@@ -0,0 +1,57 @@
+module Translator
+  class SmartlingDownloader
+    include ::Translator::Utils
+
+    attr_reader :file_uris
+
+    def self.call(attrs = {})
+      new(attrs).call
+    end
+
+    def initialize(file_uris: nil)
+      @file_uris = file_uris || file_uris_from_smartling
+    end
+
+    def call
+      raise ArgumentError, "The 'file_uris' parameter cannot be empty" unless @file_uris
+
+      @file_uris.map do |uri|
+        locales = get_file_status(file_uri: uri)
+        next unless locales
+
+        locales.map { |locale| download_file(locale: locale, file_uri: uri) }
+      end
+    end
+
+    def file_uris_from_smartling
+      ::Translator::Smartling::ApiRequestsGenerator.file_uris
+    end
+
+    def get_file_status(file_uri:)
+      ::Translator::Smartling::ApiRequestsGenerator.get_file_status(
+        file_uri: file_uri
+      )
+    end
+
+    def download_file(locale:, file_uri:)
+      doc = ::Translator::Smartling::ApiRequestsGenerator.download_file(
+        locale: locale,
+        file_uri: file_uri
+      )
+
+      return unless doc
+
+      save_file(doc, locale, file_uri)
+    end
+
+    def save_file(doc, locale, file_uri)
+      locale = locale_without_region(locale.to_s)
+      folder = storage_folder(file_uri, locale)
+      FileUtils.mkdir_p(folder) unless File.exist?(folder)
+      File.open(file_path(file_uri, locale), 'w+') do |file|
+        file.binmode
+        file.write(Nexmo::Markdown::Pipelines::Smartling::Download.call(doc))
+      end
+    end
+  end
+end

data/lib/nexmo_developer/app/services/translator/translation_request.rb

@@ -0,0 +1,11 @@
+module Translator
+  class TranslationRequest
+    attr_reader :locale, :frequency, :file_uri
+
+    def initialize(locale:, frequency:, file_uri:)
+      @locale    = locale
+      @frequency = frequency
+      @file_uri  = file_uri
+    end
+  end
+end

data/lib/nexmo_developer/app/services/translator/translator_coordinator.rb

@@ -0,0 +1,33 @@
+module Translator
+  class TranslatorCoordinator
+    attr_reader :paths
+
+    def initialize(paths:, frequency:)
+      @paths     = paths
+      @frequency = frequency
+    end
+
+    def requests
+      @requests ||= @paths.map do |path|
+        Translator::FileTranslator.new(path).translation_requests
+      end.flatten
+    end
+
+    def requests_by_frequency
+      @requests_by_frequency ||= requests.group_by(&:frequency)
+    end
+
+    def create_smartling_jobs!
+      Translator::SmartlingCoordinator.call(
+        requests: requests_by_frequency.fetch(@frequency, []),
+        frequency: @frequency
+      )
+    end
+
+    def download_smartling_files!
+      Translator::SmartlingDownloader.call(
+        paths: @paths
+      )
+    end
+  end
+end

data/lib/nexmo_developer/app/services/translator/utils.rb

@@ -0,0 +1,42 @@
+module Translator
+  module Utils
+    def locale_without_region(locale)
+      case locale
+      when 'zh-CN', 'cn'
+        :cn
+      when 'ja', 'ja-JP'
+        :ja
+      else
+        :en
+      end
+    end
+
+    def storage_folder(filename, locale)
+      if filename.starts_with? '_documentation'
+        dir_path = Pathname.new(file_uri(filename)).dirname.to_s
+        "#{Rails.configuration.docs_base_path}/_documentation/#{locale}/#{dir_path}"
+      elsif filename.starts_with? 'config/locales'
+        Pathname.new(file_uri(filename)).dirname.to_s
+      else
+        dir_path = Pathname.new(file_uri(filename)).dirname.to_s
+        "#{Rails.configuration.docs_base_path}/_documentation/#{locale}/#{dir_path}"
+      end
+    end
+
+    def file_path(filename, locale)
+      folder = storage_folder(filename, locale)
+      file_name = if filename.starts_with? '_documentation'
+                    Pathname.new(file_uri(filename)).basename.to_s
+                  elsif filename.starts_with? 'config/locales'
+                    "#{locale}#{Pathname.new(file_uri(filename)).extname}"
+                  else
+                    Pathname.new(file_uri(filename)).basename.to_s
+                  end
+      "#{folder}/#{file_name}"
+    end
+
+    def file_uri(filename)
+      filename.gsub(%r{_documentation/[a-z]{2}/}, '')
+    end
+  end
+end

data/lib/nexmo_developer/app/services/tutorial_list.rb

@@ -0,0 +1,39 @@
+class TutorialList
+  def self.by_product(product)
+    {
+      'tutorials' => tasks_for_product(product),
+
+      'use_cases' => Nexmo::Markdown::UseCase.by_product(product).map do |t|
+                       {
+                         root: t.root,
+                         path: t.document_path.to_s,
+                         title: t.title,
+                         product: product,
+                         is_file?: true,
+                         is_tutorial?: true,
+                       }
+                     end,
+    }
+  end
+
+  def self.tasks_for_product(product)
+    tasks = Hash.new { |h, k| h[k] = [] }
+    all.each do |t|
+      t.products.each do |p|
+        t.product = p
+        tasks[p].push(t)
+      end
+    end
+
+    tasks[product]
+  end
+
+  def self.all
+    tasks = []
+    # TODO: make this work with I18n fallback
+    Dir.glob("#{Rails.configuration.docs_base_path}/config/tutorials/#{I18n.default_locale}/*.yml") do |path|
+      tasks.push(TutorialListItem.new(path))
+    end
+    tasks
+  end
+end

data/lib/nexmo_developer/app/views/admin/feedbacks/_steps.html.erb

@@ -0,0 +1,44 @@
+<h4><%= feedback.config.title %></h4>
+<div>
+  <small>Paths:</small><br/>
+  <% feedback.config.paths.each_with_index do |path, path_index| %>
+    <% if feedback.path == path_index %>
+      <b><%= feedback.config.paths[path_index]['question'] %></b>
+    <% else %>
+      <span><%= feedback.config.paths[path_index]['question'] %><span>
+    <% end %>
+    <br/>
+ <% end %>
+ <br/>
+</div>
+<% feedback.config.paths[feedback.path]['steps'].each_with_index do |step, step_index| %>
+  <div>
+    <small>Step <%= step_index %></small><br/>
+    <% if step['type'] == 'textarea' %>
+      <b><%= step['label'] || step['title'] %></b>
+      <br/>
+      <span><%= feedback.steps[step_index] %></span>
+    <% elsif step['type'] == 'radiogroup' %>
+      <% step['questions'].each_with_index do |question, question_index| %>
+        <div>
+          <% if question_index == feedback.steps[step_index] %>
+            <b><%= question %></b>
+          <% else %>
+            <%= question %>
+          <% end %>
+        </div>
+      <% end %>
+    <% elsif step['type'] == 'plain' %>
+      <b><%= step['title'] %></b>
+    <% elsif step['type'] == 'fieldset' %>
+      <b><%= step['title'] %></b>
+      <% step['fields'].each_with_index do |field, field_index| %>
+        <div>
+          <b><%= field['label'] %>:</b>
+          <small><%= feedback.steps[step_index][field['name']] %></small>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+  <br/>
+<% end %>

data/lib/nexmo_developer/app/views/admin_api/code_snippets/index.json.erb

@@ -0,0 +1 @@
+<%= "#{@events.to_json}".html_safe %>

data/lib/nexmo_developer/app/views/admin_api/feedback/index.json.jbuilder

@@ -0,0 +1,3 @@
+json.feedbacks @feedbacks do |feedback|
+  json.call(feedback, :id, :sentiment, :resource, :owner, :ip, :comment, :code_language, :code_language_selected_whilst_on_page, :code_language_set_by_url, :created_at, :resolved)
+end

data/lib/nexmo_developer/app/views/api/show.html.erb

@@ -0,0 +1 @@
+<%= @content.html_safe %>

data/lib/nexmo_developer/app/views/api_errors/_error_example.html.erb

@@ -0,0 +1,9 @@
+<pre class="Vlt-prism--dark language-bash Vlt-prism--copy-disabled"><code>HTTP/1.1 403 Forbidden
+Content-Type: application/problem+json
+Content-Language: en
+{
+"type": "https://example.com/Error#out-of-credit",
+"title": "You do not have enough credit",
+"detail": "Your current balance is 30, but that costs 50.",
+"instance": "&lt;trace_id&gt;"
+}</code></pre>

data/lib/nexmo_developer/app/views/api_errors/_error_table.html.erb

@@ -0,0 +1,30 @@
+<div class="Vlt-table Vlt-table--bordered">
+<table>
+  <thead>
+    <th>Error ID</th>
+    <th>Information</th>
+    <th class="small-2">Actions</th>
+  </thead>
+  <tbody>
+    <% errors.each do |error| %>
+      <tr id="<%= error.id %>">
+        <td><code><%= error.id %></code></td>
+        <td>
+          <b>Details:</b>
+          <p><%= error.description.render_markdown %></p>
+
+          <% if error.resolution %>
+          <b>Resolution:</b>
+          <%= error.resolution.render_markdown %>
+          <% end %>
+        </td>
+        <td>
+        <% if error.link %>
+          <%= link_to error.link.text, error.link.url, class: 'Vlt-btn Vlt-btn--secondary Vlt-btn--app' %>
+        <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+</div>

data/lib/nexmo_developer/app/views/api_errors/index.html.erb

@@ -0,0 +1,45 @@
+<% unless @scoped_errors %>
+  <h4>
+    <%= link_to api_errors_path do %>
+      <i class="icon icon-angle-left"></i>
+      View all errors
+    <% end %>
+  </h4>
+  <br>
+<% end %>
+
+<% unless @hide_rfc7807_header %>
+<h1>API Errors</h1>
+
+<br>
+
+<div class="Vlt-grid">
+  <div class="Vlt-col">
+    <p>When a Nexmo API returns an error, for instance, if your account has no credit, the API will return an error in <a href="https://tools.ietf.org/html/rfc7807">RFC 7807</a> format.
+    <p>This provides a basic explanation of what the issue is, why it occurred and steps to resolve it. Check out the example to see how an <code>out-of-credit</code> is formatted.</p>
+    <p>You'll likely want to consider up-front what errors your application will need to handle, this page provides a list of all the possible errors that could occur with a more detailed explanation of how they can be addressed.</p>
+  </div>
+  <div class="Vlt-col">
+    <%= render 'error_example' %>
+  </div>
+</div>
+<% end %>
+
+
+<div class="spacious">
+  <h2><b><%= @errors_title %></b></h2>
+  <br>
+  <%= render 'error_table', errors: @errors %>
+</div>
+
+<% if @scoped_errors&.any? %>
+  <h2><b>Product Specific Errors</b></h2>
+
+  <% @scoped_errors.each do |scope| %>
+    <div class="spacious">
+      <h4><%= link_to scope[:config]['title'], api_errors_scoped_path(scope[:key]) %></h4>
+      <br>
+      <%= render 'error_table', errors: scope[:errors] %>
+    </div>
+  <% end %>
+<% end %>

data/lib/nexmo_developer/app/views/api_errors/show.html.erb

@@ -0,0 +1,27 @@
+<% unless @scoped_errors %>
+  <h4>
+    <%= link_to api_errors_path do %>
+      <i class="icon icon-angle-left"></i>
+      View all errors
+    <% end %>
+  </h4>
+  <br>
+<% end %>
+
+<h1>Error details - <small><code><%= params[:id] %></code></small></h1>
+
+<br>
+
+<h2>Description</h2>
+<p><%= @error.description.render_markdown %></p>
+
+<br>
+
+<h2>Resolution</h2>
+<p><%= @error.resolution %></p>
+
+<br>
+
+<% if @error.link %>
+    <%= link_to @error.link.text, @error.link.url, class: 'Vlt-btn Vlt-btn--secondary Vlt-btn--app' %>
+<% end %>

data/lib/nexmo_developer/app/views/careers/index.html.erb

@@ -0,0 +1,76 @@
+<div class="container">
+  <div class="content-block center spacious">
+    <h1>Careers</h1>
+    <div class="Vlt-col">
+      <div class="Vlt-dropdown" id="department-filter">
+        <div class="Vlt-dropdown__trigger Vlt-dropdown__trigger--btn"><button class="Vlt-btn Vlt-dropdown__btn Vlt-btn--tertiary">Departments</button></div>
+        <div class="Vlt-dropdown__panel Vlt-dropdown__panel--width2">
+          <div class="Vlt-dropdown__panel__content Vlt-dropdown__panel__content--scroll-area">
+            <div class="Vlt-dropdown__scroll">
+              <% Career::DEPARTMENTS.sort.each do |name, codes| %>
+                <div class="Vlt-dropdown__link Vlt-dropdown__link--noclose">
+                  <div class="Vlt-checkbox">
+                    <label for="<%= name %>">
+                      <span class="Vlt-checkbox__button">
+                        <input type="checkbox" id="<%= name %>" value="<%= name %>" name="<%= name %>">
+                        <span class="Vlt-checkbox__icon"></span>
+                      </span>
+                      <%= name %>
+                    </label>
+                  </div>
+                </div>
+              <% end %>
+            </div>
+          </div>
+        </div>
+      </div>
+      <div class="Vlt-dropdown" id="location-filter">
+        <div class="Vlt-dropdown__trigger Vlt-dropdown__trigger--btn"><button class="Vlt-btn Vlt-dropdown__btn Vlt-btn--tertiary">Locations</button></div>
+        <div class="Vlt-dropdown__panel Vlt-dropdown__panel--width2">
+          <div class="Vlt-dropdown__panel__content Vlt-dropdown__panel__content--scroll-area">
+            <div class="Vlt-dropdown__scroll">
+              <% Greenhouse.offices.map { |o| o[:name] }.each do |name| %>
+                <div class="Vlt-dropdown__link Vlt-dropdown__link--noclose">
+                  <div class="Vlt-checkbox">
+                    <label for="<%= name %>">
+                      <span class="Vlt-checkbox__button">
+                        <input type="checkbox" id="<%= name %>" value="<%= name %>" name="<%= name %>">
+                        <span class="Vlt-checkbox__icon"></span>
+                      </span>
+                      <%= name %>
+                    </label>
+                  </div>
+                </div>
+              <% end %>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+
+  <div class="Vlt-table" id="careers">
+    <table>
+      <tbody>
+        <% Career::DEPARTMENTS.sort.each do |name, codes| %>
+          <% codes.each do |code| %>
+            <% @careers_by_department[code].each do |career| %>
+              <tr class="Nxd-career">
+                <td class="title"><%= link_to career.title, career.url, class: "Vlt-text-link" %></td>
+                <td class="department" data-department="<%= name %>"><small><%= name %></small></td>
+                <td class="location" data-location="<%= career.location %>"><small><%= career.location %></small></td>
+              </tr>
+            <% end %>
+          <% end %>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+
+    <div class='Vlt-empty hide' id='no-results'>
+      <div class='Vlt-empty__content'>
+        There are no results that match your criteria.
+      </div>
+    </div>
+
+</div>