beyond_canvas 0.16.2.pre → 0.19.2.pre

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

@@ -1,17 +1,26 @@
-<div class='card card--padding'>
+<% app_name = BeyondCanvas.configuration.site_title %>
+<% i18n_scope = 'beyond_canvas.authentications.new' %>
 
-  <%= form_for(resource, as: resource_name) do |f| %>
+<div class="card card--padding">
 
-    <h2 class='card__headline'>Install <%= BeyondCanvas.configuration.site_title %> in your shop</h2>
+  <%= form_with(url: callback_path, method: :post, scope: :shop, model: @shop, local: true, builder: BeyondCanvas::FormBuilder) do |f| %>
 
-    <%= f.hidden_field :code,             value: params[:code] || resource.code %>
-    <%= f.hidden_field :signature,        value: params[:signature] || resource.signature %>
-    <%= f.hidden_field :return_url,       value: params[:return_url] || resource.return_url %>
-    <%= f.hidden_field :api_url,          value: params[:api_url] || resource.api_url %>
-    <%= f.hidden_field :access_token_url, value: params[:access_token_url] || resource.access_token_url %>
+    <h2 class="card__headline"><%= I18n.t('headline', app_name: app_name, scope: i18n_scope) %></h2>
 
-    <div class='form__actions--spaced'>
-      <%= f.button 'Save', type: :submit, class: 'button__solid--primary' %>
+    <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 %>

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>

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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -4,15 +4,22 @@
 <%= render 'beyond_canvas/shared/head' %>
 
 <body class="body--public">
+
   <main class="main <%= params[:controller].gsub(/[\/_]/, "-") %>--<%= params[:action] %>">
-    <div id="flash">
-      <%= render 'beyond_canvas/shared/flash' %>
-    </div>
-    <%= render 'beyond_canvas/locales/edit' %>
+
+    <%= render 'beyond_canvas/shared/flash' %>
+    <%= 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

@@ -1,4 +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

@@ -1,11 +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(resource_name)
-    resources resource_name, controller: 'authentications', except: :destroy
+  def create_default_routes
+    get  'callback', to: 'authentications#new'
+    post 'callback', to: 'authentications#install'
   end
 
-  create_default_routes(BeyondCanvas.auth_model.pluralize.to_sym) unless BeyondCanvas.use_rails_app_controller
+  create_default_routes unless BeyondCanvas.use_rails_app_controller
 end

data/lib/beyond_canvas.rb

@@ -8,30 +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'
-require 'blind_index'
 
 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 :Authentication,   'beyond_canvas/models/authentication'
-    autoload :Shop,             'beyond_canvas/models/shop'
-    autoload :Utils,            'beyond_canvas/models/utils'
-  end
+    autoload :Shop, 'models/shop'
 
-  autoload :ParameterSanitizer, 'beyond_canvas/parameter_sanitizer'
+    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 # rubocop:disable Style/ClassVars
-
-  mattr_accessor :auth_model
-  @@auth_model = 'shop' # rubocop:disable Style/ClassVars
+  @@use_rails_app_controller = false
 
   class << self
     def configuration

data/lib/beyond_canvas/configuration.rb

@@ -2,18 +2,23 @@
 
 module BeyondCanvas
   class Configuration # :nodoc:
-    attr_accessor :site_title, :site_logo, :favicon, :skip_webpacker, :encryption_key, :blind_index_key, :namespace
+    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
-      @favicon = nil
-      @skip_webpacker = false
+      @cockpit_app = false
+      @debug_mode = false
       @encryption_key = nil
-      @blind_index_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
 
     def setup!

data/lib/beyond_canvas/engine.rb

@@ -13,22 +13,21 @@ 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
       ActiveSupport.on_load :action_controller do
-        include ::BeyondCanvas::Authentication
         include ::BeyondCanvas::LocaleManagement
-        include ::BeyondCanvas::ResourceManagement
         include ::BeyondCanvas::RequestValidation
         include ::BeyondCanvas::StatusCodes
+        include ::BeyondCanvas::AuthenticationsHelper
+        include ::BeyondCanvas::DebugHelper
+        include ::BeyondCanvas::ControllerHelper
 
         ::ActionController::Base.helper BeyondCanvas::Engine.helpers
       end
-
-      ActiveSupport.on_load :action_mailer do
-        layout 'beyond_canvas/mailer'
-      end
     end
   end
 end

data/lib/beyond_canvas/menu_item_registration.rb

@@ -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

@@ -2,7 +2,7 @@
 
 module BeyondCanvas
   class ParameterSanitizer # :nodoc:
-    DEFAULT_PERMITTED_ATTRIBUTES = %i[code signature return_url api_url access_token_url].freeze
+    DEFAULT_PERMITTED_ATTRIBUTES = %i[code signature return_url api_url access_token_url]
 
     def initialize(resource_name, params)
       @params         = params

data/lib/beyond_canvas/rails/routes.rb

@@ -3,18 +3,19 @@
 module ActionDispatch
   module Routing
     class Mapper # :nodoc:
-      def beyond_canvas_for(*resources)
+      def beyond_canvas_routes(options = nil)
         mount BeyondCanvas::Engine => BeyondCanvas.configuration.namespace
 
-        resource_name, options = resources
-        BeyondCanvas.auth_model = resource_name.to_s.singularize
-        BeyondCanvas.use_rails_app_controller = options.present? && options[:controller].present?
+        BeyondCanvas.use_rails_app_controller = options.present? && options[:custom_controller].present?
 
-        set_routes(resource_name, options[:controller]) if BeyondCanvas.use_rails_app_controller
+        set_routes if BeyondCanvas.use_rails_app_controller
       end
 
-      def set_routes(resource_name, controller)
-        resources resource_name, controller: controller
+      def set_routes
+        scope BeyondCanvas.configuration.namespace do
+          get  'callback', controller: :authentications, action: :new
+          post 'callback', controller: :authentications, action: :install
+        end
       end
     end
   end

data/lib/beyond_canvas/version.rb

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

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

@@ -1,19 +1,14 @@
 # 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"
+        template 'shops_controller.rb', "app/controllers/shops_controller.rb"
       end
     end
   end