qualtrics_api 0.0.12 → 0.0.13

data/fixtures/vcr_cassettes/event_subscription_delete_one.yml

@@ -0,0 +1,76 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://co1.qualtrics.com/API/v3/eventsubscriptions/SUB_5pPHcNfCaiADoFf
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      request-time:
+      - '325'
+      content-type:
+      - application/json
+      content-length:
+      - '85'
+      x-edgeconnect-midmile-rtt:
+      - '13'
+      x-edgeconnect-origin-mex-latency:
+      - '399'
+      date:
+      - Mon, 04 Dec 2017 22:33:13 GMT
+      connection:
+      - close
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+    body:
+      encoding: UTF-8
+      string: '{"meta":{"httpStatus":"200 - OK","requestId":"fa58c44f-f1a4-41ba-9c7b-3db9547407d7"}}'
+    http_version: 
+  recorded_at: Mon, 04 Dec 2017 22:33:13 GMT
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/eventsubscriptions/SUB_5pPHcNfCaiADoFf
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 404
+      message: 
+    headers:
+      content-type:
+      - application/json
+      content-length:
+      - '136'
+      x-edgeconnect-midmile-rtt:
+      - '18'
+      x-edgeconnect-origin-mex-latency:
+      - '317'
+      date:
+      - Mon, 04 Dec 2017 22:33:13 GMT
+      connection:
+      - close
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+    body:
+      encoding: UTF-8
+      string: '{"meta":{"httpStatus":"404 - Not Found","error":{"errorMessage":"SUB_5pPHcNfCaiADoFf
+        not found","errorCode":"ESSG_2"},"requestId":null}}'
+    http_version: 
+  recorded_at: Mon, 04 Dec 2017 22:33:13 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/event_subscription_find.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/eventsubscriptions/SUB_6XMPw9UoySyGNyl
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      request-time:
+      - '454'
+      content-type:
+      - application/json
+      content-length:
+      - '274'
+      x-edgeconnect-midmile-rtt:
+      - '22'
+      x-edgeconnect-origin-mex-latency:
+      - '504'
+      date:
+      - Mon, 04 Dec 2017 21:22:04 GMT
+      connection:
+      - close
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+    body:
+      encoding: UTF-8
+      string: '{"result":{"id":"SUB_6XMPw9UoySyGNyl","scope":"cambridgetripod","topics":"controlpanel.activateSurvey","publicationUrl":"https://requestb.in/1mnrk0m1","encrypted":false,"successfulCalls":0},"meta":{"httpStatus":"200
+        - OK","requestId":"9ce297f0-0e9b-49fa-9710-ef53cde43b90"}}'
+    http_version: 
+  recorded_at: Mon, 04 Dec 2017 21:22:04 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/event_subscription_find_fail.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/eventsubscriptions/pewpewpewpew
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 404
+      message: 
+    headers:
+      content-type:
+      - application/json
+      content-length:
+      - '129'
+      x-edgeconnect-midmile-rtt:
+      - '23'
+      x-edgeconnect-origin-mex-latency:
+      - '397'
+      date:
+      - Mon, 04 Dec 2017 21:24:24 GMT
+      connection:
+      - close
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+    body:
+      encoding: UTF-8
+      string: '{"meta":{"httpStatus":"404 - Not Found","error":{"errorMessage":"pewpewpewpew
+        not found","errorCode":"ESSG_2"},"requestId":null}}'
+    http_version: 
+  recorded_at: Mon, 04 Dec 2017 21:24:24 GMT
+recorded_with: VCR 2.9.3

data/lib/qualtrics_api.rb

@@ -4,8 +4,6 @@ require "faraday"
 require "faraday_middleware"
 
 require "qualtrics_api/version"
-require "qualtrics_api/url"
-
 require "qualtrics_api/request_error_handler"
 
 require "qualtrics_api/configurable"
@@ -27,6 +25,8 @@ require "qualtrics_api/panel_collection"
 require "qualtrics_api/panel_member"
 require "qualtrics_api/panel_member_collection"
 require "qualtrics_api/panel_import"
+require "qualtrics_api/event_subscription"
+require "qualtrics_api/event_subscription_collection"
 
 require "qualtrics_api/services/response_export_service"
 
@@ -38,16 +38,21 @@ module QualtricsAPI
     def_delegator :client, :surveys
     def_delegator :client, :response_exports
     def_delegator :client, :panels
+    def_delegator :client, :event_subscriptions
 
     def connection(parent = nil)
       return parent.connection if parent && parent.connection
       client.connection
     end
 
+    def url(data_center_id = self.data_center_id)
+      "https://#{data_center_id}.qualtrics.com:443/API/v3/"
+    end
+
     private
 
     def client
-      @client ||= QualtricsAPI::Client.new(QualtricsAPI.api_token)
+      @client ||= QualtricsAPI::Client.new(QualtricsAPI.api_token, QualtricsAPI.data_center_id)
     end
   end
 end

data/lib/qualtrics_api/base_collection.rb

@@ -14,6 +14,20 @@ module QualtricsAPI
       end
     end
 
+    def map
+      res = []
+      each_page do |page|
+        page.each do |element|
+          res.push(yield element)
+        end
+      end
+      res
+    end
+
+    def all
+      map {|element| element}
+    end
+
     def each_page
       endpoint = list_endpoint
       loop do

data/lib/qualtrics_api/client.rb

@@ -2,8 +2,8 @@ module QualtricsAPI
   class Client
     include QualtricsAPI::Connectable
 
-    def initialize(api_token)
-      @connection = establish_connection(api_token || fail('Please provide api token!'))
+    def initialize(api_token, data_center_id)
+      @connection = establish_connection(api_token || fail('Please provide api token!'), data_center_id)
     end
 
     def surveys(options = {})
@@ -18,10 +18,14 @@ module QualtricsAPI
       QualtricsAPI::PanelCollection.new(options).propagate_connection(self)
     end
 
+    def event_subscriptions(options = {})
+      QualtricsAPI::EventSubscriptionCollection.new(options).propagate_connection(self)
+    end
+
     private
 
-    def establish_connection(api_token)
-      Faraday.new(url: QualtricsAPI::URL, headers: { 'X-API-TOKEN' => api_token }) do |faraday|
+    def establish_connection(api_token, data_center_id)
+      Faraday.new(url: QualtricsAPI.url(data_center_id), headers: { 'X-API-TOKEN' => api_token }) do |faraday|
         faraday.request :multipart
         faraday.request :json
         faraday.response :json, :content_type => /\bjson$/

data/lib/qualtrics_api/configurable.rb

@@ -1,10 +1,15 @@
 module QualtricsAPI
   module Configurable
     attr_accessor :api_token
+    attr_accessor :data_center_id
 
     def configure
       yield self
       self
     end
+
+    def data_center_id
+      @data_center_id || 'co1'
+    end
   end
 end

data/lib/qualtrics_api/event_subscription.rb

@@ -0,0 +1,35 @@
+module QualtricsAPI
+  class EventSubscription < BaseModel
+    values do
+      attribute :id, String
+      attribute :scope, String
+      attribute :topics, String
+      attribute :publication_url, String
+      attribute :encrypted, Boolean, default: false
+      attribute :successful_calls, Integer, default: 0
+    end
+
+    def delete
+      QualtricsAPI.connection(self)
+        .delete(endpoint)
+        .body["result"]
+    end
+
+    private
+
+    def endpoint
+      "eventsubscriptions/#{id}"
+    end
+
+    def attributes_mappings
+      {
+        id: "id",
+        scope: "scope",
+        topics: "topics",
+        publication_url: "publicationUrl",
+        encrypted: "encrypted",
+        successful_calls: "successfulCalls"
+      }
+    end
+  end
+end

data/lib/qualtrics_api/event_subscription_collection.rb

@@ -0,0 +1,48 @@
+module QualtricsAPI
+  class EventSubscriptionCollection < BaseCollection
+    alias_method :[], :find
+
+    def create(publication_url, topics, opts = { encrypt: false })
+      payload = {
+        publicationUrl: publication_url,
+        topics: topics
+      }.merge(opts)
+      res = QualtricsAPI.connection(self)
+              .post(list_endpoint, payload)
+              .body["result"]
+      find(res["id"])
+    end
+
+    def create_completed_response_subscription(url, survey_id, opts = { encrypt: false })
+      create(url, "surveyengine.completedResponse.#{survey_id}", opts)
+    end
+
+    def create_partial_response_subscription(url, survey_id, opts = { encrypt: false })
+      create(url, "surveyengine.partialResponse.#{survey_id}", opts)
+    end
+
+    def delete(id)
+      QualtricsAPI.connection(self)
+        .delete(endpoint(id))
+    end
+
+    def delete_all
+      QualtricsAPI.connection(self)
+        .delete(list_endpoint)
+    end
+
+    private
+
+    def build_result(element)
+      QualtricsAPI::EventSubscription.new(element)
+    end
+
+    def list_endpoint
+      "eventsubscriptions"
+    end
+
+    def endpoint(id)
+      "eventsubscriptions/#{id}"
+    end
+  end
+end

data/lib/qualtrics_api/request_error_handler.rb

@@ -1,27 +1,44 @@
+require 'logger'
+
 module QualtricsAPI
   class RequestErrorHandler < Faraday::Response::Middleware
     def on_complete(env)
-      case env[:status]
+      raise_http_errors(env[:status], env[:body])
+      show_notices(env[:body])
+    end
+
+    private
+
+    def raise_http_errors(code, body)
+      case code
       when 404
         raise NotFoundError, "Not Found"
       when 400
-        raise BadRequestError, error_message(JSON.parse(env[:body]))
+        raise BadRequestError, error_message(JSON.parse(body))
       when 401
-        raise UnauthorizedError, error_message(JSON.parse(env[:body]))
+        raise UnauthorizedError, error_message(JSON.parse(body))
       when 500
-        raise InternalServerError, error_message(JSON.parse(env[:body]))
+        raise InternalServerError, error_message(JSON.parse(body))
       end
     end
 
-    private
+    def show_notices(body)
+      response = JSON.parse(body)
+      notice = response["meta"]["notice"]
+      if notice && notice.size > 0
+        STDERR.puts notice
+      end
+    end
 
     def error_message(response)
       meta = response["meta"]
+      err = meta["error"] || {}
       ["[",
-       meta["status"], " - ",
-       meta["qualtricsErrorCode"] || meta["internalErrorCode"],
+      meta["status"] || meta["httpStatus"],
+      " - ",
+      err["qualtricsErrorCode"] || err["internalErrorCode"] || err["errorCode"],
        "] ",
-       meta["errorMessage"]
+       err["errorMessage"]
       ].join
     end
   end

data/lib/qualtrics_api/version.rb

@@ -1,3 +1,3 @@
 module QualtricsAPI
-  VERSION = "0.0.12".freeze
+  VERSION = "0.0.13".freeze
 end

data/qualtrics_api.gemspec

@@ -20,14 +20,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_dependency "faraday", "~> 0.9.1"
-  spec.add_dependency "faraday_middleware", "~> 0.9.1"
+  spec.add_dependency "faraday", "~> 0.13.1"
+  spec.add_dependency "faraday_middleware", "~> 0.12.2"
   spec.add_dependency "virtus", "~> 1.0"
 
-  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 "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "vcr", "~> 3.0"
 end

data/spec/lib/client_spec.rb

@@ -19,11 +19,18 @@ describe QualtricsAPI::Client do
     subject { QualtricsAPI::Client }
 
     it "fails if api_token not provided" do
-      expect { subject.new(nil) }.to raise_error('Please provide api token!')
+      expect { subject.new(nil, nil) }.to raise_error('Please provide api token!')
     end
 
-    it 'establishes connection when api_token' do
-      subject.new('sample_token')
+    it 'establishes connection when api_token is provided' do
+      client = subject.new('sample_token', 'co1')
+      expect(client.connection).not_to be_nil
+      expect(client.connection.headers["X-API-TOKEN"]).to eq('sample_token')
+    end
+
+    it 'establishes connection to the specified data center' do
+      client = subject.new('sample_token', 'somedcid')
+      expect(client.connection.url_prefix.to_s).to eq('https://somedcid.qualtrics.com/API/v3/')
     end
   end
 end