api_engine_base 0.1.1 → 0.2.0

data/lib/api_engine_base/configuration/user/config.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "class_composer"
+
+module ApiEngineBase
+  module Configuration
+    module User
+      class Config
+        include ClassComposer::Generator
+
+        ATTRIBUTES_TO_CHANGE = [
+          :email,
+          :first_name,
+          :last_name,
+          :last_known_timezone,
+          :username,
+          :verifier_token,
+        ]
+
+        ATTRIBUTES_TO_SHOW = [
+          *ATTRIBUTES_TO_CHANGE,
+          :id,
+          :roles,
+          :created_at,
+        ]
+
+        ATTRIBUTES_CHANGE_EXECUTE = Proc.new do |key, value|
+          ApiEngineBase::UserAttributes::Modify.assign!
+        end
+
+        ATTRIBUTES_SHOWN_EXECUTE = Proc.new do |key, value|
+          ApiEngineBase::Schema::User.assign!
+        end
+
+        add_composer :additional_attributes_for_change,
+          desc: "On top of the default attributes to change, this adds additional values for the user to change on their account",
+          allowed: Array,
+          default: [],
+          default_shown: "[]"
+
+        add_composer :default_attributes_for_change,
+          desc: "[Not Recommended for change] Default attributes that are allowed to change",
+          allowed: Array,
+          default: ATTRIBUTES_TO_CHANGE,
+          &ATTRIBUTES_CHANGE_EXECUTE
+
+        add_composer :default_attributes,
+          desc: "[Not Recommended for change] Default attributes that are shown to the user",
+          allowed: Array,
+          default_shown: ATTRIBUTES_TO_SHOW,
+          dynamic_default: -> (instance) { (ATTRIBUTES_TO_SHOW + instance.additional_attributes_for_change).uniq },
+          &ATTRIBUTES_SHOWN_EXECUTE
+      end
+    end
+  end
+end

data/lib/api_engine_base/engine.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "api_engine_base/authorization"
 require "api_engine_base/schema"
 
 module ApiEngineBase
@@ -8,14 +9,45 @@ module ApiEngineBase
 
     # Run after Rails loads the initializes and environment files
     # Ensures User has already set their desired config before we lock this down
-    initializer "api_engine_base.config.instantiate", after: :load_config_initializers do |_app|
-      # ensure defaults are instantiated and all variables are assigned
-      ApiEngineBase.config.class_composer_assign_defaults!(children: true)
+    config.after_initialize do
+      db_rake_task = defined?(Rake) && (Rake.application.top_level_tasks.any? { |task| task =~ /db:/ } rescue nil)
+      if db_rake_task
+        # Because we call the Database during configuration setup,
+        # We want to skip calling the DB during a DB migration
+      else
+        # ensure defaults are instantiated and all variables are assigned
+        ApiEngineBase.config.class_composer_assign_defaults!(children: true)
 
-      unless Rails.env.test?
-        # Now that we can confirm all variables are defined, freeze all objects an their children
-        ApiEngineBase.config.class_composer_freeze_objects!(behavior: :raise, children: true)
+        unless Rails.env.test?
+          # Now that we can confirm all variables are defined, freeze all objects an their children
+          ApiEngineBase.config.class_composer_freeze_objects!(behavior: :raise, children: true)
+        end
       end
     end
+
+
+    ####
+    # Bug: @matt-taylor
+    # RBAC code memoizes the controller object into a class variable
+    # In development when code changes, all classes get reloaded
+    # Inherently, this causes the `object_id` of the class to change
+    # This means the memoized class is no longer equal to the newly reloaded class
+    # NOTE: This is only a problem on reload! in development. Not an issue in Production
+    # Once this is fixed, it can go into a regular initializer and does not need to get re-computed on each reload
+    ###
+    # Potential solution:
+    # => Don't store the object as the comparison key
+    # => Or...When doing comparisons, convert everything to a string for comparison
+    #    Changes to names should be infrequent/should have a full app restart
+
+    # Add all RBAC based role definitions prior to fork/loading
+    # Load once use forever
+    config.to_prepare do
+      ApiEngineBase::Authorization::Role.roles_reset!
+      ApiEngineBase::Authorization::Entity.entities_reset!
+      ApiEngineBase::Authorization.mapped_controllers_reset!
+
+      ApiEngineBase::Authorization.default_defined!
+    end
   end
 end

data/lib/api_engine_base/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  class Error < StandardError; end
+end

data/lib/api_engine_base/schema/admin/users.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "api_engine_base/schema/user"
+require "api_engine_base/schema/page"
+
+module ApiEngineBase
+  module Schema
+    module Admin
+      class Users < JsonSchematize::Generator
+        add_field name: :users, array_of_types: true, type: ApiEngineBase::Schema::User
+        add_field name: :pagination, type: ApiEngineBase::Schema::Page, required: false
+      end
+    end
+  end
+end

data/lib/api_engine_base/schema/error/invalid_argument_response.rb

@@ -9,7 +9,7 @@ module ApiEngineBase
         add_field name: :message, type: String, required: true
         add_field name: :status, type: String, required: true
         add_field name: :invalid_arguments, array_of_types: true, type: InvalidArgument
-        add_field name: :invalid_argument_keys,  type: Array
+        add_field name: :invalid_argument_keys, type: Array
       end
     end
   end

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/page.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module Schema
+    class Page < JsonSchematize::Generator
+      schema_default option: :dig_type, value: :string
+
+      add_field name: :count, type: Integer
+      add_field name: :cursor, type: Integer
+      add_field name: :limit, type: Integer
+      add_field name: :next, type: String
+    end
+  end
+end

data/lib/api_engine_base/schema/user.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module Schema
+    class User < JsonSchematize::Generator
+      schema_default option: :dig_type, value: :string
+
+      def self.convert_user_object(user:)
+        attributes = ApiEngineBase.config.user.default_attributes.map(&:to_s)
+        object = user.attributes.slice(*attributes)
+
+        new(object)
+      end
+
+      # Gets assigned during configuration phase via
+      # lib/api_engine_base/configuration/user/config.rb
+      def self.assign!
+        attributes = ApiEngineBase.config.user.default_attributes
+        attributes.each do |attribute|
+          if metadata = ::User.attribute_to_type_mapping[attribute]
+            type = metadata[:serialized_type] ? metadata[:serialized_type] : metadata[:base]
+            add_field(name: attribute, type:)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/api_engine_base/schema.rb

@@ -21,5 +21,18 @@ module ApiEngineBase
 
     require "api_engine_base/schema/plain_text/login_request"
     require "api_engine_base/schema/plain_text/login_response"
+
+    require "api_engine_base/schema/admin/users"
+
+    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/spec_helper.rb

@@ -2,17 +2,18 @@
 
 module ApiEngineBase
   module SpecHelper
-    def set_jwt_token!(user:, token: nil)
+    def set_jwt_token!(user:, with_reset: false, token: nil)
       if token.nil?
         result = ApiEngineBase::Jwt::LoginCreate.(user:)
         token = result.token
       end
 
-      @request.headers[ApiEngineBase::ApplicationController::AUTHORIZATION_HEADER] = "Bearer: #{token}"
+      @request.headers[ApiEngineBase::ApplicationController::AUTHENTICATION_HEADER] = "Bearer: #{token}"
+      @request.headers[ApiEngineBase::ApplicationController::AUTHENTICATION_WITH_RESET] = "true" if with_reset
     end
 
     def unset_jwt_token!
-      @request.headers[ApiEngineBase::ApplicationController::AUTHORIZATION_HEADER] = nil
+      @request.headers[ApiEngineBase::ApplicationController::AUTHENTICATION_HEADER] = nil
     end
   end
 end

data/lib/api_engine_base/version.rb

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

data/lib/api_engine_base.rb

@@ -1,10 +1,10 @@
+require "api_engine_base/error"
+
 require "api_engine_base/version"
 require "api_engine_base/engine"
 require "api_engine_base/configuration/config"
 
 module ApiEngineBase
-  class Error < StandardError; end
-
   def self.config
     @config ||= Configuration::Config.new
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_engine_base
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - matt-taylor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-02 00:00:00.000000000 Z
+date: 2025-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rotp
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
 description: ApiEngineBase is the Base API to handle all the things you don't want
   to for a Rails API only backend serving a Dedicated frontend
 email:
@@ -119,21 +119,38 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- 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
 - app/services/api_engine_base/argument_validation.rb
+- app/services/api_engine_base/argument_validation/README.md
 - 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
@@ -151,13 +168,23 @@ files:
 - app/services/api_engine_base/secrets/verify.rb
 - app/services/api_engine_base/service_base.rb
 - app/services/api_engine_base/service_logging.rb
+- app/services/api_engine_base/user_attributes/modify.rb
+- app/services/api_engine_base/user_attributes/roles.rb
 - app/services/api_engine_base/username/available.rb
 - app/views/api_engine_base/email_verification_mailer/verify_email.html.erb
 - 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
+- lib/api_engine_base/authorization/entity.rb
+- lib/api_engine_base/authorization/role.rb
+- lib/api_engine_base/configuration/admin/config.rb
 - lib/api_engine_base/configuration/application/config.rb
+- lib/api_engine_base/configuration/authorization/config.rb
 - lib/api_engine_base/configuration/base.rb
 - lib/api_engine_base/configuration/config.rb
 - lib/api_engine_base/configuration/email/config.rb
@@ -167,13 +194,24 @@ files:
 - lib/api_engine_base/configuration/login/strategy/plain_text/email_verify.rb
 - lib/api_engine_base/configuration/login/strategy/plain_text/lockable.rb
 - lib/api_engine_base/configuration/otp/config.rb
+- lib/api_engine_base/configuration/user/config.rb
 - lib/api_engine_base/configuration/username/check.rb
 - lib/api_engine_base/configuration/username/config.rb
 - lib/api_engine_base/engine.rb
+- lib/api_engine_base/error.rb
 - lib/api_engine_base/schema.rb
+- lib/api_engine_base/schema/admin/users.rb
 - 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
 - lib/api_engine_base/schema/plain_text/email_verify_request.rb
@@ -182,6 +220,7 @@ files:
 - lib/api_engine_base/schema/plain_text/email_verify_send_response.rb
 - lib/api_engine_base/schema/plain_text/login_request.rb
 - lib/api_engine_base/schema/plain_text/login_response.rb
+- lib/api_engine_base/schema/user.rb
 - lib/api_engine_base/spec_helper.rb
 - lib/api_engine_base/version.rb
 - lib/generators/api_engine_base/configure/USAGE

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

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