qualtrics 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2ab5987d8e84074740e29a42a1f169b1ca13a6e
-  data.tar.gz: b424bd87bc1cd077f78c0d932e87cf74779ac909
+  metadata.gz: 3082552f68e86aa628b0dcda0ffd131fc6638b2e
+  data.tar.gz: 1432fdb41b01181a73fce80a07ccb5af9225d569
 SHA512:
-  metadata.gz: 63343b29dab3be01332efdf48fd84b5e0bea769a94e94993325d69f69c0d8eb88f5e831adec0ad0e2d1a670d7448552012ecd829488a5ec5b9014b16651d139c
-  data.tar.gz: d38f29d7af4ccb4e62eeb1735c244e0ee2c5d9cdd9845216fa23696d34bf99cbb0ea948973319fd37d043b0c2037f5e2b8545bab38f3740bff491d47d83a32f9
+  metadata.gz: 20d57dd6f18568e10e651dc33b262f824e50aa20adad0ca65e10fc4685904161b86117152fff84ae7174c803e5bb2a0f99003d3f140c8898ea9b9287f26bd56a
+  data.tar.gz: deeab34717dd6e74b9cdd4fb1a39de7b4fd8ec29455c9874e05e45251b7aca2f6311cb50eb5705f578eb84f6449af8789033364ffb9dfd7f78ddbe43f7a204aa

data/lib/qualtrics.rb

@@ -13,6 +13,7 @@ require "qualtrics/survey_import"
 
 require "qualtrics/message"
 require "qualtrics/distribution"
+require "qualtrics/submission"
 require "qualtrics/mailer"
 
 # not always necessary for runtime

data/lib/qualtrics/recipient.rb

@@ -98,6 +98,13 @@ module Qualtrics
       }
     end
 
+    def response_history
+      info_hash["RecipientResponseHistory"].map do |r|
+        response = Hash[r.map{|k,v| [Qualtrics::Submission.attribute_map[k], v]}]
+        Qualtrics::Submission.new(response)
+      end
+    end
+
     protected
     def update_params
       {

data/lib/qualtrics/submission.rb

@@ -0,0 +1,39 @@
+module Qualtrics
+  class Submission < Entity
+
+    attr_accessor :id, :survey_id, :distribution_id, :finished_survey, :time_stamp
+
+    def initialize(options={})
+      @id = options[:id]
+      @survey_id = options[:survey_id]
+      @distribution_id = options[:distribution_id]
+      @finished_survey = options[:finished_survey]
+      @time_stamp = options[:time_stamp]
+    end
+
+    def info_hash
+      response = get('getLegacyResponseData', {
+        'SurveyID' => survey_id,
+        'ResponseID' => id,
+        'Format' => 'CSV',
+        'ExportTags' => 1
+      })
+
+      if response.success?
+        response
+      else
+        false
+      end
+    end
+
+    def self.attribute_map
+      {
+        'ResponseID' => :id,
+        'SurveyID' => :survey_id,
+        'TimeStamp' => :time_stamp,
+        'EmailDistributionID' => :distribution_id,
+        'FinishedSurvey' => :finished_survey
+      }
+    end
+  end
+end

data/lib/qualtrics/version.rb

@@ -1,3 +1,3 @@
 module Qualtrics
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/qualtrics.gemspec

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

data/spec/fixtures/vcr_cassettes/Qualtrics_Submission/has_a_survey_id.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?ExportTags=1&Format=JSON&Request=getLegacyResponseData&ResponseID=R_296ZnPPDJEONkHP&SurveyID=SV_8deJytTY3InclQ9&Token=<QUALTRICS_TOKEN>&User=<QUALTRICS_USER>&Version=2.3
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      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=0, no-store, no-cache, must-revalidate, post-check=0, pre-check=0,
+        max-age=315360000
+      Pragma:
+      - ''
+      Content-Transfer-Encoding:
+      - binary
+      Requeststatus:
+      - Success
+      Expires:
+      - Thu, 27 Feb 2025 19:32:02 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:
+      - w11
+      X-Cnection:
+      - close
+      X-Edgeconnect-Midmile-Rtt:
+      - '1'
+      - '20'
+      X-Edgeconnect-Origin-Mex-Latency:
+      - '1356'
+      - '788'
+      Content-Length:
+      - '1199'
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 02 Mar 2015 19:32:03 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"R_296ZnPPDJEONkHP":{"ResponseSet":"Default Response Set","Name":"fn,
+        kln","ExternalDataReference":"7","EmailAddress":"ksun@brookeside.com","IPAddress":"104.129.66.226","Status":"0","StartDate":"2015-03-02
+        13:50:13","EndDate":"2015-03-02 13:50:40","Finished":"1","seller_company":"","role":"","redirect_host":"","sect1_head":1,"q1_lc_1":"9","q2_lr_1":"9","q3_lr_1":"9","q4_lc_1":"9","q5_lc_1":"9","q6_li_1":"9","q7_lr_1":"9","q8_li_1":"9","sect2_head":1,"q1_cs_1":"4","q2_cr_1":"4","q3_ch_1":"4","q4_ci_1":"4","q5_cc_1":"4","q9_cp_1":"4","q10_cs_1":"4","q8_cr_1":"4","q6_ch_1":"4","q11_ci_1":"4","q7_cc_1":"4","q14_cp_1":"4","q13_cs_1":"4","q12_cr_1":"4","q15_ch_1":"4","q16_ci_1":"4","q17_cc_1":"4","q18_cp_1":"4","sect3_head":1,"q1_pi_1":"3","q2_pc_1":"3","q3_pr_1":"3","q4_pp_1":"3","q5_ps_1":"3","q6_ph_1":"3","q7_pi_1":"3","q8_pc_1":"3","q9_pr_1":"3","q10_pp_1":"3","q11_ps_1":"3","q12_ph_1":"3","q13_pi_1":"3","q14_pc_1":"3","q15_pr_1":"3","q16_pp_1":"3","q17_ps_1":"3","q18_ph_1":"3","q19_pi_1":"3","q20_pc_1":"3","q21_pr_1":"3","q22_pp_1":"3","q23_ps_1":"3","q24_ph_1":"3","q25_pi_1":"3","q26_pc_1":"3","q27_pr_1":"3","q28_pp_1":"3","q29_ps_1":"3","q30_ph_1":"3","sect4_head":1,"q1_mx":""}}'
+    http_version: 
+  recorded_at: Mon, 02 Mar 2015 19:32:03 GMT
+recorded_with: VCR 2.9.3

data/spec/qualtrics/recipient_spec.rb

@@ -182,4 +182,31 @@ describe Qualtrics::Recipient, :vcr => true  do
     end
   end
 
+  context 'has responses' do
+    let(:recipient) { Qualtrics::Recipient.new }
+
+    it 'can check its own response history' do
+      allow(recipient).to receive(:info_hash).and_return (
+        {
+          'PanelMemberID' => 'whatever',
+          'PanelID' => 'this is',
+          'FirstName' => 'kk',
+          'LastName' => 'omg',
+          'RecipientResponseHistory' =>
+            [{'ResponseID' => 'response_id',
+              'SurveyID' => 'survey_id',
+              'TimeStamp' => '2015-03-02 11:50:40',
+              'EmailDistributionID' => 'distribution_id',
+              'FinishedSurvey' => true}]
+        }
+      )
+
+      response = recipient.response_history[0]
+      expect(response.distribution_id).to eql('distribution_id')
+      expect(response.finished_survey).to eql(true)
+      expect(response.id).to eql('response_id')
+      expect(response.survey_id).to eql('survey_id')
+      expect(response.time_stamp).to eql('2015-03-02 11:50:40')
+    end
+  end
 end

data/spec/qualtrics/submission_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Qualtrics::Submission, vcr: true do
+  it 'has an id' do
+    id = '12345asdfg'
+
+    submission = Qualtrics::Submission.new({
+      id: id
+    })
+
+    expect(submission.id).to eql(id)
+  end
+
+  it 'has a survey id' do
+    survey_id = 'survey_id'
+
+    submission = Qualtrics::Submission.new({
+      survey_id: survey_id
+    })
+
+    expect(submission.survey_id).to eql(survey_id)
+  end
+
+  it 'has a distribution id' do
+    distribution_id = 'distribution_id'
+
+    submission = Qualtrics::Submission.new({
+      distribution_id: distribution_id
+    })
+
+    expect(submission.distribution_id).to eql(distribution_id)
+  end
+
+  it 'has a finished survey boolean' do
+    finished_survey = true
+
+    submission = Qualtrics::Submission.new({
+      finished_survey: finished_survey
+    })
+
+    expect(submission.finished_survey).to eql(finished_survey)
+  end
+
+  it 'has a timestamp' do
+    time_stamp = "2015-03-02 11:50:40"
+
+    submission = Qualtrics::Submission.new({
+      time_stamp: time_stamp
+    })
+
+    expect(submission.time_stamp).to eql(time_stamp)
+  end
+
+end

data/spec/spec_helper.rb

@@ -7,5 +7,5 @@ require 'mocha/api'
 Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
 
 RSpec.configure do |config|
-	config.mock_with :mocha
+	# config.mock_with :mocha
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qualtrics
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Kevin Sun
@@ -165,20 +165,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  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
@@ -207,6 +193,7 @@ files:
 - lib/qualtrics/recipient.rb
 - lib/qualtrics/recipient_import_row.rb
 - lib/qualtrics/response.rb
+- lib/qualtrics/submission.rb
 - lib/qualtrics/survey.rb
 - lib/qualtrics/survey_import.rb
 - lib/qualtrics/transaction.rb
@@ -236,6 +223,7 @@ files:
 - spec/fixtures/vcr_cassettes/Qualtrics_Recipient/recipient_made_in_qualtrics/can_delete_itself_in_qualtrics.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Recipient/recipient_made_in_qualtrics/can_update_itself_in_qualtrics.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Recipient/recipient_made_in_qualtrics/gets_its_information_in_qualtrics.yml
+- spec/fixtures/vcr_cassettes/Qualtrics_Submission/has_a_survey_id.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Survey/creating_to_qualtrics/can_be_activated_or_deactivated.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Survey/creating_to_qualtrics/destroys_a_survey_that_returns_true_when_successful.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Survey/creating_to_qualtrics/populates_the_survey_id_when_successful.yml
@@ -251,6 +239,7 @@ files:
 - spec/qualtrics/recipient_import_row_spec.rb
 - spec/qualtrics/recipient_spec.rb
 - spec/qualtrics/response_spec.rb
+- spec/qualtrics/submission_spec.rb
 - spec/qualtrics/survey_import_spec.rb
 - spec/qualtrics/survey_spec.rb
 - spec/spec_helper.rb
@@ -306,6 +295,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/Qualtrics_Recipient/recipient_made_in_qualtrics/can_delete_itself_in_qualtrics.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Recipient/recipient_made_in_qualtrics/can_update_itself_in_qualtrics.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Recipient/recipient_made_in_qualtrics/gets_its_information_in_qualtrics.yml
+- spec/fixtures/vcr_cassettes/Qualtrics_Submission/has_a_survey_id.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Survey/creating_to_qualtrics/can_be_activated_or_deactivated.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Survey/creating_to_qualtrics/destroys_a_survey_that_returns_true_when_successful.yml
 - spec/fixtures/vcr_cassettes/Qualtrics_Survey/creating_to_qualtrics/populates_the_survey_id_when_successful.yml
@@ -321,6 +311,7 @@ test_files:
 - spec/qualtrics/recipient_import_row_spec.rb
 - spec/qualtrics/recipient_spec.rb
 - spec/qualtrics/response_spec.rb
+- spec/qualtrics/submission_spec.rb
 - spec/qualtrics/survey_import_spec.rb
 - spec/qualtrics/survey_spec.rb
 - spec/spec_helper.rb