beyond_canvas 0.15.3.pre → 0.18.0.pre

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

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

data/lib/models/shop.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module Models
+    module Shop # :nodoc:
+      extend ActiveSupport::Concern
+
+      include ::BeyondCanvas::Models::Concerns::Authentication
+      include ::BeyondCanvas::Models::Concerns::Utils
+    end
+  end
+end

metadata

@@ -1,29 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: beyond_canvas
 version: !ruby/object:Gem::Version
-  version: 0.15.3.pre
+  version: 0.18.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
-autorequire: 
+- Kathia Salazar
+- German San Emeterio
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: attr_encrypted
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: beyond_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: bourbon
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +158,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: loaf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -160,7 +204,9 @@ description: |2
       Beyond Canvas is an open-source framework that provides CSS styles for apps
       designed and developed for the online shop software Beyond
 email:
-- u.abrisketa@epages.com
+- uabrisketa@epages.com
+- ksalazar@epages.com
+- gsanemeterio@epages.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -169,36 +215,48 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/beyond_canvas_manifest.js
+- app/assets/images/icons/arrow_right.svg
 - app/assets/images/icons/checkbox_checked.svg
 - app/assets/images/icons/checkbox_unchecked.svg
+- app/assets/images/icons/close.svg
 - app/assets/images/icons/file.svg
 - app/assets/images/icons/flash_checkbox.svg
 - app/assets/images/icons/flash_close.svg
 - app/assets/images/icons/flash_error.svg
 - app/assets/images/icons/flash_info.svg
 - app/assets/images/icons/flash_warning.svg
+- app/assets/images/icons/home.svg
 - app/assets/images/icons/radiobutton_checked.svg
 - app/assets/images/icons/radiobutton_unchecked.svg
 - app/assets/javascripts/beyond_canvas/base.js
 - app/assets/stylesheets/beyond_canvas/base.scss
+- app/assets/stylesheets/beyond_canvas/components/_action_bar.scss
 - app/assets/stylesheets/beyond_canvas/components/_actions.scss
+- app/assets/stylesheets/beyond_canvas/components/_breadcrumbs.scss
 - app/assets/stylesheets/beyond_canvas/components/_buttons.scss
 - app/assets/stylesheets/beyond_canvas/components/_cards.scss
 - app/assets/stylesheets/beyond_canvas/components/_comments.scss
 - app/assets/stylesheets/beyond_canvas/components/_containers.scss
+- app/assets/stylesheets/beyond_canvas/components/_debug.scss
 - app/assets/stylesheets/beyond_canvas/components/_flash.scss
 - app/assets/stylesheets/beyond_canvas/components/_forms.scss
+- app/assets/stylesheets/beyond_canvas/components/_grids.scss
 - app/assets/stylesheets/beyond_canvas/components/_inputs.scss
 - app/assets/stylesheets/beyond_canvas/components/_layouts.scss
 - app/assets/stylesheets/beyond_canvas/components/_links.scss
 - app/assets/stylesheets/beyond_canvas/components/_main.scss
 - app/assets/stylesheets/beyond_canvas/components/_margins.scss
 - app/assets/stylesheets/beyond_canvas/components/_markdown.scss
+- app/assets/stylesheets/beyond_canvas/components/_menu.scss
+- app/assets/stylesheets/beyond_canvas/components/_modals.scss
 - app/assets/stylesheets/beyond_canvas/components/_notices.scss
 - app/assets/stylesheets/beyond_canvas/components/_relative.scss
+- app/assets/stylesheets/beyond_canvas/components/_scrollbox.scss
+- app/assets/stylesheets/beyond_canvas/components/_sidebar.scss
 - app/assets/stylesheets/beyond_canvas/components/_spinner.scss
 - app/assets/stylesheets/beyond_canvas/components/_tables.scss
 - app/assets/stylesheets/beyond_canvas/components/_texts.scss
+- app/assets/stylesheets/beyond_canvas/components/_titles.scss
 - app/assets/stylesheets/beyond_canvas/mailer.scss
 - app/assets/stylesheets/beyond_canvas/settings/_breakpoints.scss
 - app/assets/stylesheets/beyond_canvas/settings/_reset_css.scss
@@ -207,54 +265,81 @@ files:
 - app/assets/stylesheets/beyond_canvas/utilities/_functions.scss
 - app/assets/stylesheets/beyond_canvas/utilities/_mixins.scss
 - app/controllers/beyond_canvas/application_controller.rb
+- app/controllers/beyond_canvas/authentications_controller.rb
 - app/controllers/beyond_canvas/system_controller.rb
+- app/controllers/concerns/beyond_canvas/authentication.rb
 - app/controllers/concerns/beyond_canvas/locale_management.rb
 - app/controllers/concerns/beyond_canvas/request_validation.rb
 - app/controllers/concerns/beyond_canvas/status_codes.rb
 - app/form_builders/beyond_canvas/form_builder.rb
 - app/helpers/beyond_canvas/application_helper.rb
+- app/helpers/beyond_canvas/authentications_helper.rb
+- app/helpers/beyond_canvas/cockpit_app_helper.rb
+- app/helpers/beyond_canvas/debug_helper.rb
 - app/helpers/beyond_canvas/locale_switch_helper.rb
 - app/javascript/beyond_canvas/base.js
 - app/javascript/beyond_canvas/initializers/buttons.js
 - app/javascript/beyond_canvas/initializers/flash.js
-- app/javascript/beyond_canvas/initializers/functions.js
 - app/javascript/beyond_canvas/initializers/inputs.js
+- app/javascript/beyond_canvas/initializers/modals.js
+- app/views/beyond_canvas/authentications/new.html.erb
 - app/views/beyond_canvas/custom/_public_head.html.erb
-- app/views/beyond_canvas/locales/_edit.html.erb
 - app/views/beyond_canvas/mailer/_button.html.erb
 - app/views/beyond_canvas/mailer/_footer.html.erb
 - app/views/beyond_canvas/mailer/_header.html.erb
 - app/views/beyond_canvas/mailer/_text.html.erb
+- app/views/beyond_canvas/shared/_action_bar.html.erb
+- app/views/beyond_canvas/shared/_breadcrumbs.html.erb
 - app/views/beyond_canvas/shared/_flash.html.erb
 - app/views/beyond_canvas/shared/_head.html.erb
+- app/views/beyond_canvas/shared/_locales.html.erb
 - app/views/beyond_canvas/shared/_logo.html.erb
+- app/views/beyond_canvas/shared/_menu.html.erb
+- app/views/beyond_canvas/shared/_modal.html.erb
+- app/views/beyond_canvas/shared/_sidebar.html.erb
+- app/views/layouts/beyond_canvas/application.html.erb
 - app/views/layouts/beyond_canvas/mailer.html.erb
 - app/views/layouts/beyond_canvas/public.html.erb
 - config/initializers/beyond_canvas/filter_parameter_logging.rb
 - config/initializers/beyond_canvas/form_utils.rb
+- config/locales/en.yml
 - config/routes.rb
 - lib/beyond_canvas.rb
 - lib/beyond_canvas/asset_registration.rb
 - lib/beyond_canvas/configuration.rb
 - lib/beyond_canvas/engine.rb
+- lib/beyond_canvas/menu_item_registration.rb
+- lib/beyond_canvas/parameter_sanitizer.rb
+- lib/beyond_canvas/rails/routes.rb
 - lib/beyond_canvas/version.rb
 - lib/generators/beyond_canvas/assets/assets_generator.rb
 - lib/generators/beyond_canvas/assets/templates/beyond_canvas.js
 - lib/generators/beyond_canvas/assets/templates/beyond_canvas.scss
 - lib/generators/beyond_canvas/beyond_api/beyond_api_generator.rb
+- lib/generators/beyond_canvas/controller/controller_generator.rb
+- lib/generators/beyond_canvas/controller/templates/controller.erb
+- lib/generators/beyond_canvas/custom_menu/custom_menu_generator.rb
+- lib/generators/beyond_canvas/custom_menu/templates/beyond_canvas_custom_menu.html.erb
 - lib/generators/beyond_canvas/custom_styles/custom_styles_generator.rb
-- lib/generators/beyond_canvas/custom_styles/templates/beyond_canvas_custom_styles.sass
+- lib/generators/beyond_canvas/custom_styles/templates/beyond_canvas_custom_styles.scss
 - lib/generators/beyond_canvas/install/install_generator.rb
 - lib/generators/beyond_canvas/install/templates/beyond_canvas.rb.erb
+- lib/generators/beyond_canvas/model/model_generator.rb
+- lib/generators/beyond_canvas/model/templates/migration.erb
+- lib/generators/beyond_canvas/model/templates/model.erb
+- lib/generators/beyond_canvas/views/views_generator.rb
 - lib/generators/beyond_canvas/webpacker/plugins/jquery.js
 - lib/generators/beyond_canvas/webpacker/templates/beyond_canvas.js
 - lib/generators/beyond_canvas/webpacker/templates/beyond_canvas.scss
 - lib/generators/beyond_canvas/webpacker/webpacker_generator.rb
+- lib/models/concerns/authentication.rb
+- lib/models/concerns/utils.rb
+- lib/models/shop.rb
 homepage: https://github.com/ePages-de/beyond_canvas
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -269,8 +354,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Open-source framework that provides CSS styles
 test_files: []