Overview

File Manifest

File Manifest
File	Language	Author(s)	Copyright
services/dice/DiceService.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2023 Brick Mill Games, LLC, All rights reserved.
services/dice/InfoService.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2023 Brick Mill Games, LLC, All rights reserved.
contracts/dice/DiceServiceContract.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2023, Brick Mill Games, LLC, all rights reserved.
contracts/dice/InfoServiceContract.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2023, Brick Mill Games, LLC, all rights reserved.
lib/dice/DiceManager.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2022 Brick Mill Games, LLC, All rights reserved.

Contents Directory

Objects

C DiceManager

C DiceService ← CoreService

C DiceServiceContract

C InfoService ← CoreService

C InfoServiceContract

Constants & Methods

• quickroll (DiceManager)

• rolldice (DiceManager)

• bbr (DiceService) <crux-service>

• getlog (DiceService) <crux-service>

• loglist (DiceService) <crux-service>

• quickroll (DiceService) <crux-service>

• rolldice (DiceService) <crux-service>

• SERVICE_CONTRACT (DiceServiceContract)

• email (InfoService) <crux-service>

• SERVICE_CONTRACT (InfoServiceContract)

Class: DiceManager

File Manifest

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

Overview

This class provides an API for Brick Mill Games' dice server.

Class Method Registry

Item

Attributes

quickroll → Hash

rolldice → Hash

Class Method Details

quickroll → Hash

Returns:

[Hash] — the quick dice roll result

:roll [Integer] — the roll
:rid [Integer] — the roll identifier
:lid [Integer] — the log identifier

rolldice → Hash

Returns:

[Hash] — the dice roll result

:rolls [Integer] — the rolls
:rid [Integer] — the roll identifier
:lid [Integer] — the log identifier

Class: DiceService ← CoreService

File Manifest

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

Overview

This module is responsible for defining the DiceService API to the outside world.

Constructor Registry

Item

Attributes

new(crux_env)

Method Registry

Item

Attributes

bbr(ipaddr, input) → Hash

<crux-service>

getlog(ipaddr, input) → Hash

<crux-service>

loglist(ipaddr, input) → Hash

<crux-service>

quickroll(ipaddr, input) → Hash

<crux-service>

rolldice(ipaddr, input) → Hash

<crux-service>

Constructor Details

new(crux_env)

This class constructor simply calls the CoreService constructor to set up logging and other common service routines.

Parameters:

crux_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

:logdir [String] — The desired location of service handler log files
:repository [String] — The location of service handler modules
:contracts [String] — The location of service handler contract modules
:isdev [Boolean] — true if the service is running in a development environment (vs. production)

Method Details

bbr(ipaddr, input) → Hash <crux-service>

This method is used to generate a Britannia Battle Resolver request.

Javascript Example (via crux.js module):
crux.loadRegistry({ … bbr: { url: '/t/dice/bbr', params: [ 'rid','mode','turn','territory','stoppage','atk_nation','atk_armies','atk_cavalry_armies','atk_leader','atk_mixed','def_nation','def_armies','def_cavalry_armies','def_leader','def_mixed','def_fort','description','subject','recipients' ] }, }) … crux.call('bbr', rid, mode, turn, territory, stoppage, atk_nation, atk_armies, atk_cavalry_armies, atk_leader, atk_mixed, def_nation, def_armies, def_cavalry_armies, def_leader, def_mixed, def_fort, description, subject, recipients, (jr) => { // jr is the return Hash as a JS Object })

Parameters:

ipaddr [String] — the IP address of the originating request
input [Hash] — the input parameters supplied to the service from the outside world (JS)

rid [Integer] — the roll identifier
mode [String] — the BBR combat mode
turn [Integer] — the game turn
territory [String] — the territory where the combat is taking place
stoppage [String] — the combat stoppage conditions
atk_nation [String] — the attacking nation
atk_armies [Integer] — the number of attacking infantry armies
atk_cavalry_armies [Integer] — the number of attacking cavalry armies
atk_leader [String] — the attacking leader, if present
atk_mixed [String] — the mixed army attacking method
def_nation [String] — the defending nation
def_armies [Integer] — the number of defending infantry armies
def_cavalry_armies [Integer] — the number of defending cavalry armies
def_leader [String] — the defending leader, if present
def_mixed [String] — the mixed army defending method
def_fort [Integer] — 0 or 1 depending on whether a fort is present
description [String] — the subject line of the email notification
subject [String] — the subject line of the email notification
recipients [String] — a comma-delimited list of email addresses for email notification

Returns:

[Hash] — the result of the service call

result [Hash] — the battle result

rid [Integer] — the roll identifier
lid [String] — the dice logs identifier
battle [Hash] — the battle results of the combat
report [String] — the descriptive report of the combat

getlog(ipaddr, input) → Hash <crux-service>

This method is used to generate a single Dice Service Log message.

Javascript Example (via crux.js module):
crux.loadRegistry({ … getlog: { url: '/t/dice/getlog', params: [ 'lid' ] }, }) … crux.call('getlog', lid, (jr) => { // jr is the return Hash as a JS Object })

Parameters:

ipaddr [String] — the IP address of the originating request
input [Hash] — the input parameters supplied to the service from the outside world (JS)

lid [String] — the log id

Returns:

[Hash] — the result of the service call

report [String] — the log report

loglist(ipaddr, input) → Hash <crux-service>

This method is used to generate a list of Dice Service Log messages.

Javascript Example (via crux.js module):
crux.loadRegistry({ … loglist: { url: '/t/dice/loglist', params: [ 'within' ] }, }) … crux.call('loglist', within, (jr) => { // jr is the return Hash as a JS Object })

Parameters:

ipaddr [String] — the IP address of the originating request
input [Hash] — the input parameters supplied to the service from the outside world (JS)

within [Integer] — the time range in days to get logs

Returns:

[Hash] — the result of the service call

list [Array<Hash>] — the array of log ids

lid [String] — the log id
service [String] — the service id
timestamp [String] — the time stamp of the log

quickroll(ipaddr, input) → Hash <crux-service>

This method is used to generate a single dice roll for display to the web page.

Javascript Example (via crux.js module):
crux.loadRegistry({ … quickroll: { url: '/t/dice/quickroll', params: [ 'rid','sides','ndice' ] }, }) … crux.call('quickroll', rid, sides, ndice, (jr) => { // jr is the return Hash as a JS Object })

Parameters:

ipaddr [String] — the IP address of the originating request
input [Hash] — the input parameters supplied to the service from the outside world (JS)

rid [Integer] — a unique roll identifier supplied by the calling system
sides [Integer] — the number of sides to each die
ndice [Integer] — the number of dice in the roll

Returns:

[Hash] — the result of the service call

result [Hash] — the dice roll result

roll [Integer] — the die/dice roll
rid [Integer] — the roll identifier
lid [String] — the dice logs identifier

rolldice(ipaddr, input) → Hash <crux-service>

This method is used to generate a one or more dice rolls for display to the web page and for transmission via email.

Javascript Example (via crux.js module):
crux.loadRegistry({ … rolldice: { url: '/t/dice/rolldice', params: [ 'rid','sides','ndice','nrolls','mods','description','subject','recipients' ] }, }) … crux.call('rolldice', rid, sides, ndice, nrolls, mods, description, subject, recipients, (jr) => { // jr is the return Hash as a JS Object })

Parameters:

ipaddr [String] — the IP address of the originating request
input [Hash] — the input parameters supplied to the service from the outside world (JS)

rid [Integer] — a unique roll identifier supplied by the calling system
sides [Integer] — the number of sides to each die
ndice [Integer] — the number of dice in the roll
nrolls [Integer] — the number of rolls to be made
mods [Integer] — the +/- modifier to apply to each roll
description [String] — the subject line of the email notification
subject [String] — the subject line of the email notification
recipients [String] — a comma-delimited list of email addresses for email notification

Returns:

[Hash] — the result of the service call

result [Hash] — the dice roll result

rolls [Array<Integer>] — the array of die/dice rolls
rid [Integer] — the roll identifier
lid [String] — the dice logs identifier

Class: DiceServiceContract

File Manifest

File Manifest
File	Language	Author(s)	Copyright
contracts/dice/DiceServiceContract.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2023, Brick Mill Games, LLC, all rights reserved.

Overview

Constant Registry

Item

Attributes

SERVICE_CONTRACT

<read-only>

Constant Details

SERVICE_CONTRACT <read-only>

The SERVICE_CONTRACT is a Hash whose keys are the method names of the service. The values of each key is a HASH of data parameters and their associated expected types and constraints.

Class: InfoService ← CoreService

File Manifest

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

Overview

This module is responsible for defining the InfoService API to the outside world.

Constructor Registry

Item

Attributes

new(crux_env)

Method Registry

Item

Attributes

email(ipaddr, input) → Hash

<crux-service>

Constructor Details

new(crux_env)

This class constructor simply calls the CoreService constructor to set up logging and other common service routines.

Parameters:

crux_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

:logdir [String] — The desired location of service handler log files
:repository [String] — The location of service handler modules
:contracts [String] — The location of service handler contract modules
:isdev [Boolean] — true if the service is running in a development environment (vs. production)

Method Details

email(ipaddr, input) → Hash <crux-service>

This method simply loads the bmg support email address for transmission to the web page.

Javascript Example (via crux.js module):
crux.loadRegistry({ … email: { url: '/t/info/email', params: [ ] }, }) … crux.call('email', (jr) => { // jr is the return Hash as a JS Object })

Parameters:

ipaddr [String] — the IP address of the originating request
input [Hash] — the input parameters supplied to the service from the outside world (JS)

Returns:

[Hash] — the result of the service call

email [String] — the email address of the BMG support staff

Class: InfoServiceContract

File Manifest

File Manifest
File	Language	Author(s)	Copyright
contracts/dice/InfoServiceContract.rb	Ruby	Kenneth F. Guerin	Copyright © 2018-2023, Brick Mill Games, LLC, all rights reserved.

Overview

Constant Registry

Item

Attributes

SERVICE_CONTRACT

<read-only>

Constant Details

SERVICE_CONTRACT <read-only>

The SERVICE_CONTRACT is a Hash whose keys are the method names of the service. The values of each key is a HASH of data parameters and their associated expected types and constraints.