comee_core 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75efe50766a9b07ed19c73cf8102bc7b17dcd21d6b7936e1fc6df6f130e96ff2
+  data.tar.gz: bcc9e495cde736a992355c3e17b5f1fa6c1f1ce04bd56ca0c6f87f95a85966df
+SHA512:
+  metadata.gz: e569094649d5a95f37c524620e5f54faee56d2a9751b29cf8e49b5f9fc43b30c37e767e67f49f065b0075c77a5d4a5ade1b5c08dc2951a4d4f54a6ea79e651f8
+  data.tar.gz: b930dc71cd29633746849fe94d2bd40163b36359215ecfe9d162d0d785a96320f5dd727bcfe5cf6eea9795ed27b389cacc67adb9dc36036ce721ca6244860e48

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Henock L.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# ComeeCore
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "comee_core"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install comee_core
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(spec: "app:db:test:prepare")

data/app/controllers/comee/core/access_controller.rb

@@ -0,0 +1,33 @@
+module Comee
+  module Core
+    class AccessController < ApplicationController
+      skip_before_action :authenticate, only: [:login]
+
+      def login
+        user = User.find_by(email: auth_params[:email])
+        if user
+          if user.authenticate(auth_params[:password])
+            payload = {
+              id: user.id,
+              name: user.name,
+              email: user.email,
+              user_type: user.user_type
+            }
+            jwt = TokenService.issue(payload)
+            render json: {token: jwt, user: payload}
+          else
+            render json: {error: "Invalid password."}, status: 400
+          end
+        else
+          render json: {error: "User does not exist."}, status: 400
+        end
+      end
+
+      private
+
+      def auth_params
+        params.require(:auth).permit(:email, :password)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Comee
+  module Core
+    class ApplicationController < ActionController::API
+      before_action :authenticate
+
+      def current_user
+        return if token.nil?
+
+        user = User.find(auth["id"])
+        @current_user ||= user
+      end
+
+      def authenticate
+        render json: {error: "Unauthorized"}, status: 401 if current_user.nil?
+      end
+
+      # In case we want to disable bullet for specific controller actions
+      def skip_bullet
+        previous_value = Bullet.enable?
+        Bullet.enable = false
+        yield
+      ensure
+        Bullet.enable = previous_value
+      end
+
+      private
+
+      def serialize(data)
+        ActiveModelSerializers::SerializableResource.new(data)
+      end
+
+      def token
+        return nil if request.env["HTTP_AUTHORIZATION"].nil?
+
+        request.env["HTTP_AUTHORIZATION"].scan(/Bearer (.*)$/).flatten.last
+      end
+
+      def auth
+        TokenService.decode(token)
+      end
+    end
+  end
+end

data/app/controllers/comee/core/currencies_controller.rb

@@ -0,0 +1,13 @@
+module Comee
+  module Core
+    class CurrenciesController < ApplicationController
+      include Common
+
+      private
+
+      def model_params
+        params.require(:payload).permit(:code, :name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Comee
+  module Core
+    class NotificationsController < ApplicationController
+      before_action :set_notification, only: %i[mark_as_read mark_as_unread]
+
+      def index
+        data = Comee::Core::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/comee/core/product_types_controller.rb

@@ -0,0 +1,18 @@
+module Comee
+  module Core
+    class ProductTypesController < ApplicationController
+      include Common
+
+      def products
+        products = Product.where(product_type_id: params[:id])
+        render json: {success: true, data: serialize(products)}
+      end
+
+      private
+
+      def model_params
+        params.require(:payload).permit(:code, :name, :description, metadata_schema: {})
+      end
+    end
+  end
+end

data/app/controllers/comee/core/products_controller.rb

@@ -0,0 +1,13 @@
+module Comee
+  module Core
+    class ProductsController < ApplicationController
+      include Common
+
+      private
+
+      def model_params
+        params.required(:payload).permit(:code, :name, :description, :product_type_id, :unit_id, :metadata)
+      end
+    end
+  end
+end

data/app/controllers/comee/core/suppliers_controller.rb

@@ -0,0 +1,13 @@
+module Comee
+  module Core
+    class SuppliersController < ApplicationController
+      include Common
+
+      private
+
+      def model_params
+        params.require(:payload).permit(:code, :name, :address, :locale)
+      end
+    end
+  end
+end

data/app/controllers/comee/core/units_controller.rb

@@ -0,0 +1,13 @@
+module Comee
+  module Core
+    class UnitsController < ApplicationController
+      include Common
+
+      private
+
+      def model_params
+        params.require(:payload).permit(:code, :name, :unit_type)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Comee
+  module Core
+    class UsersController < ApplicationController
+      include Common
+
+      private
+
+      def model_params
+        params.require(:payload).permit(:name, :email, :active, :password, :password_confirmation, :user_type)
+      end
+    end
+  end
+end

data/app/controllers/concerns/comee/core/common.rb

@@ -0,0 +1,73 @@
+module Comee
+  module Core
+    module Common
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :set_clazz
+        before_action :set_object, only: %i[show update]
+      end
+
+      def index
+        data = if block_given?
+          yield
+        else
+          @clazz.all
+        end
+        render json: {success: true, data: serialize(data)}
+      end
+
+      def show
+        render json: {success: true, data: serialize(@obj)}
+      end
+
+      def create
+        obj = if block_given?
+          yield
+        else
+          @clazz.new(model_params)
+        end
+        if obj.save
+          render json: {success: true, data: serialize(obj)}, status: :created
+        else
+          render json: {success: false, error: obj.errors.full_messages[0]}, status: :unprocessable_entity
+        end
+      rescue => e
+        render json: {success: false, error: e.message}
+      end
+
+      def update
+        obj = if block_given?
+          yield
+        else
+          obj = @obj
+        end
+        if obj.update(model_params)
+          render json: {success: true, data: serialize(obj)}
+        else
+          render json: {success: false, error: obj.errors.full_messages[0]}, status: :unprocessable_entity
+        end
+      rescue => e
+        render json: {success: false, error: e.message}
+      end
+
+      private
+
+      def serialize(data)
+        ActiveModelSerializers::SerializableResource.new(data)
+      end
+
+      def set_clazz
+        @clazz = "Comee::Core::#{controller_name.classify}".constantize
+      end
+
+      def set_object
+        @obj = @clazz.find(params[:id])
+      end
+
+      # This class should be overridden by respective child controllers
+      def model_params
+      end
+    end
+  end
+end

data/app/jobs/comee_core/application_job.rb

@@ -0,0 +1,4 @@
+module ComeeCore
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/comee/core/application_mailer.rb

@@ -0,0 +1,8 @@
+module Comee
+  module Core
+    class ApplicationMailer < ActionMailer::Base
+      default from: "notifications@maveco.com"
+      layout "mailer"
+    end
+  end
+end

data/app/mailers/comee/core/supplier_mailer.rb

@@ -0,0 +1,18 @@
+module Comee
+  module Core
+    class SupplierMailer < ApplicationMailer
+      default from: "notifications@maveco.com"
+
+      def new_order_notification
+        @back_order = params[:back_order]
+        I18n.with_locale(@back_order.supplier.locale) do
+          mail(
+            from: "support@maveko.com",
+            to: @back_order.supplier.user.email,
+            subject: "New Order Notification"
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/comee/core/application_record.rb

@@ -0,0 +1,7 @@
+module Comee
+  module Core
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/comee/core/back_order.rb

@@ -0,0 +1,33 @@
+module Comee
+  module Core
+    class BackOrder < ApplicationRecord
+      enum :status, {draft: 0, confirmed: 1}
+
+      after_create_commit :notify_supplier
+
+      belongs_to :supplier
+      has_many :back_order_items
+
+      has_noticed_notifications model_name: "Comee::Core::Notification"
+
+      validates :order_number, presence: true, uniqueness: true
+      validates :order_date, :delivery_date, :terms, :delivery_address, :invoice_address, :status, presence: true
+
+      delegate(:name, to: :supplier, prefix: true)
+
+      def self.ransackable_attributes(auth_object = nil)
+        ["delivery_address", "delivery_date", "invoice_address", "order_date", "order_number", "status", "supplier_id"]
+      end
+
+      def self.ransackable_associations(auth_object = nil)
+        []
+      end
+
+      private
+
+      def notify_supplier
+        Comee::Core::NewOrderNotification.with(back_order: self).deliver_later(supplier.user)
+      end
+    end
+  end
+end

data/app/models/comee/core/back_order_item.rb

@@ -0,0 +1,16 @@
+module Comee
+  module Core
+    class BackOrderItem < ApplicationRecord
+      enum :item_status, {available: 0, out_of_stock: 1}
+
+      belongs_to :back_order
+      belongs_to :product
+
+      validates :item_status, presence: true
+      validates :requested_quantity, :requested_unit_price, :supplier_quantity, :supplier_unit_price, presence: true, numericality: {greater_than: 0}
+
+      delegate(:code, :name, :description, to: :product, prefix: true)
+      delegate(:unit_code, :unit_name, to: :product, prefix: false)
+    end
+  end
+end

data/app/models/comee/core/client.rb

@@ -0,0 +1,10 @@
+module Comee
+  module Core
+    class Client < ApplicationRecord
+      belongs_to :user, optional: true
+
+      validates :code, :name, :address, :locale, presence: true
+      validates :code, uniqueness: true
+    end
+  end
+end

data/app/models/comee/core/client_order.rb

@@ -0,0 +1,23 @@
+module Comee
+  module Core
+    class ClientOrder < ApplicationRecord
+      belongs_to :client
+      has_many :client_order_items
+
+      enum :status, {draft: 0, confirmed: 1}
+
+      validates :order_number, presence: true, uniqueness: true
+      validates :order_date, :delivery_date, :terms, :delivery_address, :invoice_address, :status, presence: true
+
+      delegate(:name, to: :client, prefix: true)
+
+      def self.ransackable_attributes(auth_object = nil)
+        ["delivery_address", "delivery_date", "invoice_address", "order_date", "order_number", "status", "client_id"]
+      end
+
+      def self.ransackable_associations(auth_object = nil)
+        []
+      end
+    end
+  end
+end

data/app/models/comee/core/client_order_item.rb

@@ -0,0 +1,10 @@
+module Comee
+  module Core
+    class ClientOrderItem < ApplicationRecord
+      belongs_to :client_order
+      belongs_to :product
+
+      validates :quantity, :price, presence: true, numericality: {greater_than: 0}
+    end
+  end
+end

data/app/models/comee/core/client_price.rb

@@ -0,0 +1,20 @@
+module Comee
+  module Core
+    class ClientPrice < ApplicationRecord
+      belongs_to :product
+      belongs_to :client
+
+      validates :valid_from, :valid_to, :new_price, presence: true
+      validates :old_price, :new_price, numericality: {greater_than: 0, allow_nil: true}
+      validates :product_id, uniqueness: {scope: :client_id}
+      validate :validate_price_validity_dates
+
+      def validate_price_validity_dates
+        return unless valid_from && valid_to
+
+        period = Period.new(valid_from, valid_to)
+        errors.add(:base, "Price validity date range is not correct.") unless period.valid?
+      end
+    end
+  end
+end

data/app/models/comee/core/currency.rb

@@ -0,0 +1,8 @@
+module Comee
+  module Core
+    class Currency < ApplicationRecord
+      validates :code, presence: true, uniqueness: true
+      validates :name, presence: true
+    end
+  end
+end

data/app/models/comee/core/invoice.rb

@@ -0,0 +1,23 @@
+module Comee
+  module Core
+    class Invoice < ApplicationRecord
+      before_save :update_invoice_total
+      belongs_to :client_order
+      has_many :invoice_items
+
+      enum :status, {draft: 0, approved: 1}
+      enum :payment_status, {not_settled: 0, settled: 1}
+
+      validates :invoice_no, presence: true, uniqueness: true
+      validates :date_issued, :payment_term, :status, :payment_status, presence: true
+      validates :additional_charges, :total_price, numericality: {greater_than_or_equal_to: 0, allow_nil: true}
+
+      def update_invoice_total
+        self.additional_charges ||= 0
+        self.total_price ||= 0
+        self.total_price -= additional_charges_was if additional_charges_was && additional_charges_changed?
+        self.total_price += additional_charges
+      end
+    end
+  end
+end

data/app/models/comee/core/invoice_item.rb

@@ -0,0 +1,18 @@
+module Comee
+  module Core
+    class InvoiceItem < ApplicationRecord
+      before_save { self.total_price = unit_price * quantity }
+      after_save :update_invoice_total
+
+      belongs_to :client_order_item
+      belongs_to :invoice
+
+      validates :quantity, :unit_price, :total_price, presence: true, numericality: {greater_than: 0}
+
+      def update_invoice_total
+        invoice.total_price = InvoiceItem.where(invoice: invoice).map(&:total_price).sum
+        invoice.save!
+      end
+    end
+  end
+end

data/app/models/comee/core/master_price.rb

@@ -0,0 +1,35 @@
+module Comee
+  module Core
+    class MasterPrice < ApplicationRecord
+      belongs_to :supplier
+      belongs_to :product
+
+      validates :pp_valid_from, :pp_valid_to, :sp_valid_from, :sp_valid_to, :new_pprice, :new_sprice, presence: true
+      validates :old_pprice, :old_sprice, numericality: {greater_than: 0, allow_nil: true}
+      validates :new_pprice, :new_sprice, numericality: {greater_than: 0}
+      validates :product_id, uniqueness: {scope: :supplier_id}
+      validate :validate_primary_price, :validate_purchase_price_validity_dates, :validate_selling_price_validity_dates
+
+      def validate_primary_price
+        return unless product && primary
+
+        count = MasterPrice.where(product:, primary: true).count
+        errors.add(:base, "There is already a primary supplier for item '#{product.code}'") if count.positive?
+      end
+
+      def validate_purchase_price_validity_dates
+        return unless pp_valid_from && pp_valid_to
+
+        period = Period.new(pp_valid_from, pp_valid_to)
+        errors.add(:base, "Purchase price validity date range is not correct.") unless period.valid?
+      end
+
+      def validate_selling_price_validity_dates
+        return unless sp_valid_from && sp_valid_to
+
+        period = Period.new(sp_valid_from, sp_valid_to)
+        errors.add(:base, "Selling price validity date range is not correct.") unless period.valid?
+      end
+    end
+  end
+end

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

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

data/app/models/comee/core/product.rb

@@ -0,0 +1,47 @@
+module Comee
+  module Core
+    class Product < ApplicationRecord
+      belongs_to :product_type
+      belongs_to :unit
+
+      validates :code, presence: true, uniqueness: true
+      validates :name, presence: true
+      validate :metadata_must_be_based_on_metadata_schema, if: -> { product_type.present? }
+
+      delegate(:code, :name, to: :product_type, prefix: true)
+      delegate(:code, :name, to: :unit, prefix: true)
+
+      def metadata_must_be_based_on_metadata_schema
+        metadata_schema = product_type.metadata_schema
+        return unless metadata_schema.present? && metadata.present?
+
+        properties = metadata_schema["properties"]
+        fields = properties.keys
+        required = metadata_schema["required"]
+        diff = metadata.keys - fields
+        unless diff.empty?
+          errors.add(:metadata, "holds fields that are not allowed #{diff}.")
+          return
+        end
+
+        diff = required - metadata.keys
+        unless diff.empty?
+          errors.add(:metadata, "should contain the following required fields #{diff}.")
+          return
+        end
+
+        metadata.each do |k, v|
+          if v.class.to_s.downcase != properties[k]["type"]
+            errors.add(:metadata, "contains invalid value for field #{k}.")
+          end
+          if properties[k].key?("min") && v < properties[k]["min"]
+            errors.add(:base, "The value of #{k} cannot be lower than #{properties[k]["min"]}.")
+          end
+          if properties[k].key?("max") && v > properties[k]["max"]
+            errors.add(:base, "The value of #{k} cannot be higher than #{properties[k]["max"]}.")
+          end
+        end
+      end
+    end
+  end
+end