cats_core 1.0.4 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d2e957d3c24b295e163776c3ecd67c21e16877687a0c2f4682be641ea2278a5
-  data.tar.gz: 1230cf3469e3a2943cad4e91d229e5aefb110f84e459b741022e28d91b099c62
+  metadata.gz: 45dbf26292f9ebc98fb50e4195e44773184d3f460c0d5aadb3c45afcffffa752
+  data.tar.gz: 7cab2b31272ec765c42d8cd8724f1d8f3daff1481fd82057edf08ed40ce389b3
 SHA512:
-  metadata.gz: f0b8e1139d6a14e4afc0c49914b2d1cc1f9fe4e6e180410cb15368160f7705ab76665bb8805f37d538207f14d92126a20a70cc7ccbce1b6c4380025a15f06a30
-  data.tar.gz: 9e1dc4a4ecfd31ce032e64111a5d0d21f4c89a70e0732cfcba688e1e90804e2a9c8cea50ec8a602b7d73fed7d968117ea83c44a0538e436bc4584513823e0b61
+  metadata.gz: 6017835a41ce450bb778aea397234083ac257ec74b1f995a5087811dfae0db693172468ceed14c11ef8433dd26eca298436256ff8fc876a7482e8ce2610d46bb
+  data.tar.gz: 87ff5af9c3533a23b57ede84a3547818b7f54e51cfb629dbd8f3c26c6de73900f974c2ecb0bc38c999b01bdd29a0b7260daf4ec03510407fae8511d85ae372d3

data/app/controllers/cats/core/application_controller.rb

@@ -1,4 +1,30 @@
-module CatsCore
-  class ApplicationController < ActionController::Base
+module Cats
+  module Core
+    class ApplicationController < ActionController::Base
+      before_action :authenticate
+
+      def current_user
+        return if token.nil?
+
+        user = Cats::Core::User.find(auth['id'])
+        @current_user ||= user
+      end
+
+      def authenticate
+        render json: { error: 'Unauthorized' }, status: 401 if current_user.nil?
+      end
+
+      private
+
+      def token
+        return nil if request.env['HTTP_AUTHORIZATION'].nil?
+
+        request.env['HTTP_AUTHORIZATION'].scan(/Bearer (.*)$/).flatten.last
+      end
+
+      def auth
+        Cats::Core::TokenAuthService.decode(token)
+      end
+    end
   end
 end

data/app/controllers/cats/core/notifications_controller.rb

@@ -0,0 +1,37 @@
+module Cats
+  module Core
+    class NotificationsController < ApplicationController
+      before_action :set_notification, only: %i[mark_as_read mark_as_unread]
+      def index
+        data = Notification.messages(current_user.notifications.newest_first)
+        render json: { success: true, data: data }
+      end
+
+      def read
+        data = Notification.messages(current_user.notifications.read.newest_first)
+        render json: { success: true, data: data }
+      end
+
+      def unread
+        data = Notification.messages(current_user.notifications.unread.newest_first)
+        render json: { success: true, data: data }
+      end
+
+      def mark_as_read
+        @notification.mark_as_read!
+        render json: { success: true, data: @notification.message }
+      end
+
+      def mark_as_unread
+        @notification.mark_as_unread!
+        render json: { success: true, data: @notification.message }
+      end
+
+      private
+
+      def set_notification
+        @notification = Notification.find(params[:id])
+      end
+    end
+  end
+end

data/app/controllers/cats/core/roles_controller.rb

@@ -0,0 +1,18 @@
+module Cats
+  module Core
+    class RolesController < ApplicationController
+      before_action :set_role, only: [:users]
+
+      def users
+        data = ActiveModelSerializers::SerializableResource.new(@role.users)
+        render json: { success: true, data: data }
+      end
+
+      private
+
+      def set_role
+        @role = Role.find(params[:id])
+      end
+    end
+  end
+end

data/app/controllers/cats/core/users_controller.rb

@@ -0,0 +1,23 @@
+module Cats
+  module Core
+    class UsersController < ApplicationController
+      before_action :set_user, only: %i[stores warehouses]
+
+      def stores
+        data = ActiveModelSerializers::SerializableResource.new(@user.stores)
+        render json: { success: true, data: data }
+      end
+
+      def warehouses
+        data = ActiveModelSerializers::SerializableResource.new(@user.warehouses)
+        render json: { success: true, data: data }
+      end
+
+      private
+
+      def set_user
+        @user = User.find(params[:id])
+      end
+    end
+  end
+end

data/app/jobs/cats/core/application_job.rb

@@ -0,0 +1,6 @@
+module Cats
+  module Core
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/models/cats/core/commodity.rb

@@ -12,6 +12,7 @@ module Cats
       belongs_to :unit_of_measure
 
       validates :quantity, presence: true, numericality: { greater_than: 0 }
+      validates :volume_per_metric_ton, numericality: { greater_than: 0, allow_nil: true }
     end
   end
 end

data/app/models/cats/core/notification.rb

@@ -1,7 +1,17 @@
 module Cats
   module Core
     class Notification < ApplicationRecord
+      include Noticed::Model
+
       belongs_to :recipient, polymorphic: true
+
+      def message
+        { id: id, read: !read_at.nil? }.merge(to_notification.message)
+      end
+
+      def self.messages(notifications)
+        notifications.map(&:message)
+      end
     end
   end
 end

data/app/models/cats/core/receipt_plan.rb

@@ -0,0 +1,24 @@
+module Cats
+  module Core
+    class ReceiptPlan < ApplicationRecord
+      # receipt plan status
+      DRAFT = 'Draft'.freeze
+      ACCEPTED = 'Accepted'.freeze
+      DECLINED = 'Declined'.freeze
+      RECEIPT_PLAN_STATUSES = [DRAFT, ACCEPTED, DECLINED].freeze
+
+      validates :quantity, :status, presence: true
+      belongs_to :commodity
+      belongs_to :plan_recipient, polymorphic: true
+      validates :quantity, numericality: { greater_than: 0 }
+      validates :status, inclusion: { in: RECEIPT_PLAN_STATUSES }
+      validate :validate_reason_for_decline
+
+      def validate_reason_for_decline
+        return unless reason_for_decline.nil? || reason_for_decline == 'Accepted'
+
+        errors.add(:reason_for_decline, 'must be specified')
+      end
+    end
+  end
+end

data/app/models/cats/core/role.rb

@@ -2,6 +2,7 @@ module Cats
   module Core
     class Role < ApplicationRecord
       belongs_to :application_module
+      has_and_belongs_to_many :users, join_table: :cats_core_users_cats_core_roles
       has_many :role_menus
 
       validates :name, presence: true

data/app/models/cats/core/stack.rb

@@ -19,7 +19,8 @@ module Cats
       validates :quantity, numericality: { greater_than_or_equal_to: 0 }
       validates :commodity_status, inclusion: { in: Cats::Core::Commodity::COMMODITY_STATUSES }
       validates :stack_status, inclusion: { in: STACK_STATUSES }
-      validate :validate_coordinates, :validate_dimensions
+      validate :validate_coordinates, :validate_dimensions, :validate_distance_from_wall, :validate_overlap,
+               :validate_space_between_stack
 
       def validate_coordinates
         return unless store.present? && length.present? && width.present? && start_x.present? && start_y.present?
@@ -34,6 +35,70 @@ module Cats
         errors.add(:length, 'cannot exceed store length') if start_x + length > store.length
         errors.add(:width, 'cannot exceed store width') if start_y + width > store.width
       end
+
+      def stacking_rules
+        rule = Cats::Core::StackingRule.first
+
+        # If no rule is defined, then define a default rule
+        rule ||= Cats::Core::StackingRule.new(
+          space_between_stack: 1,
+          distance_from_gangway: 2,
+          distance_from_ceiling: 1,
+          maximum_height: 5,
+          maximum_length: 5,
+          maximum_width: 5,
+          distance_from_wall: 1
+        )
+        rule
+      end
+
+      def validate_distance_from_wall
+        return unless store.present? && length.present? && width.present? && start_x.present? && start_y.present?
+
+        rule = stacking_rules
+        if start_x < rule.distance_from_wall || store.length - (start_y + length) < rule.distance_from_wall ||
+           store.width - (start_x + width) < rule.distance_from_wall || start_y < rule.distance_from_wall
+          errors.add(:base,
+                     message: "The stack must be placed #{rule.distance_from_wall} meter away from a store wall")
+        end
+      end
+
+      def validate_overlap
+        return unless store.present? && length.present? && width.present? && start_x.present? && start_y.present?
+
+        stacks = store.stacks.where(stack_status: [RESERVED, ALLOCATED]).where.not(id: id)
+        stacks.each do |s|
+          errors.add(:base, message: "#{code} overlaps with #{s.code}") if overlaps?(self, s)
+        end
+      end
+
+      def validate_space_between_stack
+        return unless store.present? && length.present? && width.present? && start_x.present? && start_y.present?
+
+        stacks = store.stacks.where(stack_status: [RESERVED, ALLOCATED]).where.not(id: id)
+        rule = stacking_rules
+        new_stack = dup
+        new_stack.assign_attributes(start_x: start_x - rule.space_between_stack,
+                                    start_y: start_y - rule.space_between_stack,
+                                    length: length + (2 * rule.space_between_stack),
+                                    width: width + (2 * rule.space_between_stack))
+        stacks.each do |s|
+          errors.add(:base, message: "#{code} overlaps with #{s.code}") if overlaps?(new_stack, s)
+        end
+      end
+
+      # A method that checks if an overlap exists b/n two stacks.
+      # An overlap b/n stacks does not occur if one of the stacks is completely above the other stack or
+      # if one of the stacks is on the left side of the other stack.
+      # If both conditions fail, it means an overlap exists b/n the two stacks
+
+      def overlaps?(st1, st2)
+        return false if st1.start_x > (st2.start_x + st2.width) || st2.start_x > (st1.start_x + st1.width)
+
+        return false if st1.start_y > (st2.start_y + st2.length) || st2.start_y > (st1.start_y + st1.length)
+
+        true
+      end
     end
   end
 end

data/app/models/cats/core/stacking_rule.rb

@@ -0,0 +1,16 @@
+module Cats
+  module Core
+    class StackingRule < ApplicationRecord
+      validates :distance_from_wall, :space_between_stack, :distance_from_ceiling, :maximum_height, :maximum_length,
+                :maximum_width, :distance_from_gangway, presence: true, numericality: { greater_than: 0 }
+      validate :validate_only_a_record_exist
+
+      def validate_only_a_record_exist
+        return unless StackingRule.count > 1
+
+        errors.add(:base,
+                   'There is already a stacking rule entry. A new rule can not be added')
+      end
+    end
+  end
+end

data/app/models/cats/core/store.rb

@@ -3,6 +3,7 @@ module Cats
     class Store < ApplicationRecord
       belongs_to :warehouse, class_name: 'Cats::Core::Location'
       has_many :stacks
+      has_many :receipt_plans, as: :receivable
 
       validates :name, :store_keeper_name, :length, :width, :height, presence: true
       validates :length, :width, :height, numericality: { greater_than: 0 }

data/app/models/cats/core/user.rb

@@ -2,7 +2,7 @@ module Cats
   module Core
     class User < ApplicationRecord
       has_secure_password
-      rolify
+      rolify role_cname: 'Cats::Core::Role'
 
       belongs_to :application_module
       has_and_belongs_to_many :roles, join_table: :cats_core_users_cats_core_roles
@@ -11,6 +11,18 @@ module Cats
       validates :first_name, :last_name, :email, presence: true
       validates :password, length: { minimum: 6 }
       validates :email, uniqueness: true, format: { with: URI::MailTo::EMAIL_REGEXP }
+
+      def warehouses
+        return unless details.key?('warehouses')
+
+        Cats::Core::Location.where(id: details['warehouses'], location_type: Cats::Core::Location::WAREHOUSE)
+      end
+
+      def stores
+        return unless details.key?('stores')
+
+        Cats::Core::Store.where(id: details['stores'])
+      end
     end
   end
 end

data/app/notifications/cats/core/simple_notification.rb

@@ -0,0 +1,9 @@
+# This is a simple notification class which delivers a
+# message via database delivery method. It requires a
+# +msg+ parameter to instantiate, which represents the
+# text message to deliver.
+class SimpleNotification < Noticed::Base
+  deliver_by :database
+
+  param :msg
+end

data/app/services/cats/core/notification_service.rb

@@ -0,0 +1,45 @@
+module Cats
+  module Core
+    class NotificationService
+      NOTIFICATION_RULES = {
+        dispatch_plan: {
+          application: 'CATS-WH',
+          notification: 'DispatchPlanNotification',
+          params: [:way_bill],
+          recipients: [:warehouse_manager]
+        },
+        receipt_plan: {
+          application: 'CATS-WH',
+          notification: 'ReceiptPlanNotification',
+          params: [:receipt_plan],
+          recipients: [:store_keeper]
+        }
+      }.freeze
+
+      def initialize(code, params)
+        @code = code
+        @params = params
+      end
+
+      def notification_rules
+        NOTIFICATION_RULES
+      end
+
+      def create_notifier(rule)
+        clazz = rule[:notification].constantize
+        clazz.with(**@params)
+      end
+
+      def notify
+        rule = notification_rules[@code]
+        notifier = create_notifier(rule)
+        app_code = rule[:application]
+        roles = rule[:recipients]
+
+        users = Cats::Core::User.joins(:application_module)
+                                .where(application_module: { prefix: app_code }).with_all_roles(*roles)
+        notifier.deliver(users)
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -1,2 +1,22 @@
 Cats::Core::Engine.routes.draw do
+  get '/notifications/unread', controller: :notifications, action: :unread
+  get '/notifications/read', controller: :notifications, action: :read
+
+  resources :notifications, only: [:index] do
+    member do
+      post 'mark_as_read', controller: :notifications, action: :mark_as_read
+      post 'mark_as_unread', controller: :notifications, action: :mark_as_unread
+    end
+  end
+  resources :roles do
+    member do
+      get 'users', controller: :roles, action: :users
+    end
+  end
+  resources :users do
+    member do
+      get 'stores', controller: :users, action: :stores
+      get 'warehouses', controller: :users, action: :warehouses
+    end
+  end
 end

data/db/migrate/20210717033223_create_cats_core_commodities.rb

@@ -21,6 +21,7 @@ class CreateCatsCoreCommodities < ActiveRecord::Migration[6.1]
       t.string :description
       t.boolean :hazardous, null: false, default: false
       t.date :best_use_before
+      t.float :volume_per_metric_ton
 
       t.timestamps
     end

data/db/migrate/20210719133710_create_cats_core_stacking_rules.rb

@@ -0,0 +1,15 @@
+class CreateCatsCoreStackingRules < ActiveRecord::Migration[6.1]
+  def change
+    create_table :cats_core_stacking_rules do |t|
+      t.float :distance_from_wall, null: false
+      t.float :space_between_stack, null: false
+      t.float :distance_from_ceiling, null: false
+      t.float :maximum_height, null: false
+      t.float :maximum_length, null: false
+      t.float :maximum_width, null: false
+      t.float :distance_from_gangway, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210727074646_create_cats_core_receipt_plans.rb

@@ -0,0 +1,16 @@
+class CreateCatsCoreReceiptPlans < ActiveRecord::Migration[6.1]
+  def change
+    create_table :cats_core_receipt_plans do |t|
+      t.float :quantity, null: false
+      t.string :status, default: 'Draft'
+      t.references :commodity,
+        null: false,
+        index: { name: 'commodity_on_receipt_plan_indx' },
+        foreign_key: { to_table: :cats_core_commodities }
+      t.string :reason_for_decline
+      t.references :plan_recipient, polymorphic: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/cats/core/version.rb

@@ -1,5 +1,5 @@
 module Cats
   module Core
-    VERSION = '1.0.4'.freeze
+    VERSION = '1.0.8'.freeze
   end
 end

data/lib/cats_core.rb

@@ -3,3 +3,5 @@ require 'cats/core/engine'
 require 'ancestry'
 require 'rolify'
 require 'jwt'
+require 'noticed'
+require 'active_model_serializers'

data/spec/factories/cats/core/commodities.rb

@@ -8,5 +8,6 @@ FactoryBot.define do
     quantity { 100 }
     hazardous { false }
     best_use_before { Date.today + 2.month }
+    volume_per_metric_ton { 10 }
   end
 end

data/spec/factories/cats/core/notifications.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :notification, class: 'Cats::Core::Notification' do
     recipient factory: :user
-    type { nil }
+    type { 'ExampleNotification' }
     params { {} }
     read_at { Date.today }
   end

data/spec/factories/cats/core/receipt_plans.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :receipt_plan, class: 'Cats::Core::ReceiptPlan' do
+    plan_recipient factory: :store
+    commodity
+    quantity { 1.5 }
+    status { 'Accepted' }
+    reason_for_decline { FFaker::Name.name }
+  end
+end

data/spec/factories/cats/core/stacking_rules.rb

@@ -0,0 +1,11 @@
+FactoryBot.define do
+  factory :stacking_rule, class: 'Cats::Core::StackingRule' do
+    space_between_stack { 1 }
+    distance_from_gangway { 1.5 }
+    distance_from_ceiling { 1 }
+    maximum_height { 2.5 }
+    maximum_length { 6 }
+    maximum_width { 6 }
+    distance_from_wall { 1 }
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cats_core
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.8
 platform: ruby
 authors:
 - Henock L.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ancestry
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +217,10 @@ files:
 - README.md
 - Rakefile
 - app/controllers/cats/core/application_controller.rb
+- app/controllers/cats/core/notifications_controller.rb
+- app/controllers/cats/core/roles_controller.rb
+- app/controllers/cats/core/users_controller.rb
+- app/jobs/cats/core/application_job.rb
 - app/models/cats/core/application_module.rb
 - app/models/cats/core/application_record.rb
 - app/models/cats/core/commodity.rb
@@ -214,15 +232,19 @@ files:
 - app/models/cats/core/menu_item.rb
 - app/models/cats/core/notification.rb
 - app/models/cats/core/program.rb
+- app/models/cats/core/receipt_plan.rb
 - app/models/cats/core/role.rb
 - app/models/cats/core/role_menu.rb
 - app/models/cats/core/stack.rb
+- app/models/cats/core/stacking_rule.rb
 - app/models/cats/core/store.rb
 - app/models/cats/core/transporter.rb
 - app/models/cats/core/unit_of_measure.rb
 - app/models/cats/core/user.rb
 - app/models/cats/core/way_bill.rb
 - app/models/cats/core/way_bill_item.rb
+- app/notifications/cats/core/simple_notification.rb
+- app/services/cats/core/notification_service.rb
 - app/services/cats/core/token_auth_service.rb
 - config/routes.rb
 - db/migrate/20210715114238_create_cats_core_application_modules.rb
@@ -243,7 +265,9 @@ files:
 - db/migrate/20210718045516_create_cats_core_way_bills.rb
 - db/migrate/20210718050751_create_cats_core_way_bill_items.rb
 - db/migrate/20210718202957_create_cats_core_commodity_transactions.rb
+- db/migrate/20210719133710_create_cats_core_stacking_rules.rb
 - db/migrate/20210724074657_create_cats_core_notifications.rb
+- db/migrate/20210727074646_create_cats_core_receipt_plans.rb
 - lib/cats/core.rb
 - lib/cats/core/engine.rb
 - lib/cats/core/version.rb
@@ -259,8 +283,10 @@ files:
 - spec/factories/cats/core/menus.rb
 - spec/factories/cats/core/notifications.rb
 - spec/factories/cats/core/programs.rb
+- spec/factories/cats/core/receipt_plans.rb
 - spec/factories/cats/core/role_menus.rb
 - spec/factories/cats/core/roles.rb
+- spec/factories/cats/core/stacking_rules.rb
 - spec/factories/cats/core/stacks.rb
 - spec/factories/cats/core/stores.rb
 - spec/factories/cats/core/transporters.rb