Collective narrative TEST DO NOT MERGE

.meteor/packages

@@ -13,12 +13,12 @@ [email protected]                  # Helpful client-side library
 [email protected]                 # Meteor's client-side reactive programming library
 
 [email protected]                # ECMAScript 5 compatibility for older browsers.
-[email protected].4              # Enable ECMAScript2015+ syntax in app code
+[email protected].7              # Enable ECMAScript2015+ syntax in app code
 
 [email protected]                # Allow all DB writes from clients (for prototyping)
 [email protected]
 twbs:bootstrap
-iron:router
+iron:router@=1.1.1
 [email protected]
 [email protected]
 [email protected]
@@ -36,7 +36,7 @@ dburles:google-maps
 [email protected]
 [email protected]
 mdg:validated-method
-fourseven:scss
+fourseven:scss@4.12.0
 [email protected]
 nooitaf:colors
 [email protected]
@@ -55,4 +55,7 @@ [email protected]
 useraccounts:iron-routing
 aldeed:template-extension
 useraccounts:bootstrap
-underscore
+[email protected]
+mrt:cookies@=0.3.0
+fortawesome:fontawesome
+dburles:collection-helpers

.meteor/release

@@ -1 +1 @@
-[email protected]
+[email protected]-issue-10516.0

.meteor/versions

@@ -44,6 +44,7 @@ cfs:[email protected]
 cfs:[email protected]
 [email protected]
 [email protected]
+dburles:[email protected]
 dburles:[email protected]
 [email protected]
 [email protected]
@@ -53,7 +54,7 @@ [email protected]
 [email protected]
 [email protected]
 [email protected]
-[email protected].4
+[email protected].7
 [email protected]
 [email protected]
 [email protected]
@@ -64,7 +65,8 @@ [email protected]
 [email protected]
 [email protected]
 [email protected]
-fourseven:[email protected]
+fortawesome:[email protected]
+fourseven:[email protected]
 [email protected]
 [email protected]
 [email protected]
@@ -79,7 +81,7 @@ iron:[email protected]
 iron:[email protected]
 iron:[email protected]
 iron:[email protected]
-iron:[email protected].2
+iron:[email protected].1
 iron:[email protected]
 [email protected]
 [email protected]
@@ -104,6 +106,7 @@ [email protected]
 [email protected]
 [email protected]
 [email protected]
+mrt:[email protected]
 mrt:[email protected]
 mrt:[email protected]
 msavin:[email protected]
@@ -156,7 +159,7 @@ [email protected]
 useraccounts:[email protected]
 useraccounts:[email protected]
 useraccounts:[email protected]
-[email protected].3
+[email protected].4-issue-10516.0
 [email protected]
 xolvio:[email protected]
 zodiase:[email protected]

README.md

@@ -1,12 +1,115 @@
-# CE Platform
-The Collective Experience (CE) Platform facilitates the creation and operation of collective experience applications. By building to cordova/iOS and distributing this project as a native app, experiences can be launched with native push notifications and users can be targeted by their location for context-specific experiences. Currently, the platform facilitates image and text submissions for experiences.
+## Collective Narrative
 
-## Setup and Local Development
+Collective Narrative is an extension of CE focused on collaborative storytelling. It allows authors to concisely write story "scripts" that are collaboratively played out and developed by participants. Currently, the repo contains "Murder Mystery," a CN script that allows three participants in different coffee shops to engage in a murder mystery centered around their current contexts. The following instructions detail how to test the murder mystery CN, how to write your own CN script, and how to continue development of the CN project.
+
+## CN Setup and Local Development
 1. Install Meteor `curl https://install.meteor.com/ | sh`.
 2. Clone the repository `git clone https://github.com/NUDelta/ce-platform.git`.
 3. Navigate to the project folder `cd ce-platform`.
 4. Run `meteor npm install` to install local dependencies.
 5. Start the server using `meteor`.
+6. Starting the server will also generate a python script for location testing. Copy and paste this script (labeled `FOR LOCATION TESTING RUN >>>>`) into a new terminal window to simulate users at specific locations.
+7. Navigate to `http://localhost:3000/` in your web browser to view the experience.
+8. For editing the codebase, we recommend using VS Code.
+
+### Murder Mystery Testing
+
+#### Local Testing
+
+For testing the murder mystery CN locally, use the following account credentials when signing in:
+
+1. username `meg`, password `password`
+2. username `andrew`, password `password`
+3. username `josh`, password `password`
+
+All three users need to sign in and participate in the murder mystery pre-story questionnaire before casting will begin. You can use different browsers or Private/Incognito mode to test the synchronous chat feature on a single computer. These default users can be modified in `testingconstants.js`.
+
+To test locally, you also need to ensure `host = "http://localhost:3000"` is uncommented in `simulatelocations.py`, and the other `host` definitions are commented.
+
+#### In-App Testing
+
+For the final Fall 2019 app, download the .ipa file [https://drive.google.com/file/d/13PUh_mMo_p1OhoEN-pidSyQtap5UC_ei/view?usp=sharing](here), then upload it to [diawi.com](www.diawi.com) to download it onto your iPhone.
+
+Then, go to [https://staging-ce-platform.herokuapp.com](https://staging-ce-platform.herokuapp.com) and open the browser console. From here, run the following commands:
+
+1. `Meteor.call(“freshDatabase")`
+2. `Meteor.call("createTestUsers")`
+
+Next, ensure `host = "https://staging-ce-platform.herokuapp.com"` is uncommented in `simulatelocations.py`, and the other `host` definitions are commented.
+
+Then, log in to [mhub.com](mhub.com) using the CE account credentials and navigate to the `users` collection within the `staging-ce-platform` database. Record the three `_id` values created for each test user.
+
+Lastly, run `python simulatelocations.py`, adding the `_id` values at the end. For example, `python simulatelocations.py ZrCZFhtfDStrXBGF2 K9ruF6p3uyrs7joR9 R7qfjYMJvyao8W2gN`.
+
+##### In-App Testing Notes
+
+If you've made changes to the code, you'll need to commit them and then run `git push staging collective-narrative:master` within the `ce-platform`directory to deploy these lastest changes to Heroku.
+
+Also, the .ipa link above should work even after you make changes to the CN-specific codebase, so don't worry about compiling a new iOS app every time you modify CN. If you do need to re-compile, follow the CE instructions copied in-part at the bottom of this readme.
+
+## CN Authoring Syntax
+
+At the core of the CN project is a concise syntax that makes authoring a CN accessible and easy. The syntax used to generate Murder Mystery can be viewed and modified in `cn.js`, which can be found at "imports" -> "api" -> "testing." Following are instructions on how to write your own CN, assuming you start with a blank `cn.js`.
+
+1. Start by declaring an export function. You must use the following name and syntax for the CN to be compiled properly: 
+```js
+export const cn = () => {
+
+}
+```
+2. Fill in the function with the eight required parameters of a CN. The first five are defined immediately while the last three start as empty arrays. The murder mystery CN can be referenced for examples of these parameters. Copy the parameters for the `templates` array exactly, as it refers to specific HTML templates currently required for CN.
+```js
+let title = 'Name of the CN'
+let description = 'Description of the CN, displayed on the Home tab of the Cerebro app'
+let notification = "Notification sent to the user's phone when the CN appears in their app"
+let setting = ['CE detector used to trigger the CN', 'description of what user context the detector refers to']
+let templates = ['CNstart', 'CNchat']
+let questions = []
+let characters = []
+let prompts = []
+```
+3. Define the pre-story questions. Each participant is asked these questions after they agree to participate in a CN. They can be used to further understand the contexts of each participant, allowing for a more engaging story. Each question is an object with three fields:
+```js
+let questionName = {
+    question: 'The question itself',
+    responseType: 'text or dropdown',
+    responseData: 'name of variable to store the text answer, or an array of the dropdown options'
+}
+```
+Remember to update the `questions` array with all of your questions objects.
+
+4. Define the characters that participants will be cast as. Currently, they'll define what kind of instruction the participant receives at the beginning of the synchronous chat. These are also objects with three fields:
+```js
+let characterName = {
+    roleName: 'name of the role',
+    instruction: 'Instructions given to the participant who is cast as this role. This is sent as a private message to the participant, so others cannot see it.',
+    context: ['An array containing the various user contexts, derived from question answers, that define if a participant is cast as this character'],
+    max: integer, defining how many people should be cast as this character
+}
+```
+Remember to update the `characters` array with all of your character objects.
+
+5. Define the prompts. These will be sent by a narrator in the group chat to all participants. They are crucial for building the narrative and guiding participants. They are also objects with three fields:
+```js
+let promptName = {
+    prompt: 'The prompt sent by the narrator',
+    info: 'Optional: the name of the responseData variable used in the prompt. It is appended to the end of the prompt.',
+    timing: integer, representing the number of seconds after casting occurs, used to time when the prompt is sent
+}
+```
+Remember to update the `prompts` array with all of your prompt objects.
+
+6. At the end of your function, return an array containing all of the parameters, in this order:
+```js
+return [title, description, notification, setting, templates, questions, characters, prompts];
+```
+
+### Notes
+
+- Templates currently conform to the CE concepts of `participateTemplate` and `resultsTemplate`, which are the HTML templates used to structure experiences in the Cerebro app. The goal is to have many different templates that satisfy different aspects of storytelling, allowing the author to use as many as they want to construct a story. But for now, exactly two templates need to be used, and only two are currently defined. The `CNstart` template allows for the pre-story questions that can further establish context before a CN. The `CNchat` template allows for synchronous storytelling experiences between participants and an author-defined narrator.
+- While experiences are currently fixed at three participants, the number will eventually be author-defined.
+
+## Additional CE Setup Notes
 
 ### Windows Subsystem for Linux Specific Setup
 
@@ -61,8 +164,8 @@ Exporting an iOS application as an `.ipa` file requires the `ceEnterpriseExport.
 ```xml
 <key>provisioningProfiles</key>
 <dict>
-    <key>edu.northwestern.delta.A</key>
-    <string>Delta Lab A</string>
+    <key>edu.northwestern.delta.D</key>
+    <string>Delta Lab D</string>
 </dict>
 ```
 ```xml
@@ -74,7 +177,7 @@ Push notifications are currently configured to work with the Enterprise A certif
 
 #### Export
 1. Navigate to `../Cerebro-ios/ios/project` and open the `.xcworkspace`. 
-2. Change the Bundle Identifier to the same identifier as in the provisioning profile above (here, `edu.northwestern.delta.A`). 
+2. Change the Bundle Identifier to the same identifier as in the provisioning profile above (here, `edu.northwestern.delta.D`). 
 3. Copy `ceEnterpriseExport.sh` and `exportOptions.plist` to the same directory as the `.xcworkspace`. Then, run `./ceEnterpriseExport.sh` to create the application.
 4. The `.ipa` can be found in the `Cerebro-export/` directory. Distribute your `.ipa` to testers using [diawi.com](www.diawi.com).
 

client/head.html

@@ -25,7 +25,6 @@
 
   <!-- Other header information goes here. -->
   <!-- This will be propagated through all files. -->
-  <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" />
   <link href='https://fonts.googleapis.com/css?family=Montserrat' rel='stylesheet' type='text/css'>
   <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet" type='text/css'>
   <link href="https://fonts.googleapis.com/css?family=Lato" rel="stylesheet">

client/main.js

@@ -3,6 +3,7 @@ import '/imports/startup/client';
 //TODO: what's all this? Do we need to add availabliity?
 if (Meteor.isDevelopment) {
   Schema = require('../imports/api/schema.js').Schema;
+  Messages = require('../imports/api/messages/messages.js').Messages;
   Experiences = require('../imports/api/OCEManager/OCEs/experiences.js').Experiences;
   Images = require('../imports/api/ImageUpload/images.js').Images;
   Incidents = require('../imports/api/OCEManager/OCEs/experiences.js').Incidents;

exportOptions.plist

@@ -8,8 +8,8 @@
         <string>enterprise</string>
         <key>provisioningProfiles</key>
         <dict>
-            <key>edu.northwestern.delta.A</key>
-            <string>Delta Lab A</string>
+            <key>edu.northwestern.delta.D</key>
+            <string>Delta Lab D</string>
         </dict>
         <key>signingCertificate</key>
         <string>iPhone Distribution</string>

imports/api/ImageUpload/server/publications.js

@@ -1,4 +1,4 @@
-import { Meteor } from 'meteor/meteor';
+// import { Meteor } from 'meteor/meteor';
 import { Images, Avatars } from '../images.js';
 
 Meteor.publish('images.activeIncident', function (incidentId) {

imports/api/Logging/groundtruth_log/methods.js

@@ -1,4 +1,4 @@
-import {Meteor} from "meteor/meteor";
+// import {Meteor} from "meteor/meteor";
 import { Locations } from "../../UserMonitor/locations/locations";
 import {Groundtruth_log} from "./groundtruth_log";
 

imports/api/Logging/page_log/methods.js

@@ -1,4 +1,4 @@
-import {Meteor} from "meteor/meteor";
+// import {Meteor} from "meteor/meteor";
 import {Page_log} from "./page_log";
 
 

imports/api/OCEManager/OCEs/experiences.js

@@ -1,4 +1,4 @@
-import { Meteor } from 'meteor/meteor';
+// import { Meteor } from 'meteor/meteor';
 import { Mongo } from 'meteor/mongo';
 import { SimpleSchema } from 'meteor/aldeed:simple-schema';
 
@@ -13,6 +13,10 @@ Schema.Callback = new SimpleSchema({
   },
   function: {
     type: String
+  },
+  chapter: {
+    type: Object,
+    optional: true,
   }
 });
 
@@ -26,6 +30,7 @@ Schema.SituationDescription = new SimpleSchema({
   detector: {
     type: String
   },
+  // sameTimeNumber (2 would mean that the situation requires 2 people to be in the situation at the same time)
   number: {
     type: Number,
   }
@@ -46,6 +51,10 @@ Schema.NeedType = new SimpleSchema({
     type: String,
     optional: true,
   },
+  participateTemplate: {
+    type: String,
+    optional: true,
+  },
   situation: {
     type: Schema.SituationDescription
   },
@@ -57,6 +66,13 @@ Schema.NeedType = new SimpleSchema({
   numberNeeded: {
     type: Number,
   },
+  // this is like a semaphore/mutex mechanism for participate routes as a resource a participant can latch onto
+  numberAllowedToParticipateAtSameTime: {
+    // if = 1, then this operates like a mutex
+    type: Number,
+    optional: true
+    // defaults to numberNeeded, like a semaphore.
+  },
   notificationDelay: {
     type: Number,
     optional: true,
@@ -103,6 +119,7 @@ Schema.Experience = new SimpleSchema({
   },
   participateTemplate: {
     type: String,
+    optional: true
   },
   resultsTemplate: {
     type: String,