command_tower 0.3.0

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

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

data/lib/command_tower/schema/error/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "json_schematize/generator"
+
+module CommandTower
+  module Schema
+    module Error
+      class Base < JsonSchematize::Generator
+        add_field name: :status, type: String
+        add_field name: :message, type: String
+      end
+    end
+  end
+end
+

data/lib/command_tower/schema/error/invalid_argument.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module Error
+      class InvalidArgument < JsonSchematize::Generator
+        add_field name: :schema, type: JsonSchematize::Generator, required: true, converter: ->(val) { val }
+        add_field name: :argument, type: String, required: true
+        add_field name: :argument_type, type: String, required: true
+        add_field name: :reason, type: String
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "command_tower/schema/error/invalid_argument"
+
+module CommandTower
+  module Schema
+    module Error
+      class InvalidArgumentResponse < JsonSchematize::Generator
+        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
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CommandTower
+  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/command_tower/schema/inbox/blast_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module Inbox
+      class BlastResponse < JsonSchematize::Generator
+        add_field name: :created_by, type: CommandTower::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/command_tower/schema/inbox/message_blast_entity.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module Inbox
+      class MessageBlastEntity < JsonSchematize::Generator
+        add_field name: :created_by, type: CommandTower::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/command_tower/schema/inbox/message_blast_metadata.rb

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

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CommandTower
+  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/command_tower/schema/inbox/metadata.rb

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

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CommandTower
+  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/command_tower/schema/page.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CommandTower
+  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/command_tower/schema/plain_text/create_user_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module PlainText
+      class CreateUserRequest < JsonSchematize::Generator
+        schema_default option: :dig_type, value: :string
+
+        add_field name: :first_name, type: String, required: false
+        add_field name: :last_name, type: String, required: false
+        add_field name: :username, type: String, required: false
+        add_field name: :email, type: String, required: false
+        add_field name: :password, type: String, required: false
+        add_field name: :password_confirmation, type: String, required: false
+      end
+    end
+  end
+end

data/lib/command_tower/schema/plain_text/create_user_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module PlainText
+      class CreateUserResponse < JsonSchematize::Generator
+        add_field name: :full_name, type: String
+        add_field name: :first_name, type: String
+        add_field name: :last_name, type: String
+        add_field name: :username, type: String
+        add_field name: :email, type: String
+        add_field name: :msg, type: String
+      end
+    end
+  end
+end
+

data/lib/command_tower/schema/plain_text/email_verify_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module PlainText
+      class EmailVerifyRequest < JsonSchematize::Generator
+        add_field name: :code, type: String
+      end
+    end
+  end
+end

data/lib/command_tower/schema/plain_text/email_verify_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module PlainText
+      class EmailVerifyResponse< JsonSchematize::Generator
+        add_field name: :message, type: String
+      end
+    end
+  end
+end

data/lib/command_tower/schema/plain_text/email_verify_send_request.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module PlainText
+      class EmailVerifySendRequest < JsonSchematize::Generator; end
+    end
+  end
+end

data/lib/command_tower/schema/plain_text/email_verify_send_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module PlainText
+      class EmailVerifySendResponse< JsonSchematize::Generator
+        add_field name: :message, type: String
+      end
+    end
+  end
+end

data/lib/command_tower/schema/plain_text/login_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module PlainText
+      class LoginRequest < JsonSchematize::Generator
+        schema_default option: :dig_type, value: :string
+
+        add_field name: :username, type: String, required: false
+        add_field name: :email, type: String, required: false
+        add_field name: :password, type: String, required: false
+      end
+    end
+  end
+end

data/lib/command_tower/schema/plain_text/login_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    module PlainText
+      class LoginResponse < JsonSchematize::Generator
+        add_field name: :token, type: String
+        add_field name: :header_name, type: String
+        add_field name: :message, type: String
+      end
+    end
+  end
+end

data/lib/command_tower/schema/user.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    class User < JsonSchematize::Generator
+      schema_default option: :dig_type, value: :string
+
+      def self.convert_user_object(user:)
+        attributes = CommandTower.config.user.default_attributes.map(&:to_s)
+        object = user.attributes.slice(*attributes)
+
+        new(object)
+      end
+
+      # Gets assigned during configuration phase via
+      # lib/command_tower/configuration/user/config.rb
+      def self.assign!
+        attributes = CommandTower.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/command_tower/schema.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module Schema
+    require "json_schematize"
+    require "json_schematize/generator"
+
+    ## Generic Error Schemas
+    require "command_tower/schema/error/base"
+    require "command_tower/schema/error/invalid_argument_response"
+
+    ## Plain Text Controller
+    require "command_tower/schema/plain_text/create_user_response"
+    require "command_tower/schema/plain_text/create_user_request"
+
+    require "command_tower/schema/plain_text/email_verify_request"
+    require "command_tower/schema/plain_text/email_verify_response"
+
+    require "command_tower/schema/plain_text/email_verify_send_response"
+    require "command_tower/schema/plain_text/email_verify_send_request"
+
+    require "command_tower/schema/plain_text/login_request"
+    require "command_tower/schema/plain_text/login_response"
+
+    require "command_tower/schema/admin/users"
+
+    require "command_tower/schema/user"
+    require "command_tower/schema/page"
+
+    require "command_tower/schema/inbox/metadata"
+    require "command_tower/schema/inbox/message_entity"
+    require "command_tower/schema/inbox/modified"
+    require "command_tower/schema/inbox/blast_response"
+    require "command_tower/schema/inbox/blast_request"
+    require "command_tower/schema/inbox/message_blast_entity"
+    require "command_tower/schema/inbox/message_blast_metadata"
+  end
+end

data/lib/command_tower/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CommandTower
+  module SpecHelper
+    def set_jwt_token!(user:, with_reset: false, token: nil)
+      if token.nil?
+        result = CommandTower::Jwt::LoginCreate.(user:)
+        token = result.token
+      end
+
+      @request.headers[CommandTower::ApplicationController::AUTHENTICATION_HEADER] = "Bearer: #{token}"
+      @request.headers[CommandTower::ApplicationController::AUTHENTICATION_WITH_RESET] = "true" if with_reset
+    end
+
+    def unset_jwt_token!
+      @request.headers[CommandTower::ApplicationController::AUTHENTICATION_HEADER] = nil
+    end
+  end
+end

data/lib/command_tower/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CommandTower
+  VERSION = "0.3.0"
+end

data/lib/command_tower.rb

@@ -0,0 +1,33 @@
+require "command_tower/error"
+
+require "command_tower/version"
+require "command_tower/engine"
+require "command_tower/configuration/config"
+
+module CommandTower
+  def self.config
+    @config ||= Configuration::Config.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  def self.config=(configuration)
+    raise ArgumentError, "Expected Configuration::Config. Given #{configuration.class}" unless Configuration::Config === configuration
+
+    @config = configuration
+  end
+
+  def self.app_name
+    Proc === config.app.app_name ? config.app.app_name.() : config.app.app_name
+  end
+
+  def self.app_name_for_comms
+    Proc === config.app.communication_name ? config.app.communication_name.() : config.app.communication_name
+  end
+
+  def self.default_app_name
+    ::Rails.application.class.module_parent_name
+  end
+end

data/lib/generators/api_engine_base/configure/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates a default Configuration file for the ApiBaseEngine.
+
+Example:
+    bin/rails generate command_tower:configure
+
+    This will create:
+        config/initializers/command_tower.rb

data/lib/generators/api_engine_base/configure/configure_generator.rb

@@ -0,0 +1,12 @@
+class CommandTower::ConfigureGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def create_config_file
+    create_file Rails.root.join("config", "initializers", "command_tower.rb"),
+      CommandTower.config.class.composer_generate_config(wrapping: "CommandTower.configure", require_file: "command_tower")
+  end
+
+  def create_route
+    route "mount CommandTower::Engine => \"/\""
+  end
+end

data/lib/tasks/auto_annotate_models.rake

@@ -0,0 +1,60 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+
+# if Rails.env.development?
+  require 'annotate'
+  task :set_annotation_options do
+    # You can override any of these by setting an environment variable of the
+    # same name.
+    Annotate.set_defaults(
+      'active_admin'                => 'false',
+      'additional_file_patterns'    => [],
+      'routes'                      => 'false',
+      'models'                      => 'true',
+      'position_in_routes'          => 'before',
+      'position_in_class'           => 'before',
+      'position_in_test'            => 'before',
+      'position_in_fixture'         => 'before',
+      'position_in_factory'         => 'before',
+      'position_in_serializer'      => 'before',
+      'show_foreign_keys'           => 'true',
+      'show_complete_foreign_keys'  => 'false',
+      'show_indexes'                => 'true',
+      'simple_indexes'              => 'false',
+      'model_dir'                   => 'app/models',
+      'root_dir'                    => '',
+      'include_version'             => 'false',
+      'require'                     => '',
+      'exclude_tests'               => 'false',
+      'exclude_fixtures'            => 'false',
+      'exclude_factories'           => 'false',
+      'exclude_serializers'         => 'false',
+      'exclude_scaffolds'           => 'true',
+      'exclude_controllers'         => 'true',
+      'exclude_helpers'             => 'true',
+      'exclude_sti_subclasses'      => 'false',
+      'ignore_model_sub_dir'        => 'false',
+      'ignore_columns'              => nil,
+      'ignore_routes'               => nil,
+      'ignore_unknown_models'       => 'false',
+      'hide_limit_column_types'     => 'integer,bigint,boolean',
+      'hide_default_column_types'   => 'json,jsonb,hstore',
+      'skip_on_db_migrate'          => 'false',
+      'format_bare'                 => 'true',
+      'format_rdoc'                 => 'false',
+      'format_yard'                 => 'false',
+      'format_markdown'             => 'false',
+      'sort'                        => 'false',
+      'force'                       => 'false',
+      'frozen'                      => 'false',
+      'classified_sort'             => 'true',
+      'trace'                       => 'false',
+      'wrapper_open'                => nil,
+      'wrapper_close'               => nil,
+      'with_comment'                => 'true'
+    )
+  end
+
+  Annotate.load_tasks
+# end