implements save method with test

digitalsadhu · Jul 7, 2013 · d5559db · d5559db
1 parent 438a9f8
commit d5559db
Show file tree

Hide file tree

Showing 9 changed files with 250 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@ Admittance
 
 Role based access control module for node. The interface is based off the Yii php framework's RBAC interface. The implementation is written in coffee script and is entirely original.
 
-This module is under heavy development at the moment and some several key features are not yet implemented... ehh hmm, persisting permissions for example... Anyway, don't use it yet. Do contribute though! Accepting pull requests! 
+This module is under heavy development at the moment and well anyway, you probably shouldn't use it beyond testing it out yet. Do contribute though! Accepting pull requests! 
 
 I wrote this module in coffeescript for the main reason of trying coffeescript out. I will most likely re-write a version in javascript at some point as well.
 
@@ -64,20 +64,56 @@ am.checkAccess('editPosts', 43) // true
 ## Other methods
 
 ### clearAll
+
+Clears all permissions, you need to call save after to persist changes
+
 ### clearAuthAssignments
+
+Clears all auth assignments, you need to call save after to persist changes
+
 ### executeBizRule
+
+Business rules not yet implemented
+
 ### getAuthAssignment
+
+Gets a Auth assignment object
+
 ### getAuthAssignments
+
+gets all auth assignments for a user
+
 ### getAuthItem
+
+gets the object that represents an auth item
+
 ### getAuthItems
+
+gets all auth items for a user
+
 ### hasItemChild
+
+Checks if an auth item has the specified child
+
 ### isAssigned
+
+Checks if a user has a certain auth item assigned
+
 ### removeAuthItem
+
+Removes an auth item
+
 ### removeItemChild
+
+Removes the reference between a parent and child auth item
+
 ### revoke
+
+Revokes access for a certain auth item to a user
+
 ### save
-### saveAuthAssignment
-### saveAuthItem
+
+Persists any changes
 
 ## Events
 

diff --git a/admittance.coffee b/admittance.coffee
@@ -182,8 +182,8 @@ class Admittance extends EventEmitter
             assignments[userId][itemName] = null
 
     save: (cb) ->
-        @adaptor.save @items, @assignments, @children, ->
-            # @emit "save"
+        @adaptor.save items, assignments, children, () ->
+            _this.emit "save"
             cb()
 
     # saveAuthAssignment: (assignment, cb) ->

diff --git a/admittance.js b/admittance.js
diff --git a/file-adaptor.coffee b/file-adaptor.coffee
@@ -23,7 +23,7 @@ class FileAdaptor
 
         data = JSON.stringify json
         #when save is done call callback
-        fs.writeFile @fileName, 'utf8', data, (err, data) ->
+        fs.writeFile @fileName, data, (err, data) ->
             if err then cb err else cb()
 
     # saveAuthItem: (item, oldName, cb) ->

diff --git a/file-adaptor.js b/file-adaptor.js
diff --git a/tests/rights-src.json b/tests/rights-src.json
@@ -0,0 +1,53 @@
+{
+    "assignments": {
+        "501": { 
+            "admin": {
+                "itemName": "admin",
+                "id": 501,
+                "bizRule": null,
+                "data": "N;"
+            },
+            "tmc": {
+                "itemName": "tmc",
+                "id": 501,
+                "bizRule": null,
+                "data": "N;"
+            }
+        },
+        "12": {
+            "tmc": {
+                "itemName": "tmc",
+                "id": 12,
+                "bizRule": null,
+                "data": "N;"
+            }
+        }
+    },
+    "items": {
+        "admin": {
+            "name": "admin",
+            "type": 2,
+            "description": "Admin user",
+            "bizRule": null,
+            "data": "N;"
+        },
+        "tmc": {
+            "name": "tmc",
+            "type": 2,
+            "description": "TMC user",
+            "bizRule": null,
+            "data": "N;"
+        },
+        "acceptTMP": {
+            "name": "acceptTMP",
+            "type": 0,
+            "description": "Accept TMPs",
+            "bizRule": null,
+            "data": "N;"  
+        }
+    },
+    "children": {
+        "admin": ["acceptTMP", "tmc"],
+        "tmc": ["acceptTMP"]
+    }
+}
diff --git a/tests/rights.json b/tests/rights.json
@@ -1,53 +1 @@
-{
-    "assignments": {
-        "501": { 
-            "admin": {
-                "itemName": "admin",
-                "id": 501,
-                "bizRule": null,
-                "data": "N;"
-            },
-            "tmc": {
-                "itemName": "tmc",
-                "id": 501,
-                "bizRule": null,
-                "data": "N;"
-            }
-        },
-        "12": {
-            "tmc": {
-                "itemName": "tmc",
-                "id": 12,
-                "bizRule": null,
-                "data": "N;"
-            }
-        }
-    },
-    "items": {
-        "admin": {
-            "name": "admin",
-            "type": 2,
-            "description": "Admin user",
-            "bizRule": null,
-            "data": "N;"
-        },
-        "tmc": {
-            "name": "tmc",
-            "type": 2,
-            "description": "TMC user",
-            "bizRule": null,
-            "data": "N;"
-        },
-        "acceptTMP": {
-            "name": "acceptTMP",
-            "type": 0,
-            "description": "Accept TMPs",
-            "bizRule": null,
-            "data": "N;"  
-        }
-    },
-    "children": {
-        "admin": ["acceptTMP", "tmc"],
-        "tmc": ["acceptTMP"]
-    }
-}
+{"items":{"admin":{"name":"admin","type":2,"description":"Admin user","bizRule":null,"data":"N;"},"tmc":{"name":"tmc","type":2,"description":"TMC user","bizRule":null,"data":"N;"},"acceptTMP":{"name":"acceptTMP","type":0,"description":"Accept TMPs","bizRule":null,"data":"N;"},"my-test":{"name":"my-test","type":2,"description":"this is a test"}},"assignments":{"12":{"tmc":{"itemName":"tmc","id":12,"bizRule":null,"data":"N;"}},"501":{"admin":{"itemName":"admin","id":501,"bizRule":null,"data":"N;"},"tmc":{"itemName":"tmc","id":501,"bizRule":null,"data":"N;"}}},"children":{"admin":["acceptTMP","tmc"],"tmc":["acceptTMP"]}}
diff --git a/tests/test.coffee b/tests/test.coffee
@@ -4,6 +4,7 @@ chai.should()
 AdmittanceModule = require '../index'
 Admittance = AdmittanceModule.Admittance
 FileAdaptor = AdmittanceModule.FileAdaptor
+fs = require 'fs'
 
 
 am = new Admittance(new FileAdaptor('tests/rights.json'))
@@ -99,9 +100,11 @@ describe 'The FileAdaptor class', ->
 
     afterEach (done) ->
         am.clearAll()
+        fs.readFile 'tests/rights-src.json', 'utf8', (err, data) ->
+            fs.writeFile 'tests/rights.json', data, () ->
         done()
 
-    describe 'load method', (done) ->
+    describe 'load method', () ->
 
         it 'should load existing rights file', (done) ->
             am.on 'load', () ->
@@ -110,5 +113,14 @@ describe 'The FileAdaptor class', ->
                 done()
 
     describe 'save method', ->
+        it 'should save rights to file', (done) ->
+            am.on 'load', () ->
+                am.createAuthItem 'my-test', 2, 'this is a test'
+                am.save () ->
+                    aam = new Admittance(new FileAdaptor('tests/rights.json'))
+                    aam.getAuthItem('my-test').should.be.an('object')
+                    done()
+
+
 
 
diff --git a/tests/test.js b/tests/test.js