beyond_canvas 0.15.3.pre → 0.18.0.pre

data/app/controllers/beyond_canvas/application_controller.rb

@@ -5,5 +5,7 @@ module BeyondCanvas
     protect_from_forgery with: :exception
 
     include ::BeyondCanvas::StatusCodes
+    include ::BeyondCanvas::AuthenticationsHelper
+    include ::BeyondCanvas::DebugHelper
   end
 end

data/app/controllers/beyond_canvas/authentications_controller.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_dependency 'beyond_canvas/application_controller'
+
+module BeyondCanvas
+  class AuthenticationsController < ApplicationController # :nodoc:
+    layout 'beyond_canvas/public'
+
+    include ::BeyondCanvas::Authentication
+
+    before_action :validate_app_installation_request!, only: :new
+
+    def new
+      @shop = Shop.find_or_initialize_by(beyond_api_url: params[:api_url])
+
+      if @shop&.authenticated?
+        open_app(@shop)
+      elsif BeyondCanvas.configuration.preinstalled
+        preinstall
+      end
+    end
+
+    def install
+      @shop = Shop.create_with(shop_params).create_or_find_by(beyond_api_url: params[:shop][:api_url])
+
+      @shop.assign_attributes(shop_params)
+
+      if @shop.save
+        @shop.authenticate(params[:shop][:code])
+
+        redirect_to after_installation_path
+      else
+        render :new
+      end
+    end
+
+    private
+
+    def shop_params
+      beyond_canvas_parameter_sanitizer.sanitize
+    end
+
+    def after_preinstallation_path
+      params[:return_url]
+    end
+
+    def after_installation_path
+      params[:shop][:return_url]
+    end
+
+    def after_sign_in_path
+      BeyondCanvas.configuration.open_app_url
+    end
+
+    def preinstall
+      @shop = Shop.create_or_find_by(beyond_api_url: params[:api_url])
+      @shop.authenticate(params[:code])
+
+      redirect_to after_preinstallation_path
+    end
+
+    def open_app(shop)
+      reset_session
+      log_in shop
+
+      redirect_to after_sign_in_path
+    end
+  end
+end

data/app/controllers/concerns/beyond_canvas/authentication.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module Authentication # :nodoc:
+    extend ActiveSupport::Concern
+
+    private
+
+    def beyond_canvas_parameter_sanitizer
+      @beyond_canvas_parameter_sanitizer ||= BeyondCanvas::ParameterSanitizer.new(:shop, params)
+    end
+  end
+end

data/app/controllers/concerns/beyond_canvas/locale_management.rb

@@ -15,16 +15,13 @@ module BeyondCanvas
     # browser compatible locale, sets the value to the cookie and set that locale as default locale.
     #
     def switch_locale(&action)
-      # NOTE: Check the HTTP_ACCEPT_LANGUAGE header to identify if the request comes from a browser or a server
-      return I18n.with_locale(I18n.default_locale, &action) if request.headers['HTTP_ACCEPT_LANGUAGE'].blank?
-
       unless valid_locale?(cookies[:locale])
         cookies[:locale] = { value: browser_compatible_locale, expires: 1.day.from_now }
       end
 
       I18n.with_locale(cookies[:locale], &action)
 
-      logger.debug "[BeyondCanvas] Locale set to: #{cookies[:locale]}".yellow
+      logger.debug "[BeyondCanvas] Locale set to: #{cookies[:locale]}".yellow if debug_mode?
     end
 
     #
@@ -36,12 +33,16 @@ module BeyondCanvas
     #   +I18n.default_locale+. (e.g. +'en-GB'+)
     #
     def browser_compatible_locale
+      return I18n.default_locale if request.headers['HTTP_ACCEPT_LANGUAGE'].blank?
+
       browser_locales = HTTP::Accept::Languages.parse(request.headers['HTTP_ACCEPT_LANGUAGE'])
       available_locales = HTTP::Accept::Languages::Locales.new(I18n.available_locales.map(&:to_s))
 
       locales = available_locales & browser_locales
 
       locales.empty? ? I18n.default_locale : locales.first
+    rescue
+      I18n.default_locale
     end
 
     #

data/app/helpers/beyond_canvas/authentications_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module AuthenticationsHelper # :nodoc:
+    #
+    # Logs in the given shop
+    #
+    def log_in(shop)
+      session[:shop_id] = shop.id
+    end
+
+    #
+    # Returns the current logged-in shop (if any)
+    #
+    def current_shop
+      if session[:shop_id]
+        @current_shop ||= Shop.find_by(id: session[:shop_id])
+      end
+    end
+
+    #
+    # Returns true if the shop is logged in, false otherwise
+    #
+    def logged_in?
+      !current_shop.nil?
+    end
+  end
+end

data/app/helpers/beyond_canvas/cockpit_app_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module CockpitAppHelper # :nodoc:
+    def is_cockpit_app?
+      BeyondCanvas.configuration.cockpit_app == true
+    end
+
+    def action_bar_content?
+      content_for?(:action_bar_left) || content_for?(:action_bar_right)
+    end
+
+    def menu_content?
+      BeyondCanvas.configuration.menu_items.any?
+    end
+  end
+end

data/app/helpers/beyond_canvas/debug_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module DebugHelper # :nodoc:
+    def debug_mode?
+      Rails.env.development? && BeyondCanvas.configuration.debug_mode
+    end
+  end
+end

data/app/helpers/beyond_canvas/locale_switch_helper.rb

@@ -2,11 +2,15 @@
 
 module BeyondCanvas
   module LocaleSwitchHelper # :nodoc:
+    def show_locale_switch?
+      defined?(I18n) && I18n.available_locales.count > 1
+    end
+
     def translate_locale(locale)
       if I18n.exists?("locales.#{locale}")
         I18n.t("locales.#{locale}")
       else
-        logger.debug "[BeyondCanvas] Missing translation: #{I18n.locale}.locales.#{locale}".yellow
+        logger.debug "[BeyondCanvas] Missing translation: #{I18n.locale}.locales.#{locale}".yellow if debug_mode?
         locale
       end
     end

data/app/javascript/beyond_canvas/base.js

@@ -1,3 +1,6 @@
+import 'jquery';
+
 import './initializers/buttons';
 import './initializers/flash';
 import './initializers/inputs';
+import './initializers/modals';

data/app/javascript/beyond_canvas/initializers/buttons.js

@@ -1,8 +1,11 @@
-import { disableActionElements, enableActionElements, hideSpinner, showSpinner } from './functions';
+const SPINNER_ANIMATION_TIMEOUT = 125;
+const BUTTON_SELECTORS = '[class^="button"]';
 
 (function ($) {
-  const onDOMReady = function () {
-    const inputs = $('input, textarea, select').not(':input[type=button], :input[type=submit], :input[type=reset]');
+  const onDOMReady = function (e) {
+    const inputs = $('input, textarea, select').not(
+      ':input[type=button], :input[type=submit], :input[type=reset]'
+    );
 
     inputs.each(function () {
       var input = $(this);
@@ -11,12 +14,11 @@ import { disableActionElements, enableActionElements, hideSpinner, showSpinner }
         if ($(input).is(':hidden')) {
           e.preventDefault();
         }
-        hideSpinner();
-        enableActionElements();
+        $.restoreActionElements();
       });
     });
 
-    $('button[class^="button"]').each(function () {
+    $(BUTTON_SELECTORS).each(function () {
       var button = $(this);
 
       // Add width attribute and save old width
@@ -24,31 +26,75 @@ import { disableActionElements, enableActionElements, hideSpinner, showSpinner }
       button.data('oldWidth', button.width());
 
       // Add the spinner
-      button.prepend(`
-        <div class="spinner">
-          <div class="bounce1"></div>
-          <div class="bounce2"></div>
-          <div class="bounce3"></div>
-        </div>`);
+      if (button.find('.spinner').length == 0) {
+        button.prepend(`
+          <div class="spinner">
+            <div class="bounce1"></div>
+            <div class="bounce2"></div>
+            <div class="bounce3"></div>
+          </div>`);
+      }
 
       // Bind ajax:success and ajax:error to the form the button belongs to
       button
         .closest('form')
         .on('ajax:success', function () {
-          hideSpinner();
-          enableActionElements();
+          $.restoreActionElements();
         })
         .on('ajax:error', function () {
-          hideSpinner();
-          enableActionElements();
+          $.restoreActionElements();
         });
     });
   };
 
-  $(document).on('click', '[class^="button"]', function () {
-    disableActionElements();
-    showSpinner($(this));
+  $(document).on('confirm:complete', function ()  {
+    $.restoreActionElements();
+  });
+
+  $(document).on('click', BUTTON_SELECTORS, function () {
+    $.disableActionElements();
+    $(this).showSpinner();
   });
 
   $(document).on('ready page:load turbolinks:load', onDOMReady);
 })(jQuery);
+
+$.extend({
+  restoreActionElements: function () {
+    // Hide spinners
+    $(BUTTON_SELECTORS).each(function (_, button) {
+      setTimeout(function () {
+        // Hide the spinner
+        $(button).find('.spinner').hide();
+        // Adjust the width of the button
+        $(button).width($(button).data('oldWidth'));
+      }, SPINNER_ANIMATION_TIMEOUT);
+    });
+
+    // Enable action elements
+    $('a, input[type="submit"], input[type="button"], input[type="reset"], button').each(function () {
+      $(this).removeClass('actions--disabled');
+    });
+  },
+  disableActionElements: function () {
+    $('a, input[type="submit"], input[type="button"], input[type="reset"], button').each(function () {
+      $(this).addClass('actions--disabled');
+    });
+  }
+});
+
+$.fn.extend({
+  showSpinner: function () {
+    var button = $(this);
+
+    // Adjust the width of the button
+    button.width(
+      button.width() + $('.spinner').outerWidth(true)
+    );
+
+    // Show the spinner
+    setTimeout(function () {
+      button.find('.spinner').css('display', 'inline-flex');
+    }, SPINNER_ANIMATION_TIMEOUT);
+  }
+});

data/app/javascript/beyond_canvas/initializers/flash.js

@@ -1,5 +1,3 @@
-import { closeAlert } from './functions';
-
 (function ($) {
   const onDOMReady = function () {
     $('.flash').each(function () {
@@ -17,3 +15,12 @@ import { closeAlert } from './functions';
 
   $(document).on('ready page:load turbolinks:load', onDOMReady);
 })(jQuery);
+
+function closeAlert() {
+  $('.flash')
+    .removeClass('flash--shown')
+    .delay(700)
+    .queue(function () {
+      $(this).remove();
+    });
+}

data/app/javascript/beyond_canvas/initializers/inputs.js

@@ -9,7 +9,10 @@
         var fileName = '';
 
         if (this.files && this.files.length > 1)
-          fileName = (this.getAttribute('data-multiple-caption') || '').replace('{count}', this.files.length);
+          fileName = (this.getAttribute('data-multiple-caption') || '').replace(
+            '{count}',
+            this.files.length
+          );
         else if (e.target.value) fileName = e.target.value.split('\\').pop();
 
         if (fileName)

data/app/javascript/beyond_canvas/initializers/modals.js

@@ -0,0 +1,14 @@
+$.extend({
+  displayModal: function (content, options = {}) {
+    $('#modal').find('#modal__content').html(content);
+    $('#modal').css('display', 'flex');
+    $.restoreActionElements();
+    $(document).trigger('modal:opened', options['extraEventParameters']);
+  },
+  closeModal: function () {
+    $('#modal').find('#modal__content').empty();
+    $('#modal').css('display', 'none');
+    $.restoreActionElements();
+    $(document).trigger('modal:closed');
+  }
+});

data/app/views/beyond_canvas/authentications/new.html.erb

@@ -0,0 +1,27 @@
+<% app_name = BeyondCanvas.configuration.site_title %>
+<% i18n_scope = 'beyond_canvas.authentications.new' %>
+
+<div class="card card--padding">
+
+  <%= form_with(url: callback_path, method: :post, scope: :shop, model: @shop, local: true, builder: BeyondCanvas::FormBuilder) do |f| %>
+
+    <h2 class="card__headline"><%= I18n.t('headline', app_name: app_name, scope: i18n_scope) %></h2>
+
+    <p class="margin--bottom"><%= I18n.t('body', app_name: app_name, scope: i18n_scope) %></p>
+
+    <%# Don't delete or modify any ot these hidden fields. They are used on shop identification and authentication %>
+
+    <%= f.hidden_field :code,             value: params[:code] || @shop.code  %>
+    <%= f.hidden_field :signature,        value: params[:signature] || @shop.signature  %>
+    <%= f.hidden_field :return_url,       value: params[:return_url] || @shop.return_url  %>
+    <%= f.hidden_field :api_url,          value: params[:api_url] || @shop.api_url  %>
+    <%= f.hidden_field :access_token_url, value: params[:access_token_url] || @shop.access_token_url  %>
+
+    <%# Add HERE your custom shop fields %>
+
+    <div class="form__actions--spaced">
+      <%= f.button I18n.t('actions.install', scope: i18n_scope), type: :submit, class: 'button__solid--primary' %>
+    </div>
+
+  <% end %>
+</div>

data/app/views/beyond_canvas/shared/_action_bar.html.erb

@@ -0,0 +1,15 @@
+<% if action_bar_content? %>
+
+  <div class="action_bar<% if menu_content? %> action_bar--menu<% end %>">
+
+    <div class="action_bar--left">
+      <%= yield :action_bar_left %>
+    </div>
+
+    <div class="action_bar--right">
+      <%= yield :action_bar_right %>
+    </div>
+
+  </div>
+
+<% end %>

data/app/views/beyond_canvas/shared/_breadcrumbs.html.erb

@@ -0,0 +1,14 @@
+<% if is_cockpit_app? %>
+
+  <div class='breadcrumbs'>
+
+    <%= inline_svg_tag 'icons/home.svg' %>
+
+    <% breadcrumb_trail do |crumb| %>
+      <%= link_to crumb.name, crumb.url, class: "breadcrumb__item#{ '--current' if crumb.current? }" %>
+      <% unless crumb.current? %><%= inline_svg_tag 'icons/arrow_right.svg' %><% end %>
+    <% end %>
+
+  </div>
+
+<% end %>

data/app/views/beyond_canvas/shared/_flash.html.erb

@@ -1,13 +1,23 @@
-<% flash.each do |key, value| %>
-  <div class="flash">
-    <div class="flash__icon flash__icon--<%= key %>">
-      <%= get_flash_icon(key) %>
+<div id="flash">
+
+  <% flash.each do |key, value| %>
+
+    <div class="flash">
+
+      <div class="flash__icon flash__icon--<%= key %>">
+        <%= get_flash_icon(key) %>
+      </div>
+
+      <div class="flash__message">
+        <%= value %>
+      </div>
+
+      <div class="flash__close">
+        <%= inline_svg_tag 'icons/flash_close.svg' %>
+      </div>
+
     </div>
-    <div class="flash__message">
-      <%= value %>
-    </div>
-    <div class="flash__close">
-      <%= inline_svg_tag 'icons/flash_close.svg' %>
-    </div>
-  </div>
-<% end %>
+
+  <% end %>
+
+</div>