beyond_canvas 0.16.2.pre → 0.19.2.pre

data/lib/generators/beyond_canvas/controller/templates/shops_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class ShopsController < 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

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

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

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

@@ -11,7 +11,8 @@
 // General styles
 // ************************************************************
 
-// $main-background: rgb(233, 232, 220);
+// $main-background-public: rgb(233, 232, 220);
+// $main-background-application: rgb(233, 232, 220);
 
 // ************************************************************
 // Typography
@@ -81,19 +82,19 @@
 // Checkboxes
 // ************************************************************
 
-// $checkbox-checked-color: #97C344;
-// $checkbox-checked-background: #ffffff;
-// $checkbox-unchecked-color: #C2BF9D;
-// $checkbox-unchecked-background: #ffffff;
+// $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;
-// $radio-checked-background: #ffffff;
-// $radio-unchecked-color: #C2BF9D;
-// $radio-unchecked-background: #ffffff;
+// $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
@@ -147,7 +148,52 @@
 // $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);

data/lib/generators/beyond_canvas/install/install_generator.rb

@@ -6,13 +6,11 @@ module BeyondCanvas
       desc 'Installs Beyond Canvas and generates the necessary files'
 
       class_option :skip_webpacker, type: :boolean, default: false, desc: 'Use Sprockets assets instead of Webpacker'
-      class_option :auth_model, type: :string, default: 'shop', desc: 'Authentication model'
 
       source_root File.expand_path('templates', __dir__)
 
       def copy_initializer
         @skip_webpacker = options[:skip_webpacker]
-        @auth_model = options[:auth_model]
 
         template 'beyond_canvas.rb.erb', 'config/initializers/beyond_canvas.rb'
       end
@@ -29,12 +27,12 @@ module BeyondCanvas
         generate 'beyond_canvas:beyond_api'
       end
 
-      def generate_auth_model
-        generate "beyond_canvas:auth_model #{@auth_model}"
+      def generate_model
+        generate 'beyond_canvas:model shop'
       end
 
       def setup_routes
-        route "beyond_canvas_for :#{@auth_model.pluralize}"
+        route 'beyond_canvas_routes'
       end
 
       def copy_locale

data/lib/generators/beyond_canvas/install/templates/beyond_canvas.rb.erb

@@ -1,9 +1,41 @@
 # frozen_string_literal: true
 
 BeyondCanvas.setup do |config|
+  # Carefully read and fill this configuration file.
+  #
+  # All uncommented configuration parameters are necessary for proper operation
+  # of Beyond Canvas.
+
+  # ==> Engine configuration
+
+  # Set the namespace where the Engine is going to be mounted.
+  #
+  # config.namespace = '/'
+
+  # Set the url or path where a shop is going to be redirected after a
+  # succesful authentication.
+  #
+  config.open_app_url = nil
+
+  # Set if your app ig going to run as a cockpit app. If you are not sure about
+  # this, please contact apps@epages.com.
+  #
+  # config.cockpit_app = false
+
+  # Set if your app is going to be preinstalled on packages. If you are not sure
+  # about this, please contact apps@epages.com.
+  #
+  # config.preinstalled = false
+
+  # Set if you want to enable the available debug mode Beyond Canvas offers.
+  # This options displays a parameter debug as well as some custom Beyond Canvas
+  # logs.
+  #
+  # config.debug_mode = false
+
   # ==> Site configuration
 
-  # Set the title that is displayed on the main layout..
+  # Set the title that is displayed on the main layout.
   #
   config.site_title = '<%= Rails.application.class.name.split("::").first.humanize %>'
 
@@ -17,35 +49,41 @@ BeyondCanvas.setup do |config|
   #
   # config.favicon = 'favicon.ico'
 
+  # Set the menu items that will be displayed on the top of your app.
+  # It accepts 3 parameters:
+  #   1. name: the text displayed on the link tag. Supports any string or an I18n compatible path.
+  #   2. url: the href of the link tag. Supports any string or a symbolized route.
+  #   3. options: any html attributes that will be added to the link tag.
+  # You can also run `rails g beyond_canvas:custom_menu` to generate a menu template you can override.
+  # See examples:
+  #
+  # config.register_menu_item 'Contact', '/contact/, class: 'contact'
+  # config.register_menu_item 'menu_item.about_us', :root_path, class: 'about-us', id: 'about-us'
+  # config.register_menu_item 'Our website', 'https://epages.com', target: :_blank
+
   # ==> Stylesheets & Javascripts
 
   # We recommend using the built in Beyond Canvas layout and loading up your own
   # stylesheets / javascripts to customize the look and feel.
   #
   # To load a stylesheet:
-  #   config.register_stylesheet 'my_stylesheet.css'
+  # config.register_stylesheet 'my_stylesheet.css'
   #
-  # You can provide an options hash for more control, which is passed along to stylesheet_link_tag():
-  #   config.register_stylesheet 'my_print_stylesheet.css', media: :print
+  # You can provide an options hash for more control, which is passed along
+  # to stylesheet_link_tag():
+  # config.register_stylesheet 'my_print_stylesheet.css', media: :print
   #
   # To load a javascript file:
-  #   config.register_javascript 'my_javascript.js'
+  # config.register_javascript 'my_javascript.js'
 
   # ==> Webpacker
 
-  # By default, Active Admin uses Webpacker.
+  # By default, Beyond Canvas uses Webpacker.
   # You can switch to using Sprocket's asset pipeline here.
   #
   <% unless @skip_webpacker %># <% end %>config.skip_webpacker = <%= @skip_webpacker %>
 
-  # ==> Authentication with ePages Beyond API
+  # ==> Database encryption
 
-  # Default model is shop
-  #
   config.encryption_key = '<%= SecureRandom.hex(32) %>'
-  config.blind_index_key = '<%= SecureRandom.hex(32) %>'
-
-  # ==> Mountable engine configuration
-  #
-  #   config.namespace = '/'
 end

data/lib/generators/beyond_canvas/{auth_model/auth_model_generator.rb → model/model_generator.rb}

@@ -4,7 +4,7 @@ require 'rails/generators/active_record'
 
 module BeyondCanvas
   module Generators
-    class AuthModelGenerator < ActiveRecord::Generators::Base # :nodoc:
+    class ModelGenerator < ActiveRecord::Generators::Base # :nodoc:
       desc 'Generates a model with the given name and provides a method to authenticate in Beyond Backend'
 
       argument :attributes, type: :array, default: [], banner: 'field:type field:type'
@@ -19,7 +19,7 @@ module BeyondCanvas
       end
 
       def generate_model
-        template 'model.erb', File.join('app', 'models', "#{file_path}.rb")
+        template 'model.erb', File.join("app/models/#{file_path}.rb")
       end
 
       private
@@ -34,15 +34,14 @@ module BeyondCanvas
 
       def migration_data
         <<RUBY
-      t.string :encrypted_beyond_api_url,       null: false
-      t.string :encrypted_beyond_api_url_iv,    null: false
-      t.string :beyond_api_url_bidx,            null: false
+      t.string :beyond_api_url, null: false
 
       t.text :encrypted_beyond_access_token,    null: true
       t.text :encrypted_beyond_access_token_iv, null: true
 
       t.text :encrypted_beyond_refresh_token,    null: true
       t.text :encrypted_beyond_refresh_token_iv, null: true
+
 RUBY
       end
     end

data/lib/generators/beyond_canvas/{auth_model → model}/templates/migration.erb

@@ -4,16 +4,14 @@ class BeyondCanvasCreate<%= table_name.camelize %> < ActiveRecord::Migration<%=
   def change
     create_table :<%= table_name %><%= primary_key_type %> do |t|
 <%= migration_data -%>
-
 <% attributes.each do |attribute| -%>
     t.<%= attribute.type %> :<%= attribute.name %>
-<% end -%>
 
+<% end -%>
       t.timestamps null: false
     end
 
-    add_index :<%= table_name %>, :encrypted_beyond_api_url_iv,       unique: true
-    add_index :<%= table_name %>, :beyond_api_url_bidx,               unique: true
+    add_index :<%= table_name %>, :beyond_api_url,                    unique: true
     add_index :<%= table_name %>, :encrypted_beyond_access_token_iv,  unique: true
     add_index :<%= table_name %>, :encrypted_beyond_refresh_token_iv, unique: true
   end

data/lib/generators/beyond_canvas/views/views_generator.rb

@@ -5,14 +5,12 @@ require 'rails/generators/active_record'
 module BeyondCanvas
   module Generators
     class ViewsGenerator < Rails::Generators::Base # :nodoc:
-      desc 'Creates a view in the app/view folder'
+      desc 'Creates all Beyond Canvas views to overwrite them'
 
-      argument :scope, required: true, desc: 'The scope to copy views to'
+      source_root File.expand_path('../../../../app/views/beyond_canvas', __dir__)
 
-      source_root File.expand_path('../../../../app/views/beyond_canvas/authentications', __dir__)
-
-      def create_view
-        copy_file 'new.html.erb', "app/views/#{scope}/new.html.erb"
+      def copy_views
+        directory 'authentications', 'app/views/beyond_canvas/authentications'
       end
     end
   end

data/lib/models/concerns/authentication.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module Models
+    module Concerns
+      module Authentication # :nodoc:
+        extend ActiveSupport::Concern
+
+        included do
+          attr_accessor :code, :signature, :access_token_url, :api_url, :return_url, :terms
+
+          ##############################################################################
+          # Encrypted attribute configuration
+          ##############################################################################
+
+          attr_encrypted :beyond_access_token,  key: [BeyondCanvas.configuration.encryption_key].pack('H*')
+          attr_encrypted :beyond_refresh_token, key: [BeyondCanvas.configuration.encryption_key].pack('H*')
+
+          ##############################################################################
+          # Validations
+          ##############################################################################
+
+          # Database fields
+
+          validates :beyond_api_url,
+                    presence: true
+          validates :beyond_access_token,
+                    presence: true,
+                    unless: -> { encrypted_beyond_access_token_was.blank? }
+          validates :beyond_refresh_token,
+                    presence: true,
+                    unless: -> { encrypted_beyond_refresh_token_was.blank? }
+
+          ##############################################################################
+          # Instance methods
+          ##############################################################################
+
+          #
+          # Get and save access_token and refresh_token using the authentication code
+          # NOTE: This method is used during the shop creation, as it is the only point
+          # we know about the authentication code
+          #
+          def authenticate(params_code)
+            session = BeyondApi::Session.new(api_url: beyond_api_url)
+            session.token.create(params_code)
+            update(beyond_access_token: session.access_token,
+                   beyond_refresh_token: session.refresh_token)
+          end
+
+          def authenticated?
+            beyond_access_token.present? && beyond_refresh_token.present?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/models/concerns/utils.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
+module BeyondCanvas
+  module Models
+    module Concerns
+      module Utils # :nodoc:
+        extend ActiveSupport::Concern
+
+        included do
+          ##############################################################################
+          # Instance methods
+          ##############################################################################
+
+          #
+          # Generates a new access_token and refresh_token
+          #
+          def refresh_token
+            beyond_session = BeyondApi::Session.new(api_url: beyond_api_url, refresh_token: beyond_refresh_token)
+            beyond_session.token.refresh
+
+            update(beyond_access_token: beyond_session.access_token,
+                   beyond_refresh_token: beyond_session.refresh_token)
+          end
+
+          #
+          # Generates a new access_token and refresh_token if they have expired
+          #
+          def refresh_token_if_needed
+            token_timestamp = decoded_jwt['exp']
+            current_timestamp = DateTime.now.to_i
+            return unless token_timestamp - current_timestamp <= 3600
+
+            refresh_token
+          end
+
+          #
+          # Returns a BeyondApi::Session object with api_url, access_token and refresh_token attributes
+          #
+          def to_session
+            BeyondApi::Session.new(api_url: beyond_api_url,
+                                    access_token: beyond_access_token,
+                                    refresh_token: beyond_refresh_token)
+          end
+
+          #
+          # Returns the shop url
+          #
+          def url
+            "https://#{URI.parse(beyond_api_url).host}"
+          end
+
+          def has_scope?(scope)
+            return unless scope.include?(':')
+
+            base, scope = scope.split(':')
+            !!(decoded_jwt['scope'].find { |s| s.split(':').first == base } =~ /#{base}:.*#{scope}.*/)
+          end
+
+          ##############################################################################
+          # Class methods
+          ##############################################################################
+
+          def self.find_session(id)
+            shop = find(id)
+            shop.to_session
+          end
+
+          private
+
+          def decoded_jwt
+            JWT.decode(beyond_access_token, nil, false).first
+          end
+        end
+      end
+    end
+  end
+end