comee_core 0.1.10

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

@@ -0,0 +1,10 @@
+module Comee
+  module Core
+    class ProductLookup < ApplicationRecord
+      belongs_to :product
+      belongs_to :itemable, polymorphic: true
+
+      validates :code, presence: true
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Comee
+  module Core
+    class ProductType < ApplicationRecord
+      validates :code, presence: true, uniqueness: true
+      validates :name, presence: true
+      validate :required_fields_must_be_in_properties
+
+      def required_fields_must_be_in_properties
+        return unless metadata_schema.present?
+
+        diff = metadata_schema["required"] - metadata_schema["properties"].keys
+        return unless diff.count.positive?
+
+        error = "The following fields are mentioned as required but do not exist in the field list: #{diff}."
+        errors.add(:base, error)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,10 @@
+module Comee
+  module Core
+    class Unit < ApplicationRecord
+      enum :unit_type, {weight: 0, volume: 1, item: 2}
+
+      validates :code, presence: true, uniqueness: true
+      validates :name, presence: true
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Comee
+  module Core
+    class User < ApplicationRecord
+      enum :user_type, {supplier: 0, admin: 1}
+
+      has_secure_password
+      has_many :notifications, as: :recipient, dependent: :destroy
+
+      validates :name, :email, :user_type, presence: true
+      validates :email, uniqueness: true
+    end
+  end
+end

data/app/notifications/comee/core/new_order_notification.rb

@@ -0,0 +1,23 @@
+module Comee
+  module Core
+    class NewOrderNotification < Noticed::Base
+      deliver_by :database
+      deliver_by :email, mailer: "Comee::Core::SupplierMailer", method: :new_order_notification
+
+      param :back_order
+
+      def message
+        back_order = params[:back_order]
+        title = "New Order Notification"
+        date = Date.current
+        content = <<~CONTENT
+          A new purchase order with the following details has been sent to you:
+            order number: #{back_order.order_number}
+            order date: #{back_order.order_date}
+            delivery date: #{back_order.delivery_date}
+        CONTENT
+        {title:, date:, content:}
+      end
+    end
+  end
+end

data/app/serializers/comee/core/currency_serializer.rb

@@ -0,0 +1,7 @@
+module Comee
+  module Core
+    class CurrencySerializer < ActiveModel::Serializer
+      attributes :id, :code, :name
+    end
+  end
+end

data/app/serializers/comee/core/product_serializer.rb

@@ -0,0 +1,8 @@
+module Comee
+  module Core
+    class ProductSerializer < ActiveModel::Serializer
+      attributes :id, :code, :name, :description, :product_type_id, :metadata, :unit_code, :unit_name,
+        :product_type_code, :product_type_name
+    end
+  end
+end

data/app/serializers/comee/core/product_type_serializer.rb

@@ -0,0 +1,7 @@
+module Comee
+  module Core
+    class ProductTypeSerializer < ActiveModel::Serializer
+      attributes :id, :code, :name, :description, :metadata_schema
+    end
+  end
+end

data/app/serializers/comee/core/supplier_serializer.rb

@@ -0,0 +1,7 @@
+module Comee
+  module Core
+    class SupplierSerializer < ActiveModel::Serializer
+      attributes :id, :code, :name, :address, :locale
+    end
+  end
+end

data/app/serializers/comee/core/unit_serializer.rb

@@ -0,0 +1,7 @@
+module Comee
+  module Core
+    class UnitSerializer < ActiveModel::Serializer
+      attributes :id, :code, :name, :unit_type
+    end
+  end
+end

data/app/serializers/comee/core/user_serializer.rb

@@ -0,0 +1,7 @@
+module Comee
+  module Core
+    class UserSerializer < ActiveModel::Serializer
+      attributes :id, :name, :email, :user_type
+    end
+  end
+end

data/app/services/comee/core/product_lookup_service.rb

@@ -0,0 +1,38 @@
+module Comee
+  module Core
+    class ProductLookupService
+      ORGANIZATION = "ORG".freeze
+      ##
+      # This method returns a translated code for a given +code+. The +code+ can be
+      # for a supplier or a client. The source of the +code+ is described using the +from+
+      # parameter. The +from+ parameter is a has which specifies the id of the source
+      # supplier/client as `itemable_id`, and the data type of the source as itemable_type.
+      # We specify the id and type because the ProductLookup model has a polymorphic relationship
+      # with supplier and client.
+      #
+      # The +to+ parameter uses a similar format to specify the target supplier/client we want to
+      # conduct the lookup for.
+      def lookup_product(code, from, to)
+        error = "The 'from' parameter cannot be assigned any string other than '#{ORGANIZATION}'."
+        raise(StandardError, error) if from.instance_of?(String) && from != ORGANIZATION
+
+        error = "The 'to' parameter cannot be assigned any string other than '#{ORGANIZATION}'."
+        raise(StandardError, error) if to.instance_of?(String) && to != ORGANIZATION
+
+        if from == ORGANIZATION
+          query = ProductLookup.joins(:product).find_by(product: {code:}, **to)
+          return query.code
+        end
+
+        if to == ORGANIZATION
+          product = ProductLookup.find_by(code: code, **from).product
+          return product.code
+        end
+
+        product = ProductLookup.find_by(code: code, **from).product
+        query = ProductLookup.find_by(product: product, **to)
+        query.code
+      end
+    end
+  end
+end

data/app/services/comee/core/token_service.rb

@@ -0,0 +1,13 @@
+module Comee
+  module Core
+    class TokenService
+      def self.issue(payload)
+        JWT.encode(payload, ENV["SECRET_KEY"], "HS256")
+      end
+
+      def self.decode(token)
+        JWT.decode(token, ENV["SECRET_KEY"], true, algorithm: "HS256").first
+      end
+    end
+  end
+end

data/app/utils/comee/core/period.rb

@@ -0,0 +1,35 @@
+module Comee
+  module Core
+    class Period
+      attr_accessor :start, :finish
+      def initialize(start, finish)
+        @start = start
+        @finish = finish
+      end
+
+      def valid?
+        finish > start
+      end
+
+      def contains?(period)
+        return true if start <= period.start && finish >= period.finish
+
+        false
+      end
+
+      def contained_by?(period)
+        return true if start >= period.start && finish <= period.finish
+
+        false
+      end
+
+      def overlaps?(period)
+        return true if period.start <= start && start <= period.finish
+
+        return true if start <= period.start && period.start <= finish
+
+        false
+      end
+    end
+  end
+end

data/app/views/comee/core/supplier_mailer/new_order_notification.html.erb

@@ -0,0 +1,8 @@
+<p><%= t(".greeting") %></p>
+<p><%= t(".entry", link: "http://localhost:4200/order-management/confirmation/#{@back_order.id}", order_number: @back_order.order_number) %><p>
+<p><%= t(".feedback", next_day: Date.current.advance(days: 1)) %>
+</p><%= t(".delivery", delivery_address: @back_order.delivery_address) %>
+<p><%= t(".invoice", invoice_address: @back_order.invoice_address) %></p>
+<p><%= t(".telephone") %></p>
+<p><%= t(".thanks") %></p>
+<p><%= t(".closing") %></p>

data/app/views/layouts/comee/core/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/layouts/comee/core/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/config/locales/de.yml

@@ -0,0 +1,13 @@
+de:
+  comee:
+    core:
+      supplier_mailer:
+        new_order_notification:
+          greeting: "Sehr geehrte Damen und Herren,"
+          entry: "Bitte besuchen Sie den %{link}, um unser '%{order_number}' zu finden."
+          feedback: "Wir bitten um Rückmeldung bis zum %{next_day} (the next day)."
+          delivery: "Die Warenannahme findet an der Adresse %{delivery_address} statt und erfolgt von Montag bis Freitag im Zeitraum von 07:00 – 16:00 Uhr."
+          invoice: "Die Büro-/Rechnungsadresse lautet %{invoice_address}."
+          telephone: "Unsere neue Telefon-Nr. lautet +49 (0) 40-98256170"
+          thanks: "Vielen Dank im Voraus."
+          closing: "Beste Grüße"

data/config/locales/en.yml

@@ -0,0 +1,13 @@
+en:
+  comee:
+    core:    
+      supplier_mailer:
+        new_order_notification:
+          greeting: "Dear Ladies and Gentlemen,"
+          entry: "Please visit %{link} to find our '%{order_number}'."
+          feedback: "We kindly ask for feedback by %{next_day} (the next day)."
+          delivery: "Please take note that the goods receipt will take place at the address %{delivery_address} from Monday to Friday in the time frame from 07:00 - 16:00 o'clock."
+          invoice: "The office billing address is %{invoice_address}."
+          telephone: "Our new telephone number is: +49 (0) 40-98256170"
+          thanks: "Thank you in advance."
+          closing: "Best regards"

data/config/routes.rb

@@ -0,0 +1,21 @@
+Comee::Core::Engine.routes.draw do
+  post "/login", controller: :access, action: :login
+  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 :suppliers
+  resources :products
+  resources :product_types do
+    member do
+      get "products", controller: :product_types, action: :products
+    end
+  end
+  resources :currencies
+  resources :units
+  resources :users
+end

data/config/spring.rb

@@ -0,0 +1 @@
+Spring.application_root = "spec/dummy"

data/db/migrate/20230727153013_create_comee_core_units.rb

@@ -0,0 +1,12 @@
+class CreateComeeCoreUnits < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_units do |t|
+      t.string :code, null: false
+      t.string :name, null: false
+      t.integer :unit_type, null: false, default: 0
+
+      t.timestamps
+    end
+    add_index :comee_core_units, :code, unique: true
+  end
+end

data/db/migrate/20230728011037_create_comee_core_currencies.rb

@@ -0,0 +1,11 @@
+class CreateComeeCoreCurrencies < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_currencies do |t|
+      t.string :code, null: false
+      t.string :name, null: false
+
+      t.timestamps
+    end
+    add_index :comee_core_currencies, :code, unique: true
+  end
+end

data/db/migrate/20230728012836_create_comee_core_product_types.rb

@@ -0,0 +1,13 @@
+class CreateComeeCoreProductTypes < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_product_types do |t|
+      t.string :code, null: false
+      t.string :name, null: false
+      t.string :description
+      t.jsonb :metadata_schema, default: {}
+
+      t.timestamps
+    end
+    add_index :comee_core_product_types, :code, unique: true
+  end
+end

data/db/migrate/20230728014322_create_comee_core_products.rb

@@ -0,0 +1,21 @@
+class CreateComeeCoreProducts < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_products do |t|
+      t.string :code, null: false
+      t.string :name, null: false
+      t.string :description
+      t.jsonb :metadata
+      t.references :product_type,
+        null: false,
+        index: {name: "ccpt_on_ccp_indx"},
+        foreign_key: {to_table: :comee_core_product_types}
+      t.references :unit,
+        null: false,
+        index: {name: "unit_on_ccp_indx"},
+        foreign_key: {to_table: :comee_core_units}
+
+      t.timestamps
+    end
+    add_index :comee_core_products, :code, unique: true
+  end
+end

data/db/migrate/20230728014330_create_comee_core_users.rb

@@ -0,0 +1,14 @@
+class CreateComeeCoreUsers < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_users do |t|
+      t.string :name, null: false
+      t.string :email, null: false
+      t.boolean :active, null: false, default: true
+      t.string :password_digest
+      t.integer :user_type, null: false, default: 0
+
+      t.timestamps
+    end
+    add_index :comee_core_users, :email, unique: true
+  end
+end

data/db/migrate/20230728122618_create_comee_core_suppliers.rb

@@ -0,0 +1,17 @@
+class CreateComeeCoreSuppliers < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_suppliers do |t|
+      t.string :code, null: false
+      t.string :name, null: false
+      t.string :address, null: false
+      t.string :locale, null: false, default: "en"
+      t.references :user,
+        null: true,
+        index: {name: "user_on_ccs_indx"},
+        foreign_key: {to_table: :comee_core_users}
+
+      t.timestamps
+    end
+    add_index :comee_core_suppliers, :code, unique: true
+  end
+end

data/db/migrate/20230728123039_create_comee_core_clients.rb

@@ -0,0 +1,18 @@
+class CreateComeeCoreClients < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_clients do |t|
+      t.references :user,
+        null: false,
+        index: {name: "user_on_ccc_indx"},
+        foreign_key: {to_table: :comee_core_users}
+      t.string :code, null: false
+      t.string :name, null: false
+      t.string :address, null: false
+      t.string :locale, null: false, default: "en"
+      t.string :discount, null: false, default: 0
+
+      t.timestamps
+    end
+    add_index :comee_core_clients, :code, unique: true
+  end
+end

data/db/migrate/20230728123928_create_comee_core_back_orders.rb

@@ -0,0 +1,20 @@
+class CreateComeeCoreBackOrders < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_back_orders do |t|
+      t.string :order_number, null: false
+      t.date :order_date, null: false, default: -> { "CURRENT_DATE" }
+      t.date :delivery_date, null: false
+      t.references :supplier,
+        null: false,
+        index: {name: "supplier_on_ccbo_indx"},
+        foreign_key: {to_table: :comee_core_suppliers}
+      t.json :terms, null: false, default: {freight_terms: "FOB", currency: "EURO"}
+      t.string :delivery_address, null: false
+      t.string :invoice_address, null: false
+      t.integer :status, null: false, default: 0
+      t.string :remark
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230728125723_create_comee_core_back_order_items.rb

@@ -0,0 +1,22 @@
+class CreateComeeCoreBackOrderItems < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_back_order_items do |t|
+      t.references :back_order,
+        null: false,
+        index: {name: "bo_on_ccboi_indx"},
+        foreign_key: {to_table: :comee_core_back_orders}
+      t.references :product,
+        null: false,
+        index: {name: "product_on_ccboi_indx"},
+        foreign_key: {to_table: :comee_core_products}
+      t.float :requested_quantity, null: false
+      t.float :requested_unit_price, null: false
+      t.float :supplier_quantity, null: false
+      t.float :supplier_unit_price, null: false
+      t.integer :item_status, null: false, default: 0
+      t.string :remark
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230730061225_create_comee_core_notifications.rb

@@ -0,0 +1,13 @@
+class CreateComeeCoreNotifications < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_notifications do |t|
+      t.references :recipient, polymorphic: true, null: false
+      t.string :type
+      t.jsonb :params
+      t.datetime :read_at
+
+      t.timestamps
+    end
+    add_index :comee_core_notifications, :read_at
+  end
+end

data/db/migrate/20230812190652_create_comee_core_client_orders.rb

@@ -0,0 +1,24 @@
+class CreateComeeCoreClientOrders < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_client_orders do |t|
+      t.string :order_number, null: false
+      t.date :order_date, null: false, default: -> { "CURRENT_DATE" }
+      t.date :delivery_date, null: false
+      t.references :client,
+        null: false,
+        index: {name: "client_on_ccco_indx"},
+        foreign_key: {to_table: :comee_core_clients}
+      t.json :terms
+      t.integer :status, null: false, default: 0
+      t.string :delivery_address, null: false
+      t.string :invoice_address, null: false
+      t.string :remark
+      t.float :total_price, null: true, default: 0
+      t.float :amount_paid, null: true, default: 0
+      t.float :amount_due, null: true, default: 0
+
+      t.timestamps
+    end
+    add_index :comee_core_client_orders, :order_number, unique: true
+  end
+end

data/db/migrate/20230812212844_create_comee_core_client_order_items.rb

@@ -0,0 +1,18 @@
+class CreateComeeCoreClientOrderItems < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_client_order_items do |t|
+      t.references :client_order,
+        null: false,
+        index: {name: "co_on_coi_indx"},
+        foreign_key: {to_table: :comee_core_client_orders}
+      t.references :product,
+        null: false,
+        index: {name: "po_on_coi_indx"},
+        foreign_key: {to_table: :comee_core_products}
+      t.integer :quantity, null: false
+      t.integer :price, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230813235946_create_comee_core_master_prices.rb

@@ -0,0 +1,26 @@
+class CreateComeeCoreMasterPrices < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_master_prices do |t|
+      t.date :pp_valid_from, null: false
+      t.date :pp_valid_to, null: false
+      t.date :sp_valid_from, null: false
+      t.date :sp_valid_to, null: false
+      t.float :old_pprice, null: true
+      t.float :new_pprice, null: false
+      t.float :old_sprice, null: true
+      t.float :new_sprice, null: false
+      t.boolean :primary, null: false
+      t.references :product,
+        null: false,
+        index: {name: "product_on_ccsp_indx"},
+        foreign_key: {to_table: :comee_core_products}
+      t.references :supplier,
+        null: false,
+        index: {name: "supplier_on_ccsp_indx"},
+        foreign_key: {to_table: :comee_core_suppliers}
+
+      t.timestamps
+    end
+    add_index :comee_core_master_prices, [:product_id, :supplier_id], unique: true
+  end
+end

data/db/migrate/20230814151601_create_comee_core_client_prices.rb

@@ -0,0 +1,23 @@
+class CreateComeeCoreClientPrices < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_client_prices do |t|
+      t.date :valid_from, null: false
+      t.date :valid_to, null: false
+      t.float :old_price, null: true
+      t.float :new_price, null: false
+      t.float :future_price, null: true
+      t.date :future_validity, null: true
+      t.references :product,
+        null: false,
+        index: {name: "product_on_cccp_indx"},
+        foreign_key: {to_table: :comee_core_products}
+      t.references :client,
+        null: false,
+        index: {name: "client_on_cccp_indx"},
+        foreign_key: {to_table: :comee_core_clients}
+
+      t.timestamps
+    end
+    add_index :comee_core_client_prices, [:product_id, :client_id], unique: true
+  end
+end

data/db/migrate/20230914041307_create_comee_core_external_products.rb

@@ -0,0 +1,18 @@
+class CreateComeeCoreExternalProducts < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_product_lookups do |t|
+      t.string :code, null: false
+      t.references :itemable, polymorphic: true, null: false
+      t.references :product,
+        null: false,
+        index: {name: "product_on_ccep_indx"},
+        foreign_key: {to_table: :comee_core_products}
+
+      t.timestamps
+    end
+    add_index :comee_core_product_lookups,
+      [:itemable_id, :itemable_type, :product_id],
+      name: "itemable_product_indx_uniq",
+      unique: true
+  end
+end

data/db/migrate/20230915205522_create_comee_core_invoices.rb

@@ -0,0 +1,24 @@
+class CreateComeeCoreInvoices < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_invoices do |t|
+      t.string :invoice_no, null: false
+      t.references :client_order,
+        null: false,
+        index: {name: "co_on_cci_indx"},
+        foreign_key: {to_table: :comee_core_client_orders}
+      t.date :date_issued, null: false
+      t.string :ship_name
+      t.date :delivery_date
+      t.string :voyage_no
+      t.float :additional_charges
+      t.float :total_price
+      t.string :payment_term, null: false
+      t.integer :notifications_sent
+      t.integer :status, null: false, default: 0
+      t.integer :payment_status, null: false, default: 0
+
+      t.timestamps
+    end
+    add_index :comee_core_invoices, :invoice_no, unique: true
+  end
+end

data/db/migrate/20230915205648_create_comee_core_invoice_items.rb

@@ -0,0 +1,19 @@
+class CreateComeeCoreInvoiceItems < ActiveRecord::Migration[7.0]
+  def change
+    create_table :comee_core_invoice_items do |t|
+      t.references :client_order_item,
+        null: false,
+        index: {name: "coi_on_ccii_indx"},
+        foreign_key: {to_table: :comee_core_client_order_items}
+      t.float :quantity, null: false
+      t.float :unit_price, null: false
+      t.float :total_price, null: false
+      t.references :invoice,
+        null: false,
+        index: {name: "invoice_on_ccii_indx"},
+        foreign_key: {to_table: :comee_core_invoices}
+
+      t.timestamps
+    end
+  end
+end