beyond_canvas 0.19.2.pre → 0.23.0.pre

data/lib/beyond_canvas/configuration.rb

@@ -3,26 +3,30 @@
 module BeyondCanvas
   class Configuration # :nodoc:
     attr_accessor :site_title, :site_logo, :favicon, :skip_webpacker, :encryption_key, :namespace, :cockpit_app,
-                  :open_app_url, :preinstalled, :debug_mode
+                  :open_app_url, :preinstalled, :debug_mode, :webhook_site_url, :email_logo, :client_credentials
 
     include AssetRegistration
     include MenuItemRegistration
+    include WebhookEventRegistration
 
     def initialize
       @cockpit_app = false
       @debug_mode = false
+      @client_credentials = false
       @encryption_key = nil
       @favicon = nil
       @namespace = '/'
       @open_app_url = nil
       @preinstalled = false
       @site_logo = nil
+      @email_logo = nil
       @site_title = ::Rails.application.class.name.split('::').first.humanize
       @skip_webpacker = false
     end
 
     def setup!
       register_default_assets
+      register_default_webhook_events
     end
 
     private
@@ -31,5 +35,9 @@ module BeyondCanvas
       register_stylesheet 'beyond_canvas.css', media: 'screen'
       register_javascript 'beyond_canvas.js'
     end
+
+    def register_default_webhook_events
+      register_webhook_event('app.uninstalled')
+    end
   end
 end

data/lib/beyond_canvas/engine.rb

@@ -21,6 +21,7 @@ module BeyondCanvas
       ActiveSupport.on_load :action_controller do
         include ::BeyondCanvas::LocaleManagement
         include ::BeyondCanvas::RequestValidation
+        include ::BeyondCanvas::CustomStyles
         include ::BeyondCanvas::StatusCodes
         include ::BeyondCanvas::AuthenticationsHelper
         include ::BeyondCanvas::DebugHelper
@@ -29,5 +30,11 @@ module BeyondCanvas
         ::ActionController::Base.helper BeyondCanvas::Engine.helpers
       end
     end
+
+    config.after_initialize do
+      ActiveSupport.on_load :action_controller do
+        include ::BeyondCanvas::AddBlockerCheck
+      end
+    end
   end
 end

data/lib/beyond_canvas/rails/routes.rb

@@ -3,18 +3,38 @@
 module ActionDispatch
   module Routing
     class Mapper # :nodoc:
-      def beyond_canvas_routes(options = nil)
-        mount BeyondCanvas::Engine => BeyondCanvas.configuration.namespace
+      def beyond_canvas_routes(*resources)
+        scope BeyondCanvas.configuration.namespace do
+          put 'locale', to: 'beyond_canvas/system#update_locale', as: :update_locale
+        end
+
+        resources = resources.extract_options!
+
+        beyond_canvas_for_controllers(resources[:controllers] || {})
+      end
 
-        BeyondCanvas.use_rails_app_controller = options.present? && options[:custom_controller].present?
+      protected
 
-        set_routes if BeyondCanvas.use_rails_app_controller
+      def beyond_canvas_for_controllers(controllers)
+        [:authentications, :webhooks].each do |method|
+          controllers.key?(method) ? send("set_#{method}_routes", controllers[method]) : send("set_#{method}_routes")
+        end
+      end
+
+      def set_webhooks_routes(controller = 'beyond_canvas/webhooks')
+        scope BeyondCanvas.configuration.namespace do
+          resources :shops, only: [] do
+            member do
+              post :beyond_webhook, controller: controller, action: :webhook
+            end
+          end
+        end
       end
 
-      def set_routes
+      def set_authentications_routes(controller = 'beyond_canvas/authentications')
         scope BeyondCanvas.configuration.namespace do
-          get  'callback', controller: :authentications, action: :new
-          post 'callback', controller: :authentications, action: :install
+          get  'callback', controller: controller, action: :new
+          post 'callback', controller: controller, action: :install
         end
       end
     end

data/lib/beyond_canvas/version.rb

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

data/lib/beyond_canvas/webhook_event_registration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BeyondCanvas
+  module WebhookEventRegistration # :nodoc:
+    def register_webhook_event(event)
+      event.is_a?(Array) ? webhook_events.merge(event) : webhook_events.add(event)
+    end
+
+    def webhook_events
+      @webhook_events ||= Set.new
+    end
+
+    def clear_webhook_events!
+      webhook_events.clear
+    end
+
+    alias register_webhook_events register_webhook_event
+  end
+end

data/lib/beyond_canvas.rb

@@ -16,10 +16,11 @@ require 'beyond_api'
 require 'attr_encrypted'
 
 module BeyondCanvas # :nodoc:
-  autoload :AssetRegistration,    'beyond_canvas/asset_registration'
-  autoload :Configuration,        'beyond_canvas/configuration'
-  autoload :MenuItemRegistration, 'beyond_canvas/menu_item_registration'
-  autoload :ParameterSanitizer,   'beyond_canvas/parameter_sanitizer'
+  autoload :AssetRegistration,        'beyond_canvas/asset_registration'
+  autoload :Configuration,            'beyond_canvas/configuration'
+  autoload :MenuItemRegistration,     'beyond_canvas/menu_item_registration'
+  autoload :ParameterSanitizer,       'beyond_canvas/parameter_sanitizer'
+  autoload :WebhookEventRegistration, 'beyond_canvas/webhook_event_registration'
 
   module Models # :nodoc:
     autoload :Shop, 'models/shop'
@@ -27,6 +28,7 @@ module BeyondCanvas # :nodoc:
     module Concerns
       autoload :Authentication, 'models/concerns/authentication'
       autoload :Utils,          'models/concerns/utils'
+      autoload :Webhook,        'models/concerns/webhook'
     end
   end
 

data/lib/generators/beyond_canvas/custom_styles/templates/beyond_canvas_custom_styles.scss

@@ -47,6 +47,10 @@
 // $button-danger-background: $palette-danger;
 // $button-danger-color: $white;
 
+// $button-disabled-background: rgb(208,208,208);
+// $button-disabled-color: rgb(144,144,144);
+// $button-disabled-text-shadow: 1px 1px 0 $white;
+
 // $button-border-radius: 3px;
 // $button-box-shadow: true;
 
@@ -77,6 +81,8 @@
 // $input-border-color: rgb(217, 216, 195);
 // $input-border-color-focus: $palette-primary;
 // $input-errors-color: $palette-danger;
+// $input-disabled-background: rgb(245,244,239);
+// $input-disabled-color: rgb(163,161,137);
 
 // ************************************************************
 // Checkboxes
@@ -148,6 +154,19 @@
 // $notice-border-radius: 4px;
 // $notice-color: rgb(153, 153, 153);
 
+// ************************************************************
+// Status
+// ************************************************************
+
+// $status-good-background: rgb(205,225,165);
+// $status-good-color: rgb(85,110,41);
+// $status-warning-background: rgb(249,220,166);
+// $status-warning-color: rgb(178,120,18);
+// $status-danger-background: rgb(247,174,163);
+// $status-danger-color: rgb(164,35,34);
+// $status-neutral-background: rgb(224,223,205);
+// $status-neutral-color: rgb(155,151,100);
+
 // ************************************************************
 // Breadcrums
 // ************************************************************
@@ -197,3 +216,17 @@
 
 // $modal-close-icon-color: #8b8b8b;
 // $modal-background-color: rgba(0, 0, 0, 0.5);
+
+// ************************************************************
+// Select2
+// ************************************************************
+
+// $select2-border-color: $input-border-color;
+// $select2-border-color-focus: $input-border-color-focus;
+// $select2-close-icon-color: #79764b;
+// $select2-close-icon-color-hover: darken($select2-close-icon-color, 15%);
+// $select2-tag-background: rgb(223, 222, 204);
+// $select2-tag-color: rgb(122, 118, 76);
+// $select2-disabled-background: rgb(245, 244, 239);
+// $select2-option-hover-background: rgb(229, 241, 240);
+// $select2-option-hover-color: rgb(62, 62, 62);

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
@@ -40,15 +40,16 @@ module BeyondCanvas
           #
           def to_session
             BeyondApi::Session.new(api_url: beyond_api_url,
-                                    access_token: beyond_access_token,
-                                    refresh_token: beyond_refresh_token)
+                                   access_token: beyond_access_token,
+                                   refresh_token: beyond_refresh_token)
           end
 
           #
           # Returns the shop url
           #
-          def url
-            "https://#{URI.parse(beyond_api_url).host}"
+          def url(path = nil, params = nil)
+            path = path[1..-1] if path&.chr == '/'
+            "https://#{URI.parse(beyond_api_url).host}/#{path}#{'?' +params&.to_query if params.present?}"
           end
 
           def has_scope?(scope)

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