integral 1.3.0 → 1.4.0

data/app/models/concerns/integral/lazy_contentable.rb

@@ -0,0 +1,54 @@
+# Adds lazy content behaviour to a model
+module Integral
+  # Enable lazy loading WYSIWYG content
+  module LazyContentable
+    extend ActiveSupport::Concern
+
+    included do
+      before_save :lazyload_content
+    end
+
+    # @return [String] body HTML ready for WYSIWYG editor
+    def editor_body
+      html = Nokogiri::HTML(body)
+
+      # Remove image lazyloading
+      html.css('img.lazyload').each do |element|
+        element.attributes['src'].value = element.attributes['data-src'].value
+      end
+
+      html.css('body').inner_html
+    end
+
+    private
+
+    def lazyload_content
+      html = Nokogiri::HTML(body)
+
+      # Add lazyloading to tagged images
+      html.css('img.lazyload').each do |element|
+        element['data-src'] = element.attributes['src'].value
+        element.attributes['src'].value = ''
+      end
+
+      # Add lazy loading to oEmbeds
+      html.css('div[data-oembed-url]').each do |element|
+        next if element.css('blockquote.lazyload').any?
+
+        blockquote = element.css('blockquote').first
+
+        next unless blockquote.present?
+
+        blockquote['class'] = "#{blockquote.attributes['class']} lazyload"
+
+        if element['data-oembed-url'].starts_with?('https://www.instagram.com')
+          blockquote['data-instagram'] = 'instagram'
+        elsif element['data-oembed-url'].starts_with?('https://twitter.com')
+          blockquote['data-twitter'] = 'twitter'
+        end
+      end
+
+      self.body = html.css('body').inner_html
+    end
+  end
+end

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/category.rb

@@ -0,0 +1,20 @@
+module Integral
+  # Represents a user post category
+  class Category < ApplicationRecord
+    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 }
+  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/list_item.rb

@@ -2,14 +2,13 @@ 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) },

data/app/models/integral/page.rb

@@ -1,6 +1,8 @@
 module Integral
   # Represents a public viewable page
   class Page < ApplicationRecord
+    include LazyContentable
+
     acts_as_paranoid # Soft-deletion
     acts_as_listable # Listable Item
 
@@ -12,9 +14,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 +33,13 @@ module Integral
     validate :validate_path_is_not_black_listed
     validate :validate_parent_is_available
 
+    # Callbacks
+    before_save :set_paper_trail_event
+
     # Scopes
     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
@@ -123,11 +130,18 @@ module Integral
 
     private
 
+    def set_paper_trail_event
+      if persisted? && published? && status_changed?
+        self.paper_trail_event = :publish
+      end
+    end
+
     # @return [Array] containing available human readable statuses against there numeric value
     def self.available_statuses
       [
         ['Draft', 0],
-        ['Published', 1]
+        ['Published', 1],
+        ['Archived', 2]
       ]
     end
 
@@ -142,6 +156,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,9 @@ module Integral
   # Represents a user post
   class Post < ApplicationRecord
     include ActionView::Helpers::DateHelper
+    include LazyContentable
+    include Webhook::Observable
+
     acts_as_paranoid # Soft-deletion
     acts_as_listable if Integral.blog_enabled? # Listable Item
     acts_as_taggable # Tagging
@@ -19,6 +22,7 @@ module Integral
 
     # Associations
     belongs_to :user
+    belongs_to :category
     belongs_to :image, class_name: 'Integral::Image', optional: true
     belongs_to :preview_image, class_name: 'Integral::Image', optional: true
 
@@ -29,7 +33,10 @@ 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
@@ -111,6 +118,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 +129,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 +164,13 @@ module Integral
       contexts.delete(tag_context)
       contexts
     end
+
+    def deliver_published_webhook_on_update
+      deliver_webhook(:published) if status_changed? && published?
+    end
+
+    def deliver_published_webhook_on_create
+      deliver_webhook(:published) if published?
+    end
   end
 end

data/app/models/integral/version.rb

@@ -10,7 +10,7 @@ module Integral
     def self.available_actions
       available = []
 
-      %w[update create destroy].each do |item|
+      %w[update create destroy publish].each do |item|
         available << [I18n.t("integral.actions.#{item}"), item]
       end
 
@@ -21,7 +21,7 @@ module Integral
     def self.available_objects
       available = []
 
-      [Integral::Post, Integral::Page, Integral::List, Integral::Image, Integral::User].each do |item|
+      [Integral::Post, Integral::Category, Integral::Page, Integral::List, Integral::Image, Integral::User].concat(Integral.additional_tracked_classes).each do |item|
         available << [item.model_name.human, item]
       end
 

data/app/models/integral/webhook/endpoint.rb

@@ -0,0 +1,40 @@
+module Integral
+  # Webhook Implementation - https://benediktdeicke.com/2017/09/sending-webhooks-with-rails/
+  module Webhook
+    # A Webhook::Endpoint can listen to one or more Webhook::Event, everytime an Event is created
+    # it is sent (along with its payload) to the Endpoint target_url
+    class Endpoint < ApplicationRecord
+      self.table_name = 'integral_webhook_endpoints'
+
+      attribute :events, :string, array: true, default: []
+
+      validates :target_url,
+                presence: true,
+                format: URI.regexp(%w[http https])
+
+      validates :events,
+                presence: true
+
+      # @param events [Array] list of Integral::Webhook::Event names
+      #
+      # @return [Integral::Webhook::Endpoint] endpoints which are listening for the provided events
+      def self.for_event(events)
+        where('events @> ARRAY[?]::varchar[]', Array(events))
+      end
+
+      # Override the default setter to normalise the events and validate them (TODO)
+      def events=(events)
+        events = Array(events).map { |event| event.to_s.underscore }
+        # TODO: Validate events from specified list in Integral.config which can be used to
+        # list them on the backend for click and create
+        # super(Webhook::Event::EVENT_TYPES & events)
+        super(events)
+      end
+
+      # Deliver a particular event to the endpoint
+      def deliver(event)
+        Webhook::DeliveryJob.perform_later(id, event.to_json)
+      end
+    end
+  end
+end

data/app/models/integral/webhook/event.rb

@@ -0,0 +1,20 @@
+module Integral
+  # Webhook Implementation source from - https://benediktdeicke.com/2017/09/sending-webhooks-with-rails/
+  module Webhook
+    # An event instance which a Webhook::Endpoint might be listening too, for example a post publication, creation or deletion
+    class Event
+      attr_reader :event_name, :payload
+
+      def initialize(event_name, payload = {})
+        @event_name = event_name
+        @payload = payload
+      end
+
+      # Adds the event_name to the JSON representation
+      def as_json(*_args)
+        payload[:event_name] = event_name
+        payload
+      end
+    end
+  end
+end

data/app/policies/integral/base_policy.rb

@@ -39,6 +39,7 @@ module Integral
 
     alias destroy? manager?
     alias index? manager?
+    alias list? manager?
     alias show? manager?
     alias new? manager?
     alias create? manager?

data/app/policies/integral/category_policy.rb

@@ -0,0 +1,9 @@
+module Integral
+  # Handles Category authorization
+  class CategoryPolicy < BasePolicy
+    # @return [Symbol] role name
+    def role_name
+      :post_manager
+    end
+  end
+end

data/app/serializers/integral/post_serializer.rb

@@ -0,0 +1,24 @@
+module Integral
+  # Used too transform Integral::Post records into JSON format
+  class PostSerializer
+    include FastJsonapi::ObjectSerializer
+
+    attributes :title, :description, :status, :slug, :created_at, :updated_at, :published_at, :url, :body
+
+    attribute :author do |post|
+      post.author&.name
+    end
+
+    attribute :tags do |post|
+      post.tags.map(&:name).join(',')
+    end
+
+    attribute :featured_image do |post|
+      post&.featured_image&.url(:large)
+    end
+
+    attribute :preview_image do |post|
+      post&.preview_image&.url(:large)
+    end
+  end
+end

data/app/uploaders/integral/avatar_uploader.rb

@@ -2,7 +2,7 @@ module Integral
   # Handles uploading user avatars
   class AvatarUploader < ImageUploader
     # Provide a default URL as a default if there hasn't been a file uploaded
-    def default_url
+    def default_url(*args)
       ActionController::Base.helpers.asset_path('integral/defaults/user_avatar.jpg')
     end
   end

data/app/views/integral/backend/activities/_activity.haml

@@ -0,0 +1,21 @@
+.timeline-item
+  .timeline-icon
+    = icon(activity.item_icon)
+  .timeline-content
+    .timeline-content-header
+      %p.timeline-content-event= activity.event
+      - if activity.whodunnit.present?
+        = link_to activity.whodunnit_url, class: 'timeline-content-user' do
+          = image_tag activity.whodunnit_avatar_url, class: :avatar
+          %span= activity.whodunnit_name.truncate(30)
+      - else
+        %p.timeline-content-user
+          = image_tag activity.whodunnit_avatar_url, class: :avatar
+          %span= activity.whodunnit_name.truncate(30)
+    %p.timeline-content-date= l(activity.created_at)
+    %p.timeline-content-title
+      = activity.whodunnit_name
+      = activity.event_verb.downcase
+      = link_to activity.item_title, activity.item_url
+    %hr
+