Implement API route for viewing a created society

README.md

@@ -11,6 +11,7 @@ Server for Integrated Project, powered by Express.js and Redis, listens only on
     * [/user/register/](#userregister)
     * [/user/auth/](#userauth)
     * [/society/create/](#societycreate)
+    * [/society/view/](#societyview)
 
 ### Installation
 Instructions are for OSX El Capitan at time of writing.
@@ -106,6 +107,7 @@ database and a response will be sent looking like this:
         "name": "FooBarSociety",
         "admins": ["FooBar", "BarFoo", "FarBoo"],
         "description": "A description of the FooBarSociety society.",
+        "users": ["FooBar", "BarFoo", "FarBoo"] // At this point the users will simply be the admin list
     }, // An object representing the society
     "error": 0
 }
@@ -114,3 +116,19 @@ The error codes are as follows, `1` indicates a malformed request, `2` indicates
 that a society with that name already exists, and `3` indicates that the user
 does not have authorisation to create that society. (Note that the admin list
 must contain the username that is creating it.)
+
+### /society/view/:society\_name
+To view a created society, :society\_name, a `GET` request should be sent with
+no data. The response will then be formed as follows:
+```javascript
+{
+    "society": { // Society object containing information about the society
+        "name": "FooBarSociety",
+        "admins": ["FooBar", "BarFoo", "FarBoo"],
+        "description": "A description of the FooBarSociety society.",
+        "users": ["FooBar", "BarFoo", "FarBoo"]
+    },
+    "error": 0 // Error code if an error occured, 0 indicates no error.
+}
+```
+The error codes are as follows, `1` indicates that the society does not exist.

routes/society/create-society.js

@@ -18,6 +18,7 @@ var perform = function(req,res) {
     society_name = decodeURIComponent(society_name);
     admins = decodeURIComponent(admins);
     description = decodeURIComponent(description);
+    var admins_str = admins;
     admins = JSON.parse(admins);
     redis.hget(soc_query, "name", function (err, result) {
       if (result) {
@@ -28,13 +29,15 @@ var perform = function(req,res) {
           var username = result;
           if (admins.indexOf(result) !== -1) {
             redis.hset(soc_query, "name", society_name);
-            redis.hset(soc_query, "admins", JSON.stringify(admins));
+            redis.hset(soc_query, "admins", admins_str);
             redis.hset(soc_query, "description", description);
+            redis.hset(soc_query, "users", admins_str);
             res.send({"success": 1,
                       "society" : {
                        "name": society_name,
-                       "admins": JSON.stringify(admins),
-                       "description": description
+                       "admins": admins,
+                       "description": description,
+                       "users": admins
                       },
                       "error": 0});
           } else {

routes/society/view-society.js

@@ -1,3 +1,6 @@
+var Redis = require("ioredis");
+var redis = new Redis();
+
 module.exports = {
   perform: function (a,b) {
     perform(a,b);
@@ -5,5 +8,19 @@ module.exports = {
 }
 
 var perform = function (req, res) {
-  res.send("Attempting to view society: " + req.params.societyid);
+  var auth_key = req.body.auth || req.query.auth;
+
+  redis.hgetall("society:" + req.params.societyid).then(function (result) {
+    if (result.name) {
+      result.users = JSON.parse(result.users);
+      result.admins = JSON.parse(result.admins);
+      res.send({
+        "society": result,
+        "error": 0
+      });
+    } else {
+      res.send({"society": {},
+               "error": 1});
+    }
+  });
 };