social_networking 0.9.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f586ac64eb17b2f8424001075709860a9128924
+  data.tar.gz: dda19a3c5e433c7bd6998313997d7c90f13fe891
+SHA512:
+  metadata.gz: 66e84b795ad20e68b4564410c9d6e6b81a7dedc971ce8f6535af75da5a9c387dac7eed2e1f88ddbfbb8f9ad475cef2874103d551b8f0bb9b2a47c64a8dfe5331
+  data.tar.gz: 5b3690ef9cbc6aa4831886383626d8dda734bb8d637ffbbd53d3484efb259c32bcecd0aa6315ee76924298302010ea75de99999923d4ab081df7cb09ddbb4589

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# SocialNetworking
+
+Server and client components for social networking functionality.
+
+## Assumptions
+
+This engine expects there to be a Devise-like API available, and an
+authenticatable `Participant` class stored in a `participants` table.
+
+## Installation
+
+Add to your `Gemfile`
+
+    gem 'social_networking', git: 'git://github.com/cbitstech/social_networking.git'
+
+Then
+
+    bundle install
+
+Add the migrations and run them
+
+    rake social_networking:install:migrations db:migrate
+
+Install PhantomJS
+
+    Download: http://phantomjs.org/download.html
+    Add the unzipped /bin folder to your $PATH:
+    ---
+    export PHANTOM_JS=$HOME_DIR/tools/phantomjs-1.9.7-linux-x86_64/bin/
+    PATH=$PATH:$PHANTOM_JS
+    ---
+
+## Usage
+
+Mount the engine in `config/routes.rb`
+
+    mount SocialNetworking::Engine, at: "social_networking"
+
+Include the JavaScript in your 'engine' manifest
+
+    //= require social_networking
+
+## Run Ruby specs
+
+Create the database
+
+    rake app:db:create app:db:migrate
+
+Run the specs
+
+    rake spec
+
+## Run JavaScript specs
+
+    RAILS_ENV=test rake js_spec
+
+## Run Ruby linter
+
+    rake rb_lint
+
+## Run JSHint
+
+    rake jshint
+
+## Development
+
+Note that when updating Angular, it is necessary to update
+`spec/javascripts/helpers/angular-mocks.js`.
+
+## Publishing to RubyGems
+
+Build the `social_networking` gem
+
+```console
+gem build social_networking.gemspec
+```
+
+Publish to [rubygems.org](https://rubygems.org)
+
+```console
+gem push social_networking-x.x.x.gem
+```
+
+View the published `social_networking` gem [here](https://rubygems.org/gems/social_networking)

data/Rakefile

@@ -0,0 +1,66 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+load "rails/tasks/engine.rake"
+load "lib/tasks/seed.rake"
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), "tasks/**/*.rake")].each { |f| load f }
+
+require "rspec/core"
+require "rspec/core/rake_task"
+
+desc "Run all Ruby specs"
+RSpec::Core::RakeTask.new(spec: "app:db:test:prepare")
+
+desc "Run all JS specs"
+task :js_spec do
+  Rake::Task["app:spec:javascript"].invoke
+end
+
+desc "Run all specs"
+task :all_spec do
+  Rake::Task["spec"].invoke
+  Rake::Task["js_spec"].invoke
+end
+
+require "jshintrb/jshinttask"
+Jshintrb::JshintTask.new :jshint do |t|
+  t.pattern = "app/assets/javascripts/**/*.js"
+  t.options = :defaults
+  t.globals = [:angular, :moment, "$"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+desc "Run Brakeman"
+task :brakeman do
+  dir = File.dirname(__FILE__)
+  puts `#{ File.join(dir, "bin", "brakeman") } #{ File.join(dir, ".") }`
+end
+
+desc "Run all linters"
+task :lint do
+  Rake::Task["brakeman"].invoke
+  Rake::Task["jshint"].invoke
+  Rake::Task["rubocop"].invoke
+end
+
+desc "Run all specs and linters"
+task :spec_lint do
+  Rake::Task["all_spec"].invoke
+  Rake::Task["lint"].invoke
+end
+
+task default: :spec_lint
+
+git_tagger = Gem::Specification.find_by_name "git_tagger"
+load "#{git_tagger.gem_dir}/lib/tasks/deploy.rake"

data/app/assets/javascripts/notices.js

@@ -0,0 +1,92 @@
+(function() {
+  "use strict";
+  
+  function Notice() {
+    var toastTimeout = 7000;
+
+    this.actionNotice = function(actionType, description, participantId) {
+      var self = this;
+      this.behaviorPostNotice(actionType, description, participantId);
+      setTimeout(
+        function () {
+          self.incentivePostNotice(actionType, description, participantId);
+        }, 3000);
+    };
+
+    this.incentivePostNotice = function(actionType, description, participantId) {
+      var self = this;
+      $.ajax({
+        type: "POST",
+        url: "/participant_incentives/complete",
+        data: {
+          "participant_id": participantId,
+          "action_type": actionType
+        },
+        success: function (data, status) {
+          if ('success' === status) {
+            self.incentivRealTimeToast(description);
+          }
+        }
+      });
+    };
+
+    this.behaviorPostNotice = function(actionType, description, participantId) {
+      var self = this;
+      $.ajax({
+        type: "POST",
+        url: "/participant_behaviors/complete",
+        data: {
+          "participant_id": participantId,
+          "action_type": actionType
+        },
+        success: function (data, status) {
+          if ('success' === status) {
+            self.behaviorRealTimeToast(description);
+          }
+        }
+      });
+    };
+
+    this.incentiveToastView = function(incentiveId, description) {
+      this.realTimeToast("incentive", description);
+      setTimeout(
+        function () {
+          $.ajax({
+            type: "PATCH",
+            url: "/participant_incentives/" + incentiveId + "/complete"
+          });
+        }, toastTimeout);
+    };
+
+    this.behaviorToastView = function(behaviorId, description) {
+      this.realTimeToast("behavior", description);
+      setTimeout(
+        function () {
+          $.ajax({
+            type: "PATCH",
+            url: "/participant_behaviors/" + behaviorId + "/complete"
+          });
+        }, toastTimeout);
+    };
+
+    this.incentivRealTimeToast = function(description) {
+      this.realTimeToast('incentive', description);
+    };
+
+    this.behaviorRealTimeToast = function(description) {
+      this.realTimeToast('behavior', description);
+    };
+
+    this.realTimeToast = function(type, description) {
+      $.toaster(
+        {
+          title: 'Congratulations',
+          priority: 'success',
+          message: 'you completed the ' + type + ': ' + description,
+          settings: {timeout: toastTimeout}
+        });
+    };
+  }
+
+  window.Notice = new Notice();
+}());

data/app/assets/javascripts/shared/new_shareable_form.js.erb

@@ -0,0 +1,28 @@
+<% template = File.join(SocialNetworking::Engine.root, 'app/views/social_networking/shared/_sharing_fields.html') %>
+<% js_helper = Class.new.extend(ActionView::Helpers::JavaScriptHelper) %>
+
+;(function() {
+  function addSharingToNewShareableForm() {
+    'use strict';
+
+    var actionType,
+        displayName,
+        itemType,
+        placeholder, 
+        template;
+
+    placeholder = $('.new-shareable-form-after-form-groups');
+    actionType = placeholder.data('actionType');
+    itemType = placeholder.data('itemType');
+    template = '<%= js_helper.j(Erubis::Eruby.new(File.read(template)).result) %>';
+    displayName = itemType;
+    if (displayName) {
+      displayName = displayName.replace('_', ' ');
+    }
+    template = template.replace(/{{ ITEM_TYPE }}/g, itemType).replace(/{{ ITEM_TYPE_DISPLAY }}/g, displayName).replace(/{{ ACTION_TYPE }}/g, actionType);
+
+    placeholder.append(template);
+  };
+
+  $(document).on('page:change', addSharingToNewShareableForm);
+})();

data/app/assets/javascripts/social_networking/app.js

@@ -0,0 +1,15 @@
+// Create the socialNetworking module and specify its required submodules.
+angular.module('socialNetworking', [
+  'ngResource',
+  'infinite-scroll',
+  'socialNetworking.controllers',
+  'socialNetworking.filters',
+  'socialNetworking.directives',
+  'socialNetworking.services',
+  'socialNetworking.values'
+]);
+
+// Define submodules.
+angular.module('socialNetworking.controllers', []);
+angular.module('socialNetworking.services', []);
+angular.module('socialNetworking.values', []);

data/app/assets/javascripts/social_networking/controllers/goal-controller.js

@@ -0,0 +1,166 @@
+;(function() {
+  "use strict";
+
+  // Provides management of goals.
+  function GoalCtrl(GoalService, goalTool, currentGoals,
+                    studyEndDate, noticesEnabled, noticeUtility) {
+    this._goals = GoalService;
+    this._goalTool = goalTool;
+    this.goalModel = this._goalTool.getModel();
+    this.participantGoals = currentGoals;
+    this.studyEndDate = studyEndDate;
+    this.noticesEnabled = noticesEnabled;
+    this.noticeUtility = noticeUtility;
+
+    this.resetForm();
+    this.resetTabs();
+    if (typeof $ !== 'undefined') {
+      $("#help-pop").popover({
+        html: true
+      });
+    }
+  }
+
+  // Is this only available for goal browsing?
+  GoalCtrl.prototype.inBrowseMode = function() {
+    return this._goalTool.getMode() === this._goalTool.MODES.BROWSE;
+  };
+
+  // Is this available for goal entry?
+  GoalCtrl.prototype.inEntryMode = function() {
+    return this._goalTool.getMode() === this._goalTool.MODES.ENTRY;
+  };
+
+  // Open a form.
+  GoalCtrl.prototype.new = function() {
+    this._goalTool.edit();
+  };
+
+  GoalCtrl.prototype.edit = function(goal) {
+    this._goalTool.edit(goal);
+  };
+
+  // Persist the isCompleted attribute to the server.
+  GoalCtrl.prototype.toggleComplete = function(currentGoal) {
+    if (window.confirm("Are you sure you would like to mark this goal as complete? This action cannot be undone.")) {
+      currentGoal.isCompleted = !currentGoal.isCompleted;
+      this._goals.update(currentGoal)
+        .catch(function(goal) {
+          currentGoal.isCompleted = goal.isCompleted;
+        });
+      if(this.noticesEnabled && this.noticeUtility) {
+        this.noticeUtility.actionNotice("SocialNetworking::Goal",
+                            "Complete a goal.",
+                            currentGoal.participantId);
+      }
+    }
+  };
+
+  // Persist the isDeleted attribute to the server.
+  GoalCtrl.prototype.toggleDeleted = function(currentGoal) {
+    if (window.confirm("Are you sure you would like to delete this goal? This action cannot be undone.")) {
+      currentGoal.isDeleted = !currentGoal.isDeleted;
+      this._goals.update(currentGoal)
+        .catch(function (goal) {
+          currentGoal.isDeleted = goal.isDeleted;
+        });
+    }
+  };
+
+  // Persist a goal from the form.
+  GoalCtrl.prototype.save = function() {
+    var self = this;
+
+    if (this._goalTool.getModel().id === null) {
+      this._goals.create(this._goalTool.getModel())
+        .then(function(goal) {
+          self.resetForm();
+          self.participantGoals.push(goal);
+          self.resetTabs();
+          if(self.noticesEnabled && self.noticeUtility) {
+            self.noticeUtility.actionNotice("SocialNetworking::Goal",
+                                "Create a goal.",
+                                goal.participantId);
+          }
+        })
+        .catch(function(message) {
+          self.error = message.error;
+        });
+    } else {
+      this._goals.update(this._goalTool.getModel())
+        .then(function(goal) {
+          // Update the model in the collection.
+          self.participantGoals.some(function(g, i, array) {
+            if (g.id === goal.id) {
+              self._goalTool.copy(goal, g);
+
+              return true;
+            }
+
+            return false;
+          });
+          self.resetForm();
+          self.resetTabs();
+        })
+        .catch(function(message) {
+          self.error = message.error;
+        });
+    }
+  };
+
+  // Undo any changes.
+  GoalCtrl.prototype.resetForm = function() {
+    this._goalTool.setModel();
+    this._goalTool.setMode(this._goalTool.MODES.BROWSE);
+  };
+
+  GoalCtrl.prototype.resetTabs = function() {
+    this._goalTool.setFilter('all');
+    this._goalTool.setTab('all');
+  };
+
+  GoalCtrl.prototype.setTab = function(name) {
+    this._goalTool.setTab(name);
+  };
+
+  GoalCtrl.prototype.getTab = function() {
+    return this._goalTool.getTab();
+  };
+
+  GoalCtrl.prototype.dateInNWeeks = function(week_number) {
+    if (week_number) {
+      return moment().add(week_number, 'weeks').format('MMM DD YYYY');
+    } else {
+      return null;
+    }
+  };
+
+  GoalCtrl.prototype.dateAtEndOfTrial = function() {
+    if (this.studyEndDate && moment(this.studyEndDate) > moment()) {
+      return moment(this.studyEndDate).format("MMM DD YYYY");
+    } else {
+      return null;
+    }
+  };
+
+  GoalCtrl.prototype.atLeastNWeeksLeftInTrial = function(week_number) {
+    week_number = week_number || 0;
+
+    return moment().add(week_number, 'weeks')
+      .isBefore(moment(this.studyEndDate));
+  };
+
+  GoalCtrl.prototype.setFilter = function(type) {
+    this._goalTool.setFilter(type);
+  };
+
+  GoalCtrl.prototype.getFilter = function() {
+    return this._goalTool.getFilter();
+  };
+
+  // Create a module and register the controller.
+  angular.module('socialNetworking.controllers')
+    .controller('GoalCtrl', ['Goals', 'goalTool', 'currentGoals',
+                'participantStudyEndDate', 'noticesEnabled',
+                'noticeUtility', GoalCtrl]);
+})();