qualtrics_api 0.0.12 → 0.0.13

data/spec/lib/event_subscription_collection_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe QualtricsAPI::EventSubscriptionCollection do
+  subject { described_class.new }
+
+  describe "can find subscriptions" do
+    it "returns the subscription if exists" do
+      VCR.use_cassette("event_subscription_find") do
+        subscription_id = "SUB_6XMPw9UoySyGNyl"
+        result = subject.find(subscription_id)
+        expect(result).to be_a QualtricsAPI::EventSubscription
+        expect(result.id).to eq subscription_id
+      end
+    end
+
+    it "raise an error if not exists" do
+      VCR.use_cassette("event_subscription_find_fail") do
+        subscription_id = "pewpewpewpew"
+        expect {
+          subject.find(subscription_id)
+        }.to raise_error(QualtricsAPI::NotFoundError)
+      end
+    end
+  end
+
+  describe "#create" do
+    it "creates subscription with publication url and topics" do
+      VCR.use_cassette("event_subscription_create") do
+        result = subject.create('https://some.random.url', 'controlpanel.activateSurvey')
+        expect(result).to be_a QualtricsAPI::EventSubscription
+        expect(result.id).to_not be_nil
+        expect(result.publication_url).to eq 'https://some.random.url'
+      end
+    end
+
+    describe "#create_completed_response_subscription" do
+      it "creates a subscription to the completedResponse event of the survey id specified" do
+        VCR.use_cassette("event_subscription_create_response_sub") do
+          survey_id = 'SV_SOME_SURVEY_ID'
+          url = 'https://some.url.fake'
+          result = subject.create_completed_response_subscription(url, survey_id)
+          expect(result).to be_a QualtricsAPI::EventSubscription
+          expect(result.id).to_not be_nil
+          expect(result.publication_url).to eq url
+          expect(result.topics).to eq "surveyengine.completedResponse.#{survey_id}"
+        end
+      end
+    end
+
+    describe "#create_completed_response_subscription" do
+      it "creates a subscription to the partialResponse event of the survey id specified" do
+        VCR.use_cassette("event_subscription_create_partial_response_sub") do
+          survey_id = 'SV_ANOTHER_SURVEY'
+          url = 'https://request.url.fake'
+          result = subject.create_partial_response_subscription(url, survey_id)
+          expect(result).to be_a QualtricsAPI::EventSubscription
+          expect(result.id).to_not be_nil
+          expect(result.publication_url).to eq url
+          expect(result.topics).to eq "surveyengine.partialResponse.#{survey_id}"
+        end
+      end
+    end
+  end
+
+  describe "#delete" do
+    it "deletes the subscription specified" do
+      VCR.use_cassette("event_subscription_delete_one") do
+        sub_id = 'SUB_5pPHcNfCaiADoFf'
+        subject.delete(sub_id)
+        #QualtricsAPI.event_subscriptions.delete(sub_id)
+        expect {
+          subject.find(sub_id)
+          #QualtricsAPI.event_subscriptions.find(sub_id)
+        }.to raise_error(QualtricsAPI::NotFoundError)
+      end
+    end
+  end
+
+  describe "#delete_all" do
+    it "deletes all subscriptions" do
+      VCR.use_cassette("event_subscription_delete_all") do
+        expect(subject.all.size).to eq 3
+        subject.delete_all
+        expect(subject.all.size).to eq 0
+      end
+    end
+  end
+
+end

data/spec/lib/event_subscription_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe QualtricsAPI::EventSubscription do
+  let(:event_subscription) do
+    {
+      "id" => "SUB_012345678912345",
+      "scope" => "exampleorganizationid",
+      "topics" => "controlpanel.activateSurvey",
+      "publicationUrl" => "https://www.example.com/pub",
+      "encrypted" => false,
+      "successfulCalls" => 3
+    }
+  end
+
+  subject { described_class.new event_subscription }
+
+  it "has an id" do
+    expect(subject.id).to eq "SUB_012345678912345"
+  end
+  
+  it "has scope" do
+    expect(subject.scope).to eq "exampleorganizationid"
+  end
+
+  it "has topics" do
+    expect(subject.topics).to eq "controlpanel.activateSurvey"
+  end
+
+  it "has publicationUrl" do
+    expect(subject.publication_url).to eq "https://www.example.com/pub"
+  end
+
+  it "shows if encrypted" do
+    expect(subject.encrypted?).to be false
+  end
+
+  it "shows number of successful calls" do
+    expect(subject.successful_calls).to eq 3
+  end
+
+  describe "#delete" do
+    it "deletes the subscription" do
+      VCR.use_cassette("event_subscription_delete") do
+        sub_id = 'SUB_2i7QDi3PXEK4eqx'
+        subscription = QualtricsAPI.event_subscriptions.find(sub_id)
+        subscription.delete
+        expect {
+          QualtricsAPI.event_subscriptions.find(sub_id)
+        }.to raise_error(QualtricsAPI::NotFoundError)
+      end
+    end
+  end
+end

data/spec/qualtrics_api_spec.rb

@@ -5,8 +5,8 @@ describe QualtricsAPI do
     subject { QualtricsAPI }
 
     it 'two clients have different connection' do
-      client_1 = QualtricsAPI::Client.new('some_id')
-      client_2 = QualtricsAPI::Client.new('other_id')
+      client_1 = QualtricsAPI::Client.new('some_id', 'co1')
+      client_2 = QualtricsAPI::Client.new('other_id', 'co2')
       expect(client_1.connection).not_to eq(client_2.connection)
     end
 
@@ -15,7 +15,7 @@ describe QualtricsAPI do
     end
 
     it 'does not reuse connection with client' do
-      client = QualtricsAPI::Client.new('some_id')
+      client = QualtricsAPI::Client.new('some_id', 'co1')
       expect(client.connection).not_to eq(QualtricsAPI.connection)
     end
 
@@ -28,7 +28,7 @@ describe QualtricsAPI do
       end
 
       context 'with client' do
-        let(:client) { QualtricsAPI::Client.new(TEST_API_TOKEN) }
+        let(:client) { QualtricsAPI::Client.new(TEST_API_TOKEN, 'co1') }
         let(:members) do
           VCR.use_cassette('panel_member_collection_create_success') do
             client.panels.find('ML_bC2c5xBz1DxyOYB').members
@@ -44,7 +44,7 @@ describe QualtricsAPI do
         end
 
         context 'with different client' do
-          let(:client_2) { QualtricsAPI::Client.new(TEST_API_TOKEN) }
+          let(:client_2) { QualtricsAPI::Client.new(TEST_API_TOKEN, 'co1') }
           let(:members_2) do
             VCR.use_cassette('panel_member_collection_create_success') do
               client_2.panels.find('ML_bC2c5xBz1DxyOYB').members

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qualtrics_api
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Yurui Zhang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2017-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -18,28 +18,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -60,56 +60,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.0'
 description: |-
   A Ruby wrapper for Qualtrics REST API version 3.0.
                             See https://co1.qualtrics.com/APIDocs/ for API documents.
@@ -129,6 +129,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- fixtures/vcr_cassettes/event_subscription_create.yml
+- fixtures/vcr_cassettes/event_subscription_create_partial_response_sub.yml
+- fixtures/vcr_cassettes/event_subscription_create_response_sub.yml
+- fixtures/vcr_cassettes/event_subscription_delete.yml
+- fixtures/vcr_cassettes/event_subscription_delete_all.yml
+- fixtures/vcr_cassettes/event_subscription_delete_one.yml
+- fixtures/vcr_cassettes/event_subscription_find.yml
+- fixtures/vcr_cassettes/event_subscription_find_fail.yml
 - fixtures/vcr_cassettes/panel_collection_fetch_fail.yml
 - fixtures/vcr_cassettes/panel_collection_fetch_success.yml
 - fixtures/vcr_cassettes/panel_find.yml
@@ -148,6 +156,8 @@ files:
 - lib/qualtrics_api/client.rb
 - lib/qualtrics_api/configurable.rb
 - lib/qualtrics_api/connectable.rb
+- lib/qualtrics_api/event_subscription.rb
+- lib/qualtrics_api/event_subscription_collection.rb
 - lib/qualtrics_api/extensions/serializable_collection.rb
 - lib/qualtrics_api/extensions/serializable_model.rb
 - lib/qualtrics_api/panel.rb
@@ -161,10 +171,11 @@ files:
 - lib/qualtrics_api/services/response_export_service.rb
 - lib/qualtrics_api/survey.rb
 - lib/qualtrics_api/survey_collection.rb
-- lib/qualtrics_api/url.rb
 - lib/qualtrics_api/version.rb
 - qualtrics_api.gemspec
 - spec/lib/client_spec.rb
+- spec/lib/event_subscription_collection_spec.rb
+- spec/lib/event_subscription_spec.rb
 - spec/lib/panel_collection_spec.rb
 - spec/lib/panel_import_spec.rb
 - spec/lib/panel_member_collection_spec.rb
@@ -189,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -197,12 +208,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for Qualtrics REST API v3.0
 test_files:
 - spec/lib/client_spec.rb
+- spec/lib/event_subscription_collection_spec.rb
+- spec/lib/event_subscription_spec.rb
 - spec/lib/panel_collection_spec.rb
 - spec/lib/panel_import_spec.rb
 - spec/lib/panel_member_collection_spec.rb

data/lib/qualtrics_api/url.rb

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