RubyGems - beyond_canvas - Versions diffs - 0.15.3.pre → 0.18.0.pre - Mend

beyond_canvas 0.15.3.pre → 0.18.0.pre

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (75) hide show

data/app/views/beyond_canvas/shared/_locales.html.erb ADDED

@@ -0,0 +1,8 @@
+<% if show_locale_switch? && !is_cockpit_app? %>
+  <%= form_for :system, url: beyond_canvas.update_locale_path, method: :put do |f| %>
+      <%= f.select :locale, I18n.available_locales.collect { |l| [translate_locale(l), l] },
+                            { selected: cookies[:locale] },
+                            class: 'select--locale',
+                            onchange: 'this.form.submit()'  %>
+  <% end %>
+<% end %>

data/app/views/beyond_canvas/shared/_menu.html.erb ADDED

@@ -0,0 +1,31 @@
+<% if menu_content? %>
+  <div class="menu">
+    <div class="menu--left">
+      <%= render 'beyond_canvas/shared/logo' %>
+    </div>
+    <div class="menu--center">
+      <% BeyondCanvas.configuration.menu_items.each do |menu_item| %>
+        <% name, url, options = menu_item.name.to_s, menu_item.url.to_s, menu_item.options %>
+        <% url, external_url = respond_to?(url) ? [send(url), false] : [url, true] %>
+        <% name = defined?(I18n) && I18n.exists?(name) ? I18n.t(name) : name %>
+        <% path = Rails.application.routes.recognize_path(url) %>
+        <% options = options.merge(class: 'menu__item--active') { |_key, old_val, new_val| [new_val, old_val].join(' ') if !external_url && path[:controller] == params[:controller] } %>
+        <% options = options.merge(class: 'menu__item') { |_key, old_val, new_val| [new_val, old_val].join(' ') } %>
+        <%= link_to name, url, options %>
+      <% end %>
+    </div>
+    <div class="menu--right"></div>
+  </div>
+<% end %>

data/app/views/beyond_canvas/shared/_modal.html.erb ADDED

@@ -0,0 +1,6 @@
+<div class="modal__background" id="modal">
+  <div class="relative card card--padding">
+    <span onClick= "$.closeModal()"><%= inline_svg_tag 'icons/close.svg', class: 'modal__close' %></span>
+    <div id="modal__content"></div>
+  </div>
+</div>

data/app/views/beyond_canvas/shared/_sidebar.html.erb ADDED

@@ -0,0 +1,16 @@
+<% if is_cockpit_app? && Rails.env.development? %>
+  <div class="sidebar">
+    <div class="sidebar__header">
+      <div class="sidebar__logo"></div>
+    </div>
+    <div class="sidebar__item sidebar__item--selected"></div>
+    <div class="sidebar__item"></div>
+    <div class="sidebar__item"></div>
+    <div class="sidebar__item"></div>
+    <div class="sidebar__footer">
+      <div class="sidebar__icon"></div>
+      <div class="sidebar__icon"></div>
+      <div class="sidebar__icon"></div>
+    </div>
+  </div>
+<% end %>

data/app/views/layouts/beyond_canvas/application.html.erb ADDED

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+<%= render 'beyond_canvas/shared/head' %>
+<body class="body--application"<% if is_cockpit_app? && Rails.env.development? %> style="display: flex;"<% end %>>
+  <%= render 'beyond_canvas/shared/sidebar' %>
+  <main class="main <%= params[:controller].gsub(/[\/_]/, "-") %>--<%= params[:action] %>">
+    <%= render 'beyond_canvas/shared/flash' %>
+    <%= render 'beyond_canvas/shared/locales' %>
+    <%= render 'beyond_canvas/shared/modal' %>
+    <%= render 'beyond_canvas/shared/menu' %>
+    <%= render 'beyond_canvas/shared/action_bar' %>
+    <div class="main-wrapper<% if action_bar_content? %> main-wrapper--action_bar<% end %>"<% if content_for?(:max_width)%> style="max-width: <%= yield :max_width %>"<% end %>>
+      <%= render 'beyond_canvas/shared/breadcrumbs' %>
+      <%= yield %>
+      <%= debug(params) if debug_mode? %>
+    </div>
+  </main>
+</body>
+</html>

data/app/views/layouts/beyond_canvas/public.html.erb CHANGED

@@ -4,13 +4,22 @@
 <%= render 'beyond_canvas/shared/head' %>
 <body class="body--public">
   <main class="main <%= params[:controller].gsub(/[\/_]/, "-") %>--<%= params[:action] %>">
     <%= render 'beyond_canvas/shared/flash' %>
-    <%= render 'beyond_canvas/locales/edit' %>
+    <%= render 'beyond_canvas/shared/locales' %>
     <div class="main-wrapper">
       <%= render 'beyond_canvas/shared/logo' %>
       <%= yield %>
     </div>
+    <%= debug(params) if debug_mode? %>
   </main>
 </body>
 </html>

data/config/locales/en.yml ADDED

@@ -0,0 +1,9 @@
+en:
+  beyond_canvas:
+    authentications:
+      new:
+        headline: Install %{app_name} in your shop
+        body: You are about to install %{app_name} in your shop. For continuing with this process, press the install button below.
+        actions:
+          install: Install
+      failure: Shop could not be saved

data/config/routes.rb CHANGED

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 BeyondCanvas::Engine.routes.draw do
-  put '/locale', to: 'system#update_locale', as: :update_locale
+  put 'locale', to: 'system#update_locale', as: :update_locale
+  def create_default_routes
+    get  'callback', to: 'authentications#new'
+    post 'callback', to: 'authentications#install'
+  end
+  create_default_routes unless BeyondCanvas.use_rails_app_controller
 end

data/lib/beyond_canvas.rb CHANGED

@@ -8,14 +8,30 @@ require 'jquery-rails'
 require 'bourbon'
 require 'sassc-rails'
 require 'inline_svg'
+require 'loaf'
 require 'http/accept'
 require 'premailer/rails'
 require 'beyond_api'
+require 'attr_encrypted'
 module BeyondCanvas # :nodoc:
-  autoload :AssetRegistration, 'beyond_canvas/asset_registration'
-  autoload :Configuration,     'beyond_canvas/configuration'
+  autoload :AssetRegistration,    'beyond_canvas/asset_registration'
+  autoload :Configuration,        'beyond_canvas/configuration'
+  autoload :MenuItemRegistration, 'beyond_canvas/menu_item_registration'
+  autoload :ParameterSanitizer,   'beyond_canvas/parameter_sanitizer'
+  module Models # :nodoc:
+    autoload :Shop, 'models/shop'
+    module Concerns
+      autoload :Authentication, 'models/concerns/authentication'
+      autoload :Utils,          'models/concerns/utils'
+    end
+  end
+  mattr_accessor :use_rails_app_controller
+  @@use_rails_app_controller = false
   class << self
     def configuration

data/lib/beyond_canvas/configuration.rb CHANGED

@@ -2,14 +2,22 @@
 module BeyondCanvas
   class Configuration # :nodoc:
-    attr_accessor :site_title, :site_logo, :favicon, :skip_webpacker
+    attr_accessor :site_title, :site_logo, :favicon, :skip_webpacker, :encryption_key, :namespace, :cockpit_app,
+                  :open_app_url, :preinstalled, :debug_mode
     include AssetRegistration
+    include MenuItemRegistration
     def initialize
-      @site_title = ::Rails.application.class.name.split('::').first.humanize
-      @site_logo = nil
+      @cockpit_app = false
+      @debug_mode = false
+      @encryption_key = nil
       @favicon = nil
+      @namespace = '/'
+      @open_app_url = nil
+      @preinstalled = false
+      @site_logo = nil
+      @site_title = ::Rails.application.class.name.split('::').first.humanize
       @skip_webpacker = false
     end

data/lib/beyond_canvas/engine.rb CHANGED

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+require 'beyond_canvas/rails/routes'
 module BeyondCanvas
   class Engine < ::Rails::Engine # :nodoc:
     isolate_namespace BeyondCanvas
@@ -11,6 +13,8 @@ module BeyondCanvas
       BeyondCanvas.configuration.javascripts.each do |path|
         app.config.assets.precompile << path
       end
+      app.config.assets.precompile << 'beyond_canvas_manifest.js'
     end
     config.before_initialize do
@@ -18,6 +22,8 @@ module BeyondCanvas
         include ::BeyondCanvas::LocaleManagement
         include ::BeyondCanvas::RequestValidation
         include ::BeyondCanvas::StatusCodes
+        include ::BeyondCanvas::AuthenticationsHelper
+        include ::BeyondCanvas::DebugHelper
         ::ActionController::Base.helper BeyondCanvas::Engine.helpers
       end

data/lib/beyond_canvas/menu_item_registration.rb ADDED

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module BeyondCanvas
+  module MenuItemRegistration # :nodoc:
+    MenuItem = Struct.new(:name, :url, :options)
+    def register_menu_item(name, url, options = {})
+      menu_items.add MenuItem.new(name, url, options)
+    end
+    def menu_items
+      @menu_items ||= Set.new
+    end
+    def clear_menu_items!
+      menu_items.clear
+    end
+  end
+end

data/lib/beyond_canvas/parameter_sanitizer.rb ADDED

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module BeyondCanvas
+  class ParameterSanitizer # :nodoc:
+    DEFAULT_PERMITTED_ATTRIBUTES = %i[code signature return_url api_url access_token_url]
+    def initialize(resource_name, params)
+      @params         = params
+      @resource_name  = resource_name
+      @permitted      = DEFAULT_PERMITTED_ATTRIBUTES
+    end
+    def sanitize
+      permit_keys(default_params)
+    end
+    def permit(*keys)
+      @permitted.concat(keys)
+    end
+    private
+    def default_params
+      if hashable_resource_params?
+        @params.fetch(@resource_name)
+      else
+        empty_params
+      end
+    end
+    def hashable_resource_params?
+      @params[@resource_name].respond_to?(:permit)
+    end
+    def empty_params
+      ActionController::Parameters.new({})
+    end
+    def permit_keys(parameters)
+      parameters.permit(*@permitted)
+    end
+  end
+end

data/lib/beyond_canvas/rails/routes.rb ADDED

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module ActionDispatch
+  module Routing
+    class Mapper # :nodoc:
+      def beyond_canvas_routes(options = nil)
+        mount BeyondCanvas::Engine => BeyondCanvas.configuration.namespace
+        BeyondCanvas.use_rails_app_controller = options.present? && options[:custom_controller].present?
+        set_routes if BeyondCanvas.use_rails_app_controller
+      end
+      def set_routes
+        scope BeyondCanvas.configuration.namespace do
+          get  'callback', controller: :authentications, action: :new
+          post 'callback', controller: :authentications, action: :install
+        end
+      end
+    end
+  end
+end

data/lib/beyond_canvas/version.rb CHANGED

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module BeyondCanvas
-  VERSION = '0.15.3.pre'
+  VERSION = '0.18.0.pre'
 end

data/lib/generators/beyond_canvas/controller/controller_generator.rb ADDED

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'rails/generators/active_record'
+module BeyondCanvas
+  module Generators
+    class ControllerGenerator < Rails::Generators::Base # :nodoc:
+      desc 'Creates an inherited Beyond Canvas controller in the app/controllers folder'
+      argument :scope, required: true, desc: 'The scope to create the controller, e.g. shops, users'
+      source_root File.expand_path('templates', __dir__)
+      def create_controller
+        template 'controller.erb', "app/controllers/#{scope}_controller.rb"
+      end
+    end
+  end
+end

data/lib/generators/beyond_canvas/controller/templates/controller.erb ADDED

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+class <%= scope.camelize %>Controller < BeyondCanvas::AuthenticationsController
+  # before_action :configure_params, only: [:install]
+  # def new
+  #   super
+  # end
+  # def install
+  #   super
+  # end
+  # private
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_params
+  #   beyond_canvas_parameter_sanitizer.permit(:attribute1, :attribute2)
+  # end
+end

data/lib/generators/beyond_canvas/custom_menu/custom_menu_generator.rb ADDED

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module BeyondCanvas
+  module Generators
+    class CustomMenuGenerator < Rails::Generators::Base # :nodoc:
+      source_root File.expand_path('templates', __dir__)
+      def copy_initializer
+        copy_file 'beyond_canvas_custom_menu.html.erb', 'app/views/beyond_canvas/shared/_menu.html.erb'
+      end
+    end
+  end
+end

data/lib/generators/beyond_canvas/custom_menu/templates/beyond_canvas_custom_menu.html.erb ADDED

@@ -0,0 +1,32 @@
+<div class="menu">
+  <div class="menu--left">
+    <%= render 'beyond_canvas/shared/logo' %>
+  </div>
+  <div class="menu--center">
+<%
+=begin
+    Add here your menu links. You can use `menu__item` as class name and add
+    `menu__item--selected` as secondary class for selected menu item. E.g:
+    <%= link_to 'About us', about_us_path, class: "menu__item #{ 'menu__item--selected' if params[:controller] == 'about_us' }" %>
+    <%= link_to 'Support', support_path, class: "menu__item #{ 'menu__item--selected' if params[:controller] == 'support' }" %>
+=end
+%>
+  </div>
+  <div class="menu--right">
+<%
+=begin
+    You can also add here some content that will be right-aligned, like a user
+    avatar image or a dropdown account menu.
+=end
+%>
+  </div>
+</div>

data/lib/generators/beyond_canvas/custom_styles/custom_styles_generator.rb CHANGED

@@ -6,7 +6,7 @@ module BeyondCanvas
       source_root File.expand_path('templates', __dir__)
       def copy_initializer
-        template 'beyond_canvas_custom_styles.sass', 'app/assets/stylesheets/_beyond_canvas_custom_styles.sass'
+        template 'beyond_canvas_custom_styles.scss', 'app/assets/stylesheets/_beyond_canvas_custom_styles.scss'
       end
     end
   end

data/lib/generators/beyond_canvas/custom_styles/templates/beyond_canvas_custom_styles.scss ADDED

@@ -0,0 +1,199 @@
+// ************************************************************
+// Colors
+// ************************************************************
+// $palette-primary: rgb(78, 183, 168);
+// $palette-secondary: rgb(28, 53, 69);
+// $palette-cancel: rgb(153, 153, 153);
+// $palette-danger: rgb(218, 60, 60);
+// ************************************************************
+// General styles
+// ************************************************************
+// $main-background-public: rgb(233, 232, 220);
+// $main-background-application: rgb(233, 232, 220);
+// ************************************************************
+// Typography
+// ************************************************************
+// $main-color: rgb(62, 62, 62);
+// ************************************************************
+// Headlines
+// ************************************************************
+// $headline-color: rgb(122, 118, 76);
+// ************************************************************
+// Links
+// ************************************************************
+// $link-primary-color: darken($palette-primary, 10%);
+// $link-secondary-color: darken($palette-cancel, 10%);
+// $link-danger-color: darken($palette-danger, 10%);
+// ************************************************************
+// Buttons
+// ************************************************************
+// $button-primary-background: $palette-primary;
+// $button-primary-color: $white;
+// $button-secondary-background: $palette-cancel;
+// $button-secondary-color: $white;
+// $button-danger-background: $palette-danger;
+// $button-danger-color: $white;
+// $button-border-radius: 3px;
+// $button-box-shadow: true;
+// ************************************************************
+// Cards
+// ************************************************************
+// $card-border-radius: 3px;
+// $card-box-shadow: 0 2px 7px rgba($black, 0.2);
+// $card-separator-color: rgb(222, 222, 222);
+// $card-title-color: rgb(247, 133, 96);
+// ************************************************************
+// Containers
+// ************************************************************
+// ************************************************************
+// Labels
+// ************************************************************
+// $label-color: rgb(128, 128, 128);
+// ************************************************************
+// Inputs
+// ************************************************************
+// $input-border-color: rgb(217, 216, 195);
+// $input-border-color-focus: $palette-primary;
+// $input-errors-color: $palette-danger;
+// ************************************************************
+// Checkboxes
+// ************************************************************
+// $checkbox-checked-color: #97C344; // This value MUST be HEX
+// $checkbox-checked-background: #ffffff; // This value MUST be HEX
+// $checkbox-unchecked-color: #C2BF9D; // This value MUST be HEX
+// $checkbox-unchecked-background: #ffffff; // This value MUST be HEX
+// ************************************************************
+// Radiobuttons
+// ************************************************************
+// $radio-checked-color: #97C344; // This value MUST be HEX
+// $radio-checked-background: #ffffff; // This value MUST be HEX
+// $radio-unchecked-color: #C2BF9D; // This value MUST be HEX
+// $radio-unchecked-background: #ffffff; // This value MUST be HEX
+// ************************************************************
+// Hints
+// ************************************************************
+// $hint-color: rgb(158, 158, 158);
+// ************************************************************
+// Logo
+// ************************************************************
+// $logo-margin-top-public: 0;
+// $logo-margin-bottom-public: 34px;
+// ************************************************************
+// Flash
+// ************************************************************
+// $flash-success: rgb(123, 170, 81);
+// $flash-notice: rgb(123, 170, 81);
+// $flash-info: rgb(153, 153, 153);
+// $flash-warning: rgb(243, 181, 71);
+// $flash-error: rgb(218, 60, 60);
+// $flash-border-radius: 4px;
+// $flash-box-shadow: 0 1px 2px 0 rgba($black, 0.2);
+// $flash-color: rgb(128, 128, 128);
+// ************************************************************
+// Tables
+// ************************************************************
+// $table-header-background: rgb(243, 242, 236);
+// $table-border-color: rgb(233, 232, 220);
+// ************************************************************
+// Comments
+// ************************************************************
+// $comment-background: rgb(246, 246, 243);
+// $comment-color: rgb(170, 169, 156);
+// ************************************************************
+// Notices
+// ************************************************************
+// $notice-success-background: rgb(123, 170, 81);
+// $notice-notice-background: rgb(123, 170, 81);
+// $notice-info-background: rgb(153, 153, 153);
+// $notice-warning-background: rgb(243, 181, 71);
+// $notice-error-background: rgb(218, 60, 60);
+// $notice-border-radius: 4px;
+// $notice-color: rgb(153, 153, 153);
+// ************************************************************
+// Breadcrums
+// ************************************************************
+// $breadcrum-color: rgb(122, 118, 76);
+// $breadcrum-color-current: rgb(61, 149, 137);
+// ************************************************************
+// Titles
+// ************************************************************
+// $title-color: rgb(122, 118, 76);
+// ************************************************************
+// Menu
+// ************************************************************
+// $menu-background: #1c3445;
+// $menu-height: 60px;
+// $menu-logo-height: 30px;
+// $menu-item-color: #9ab5c6;
+// $menu-item-hover-color: lighten($menu-item-color, 13%);
+// $menu-item-selected-color: #4eb7a8;
+// $menu-item-selected-hover-color: lighten($menu-item-selected-color, 13%);
+// ************************************************************
+// Action bar
+// ************************************************************
+// $action-bar-background: rgb(255, 255, 255);
+// $action-bar-shadow: 1px solid rgba(0, 0, 0, 0.2);
+// $action-bar-height: 73px;
+// ************************************************************
+// Markdown
+// ************************************************************
+// ************************************************************
+// Sidebar
+// ************************************************************
+// ************************************************************
+// Modals
+// ************************************************************
+// $modal-close-icon-color: #8b8b8b;
+// $modal-background-color: rgba(0, 0, 0, 0.5);