api_engine_base 0.1.1

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "class_composer"
+
+module ApiEngineBase
+  module Configuration
+    module Otp
+      class Config
+        include ClassComposer::Generator
+
+        add_composer :default_code_interval,
+          desc: "The length of time a code is good for",
+          allowed: ActiveSupport::Duration,
+          default: 30.seconds,
+          validator: -> (val) { (val <= 5.minutes) && (val >= 30.seconds) }
+
+        add_composer :default_code_length,
+          desc: "The default length of the OTP. Used when one not provided",
+          allowed: Integer,
+          default: 6,
+          validator: -> (val) { (val <= 10) && (val >= 4) },
+          invalid_message: ->(val) { "Provided #{val}. Value must be less than or equal to 10 and greater than or equal to 4." }
+
+        add_composer :secret_code_length,
+          desc: "The size of each users base32 Secret value generated",
+          allowed: Integer,
+          default: 32,
+          validator: -> (val) { (val <= 128) && (val >= 32) },
+          invalid_message: ->(val) { "Provided #{val}. Value must be less than or equal to 128 and greater than or equal to 32." }
+
+        add_composer :backup_code_length,
+          desc: "The length of each backup code for User",
+          allowed: Integer,
+          default: 32,
+          validator: -> (val) { (val <= 64) && (val >= 10) },
+          invalid_message: ->(val) { "Provided #{val}. Value must be less than or equal to 64 and greater than or equal to 20." }
+
+        add_composer :backup_code_count,
+          desc: "The number of backup codes that get generated",
+          allowed: Integer,
+          default: 10,
+          validator: -> (val) { (val <= 10) && (val >= 2) },
+          invalid_message: ->(val) { "Provided #{val}. Value must be less than or equal to 10 and greater than or equal to 2." }
+
+        add_composer :allowed_drift_behind,
+          desc: "Sometimes a user is just a tad slow. This allows a small drift behind to allow codes within drift to be accepted",
+          allowed: ActiveSupport::Duration,
+          default: 15.seconds,
+          validator: -> (val) { (val <= 15.seconds) && (val >= 0.seconds) },
+          invalid_message: ->(val) { "Provided #{val}. Value must be less than or equal to 15.seconds" }
+      end
+    end
+  end
+end

data/lib/api_engine_base/configuration/username/check.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "class_composer"
+
+module ApiEngineBase
+  module Configuration
+    module Username
+      class Check
+      include ClassComposer::Generator
+
+        add_composer :enable,
+          desc: "Enable Controller method for checking Real time username availability",
+          allowed: [FalseClass, TrueClass],
+          default: true
+
+        add_composer :local_cache,
+          desc: "Local Cache store. Instantiated before fork",
+          allowed: [ActiveSupport::Cache::MemoryStore, ActiveSupport::Cache::FileStore],
+          default: ActiveSupport::Cache::MemoryStore.new
+
+        add_composer :local_cache_ttl,
+          desc: "TTL on local cache data before data is invalidated and upstream is queried",
+          allowed: ActiveSupport::Duration,
+          default_shown: "1.minutes",
+          default: 1.minute,
+          validator: -> (val) { val < 60.minutes },
+          invalid_message: ->(val) { "Provided #{val}. Value must be less than #{60.minutes}" }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "class_composer"
+require "api_engine_base/configuration/username/check"
+
+module ApiEngineBase::Configuration
+  module Username
+    class Config
+      include ClassComposer::Generator
+
+      DEFAULT_MAX_LENGTH = 32
+      DEFAULT_MIN_LENGTH = 4
+
+      add_composer_blocking :realtime_username_check,
+        desc: "Adds components to check if the username is available in real time",
+        composer_class: Check,
+        enable_attr: :enable
+
+      add_composer :username_length_min,
+        desc: "Min Length for Username",
+        allowed: Integer,
+        default: DEFAULT_MIN_LENGTH
+
+      add_composer :username_length_max,
+        desc: "Max Length for Username",
+        allowed: Integer,
+        default: DEFAULT_MAX_LENGTH
+
+      add_composer :username_regex,
+        desc: "Regex for username.",
+        allowed: Regexp,
+        default: /\A\w{#{DEFAULT_MIN_LENGTH},#{DEFAULT_MAX_LENGTH}}\z/,
+        default_shown: "Regexp.new(\"/\A\w{#{DEFAULT_MIN_LENGTH},#{DEFAULT_MAX_LENGTH}}\z/\")"
+
+      add_composer :username_failure_message,
+        desc: "Max Length for Username",
+        allowed: String,
+        default: "Username length must be between #{DEFAULT_MIN_LENGTH} and #{DEFAULT_MAX_LENGTH}. Must contain only letters and/or numbers"
+    end
+  end
+end

data/lib/api_engine_base/engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "api_engine_base/schema"
+
+module ApiEngineBase
+  class Engine < ::Rails::Engine
+    isolate_namespace 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)
+
+      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
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "json_schematize/generator"
+
+module ApiEngineBase
+  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/api_engine_base/schema/error/invalid_argument.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  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/api_engine_base/schema/error/invalid_argument_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "api_engine_base/schema/error/invalid_argument"
+
+module ApiEngineBase
+  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/api_engine_base/schema/plain_text/create_user_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  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/api_engine_base/schema/plain_text/create_user_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  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/api_engine_base/schema/plain_text/email_verify_request.rb

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

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

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

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

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

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

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

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  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/api_engine_base/schema/plain_text/login_response.rb

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ApiEngineBase
+  module Schema
+    require "json_schematize"
+    require "json_schematize/generator"
+
+    ## Generic Error Schemas
+    require "api_engine_base/schema/error/base"
+    require "api_engine_base/schema/error/invalid_argument_response"
+
+    ## Plain Text Controller
+    require "api_engine_base/schema/plain_text/create_user_response"
+    require "api_engine_base/schema/plain_text/create_user_request"
+
+    require "api_engine_base/schema/plain_text/email_verify_request"
+    require "api_engine_base/schema/plain_text/email_verify_response"
+
+    require "api_engine_base/schema/plain_text/email_verify_send_response"
+    require "api_engine_base/schema/plain_text/email_verify_send_request"
+
+    require "api_engine_base/schema/plain_text/login_request"
+    require "api_engine_base/schema/plain_text/login_response"
+  end
+end

data/lib/api_engine_base/spec_helper.rb

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

data/lib/api_engine_base/version.rb

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

data/lib/api_engine_base.rb

@@ -0,0 +1,33 @@
+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
+
+  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 api_engine_base:configure
+
+    This will create:
+        config/initializers/api_engine_base.rb

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

@@ -0,0 +1,12 @@
+class ApiEngineBase::ConfigureGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def create_config_file
+    create_file Rails.root.join("config", "initializers", "api_engine_base.rb"),
+      ApiEngineBase.config.class.composer_generate_config(wrapping: "ApiEngineBase.configure", require_file: "api_engine_base")
+  end
+
+  def create_route
+    route "mount ApiEngineBase::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