api_engine_base 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f2182e3fbdabb9d8dee95b45cd2308d4c9f60f1fe93b9cde7a4e1c543cbc2a8
-  data.tar.gz: e9a9063e61ff9f3815533db89a783a38da4eab6860c7511d86a4a3fcd8943c19
+  metadata.gz: d10e7cc64ff7f99aa912731ce7200ebfbff18e90b0cc05b948a8f6034d15e54f
+  data.tar.gz: 07baec4ba6dc487ab145d68e87e489181153550b3e22f1db594d56e1fcc86e3d
 SHA512:
-  metadata.gz: 36eaf340ded210a8dc26d5d10de1fbfacec838bef501618efff5c3adaad8dace49b3217e36ca614627bda213504511778dccef2c2d421c7978b238dbaca2b978
-  data.tar.gz: a849ee1f598893dc670b3f40b1984cbfbde3efa2b50c33e6c823b7a0360967c000e25583874174105466bec1f4920f76aa9247c7d0e8b05348d29ae935cc2dd4
+  metadata.gz: 93d925277dac2e33eff40c8f3e4669f4ea162051ca6f9ec0d9d66791ed9e937384262fd983a04d4895c7891d1ec763d41f092a3242c4e685f9237f6b8af463ba
+  data.tar.gz: 7e7bd57ff6c8a991fe251c6afb01d4d3a8900a002973dc8c661313fd94ceac1f81e17f7dc80ec96f175bc110f4c0ec74638c75b9eb32b4a871815dff2c20e21f

data/app/controllers/api_engine_base/inbox/message_blast_controller.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module Inbox
+    class MessageBlastController < ::ApiEngineBase::ApplicationController
+      include ApiEngineBase::SchemaHelper
+
+      before_action :authenticate_user!
+      before_action :authorize_user!
+
+      # GET /inbox/blast
+      def metadata
+        result = ApiEngineBase::InboxService::Blast::Metadata.(id: params[:id].to_i)
+        schema_succesful!(status: 200, schema: result.metadata)
+      end
+
+      # GET /inbox/blast/:id
+      def blast
+        result = ApiEngineBase::InboxService::Blast::Retrieve.(id: params[:id].to_i)
+        if result.success?
+          schema = result.message_blast
+          status = 200
+          schema_succesful!(status:, schema:)
+        else
+          invalid_arguments!(
+            status: 400,
+            message: result.msg,
+            argument_object: result.invalid_argument_hash,
+            schema: ApiEngineBase::Schema::PlainText::LoginRequest,
+          )
+        end
+      end
+
+      # POST /inbox/blast
+      def create
+        upsert
+      end
+
+      # PATCH /inbox/blast/:id
+      def modify
+        upsert(id: params[:id].to_i)
+      end
+
+      # DELETE /inbox/blast/:id
+      def delete
+        result = ApiEngineBase::InboxService::Blast::Delete.(id: params[:id].to_i)
+        if result.success?
+          schema = result.message
+          status = 200
+          render :json, { id: params[:id], msg: "Message Blast message deleted" }
+        else
+          invalid_arguments!(
+            status: 400,
+            message: result.msg,
+            argument_object: result.invalid_argument_hash,
+            schema: ApiEngineBase::Schema::PlainText::LoginRequest,
+          )
+        end
+      end
+
+      private
+
+      def upsert(id: nil)
+        upsert_params = {
+          user: current_user,
+          existing_users: safe_boolean(value: params[:existing_users]),
+          new_users: safe_boolean(value: params[:new_users]),
+          text: params[:text],
+          title: params[:title],
+          id:,
+        }.compact
+        result = ApiEngineBase::InboxService::Blast::Upsert.(**upsert_params)
+
+        if result.success?
+          schema = result.blast
+          status = 200
+          schema_succesful!(status:, schema:)
+        else
+          invalid_arguments!(
+            status: 400,
+            message: result.msg,
+            argument_object: result.invalid_argument_hash,
+            schema: ApiEngineBase::Schema::Inbox::BlastRequest
+          )
+        end
+      end
+    end
+  end
+end

data/app/controllers/api_engine_base/inbox/message_controller.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module Inbox
+    class MessageController < ::ApiEngineBase::ApplicationController
+      include ApiEngineBase::SchemaHelper
+
+      before_action :authenticate_user!
+
+      # GET: /inbox/messages
+      def metadata
+        result = ApiEngineBase::InboxService::Message::Metadata.(user: current_user)
+        if result.success?
+          schema = result.metadata
+          status = 200
+          schema_succesful!(status:, schema:)
+        else
+          invalid_arguments!(
+            status: 400,
+            message: result.msg,
+            argument_object: result.invalid_argument_hash,
+            schema: ApiEngineBase::Schema::PlainText::LoginRequest
+          )
+        end
+      end
+
+      # GET: /inbox/messages/:id
+      def message
+        result = ApiEngineBase::InboxService::Message::Retrieve.(user: current_user, id: params[:id].to_i)
+        if result.success?
+          schema = result.message
+          status = 200
+          schema_succesful!(status:, schema:)
+        else
+          invalid_arguments!(
+            status: 400,
+            message: result.msg,
+            argument_object: result.invalid_argument_hash,
+            schema: ApiEngineBase::Schema::PlainText::LoginRequest
+          )
+        end
+      end
+
+      # POST: /inbox/messages/ack
+      # Body { ids: [<list of ids to ack>] }
+      def ack
+        modify(type: ApiEngineBase::InboxService::Message::Modify::VIEWED)
+      end
+
+      # POST: /inbox/messages/delete
+      # Body { ids: [<list of ids to delete>] }
+      def delete
+        modify(type: ApiEngineBase::InboxService::Message::Modify::DELETE)
+      end
+
+      private
+
+      def modify(type:)
+        result = ApiEngineBase::InboxService::Message::Modify.(
+          user: current_user,
+          ids: params[:ids],
+          type:,
+        )
+        if result.success?
+          schema = result.modified
+          status = 200
+          schema_succesful!(status:, schema:)
+        else
+          invalid_arguments!(
+            status: 400,
+            message: result.msg,
+            argument_object: result.invalid_argument_hash,
+            schema: ApiEngineBase::Schema::PlainText::LoginRequest
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/message.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: messages
+#
+#  id               :bigint           not null, primary key
+#  pushed           :boolean          default(FALSE)
+#  text             :text(65535)
+#  title            :string(255)
+#  viewed           :boolean          default(FALSE)
+#  created_at       :datetime         not null
+#  updated_at       :datetime         not null
+#  message_blast_id :bigint
+#  user_id          :bigint           not null
+#
+# Indexes
+#
+#  index_messages_on_message_blast_id  (message_blast_id)
+#  index_messages_on_user_id           (user_id)
+#
+# Foreign Keys
+#
+#  fk_rails_...  (message_blast_id => message_blasts.id)
+#  fk_rails_...  (user_id => users.id)
+#
+class Message < ApplicationRecord
+  belongs_to :user
+  belongs_to :message_blast, optional: true
+end

data/app/models/message_blast.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: message_blasts
+#
+#  id             :bigint           not null, primary key
+#  existing_users :boolean          default(FALSE)
+#  new_users      :boolean          default(FALSE)
+#  text           :text(65535)
+#  title          :string(255)
+#  created_at     :datetime         not null
+#  updated_at     :datetime         not null
+#  user_id        :bigint           not null
+#
+# Indexes
+#
+#  index_message_blasts_on_user_id  (user_id)
+#
+# Foreign Keys
+#
+#  fk_rails_...  (user_id => users.id)
+#
+class MessageBlast < ApplicationRecord
+  has_many :messages
+  belongs_to :user
+end

data/app/models/user.rb

@@ -40,6 +40,8 @@ class User < ApiEngineBase::ApplicationRecord
   # Serialize the roles column to check for inclusion easily
   serialize :roles, coder: JSON, type: Array
 
+  has_many :messages
+
   def full_name
     "#{first_name} #{last_name}"
   end

data/app/services/api_engine_base/inbox_service/blast/delete.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module InboxService
+    module Blast
+      class Delete < ApiEngineBase::ServiceBase
+        on_argument_validation :fail_early
+
+        validate :id, is_a: Integer, required: true
+
+        def call
+          message_blast = ::MessageBlast.where(id:).first
+
+          if message_blast.nil?
+            inline_argument_failure!(errors: { id: "MessageBlast ID not found" })
+          end
+
+          message_blast.destroy
+        end
+      end
+    end
+  end
+end

data/app/services/api_engine_base/inbox_service/blast/metadata.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module InboxService
+    module Blast
+      class Metadata  < ApiEngineBase::ServiceBase
+        def call
+          entities = ::MessageBlast.all.select(:id, :title, :existing_users, :new_users).map do |mb|
+            ApiEngineBase::Schema::Inbox::MessageBlastEntity.new(
+              title: mb.title,
+              id: mb.id,
+              existing_users: mb.existing_users,
+              new_users: mb.new_users,
+            )
+          end
+
+
+          context.metadata = ApiEngineBase::Schema::Inbox::MessageBlastMetadata.new(
+            entities: entities,
+            count: entities.length,
+          )
+        end
+      end
+    end
+  end
+end

data/app/services/api_engine_base/inbox_service/blast/new_user_blaster.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module InboxService
+    module Blast
+      class NewUserBlaster  < ApiEngineBase::ServiceBase
+        on_argument_validation :fail_early
+
+        validate :user, is_a: User, required: true
+
+        def call
+          ::MessageBlast.where(new_users: true).each do |message_blast|
+            InboxService::Message::Send.(
+              user:,
+              text: message_blast.text,
+              title: message_blast.title,
+              message_blast:,
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/app/services/api_engine_base/inbox_service/blast/retrieve.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module InboxService
+    module Blast
+      class Retrieve < ApiEngineBase::ServiceBase
+        on_argument_validation :fail_early
+
+        validate :id, is_a: Integer, required: true
+
+        def call
+          message_blast = ::MessageBlast.where(id:).first
+
+          if message_blast.nil?
+            inline_argument_failure!(errors: { id: "MessageBlast ID not found" })
+          end
+
+          context.message_blast = ApiEngineBase::Schema::Inbox::MessageBlastEntity.new(
+            created_by: ApiEngineBase::Schema::User.convert_user_object(user: message_blast.user),
+            title: message_blast.title,
+            text: message_blast.text,
+            id: message_blast.id,
+            existing_users: message_blast.existing_users,
+            new_users: message_blast.new_users,
+          )
+        end
+      end
+    end
+  end
+end

data/app/services/api_engine_base/inbox_service/blast/upsert.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module InboxService
+    module Blast
+      class Upsert  < ApiEngineBase::ServiceBase
+        on_argument_validation :fail_early
+
+        validate :user, is_a: User, required: true
+        validate :existing_users, is_one: [true, false], required: true
+        validate :new_users, is_one: [true, false], required: true
+        validate :text, is_a: String, required: true
+        validate :title, is_a: String, required: true
+        validate :id, is_a: Integer, required: false
+
+        def call
+          ar = record
+
+          ar.existing_users = existing_users
+          ar.new_users = new_users
+          ar.text = text
+          ar.title = title
+          ar.user = user
+
+          # Probably should wrap this in a transaction block
+          ar.save!
+          blast_messages!(message_blast: ar)
+
+          context.message_blast = ar
+          context.blast = ApiEngineBase::Schema::Inbox::BlastResponse.new(
+            existing_users:,
+            new_users:,
+            text:,
+            title:,
+            id: ar.id,
+            created_by: ApiEngineBase::Schema::User.convert_user_object(user:)
+          )
+        end
+
+        def blast_messages!(message_blast:)
+          # Only blast messages to existing users that are brand new
+          return if @existing_record
+          return unless existing_users
+
+          User.all.each do |u|
+            InboxService::Message::Send.(
+              user: u,
+              text: text,
+              title: title,
+              message_blast: message_blast,
+            )
+          end
+        end
+
+        def record
+          return MessageBlast.new if id.nil?
+
+          record = MessageBlast.where(id:).first
+          inline_argument_failure!(errors: { id: "Message Blast ID does not exist" }) if record.nil?
+
+          @existing_record = true
+          record
+        end
+      end
+    end
+  end
+end

data/app/services/api_engine_base/inbox_service/message/metadata.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module InboxService
+    module Message
+      class Metadata < ApiEngineBase::ServiceBase
+        on_argument_validation :fail_early
+
+        validate :user, is_a: User, required: true
+
+        def call
+          entities = ::Message.where(user:).select(:id, :title, :viewed).map do |message|
+            ApiEngineBase::Schema::Inbox::MessageEntity.new(
+              title:  message.title,
+              id:  message.id,
+              viewed:  message.viewed,
+            )
+          end
+
+          params = {
+            entities: entities.nil? ? nil : entities,
+            count: entities.length,
+          }
+
+          context.metadata = ApiEngineBase::Schema::Inbox::Metadata.new(**params.compact)
+        end
+      end
+    end
+  end
+end
+
+
+
+
+

data/app/services/api_engine_base/inbox_service/message/modify.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module InboxService
+    module Message
+      class Modify < ApiEngineBase::ServiceBase
+        on_argument_validation :fail_early
+
+        IS_ONE = [
+          VIEWED = :viewed,
+          DELETE = :delete,
+        ]
+        validate :user, is_a: User, required: true
+        validate :ids, is_a: Array, required: true
+        validate :type, is_one: IS_ONE, required: true
+
+        def call
+          messages = ::Message.where(user:, id: ids)
+          if messages.empty?
+            inline_argument_failure!(errors: { ids: "No ID's found for user" })
+          end
+
+          case type
+          when VIEWED
+            modified_ids = messages.update(viewed: true).pluck(:id)
+          when DELETE
+            modified_ids = messages.destroy_all.pluck(:id)
+          end
+
+          context.modified = ApiEngineBase::Schema::Inbox::Modified.new(
+            ids: modified_ids,
+            type:,
+            count: modified_ids.length,
+          )
+        end
+      end
+    end
+  end
+end
+
+
+
+
+

data/app/services/api_engine_base/inbox_service/message/retrieve.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module InboxService
+    module Message
+      class Retrieve < ApiEngineBase::ServiceBase
+        on_argument_validation :fail_early
+
+        validate :user, is_a: User, required: true
+        validate :id, is_a: Integer, required: true
+
+        def call
+          message = ::Message.where(user:, id:).first
+
+          if message.nil?
+            inline_argument_failure!(errors: { id: "Message ID not found for user" })
+          end
+
+          message.update!(viewed: true)
+
+          context.message = ApiEngineBase::Schema::Inbox::MessageEntity.new(
+            title: message.title,
+            id: message.id,
+            text: message.text,
+            viewed: message.viewed,
+          )
+        end
+      end
+    end
+  end
+end
+
+
+
+
+

data/app/services/api_engine_base/inbox_service/message/send.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module InboxService
+    module Message
+      class Send  < ApiEngineBase::ServiceBase
+        validate :user, is_a: User, required: true
+        validate :text, is_a: String, required: true
+        validate :title, is_a: String, required: true
+        validate :message_blast, is_a: ::MessageBlast, required: false
+        validate :pushed, is_one: [true, false], default: false
+
+        def call
+          message = create_message!
+          context.message = message
+        end
+
+        def push_notification!
+          # TODO: Push notifications
+        end
+
+        def create_message!
+          ::Message.create!(
+            user:,
+            text: ,
+            title: ,
+            message_blast:,
+          )
+        end
+      end
+    end
+  end
+end

data/app/services/api_engine_base/login_strategy/plain_text/create.rb

@@ -34,6 +34,7 @@ module ApiEngineBase::LoginStrategy::PlainText
 
       if user.save
         context.user = user
+        ApiEngineBase::InboxService::Blast::NewUserBlaster.(user:)
       else
         inline_argument_failure!(errors: user.errors)
       end

data/config/routes.rb

@@ -26,6 +26,27 @@ Rails.application.routes.draw do
     post "/modify", to: "api_engine_base/user#modify", as: :"#{append_to_ass}_user_modify_post"
   end
 
+  scope "inbox" do
+    scope "messages" do
+      get "/", to: "api_engine_base/inbox/message#metadata", as: :"#{append_to_ass}_inbox_metadata"
+
+      get "/:id", to: "api_engine_base/inbox/message#message", as: :"#{append_to_ass}_inbox_message"
+      delete "/:id", to: "api_engine_base/inbox/message#delete", as: :"#{append_to_ass}_inbox_message_del"
+
+      post "/ack", to: "api_engine_base/inbox/message#ack", as: :"#{append_to_ass}_inbox_ack"
+      post "/delete", to: "api_engine_base/inbox/message#delete", as: :"#{append_to_ass}_inbox_delete"
+    end
+
+    scope "blast" do
+      get "/", to: "api_engine_base/inbox/message_blast#metadata", as: :"#{append_to_ass}_blast_metadata"
+      post "/", to: "api_engine_base/inbox/message_blast#create", as: :"#{append_to_ass}_blast_create"
+
+      get "/:id", to: "api_engine_base/inbox/message_blast#blast", as: :"#{append_to_ass}_blast_blast"
+      patch "/:id", to: "api_engine_base/inbox/message_blast#modify", as: :"#{append_to_ass}_blast_modify"
+      delete "/:id", to: "api_engine_base/inbox/message_blast#delete", as: :"#{append_to_ass}_blast_delete"
+    end
+  end
+
   scope "admin" do
     get "/", to: "api_engine_base/admin#show", as: :"#{append_to_ass}_admin_show_get"
     post "/modify", to: "api_engine_base/admin#modify", as: :"#{append_to_ass}_admin_modify_post"

data/db/migrate/20250223023306_create_api_engine_base_messages.rb

@@ -0,0 +1,12 @@
+class CreateApiEngineBaseMessages < ActiveRecord::Migration[7.2]
+  def change
+    create_table :messages do |t|
+      t.timestamps
+      t.references :user, null: false, foreign_key: true # Required
+      t.text :text
+      t.string :title
+      t.boolean :viewed, default: false
+      t.boolean :pushed, default: false
+    end
+  end
+end

data/db/migrate/20250223023313_create_api_engine_base_message_blasts.rb

@@ -0,0 +1,14 @@
+class CreateApiEngineBaseMessageBlasts < ActiveRecord::Migration[7.2]
+  def change
+    create_table :message_blasts do |t|
+      t.timestamps
+      t.references :user, null: false, foreign_key: true # Required
+      t.text :text
+      t.string :title
+      t.boolean :existing_users, default: false
+      t.boolean :new_users, default: false
+    end
+
+    add_reference :messages, :message_blast, foreign_key: true, null: true
+  end
+end

data/lib/api_engine_base/authorization/default.yml

@@ -9,18 +9,26 @@ groups:
       the ability to view and update other users states.
     entities:
       - admin
+      - message-blast
   admin-without-impersonation:
     description: |
       This group defines permissions for Admin Read and Write operations. Users with this role will have
       the ability to view and update other users states. However, impersonation is not permitted with this role
     entities:
       - admin-without-impersonate
+      - message-blast
   admin-read-only:
     description: |
       This group defines permissions for Admin Read interface only.
     entities:
       - read-admin
+      - message-blast-read-only
 entities:
+  - name: message-blast
+    controller: ApiEngineBase::Inbox::MessageBlastController
+  - name: message-blast-read-only
+    controller: ApiEngineBase::Inbox::MessageBlastController
+    only: metadata
   - name: read-admin
     controller: ApiEngineBase::AdminController
     only: show

data/lib/api_engine_base/schema/inbox/blast_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module Schema
+    module Inbox
+      class BlastRequest < JsonSchematize::Generator
+        add_field name: :existing_users, type: JsonSchematize::Boolean
+        add_field name: :new_users, type: JsonSchematize::Boolean
+        add_field name: :title, type: String
+        add_field name: :text, type: String
+        add_field name: :id, type: Integer, required: false
+      end
+    end
+  end
+end

data/lib/api_engine_base/schema/inbox/blast_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module Schema
+    module Inbox
+      class BlastResponse < JsonSchematize::Generator
+        add_field name: :created_by, type: ApiEngineBase::Schema::User
+        add_field name: :existing_users, type: JsonSchematize::Boolean
+        add_field name: :new_users, type: JsonSchematize::Boolean
+        add_field name: :title, type: String
+        add_field name: :text, type: String
+        add_field name: :id, type: Integer, required: false
+      end
+    end
+  end
+end

data/lib/api_engine_base/schema/inbox/message_blast_entity.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module Schema
+    module Inbox
+      class MessageBlastEntity < JsonSchematize::Generator
+        add_field name: :created_by, type: ApiEngineBase::Schema::User, required: false # to allow metadata call to be fast
+        add_field name: :text, type: String, required: false # to allow metadata call to be fast
+        add_field name: :title, type: String
+        add_field name: :id, type: Integer
+        add_field name: :existing_users, type: JsonSchematize::Boolean
+        add_field name: :new_users, type: JsonSchematize::Boolean
+      end
+    end
+  end
+end

data/lib/api_engine_base/schema/inbox/message_blast_metadata.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "api_engine_base/schema/inbox/message_blast_entity"
+require "api_engine_base/schema/page"
+
+module ApiEngineBase
+  module Schema
+    module Inbox
+      class MessageBlastMetadata < JsonSchematize::Generator
+        add_field name: :entities, array_of_types: true, type: ApiEngineBase::Schema::Inbox::MessageBlastEntity, required: false
+        add_field name: :count, type: Integer
+        add_field name: :pagination, type: ApiEngineBase::Schema::Page, required: false
+      end
+    end
+  end
+end

data/lib/api_engine_base/schema/inbox/message_entity.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module Schema
+    module Inbox
+      class MessageEntity < JsonSchematize::Generator
+        add_field name: :title, type: String
+        add_field name: :id, type: Integer
+        add_field name: :text, type: String, required: false
+        add_field name: :viewed, type: JsonSchematize::Boolean
+      end
+    end
+  end
+end

data/lib/api_engine_base/schema/inbox/metadata.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "api_engine_base/schema/inbox/message_entity"
+require "api_engine_base/schema/page"
+
+module ApiEngineBase
+  module Schema
+    module Inbox
+      class Metadata < JsonSchematize::Generator
+        # schema_default option: :dig_type, value: :string
+
+        add_field name: :entities, array_of_types: true, type: ApiEngineBase::Schema::Inbox::MessageEntity, required: false
+        add_field name: :count, type: Integer
+        add_field name: :pagination, type: ApiEngineBase::Schema::Page, required: false
+      end
+    end
+  end
+end

data/lib/api_engine_base/schema/inbox/modified.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module Schema
+    module Inbox
+      class Modified < JsonSchematize::Generator
+        add_field name: :type, type: Symbol
+        add_field name: :ids, type: Array
+        add_field name: :count, type: Integer
+      end
+    end
+  end
+end

data/lib/api_engine_base/schema.rb

@@ -26,5 +26,13 @@ module ApiEngineBase
 
     require "api_engine_base/schema/user"
     require "api_engine_base/schema/page"
+
+    require "api_engine_base/schema/inbox/metadata"
+    require "api_engine_base/schema/inbox/message_entity"
+    require "api_engine_base/schema/inbox/modified"
+    require "api_engine_base/schema/inbox/blast_response"
+    require "api_engine_base/schema/inbox/blast_request"
+    require "api_engine_base/schema/inbox/message_blast_entity"
+    require "api_engine_base/schema/inbox/message_blast_metadata"
   end
 end

data/lib/api_engine_base/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApiEngineBase
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_engine_base
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - matt-taylor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rotp
@@ -122,15 +122,18 @@ files:
 - app/controllers/api_engine_base/admin_controller.rb
 - app/controllers/api_engine_base/application_controller.rb
 - app/controllers/api_engine_base/auth/plain_text_controller.rb
+- app/controllers/api_engine_base/inbox/message_blast_controller.rb
+- app/controllers/api_engine_base/inbox/message_controller.rb
 - app/controllers/api_engine_base/user_controller.rb
 - app/controllers/api_engine_base/username_controller.rb
-- app/controllers/concerns/api_engine_base/schematizable.rb
 - app/helpers/api_engine_base/application_helper.rb
 - app/helpers/api_engine_base/schema_helper.rb
 - app/jobs/api_engine_base/application_job.rb
 - app/mailers/api_engine_base/application_mailer.rb
 - app/mailers/api_engine_base/email_verification_mailer.rb
 - app/models/api_engine_base/application_record.rb
+- app/models/message.rb
+- app/models/message_blast.rb
 - app/models/user.rb
 - app/models/user_secret.rb
 - app/services/api_engine_base/README.md
@@ -139,6 +142,15 @@ files:
 - app/services/api_engine_base/argument_validation/class_methods.rb
 - app/services/api_engine_base/argument_validation/instance_methods.rb
 - app/services/api_engine_base/authorize/validate.rb
+- app/services/api_engine_base/inbox_service/blast/delete.rb
+- app/services/api_engine_base/inbox_service/blast/metadata.rb
+- app/services/api_engine_base/inbox_service/blast/new_user_blaster.rb
+- app/services/api_engine_base/inbox_service/blast/retrieve.rb
+- app/services/api_engine_base/inbox_service/blast/upsert.rb
+- app/services/api_engine_base/inbox_service/message/metadata.rb
+- app/services/api_engine_base/inbox_service/message/modify.rb
+- app/services/api_engine_base/inbox_service/message/retrieve.rb
+- app/services/api_engine_base/inbox_service/message/send.rb
 - app/services/api_engine_base/jwt/authenticate_user.rb
 - app/services/api_engine_base/jwt/decode.rb
 - app/services/api_engine_base/jwt/encode.rb
@@ -163,6 +175,8 @@ files:
 - config/routes.rb
 - db/migrate/20241117043720_create_api_engine_base_users.rb
 - db/migrate/20241204065708_create_api_engine_base_user_secrets.rb
+- db/migrate/20250223023306_create_api_engine_base_messages.rb
+- db/migrate/20250223023313_create_api_engine_base_message_blasts.rb
 - lib/api_engine_base.rb
 - lib/api_engine_base/authorization.rb
 - lib/api_engine_base/authorization/default.yml
@@ -190,6 +204,13 @@ files:
 - lib/api_engine_base/schema/error/base.rb
 - lib/api_engine_base/schema/error/invalid_argument.rb
 - lib/api_engine_base/schema/error/invalid_argument_response.rb
+- lib/api_engine_base/schema/inbox/blast_request.rb
+- lib/api_engine_base/schema/inbox/blast_response.rb
+- lib/api_engine_base/schema/inbox/message_blast_entity.rb
+- lib/api_engine_base/schema/inbox/message_blast_metadata.rb
+- lib/api_engine_base/schema/inbox/message_entity.rb
+- lib/api_engine_base/schema/inbox/metadata.rb
+- lib/api_engine_base/schema/inbox/modified.rb
 - lib/api_engine_base/schema/page.rb
 - lib/api_engine_base/schema/plain_text/create_user_request.rb
 - lib/api_engine_base/schema/plain_text/create_user_response.rb

data/app/controllers/concerns/api_engine_base/schematizable.rb

@@ -1,5 +0,0 @@
-module ApiEngineBase
-  class Schematizable
-  end
-end
-