bht_survey 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c684b9b4714d3b27caf69a72e5a699383ef8ea1b
-  data.tar.gz: 33e35080bc3b276d3cd9b6cd5d201781ddc2dbd5
+  metadata.gz: ba82037e1b058c4ecf7430289db392d0a7f5b465
+  data.tar.gz: 5de73a69ee23d588e0ea26e4f51e4884d15525c7
 SHA512:
-  metadata.gz: 72c18d4c679891ba54a8f0ac7e0f337f0f72bb9a6d22c9b89bb58d37d6b36b31e8e0bf259c84f91d2a28d0704231a22e7ddb9b894ac24f940f67ccc5c3765b94
-  data.tar.gz: b1d37f736e6dfaf893fd64faaaca62c1284c3c3ce568d33ef56465742b6c7e5446309a91e52a4bcb1fe75f581cd2d2087abddfc670230fcfa95332c0d200e8d1
+  metadata.gz: d4a0113603ff21a86fb027b7d9bf6ea548d873dac2f813e18e6647b34e1d8a2af514c25513b0e3ff99723eb0c3ce498b0edb69623e05a628d8886563de9a2035
+  data.tar.gz: cd96148fa88c863fc7d2ba6d41a9849686cc4c3006ebeca39ba1fdb17c7d375c799240f22f1f84e30bb61f3ca78260239c65c63c16e3e79efea9e94ec8d92f30

data/README.md

@@ -15,39 +15,32 @@ And then execute:
     $ bundle
     $ rake assets:precompile
 
-## Usage
+## Development
 
 Application Controller Code needed for workspace and status callback
 
-  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
-
-  To post status as 'in progress' override this method
-    - def process_link_clicked_event participant_id, survey_name
-
-  To open the Survey in a new tab be sure to update application.js by adding 
-    - //= require qualtrics_survey
+    include QualtricsInterface (for example in helpers/shut/study_helper.rb)
+  
+    Set environment variables
+  
+    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'
 
 ## Usage
 
-Controller
+    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  
+        get_participant_state participant_id, survey_name
+            - returns 'not started', 'in progress', 'responded'
+        get_participant_link(participant_id, survey_name)['unique_link']
+            - returns link to qualtrics
+
+    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
 

data/app/controllers/bht_survey/qualtrics_surveys_controller.rb

@@ -9,7 +9,7 @@ module BhtSurvey
     def index
       participant_id = params["participant_id"]
       survey_name = params["survey_name"]
-      process_link_clicked_event participant_id, survey_name
+      #process_link_clicked_event participant_id, survey_name
       result = get_participant_link participant_id, survey_name
       unique_link = result['unique_link']
       render json: {unique_link: unique_link}.to_json, status: 200

data/lib/bht_survey/qualtrics_interface.rb

@@ -1,6 +1,7 @@
 module QualtricsInterface
     def get_api method_url, api_conditions
-      connect_to_api = Faraday.new(url: API_URL)  do |faraday|
+      url =   ENV['API_URL'] || 'http://api-assessment.bhtcloud.org/'
+      connect_to_api = Faraday.new(url: url)  do |faraday|
         faraday.response :logger do | logger |
           logger.filter(/(api_key=)(\w+)/,'\1[REMOVED]') #TODO remove the qualtics key
         end
@@ -16,13 +17,12 @@ module QualtricsInterface
     # The Account table is used for saving credentials for multiple survey developers.
 
     def get_workspace_key
-      puts "----------------- #{@workspace}"
       api_params = {
-        qualtrics_id: @workspace['qualtrics_id'],
-        qualtrics_library: @workspace['qualtrics_library'],
-        study_workspace_name: @workspace['study_workspace_name']
+        qualtrics_id: ENV['qualtrics_id'],
+        qualtrics_library: ENV['qualtrics_library'],
+        study_workspace_name: ENV['study_workspace_name']
       }
-      puts ">>>>>>>>>>>>>>>>>>> #{api_params.inspect}"
+      Rails.logger.debug ">>>>>>>>>>>>>>>>>>> #{api_params.inspect}"
       result = get_api 'api/v1/study_workspace', api_params
       session[:workspace_key] = result['response']['workspace_key']  
     end
@@ -37,8 +37,9 @@ module QualtricsInterface
       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
+      #flags = {nil => 0, 'not_started' => 0, 'in progress' => 1, 'responded' => 2}
+      #flags[state] || 0
+      state || 'not_started'
     end
 
     def get_participant_link participant_id, survey_name

data/lib/bht_survey/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bht_survey
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - jfinucane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler