beyond_canvas 0.22.0.pre → 0.23.0.pre

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

@@ -38,6 +38,12 @@ module BeyondCanvas
       def copy_locale
         copy_file '../../../../../config/locales/en.yml', 'config/locales/beyond_canvas.en.yml'
       end
+
+      def copy_public
+        Dir[File.join(BeyondCanvas::Engine.root, 'public', '*')].each do |file|
+          copy_file file, File.join(Rails.root, 'public', File.basename(file))
+        end
+      end
     end
   end
 end

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

@@ -33,6 +33,18 @@ BeyondCanvas.setup do |config|
   #
   # config.debug_mode = false
 
+  # Set an optional image to be send as email. Accepts any
+  # string supported by image_tag's source parameter. Overrides
+  # :email_logo.
+  #
+  # config.email_logo = 'logo.png' # Can't be svg
+
+  # ==> Authorization configuration
+
+  # Set if you want to retrieve the shop token using `grant_type=client_credentials`
+  # on development environment. Default is `grant_type=authorization_code`.
+  # config.client_credentials = false
+
   # ==> Site configuration
 
   # Set the title that is displayed on the main layout.
@@ -43,7 +55,7 @@ BeyondCanvas.setup do |config|
   # string supported by image_tag's source parameter or a SVG file. Overrides
   # :site_title.
   #
-  # config.site_logo = 'logo.png'
+  # config.site_logo = 'logo.svg'
 
   # Set the favicon of the site.
   #
@@ -86,4 +98,29 @@ BeyondCanvas.setup do |config|
   # ==> Database encryption
 
   config.encryption_key = '<%= SecureRandom.hex(32) %>'
+
+  # Webhooks event listeners
+  # You can inculde the beyond
+  # By default Beyond canvas is listening for app.unistalled event.
+
+  # URL for get webhooks whe you are using develpment
+
+  # ==> Webhooks
+
+  # By default Beyond Canvas subscribes to `app.uninstalled` webhook event and
+  # handles the uninstallation of an app.
+  # If you want to subscribe to any of the existing webhooks (`product.created`,
+  # `product.updated`, `order.created`, `order.updated`) apart from
+  # `app.uninstalled` on app installation process, add them like follows:
+  #
+  # To subscribe to a single webhook event:
+  # config.register_webhook_event('product.created')
+  #
+  # To subscribe to multiple webhook events:
+  # config.register_webhook_events(['product.created', 'product.updated'])
+
+  # Set a URL where webhooks will call on non-production environments. You can
+  # make use of https://webhook.site/.
+  # On production environments, the URL will be automatically generated.
+  config.webhook_site_url = nil
 end

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

@@ -42,6 +42,9 @@ module BeyondCanvas
       t.text :encrypted_beyond_refresh_token,    null: true
       t.text :encrypted_beyond_refresh_token_iv, null: true
 
+      t.text :encrypted_beyond_shared_secret,    null: true
+      t.text :encrypted_beyond_shared_secret_iv, null: true
+
 RUBY
       end
     end

data/lib/generators/beyond_canvas/webhook/templates/webhooks_controller.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class WebhooksController < BeyondCanvas::WebhooksController
+
+  private
+
+#   def handle_app_uninstalled(_data)
+#   end
+
+#   def handle_order_created(data)
+#   end
+
+#   def handle_order_updated(data)
+#   end
+
+#   def handle_product_created(data)
+#   end
+
+#   def handle_product_updated(data)
+#   end
+
+end

data/lib/generators/beyond_canvas/webhook/webhook_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module Generators
+    class WebhookGenerator < Rails::Generators::Base # :nodoc:
+      desc 'Creates an inherited Webhook controller in the app/controllers folder'
+
+      source_root File.expand_path('templates', __dir__)
+
+      def create_controller
+        template 'webhooks_controller.rb', "app/controllers/webhooks_controller.rb"
+      end
+    end
+  end
+end

data/lib/models/concerns/authentication.rb

@@ -40,15 +40,22 @@ module BeyondCanvas
           # 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)
+          def authenticate(code)
             session = BeyondApi::Session.new(api_url: beyond_api_url)
-            session.token.create(params_code)
+
+            if Rails.env.development? && BeyondCanvas.configuration.client_credentials
+              session.token.client_credentials
+            else
+              session.token.authorization_code(code)
+            end
+
             update(beyond_access_token: session.access_token,
                    beyond_refresh_token: session.refresh_token)
           end
 
           def authenticated?
-            beyond_access_token.present? && beyond_refresh_token.present?
+            beyond_access_token.present? &&
+              (Rails.env.development? && BeyondCanvas.configuration.client_credentials || beyond_refresh_token.present?)
           end
         end
       end

data/lib/models/concerns/utils.rb

@@ -30,7 +30,7 @@ module BeyondCanvas
           def refresh_token_if_needed
             token_timestamp = decoded_jwt['exp']
             current_timestamp = DateTime.now.to_i
-            return unless token_timestamp - current_timestamp <= 3600
+            return unless token_timestamp - current_timestamp <= 0
 
             refresh_token
           end

data/lib/models/concerns/webhook.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module Models
+    module Concerns
+      module Webhook # :nodoc:
+        extend ActiveSupport::Concern
+
+        included do
+          # Attribute accessor to generate webhook url
+          attr_accessor :http_host
+
+          ##############################################################################
+          # Encrypted attribute configuration
+          ##############################################################################
+
+          attr_encrypted :beyond_shared_secret, key: [BeyondCanvas.configuration.encryption_key].pack('H*')
+
+          ##############################################################################
+          # Validations
+          ##############################################################################
+
+          # Database fields
+
+          validates :beyond_shared_secret,
+                    presence: {
+                      unless: -> { encrypted_beyond_shared_secret_was.blank? }
+                    }
+
+          ##############################################################################
+          # Instance methods
+          ##############################################################################
+
+          #
+          # Subscribes to Beyond webhooks:
+          #   * Callback URI: {APP_URL}/shops/:id/beyond_webhook
+          #
+          def subscribe_to_beyond_webhooks
+            return if BeyondCanvas.configuration.webhook_events.to_a.empty?
+
+            # Unsubscribe from all existing Beyond webhooks
+            self.unsubscribe_from_all_beyond_webhooks
+            # Create and save a signer
+            self.create_signer
+            # Subscribe to webhooks
+            self.to_session.webhook_subscriptions.create(
+              callback_uri: beyond_webhook_url(self.id),
+              event_types: BeyondCanvas.configuration.webhook_events.to_a
+            )
+          end
+
+          #
+          # Unsubscribe from Beyond webhooks
+          #
+          def unsubscribe_from_all_beyond_webhooks
+            self.refresh_token_if_needed
+
+            session = self.to_session
+
+            session.webhook_subscriptions.all.dig(:embedded, :subscriptions)&.each do |webhook|
+              session.webhook_subscriptions.delete(webhook.dig(:id))
+            end
+          end
+
+          #
+          # Update suscription from Beyond webhooks
+          #
+          def update_suscription_of_beyond_webhooks(callback_uri = beyond_webhook_url(self.id))
+            self.refresh_token_if_needed
+
+            session = self.to_session
+
+            session.webhook_subscriptions.all.dig(:embedded, :subscriptions)&.each do |webhook|
+              session.webhook_subscriptions.update(webhook.dig(:id), callback_uri: callback_uri,
+                                                               event_types: BeyondCanvas.configuration.webhook_events.to_a)
+            end
+          end
+
+
+          private
+
+          #
+          # Deletes all existing signers and creates and stores a new one
+          #
+          def create_signer
+            # Get all existing signer ids
+            signer_ids = self.to_session.signers.all.dig(:embedded, :signers)&.map(&:id)
+            # Remove the first signer if max number of signers reached to allow to create a new one
+            self.to_session.signers.delete(signer_ids.slice!(0)) if signer_ids.count == 5
+
+            # Create and save the new signer
+            signer = self.to_session.signers.create
+            self.update(beyond_shared_secret: signer.shared_secret)
+            # Delete old signers
+            signer_ids&.each { |signer_id| self.to_session.signers.delete(signer_id) }
+          end
+
+          #
+          # Generates the Beyond webhook url for a given shop_id. If Rails.env is development, it uses the WEBHOOK_SITE_URL
+          # environment variable. In any other case, it uses the request.env['HTTP_HOST'], that should be
+          # {APP_URL}/shops/:id/beyond_webhook
+          #
+          def beyond_webhook_url(shop_id)
+            if Rails.env.development?
+              obtain_webhook_site_url
+            else
+              Rails.application.routes.url_helpers.beyond_webhook_shop_url(shop_id, host: http_host || ENV['HTTP_HOST'],
+                                                                                    protocol: 'https')
+            end
+          end
+
+          def obtain_webhook_site_url
+            if BeyondCanvas.configuration.webhook_site_url.blank?
+              raise 'Set BeyondCanvas.config.webhook_site_url environment variable for develpment'
+            end
+
+            BeyondCanvas.configuration.webhook_site_url
+          end
+        end
+      end
+    end
+  end
+end

data/lib/models/shop.rb

@@ -7,6 +7,7 @@ module BeyondCanvas
 
       include ::BeyondCanvas::Models::Concerns::Authentication
       include ::BeyondCanvas::Models::Concerns::Utils
+      include ::BeyondCanvas::Models::Concerns::Webhook
     end
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: beyond_canvas
 version: !ruby/object:Gem::Version
-  version: 0.22.0.pre
+  version: 0.23.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
 - Kathia Salazar
 - German San Emeterio
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attr_encrypted
@@ -30,30 +30,30 @@ dependencies:
   name: beyond_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 0.18.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 0.18.0.pre
 - !ruby/object:Gem::Dependency
   name: bourbon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -111,81 +111,95 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.4'
 - !ruby/object:Gem::Dependency
-  name: premailer-rails
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: sassc-rails
+  name: loaf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: sprockets
+  name: premailer-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
+        version: 5.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 5.1.7
 - !ruby/object:Gem::Dependency
-  name: loaf
+  name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: jwt
+  name: sprockets
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -215,10 +229,12 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/beyond_canvas_manifest.js
+- app/assets/images/icons/adblocker.svg
 - 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/external_link.svg
 - app/assets/images/icons/file.svg
 - app/assets/images/icons/flash_checkbox.svg
 - app/assets/images/icons/flash_close.svg
@@ -228,6 +244,9 @@ files:
 - app/assets/images/icons/home.svg
 - app/assets/images/icons/radiobutton_checked.svg
 - app/assets/images/icons/radiobutton_unchecked.svg
+- app/assets/images/icons/toggle.svg
+- app/assets/images/icons/toggle_checked.svg
+- app/assets/images/icons/toggle_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
@@ -236,7 +255,6 @@ files:
 - app/assets/stylesheets/beyond_canvas/components/_buttons.scss
 - app/assets/stylesheets/beyond_canvas/components/_cards.scss
 - app/assets/stylesheets/beyond_canvas/components/_collapse.scss
-- app/assets/stylesheets/beyond_canvas/components/_comments.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
@@ -256,20 +274,26 @@ files:
 - app/assets/stylesheets/beyond_canvas/components/_sidebar.scss
 - app/assets/stylesheets/beyond_canvas/components/_spinner.scss
 - app/assets/stylesheets/beyond_canvas/components/_statuses.scss
+- app/assets/stylesheets/beyond_canvas/components/_step_list.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/_base_variables.scss
 - app/assets/stylesheets/beyond_canvas/settings/_breakpoints.scss
+- app/assets/stylesheets/beyond_canvas/settings/_constant_variables.scss
+- app/assets/stylesheets/beyond_canvas/settings/_custom_variables.scss
 - app/assets/stylesheets/beyond_canvas/settings/_reset_css.scss
 - app/assets/stylesheets/beyond_canvas/settings/_typography.scss
-- app/assets/stylesheets/beyond_canvas/settings/_variables.scss
 - 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/beyond_canvas/webhooks_controller.rb
+- app/controllers/concerns/beyond_canvas/add_blocker_check.rb
 - app/controllers/concerns/beyond_canvas/authentication.rb
+- app/controllers/concerns/beyond_canvas/custom_styles.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
@@ -279,6 +303,7 @@ files:
 - app/helpers/beyond_canvas/cockpit_app_helper.rb
 - app/helpers/beyond_canvas/controller_helper.rb
 - app/helpers/beyond_canvas/debug_helper.rb
+- app/helpers/beyond_canvas/form_tag_helper.rb
 - app/helpers/beyond_canvas/locale_switch_helper.rb
 - app/helpers/beyond_canvas/statuses_helper.rb
 - app/javascript/beyond_canvas/base.js
@@ -300,15 +325,15 @@ files:
 - 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/constants.rb
 - config/initializers/beyond_canvas/filter_parameter_logging.rb
 - config/initializers/beyond_canvas/form_utils.rb
+- config/initializers/beyond_canvas/session_store.rb
 - config/locales/en.yml
-- config/routes.rb
 - lib/beyond_canvas.rb
 - lib/beyond_canvas/asset_registration.rb
 - lib/beyond_canvas/configuration.rb
@@ -317,6 +342,7 @@ files:
 - lib/beyond_canvas/parameter_sanitizer.rb
 - lib/beyond_canvas/rails/routes.rb
 - lib/beyond_canvas/version.rb
+- lib/beyond_canvas/webhook_event_registration.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
@@ -333,18 +359,21 @@ files:
 - 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/webhook/templates/webhooks_controller.rb
+- lib/generators/beyond_canvas/webhook/webhook_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/concerns/webhook.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
@@ -359,8 +388,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Open-source framework that provides CSS styles
 test_files: []