Class: APIManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/crux/APIManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2023 Brick Mill Games, LLC, All rights reserved.

Overview

Class Method Registry

Class Method Details

generate_service_call(paths, group, service, method, language, cvarname) → Hash

This method will generate a source code snippet in a specified language to aid in software development.

Parameters:

• paths [Hash] — the directory LUT
• group [String] — the service group of the service
• service [String] — the name of the service
• method [String] — the name of the service method
• language [String] — the language of the source code to generate
• cvarname [String] — the name of the crux object variable name

Returns:

• [Hash] — the function declaration and source code body to copy/paste into source code.

---

get_crux_site_map → Hash

This class method returns a list of URL mappings used by this Crux installation.

Returns:

• [Hash] — the Crux application map

---

get_service_groups(paths) → Array<String>

This class method returns a list of service groups by reading the subfolder names in the services path

Parameters:

• paths [Hash] — the Crux arena's relevant paths
• :services [String] — the path to the services root directory
• :contracts [String] — the path to the contracts root directory
• :specs [String] — the path to the specs root directory
• :logs [String] — the path to the logs root directory
• :restart [String] — the path to the tmp/restart.txt file

Returns:

• [Array<String>] — the list of installed service groups

---

get_service_method_api(paths, group, service, method) → Hash

This class method returns the API of the specified service/method.

Parameters:

• paths [Hash] — the directory LUT
• group [String] — the service group of the service
• service [String] — the name of the service
• method [String] — the name of the service method

Returns:

• [Hash] — the API of the service method

---

get_service_method_list(paths, group, service) → Array<String>

This class method returns a list of methods provided by the specified service.

Parameters:

• paths [Hash] — the Crux arena's relevant paths
• :services [String] — the path to the services root directory
• :contracts [String] — the path to the contracts root directory
• :specs [String] — the path to the specs root directory
• :logs [String] — the path to the logs root directory
• :restart [String] — the path to the tmp/restart.txt file
• group [String] — the service group of the service
• service [String] — the name of the service to query

Returns:

• [Array<String>] — the list of methods provided by the specified service

---

get_services_list(paths, group) → Array<String>

This class method returns a list of services in the specified group

Parameters:

• paths [Hash] — the Crux arena's relevant paths
• :services [String] — the path to the services root directory
• :contracts [String] — the path to the contracts root directory
• :specs [String] — the path to the specs root directory
• :logs [String] — the path to the logs root directory
• :restart [String] — the path to the tmp/restart.txt file
• group [String] — the group to get search ('*' = all groups)

Returns:

• [Array<String>] — the list of group's services

---

get_services_manifest(client, paths) → Hash<Hash>

This class method returns a keyed hash of services that the Crux framework will find and try to load. There is no registration service. It simply scans the appropriate subfolder for files named xxxService.rb. Be wary of placing half-baked, untested ideas in there.

Parameters:

• client [Mysql2::Client] — the database connection
• paths [Hash] — the directory LUT

Returns:

• [Hash<Hash>] — the list of TOCS services complete with associated method/API information

---

make(paths, group) → Hash

This class method builds the service & contract boilerplate code from the specification(s)

Parameters:

• paths [Hash] — the Crux arena's relevant paths
• :services [String] — the path to the services root directory
• :contracts [String] — the path to the contracts root directory
• :specs [String] — the path to the specs root directory
• :logs [String] — the path to the logs root directory
• :restart [String] — the path to the tmp/restart.txt file
• group [String] — the service group to build ('*' = all groups, terminating '!' = force)

Returns:

• [Hash] — the result of the make
• make [Array<Hash>] — the make results
• service [String] — dot-name of the service being considered for building
• result [Mixed] — the result of the build

---

restart_server(paths) → Array<Hash>

This class method restarts the Rack server

Parameters:

• paths [Hash] — the Crux arena's relevant paths
• :services [String] — the path to the services root directory
• :contracts [String] — the path to the contracts root directory
• :specs [String] — the path to the specs root directory
• :logs [String] — the path to the logs root directory
• :restart [String] — the path to the tmp/restart.txt file

Returns:

• [Array<Hash>] — the list of URL mappings

---

Class: AuthManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/crux/AuthManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Class Method Registry

Class Method Details

authenticate(client, ipaddr, app, username, password, force) → Hash

Parameters:

• client [Mysql2::Client] — the database connection
• ipaddr [String] — the IP address of the user's web client connection
• app [String] — the app to login to
• username [String] — the user's username (login name)
• password [String] — the user's password
• force [Boolean] — true, if the user is attempting a forced re-connection (recovery from an Internet connection drop)

Returns:

• [Hash] — the successful authentication information
• :uid [Uid] — the user's 32-bit hexadecimal user identification
• :username [String] — the user's username
• :realname [String] — the user's real (or display) name
• :email [String] — the user's email address
• :roles [Array<String>] — the user's named roles / privileges
• :jwt [String] — the user's new session credentials

---

logout(client, jwt) → Boolean

Parameters:

• client [Mysql2::Client] — the database connection
• jwt [String] — the user's previously-authenticated credentials

Returns:

• [Boolean] — the result of the expire call

---

reconnect(client, ipaddr, jwt) → Hash

Parameters:

• client [Mysql2::Client] — the database connection
• ipaddr [String] — the IP address of the user's current web client connection
• jwt [String] — the user's previously-authenticated credentials

Returns:

• [Hash] — the successful authentication information
• :uid [Uid] — the user's 32-bit hexadecimal user identification
• :username [String] — the user's username
• :realname [String] — the user's real (or display) name
• :email [String] — the user's email address
• :roles [Integer] — the user's privileges

---

Class: AuthServices ← Sinatra::Base

File Manifest

File Manifest

File	Language	Author(s)	Copyright
crux-server.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022, Brick Mill Games, LLC, all rights reserved.

Overview

Class: AuthServices::IMDEServices ← Sinatra::Base

File Manifest

File Manifest

File	Language	Author(s)	Copyright
crux-server.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022, Brick Mill Games, LLC, all rights reserved.

Overview

Class: AuthServices::IMDEServices::CruxApp ← Sinatra::Base

File Manifest

File Manifest

File	Language	Author(s)	Copyright
crux-server.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022, Brick Mill Games, LLC, all rights reserved.

Overview

Class: BBRCombatManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
slib/BBRCombatManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Class: BMGDice ← Sinatra::Base

File Manifest

File Manifest

File	Language	Author(s)	Copyright
dice-server.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022, Brick Mill Games, LLC, all rights reserved.

Overview

Class: CoreService

File Manifest

File Manifest

File	Language	Author(s)	Copyright
syslib/CoreService.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Constructor Registry

Class Method Registry

Method Registry

Constructor Details

new(svc_env)

This class constructor initializes the common functionality used by all services which derive from this class

Parameters:

• svc_env [Hash] — The Crux service handler environment
• :db_info [Hash] — Database connection information used to establish MySQL database connections
• :host [String] — The hostname of the server hosting the SQL database
• :username [String] — the username of the login credentials for access the SQL databases
• :password [String] — the password of the login credentials for access the SQL databases
• :database [String] — the name of the database to be accesses, differentiated by the is_development value
• :paths [Hash] — Service group subpaths
• :specs [String] — The location of service handler specifications
• :services [String] — The location of service handler modules
• :contracts [String] — The location of service handler contract modules
• :logs [String] — The desired location of service handler log files
• :isdev [Boolean] — true if the service is running in a development environment (vs. production)

---

new(db_info)

This class constructor initializes the common functionality used by all services which derive from this class

Parameters:

• db_info [Hash] — Database connection information used to establish MySQL database connections
• :host [String] — The hostname of the server hosting the SQL database
• :username [String] — the username of the login credentials for access the SQL databases
• :password [String] — the password of the login credentials for access the SQL databases
• :database [String] — the name of the database to be accesses, differentiated by the is_development value

---

Class Method Details

generate_sql_safe_json(properties) → String

This method escapes single-quotes from the JSON string for inclusion within a SQL command string.

Parameters:

• properties [Hash] — the Ruby properties hash to convert to SQL-safe JSON

Returns:

• [String] — the SQL-safe JSON string to be used within a SQL statement.

---

Method Details

connect_to_db

---

delete(table, criteria)

This method constructs a simple SQL DELETE statement and submits it for a client query.

Parameters:

• table [String] — the name of the database table to access
• criteria [Hash] — a hash of key/value pairs that form the record contents

---

entity_create(table, context, etype, eattribute, eid, properties)

This method prepares the inputs for the SQL insert statement with which to store a specific entity based on its etype/eattribute/eid

Parameters:

• table [String] — the name of the database table to access
• context [Hash] — the context key defined as a set of key/value pairs
• etype [Integer] — the type of entity to store as part of the group
• eattribute [Integer] — the optional attribute of entity to retrieve as part of the group
• eid [String] — the entity id to store
• properties [Hash] — the property list as a hash, converted to a JSON string when stored

---

entity_delete(table, context, etype, eattribute, eid)

This method prepares the inputs for the SQL delete statement with which to delete a specific entity based on its etype/eattribute/eid

Parameters:

• table [String] — the name of the database table to access
• context [Hash] — the context key defined as a set of key/value pairs
• etype [Integer] — the type of entity to store as part of the group
• eattribute [Integer] — the attribute of entity to retrieve as part of the group
• eid [String] — the entity id to delete

---

entity_fetch(table, context, etype, eattribute, eid, filter) → Hash

This method prepares the inputs for the SQL select statement with which to fetch one or more entities based on its eid or filtered property values

Parameters:

• table [String] — the name of the database table to access
• context [Hash] — the context key defined as a set of key/value pairs
• etype [Integer] — the type of entity to retrieve as part of the group
• eattribute [Integer] — the optional attribute of entity to retrieve as part of the group
• eid [Nil or String] — the optional entity id to fetch
• filter [Nil or Hash] — the optional property filter of key/value pairs to include as part of the query

Returns:

• [Hash] — the fetched entity's properties

---

entity_get(table, context, etype, eattribute, eid, filter, properties) → Hash

This method prepares the inputs for the SQL select statement with which to get one or more entities based on its eid or filtered property values

Parameters:

• table [String] — the name of the database table to access
• context [Hash] — the context key defined as a set of key/value pairs
• etype [Integer] — the type of entity to retrieve as part of the group
• eattribute [Integer] — the optional attribute of entity to retrieve as part of the group
• eid [Nil or String] — the optional entity id to get
• filter [Nil or Hash] — the optional property filter of key/value pairs to include as part of the query
• properties [Nil or Array<String>] — an optinal list of properties of the entity to return

Returns:

• [Hash] — the returned record

---

entity_update(table, context, etype, eattribute, eid, filter, updates)

This method prepares the inputs for the SQL update statement with which to update one or more entities based on its eid or filtered property values

Parameters:

• table [String] — the name of the database table to access
• context [Hash] — the context key defined as a set of key/value pairs
• etype [Integer] — the type of entity to store as part of the group
• eattribute [Integer] — the optional attribute of entity to retrieve as part of the group
• eid [Nil or String] — the entity id to delete
• filter [Nil or Hash] — the optional property filter of key/value pairs to include as part of the query
• updates [Hash] — a set of key/value pairs detailing the property values to update

---

insert(table, data)

This method constructs a simple SQL INSERT statement and submits it for a client query.

Parameters:

• table [String] — the name of the database table to access
• data [Hash] — a hash of key/value pairs that form the record contents

---

select(table, columns, criteria, xref) → Array<Hash>

This method constructs a simple SQL SELECT statement and submits it for a client query.

Parameters:

• table [String] — the name of the database table to access
• columns [Array] — the columns to report back <default: '*'>
• criteria [Nil or String or Array<String> or Hash] — an explicit WHERE clause string or an array of WHERE clause strings or a hash of key/value pairs that form the WHERE clause filtering <default: nil>
• xref [Nil or Hash] — a hash of cross-reference information for add'l WHERE clause definitions <default: nil>

Returns:

• [Array<Hash>] — all rows within the query result, if no block given

---

update(table, criteria, updates)

This method constructs a simple SQL DELETE statement and submits it for a client query.

Parameters:

• table [String] — the name of the database table to access
• criteria [Hash] — a hash of key/value pairs that form the filtering criteria
• updates [Hash] — a hash of key/value pairs that form the updated data values

---

write_log(mesg)   <private>

This method writes a log message to a created log file.

Parameters:

• mesg [String] — the message to write to the underlying logging system

---

write_service_log(method_name, input, output, filter)

This method is a common logging method used to mark a service method's completion.

Parameters:

• method_name [String] — the name of the API method
• input [Hash] — the input parameters supplied to the service from the outside world (JS)
• output [Hash] — the output parameters supplied to the outside world by the downstream logic (lib)
• filter [Array<String>] — an array of keys to filter values from input & output from the log

---

Module: CruxConfig

File Manifest

File Manifest

File	Language	Author(s)	Copyright
syslib/CruxConfig.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2023 Brick Mill Games, LLC, All rights reserved.

Overview

Method Registry

Method Details

site_db_info(is_development) → Hash

This method returns the connection credentials for connections to the SQL database server hosted at DreamHost.

Parameters:

• is_development [Boolean] — True if running on the development server

Returns:

• [Hash] — database credential information
• :host [String] — the name of the SQL database server
• :username [String] — the username of the login credentials for access the SQL databases
• :password [String] — the password of the login credentials for access the SQL databases
• :database [String] — the name of the database to be accesses, differentiated by the is_development value

---

site_map → Hash

This method returns the site application mapping to URLs and services.

Returns:

• [Hash] — Ruby class Rack mapping to URL/Services mapping manifest

---

site_url_info → Hash

This method returns the Rack URLMap used to run the installed Crux applications

Returns:

• [Hash] — URL to Ruby class Rack mapping manifest

---

site_url_map → Hash

This method returns URL map with the manifest class names converted to class objects This Hash is Rack::URLMap ready.

Returns:

• [Hash] — the URL map as a Hash

---

Module: CruxContractManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
syslib/CruxContractManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Method Registry

Method Details

get_method_api(method_name) → Hash

This method is usually used by a Service API handler.

Parameters:

• method_name [String] — the name of the service method

Returns:

• [Hash] — the input parameters defined in the service contract for the specified method

---

get_method_list → Array<String>

This method is usually used by a Service API handler.

Returns:

• [Array<String>] — the list of methods listed in the service contract

---

validate_contract

Each service contract object requires a Hash constant named SERVICE_CONTRACT which contains a registry of the service class's methods and expected input parameters and the parameter's data formats.

---

verify_contract(method, data)

This method verifies the incoming service request's method and data to ensure that the client has honored the service site's working conditions. This is where data sanitization and bad requests (whether accidental or intentional) can be captured. Service request inputs for each service and method are defined within each service's contract class. This code uses advanced Ruby voodoo (introspection) to do its work. Handle with care.

Parameters:

• method [String] — the name of the incoming service request method
• data [Hash] — the incoming service request's data parameters, supplied by the client

---

Class: CruxResource

File Manifest

File Manifest

File	Language	Author(s)	Copyright
syslib/CruxResource.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(type, mime, item, size)

Parameters:

• type [Symbol] — the type of the resource to process
• mime [Symbol] — the MIME type of the resource to process
• item [String] — the name of the resource to process, such as a filename
• size [Integer] — the size of the buffer used for processing, such as a filename <default: 65536>

---

Method Details

each

---

to_s → String

Returns:

• [String] — a string representation of the CruxResource class

---

Class: CruxServiceManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
syslib/CruxServiceManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new

---

Method Details

error(mesg)

Parameters:

• mesg [String] — the error message to return to the user

---

find_service(name) → Hash

This method is used to get the specified service's instantiated classes in order for Crux to its work. Services which haven't been loaded yet are loaded.

Parameters:

• name [String] — the name of the loaded service to find

Returns:

• [Hash] — the service's loaded parameters
• :service [Object] — the instantiated service class
• :contract [Object] — the instantiated service contract class

---

handle_service_request(service, method, input, ipaddr)

This method is the services dispatcher, loading services on demand and verifying inputs against the individual service contracts. Results are packaged as JSON payloads for transmission back to the client, via ok, error or syserror methods. This method uses some fairly advanced Ruby voodoo (bind and introspection routines) to do its work. Don't futz around in here if you're not careful. This is the beating heart of the Crux framework.

Parameters:

• service [String] — the name of the service to handle the incoming request
• method [String] — the name of the incoming request method
• input [Hash] — the incoming request data parameters (dependent on the service contract)
• ipaddr [String] — the IP address which is the source for the incoming request

---

load_service(name)

This method loads the Crux service handler and its associated service contract based on the supplied fully-qualified name. Fully-qualified means that while the client has asked for the "Dice" service, the name has been expanded to "DiceService" by this time.

Parameters:

• name [String] — the fully-qualified name of the service to load

---

ok(result)

Parameters:

• result [Hash or CruxResource] — the successful result of the service request

---

syserror(mesg)

Parameters:

• mesg [String] — the error message to return to the user

---

write_log(mesg, extension)   <private>

Parameters:

• mesg [String] — the message to emit to the logfile
• extension [String or Nil] — a further message to emit to the logfile on its own line(s) <default: nil>

---

Class: DatabaseManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
slib/DatabaseManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Class Method Registry

Class Method Details

get_table_info(client, table_name) → Hash

Parameters:

• client [CoreService::Client] — the database client connection
• table_name [String] — the name of the database table

Returns:

• [Hash] — the table info
• :info [Array<Hash>] — an array containing the table's column information, foreach column:
• :name [String] — the column name
• :type [String] — the column type
• :is_nullable [Boolean] — can the column value be NULL
• :cmaxlen [Integer] — the maximum length of the column if it is a CHAR type
• :precision [Integer] — the maximum numeric precision if the column is a NUMERIC type
• :key [Integer] — the type of key that this column is a part of
• :comment [Integer] — the comment associated with the column

---

get_table_paged_rows(client, table_name, page_key, page_size, nth_page) → Hash

Parameters:

• client [CoreService::Client] — the database client connection
• table_name [String] — the name of the database table
• page_key [String] — the key to order by
• page_size [Integer] — the size of the page in rows per page
• nth_page [Integer] — the index of the page to retrieve

Returns:

• [Hash] — the table info

---

get_table_pagination_info(client, table_name, page_key, page_size, nth_page) → Hash

Parameters:

• client [CoreService::Client] — the database client connection
• table_name [String] — the name of the database table
• page_key [String] — the key to order by
• page_size [Integer] — the size of the page in rows per page
• nth_page [Integer] — the index of the page to retrieve

Returns:

• [Hash] — the table info

---

get_tables_list(client) → Hash

Parameters:

• client [CoreService::Client] — the database client connection

Returns:

• [Hash] — the table list
• :list [Array<String>] — the list of table names
• :comments [Array<String>] — the list of associated table comments (optional)

---

get_tables_manifest(client) → Hash

Parameters:

• client [CoreService::Client] — the database client connection

Returns:

• [Hash] — the manifest
• :manifest [Array<Hash>] —
• :name [String] — the name of the database table
• :comment [String] — the database table comment
• :info [Hash] — the column/key info for the database table

---

Class: Emailer

File Manifest

File Manifest

File	Language	Author(s)	Copyright
slib/Emailer.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Class Method Registry

Class Method Details

send_email(recipients, subject, message, sent_by) → String

Parameters:

• recipients [Array<String>] — a list of email addresses to send the message to
• subject [String] — the subject of the email
• message [String] — the body of the email
• sent_by [String or Nil] — an optional additional message to add to the end of the body <default: nil>

Returns:

• [String] — "ok" if successful, otherwise an error message

---

Class: InfoManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
slib/InfoManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Class Method Registry

Class Method Details

email → Hash

Returns:

• [Hash] — the successful authentication information
• :email [Uid] — the user's 32-bit hexadecimal user identification

---

Class: MTRManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
slib/MTRManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Class Method Registry

Class Method Details

get_dice_rolls(client, slot)

Parameters:

• client [CoreService::Client] — the database connection
• slot [Integer] — the random number pipeline to use

---

get_dwords(client, slot, amt) → Array<Integer>

Parameters:

• client [CoreService::Client] — the database connection
• slot [Integer] — the random number pipeline to use
• amt [Integer] — the number of random numbers to get <default: 1>

Returns:

• [Array<Integer>] — an array of 32-bit random numbers

---

get_qwords(client, slot, amt) → Array<Integer>

Parameters:

• client [CoreService::Client] — the database connection
• slot [Integer] — the random number pipeline to use
• amt [Integer] — the number of random numbers to get <default: 1>

Returns:

• [Array<Integer>] — an array of 64-bit random numbers

---

prepare(client, slot, timeout)   <private>

Parameters:

• client [CoreService::Client] — the database connection
• slot [Integer] — the random number pipeline to use
• timeout [Integer] — the timeout limit to use when acquiring the record lock on the pipeline

---

shuffle(client, slot, entries) → Array<Any>

Parameters:

• client [CoreService::Client] — the database connection
• slot [Integer] — the random number pipeline to use
• entries [Array<Any>] — an array of items to be shuffled

Returns:

• [Array<Any>] — the randomly shuffled array of items

---

Class: MersenneTwister

File Manifest

File Manifest

File	Language	Author(s)	Copyright
slib/MersenneTwister.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(seed, type)

Parameters:

• seed [Integer] — the seed to with which to initialize the random pipeline <default: 0>
• type [Symbol] — the strength of the random number pipeline <default: :mt19937>

---

Method Details

do_recursion   <private>

---

gen_dword → Integer

Returns:

• [Integer] — a random 32-bit integer

---

gen_dwords(n) → Array<Integer>

Parameters:

• n [Integer] — the number of random 32-bit integers to get

Returns:

• [Array<Integer>] — the list of random 32-bit integers

---

gen_qword → Integer

Returns:

• [Integer] — a random 64-bit integer

---

gen_qwords(n) → Array<Integer>

Parameters:

• n [Integer] — the number of random 64-bit integers to get

Returns:

• [Array<Integer>] — the list of random 64-bit integers

---

gen_rand_all   <private>

---

get_state(state)

Parameters:

• state [ByteString] — a packed array of bytes consisting of the random number pipline and its associated index

---

get_state → ByteString

Returns:

• [ByteString] — a packed array of bytes consisting of the random number pipline and its associated index

---

lshift128   <private>

---

prime(seed)

Parameters:

• seed [Integer] — the seed to with which to initialize the random pipeline <default: 0>

---

rshift128   <private>

---

Class: SessionManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
slib/SessionManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Class Method Registry

Class Method Details

expire(client, jwt) → Boolean

Parameters:

• client [CoreService::Client] — the database connection
• jwt [String] — the encoded JWT session credential

Returns:

• [Boolean] — true

---

ipaddr_to_hex(ipaddrv4) → String   <private>

Parameters:

• ipaddrv4 [String] — the IP address to convert

Returns:

• [String] — the IPv4 IP address in packed hexadecimal format

---

ipv4_to_hex(ipv4) → String   <private>

Parameters:

• ipv4 [String] — the IPv4 IP address in '.' format

Returns:

• [String] — the IPv4 IP address in packed hexadecimal format

---

ipv6_to_hex(ipv6) → String   <private>

Parameters:

• ipv6 [String] — the IPv6 IP address in ':' format

Returns:

• [String] — the IPv6 IP address in pack hexadecimal format

---

is_ipaddr_registered?(client, ipaddr) → Boolean

Parameters:

• client [CoreService::Client] — the database connection
• ipaddr [String] — the IP address of the user's client connection

Returns:

• [Boolean] — true, if registered

---

is_ipv4?(ipaddr) → Boolean   <private>

Parameters:

• ipaddr [String] — the IP address to check

Returns:

• [Boolean] — true, if the IP address is in IPv4 dot format

---

is_ipv6?(ipaddr) → Boolean   <private>

Parameters:

• ipaddr [String] — the IP address to check

Returns:

• [Boolean] — true, if the IP address is in IPv6 colon format

---

is_sid_registered?(client, sid) → Boolean

Parameters:

• client [CoreService::Client] — the database connection
• sid [String] — the 64-bit hex-encoded session identifier

Returns:

• [Boolean] — true, if registered

---

is_uid_registered?(client, uid, app) → Boolean

Parameters:

• client [CoreService::Client] — the database connection
• uid [String] — the 64-bit hex-encoded user identifier
• app [String] — the 32-bit hex-encoded user identifier

Returns:

• [Boolean] — true, if registered

---

jwt_decode(jwt) → Hash   <private>

Parameters:

• jwt [String] — the JWT-encoded user credentials

Returns:

• [Hash] — the user's credentials taken from the user database

---

jwt_encode(payload) → String   <private>

Parameters:

• payload [Hash] — the user's credentials taken from the user database

Returns:

• [String] — the JWT-encoded string used for user credentials

---

register(client, ipaddr, force, app, uid, username, realname, email, roles, ndays) → String

Parameters:

• client [CoreService::Client] — the database connection
• ipaddr [Integer] — the IP address of the user's current connection (only one connection per user per IP)
• force [Boolean] — if true, allows the user to re-register (prevents account lockout on a dropped connection)
• app [String] — the app being registered
• uid [String] — the hexadecimal user identifier
• username [String] — the username
• realname [String] — the user's real name
• email [String] — the user's email address
• roles [Integer] — the user's roles (permissions)
• ndays [Integer] — the credentials expiration

Returns:

• [String] — an encoded JWT credentialed string

---

validate(client, ipaddr, jwt) → Boolean

Parameters:

• client [CoreService::Client] — the database connection
• ipaddr [Integer] — the IP address of the user's current connection (only one connection per user per IP)
• jwt [String] — the encoded JWT session credential

Returns:

• [Boolean] — true

---

Class: StorageManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
slib/StorageManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new

---

Method Details

dir_version_list(path) → Array<String>

Parameters:

• path [String] — the path of the directory to search

Returns:

• [Array<String>] — a sorted list of version subdirectories

---

Class: SysUserManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/crux/SysUserManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2023 Brick Mill Games, LLC, All rights reserved.

Overview

Class Method Registry

Class Method Details

add_new_user(client, uid, username, realname, email, password) → String

This class method adds a new user to the Crux system.

Parameters:

• client [CoreService::Client] — the database connection
• uid [String] — the new user id
• username [String] — the username of the new user
• realname [String] — the new user's real name
• email [String] — the new user's email address
• password [String] — the new user's password

Returns:

• [String] — the result of the operation

---

build_reverse_roles_lut(client, app) → Hash   <private>

This class method generates an rlut, indexed on the privilege string, per the specified app.

Parameters:

• client [CoreService::Client] — the database connection
• app [String] — the app

Returns:

• [Hash] — the rlut for the specified app

---

build_reverse_roles_lut(client, app) → Hash   <private>

This class method generates an rlut, indexed on the privilege string, per the specified app.

Parameters:

• client [CoreService::Client] — the database connection
• app [String] — the app

Returns:

• [Hash] — the rlut for the specified app

---

build_roles_list(rlut, rvalue) → Array<String>   <private>

This class method generates a list of roles based on the specified rlut and rvalue.

Parameters:

• rlut [Hash] — the role value LUT
• rvalue [Integer] — the integer value containing the roles

Returns:

• [Array<String>] — the list containing the roles based on the specified rvalue

---

build_roles_lut(client, app) → Hash   <private>

This class method generates an rlut, indexed on the bitfield value, per the specified app.

Parameters:

• client [CoreService::Client] — the database connection
• app [String] — the app

Returns:

• [Hash] — the rlut for the specified app

---

build_roles_manifest(client, app, sorted) → Hash   <private>

This class method generates full app + privileges manifest.

Parameters:

• client [CoreService::Client] — the database connection
• app [String] — the app
• sorted [Boolean] — true, if the manifest's lists are to be sorted by its bit value

Returns:

• [Hash] — the full manifest for the apps and associated privileges

---

get_app_access_privilege(client) → Hash

This class method returns the base access privilege of all of the apps.

Parameters:

• client [CoreService::Client] — the database connection

Returns:

• [Hash] — the list of app privileges
• app [String] — the app
• privilege [String] — the app's basic access privilege

---

get_app_privileges_manifest(client) → Hash

This class method returns a manifest of all of the apps and their associated privileges.

Parameters:

• client [CoreService::Client] — the database connection

Returns:

• [Hash] — the list of app privileges
• app [String] — the app
• roles [Array<String>] — the list of the app's privileges / roles

---

get_app_user_list(client, app) → Array<Hash>

This class method returns a list of Crux application users.

Parameters:

• client [CoreService::Client] — the database connection
• app [String] — the app

Returns:

• [Array<Hash>] — the list of users with privileges for the specified application

---

get_app_user_privileges(client, uid, app) → Array<String>

This class method returns the list of privileges for the given user for the specified app.

Parameters:

• client [CoreService::Client] — the database connection
• uid [String] — the user id
• app [String] — the app

Returns:

• [Array<String>] — the list of the app user's privileges

---

get_user_list(client) → Array<Hash>

This class method returns a list of Crux system users.

Parameters:

• client [CoreService::Client] — the database connection

Returns:

• [Array<Hash>] — the list of users with their uid, username, realname, email and apps

---

get_user_manifest(client) → Array<Hash>

This class method returns a manifest of Crux system users.

Parameters:

• client [CoreService::Client] — the database connection

Returns:

• [Array<Hash>] — the manifest of users with their uid, username, realname, email and apps

---

remove_app_user_privileges(client, uid, app) → String

This class method removes the privileges for the given user for a given app.

Parameters:

• client [CoreService::Client] — the database connection
• uid [String] — the user id
• app [String] — the app

Returns:

• [String] — the result of the removal operation

---

remove_user(client, uid) → String

This class method removes a user from the Crux system.

Parameters:

• client [CoreService::Client] — the database connection
• uid [String] — the user id

Returns:

• [String] — the result of the operation

---

restore_app_user_privileges(client, uid, app) → String

This class method restores the privileges for the given user for a given app.

Parameters:

• client [CoreService::Client] — the database connection
• uid [String] — the user id
• app [String] — the app

Returns:

• [String] — the result of the restoration operation

---

restore_user_privileges(client, uid) → String

This class method restores the privileges for the given user system-wide.

Parameters:

• client [CoreService::Client] — the database connection
• uid [String] — the user id

Returns:

• [String] — the result of the restoration operation

---

set_app_user_privileges(client, uid, app, privileges, create) → String

This class method sets the privileges for the given user for the specified app.

Parameters:

• client [CoreService::Client] — the database connection
• uid [String] — the user id
• app [String] — the app
• privileges [Array<String>] — the list of privileges to set
• create [Boolean] — true, if new user privileges can be created if not already existing

Returns:

• [String] — the result of the operation

---

suspend_app_user_privileges(client, uid, app) → String

This class method suspends the privileges for the given user for a given app.

Parameters:

• client [CoreService::Client] — the database connection
• uid [String] — the user id
• app [String] — the app

Returns:

• [String] — the result of the suspension operation

---

suspend_user_privileges(client, uid) → String

This class method suspends the privileges for the given user system-wide.

Parameters:

• client [CoreService::Client] — the database connection
• uid [String] — the user id

Returns:

• [String] — the result of the suspension operation

---

Class: TOCSServices ← Sinatra::Base

File Manifest

File Manifest

File	Language	Author(s)	Copyright
tocs-server.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022, Brick Mill Games, LLC, all rights reserved.

Overview

Class: UIDManager

File Manifest

File Manifest

File	Language	Author(s)	Copyright
slib/UIDManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview

Class Method Registry

Class Method Details

get_32bit_key(client, table, field, slot) → String

This class method returns a unique 8-byte hex id and making sure the database table we'll be inserting it into doesn't already have it.

Parameters:

• client [CoreService::Client] — the database connection
• table [String] — the database table we'll be inserting a unique id into
• field [String] — the field (column) of the table containing the unique id key <default: 'id'>
• slot [Integer] — the UID slot to use

Returns:

• [String] — the 32-bit unique id as an 8-byte hexadecimal number

---

get_64bit_key(client, table, field, slot) → String

This class method returns a unique 16-byte hex id and making sure the database table we'll be inserting it into doesn't already have it.

Parameters:

• client [CoreService::Client] — the database connection
• table [String] — the database table we'll be inserting a unique id into
• field [String] — the field (column) of the table containing the unique id key <default: 'id'>
• slot [Integer] — the UID slot to use

Returns:

• [String] — the 64-bit unique id as a 16-byte hexadecimal number

---

get_dword(client, slot) → Array<Integer>

Parameters:

• client [CoreService::Client] — the database connection
• slot [Integer] — the random number pipeline to use

Returns:

• [Array<Integer>] — an array of 32-bit random numbers

---

get_qword(client, slot) → Array<Integer>

Parameters:

• client [CoreService::Client] — the database connection
• slot [Integer] — the random number pipeline to use

Returns:

• [Array<Integer>] — an array of 64-bit random numbers

---

prepare(client, slot, timeout)   <private>

Parameters:

• client [CoreService::Client] — the database connection
• slot [Integer] — the random number pipeline to use
• timeout [Integer] — the timeout limit to use when acquiring the record lock on the pipeline

---

Script: config.ru

File Manifest

File Manifest

File	Language	Author(s)	Copyright
config.ru	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Overview