feat(Storages): Allow customizing of storages

cbauth now exposes a `sessionStorage` and a `requestStorage` setting. These expect WireBox mappings and will use them inside inside of `authenticationService.` The defaults provided are `SessionStorage@cbstorages` and `RequestStorage@cbstorages` respectively.

BREAKING CHANGE: The default `sessionStorage@cbauth` is now `SessionStorage@cbstorages`.  Previously it was `CacheStorage@cbstorages`.

Author: elpete

.travis.yml

@@ -2,10 +2,6 @@ language: java
 sudo: required
 jdk:
   - oraclejdk8
-cache:
-  directories:
-    - "$HOME/.CommandBox/artifacts/"
-    - "$HOME/.CommandBox/server/"
 env:
   matrix:
     - ENGINE=adobe@2018

ModuleConfig.cfc

@@ -1,10 +1,14 @@
 component {
 
     this.title = "cbauth";
+    this.autoMapModels = false;
+    this.dependencies = [ "cbstorages" ];
 
     function configure() {
         settings = {
-            userServiceClass = ""
+            userServiceClass = "",
+            sessionStorage = "SessionStorage@cbstorages",
+            requestStorage = "RequestStorage@cbstorages"
         };
 
         interceptorSettings = {
@@ -13,6 +17,10 @@ component {
     }
 
     function onLoad() {
+        binder.map( "SessionStorage@cbauth" ).toDSL( settings.sessionStorage );
+        binder.map( "RequestStorage@cbauth" ).toDSL( settings.requestStorage );
+        binder.map( "AuthenticationService@cbauth" ).to( "#moduleMapping#.models.AuthenticationService" );
+
         var helpers = controller.getSetting( "applicationHelper" );
         arrayAppend(
             helpers,
@@ -25,7 +33,7 @@ component {
         controller.setSetting(
             "applicationHelper",
             arrayFilter( controller.getSetting( "applicationHelper" ), function( helper ) {
-                return helper != "#moduleMapping#/helpers/AuthenticationServiceHelpers.cfm"; 
+                return helper != "#moduleMapping#/helpers/AuthenticationServiceHelpers.cfm";
             } )
         );
     }

README.md

@@ -16,6 +16,12 @@ Specify a `userServiceClass` in your `config/ColdBox.cfc` inside `moduleSettings
 
 Additionally, the user component returned by the `retrieve` methods needs to respond to `getId()`.
 
+You can also specify a `sessionStorage` and a `requestStorage` WireBox mapping.
+These will be used inside `AuthenticationService`.  By default, these are
+`SessionStorage@cbstorages` and `RequestStorage@cbstorages` respectively.
+Interfaces are provided in the `models` folder for reference when building
+your own.  (Your storage classes do not need to formally implement the interface.)
+
 ## Usage
 
 You can inject the `authenticationService` using WireBox.
@@ -154,4 +160,4 @@ interceptData
 | sessionStorage | The sessionStorage object to store additional values if needed. |
 | requestStorage | The requestStorage object to store additional values if needed. |
 
-This is the prime time to store additional values based on the user returned.
+This is the prime time to store additional values based on the user returned.

box.json

@@ -31,8 +31,8 @@
         "testbox":"^2.3.0+00044"
     },
     "installPaths":{
-        "testbox":"testbox",
-        "cbstorages":"modules/cbstorages"
+        "testbox":"testbox/",
+        "cbstorages":"modules/cbstorages/"
     },
     "scripts":{
         "postVersion":"package set location='elpete/cbauth#v`package version`'"

models/AuthenticationService.cfc

@@ -2,8 +2,8 @@ component singleton {
 
     property name="wirebox" inject="wirebox";
     property name="interceptorService" inject="coldbox:interceptorService";
-    property name="sessionStorage" inject="CacheStorage@cbstorages";
-    property name="requestStorage" inject="RequestStorage@cbstorages";
+    property name="sessionStorage" inject="SessionStorage@cbauth";
+    property name="requestStorage" inject="RequestStorage@cbauth";
     property name="userServiceClass" inject="coldbox:setting:userServiceClass@cbauth";
 
     variables.USER_ID_KEY = "cbauth__userId";

models/RequestStorageInterface.cfc

@@ -0,0 +1,6 @@
+interface name="RequestStorageInterface" {
+    public any function getVar( required string name, any defaultValue );
+    public void function setVar( required string name, required any value );
+    public boolean function deleteVar( required string name );
+    public boolean function exists( required string name );
+}

models/SessionStorageInterface.cfc

@@ -0,0 +1,6 @@
+interface name="SessionStorageInterface" {
+    public any function getVar( required string name, any defaultValue );
+    public void function setVar( required string name, required any value );
+    public boolean function deleteVar( required string name );
+    public boolean function exists( required string name );
+}