integral 1.0.1 → 1.5.0

data/app/models/concerns/integral/webhook/delivery.rb

@@ -0,0 +1,30 @@
+module Integral
+  module Webhook
+    # Helper to handle the delivery of webhook events
+    module Delivery
+      extend ActiveSupport::Concern
+
+      # Abstract method to be overriden
+      #
+      # @return [Hash] which repesents the object
+      def webhook_payload
+        {}
+      end
+
+      # Build event_name and delivery webhook
+      def deliver_webhook(action)
+        event_name = "#{self.class.name.underscore}_#{action}"
+        deliver_webhook_event(event_name, webhook_payload)
+      end
+
+      # Create webhook event and deliver it to any endpoint listening
+      def deliver_webhook_event(event_name, payload)
+        event = Webhook::Event.new(event_name, payload || {})
+
+        Endpoint.for_event(event_name).each do |endpoint|
+          endpoint.deliver(event)
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/integral/webhook/observable.rb

@@ -0,0 +1,23 @@
+module Integral
+  module Webhook
+    # Helper to deliver webhooks for each of the 3 major model lifestyle events - creation, update and deletion
+    module Observable
+      extend ActiveSupport::Concern
+      include Webhook::Delivery
+
+      included do
+        after_commit on: :create do
+          deliver_webhook(:created)
+        end
+
+        after_commit on: :update do
+          deliver_webhook(:updated)
+        end
+
+        after_commit on: :destroy do
+          deliver_webhook(:destroyed)
+        end
+      end
+    end
+  end
+end

data/app/models/integral/application_record.rb

@@ -2,5 +2,14 @@ module Integral
   # Base Integral Model.
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true
+
+    # @return [Array] containing available human readable statuses against there numeric value
+    def self.available_statuses(opts = { reverse: false })
+      available_statuses = statuses.map do |key, value|
+        [I18n.t("integral.statuses.#{key}"), key]
+      end
+
+      opts[:reverse] ? available_statuses.each(&:reverse!) : available_statuses
+    end
   end
 end

data/app/models/integral/category.rb

@@ -0,0 +1,29 @@
+module Integral
+  # Represents a user post category
+  class Category < ApplicationRecord
+    acts_as_integral({
+      backend_main_menu: { enabled: false },
+      backend_create_menu: { enabled: false }
+    })
+
+    has_paper_trail class_name: 'Integral::CategoryVersion'
+
+    # Slugging
+    extend FriendlyId
+    friendly_id :title
+
+    # Associations
+    has_many :posts # TODO: Touch the posts on change
+    belongs_to :image, class_name: 'Integral::Image', optional: true
+
+    # Validations
+    validates :slug, presence: true
+    validates_format_of :slug, with: /\A[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*\z/
+    validates :title, presence: true, length: { minimum: 4, maximum: 60 }
+    validates :description, presence: true, length: { minimum: 25, maximum: 300 }
+
+    def self.integral_icon
+      'tags'
+    end
+  end
+end

data/app/models/integral/category_version.rb

@@ -0,0 +1,8 @@
+# Integral namespace
+module Integral
+  # Record PaperTrail of Integral::Category
+  class CategoryVersion < Version
+    self.table_name = :integral_category_versions
+    self.sequence_name = :integral_category_versions_id_seq
+  end
+end

data/app/models/integral/image.rb

@@ -3,8 +3,12 @@ module Integral
   class Image < ApplicationRecord
     before_save :touch_list_items
 
-    # Soft-deletion
-    acts_as_paranoid
+    acts_as_integral({
+      notifications: { enabled: false },
+      backend_main_menu: { order: 40 },
+      backend_create_menu: { order: 30 }
+    }) # Integral Goodness
+    acts_as_paranoid # Soft-deletion
 
     validates :file, presence: true
     validates :title, presence: true, length: { minimum: 5, maximum: 50 }
@@ -45,11 +49,44 @@ module Integral
     def self.listable_options
       {
         record_title: I18n.t('integral.backend.record_selector.images.record'),
-        selector_path: Engine.routes.url_helpers.backend_images_path,
+        selector_path: Engine.routes.url_helpers.list_backend_images_path,
         selector_title: I18n.t('integral.backend.record_selector.images.title')
       }
     end
 
+    def self.integral_icon
+      'image'
+    end
+
+    def self.integral_backend_main_menu_item
+      {
+        icon: integral_icon,
+        order: integral_options.dig(:backend_main_menu, :order),
+        label: model_name.human.pluralize,
+        url: url_helpers.send("backend_img_index_url"),
+        authorize_class: self,
+        authorize_action: :index,
+        list_items: [
+          { label: I18n.t('integral.navigation.dashboard'), url: url_helpers.send("backend_img_index_url"), authorize_class: self, authorize_action: :index },
+          { label: I18n.t('integral.actions.create'), url: url_helpers.send("new_backend_img_url"), authorize_class: self, authorize_action: :new },
+          { label: I18n.t('integral.navigation.listing'), url: url_helpers.send("list_backend_img_index_url"), authorize_class: self, authorize_action: :list },
+        ]
+      }
+    end
+
+    # @return [Hash] hash representing the class, used to render within the create menu
+    def self.integral_backend_create_menu_item
+      {
+        icon: integral_icon,
+        order: integral_options.dig(:backend_create_menu, :order),
+        label: model_name.human,
+        url: url_helpers.send("new_backend_img_url"),
+        # authorize: proc { policy(self).index? }, can't use this as self is in wrong context
+        authorize_class: self,
+        authorize_action: :new,
+      }
+    end
+
     private
 
     def touch_list_items

data/app/models/integral/list.rb

@@ -3,8 +3,12 @@ module Integral
   class List < ApplicationRecord
     default_scope { includes(:list_items) }
 
-    # Soft-deletion
-    acts_as_paranoid
+    acts_as_integral({
+      backend_main_menu: { order: 50 },
+      backend_create_menu: { order: 40 }
+    }) # Integral Goodness
+
+    acts_as_paranoid # Soft-deletion
 
     # Associations
     has_many :list_items
@@ -30,9 +34,8 @@ module Integral
     # Duplicates the list including all attributes, list items and list item children
     #
     # @return [List] Unsaved cloned list
-    def dup(title = '')
+    def dup
       new_list = super()
-      new_list.title = title if title.present?
 
       list_items.each do |list_item|
         new_list_item = list_item.dup
@@ -49,6 +52,10 @@ module Integral
       new_list
     end
 
+    def self.integral_icon
+      'list'
+    end
+
     private
 
     def validate_unlocked

data/app/models/integral/list_item.rb

@@ -1,25 +1,17 @@
 module Integral
   # Represents an item within a particular list
   class ListItem < ApplicationRecord
-    after_initialize :set_defaults
-    before_save :touch_list
-    after_touch :touch_list
-
     # Default scope orders by priority and includes children
     default_scope { includes(:children).includes(:image).order(:priority) }
 
     # Associations
-    belongs_to :list, optional: true
+    belongs_to :list, optional: true, touch: true
     belongs_to :image, optional: true
-    has_and_belongs_to_many(:children,
-                            -> { order(:priority) },
-                            join_table: 'integral_list_item_connections',
-                            foreign_key: 'parent_id',
-                            association_foreign_key: 'child_id',
-                            class_name: 'ListItem',
-                            after_add: :touch_updated_at,
-                            after_remove: :touch_updated_at,
-                            optional: true)
+    has_many :list_item_connections, foreign_key: 'parent_id'
+    has_many :children, -> { order(:priority) }, through: :list_item_connections
+    has_many :inverse_list_item_connections, class_name: "ListItemConnection", foreign_key: "child_id"
+    # NOTE: A List Item only has one parent
+    has_many :parents, :through => :inverse_list_item_connections
 
     # Validations
     validate :validate_child_absence
@@ -27,6 +19,12 @@ module Integral
     # Nested forms
     accepts_nested_attributes_for :children, reject_if: :all_blank, allow_destroy: true
 
+    # Callbacks
+    after_initialize :set_defaults
+    after_commit :touch_parent, on: :update
+    after_destroy :touch_parent
+    after_touch :touch_list
+
     # @return [Array] list of types available for a list item
     def self.types_collection
       collection = [
@@ -70,8 +68,9 @@ module Integral
       self.type ||= 'Integral::Basic'
     end
 
-    def touch_updated_at(_list_item)
-      touch if persisted?
+    def touch_parent
+      parent = parents.first
+      parent.touch if parent.present? && parent.persisted?
     end
 
     def touch_list

data/app/models/integral/list_item_connection.rb

@@ -0,0 +1,6 @@
+module Integral
+  class ListItemConnection < ApplicationRecord
+    belongs_to :parent, touch: true, class_name: 'Integral::ListItem'
+    belongs_to :child, touch: true, class_name: 'Integral::ListItem', dependent: :destroy
+  end
+end

data/app/models/integral/notification/notification.rb

@@ -0,0 +1,28 @@
+module Integral
+  module Notification
+    class Notification < ApplicationRecord
+      belongs_to :recipient, class_name: "User"
+      belongs_to :actor, class_name: "User", optional: true
+      belongs_to :subscribable, polymorphic: true
+
+      scope :unread, ->{ where(read_at: nil) }
+      scope :recent, ->{ order(created_at: :desc).limit(per_page) }
+
+      self.per_page = 8
+
+      validates :action, presence: true
+
+      def read!
+        update!(read_at: Time.now())
+      end
+
+      def unread?
+        read_at.nil?
+      end
+
+      def to_partial_path
+        'integral/backend/notifications/notification'
+      end
+    end
+  end
+end

data/app/models/integral/notification/subscription.rb

@@ -0,0 +1,14 @@
+module Integral
+  module Notification
+    class Subscription < ApplicationRecord
+      self.table_name = 'integral_notification_subscriptions'
+
+      belongs_to :subscribable, polymorphic: true, optional: true
+      belongs_to :user
+
+      enum state: { subscribed: 'subscribed', unsubscribed: 'unsubscribed' }
+
+      validates :subscribable_type, :state, presence: true
+    end
+  end
+end

data/app/models/integral/page.rb

@@ -1,7 +1,14 @@
 module Integral
   # Represents a public viewable page
   class Page < ApplicationRecord
+    include LazyContentable
+
     acts_as_paranoid # Soft-deletion
+    acts_as_integral({
+      backend_main_menu: { order: 20 },
+      backend_create_menu: { order: 10 }
+    }) # Integral Goodness
+
     acts_as_listable # Listable Item
 
     has_paper_trail class_name: 'Integral::PageVersion'
@@ -12,9 +19,9 @@ module Integral
     # /foo, /foo/bar, /123/456
     # Bad:
     # //, foo, /foo bar, /foo?y=123, /foo$
-    PATH_REGEX = /\A\/[\/.a-zA-Z0-9-]+\z/
+    PATH_REGEX = %r{\A/[/.a-zA-Z0-9-]+\z}.freeze
 
-    enum status: %i[draft published]
+    enum status: %i[draft published archived]
 
     # Associations
     belongs_to :parent, class_name: 'Integral::Page', optional: true
@@ -31,8 +38,14 @@ module Integral
     validate :validate_path_is_not_black_listed
     validate :validate_parent_is_available
 
+    # Callbacks
+    before_save :set_paper_trail_event
+    before_save :set_integral_notification_action
+
     # Scopes
-    scope :search, ->(search) { where('lower(title) LIKE ?', "%#{search.downcase}%") }
+    scope :search, ->(query) { where('lower(title) LIKE ? OR lower(path) LIKE ?', "%#{query.downcase}%", "%#{query.downcase}%") }
+    # TODO: Remove this on Rails 6 upgrade
+    scope :not_archived, -> { where.not(status: :archived) }
 
     # Return all available parents
     # TODO: Update parent behaviour
@@ -64,11 +77,15 @@ module Integral
       {
         icon: 'file',
         record_title: I18n.t('integral.backend.record_selector.pages.record'),
-        selector_path: Engine.routes.url_helpers.backend_pages_path,
+        selector_path: Engine.routes.url_helpers.list_backend_pages_path,
         selector_title: I18n.t('integral.backend.record_selector.pages.title')
       }
     end
 
+    def self.integral_icon
+      'file'
+    end
+
     # @return [Hash] the instance as a card
     def to_card
       # subtitle = self.published_at.present? ? I18n.t('integral.blog.posted_ago', time: time_ago_in_words(self.published_at)) : I18n.t('integral.records.status.draft')
@@ -123,12 +140,16 @@ module Integral
 
     private
 
-    # @return [Array] containing available human readable statuses against there numeric value
-    def self.available_statuses
-      [
-        ['Draft', 0],
-        ['Published', 1]
-      ]
+    def set_paper_trail_event
+      if persisted? && published? && status_changed?
+        self.paper_trail_event = :publish
+      end
+    end
+
+    def set_integral_notification_action
+      if persisted? && published? && status_changed?
+        self.integral_notification_action = :publish
+      end
     end
 
     def validate_parent_is_available
@@ -142,6 +163,7 @@ module Integral
 
       Integral.black_listed_paths.each do |black_listed_path|
         next unless path&.starts_with?(black_listed_path)
+
         valid = false
         errors.add(:path, 'Invalid path')
         break

data/app/models/integral/post.rb

@@ -2,6 +2,13 @@ module Integral
   # Represents a user post
   class Post < ApplicationRecord
     include ActionView::Helpers::DateHelper
+    include LazyContentable
+    include Webhook::Observable
+
+    acts_as_integral({
+      backend_main_menu: { order: 30, enabled: Integral.blog_enabled? },
+      backend_create_menu: { order: 20, enabled: Integral.blog_enabled? }
+    }) # Integral Goodness
     acts_as_paranoid # Soft-deletion
     acts_as_listable if Integral.blog_enabled? # Listable Item
     acts_as_taggable # Tagging
@@ -18,7 +25,8 @@ module Integral
     self.per_page = 8 if respond_to? :per_page
 
     # Associations
-    belongs_to :user
+    belongs_to :user, -> { with_deleted }
+    belongs_to :category
     belongs_to :image, class_name: 'Integral::Image', optional: true
     belongs_to :preview_image, class_name: 'Integral::Image', optional: true
 
@@ -29,24 +37,17 @@ module Integral
 
     # Callbacks
     before_save :set_published_at
+    before_save :set_paper_trail_event
     before_save :set_tags_context
+    after_update :deliver_published_webhook_on_update
+    after_create :deliver_published_webhook_on_create
 
     # Aliases
     alias author user
     alias featured_image image
 
     # Scopes
-    scope :search, ->(query) { where('lower(title) LIKE ?', "%#{query.downcase}%") }
-
-    # @return [Array] containing available human readable statuses against there numeric value
-    def self.available_statuses(opts = { reverse: false })
-      statuses = [
-        [I18n.t('integral.records.status.draft'), 0],
-        [I18n.t('integral.records.status.published'), 1]
-      ]
-
-      opts[:reverse] ? statuses.each(&:reverse!) : statuses
-    end
+    scope :search, ->(query) { where('lower(title) LIKE ? OR lower(slug) LIKE ?', "%#{query.downcase}%", "%#{query.downcase}%") }
 
     # Increments the view count of the post if a PostViewing is successfully added
     #
@@ -94,11 +95,15 @@ module Integral
       {
         icon: 'rss',
         record_title: I18n.t('integral.backend.record_selector.posts.record'),
-        selector_path: Engine.routes.url_helpers.backend_posts_path,
+        selector_path: Engine.routes.url_helpers.list_backend_posts_path,
         selector_title: I18n.t('integral.backend.record_selector.posts.title')
       }
     end
 
+    def self.integral_icon
+      'rss'
+    end
+
     # @return [String] Current tag context
     def tag_context
       status
@@ -111,6 +116,10 @@ module Integral
 
     private
 
+    def webhook_payload
+      Integral::PostSerializer.new(self).serializable_hash
+    end
+
     def set_slug
       if slug_changed? && Post.exists_by_friendly_id?(slug)
         self.slug = resolve_friendly_id_conflict([slug])
@@ -118,7 +127,15 @@ module Integral
     end
 
     def set_published_at
-      self.published_at = Time.now if published? && published_at.nil?
+      if published? && published_at.nil?
+        self.published_at = Time.now
+      end
+    end
+
+    def set_paper_trail_event
+      if persisted? && published? && status_changed?
+        self.paper_trail_event = :publish
+      end
     end
 
     # Set the context of tags so that draft and archived tags are not displayed publicly
@@ -145,5 +162,13 @@ module Integral
       contexts.delete(tag_context)
       contexts
     end
+
+    def deliver_published_webhook_on_update
+      deliver_webhook(:published) if saved_change_to_status? && published?
+    end
+
+    def deliver_published_webhook_on_create
+      deliver_webhook(:published) if published?
+    end
   end
 end