qualtrics_api 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f836176e18af2d85f18fba39a7af32952e185a2
-  data.tar.gz: 24a7800f963644225c332126d6df9c85dae67ea0
+  metadata.gz: 79a66f0df860f75c6181490b7d6c241b509b0ff8
+  data.tar.gz: 34a1db85f28e9ec0bb583b581dba1f6ab1078cad
 SHA512:
-  metadata.gz: 01df3b46bf2cbe27349920312e2b54efb0c64a0ecf7d004c57acc35ee3d7ad10f90652c81018f6e8ca210121ae8a7b810815a8f5e0ec38fc40e37e3028eded95
-  data.tar.gz: 68edbed27d3c5c3f6b66fb2d760e7dc5f6d47dc22136d882ae9e2de47aa16d23d79d61af07167fc923279cda246a18251e3f197c9c1c3b5e09e218ab843f7550
+  metadata.gz: f5d214fac45c117c0b06071309d7546bee2075cce098d51b8f1532da7e775a671f7a29ac8a8a544d4387bc73e268218f38cc64353e0039b8463bc23d3b03fd08
+  data.tar.gz: 0d3e12210c810d3d6fd3ecb3a2b1784001002da1339a68b5cb0ee22b3c7de28115f9a1e8a4c1e88a393640ccc7046ee3c894b5925eeb04fbf82390243902cf13

data/README.md

@@ -35,17 +35,21 @@ end
 
 ### Surveys
 
-To paginate all your surveys:
+To enumerate all your surveys:
 
 ```ruby
-surveys = QualtricsAPI.surveys.fetch
-# => #<QualtricsAPI::SurveyCollection:0x007fcb72cce350 ....>
-
-surveys = surveys.next_page # to fetch next page if not on the last page
-# => #<QualtricsAPI::SurveyCollection:0x007fcb72cce350 ....>
+QualtricsAPI.surveys.each do |survey|
+  # => #<QualtricsAPI::Survey:0x007fcb72cce350 ....>
+end
+```
 
-surveys.next_page?
-# => true
+To enumerate individual pages:
+```ruby
+QualtricsAPI.surveys.each_page do |page|
+  page.each do |survey|
+    # => #<QualtricsAPI::Survey:0x007fcb72cce350 ....>
+  end
+end
 ```
 
 You can search for a survey by id:
@@ -137,14 +141,22 @@ export.status
 
 ### Panels
 
-To paginate all the panels:
+To enumerate all the panels:
 
 ```ruby
-panels = QualtricsAPI.panels.fetch
-# => #<QualtricsAPI::PanelCollection:0x007f8769aae2c0 ....>
+QualtricsAPI.panels.each do |panel|
+  # => #<QualtricsAPI::Panel:0x007f8769aae2c0 ....>
+end
+```
+
+To enumerate individual pages:
 
-panels = panels.next_page # get next page if panels.next_page?
-# => #<QualtricsAPI::PanelCollection:0x007f8769aae2c0 ....>
+```ruby
+QualtricsAPI.panels.each_page do |page|
+  page.each do |survey|
+    # => #<QualtricsAPI::Panel:0x007f8769aae2c0 ....>
+  end
+end
 ```
 
 You can search for a panel by id:

data/fixtures/vcr_cassettes/panel_collection_fetch_fail.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://co1.qualtrics.com/API/v3/panels
+    uri: https://co1.qualtrics.com/API/v3/mailinglists
     body:
       encoding: US-ASCII
       string: ''
@@ -13,7 +13,7 @@ http_interactions:
       - Faraday v0.9.2
   response:
     status:
-      code: 200
+      code: 400
       message: 
     headers:
       server:

data/fixtures/vcr_cassettes/panel_member_collection_fetch_fail.yml

@@ -2,32 +2,35 @@
 http_interactions:
 - request:
     method: get
-    uri: https://co1.qualtrics.com/API/v1/panels/ABCD/members?apiToken=6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+    uri: https://co1.qualtrics.com/API/v3/mailinglists/ABCD/contacts
     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:
+      code: 400
+      message: 
     headers:
-      server:
-      - Apache-Coyote/1.1
       content-type:
-      - application/json
+      - application/json; charset=utf-8
+      request-time:
+      - '178'
       content-length:
-      - '223'
+      - '2362'
       date:
-      - Sun, 28 Jun 2015 21:05:57 GMT
+      - Tue, 12 Apr 2016 11:39:15 GMT
       connection:
       - close
     body:
       encoding: UTF-8
-       string: '{"meta":{"status":"Error","errorMessage":"You do not have permission
-        to access this resource.","internalErrorCode":"GS_5","errorId":"3d6a9018-3b87-4265-b662-572ad96bbe6c"},"result":null}'
-    http_version:
-  recorded_at: Sun, 28 Jun 2015 21:05:57 GMT
+      string: '{"result":{"elements":[{"id":"ABCE","firstName":"Joe","lastName":"Doe","email":"demo@example.com","externalDataReference":"0001","embeddedData":{"subject_name":"John
+        Doe"},"language":null,"unsubscribed":false,"responseHistory":[],"emailHistory":[]}],"nextPage":null},"meta":{"httpStatus":"200
+        - OK"}}'
+    http_version: 
+  recorded_at: Tue, 12 Apr 2016 11:39:17 GMT
 recorded_with: VCR 2.9.3

data/lib/qualtrics_api/base_collection.rb

@@ -6,23 +6,21 @@ module QualtricsAPI
     include QualtricsAPI::Extensions::SerializableCollection
     include QualtricsAPI::Connectable
 
-    values do
-      attribute :page, Array, :default => []
-      attribute :fetched, Boolean, :default => false
-      attribute :next_endpoint, String
-    end
-
-    def_delegator :page, :each
-
-    def fetch
-      parse_fetch_response(QualtricsAPI.connection(self).get(list_endpoint))
-      self
+    def each
+      each_page do |page|
+        page.each do |element|
+          yield element
+        end
+      end
     end
 
-    def next_page
-      raise NotFoundError unless next_page?
-      self.class.new.tap do |r|
-        r.parse_fetch_response(QualtricsAPI.connection(self).get(next_endpoint))
+    def each_page
+      endpoint = list_endpoint
+      loop do
+        response = QualtricsAPI.connection(self).get(endpoint)
+        endpoint = response.body["result"]["nextPage"]
+        yield parse_page(response)
+        break unless endpoint
       end
     end
 
@@ -32,19 +30,16 @@ module QualtricsAPI
       build_result(response.body['result']).propagate_connection(self)
     end
 
-    def next_page?
-      raise NotYetFetchedError unless fetched
-      !next_endpoint.nil?
-    end
-
     protected
 
-    def parse_fetch_response(response)
-      @page = response.body["result"]["elements"].map do |element|
+    def page_endpoint(fetched)
+      fetched ? @next_endpoint : list_endpoint
+    end
+
+    def parse_page(response)
+      response.body["result"]["elements"].map do |element|
         build_result(element).propagate_connection(self)
       end
-      @next_endpoint = response.body["result"]["nextPage"]
-      @fetched = true
     end
   end
 end

data/lib/qualtrics_api/version.rb

@@ -1,3 +1,3 @@
 module QualtricsAPI
-  VERSION = "0.0.10".freeze
+  VERSION = "0.0.11".freeze
 end

data/spec/lib/panel_collection_spec.rb

@@ -1,10 +1,6 @@
 require 'spec_helper'
 
 describe QualtricsAPI::PanelCollection do
-  it "has no @page when initialized" do
-    expect(subject.page).to eq []
-  end
-
   describe "integration" do
     describe "#find" do
       let(:result) do
@@ -29,57 +25,31 @@ describe QualtricsAPI::PanelCollection do
         end
       end
     end
-    describe "#fetch" do
+    describe "#each_page" do
       describe "when success" do
-        before do
-          expect(subject.page.size).to eq 0
-        end
-
         let!(:result) do
           VCR.use_cassette("panel_collection_fetch_success") do
-            subject.fetch
+            subject.each_page do |page|
+              return page
+            end
           end
         end
 
         it "populates the collection" do
-          expect(subject.page.size).to eq 1
-          expect(subject.first).to be_a QualtricsAPI::Panel
-        end
-
-        it "returns itself" do
-          expect(result).to eq subject
+          expect(result.size).to eq 1
+          expect(result.first).to be_a QualtricsAPI::Panel
         end
       end
 
       describe "when failed" do
         it "raises error and does not reset panels" do
-          subject.instance_variable_set :@page, [QualtricsAPI::Panel.new({})]
           expect do
             VCR.use_cassette("panel_collection_fetch_fail") do
-              begin
-                subject.fetch
-              rescue
-                nil
-              end
+              subject.each_page
             end
-          end.not_to change { subject.page }
+          end.to raise_error(QualtricsAPI::BadRequestError)
         end
       end
     end
   end
-
-  describe 'equality' do
-    subject { described_class.new(page: [QualtricsAPI::Panel.new("panelId" => "p1"), QualtricsAPI::Panel.new("panelId" => "p2")]) }
-    context 'when same' do
-      it 'returns true' do
-        expect(subject).to eq(described_class.new(page: subject.page))
-      end
-    end
-  
-    context 'when different' do
-      it 'returns false' do
-        expect(subject).not_to eq(described_class.new)
-      end
-    end
-  end
 end

data/spec/lib/panel_member_collection_spec.rb

@@ -1,10 +1,6 @@
 require 'spec_helper'
 
 describe QualtricsAPI::PanelMemberCollection do
-  it "has no @page when initialized" do
-    expect(subject.page).to eq []
-  end
-
   describe "integration" do
     subject { described_class.new(id: 'ABCD') }
 
@@ -34,34 +30,25 @@ describe QualtricsAPI::PanelMemberCollection do
 
     describe "#fetch" do
       describe "when success" do
-        before do
-          expect(subject.page.size).to eq 0
-        end
-
         let!(:result) do
           VCR.use_cassette("panel_member_collection_fetch_success") do
-            subject.fetch
+            subject.each_page do |page|
+              return page
+            end
           end
         end
 
         it "populates the collection" do
-          expect(subject.page.size).to eq 1
-          expect(subject.first).to be_a QualtricsAPI::PanelMember
-        end
-
-        it "returns itself" do
-          expect(result).to eq subject
+          expect(result.size).to eq 1
+          expect(result.first).to be_a QualtricsAPI::PanelMember
         end
       end
 
       describe "when failed" do
-        it "raise error and does not change panels" do
-          subject.instance_variable_set :@page, [QualtricsAPI::PanelMember.new({})]
-          expect do
-            VCR.use_cassette("panel_member_collection_fetch_fail") do
-              expect { subject.fetch }.to raise_error
-            end
-          end.not_to change { subject.page }
+        it "raise error" do
+          VCR.use_cassette("panel_member_collection_fetch_fail") do
+            expect { subject.each_page }.to raise_error(QualtricsAPI::BadRequestError)
+          end
         end
       end
     end
@@ -95,24 +82,9 @@ describe QualtricsAPI::PanelMemberCollection do
         let(:panel_members) { [QualtricsAPI::PanelMember.new] }
 
         it "returns results" do
-          expect { result }.to raise_error
+          expect { result }.to raise_error(QualtricsAPI::BadRequestError)
         end
       end
     end
   end
-
-  describe 'equality' do
-    subject { described_class.new(page: [QualtricsAPI::PanelMember.new("recipientID" => "p1"), QualtricsAPI::PanelMember.new("recipientID" => "p1")]) }
-    context 'when same' do
-      it 'returns true' do
-        expect(subject).to eq(described_class.new(page: subject.page))
-      end
-    end
-  
-    context 'when different' do
-      it 'returns false' do
-        expect(subject).not_to eq(described_class.new)
-      end
-    end
-  end
 end

data/spec/lib/survey_collection_spec.rb

@@ -1,10 +1,6 @@
 require 'spec_helper'
 
 describe QualtricsAPI::SurveyCollection do
-  it "has no @page when initialized" do
-    expect(subject.page).to eq []
-  end
-
   describe "integration" do
     subject { described_class.new }
 
@@ -34,87 +30,48 @@ describe QualtricsAPI::SurveyCollection do
     
     describe "#fetch" do
       describe "when success" do
-        before do
-          expect(subject.page.size).to eq 0
-        end
-
         let!(:result) do
           VCR.use_cassette("survey_collection_fetch_sucess") do
-            subject.fetch
+            subject.each_page do |page|
+              return page
+            end
           end
         end
 
         it "populates the collection" do
-          expect(subject.page.size).to eq 1
-          expect(subject.first).to be_a QualtricsAPI::Survey
-        end
-
-        it "returns itself" do
-          expect(result).to eq subject
+          expect(result.size).to eq 1
+          expect(result.first).to be_a QualtricsAPI::Survey
         end
       end
 
       describe "when failed" do
-        it "raises error and does not reset surveys" do
-          subject.instance_variable_set :@page, [QualtricsAPI::Survey.new({})]
-          expect do
-            VCR.use_cassette("survey_collection_fetch_fail") do
-              begin
-                subject.fetch
-              rescue
-                nil
-              end
-            end
-          end.not_to change { subject.page }
+        it "raises error" do
+          VCR.use_cassette("survey_collection_fetch_fail") 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("survey_collection_fetch_sucess") do
-          subject.fetch
-          expect(subject.fetched).to be_truthy
-          expect(subject.page.size).to eq(1)
-          expect(subject.next_page?).to be_truthy
-        end
-      end
-
-      it 'raises error when next_page without fetch' do
-        VCR.use_cassette("survey_collection_fetch_sucess") do
-          expect { expect(subject.next_page) }.to raise_error(QualtricsAPI::NotYetFetchedError)
-        end
-      end
-
-      it 'fetches pages from next page' do
-        VCR.use_cassette("survey_collection_fetch_sucess") do
-          result = subject.fetch.next_page
-          expect(result.fetched).to be_truthy
-          expect(result.page.size).to eq(0)
-          expect(result.next_page?).to be_falsey
-        end
-      end
-    
-      it 'raises error when on last page' do
-        VCR.use_cassette("survey_collection_fetch_sucess") do
-          expect { subject.fetch.next_page.next_page }.to raise_error(QualtricsAPI::NotFoundError)
+          page_no = 0
+          subject.each_page do |page|
+            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
-
-  describe 'equality' do
-    subject { described_class.new(page: [QualtricsAPI::Survey.new("id" => "s1"), QualtricsAPI::Survey.new("id" => "s2")]) }
-    context 'when same' do
-      it 'returns true' do
-        expect(subject).to eq(described_class.new(page: subject.page))
-      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.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Yurui Zhang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday