mumuki-laboratory 9.0.1 → 9.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4fc890303f1598f34b8258b73ca92a3beb1d594cbdb7f00d729401df4e44f89
-  data.tar.gz: 8ad9aba5c0b5d11251a972f2f5354f6f3ee6c6fcb3ef62d72b592e0d6e78b66f
+  metadata.gz: 3bfbac4c5667f84f0ef0365430b3b8b22bb421d0149a906bff69f7ad8116200a
+  data.tar.gz: b3a2468082c345db35724748e1e1d992e1a7fd0e4688a480040e873ac5d94650
 SHA512:
-  metadata.gz: 3f44cc0d2df94e3b613abea57d4ff8a1c48628a2d3fbc1797cb2a2fdca1d54c1c639c8da8e19ddfb65c581f874927758cb1fbf673cd9cf66ed8c1b9186a5d9ca
-  data.tar.gz: c5e6c4b580ec812c0ff84290558f6439fab546dc2be009da77c032b9059700230da3db4e1fc0765a4560d846d6409d4e6a17f79dbbff830a10199ad4ae25a6ec
+  metadata.gz: 228622d76f975543bac60f7b62f3f1ff28fb831934b1841e2fe1e4faaf6ed31b4301d30815c160c1aaa0b0751df34b056eec22ae0e56fc660261949deb40dd34
+  data.tar.gz: a5e86b47de449d68553f162bafa77a69c7dc850bbb65efa3ab1c1401c3091da5979453b50d306a1d8a95973ffc29a66ce6f6b9bd2c29e29192c83c0a68d887e3

data/app/assets/javascripts/mumuki_laboratory/application/certificate.js

@@ -0,0 +1,17 @@
+mumuki.load(() => {
+  scaleCertificate();
+  mumuki.resize(scaleCertificate);
+
+  function scaleCertificate() {
+    const $certPreview = $('.certificate-preview');
+    const $muCertificate = $('.mu-certificate-box');
+    $muCertificate.css('transform', 'scale(1)');
+
+    const scaleWidth = $muCertificate.width() / $certPreview.width();
+    $muCertificate.css({
+      'transform': `scale(${1 / scaleWidth})`,
+      'transform-origin': `0 0`,
+    });
+    $certPreview.height($muCertificate.height());
+  }
+});

data/app/assets/javascripts/mumuki_laboratory/application/faqs.js

@@ -0,0 +1,80 @@
+mumuki.faqs = class {
+
+  constructor() {
+    this.faqs = $('.mu-faqs');
+    this.topHierarchyElem = "H2";
+  }
+
+  // ================
+  // == Public API ==
+  // ================
+
+  /**
+   * Actually setup the faqs page
+   */
+  load() {
+    if(!this.faqs) return;
+    this._createFaqsGroups();
+    this._createNavbar();
+  }
+
+  // =================
+  // == Private API ==
+  // =================
+
+  _createNavbar() {
+    const $faqsNavbar = $(".mu-faqs-navbar nav ul");
+    $('.mu-faqs-group').each((_index, faqGroup) => {
+      const $navItem = this._createNavbarItem($faqsNavbar, faqGroup)
+      const $faqGroup = $(faqGroup);
+      this._configureClickFor($navItem, $faqGroup, $faqsNavbar)
+    });
+  }
+
+  _createNavbarItem($faqsNavbar, faqGroup) {
+    const $newLink = $('<a></a>').attr("href",`#${faqGroup.id}`)
+      .html(`${faqGroup.children[0].textContent}`);
+    const $navItem = $('<li></li>').html($newLink);
+    $faqsNavbar.append($navItem);
+    return $navItem;
+  }
+
+  _configureClickFor($navItem, $faqGroup, $faqsNavbar) {
+    $navItem.click(function(e){
+      e.preventDefault();
+      $faqsNavbar.find('li').removeClass('active');
+      $navItem.addClass('active');
+      $('html, body').animate({scrollTop: $faqGroup.offset().top}, 1000);
+    });
+  }
+
+  _createFaqsGroups() {
+    const elemsGroups = this._buildFaqsGroups();
+    elemsGroups.forEach((group, index) => {
+      $(group).wrapAll(`<div class='mu-faqs-group' id='mu-faqs-group-${index}'>`)
+    });
+  }
+
+  _buildFaqsGroups() {
+    let newGroup = [];
+    let elemsGroups = [];
+    let previousNodeName;
+    $(".mu-faqs-content").children().each((index, elem) => {
+      if(elem.nodeName === this.topHierarchyElem && newGroup.length) {
+        elemsGroups.push(newGroup);
+        newGroup = [];
+      }
+      newGroup.push(elem);
+      previousNodeName = elem.nodeName
+    });
+
+    elemsGroups.push(newGroup);
+
+    return elemsGroups;
+  }
+
+};
+
+mumuki.load(() => {
+  new mumuki.faqs().load();
+});

data/app/assets/stylesheets/mumuki_laboratory/application/_modules.scss

@@ -1,6 +1,7 @@
 @import "modules/avatar";
 @import "modules/book_header";
 @import "modules/breadcrumb";
+@import "modules/certificate";
 @import "modules/checkboxes";
 @import "modules/console";
 @import "modules/content_show";
@@ -10,6 +11,7 @@
 @import "modules/editor";
 @import "modules/exercise_assignment";
 @import "modules/exercise_results";
+@import "modules/faqs";
 @import "modules/flash";
 @import "modules/gs-board";
 @import "modules/guide_corollary";

data/app/assets/stylesheets/mumuki_laboratory/application/modules/_certificate.scss

@@ -0,0 +1,33 @@
+.mu-certificate {
+  border: 1px solid $mu-color-dark-separator;
+}
+
+.mu-certificate-name {
+  margin-top: 0;
+  margin-bottom: 1em;
+}
+
+.mu-certificate-data {
+  margin-top: 30px;
+}
+
+.mu-certificate-buttons {
+  margin-bottom: 30px;
+}
+
+.mu-certificate-download-btn {
+  height: 35px;
+  padding: 0;
+  width: 157px;
+  border: none;
+}
+.mu-certificate-download-btn-icon {
+  border-right: 1px solid darken($mu-color-complementary, 10%);
+  padding: 8px 6px 9px 6px;
+  width: 35px;
+}
+.mu-certificate-download-btn-text {
+  display: inline-block;
+  width: 115px;
+  text-align: center;
+}

data/app/assets/stylesheets/mumuki_laboratory/application/modules/_faqs.scss

@@ -0,0 +1,62 @@
+.mu-faqs-container {
+  position: relative;
+  display: table;
+
+  .mu-faqs-content {
+    padding-top: 50px;
+
+    @media (min-width: $container-sm) {
+      width: 75%;
+      float: right;
+    }
+
+    .mu-faqs-group {
+      padding: 32px;
+      box-shadow: 0 0.375em 2.8125em 0 #d2d5d9;
+      margin-bottom: 32px;
+      h2 {
+        margin-top: 0;
+        margin-bottom: 20px;
+      }
+      h3 {
+        color: #1A94A3; // should be $brand-secondary
+        margin-top: 40px;
+      }
+    }
+  }
+
+  .mu-faqs-navbar {
+    top: 0;
+    position: sticky;
+    width: 25%;
+    padding-top: 50px;
+
+    @media (min-width: $container-sm) {
+      display: hidden;
+    }
+
+    ul {
+      border-left: 1px solid $mu-color-disabled;
+      list-style: none;
+      padding-left: 0px;
+      li {
+        padding: 8px 10px 8px 15px;
+        cursor: pointer;
+        &.active {
+          border-left: 3px solid transparent;
+          border-color: darken($brand-primary, 5%);
+          margin-left: -3px;
+        }
+        a {
+          color: $brand-primary;
+          &:hover {
+            text-decoration: none;
+          }
+          @media (min-width: $container-lg) {
+            font-size: 1.1em;
+          }
+        }
+      }
+    }
+  }
+}

data/app/controllers/certificates_controller.rb

@@ -0,0 +1,28 @@
+class CertificatesController < ApplicationController
+  include WithCertificateRender
+
+  before_action :authorize_if_private!, only: [:show]
+  before_action :set_certificate!
+  before_action :validate_current_user!, only: [:download]
+
+  def verify
+  end
+
+  def show
+  end
+
+  def download
+    send_data pdf_for(@certificate), filename: @certificate.filename
+  end
+
+  private
+
+  def set_certificate!
+    @certificate = Certificate.find_by! code: params[:code]
+  end
+
+  def validate_current_user!
+    raise Mumuki::Domain::NotFoundError unless @certificate.for_user? current_user
+  end
+
+end

data/app/controllers/concerns/with_certificate_render.rb

@@ -0,0 +1,25 @@
+require 'wicked_pdf'
+require 'rqrcode'
+
+module WithCertificateRender
+
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :qr_for
+  end
+
+  def qr_for(certificate)
+    qr = RQRCode::QRCode.new(verify_certificate_url certificate.code).as_svg(color: '0B465D')
+    "data:image/svg+xml,#{URI.encode(qr)}"
+  end
+
+  def pdf_for(certificate)
+    pdf_html = render_to_string(partial: 'certificates/download', locals: { certificate: certificate })
+    WickedPdf.new.pdf_from_string pdf_html,
+                                  orientation: 'Landscape',
+                                  page_size: 'A5',
+                                  margin: { top: 0.5, left: 1, bottom: 0.5, right: 1 }
+
+  end
+end

data/app/controllers/faqs_controller.rb

@@ -0,0 +1,6 @@
+class FAQsController < ApplicationController
+  def index
+    @faqs = Organization.current.faqs_html
+    raise Mumuki::Domain::NotFoundError unless @faqs.present?
+  end
+end

data/app/controllers/users_controller.rb

@@ -30,6 +30,10 @@ class UsersController < ApplicationController
     @watched_discussions = current_user.watched_discussions_in_organization
   end
 
+  def certificates
+    @certificates ||= current_user.certificates_in_organization
+  end
+
   def unsubscribe
     user_id = User.unsubscription_verifier.verify(params[:id])
     User.find(user_id).unsubscribe_from_reminders!

data/app/helpers/certificate_helper.rb

@@ -0,0 +1,13 @@
+module CertificateHelper
+  def linkedin_post_url(certificate)
+    URI::HTTPS.build host: 'www.linkedin.com',
+                     path: '/profile/add',
+                     query: Rack::Utils.build_query(startTask: 'CERTIFICATION_NAME',
+                                                    name: certificate.title,
+                                                    organizationId: ENV['MUMUKI_LINKEDIN_ORGANIZATION_ID'],
+                                                    issueYear: certificate.created_at.year,
+                                                    issueMonth: certificate.created_at.month,
+                                                    certUrl: verify_certificate_url(certificate.code),
+                                                    certId: certificate.code)
+  end
+end

data/app/helpers/links_helper.rb

@@ -59,10 +59,18 @@ module LinksHelper
     link_to t(:forum_terms), discussions_terms_path, target: '_blank'
   end
 
+  def link_to_faqs
+    link_to t(:faqs), faqs_path, target: '_blank' if faqs_enabled_here?
+  end
+
   def turbolinks_enable_for(exercise)
     %Q{data-turbolinks="#{!exercise.input_kids?}"}.html_safe
   end
 
+  def faqs_enabled_here?
+    Organization.current.faqs.present?
+  end
+
   private
 
   def extract_name(named, options)

data/app/helpers/menu_bar_helper.rb

@@ -1,9 +1,9 @@
 module MenuBarHelper
   def menu_bar_links
     [
-      link_to_profile,
-      link_to_classroom,
-      link_to_bibliotheca,
+      menu_link_to_profile,
+      menu_link_to_classroom,
+      menu_link_to_bibliotheca,
       solve_discussions_link,
       user_discussions_link
     ]
@@ -17,25 +17,25 @@ module MenuBarHelper
     content_tag :li, link
   end
 
-  def link_to_profile
+  def menu_link_to_profile
     menu_item('user', :my_account, user_path)
   end
 
-  def link_to_classroom
-    link_to_application 'graduation-cap', :classroom_ui, :teacher_here?
+  def menu_link_to_classroom
+    menu_link_to_application 'graduation-cap', :classroom_ui, :teacher_here?
   end
 
-  def link_to_bibliotheca
-    link_to_application :book, :bibliotheca_ui, :writer?
+  def menu_link_to_bibliotheca
+    menu_link_to_application :book, :bibliotheca_ui, :writer?
   end
 
-  def link_to_application(icon, app_name, minimal_permissions)
+  def menu_link_to_application(icon, app_name, minimal_permissions)
     return unless current_user&.send(minimal_permissions)
     url = url_for_application(app_name)
     menu_item icon, app_name, url
   end
 
-  def logout_link
+  def logout_menu_link
     li_tag menu_item('sign-out-alt', :sign_out, logout_path(origin: url_for))
   end
 
@@ -46,4 +46,8 @@ module MenuBarHelper
   def any_menu_bar_links?
     menu_bar_links.any?
   end
+
+  def menu_link_to_faqs
+    li_tag menu_item('question', :faqs, faqs_path)
+  end
 end

data/app/helpers/user_menu_helper.rb

@@ -11,6 +11,10 @@ module UserMenuHelper
     user_menu_link t(:discussions), discussions_user_path, 'discussions'
   end
 
+  def certificates_user_menu_link
+    user_menu_link t(:certificates), certificates_user_path, 'certificates'
+  end
+
   def user_menu_link(label, path, active_on)
     link_klass = 'active' if action_name == active_on
     link_to label, path, { class: link_klass }.compact

data/app/mailers/application_mailer.rb

@@ -13,4 +13,3 @@ class ApplicationMailer < ActionMailer::Base
     mailer_environment_variables.all? { |env_var| ENV[env_var].present? }
   end
 end
-

data/app/mailers/user_mailer.rb

@@ -1,4 +1,6 @@
 class UserMailer < ApplicationMailer
+  include WithCertificateRender
+
   def welcome_email(user, organization)
     with_locale(user, organization) do
       organization_name = organization.display_name || t(:your_new_organization)
@@ -18,6 +20,13 @@ class UserMailer < ApplicationMailer
     end
   end
 
+  def certificate(certificate)
+    with_locale certificate.user, certificate.organization do
+      attachments[certificate.filename] = pdf_for(certificate)
+      mail to: certificate.user.email, subject: t(:certificate)
+    end
+  end
+
   def with_locale(user, organization = nil, &block)
     @user = user
     @unsubscribe_code = User.unsubscription_verifier.generate(user.id)

data/app/views/certificates/_certificate.html.erb

@@ -0,0 +1,44 @@
+<style>
+
+  .mu-certificate-box {
+    overflow: hidden;
+    height: 210mm;
+    width: 297mm;
+    max-height: 210mm;
+    max-width: 297mm;
+    min-height: 210mm;
+    min-width: 297mm;
+    margin: 0;
+    box-sizing: border-box;
+    position: relative;
+    border: 1px solid lightgrey;
+  }
+
+  .mu-certificate-box section {
+    background: transparent;
+    z-index: 10;
+  }
+
+  .background-image {
+    position: absolute;
+    height: 210mm;
+    width: 297mm;
+    margin: 0;
+    padding: 0;
+    z-index: 0;
+  }
+
+  .qr-code {
+    position: absolute;
+    z-index: 10;
+  }
+
+</style>
+
+<div class="mu-certificate-box">
+  <img src="<%= certificate.background_image_url %>" class="background-image"/>
+  <%= render inline: certificate.template_html_erb, locals: certificate.template_locals %>
+  <a href="<%= verify_certificate_path certificate.code %>" target="_blank">
+    <div><img class="qr-code" src="<%= qr_for certificate %>"/></div>
+  </a>
+</div>