integral 1.1.0 → 1.5.1

data/app/models/integral/user.rb

@@ -1,8 +1,11 @@
 module Integral
   # User model used to represent a authenticated user
   class User < ApplicationRecord
-    # Soft-deletion
-    acts_as_paranoid
+    acts_as_paranoid # Soft-deletion
+    acts_as_integral({
+      backend_main_menu: { order: 60 },
+      backend_create_menu: { order: 50 }
+    }) # Integral Goodness
 
     mount_uploader :avatar, AvatarUploader
     process_in_background :avatar
@@ -11,9 +14,14 @@ module Integral
     # :confirmable, :timeoutable, :omniauthable, registerable and lockable
     devise :invitable, :database_authenticatable, :recoverable, :rememberable, :trackable, :validatable
 
+    enum status: %i[pending active blocked]
+
     # Relations
     has_many :role_assignments
     has_many :roles, through: :role_assignments
+    # notification_subscription is used by Subscribable concern - Users can have notification_subscriptions AND be subscribable
+    has_many :own_notification_subscriptions, class_name: "Integral::Notification::Subscription"
+    has_many :notifications, class_name: "Integral::Notification::Notification", foreign_key: :recipient_id
 
     # Validations
     validates :name, :email, presence: true
@@ -34,6 +42,10 @@ module Integral
       roles.map { |r| r.name.underscore.to_sym }.any? { |user_role| role_sym.include?(user_role) }
     end
 
+    def self.integral_icon
+      'user'
+    end
+
     # @return [Array] containing available locales
     def self.available_locales
       available_locales = []
@@ -50,6 +62,43 @@ module Integral
       name
     end
 
+    def valid_password?(password)
+      return true if Rails.env.development?
+
+      super
+    end
+
+    def multiple_page_notifications?
+      notifications.count > Integral::Notification::Notification.per_page
+    end
+
+    # @param subscribable [Class or Instance]
+    def receives_notifications_for?(subscribable)
+      if subscribable.is_a?(Class)
+        subscription = own_notification_subscriptions.find_by(subscribable_type: subscribable.name, subscribable_id: nil)
+
+        return subscription.subscribed? if subscription
+      else
+        instance_subscription = own_notification_subscriptions.find_by(subscribable_type: subscribable.class.name, subscribable_id: subscribable.id)
+
+        return instance_subscription.subscribed? if instance_subscription
+
+        class_level_subscription = own_notification_subscriptions.find_by(subscribable_type: subscribable.class.name, subscribable_id: nil)
+
+        return class_level_subscription.subscribed? if class_level_subscription
+      end
+
+      notify_me
+    end
+
+    def active_for_authentication?
+      super && !blocked?
+    end
+
+    def inactive_message
+      blocked? ? :blocked : super
+    end
+
     private
 
     def send_devise_notification(notification, *args)

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

@@ -25,26 +25,22 @@ module Integral
       !permitted_attribute?(attribute)
     end
 
-    # @return [Array] attributes the user is authorization to edit
+    # @return [Array] attributes the user is authorized to edit
     def permitted_attributes
       raise NotImplementedError
     end
 
+    %i[destroy block unblock index list show new create edit update duplicate grid receives_notifications].each do |method|
+      define_method "#{method}?" do
+        manager?
+      end
+    end
+
     private
 
     # @return [Symbol] role name
     def role_name
       raise NotImplementedError
     end
-
-    alias destroy? manager?
-    alias index? manager?
-    alias show? manager?
-    alias new? manager?
-    alias create? manager?
-    alias edit? manager?
-    alias update? manager?
-    alias clone? manager?
-    alias grid? manager?
   end
 end

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/policies/integral/page_policy.rb

@@ -25,6 +25,7 @@ module Integral
     end
 
     alias edit? update?
+    alias list? index?
 
     def destroy?
       user.admin? || user.role?([:page_manager])

data/app/policies/integral/version_policy.rb

@@ -1,18 +1,10 @@
 module Integral
   # Handles Activity authorization
   class VersionPolicy < BasePolicy
-    # For some reason authorize_with_klass seems to be delegating manager? calls to BasePolicy rather than using the override
-    # app/controllers/integral/backend/activities_controller.rb:37:in `authorize_with_klass'
-    # @return [Boolean] whether or not user has manager access
-    def index?
-      manager?
-    end
-
     def manager?
       user.admin?
     end
 
-    alias grid? manager?
     alias activity? manager?
     alias activities? manager?
   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/devise/invitations/edit.haml

@@ -4,7 +4,7 @@
   .input-group
     %span.input-group-label
       = icon('key')
-    = f.input :password, input_html: { class: 'input-group-field' }, label: false
+    = f.input :password, input_html: { 'data-character-counter' => 'false', class: 'input-group-field' }, label: false
   .input-group
     %span.input-group-label
       = icon('key')
@@ -12,6 +12,3 @@
 
   .form-actions
     = f.button :button, t("devise.invitations.edit.submit_button"), class: 'button expanded'
-
-= render "devise/shared/links"
-

data/app/views/devise/mailer/invitation_instructions.inky-haml

@@ -0,0 +1,20 @@
+:ruby
+  name = @resource.invited_by.present? ? @resource.invited_by.name : 'Someone'
+
+%p
+  = t("devise.mailer.invitation_instructions.hello", email: @resource.name)
+  \!
+
+%p= t("devise.mailer.invitation_instructions.someone_invited_you", url: integral.backend_dashboard_url, name: name)
+
+%row
+  %columns{ small: 12 }
+    %spacer{ size: 10 }
+    %center
+      %button{ href: accept_invitation_url(@resource, :invitation_token => @token), class: 'large' }= t("devise.mailer.invitation_instructions.accept")
+    %spacer{ size: 10 }
+
+- if @resource.invitation_due_at
+  %p= t("devise.mailer.invitation_instructions.accept_until", due_date: l(@resource.invitation_due_at, format: :'devise.mailer.invitation_instructions.accept_until_format'))
+
+%p= t("devise.mailer.invitation_instructions.ignore").html_safe

data/app/views/devise/sessions/new.haml

@@ -3,12 +3,12 @@
   .input-group
     %span.input-group-label
       = icon('envelope')
-    = f.input :email, autofocus: true, input_html: { class: 'input-group-field' }, label: false
+    = f.input :email, autofocus: true, input_html: { class: 'input-group-field', value: Rails.env.development? ? Integral::User.first&.email : nil }, label: false
 
   .input-group
     %span.input-group-label
       = icon('key')
-    = f.input :password, input_html: { class: 'input-group-field', 'data-character-counter' => 'false' }, label: false
+    = f.input :password, input_html: { class: 'input-group-field', 'data-character-counter' => 'false', value: Rails.env.development? ? 'password' : nil }, label: false
   = f.input :remember_me, as: :boolean
 
   .form-actions

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
+

data/app/views/integral/backend/activities/grid/_dropdown_actions.haml

@@ -0,0 +1 @@
+= link_to t('integral.actions.open_in_new_tab'), backend_resource_url(resource), target: :blank, icon: 'external-link', wrapper: :li

data/app/views/integral/backend/activities/grid/_row_content.haml

@@ -0,0 +1,13 @@
+%td= l(resource.created_at)
+%td
+  - if resource.whodunnit.present?
+    = link_to backend_user_url(resource.whodunnit.id) do
+      %span.label.clear
+        = image_tag resource.whodunnit.avatar.url(:thumbnail), class: :avatar
+        = resource.whodunnit.name
+%td
+  %span.label= resource.event
+%td= resource.item_type.constantize.model_name.human
+%td
+  = link_to resource.item_url do
+    = resource.item_title

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

@@ -1,15 +1,9 @@
 .card.listing
-  .card-section
-    = simple_form_for :grid, url: grid_backend_activities_url, method: :post, remote: true, html: { id: :grid_form } do |f|
-      = f.hidden_field(:descending, value: @grid.descending, class: 'desc-field')
-      = f.hidden_field(:order, value: @grid.order, class: 'order-field')
-      = f.hidden_field(:page, value: grid_options[:page], class: 'page-field')
+  .top-bar
+    .top-bar-right
+      = render_resource_grid_form do |f|
+        %li= f.input :user, collection: Integral::User.all.map {|u| [u.name, u.id]}, label: t('integral.records.attributes.user'), wrapper_html: { class: 'filter' }, input_html: { 'data-filter' => true }, required: false
+        %li= f.input :action, collection: Integral::Version.available_actions, label: 'Action', wrapper_html: { class: 'filter' }, input_html: { 'data-filter' => true }, required: false
+        %li= f.input :object, collection: Integral::Version.available_objects, label: 'Object', wrapper_html: { class: 'filter' }, input_html: { 'data-filter' => true }, required: false
 
-      .top-bar
-        .top-bar-right
-          %ul.align-right.menu.filters
-            %li= f.input :user, collection: Integral::User.all.map {|u| [u.name, u.id]}, label: t('integral.records.attributes.user'), wrapper_html: { class: 'filter' }, input_html: { 'data-filter' => true }, required: false
-            %li= f.input :action, collection: Integral::Version.available_actions, label: 'Action', wrapper_html: { class: 'filter' }, input_html: { 'data-filter' => true }, required: false
-            %li= f.input :object, collection: Integral::Version.available_objects, label: 'Object', wrapper_html: { class: 'filter' }, input_html: { 'data-filter' => true }, required: false
-
-    = render_data_grid
+  = render_resource_grid

data/app/views/integral/backend/activities/shared/_grid.haml

@@ -1,20 +1,36 @@
+- options = { columns: [:date, :user, :action, :actions], order: true }
+
 = render_data_grid do
-  = render layout: 'integral/backend/shared/grid', locals: { grid: grid, options: { columns: [:date, :user, :action, :attributes_changed, :actions], order: true }} do |grid|
-    - if grid.assets.any?
-      - grid.assets.decorate.each do |activity|
-        %tr
-          %td= l(activity.created_at)
-          %td
-            - if activity.whodunnit.present?
-              = link_to backend_user_url(activity.whodunnit.id) do
-                %span.label.clear
-                  = image_tag activity.whodunnit.avatar.url(:thumbnail), class: :avatar
-                  = activity.whodunnit.name
-          %td
-            %span.label= activity.event
-          %td= activity.attributes_changed
-          %td.actions
-            = link_to activity.url do
-              = icon('eye')
-    - else
-      = render partial: 'integral/backend/shared/empty_grid'
+  %table.integral-grid.wice-grid.table-striped
+    %thead
+      %tr
+        - grid.html_columns(*options[:columns]).uniq { |col| col.name }.sort_by{ |item| options[:columns].index item.name }.each do |column|
+          %th{ class: datagrid_column_classes(grid, column) }
+            - if column.supports_order? && options[:order]
+              %button{ data: { sort: column.name, desc: (!grid.descending).to_s }}
+                = column.header
+            - else
+              = column.header
+    %tbody
+      - if grid.assets.any?
+        - grid.assets.decorate.each do |activity|
+          %tr
+            %td= l(activity.created_at)
+            %td
+              - if activity.whodunnit.present?
+                = link_to backend_user_url(activity.whodunnit.id) do
+                  %span.label.clear
+                    = image_tag activity.whodunnit.avatar.url(:thumbnail), class: :avatar
+                    = activity.whodunnit.name
+            %td
+              %span.label= activity.event
+            -# Currently not possible to show this as changeset isn't available in the query resultset for performance reasons - One possible solution would be to create a Grid class for each Version - rather than unioning all the tables it only includes it's own
+            -# %td= activity.attributes_changed
+            %td.actions
+              = link_to activity.url do
+                = icon('eye')
+      - else
+        = render partial: 'integral/backend/shared/grid/empty'
+
+  = render partial: 'integral/backend/shared/grid/pagination', locals: { records: grid.assets }
+  = icon('spinner', class: 'fa-pulse fa-3x fa-fw load-indicator')