qualtrics_api 0.0.8 → 0.0.9

data/fixtures/vcr_cassettes/survey_collection_fetch_fail.yml

@@ -2,13 +2,15 @@
 http_interactions:
 - request:
     method: get
-    uri: https://co1.qualtrics.com/API/v1/surveys?apiToken=6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ&scopeId=fake
+    uri: https://co1.qualtrics.com/API/v3/surveys
     body:
       encoding: US-ASCII
       string: ''
     headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
       User-Agent:
-      - Faraday v0.8.9
+      - Faraday v0.9.2
   response:
     status:
       code: 404

data/fixtures/vcr_cassettes/survey_collection_fetch_sucess.yml

@@ -2,32 +2,34 @@
 http_interactions:
 - request:
     method: get
-    uri: https://co1.qualtrics.com/API/v1/surveys?apiToken=6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+    uri: https://co1.qualtrics.com/API/v3/surveys
     body:
       encoding: US-ASCII
       string: ''
     headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
       User-Agent:
-      - Faraday v0.8.9
+      - Faraday v0.9.2
   response:
     status:
       code: 200
       message: 
     headers:
-      server:
-      - Apache-Coyote/1.1
       content-type:
-      - application/json
+      - application/json; charset=utf-8
+      request-time:
+      - '573'
       content-length:
-      - '223'
+      - '1737'
       date:
-      - Sun, 22 Mar 2015 21:05:57 GMT
+      - Mon, 11 Apr 2016 13:04:55 GMT
       connection:
       - close
     body:
       encoding: UTF-8
-      string: '{"result":[{"id":"SV_djzgZ6eJXqnIUyF","name":"test_survey","ownerId":"UR_3fnAz35QCGlr725","lastModified":"2015-03-20
-        12:56:33","status":"Inactive"}],"meta":{"status":"Success","qualtricsErrorCode":null,"errorMessage":null}}'
+      string: '{"result":{"elements":[{"id":"SV_djzgZ6eJXqnIUyF","name":"Test","ownerId":"UR_3fnAz35QCGlr725","lastModified":"2015-08-06T16:11:15Z","isActive":false}],"nextPage":"https://co1.qualtrics.com/API/v3/surveys?offset=10"},"meta":{"httpStatus":"200
+        - OK"}}'
     http_version: 
-  recorded_at: Sun, 22 Mar 2015 21:05:57 GMT
+  recorded_at: Mon, 11 Apr 2016 13:04:55 GMT
 recorded_with: VCR 2.9.3

data/lib/qualtrics_api/client.rb

@@ -7,7 +7,6 @@ module QualtricsAPI
     end
 
     def surveys(options = {})
-      @surveys = nil if @surveys && @surveys.scope_id != options[:scope_id]
       @surveys ||= QualtricsAPI::SurveyCollection.new(options).propagate_connection(self)
     end
 
@@ -22,8 +21,9 @@ module QualtricsAPI
     private
 
     def establish_connection(api_token)
-      Faraday.new(url: QualtricsAPI::URL, params: { apiToken: api_token }) do |faraday|
-        faraday.request :url_encoded
+      Faraday.new(url: QualtricsAPI::URL, headers: { 'X-API-TOKEN' => api_token }) do |faraday|
+        faraday.request :multipart
+        faraday.request :json
         faraday.response :json, :content_type => /\bjson$/
 
         faraday.use FaradayMiddleware::FollowRedirects

data/lib/qualtrics_api/panel_collection.rb

@@ -4,9 +4,9 @@ module QualtricsAPI
       attribute :all, Array, :default => []
     end
 
-    def fetch(_options = {})
+    def fetch()
       @all = []
-      parse_fetch_response(QualtricsAPI.connection(self).get('panels'))
+      parse_fetch_response(QualtricsAPI.connection(self).get('mailinglists'))
       self
     end
 
@@ -23,8 +23,8 @@ module QualtricsAPI
     private
 
     def parse_fetch_response(response)
-      @all = response.body["result"].map do |result|
-        QualtricsAPI::Panel.new(result).propagate_connection(self)
+      @all = response.body["result"]["elements"].map do |elements|
+        QualtricsAPI::Panel.new(elements).propagate_connection(self)
       end
     end
   end

data/lib/qualtrics_api/panel_import.rb

@@ -6,7 +6,7 @@ module QualtricsAPI
     end
 
     def update_status
-      res = QualtricsAPI.connection(self).get("panels/#{panel_id}/members/panelImports/#{id}").body["result"]
+      res = QualtricsAPI.connection(self).get("mailinglists/#{panel_id}/contactimports/#{id}").body["result"]
       @import_progress = res["percentComplete"]
       @completed = true if @import_progress == 100.0
       self

data/lib/qualtrics_api/panel_member.rb

@@ -25,14 +25,14 @@ module QualtricsAPI
 
     def attributes_for_save
       {
-        :id => "RecipientID",
-        :first_name => "FirstName",
-        :last_name => "LastName",
-        :email => "Email",
-        :language => "Language",
-        :unsubscribed => 'Unsubscribed',
-        :external_reference => "ExternalReference",
-        :embeded_data => "EmbeddedData"
+        :id => "recipientID",
+        :first_name => "firstName",
+        :last_name => "lastName",
+        :email => "email",
+        :language => "language",
+        :unsubscribed => 'unsubscribed',
+        :external_reference => "externalReference",
+        :embeded_data => "embeddedData"
       }
     end
 

data/lib/qualtrics_api/panel_member_collection.rb

@@ -7,15 +7,18 @@ module QualtricsAPI
   
     def fetch(_options = {})
       @all = []
-      parse_fetch_response(QualtricsAPI.connection(self).get("panels/#{id}/members"))
+      parse_fetch_response(QualtricsAPI.connection(self).get("mailinglists/#{id}/contacts"))
       self
     end
 
     def create(panel_members)
+      payload = {
+        contacts: Faraday::UploadIO.new(StringIO.new(panel_members.to_json), 'application/json', 'contacts.json')
+      }
       res = QualtricsAPI.connection(self)
-            .post("panels/#{id}/members", QualtricsAPI.connection(self).params.merge(panelMembers: panel_members.to_json))
-            .body["result"]
-      import_id = res['importStatus'].split('/').last
+                        .post("mailinglists/#{id}/contactimports", payload)
+                        .body["result"]
+      import_id = res['id']
       QualtricsAPI::PanelImport.new(id: import_id, panel_id: id).propagate_connection(self)
     end
 
@@ -32,8 +35,8 @@ module QualtricsAPI
     private
 
     def parse_fetch_response(response)
-      @all = response.body["result"].map do |result|
-        QualtricsAPI::PanelMember.new(result).propagate_connection(self)
+      @all = response.body["result"]["elements"].map do |element|
+        QualtricsAPI::PanelMember.new(element).propagate_connection(self)
       end
     end
   end

data/lib/qualtrics_api/request_error_handler.rb

@@ -1,7 +1,5 @@
 module QualtricsAPI
-
   class RequestErrorHandler < Faraday::Response::Middleware
-
     def on_complete(env)
       case env[:status]
       when 404
@@ -19,19 +17,17 @@ module QualtricsAPI
 
     def error_message(response)
       meta = response["meta"]
-      [ "[",
-        meta["status"], " - ",
-        meta["qualtricsErrorCode"] || meta["internalErrorCode"],
-        "] ",
-        meta["errorMessage"]
+      ["[",
+       meta["status"], " - ",
+       meta["qualtricsErrorCode"] || meta["internalErrorCode"],
+       "] ",
+       meta["errorMessage"]
       ].join
     end
-
   end
 
   class NotFoundError < StandardError; end
   class BadRequestError < StandardError; end
   class UnauthorizedError < StandardError; end
   class InternalServerError < StandardError; end
-
 end

data/lib/qualtrics_api/response_export.rb

@@ -5,9 +5,9 @@ module QualtricsAPI
     end
 
     def update_status
-      res = QualtricsAPI.connection(self).get('surveys/responseExports/' + id).body["result"]
+      res = QualtricsAPI.connection(self).get('responseexports/' + id).body["result"]
       @export_progress = res["percentComplete"]
-      @file_url = res["fileUrl"]
+      @file_url = res["file"]
       @completed = true if @export_progress == 100.0
       self
     end

data/lib/qualtrics_api/services/response_export_service.rb

@@ -2,46 +2,42 @@ module QualtricsAPI
   module Services
     class ResponseExportService < QualtricsAPI::BaseModel
       values do
+        attribute :format, String, :default => 'csv'
         attribute :survey_id, String
-        attribute :response_set_id, String
-        attribute :file_type, String, :default => 'CSV'
         attribute :last_response_id, String
         attribute :start_date, String
         attribute :end_date, String
         attribute :limit, String
         attribute :included_question_ids, String
-        attribute :max_rows, String
         attribute :use_labels, Boolean, :default => false
-        attribute :decimal_format, String, :default => '.'
+        attribute :decimal_separator, String, :default => '.'
         attribute :seen_unanswered_recode, String
         attribute :use_local_time, Boolean, :default => false
-        attribute :spss_string_length, String
+
         attribute :id, String
       end
       
       attr_reader :result
 
       def start
-        response = QualtricsAPI.connection(self).get("surveys/#{survey_id}/responseExports", export_params)
-        export_id = response.body["result"]["exportStatus"].split('/').last
+        response = QualtricsAPI.connection(self).post("responseexports", export_params)
+        export_id = response.body["result"]["id"]
         @result = ResponseExport.new(id: export_id)
       end
 
       def export_configurations
         {
-          response_set_id: response_set_id,
-          file_type: file_type,
+          format: format,
+          survey_id: survey_id,
           last_response_id: last_response_id,
           start_date: start_date,
           end_date: end_date,
           limit: limit,
           included_question_ids: included_question_ids,
-          max_rows: max_rows,
           use_labels: use_labels,
-          decimal_format: decimal_format,
+          decimal_separator: decimal_separator,
           seen_unanswered_recode: seen_unanswered_recode,
-          use_local_time: use_local_time,
-          spss_string_length: spss_string_length
+          use_local_time: use_local_time
         }
       end
 
@@ -49,19 +45,17 @@ module QualtricsAPI
 
       def param_mappings
         {
-          response_set_id: "responseSetId",
-          file_type: "fileType",
+          format: "format",
+          survey_id: "surveyId",
           last_response_id: "lastResponseId",
           start_date: "startDate",
           end_date: "endDate",
           limit: "limit",
           included_question_ids: "includedQuestionIds",
-          max_rows: "maxRows",
           use_labels: "useLabels",
-          decimal_format: "decimalFormat",
+          decimal_separator: "decimalSeparator",
           seen_unanswered_recode: "seenUnansweredRecode",
-          use_local_time: "useLocalTime",
-          spss_string_length: "spssStringLength"
+          use_local_time: "useLocalTime"
         }
       end
 

data/lib/qualtrics_api/survey.rb

@@ -5,8 +5,7 @@ module QualtricsAPI
       attribute :name, String
       attribute :owner_id, String
       attribute :last_modified, String
-      attribute :created_at, String
-      attribute :status, String
+      attribute :is_active, Boolean
     end
 
     def export_responses(export_options = {})
@@ -21,8 +20,7 @@ module QualtricsAPI
         :name => "name",
         :owner_id => "ownerId",
         :last_modified => "lastModified",
-        :status => "status",
-        :created_at => "SurveyCreationDate"
+        :is_active => "isActive"
       }
     end
   end

data/lib/qualtrics_api/survey_collection.rb

@@ -1,29 +1,15 @@
 module QualtricsAPI
   class SurveyCollection < BaseCollection
     values do
-      attribute :scope_id, String
       attribute :all, Array, :default => []
     end
 
-    attr_writer :scope_id
-
-    def fetch(options = {})
+    def fetch
       @all = []
-      update_query_attributes(options)
-      parse_fetch_response(QualtricsAPI.connection(self).get('surveys', query_params))
+      parse_fetch_response(QualtricsAPI.connection(self).get('surveys'))
       self
     end
 
-    def query_attributes
-      {
-        :scope_id => @scope_id
-      }
-    end
-
-    def update_query_attributes(new_attributes = {})
-      @scope_id = new_attributes[:scope_id] if new_attributes.key?(:scope_id)
-    end
-
     def [](survey_id)
       find(survey_id)
     end
@@ -36,21 +22,9 @@ module QualtricsAPI
 
     private
 
-    def attributes_mapping
-      {
-        :scope_id => "scopeId"
-      }
-    end
-
-    def query_params
-      query_attributes.map do |k, v|
-        [attributes_mapping[k], v] unless v.nil? || v.to_s.empty?
-      end.compact.to_h
-    end
-
     def parse_fetch_response(response)
-      @all = response.body["result"].map do |result|
-        QualtricsAPI::Survey.new(result).propagate_connection(self)
+      @all = response.body["result"]['elements'].map do |elements|
+        QualtricsAPI::Survey.new(elements).propagate_connection(self)
       end
     end
   end

data/lib/qualtrics_api/url.rb

@@ -1,3 +1,3 @@
 module QualtricsAPI
-  URL = "https://co1.qualtrics.com:443/API/v1/"
+  URL = "https://co1.qualtrics.com:443/API/v3/"
 end

data/lib/qualtrics_api/version.rb

@@ -1,3 +1,3 @@
 module QualtricsAPI
-  VERSION = "0.0.8".freeze
+  VERSION = "0.0.9".freeze
 end

data/qualtrics_api.gemspec

@@ -26,9 +26,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday_middleware", "~> 0.9.1"
   spec.add_dependency "virtus", "~> 1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "vcr", "~> 2.9"
   spec.add_development_dependency "guard-rspec", "~> 4.5"
   spec.add_development_dependency "pry", "~> 0.10.1"

data/spec/lib/client_spec.rb

@@ -18,10 +18,6 @@ describe QualtricsAPI::Client do
       expect(subject.surveys).to be_a QualtricsAPI::SurveyCollection
     end
 
-    it "assigns scope_id if passed" do
-      expect(subject.surveys(:scope_id => "someId").scope_id).to eq "someId"
-    end
-
     it "caches the surveys" do
       expect(subject.surveys.object_id).to eq subject.surveys.object_id
     end

data/spec/lib/panel_import_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe QualtricsAPI::PanelImport do
-  subject { described_class.new(id: 'PGRS_bEJLYLkqMBs8Bwx', panel_id: 'ML_bC2c5xBz1DxyOYB') }
+  subject { described_class.new(id: 'PGRS_4GvIMg79RFEPW4d', panel_id: 'ML_0APx3C4rmHER6w5') }
 
   describe "integration" do
     describe "#update_status" do
       let(:result) do
-        VCR.use_cassette('panel_import_update_success') do
+        VCR.use_cassette('panel_import_update_success', record: :once) do
           subject.update_status
         end
       end

data/spec/lib/panel_member_collection_spec.rb

@@ -61,8 +61,8 @@ describe QualtricsAPI::PanelMemberCollection do
 
     describe "#create" do
       let(:result) do
-        VCR.use_cassette(cassette) do
-          QualtricsAPI.panels.fetch['ML_bC2c5xBz1DxyOYB'].members.create(panel_members)
+        VCR.use_cassette(cassette, record: :once) do
+          QualtricsAPI.panels.fetch['ML_0APx3C4rmHER6w5'].members.create(panel_members)
         end
       end
 
@@ -75,11 +75,11 @@ describe QualtricsAPI::PanelMemberCollection do
         end
 
         it "returns PanelImport with id" do
-          expect(result.id).to eq('PGRS_bEJLYLkqMBs8Bwx')
+          expect(result.id).to eq('PGRS_4GvIMg79RFEPW4d')
         end
 
         it "returns PanelImport with panel id" do
-          expect(result.panel_id).to eq('ML_bC2c5xBz1DxyOYB')
+          expect(result.panel_id).to eq('ML_0APx3C4rmHER6w5')
         end
       end