RubyGems - bht_survey - Versions diffs - 0.7.0 → 0.8.0 - Mend

bht_survey 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dc4241101ce69628262589428f675856c86bc9d
-  data.tar.gz: 936e59f6e7cb8c9b3475d9ea4bbc7eab3d98126d
+  metadata.gz: 211e992fe10e1f31f8f25030139ba555f7486e2c
+  data.tar.gz: 59312878717278bb730abcf176b073be63e720e4
 SHA512:
-  metadata.gz: 8709980101001d9fc65c514cde20a7a6fc81937b45fbdce097807a8235bc4ccae61985ca0dc8bca0185861a2ce740909cd393c34b5b46cd608f5c19c34015666
-  data.tar.gz: bb09621421f56b158483ee07a85389ca13ec8c8c15d434491328ffa14822bb2ab3e57999c5e6fe19e9f8fb7be1ba73195132cb139102aac4be366d593fe2c799
+  metadata.gz: ed541a1279581111037243b8e429748863df836585fbb4c81c7e8dbd6880cd1ad3e3834215c5389f1947cdb8af3c6eec9a0381cee61faf18026ba44f5665f91b
+  data.tar.gz: 1755dcd36df458d0e4e83be4c2707dfec45aca328ac9d32750fdaaefbe96c3002b384b09a6b09b40a04b8a23b975fffa4c3faadbc246638cfa8fac7d5db8b980

data/README.md CHANGED Viewed

@@ -1,20 +1,3 @@
-# BhtSurvey
-This is a wrapper for Faraday access to the Qualtric Interface Service.  It generates the workspace key separately from individual API calls.
-## Installation
-Add this line to your application's Gemfile:
-```ruby
-gem 'bht_survey'
-```
-And then execute:
-    $ bundle
-    $ rake assets:precompile
 ## Development
 Application Controller Code needed for workspace and status callback
@@ -26,9 +9,9 @@ Application Controller Code needed for workspace and status callback
     ENV['API_URL'}                      ||= 'http://api-assessment.bhtcloud.org/'
     ENV['QUALTRICS_ID']                 =  'a qualtrics api token'
     ENV['QUALTRICS_LIBRARY']            =  'a qualtrics library id'
-    ENV['STUDY_WORKSPACE_NAME']         =  'a study name plus optional suffix like Test'
+    ENV['STUDY_WORKSPACE_NAME']         =  'a unique name for the study on a specific deploy'
-## Usage
+## Interface
     Controller
@@ -36,18 +19,161 @@ Application Controller Code needed for workspace and status callback
             - returns 'not started', 'in progress', 'responded'
         get_participant_link(participant_id, survey_name)['unique_link']
             - returns link to qualtrics
+        get_results(participant_id, survey_name)['answers']
+            - returns a hash of question=>respose values
+## Usage
-    View Helper
-        qualtrics_link participant_id, survey_name
-        	- opens the link in a new tab,
-        	- calls process_link_clicked_event participant_id, survey_name
-## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/jfinucane/bht_survey.
-## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+    Participants have activities thru the activity_participants join record.   Typical activities are:
+      interest
+      consent
+      phone (phone assessment)
+      time_1  (pre)
+      time_2  (post)
+      time_3  (post_6)
+      time_4  (post_12)
+    The survey name referenced in the interface is:
+    survey_name = ENV['STUDY_WORKSPACE_NAME'] + '-' + activity
+   #### app/helpers/shuti/study_helper.rb   (see git blame for lines 40-70)
+        There is a horrific method called main_btn_state that governs the appearance
+        of the big yellow button on the landing page for the intervention.
+        Here is an extension of that code.   Style Notes:  the ruby multiple assignment syntax is used:
+         a,b= something.  Obviously this code could be refactored
+          include QualtricsInterface
+          def assessment_status assessment_key
+            main_button=[]
+            @participant = Participant.find(@participant.id)
+            assessment_uuid = Activity.find_by(key: assessment_key).uuid
+            if @participant.assessment_available_or_in_progress?(assessment_key[-1])
+              survey_name = ENV['STUDY_WORKSPACE_NAME'] + '-' + assessment_key
+              main_button[0] = activities_path(survey_name: survey_name, activity_uuid: assessment_uuid)
+              state = get_participant_state(@participant.id, survey_name)
+              main_button[1] = "#{state == 'not started' ? 'Start' : 'Continue'} #{assessment_key.humanize} Survey"
+              if state == 'responded'
+                #STALE CACHE WORKAROUND
+                raise StaleAASMException unless @participant.activity(assessment_key).in_progress?
+                @participant.activity(assessment_key).complete!
+              end
+            end
+            [@participant.assessment_available_or_in_progress?(assessment_key[-1]), main_button]
+          end
+          def main_btn_state
+            unless @main_btn_state
+              @main_btn_state = []
+              if ['Experimental', 'Control'].include?(@participant.participant_type)
+                assessment_active, @main_btn_state = assessment_status 'time_4'
+                return @main_btn_state if assessment_active && @participant.study_phase == 'time_4'
+                assessment_active, @main_btn_state = assessment_status 'time_3'
+                return @main_btn_state if assessment_active && @participant.study_phase == 'time_3'
+                assessment_active, @main_btn_state = assessment_status 'time_2'
+                return @main_btn_state if assessment_active && @participant.study_phase == 'time_2'
+                assessment_active, @main_btn_state = assessment_status 'time_1'
+                return @main_btn_state if assessment_active && @participant.study_phase == 'time_1'
+              end
+ #### app/controllers/activities/assessments_controller.rb
+        The assessment links are accessed by a redirect from the main button state.  We redirect to the start route
+        in the Assesments controller to set the in progress state.
+        We redirect from Qualtrics to the complete route in order to update the assessment to complete.
+            class Activities::AssessmentsController < ApplicationController
+              include QualtricsInterface
+              prepend_before_action only: [:complete] { request.env["devise.skip_timeout"] = true }
+              def start
+                survey_name = params['survey_name']
+                activity_key = Activity.uuid_to_key(params['activity_uuid'])
+                participant = current_user.participant
+                activity = participant.activity(activity_key)
+                activity.start! unless activity.in_progress?
+                #STALE CACHE WORKAROUND
+                raise StaleAASMException unless activity.in_progress?
+                link = get_participant_link(participant.id, survey_name)['unique_link']
+                redirect_to link
+              end
+              def complete
+                participant = current_user.participant
+                activity_key = Activity.uuid_to_key(params['assessment_uuid'])
+                participant.activity(activity_key).complete!
+                redirect_to root_path
+              end
+ #### app/controllers/activities/consents_controller.rb
+       The consent links are accessed by a similar controller.
+            class Activities::ConsentsController < ActionController::Base
+              include QualtricsInterface
+              before_action :init_session
+              def init_session
+                session[:init] = true
+              end
+              def start
+                uuid=params[:uuid]
+                survey_name = ENV['STUDY_WORKSPACE_NAME'] + '-' + 'consent'
+                participant = User.find_by(uuid: uuid).participant
+                link = get_participant_link(participant.id, survey_name)['unique_link']
+                activity = participant.activity('consent')
+                activity.start! unless activity.in_progress?
+                redirect_to link
+              end
+              def complete
+                CompleteConsentWorker.new.perform
+                redirect_to consent_thanks_path
+              end
+              def download
+                send_file(
+                    "#{Rails.root}/consent_forms/pid_#{params[:id]}_consent_form.pdf",
+                    filename: "pid_#{params[:id]}_consent_form.pdf",
+                    type: 'application/pdf'
+                )
+              end
+            end
+            The actual Consent completion process is handled by
+   ###### app/workers/complete_consent_worker.rb
+            The actual Consent completion process invoked by the complete function. This worker synchronously
+            updates the status of the Participant, allowing the study to proceed.
+   ###### app/workers/generate_consent_pdf_worker.rb
+            The Consent form PDF generation invoked with perform_async by the Consent completion worker.
+            It should be possible for this worker to fail and be retried by Sidekiq.   When this succeeds
+            it also sends an email with the PDF.
+### Qualtrics callbacks
+           The Qualtrics callback for a survey is build with the UUID of an activity.   This
+           callback is found under Survey Options on Qualtrics.  Near the bottom of the options
+           is an option to enter a Redirect URL.
+           Here's a example for localhost testing.
+           http://localhost:3000/activities/assessments/complete/045939cd-7ede-47c3-9ae9-3022521c11d
+           This is routed to a completion endpoint.
+           which converts that UUID into a activity, like time_1.
+           Then it updates the status of the current participant.
+           These UUIDs are in db/seeds/activities.seeds.rb.
+           Here is what the consent form callback URL looks like for localhost.
+           http://localhost:3000/activities/consents/complete

data/bht_survey.gemspec CHANGED Viewed

@@ -6,8 +6,8 @@ require 'bht_survey/version'
 Gem::Specification.new do |spec|
   spec.name          = "bht_survey"
   spec.version       = BhtSurvey::VERSION
-  spec.authors       = ["jfinucane"]
-  spec.email         = ["jimway@gmail.com"]
+  spec.authors       = ["gdh7y", "spj4g"]
+  spec.email         = ["gdh7y@virginia.edu", "spj4g@virginia.edu"]
   spec.summary       = %q{Shim for Faraday access to the APIs of Qualtrics Interface Service}
   spec.description   = %q{#Requires a hash with three key values
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
     #Requires an API_URL to access the Qualtrics Interface Service
   }
-  spec.homepage      = "https://github.com/jfinucane/bht_survey.git"
+  spec.homepage      = "https://github.com/BHT/bht_survey.git"
   spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -33,4 +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
+end

data/lib/bht_survey/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module BhtSurvey
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata CHANGED Viewed

@@ -1,69 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: bht_survey
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
-- jfinucane
+- gdh7y
+- spj4g
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
 description: "#Requires a hash with three key values\n       #@workspace = {\n      'qualtrics_id'
@@ -71,14 +72,15 @@ description: "#Requires a hash with three key values\n       #@workspace = {\n
   \     'study_workspace_name' => 'Shuti-Example'\n    }\n    #Requires an API_URL
   to access the Qualtrics Interface Service\n  "
 email:
-- jimway@gmail.com
+- gdh7y@virginia.edu
+- spj4g@virginia.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,7 +96,7 @@ files:
 - lib/bht_survey/engine.rb
 - lib/bht_survey/qualtrics_interface.rb
 - lib/bht_survey/version.rb
-homepage: https://github.com/jfinucane/bht_survey.git
+homepage: https://github.com/BHT/bht_survey.git
 licenses:
 - MIT
 metadata: {}
@@ -104,17 +106,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.5.1
+rubygems_version: 2.0.14.1
 signing_key:
 specification_version: 4
 summary: Shim for Faraday access to the APIs of Qualtrics Interface Service