bht_survey 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5489830167b8c53332b96ddbe1ce28177463ae9
-  data.tar.gz: 96cb2ea70396e561435cd35368d922a085244be1
+  metadata.gz: c684b9b4714d3b27caf69a72e5a699383ef8ea1b
+  data.tar.gz: 33e35080bc3b276d3cd9b6cd5d201781ddc2dbd5
 SHA512:
-  metadata.gz: '0419eb42a98681acfb110f552bd08ee6785b0c22f60d7f7937aaafd6886ac5c912804954f261a909de9c488392451484e396856632bd783d84e4c87946cf80ee'
-  data.tar.gz: 83d9094d6b53c19e6e1b01823d01c46fb8c14c9bbdbfdfbf3db9c58d4ed143387b7000d4ab3ddff7ca06aff9e2268f51e79fa5cd77d055ea132969657f71114b
+  metadata.gz: 72c18d4c679891ba54a8f0ac7e0f337f0f72bb9a6d22c9b89bb58d37d6b36b31e8e0bf259c84f91d2a28d0704231a22e7ddb9b894ac24f940f67ccc5c3765b94
+  data.tar.gz: b1d37f736e6dfaf893fd64faaaca62c1284c3c3ce568d33ef56465742b6c7e5446309a91e52a4bcb1fe75f581cd2d2087abddfc670230fcfa95332c0d200e8d1

data/README.md

@@ -1,8 +1,6 @@
 # BhtSurvey
 
-This is a simple wrapper for Faraday access to the Qualtric Interface Service.  It generates the workspace key separately from individual API calls.   
-
-
+This is a wrapper for Faraday access to the Qualtric Interface Service.  It generates the workspace key separately from individual API calls.   
 
 ## Installation
 
@@ -15,20 +13,41 @@ gem 'bht_survey'
 And then execute:
 
     $ bundle
+    $ rake assets:precompile
 
-Or install it yourself as:
+## Usage
 
-    $ gem install bht_survey
+Application Controller Code needed for workspace and status callback
 
-## Usage
+  include QualtricsInterface
+  # Use API_URL to override the default API Server
+  def set_workspace
+    @user = Account.where(user: session[:user]).first
+    @workspace = {
+      'qualtrics_id' => @user.qualtrics_id,
+      'qualtrics_library' => @user.library_id,
+      'study_workspace_name' => 'Shuti-Gold-Test'
+    }
+  end
 
-TODO: Write usage instructions here
+  To post status as 'in progress' override this method
+    - def process_link_clicked_event participant_id, survey_name
 
-## Development
+  To open the Survey in a new tab be sure to update application.js by adding 
+    - //= require qualtrics_survey
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Usage
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Controller
+  
+  get_participant_state participant_id, survey_name
+    - returns 0,1,2
+  get_participant_link(participant_id, survey_name)['unique_link']
+    - returns link to qualtrics
+View
+  qualtrics_link participant_id, survey_name
+    - opens the link in a new tab,
+    - calls process_link_clicked_event participant_id, survey_name  
 
 ## Contributing
 

data/app/assets/javascripts/qualtrics_survey.js

@@ -0,0 +1,21 @@
+// Open the qualtrics survey link in another tab
+$(document).ready(function(){
+  $('.survey_link a').on('click', function(){
+    $.get({
+      url: this.href,
+        success: function(response){
+        link = response['unique_link']
+         window.open(link, '_blank')
+      },
+      dataType: 'json'
+    })
+    return false;
+  });
+});
+// Refresh the RICE page when focus returns to the RICE tab
+document.addEventListener('visibilitychange', function(){
+  if (!document['hidden']) {
+    location.reload()
+  }  
+})
+

data/app/helpers/qualtrics_link_helper.rb

@@ -0,0 +1,11 @@
+module QualtricsLinkHelper
+  def qualtrics_link participant_id, survey_name, button_name=survey_name
+  html = "<div class='survey_link'><a href='"
+  html << "/qualtrics_surveys?participant_id=" +
+    participant_id.to_s + "&survey_name=" +survey_name.to_s
+  html << "'>"
+    html << button_name
+    html << " </div>"
+    html  = html.html_safe
+  end
+end	

data/bht_survey.gemspec

@@ -33,5 +33,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_dependency "rails", "~> 5.0" 
-
 end

data/lib/bht_survey/qualtrics_interface.rb

@@ -32,7 +32,15 @@ module QualtricsInterface
       result = get_api 'api/v1/participant_states', api_params
       result['response']
     end
-   
+
+    def get_participant_state participant_id, survey_name
+      states = get_participant_states participant_id
+      result = states.detect{|state|state['name'] == survey_name}
+      state = result && result['status']
+      flags = {nil => 0, 'not_started' => 0, 'in progress' => 1, 'responded' => 2}
+      flags[state] || 0
+    end
+
     def get_participant_link participant_id, survey_name
       api_params = {workspace_key: get_workspace_key, participant_id: participant_id, assessment_name: survey_name}
       result = get_api 'api/v1/participant_link', api_params

data/lib/bht_survey/version.rb

@@ -1,3 +1,3 @@
 module BhtSurvey
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bht_survey
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - jfinucane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-24 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,7 +83,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/javascripts/qualtrics_survey.js
 - app/controllers/bht_survey/qualtrics_surveys_controller.rb
+- app/helpers/qualtrics_link_helper.rb
 - bht_survey.gemspec
 - bin/console
 - bin/setup