qualtrics 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d2a904a2949091deeca7ce3767804fa303fc9f1
-  data.tar.gz: 7267ee130f72423946a688f950a329eafb89e94a
+  metadata.gz: be834a55988ab40b72e6965929937c2dd41a07fb
+  data.tar.gz: bf6d9f735800c64921ffcfe051c73c92eba99f43
 SHA512:
-  metadata.gz: 312789a9a387de64ee65633938054e0b2a19909ea73b056c97614594c74d4d62da25cf587bad9ff5f132d110589026f9d103f1204a2118fb3045c0f8d21e4296
-  data.tar.gz: 0ded16f030cb49c95d82b7eda232a9f29f05716171c78c0fdbb278d8ee7cbab789f19c5c59290f5a17c9024ed3e111385ffbe7e9d5e5b4fac3a440bd75462d0e
+  metadata.gz: 118bc5617532aa6fea1f706d705588cd895e1922520ac9ba3162e0e898f299e9b91d0330e5d0fb7767432749272c78152acbd67c036d57cd8447d24b9bee0e70
+  data.tar.gz: 7fc42f68e519f6c0e8bc494d3a45e608b850323bf9c150bdea1ee210288f0fc92b7b8002a7e19f0c4782780423528389ebf70f9ae6f2738c5f765f3082846e4e

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/README.md

@@ -1,35 +1,83 @@
-# Qualtrics
+[![Code Climate](https://codeclimate.com/github/sunkev/qualtrics/badges/gpa.svg)](https://codeclimate.com/github/sunkev/qualtrics) [![Build Status](https://travis-ci.org/sunkev/qualtrics.svg?branch=master)](https://travis-ci.org/sunkev/qualtrics) [![Coverage Status](https://coveralls.io/repos/sunkev/qualtrics/badge.svg)](https://coveralls.io/r/sunkev/qualtrics) [![Gem Version](https://badge.fury.io/rb/qualtrics.svg)](http://badge.fury.io/rb/qualtrics)
 
-TODO: Write a gem description
+# Qualtrics
 
-## Installation
+A nice wrapper for the Qualtrics REST API. Currently under fast iterations. 
+Full functional, but may see many changes before 1.0 release. 
+Not recommended for production use before then.
 
-Add this line to your application's Gemfile:
+Just add the gem.
 
     gem 'qualtrics'
+    
+## Configuration
+
+Set the user, token and default library id
 
-And then execute:
+    Qualtrics.configure do |config|
+      config.user = ENV['QUALTRICS_USER']
+      config.token = ENV['QUALTRICS_TOKEN']
+      config.default_library_id = ENV['QUALTRICS_LIBRARY_ID']
+    end
 
-    $ bundle
+## Example usage
 
-Or install it yourself as:
+Add/remove a panel to Qualtrics
 
-    $ gem install qualtrics
+    panel = Qualtrics::Panel.new({
+      name: 'My first panel'
+    })
 
-Qualtrics.configure do |config|
-  config.user = ENV['QUALTRICS_USER']
-  config.token = ENV['QUALTRICS_TOKEN']
-  config.default_library_id = ENV['QUALTRICS_LIBRARY_ID']
-end
+    panel.save
+    panel.destroy
+    
+Add/remove recipients to panel
+    
+    recipient = Qualtrics::Recipient.new({
+      panel_id: panel.id
+    })
+    
+    recipient.save
+    recipient.delete
+    
+Retrieve all survey and messages in Qualtrics
+    
+    Qualtrics::Survey.all   -> returns array of Qualtrics::Survey objects
+    Qualtrics::Message.all
+  
+Send a survey to a panel or individual with the Mailer object
 
-## Usage
+    mailer = Qualtrics::Mailer.new({
+      from_email: 'from_email',
+      from_name: 'from_name',
+      subject: 'subject'
+    })
+  
+    mailer.send_survey_to_individual(recipient, message, survey)
+    mailer.send_survey_to_panel(panel, message, survey)
+    
+Retrieve submission results if you know the Qualtrics response_qid
+  
+    submission = Qualtrics::Submission.new({
+      id: 'response_qid',
+      survey_id: 'survey_id'
+    })
+    
+    submission.raw_csv
+    
+## Interesting features
 
-TODO: Write usage instructions here
+  Can batch update all the recipients in a panel for efficency.
 
+## TODO
+
+  1. Allow retrieving responses in different formats.
+  2. Qualtrics does not all deleting library messages, find a way to test around this.
+  
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/qualtrics/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+1. Fork it ( https://github.com/[my-github-username]/qualtrics/fork 
+2. Add tests.
+3. Make your feature addition or bug fix.
+4. Send me a pull request.
+

data/lib/qualtrics/entity.rb

@@ -4,6 +4,8 @@ module Qualtrics
     include ActiveModel::Model
     include ActiveModel::Validations
 
+    QUALTRICS_POST_TIMEZONE = 'Mountain Time (US & Canada)'
+
     def library_id=(lib_id)
       @library_id = lib_id
     end
@@ -51,5 +53,9 @@ module Qualtrics
     def self.configuration
       Qualtrics.configuration
     end
+
+    def formatted_time(time)
+      time.utc.in_time_zone(QUALTRICS_POST_TIMEZONE).strftime("%Y-%m-%d %H:%M:%S")
+    end
   end
 end

data/lib/qualtrics/mailer.rb

@@ -12,8 +12,6 @@ module Qualtrics
     validates :from_name, presence: true
     validates :subject, presence: true
 
-    QUALTRICS_POST_TIMEZONE = 'Mountain Time (US & Canada)'
-
     def initialize(options={})
       @send_date = options[:send_date] || post_time
       @from_email = options[:from_email]
@@ -92,12 +90,9 @@ module Qualtrics
     end
 
     private
-    def post_time
-      formatted_time Time.now.utc.in_time_zone(QUALTRICS_POST_TIMEZONE)
-    end
 
-    def formatted_time(time)
-      time.strftime("%Y-%m-%d %H:%M:%S")
+    def post_time
+      formatted_time Time.now
     end
 
     def create_distribution(response, survey_id, message_id)

data/lib/qualtrics/panel.rb

@@ -50,6 +50,14 @@ module Qualtrics
       end
     end
 
+    def add_recipients(recipients)
+      panel_import = Qualtrics::PanelImport.new({
+          panel: self,
+          recipients: recipients
+      })
+      panel_import.save
+    end
+
     def destroy
       response = post('deletePanel', {
         'LibraryID' => library_id,

data/lib/qualtrics/panel_import.rb

@@ -13,6 +13,7 @@ module Qualtrics
       payload = headers
       payload['LibraryID'] = library_id
       payload['ColumnHeaders'] = 1
+      payload['PanelID'] = @panel.id if @panel.persisted?
       file = Qualtrics::PanelImportFile.new(@recipients)
       post 'importPanel', payload, File.read(file.temp_file)
       true

data/lib/qualtrics/survey.rb

@@ -38,6 +38,22 @@ module Qualtrics
       end
     end
 
+    def retrieve_all_raw_responses(start_date, end_date)
+      response = get('getLegacyResponseData', {
+        'SurveyID' => id,
+        'StartDate' => formatted_time(start_date),
+        'EndDate' => formatted_time(end_date),
+        'Format' => 'CSV',
+        'ExportTags' => 1
+      })
+
+      if response.status == 200
+        response.result
+      else
+        false
+      end
+    end
+
     def self.attribute_map
       {
         'responses' => :responses,

data/lib/qualtrics/version.rb

@@ -1,3 +1,3 @@
 module Qualtrics
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/qualtrics.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'coveralls'
 end

data/spec/fixtures/vcr_cassettes/Qualtrics_Panel/updating_in_qualtrics/adds_recipients_to_an_existing_panel.yml

@@ -0,0 +1,110 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://survey.qualtrics.com/WRAPI/ControlPanel/api.php
+    body:
+      encoding: UTF-8
+      string: Category=Great+Category&Format=JSON&LibraryID=<QUALTRICS_LIBRARY_ID>&Name=Newest+Panel&Request=createPanel&Token=<QUALTRICS_TOKEN>&User=brookesidedev%40brookeside.com&Version=2.3
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache
+      Cache-Control:
+      - max-age=315360000
+      Expires:
+      - Sun, 09 Mar 2025 20:52:52 GMT
+      P3p:
+      - CP="CAO DSP COR CURa ADMa DEVa OUR IND PHY ONL UNI COM NAV INT DEM PRE", CP="CAO
+        DSP COR CURa ADMa DEVa OUR IND PHY ONL UNI COM NAV INT DEM PRE"
+      Servershortname:
+      - w634
+      X-Cnection:
+      - close
+      X-Edgeconnect-Midmile-Rtt:
+      - '10'
+      - '14'
+      X-Edgeconnect-Origin-Mex-Latency:
+      - '224'
+      - '733'
+      Content-Length:
+      - '82'
+      Content-Type:
+      - application/json
+      Date:
+      - Thu, 12 Mar 2015 20:52:52 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"Meta":{"Status":"Success","Debug":""},"Result":{"PanelID":"ML_5gMUHo4Xfog8K6F"}}'
+    http_version: 
+  recorded_at: Thu, 12 Mar 2015 20:52:52 GMT
+- request:
+    method: post
+    uri: https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?ColumnHeaders=1&Email=3&EmbeddedData=4&ExternalData=5&FirstName=1&Format=JSON&Language=7&LastName=2&LibraryID=<QUALTRICS_LIBRARY_ID>&PanelID=ML_5gMUHo4Xfog8K6F&Request=importPanel&Token=<QUALTRICS_TOKEN>&Unsubscribed=6&User=<QUALTRICS_USER>&Version=2.3
+    body:
+      encoding: UTF-8
+      string: |
+        "FirstName","LastName","Email","EmbeddedData","ExternalData","Unsubscribed","Language"
+        "New","Person","example@example.com","","","",""
+        "Another","NewPerson","example@example.com","","","",""
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache
+      Cache-Control:
+      - max-age=315360000
+      Expires:
+      - Sun, 09 Mar 2025 20:52:53 GMT
+      P3p:
+      - CP="CAO DSP COR CURa ADMa DEVa OUR IND PHY ONL UNI COM NAV INT DEM PRE", CP="CAO
+        DSP COR CURa ADMa DEVa OUR IND PHY ONL UNI COM NAV INT DEM PRE"
+      Servershortname:
+      - w202
+      X-Cnection:
+      - close
+      X-Edgeconnect-Midmile-Rtt:
+      - '10'
+      - '11'
+      X-Edgeconnect-Origin-Mex-Latency:
+      - '323'
+      - '792'
+      Content-Length:
+      - '214'
+      Content-Type:
+      - application/json
+      Date:
+      - Thu, 12 Mar 2015 20:52:53 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"Meta":{"Status":"Success","Debug":""},"Result":{"PanelID":"ML_5gMUHo4Xfog8K6F","Count":2,"IgnoredCount":0,"Recipients":{"MLRP_9BmlZ9vmPgQ9hGJ":"example@example.com","MLRP_7WlcwPHwkUYPWKx":"example@example.com"}}}'
+    http_version: 
+  recorded_at: Thu, 12 Mar 2015 20:52:53 GMT
+recorded_with: VCR 2.9.2

data/spec/qualtrics/mailer_spec.rb

@@ -11,7 +11,7 @@ describe Qualtrics::Mailer, :vcr do
   end
 
   it 'has a default send date' do
-    send_date = Time.now.utc.in_time_zone(Qualtrics::Mailer::QUALTRICS_POST_TIMEZONE).strftime("%Y-%m-%d %H:%M:%S")
+    send_date = Time.now.utc.in_time_zone(Qualtrics::Entity::QUALTRICS_POST_TIMEZONE).strftime("%Y-%m-%d %H:%M:%S")
     mailer = Qualtrics::Mailer.new({})
     expect(mailer.send_date).to eq(send_date)
   end

data/spec/qualtrics/panel_spec.rb

@@ -77,4 +77,16 @@ describe Qualtrics::Panel, :vcr => true  do
     panel.save
     expect(Qualtrics::Panel.all.map{|p| p.id}).to include(panel.id)
   end
+
+  context 'updating in qualtrics' do
+    it 'adds recipients to an existing panel' do
+      panel.save
+      expect(panel.persisted?).to be true
+      recipients = [
+        Qualtrics::Recipient.new(email: 'example@example.com', first_name: 'New', last_name: 'Person'),
+        Qualtrics::Recipient.new(email: 'example@example.com', first_name: 'Another', last_name: 'NewPerson')
+      ]
+      expect(panel.add_recipients(recipients)).to be true
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'rspec'
 require 'pry'
 require 'qualtrics'
+require 'coveralls'
+Coveralls.wear!
 
 Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qualtrics
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Kevin Sun
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configatron
@@ -165,6 +165,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Client for Qualtrics API with Faraday
 email:
 - sunkev@brandeis.edu
@@ -176,6 +190,7 @@ files:
 - ".env.example"
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -215,6 +230,7 @@ files:
 - spec/fixtures/vcr_cassettes/Qualtrics_Panel/destroys_a_panel_that_returns_true_when_successful.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Panel/raises_an_error_when_you_attempt_to_save_an_already_presisted_panel.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Panel/retrieves_an_array_of_all_panels_in_a_library.yml
+- spec/fixtures/vcr_cassettes/Qualtrics_Panel/updating_in_qualtrics/adds_recipients_to_an_existing_panel.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_PanelImport/transmits_to_qualtrics.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Recipient/creating_to_qualtrics/persists_to_qualtrics.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Recipient/creating_to_qualtrics/populates_the_recipient_id_when_successful.yml
@@ -286,6 +302,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/Qualtrics_Panel/destroys_a_panel_that_returns_true_when_successful.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Panel/raises_an_error_when_you_attempt_to_save_an_already_presisted_panel.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Panel/retrieves_an_array_of_all_panels_in_a_library.yml
+- spec/fixtures/vcr_cassettes/Qualtrics_Panel/updating_in_qualtrics/adds_recipients_to_an_existing_panel.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_PanelImport/transmits_to_qualtrics.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Recipient/creating_to_qualtrics/persists_to_qualtrics.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Recipient/creating_to_qualtrics/populates_the_recipient_id_when_successful.yml