Merge branch 'release/0.5.0'

Author: abought

.editorconfig

@@ -11,24 +11,24 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = space
-indent_size = 2
+indent_size = 4
 
 [*.js]
 indent_style = space
-indent_size = 2
+indent_size = 4
 
 [*.hbs]
 insert_final_newline = false
 indent_style = space
-indent_size = 2
+indent_size = 4
 
 [*.css]
 indent_style = space
-indent_size = 2
+indent_size = 4
 
 [*.html]
 indent_style = space
-indent_size = 2
+indent_size = 4
 
 [*.{diff,md}]
 trim_trailing_whitespace = false

.env-travis

@@ -0,0 +1,7 @@
+OSF_CLIENT_ID=CLIENT_ID>
+OSF_SCOPE=osf.users.all_read
+OSF_URL=https://staging.osf.io
+OSF_AUTH_URL=https://staging-accounts.osf.io
+
+JAMDB_URL=https://staging-metadata.osf.io
+EXPERIMENT_ID=<STUDY_ID>

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,10 @@
+Refs: https://openscience.atlassian.net/browse/LEI-
+
+## Purpose
+
+
+## Summary of changes
+
+
+## Testing notes
+

.gitignore

@@ -15,3 +15,17 @@
 /libpeerconnection.log
 npm-debug.log
 testem.log
+/scripts/credentials/*
+
+# local configuration
+.env
+.env-local
+env
+
+# Misc
+/scripts/*.json
+/scripts/*.csv
+
+/scripts/consent_forms/*csv
+/scripts/consent_forms/**
+!/scripts/consent_forms/test.csv

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib"]
+	path = lib
+	url = https://github.com/CenterForOpenScience/exp-addons.git

.jshintrc

@@ -27,6 +27,6 @@
   "strict": false,
   "white": false,
   "eqnull": true,
-  "esnext": true,
+  "esversion": 6,
   "unused": true
 }

.travis.yml

@@ -1,7 +1,7 @@
 ---
 language: node_js
 node_js:
-  - "4"
+  - "4.6.0"
 
 sudo: false
 
@@ -10,9 +10,11 @@ cache:
     - node_modules
 
 before_install:
+  - cp .env-travis .env
+  - export PATH=/usr/local/phantomjs-2.0.0/bin:$PATH
   - npm config set spin false
+  - npm install -g npm@^2
   - npm install -g bower
-  - npm install phantomjs-prebuilt
 
 install:
   - npm install

NOTICE

@@ -0,0 +1,17 @@
+ISP uses some third-party code.
+
+
+locale-utils adapted from ember-i18n internals code
+====================================================
+## Copyright and license
+
+Copyright 2011 James A. Rosen
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations under the License.

README.md

@@ -20,11 +20,47 @@ You will need the following things properly installed on your computer.
 * `npm install`
 * `bower install`
 
+### Install submodule dependencies
+
+```bash
+cd lib
+git submodule init
+git submodule update
+```
+
+You may need to run the npm and bower install commands in `lib/exp-player` and `lib/exp-models` as well.
+
 ## Running / Development
 
+Setup instructions are broadly derived from those of the [experimenter addon](https://github.com/CenterForOpenScience/experimenter/). 
+For most use cases, it should be possible to run against a remote installation of JamDB. The instructions below assume a staging server, 
+`https://staging-metadata.osf.io`.
+
+To login via OSF:
+* create .env file in top directory
+* in .env file include:
+  * OSF_CLIENT_ID=\<client ID for staging account\>
+  * OSF_SCOPE="osf.users.all_read"
+  * OSF_URL="https://staging.osf.io"
+  * OSF_AUTH_URL=https://staging-accounts.osf.io
+  * JAMDB_URL=https://staging-metadata.osf.io
+  * EXPERIMENT_ID=\<jam db document ID referencing the desired ISP study\>
+
+* Find jam db document id at: https://staging-experimenter.osf.io/experiments/ (this is the EXPERIMENT_ID)
+* Create a new participant at https://staging-experimenter.osf.io/participants
+  * Study ID: test
+  * Participant ID: <look in the downloaded csv file>
+
+Then run the ember application:
+
 * `ember server`
 * Visit your app at [http://localhost:4200](http://localhost:4200).
 
+### Trying an experiment
+Once the app is started, you will need to log in. Provide a study ID and participant ID. 
+These are human readable strings as defined by the researchers, and are available on request (not committed to Github). 
+There may be different study IDs to test conditions at different times of day.
+
 ### Code Generators
 
 Make use of the many generators for code, try `ember help generate` for more details

app/authenticators/jam-jwt.js

@@ -0,0 +1,25 @@
+import Ember from 'ember';
+import ExpJamJwtAuthenticator from 'exp-models/authenticators/jam-jwt';
+
+export default ExpJamJwtAuthenticator.extend({
+  raven: Ember.inject.service(),
+
+  _captureUser(username) {
+    this.get('raven').callRaven('setUserContext', { id: username });
+  },
+
+  restore(data) {
+    return this._super(data).then((res) => {
+      this._captureUser(res.id);
+      return res;
+    });
+  },
+
+  authenticate(attrs, token) {
+    return this._super(attrs, token).then((res) => {
+      this._captureUser(res.id);
+      return res;
+    });
+  }
+
+});