bht_survey 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f67171e515407f84b9a99933a7f5834bf96045c
+  data.tar.gz: c5478b894db9b23b70623c9ea02dee49db9f43ba
+SHA512:
+  metadata.gz: 18371fb560679c708f54a6c3676efd1da2251cf54583481c16d8c045c6db49d93fed8f07495dca56afc8078307f5d15f0e4abf9a8371351d78b015ecdae04c00
+  data.tar.gz: 478cd75e6a62d86fb185b7a8aa0169e7cd1012d4864e6b1e25853e311ad2ff2134a6ab1e4b55fcdee7a755623a998f46a651df5ddd2795027c4954400950832f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.14.4

data/Gemfile

@@ -0,0 +1,4 @@
+#source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bht_survey.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 jfinucane
+
+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,41 @@
+# BhtSurvey
+
+This is a simple 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
+
+Or install it yourself as:
+
+    $ gem install bht_survey
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## 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).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/bht_survey/qualtrics_surveys_controller.rb

@@ -0,0 +1,30 @@
+module BhtSurvey
+
+  class QualtricsSurveysController < ApplicationController
+  include QualtricsInterface
+  before_action :set_workspace
+    EXCLUDELIST = ['IPAddress', 'Location', 'StartDate', 'ResponseID', 'ResponseSet',
+     'LocationAccuracy', 'LocationLatitude', 'LocationLongitude', 'RecipientLastName', 'RecipientFirstName',
+     'Status', 'Finished', 'RecipientEmail']
+    def index
+      participant_id = params["participant_id"]
+      survey_name = params["survey_name"]
+      result = get_participant_link participant_id, survey_name
+      unique_link = result['unique_link']
+      puts 'Unique',unique_link
+      render json: {unique_link: unique_link}.to_json, status: 200
+    end
+
+    def results
+      puts '-----------------seriously'
+      participant_id = params["participant_id"]
+      survey_name = params["survey_name"]
+      result = get_results participant_id, survey_name
+      display_answers = result['answers'].except(*EXCLUDELIST)
+      render json: display_answers.to_json, status: 200
+    end
+  end
+end
+
+
+

data/bht_survey.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = %q{Shim for Faraday access to the APIs of Qualtrics Interface Service}
+  spec.description   = %q{Requires a hash with three key values   
+       @workspace = {
+      'qualtrics_id' => ENV['qualtrics_id'],
+      'qualtrics_library' => ENV['qualtrics_library_id'],
+      'study_workspace_name' => 'Shuti-Example'
+    }
+  }
+  spec.homepage      = "https://github.com/jfinucane/bht_survey.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_dependency "rails", "~> 5.0" 
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bht_survey"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  get 'qualtrics_surveys' => 'bht_survey/qualtrics_surveys#index'
+  get 'qualtrics_surveys/results' => 'bht_survey/qualtrics_surveys#results'
+end

data/lib/bht_survey.rb

@@ -0,0 +1,8 @@
+require "bht_survey/version"
+require 'bht_survey/engine'
+require 'bht_survey/qualtrics_interface'
+module BhtSurvey
+  STUFF=9
+end
+
+

data/lib/bht_survey/engine.rb

@@ -0,0 +1,4 @@
+require 'rails/engine'    #Pat from https://github.com/pat/combustion/issues/70
+module BhtSurvey
+  class Engine < Rails::Engine; end
+end

data/lib/bht_survey/qualtrics_interface.rb

@@ -0,0 +1,49 @@
+module QualtricsInterface
+    def get_api method_url, api_conditions
+      connect_to_api = Faraday.new(url: API_URL)  do |faraday|
+        faraday.response :logger do | logger |
+          logger.filter(/(api_key=)(\w+)/,'\1[REMOVED]') #TODO remove the qualtics key
+        end
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+
+      local_response = connect_to_api.get method_url, api_conditions
+      result = JSON.parse(local_response.body)
+      result
+    end
+
+    # Initialization parameters are used to provide credentials in RICE
+    # 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']
+      }
+      puts ">>>>>>>>>>>>>>>>>>> #{api_params.inspect}"
+      result = get_api 'api/v1/study_workspace', api_params
+      session[:workspace_key] = result['response']['workspace_key']  
+    end
+    
+    def get_participant_states participant_id
+      api_params = {workspace_key: get_workspace_key, participant_id: participant_id}
+      result = get_api 'api/v1/participant_states', api_params
+      result['response']
+    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
+      result['response']
+    end
+
+    def get_results participant_id, survey_name
+      api_params = {workspace_key: get_workspace_key, participant_id: participant_id, assessment_name: survey_name}
+      result = get_api 'api/v1/survey_results', api_params
+      result['response']
+    end
+
+end
+

data/lib/bht_survey/version.rb

@@ -0,0 +1,3 @@
+module BhtSurvey
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: bht_survey
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jfinucane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-23 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'
+  => ENV['qualtrics_id'],\n      'qualtrics_library' => ENV['qualtrics_library_id'],\n
+  \     'study_workspace_name' => 'Shuti-Example'\n    }\n  "
+email:
+- jimway@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/bht_survey/qualtrics_surveys_controller.rb
+- bht_survey.gemspec
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/bht_survey.rb
+- lib/bht_survey/engine.rb
+- lib/bht_survey/qualtrics_interface.rb
+- lib/bht_survey/version.rb
+homepage: https://github.com/jfinucane/bht_survey.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.8
+signing_key: 
+specification_version: 4
+summary: Shim for Faraday access to the APIs of Qualtrics Interface Service
+test_files: []