beyond_canvas 0.15.2.pre → 0.17.0.pre

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

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

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

@@ -15,10 +15,6 @@ module BeyondCanvas
         template 'beyond_canvas.rb.erb', 'config/initializers/beyond_canvas.rb'
       end
 
-      def setup_routes
-        route "mount BeyondCanvas::Engine => '/'"
-      end
-
       def create_assets
         if options[:skip_webpacker]
           generate 'beyond_canvas:assets'
@@ -28,7 +24,19 @@ module BeyondCanvas
       end
 
       def install_beyond_api
-        generate 'beyond_api:install'
+        generate 'beyond_canvas:beyond_api'
+      end
+
+      def generate_model
+        generate 'beyond_canvas:model shop'
+      end
+
+      def setup_routes
+        route 'beyond_canvas_routes'
+      end
+
+      def copy_locale
+        copy_file '../../../../../config/locales/en.yml', 'config/locales/beyond_canvas.en.yml'
       end
     end
   end

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,24 +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
+
+  config.encryption_key = '<%= SecureRandom.hex(32) %>'
 end

data/lib/generators/beyond_canvas/model/model_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module BeyondCanvas
+  module Generators
+    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'
+
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_beyond_canvas_migration
+        migration_path = File.join('db', 'migrate')
+        migration_template 'migration.erb',
+                           "#{migration_path}/beyond_canvas_create_#{table_name}.rb",
+                           migration_version: migration_version
+      end
+
+      def generate_model
+        template 'model.erb', File.join("app/models/#{file_path}.rb")
+      end
+
+      private
+
+      def rails5_and_up?
+        Rails::VERSION::MAJOR >= 5
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5_and_up?
+      end
+
+      def migration_data
+        <<RUBY
+      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
+  end
+end

data/lib/generators/beyond_canvas/model/templates/migration.erb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class BeyondCanvasCreate<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %><%= primary_key_type %> do |t|
+<%= migration_data -%>
+<% attributes.each do |attribute| -%>
+    t.<%= attribute.type %> :<%= attribute.name %>
+
+<% end -%>
+      t.timestamps null: false
+    end
+
+    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
+end

data/lib/generators/beyond_canvas/model/templates/model.erb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class <%= file_path.classify %> < ApplicationRecord
+  include BeyondCanvas::Models::Shop
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module BeyondCanvas
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base # :nodoc:
+      desc 'Creates all Beyond Canvas views to overwrite them'
+
+      source_root File.expand_path('../../../../app/views/beyond_canvas', __dir__)
+
+      def copy_views
+        directory 'authentications', 'app/views/beyond_canvas/authentications'
+      end
+    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