qualtrics_api 0.0.15 → 0.0.16

data/lib/qualtrics_api/question_collection.rb

@@ -0,0 +1,46 @@
+module QualtricsAPI
+  class QuestionCollection < BaseCollection
+    def [](survey_id, question_id)
+      find(survey_id, question_id)
+    end
+
+    def find(survey_id, question_id)
+      response = QualtricsAPI.connection(self).get(endpoint(survey_id, question_id))
+      return nil unless response.status == 200
+      build_result(response.body['result']).propagate_connection(self)
+    end
+
+    def each(survey_id)
+      page = each_page(survey_id)
+      page.each do |element|
+        yield element
+      end
+    end
+
+    def each_page(survey_id)
+      endpoint = list_endpoint(survey_id)
+      response = QualtricsAPI.connection(self).get(endpoint)
+      parse_page(response)
+    end
+
+    protected
+
+    def page_endpoint(fetched)
+      raise NotSupported
+    end
+
+    private
+
+    def build_result(element)
+      QualtricsAPI::Question.new(element)
+    end
+
+    def list_endpoint(survey_id)
+      "survey-definitions/#{survey_id}/questions"
+    end
+
+    def endpoint(survey_id, question_id)
+      "survey-definitions/#{survey_id}/questions/#{question_id}"
+    end
+  end
+end

data/lib/qualtrics_api/version.rb

@@ -1,3 +1,3 @@
 module QualtricsAPI
-  VERSION = "0.0.15".freeze
+  VERSION = "0.0.16".freeze
 end

data/spec/lib/client_spec.rb

@@ -15,6 +15,12 @@ describe QualtricsAPI::Client do
     end
   end
 
+  describe "#questions" do
+    it "returns a QuestionCollection" do
+      expect(subject.questions).to be_a QualtricsAPI::QuestionCollection
+    end
+  end
+
   describe "#initialize" do
     subject { QualtricsAPI::Client }
 

data/spec/lib/distribution_collection_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe QualtricsAPI::DistributionCollection do
+  describe "integration" do
+    subject { described_class.new(id: 'ABCD') }
+
+    describe '#create' do
+      let(:distribution) do
+        QualtricsAPI::Distribution.new(
+          action: "CreateDistribution",
+          survey_id: "SV_eVtvUQALTlL8Uzr",
+          mailing_list_id: "ML_3wO6vOd0yrRezyd",
+          description: "Foobar",
+          expiration_date: nil,
+          link_type: 'Individual'
+        )
+      end
+      let(:result) do
+        VCR.use_cassette(cassette, record: :once) do
+          QualtricsAPI::DistributionCollection.new.create(distribution)
+        end
+      end
+
+      describe 'when success' do
+        let(:cassette) { 'distribution_create_success' }
+
+        it 'returns distribution' do
+          expect(result).to be_a QualtricsAPI::Distribution
+        end
+      end
+    end
+  end
+end

data/spec/lib/distribution_link_collection_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe QualtricsAPI::DistributionLinkCollection do
+  describe "integration" do
+    subject { described_class.new('SV_eVtvUQALTlL8Uzr', 'EMD_9A7FZioL5pgWZJb') }
+
+    describe "#find" do
+      # There's no API endpoint for retrieving a single distribution link that I can see.
+      it 'is not implemented' do
+        expect { subject.find('foo') }.to raise_exception(NotImplementedError)
+      end
+    end
+
+    describe "#fetch" do
+      describe "when success" do
+        let!(:result) do
+          VCR.use_cassette("distribution_link_collection_fetch_sucess", record: :once) do
+            subject.each_page do |page|
+              return page
+            end
+          end
+        end
+
+        it "populates the collection" do
+          expect(result.size).to eq 100
+          expect(result.first).to be_a QualtricsAPI::DistributionLink
+        end
+      end
+
+      describe "when failed" do
+        subject { described_class.new('SV_eVtvUQALTlL8Uzr', 'EMD_9A7FZioL5pgxxxx') }
+
+        it "raises error" do
+          VCR.use_cassette("distribution_link_collection_fetch_fail", record: :once) do
+            expect { subject.each_page }.to raise_error(QualtricsAPI::NotFoundError)
+          end
+        end
+      end
+    end
+
+    describe 'pagination' do
+      it 'fetches pages from list endpoint' do
+        page1 = page2 = nil
+        VCR.use_cassette("distribution_link_collection_pagination") do
+          page_no = 0
+          max_pages = 2
+          subject.each_page do |page|
+            break if page_no == max_pages
+            if page_no == 0
+              page1 = page
+            elsif page_no == 1
+              page2 = page
+            else
+              raise 'should not iterate here'
+            end
+            page_no += 1
+          end
+          expect(page1).not_to be_nil
+          expect(page2).not_to be_nil
+        end
+      end
+    end
+  end
+end

data/spec/lib/question_collection_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe QualtricsAPI::QuestionCollection do
+  describe "integration" do
+    subject { described_class.new }
+    let(:survey_id) { 'SV_a2AcbPZz1DehlOd' }
+    let(:missing_survey_id) { 'SV_a2AcbPZz1Dxxxx' }
+    let(:question_id) { 'QID1' }
+    let(:missing_question_id) { 'QID1xxxx' }
+    let(:question_attr_keys) do
+      %i[
+        question_text
+        data_export_tag
+        question_type
+        selector
+        sub_selector
+        configuration
+        question_description
+        choices
+        choice_order
+        validation
+        language
+        next_choice_id
+        next_answer_id
+        question_id
+        question_text_unsafe
+      ]
+    end
+
+    describe "#find" do
+      context 'when exists' do
+        let!(:result) do
+          VCR.use_cassette("question_find") do
+            subject.find(survey_id, question_id)
+          end
+        end
+
+        it 'populates the result' do
+          expect(result.attributes.keys).to match_array(question_attr_keys)
+        end
+      end
+
+      context 'when does not exist' do
+        let!(:result) do
+          VCR.use_cassette("question_find_fail") do
+            subject.find(missing_survey_id, missing_question_id)
+          end
+        end
+
+        it 'raises error', skip: 'API Bug' do
+          # TODO: API returns 403 in this case. 404 seems more appropriate.
+          # expect { result }.to raise_error(QualtricsAPI::NotFoundError)
+        end
+      end
+    end
+
+    describe "#fetch" do
+      describe "when success" do
+        let!(:result) do
+          VCR.use_cassette("question_collection_fetch_success") do
+            subject.each_page(survey_id) do |page|
+              return page
+            end
+          end
+        end
+
+        it "populates the collection" do
+          expect(result.first).to be_a QualtricsAPI::Question
+        end
+      end
+
+      describe "when failed" do
+        let!(:result) do
+          VCR.use_cassette("question_collection_fetch_fail") do
+            subject.each_page(missing_survey_id)
+          end
+        end
+
+        it "raises error", skip: 'API Bug' do
+          # TODO: API returns 403 in this case. 404 seems more appropriate.
+          # expect { result }.to raise_error(QualtricsAPI::NotFoundError)
+        end
+      end
+    end
+  end
+end

data/spec/lib/question_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe QualtricsAPI::Question do
+  let(:qualtrics_response) do
+    {
+      "QuestionText" => "Who is your favorite writer?",
+      "DataExportTag" => "Q1",
+      "QuestionType" => "MC",
+      "Selector" => "SAVR",
+      "SubSelector" => "TX",
+      "Configuration" => {
+        "QuestionDescriptionOption" => "UseText"
+      },
+      "QuestionDescription" => "Who is your favorite writer?",
+      "Choices" => {
+        "1" => {
+          "Display" => "Thomas Mann"
+        },
+        "2" => {
+          "Display" => "Albert Camus"
+        },
+        "3" => {
+          "Display" => "Anton Chekov"
+        }
+      },
+      "ChoiceOrder" => [
+        1,
+        2,
+        3
+      ],
+      "Validation" => {
+        "Settings" => {
+          "ForceResponse" => "OFF",
+          "ForceResponseType" => "ON",
+          "Type" => "None"
+        }
+      },
+      "Language" => [],
+      "NextChoiceId" => 4,
+      "NextAnswerId" => 1,
+      "QuestionID" => "QID1",
+      "QuestionText_Unsafe" => "Who is your favorite writer?"
+    }
+  end
+
+  subject { described_class.new qualtrics_response }
+
+  it "has question text" do
+    expect(subject.question_text).to eq qualtrics_response["QuestionText"]
+  end
+
+  it "has a data export tag" do
+    expect(subject.data_export_tag).to eq qualtrics_response["DataExportTag"]
+  end
+
+  it "has a question type" do
+    expect(subject.question_type).to eq qualtrics_response["QuestionType"]
+  end
+
+  it "has a selector" do
+    expect(subject.selector).to eq qualtrics_response["Selector"]
+  end
+
+  it "has a sub selector" do
+    expect(subject.sub_selector).to eq qualtrics_response["SubSelector"]
+  end
+
+  it "has a configuration" do
+    expect(subject.configuration).to eq qualtrics_response["Configuration"]
+  end
+
+  it "has a question description" do
+    expect(subject.question_description).to eq qualtrics_response["QuestionDescription"]
+  end
+
+  it "has choices" do
+    expect(subject.choices).to eq qualtrics_response["Choices"]
+  end
+
+  it "has a choice order" do
+    expect(subject.choice_order).to eq qualtrics_response["ChoiceOrder"]
+  end
+
+  it "has validation" do
+    expect(subject.validation).to eq qualtrics_response["Validation"]
+  end
+
+  it "has a language" do
+    expect(subject.language).to eq qualtrics_response["Language"]
+  end
+
+  it "has a next choice id" do
+    expect(subject.next_choice_id).to eq qualtrics_response["NextChoiceId"]
+  end
+
+  it "has a next answer id" do
+    expect(subject.next_answer_id).to eq qualtrics_response["NextAnswerId"]
+  end
+
+  it "has a question id" do
+    expect(subject.question_id).to eq qualtrics_response["QuestionID"]
+  end
+
+  it "has question text (unsafe)" do
+    expect(subject.question_text_unsafe).to eq qualtrics_response["QuestionText_Unsafe"]
+  end
+
+  describe 'equality' do
+    context 'when same' do
+      it 'returns true' do
+        expect(subject).to eq(described_class.new(subject.attributes))
+      end
+    end
+
+    context 'when different' do
+      it 'returns false' do
+        expect(subject).not_to eq(described_class.new)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qualtrics_api
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Yurui Zhang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -129,6 +129,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- fixtures/vcr_cassettes/distribution_create_success.yml
+- fixtures/vcr_cassettes/distribution_link_collection_fetch_fail.yml
+- fixtures/vcr_cassettes/distribution_link_collection_fetch_sucess.yml
+- fixtures/vcr_cassettes/distribution_link_collection_pagination.yml
+- fixtures/vcr_cassettes/distribution_links.yml
 - 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
@@ -147,6 +152,10 @@ files:
 - fixtures/vcr_cassettes/panel_member_collection_fetch_success.yml
 - fixtures/vcr_cassettes/panel_member_single_create_failure.yml
 - fixtures/vcr_cassettes/panel_member_single_create_success.yml
+- fixtures/vcr_cassettes/question_collection_fetch_fail.yml
+- fixtures/vcr_cassettes/question_collection_fetch_success.yml
+- fixtures/vcr_cassettes/question_find.yml
+- fixtures/vcr_cassettes/question_find_fail.yml
 - fixtures/vcr_cassettes/response_export_start_success.yml
 - fixtures/vcr_cassettes/response_export_update_success.yml
 - fixtures/vcr_cassettes/survey_collection_fetch_fail.yml
@@ -158,6 +167,10 @@ files:
 - lib/qualtrics_api/client.rb
 - lib/qualtrics_api/configurable.rb
 - lib/qualtrics_api/connectable.rb
+- lib/qualtrics_api/distribution.rb
+- lib/qualtrics_api/distribution_collection.rb
+- lib/qualtrics_api/distribution_link.rb
+- lib/qualtrics_api/distribution_link_collection.rb
 - lib/qualtrics_api/event_subscription.rb
 - lib/qualtrics_api/event_subscription_collection.rb
 - lib/qualtrics_api/extensions/serializable_collection.rb
@@ -167,6 +180,8 @@ files:
 - lib/qualtrics_api/panel_import.rb
 - lib/qualtrics_api/panel_member.rb
 - lib/qualtrics_api/panel_member_collection.rb
+- lib/qualtrics_api/question.rb
+- lib/qualtrics_api/question_collection.rb
 - lib/qualtrics_api/request_error_handler.rb
 - lib/qualtrics_api/response_export.rb
 - lib/qualtrics_api/response_export_collection.rb
@@ -176,6 +191,10 @@ files:
 - lib/qualtrics_api/version.rb
 - qualtrics_api.gemspec
 - spec/lib/client_spec.rb
+- spec/lib/distribution_collection_spec.rb
+- spec/lib/distribution_link_collection_spec.rb
+- spec/lib/distribution_link_spec.rb
+- spec/lib/distribution_spec.rb
 - spec/lib/event_subscription_collection_spec.rb
 - spec/lib/event_subscription_spec.rb
 - spec/lib/panel_collection_spec.rb
@@ -183,6 +202,8 @@ files:
 - spec/lib/panel_member_collection_spec.rb
 - spec/lib/panel_member_spec.rb
 - spec/lib/panel_spec.rb
+- spec/lib/question_collection_spec.rb
+- spec/lib/question_spec.rb
 - spec/lib/response_export_collection_spec.rb
 - spec/lib/response_export_spec.rb
 - spec/lib/services/response_export_service_spec.rb
@@ -209,13 +230,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for Qualtrics REST API v3.0
 test_files:
 - spec/lib/client_spec.rb
+- spec/lib/distribution_collection_spec.rb
+- spec/lib/distribution_link_collection_spec.rb
+- spec/lib/distribution_link_spec.rb
+- spec/lib/distribution_spec.rb
 - spec/lib/event_subscription_collection_spec.rb
 - spec/lib/event_subscription_spec.rb
 - spec/lib/panel_collection_spec.rb
@@ -223,6 +247,8 @@ test_files:
 - spec/lib/panel_member_collection_spec.rb
 - spec/lib/panel_member_spec.rb
 - spec/lib/panel_spec.rb
+- spec/lib/question_collection_spec.rb
+- spec/lib/question_spec.rb
 - spec/lib/response_export_collection_spec.rb
 - spec/lib/response_export_spec.rb
 - spec/lib/services/response_export_service_spec.rb