qualtrics_api 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f8c86f14151c132a64f4c8aff0873fa87ca6793
-  data.tar.gz: cc34a47d547633e0bea66b2b3791ad46818fb01d
+  metadata.gz: 1f836176e18af2d85f18fba39a7af32952e185a2
+  data.tar.gz: 24a7800f963644225c332126d6df9c85dae67ea0
 SHA512:
-  metadata.gz: 77d7d06a3bcfc5e8d9806ff0a19c7ca28006bdb8d3311360f3fdd550a1786a0d0dd18092e26016460216661e416515ad07e134f2687d6e8a6bc38f1c40e75ba7
-  data.tar.gz: 696d86de618b275d3da4e53fdaf65f80c3228b8f590a469f21e1f38d202d10333dd5c01d95a52fd76c9d11125414d2c74bb89874b02e79bf42d7eea2405c9fac
+  metadata.gz: 01df3b46bf2cbe27349920312e2b54efb0c64a0ecf7d004c57acc35ee3d7ad10f90652c81018f6e8ca210121ae8a7b810815a8f5e0ec38fc40e37e3028eded95
+  data.tar.gz: 68edbed27d3c5c3f6b66fb2d760e7dc5f6d47dc22136d882ae9e2de47aa16d23d79d61af07167fc923279cda246a18251e3f197c9c1c3b5e09e218ab843f7550

data/README.md

@@ -5,7 +5,7 @@
 # QualtricsAPI
 
 Ruby wrapper for Qualtrics REST ControlPanel API version 3.0.
-[API Documents/Play Ground](https://co1.qualtrics.com/APIDocs/)
+[API Documents/Play Ground](https://api.qualtrics.com/)
 
 ## Installation
 
@@ -35,14 +35,20 @@ end
 
 ### Surveys
 
-To get all your surveys:
+To paginate all your surveys:
 
 ```ruby
-QualtricsAPI.surveys.fetch
+surveys = QualtricsAPI.surveys.fetch
 # => #<QualtricsAPI::SurveyCollection:0x007fcb72cce350 ....>
+
+surveys = surveys.next_page # to fetch next page if not on the last page
+# => #<QualtricsAPI::SurveyCollection:0x007fcb72cce350 ....>
+
+surveys.next_page?
+# => true
 ```
 
-After you have received results, you can search for a survey by id:
+You can search for a survey by id:
 
 ```ruby
 survey = QualtricsAPI.surveys.find("surveyIdHere")
@@ -131,14 +137,17 @@ export.status
 
 ### Panels
 
-To get all the panels:
+To paginate all the panels:
 
 ```ruby
-QualtricsAPI.panels.fetch
+panels = QualtricsAPI.panels.fetch
+# => #<QualtricsAPI::PanelCollection:0x007f8769aae2c0 ....>
+
+panels = panels.next_page # get next page if panels.next_page?
 # => #<QualtricsAPI::PanelCollection:0x007f8769aae2c0 ....>
 ```
 
-After you have received results, you can search for a panel by id:
+You can search for a panel by id:
 
 ```ruby
 panel = QualtricsAPI.panels.find("panelIdHere")
@@ -157,7 +166,7 @@ panel = QualtricsAPI.panels["panelIdHere"]
 To add panel members to a panel:
 
 ```ruby
-panel = QualtricsAPI.panels.fetch["panelIdHere"]
+panel = QualtricsAPI.panels.find("panelIdHere")
 members = [QualtricsAPI::PanelMember.new(first_name: 'John', last_name: 'Doe', email: 'test@test.com')]
 panel.members.create(members)
 => #<QualtricsAPI::PanelImport:0x007fb7db984668 ...>

data/fixtures/vcr_cassettes/panel_collection_fetch_success.yml

@@ -32,4 +32,36 @@ http_interactions:
         - OK"}}'
     http_version: 
   recorded_at: Mon, 11 Apr 2016 13:26:52 GMT
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/mailinglists
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 2aYeWieRoRq1cOapLnTKZuHuQc8FMq7zZvSGps0v
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      content-type:
+      - application/json; charset=utf-8
+      request-time:
+      - '742'
+      content-length:
+      - '1329'
+      date:
+      - Mon, 11 Apr 2016 13:26:52 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":{"elements":[{"panelId":"AB_abcdefghijk","name":"Master Panel","libraryId":"GR_abcdefghijk","category":"Unassigned"}],"nextPage":"https://co1.qualtrics.com/API/v3/mailinglists?offset=20"},"meta":{"httpStatus":"200
+        - OK"}}'
+    http_version: 
+  recorded_at: Mon, 11 Apr 2016 13:26:52 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/panel_find.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/mailinglists/ML_00c5BS2WNUCWQIt
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      content-type:
+      - application/json; charset=utf-8
+      request-time:
+      - '216'
+      content-length:
+      - '164'
+      date:
+      - Wed, 13 Apr 2016 13:15:28 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":{"id":"ML_00c5BS2WNUCWQIt","libraryId":"UR_5dURLpfp5tm43EV","name":"Panel name","category":"Unassigned"},"meta":{"httpStatus":"200 -
+        OK"}}'
+    http_version: 
+  recorded_at: Wed, 13 Apr 2016 13:15:28 GMT
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/mailinglists/ML_00c5BS2WNUCWQI0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 400
+      message: 
+    headers:
+      content-type:
+      - application/json
+      content-length:
+      - '145'
+      date:
+      - Wed, 13 Apr 2016 13:15:35 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"meta":{"httpStatus":"400 - Bad Request","error":{"errorMessage":"Invalid
+        mailingListId parameter. Mailing list not found","errorCode":"GP_0"}}}'
+    http_version: 
+  recorded_at: Wed, 13 Apr 2016 13:15:35 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/panel_member_collection_create_fail.yml

@@ -2,7 +2,39 @@
 http_interactions:
 - request:
     method: get
-    uri: https://co1.qualtrics.com/API/v3/mailinglists
+    uri: https://co1.qualtrics.com/API/v3/mailinglists/ML_0APx3C4rmHER6w5
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      content-type:
+      - application/json; charset=utf-8
+      request-time:
+      - '216'
+      content-length:
+      - '164'
+      date:
+      - Wed, 13 Apr 2016 13:15:28 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":{"id":"ML_0APx3C4rmHER6w5","libraryId":"UR_5dURLpfp5tm43EV","name":"Panel name","category":"Unassigned"},"meta":{"httpStatus":"200 -
+        OK"}}'
+    http_version: 
+  recorded_at: Wed, 13 Apr 2016 13:15:28 GMT
+- request:
+    method: post
+    uri: https://co1.qualtrics.com/API/v3/mailinglists/ML_0APx3C4rmHER6w5/contactimports
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/vcr_cassettes/panel_member_collection_create_success.yml

@@ -32,6 +32,38 @@ http_interactions:
         - OK"}}'
     http_version: 
   recorded_at: Tue, 12 Apr 2016 21:35:39 GMT
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/mailinglists/ML_0APx3C4rmHER6w5
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      content-type:
+      - application/json; charset=utf-8
+      request-time:
+      - '216'
+      content-length:
+      - '164'
+      date:
+      - Wed, 13 Apr 2016 13:15:28 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":{"id":"ML_0APx3C4rmHER6w5","libraryId":"UR_5dURLpfp5tm43EV","name":"Panel name","category":"Unassigned"},"meta":{"httpStatus":"200 -
+        OK"}}'
+    http_version: 
+  recorded_at: Wed, 13 Apr 2016 13:15:28 GMT
 - request:
     method: post
     uri: https://co1.qualtrics.com/API/v3/mailinglists/ML_0APx3C4rmHER6w5/contactimports
@@ -70,4 +102,36 @@ http_interactions:
         OK"}}'
     http_version: 
   recorded_at: Tue, 12 Apr 2016 21:35:40 GMT
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/mailinglists/ML_bC2c5xBz1DxyOYB
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      content-type:
+      - application/json; charset=utf-8
+      request-time:
+      - '216'
+      content-length:
+      - '164'
+      date:
+      - Wed, 13 Apr 2016 13:15:28 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":{"id":"ML_bC2c5xBz1DxyOYB","libraryId":"UR_5dURLpfp5tm43EV","name":"Panel name","category":"Unassigned"},"meta":{"httpStatus":"200 -
+        OK"}}'
+    http_version: 
+  recorded_at: Wed, 13 Apr 2016 13:15:28 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/response_export_start_success.yml

@@ -34,4 +34,36 @@ http_interactions:
         - OK"}}'
     http_version: 
   recorded_at: Tue, 12 Apr 2016 10:08:29 GMT
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/surveys/SV_bpCTGQvjOqgd4RD
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      content-type:
+      - application/json; charset=utf-8
+      request-time:
+      - '642'
+      content-length:
+      - '1339'
+      date:
+      - Wed, 13 Apr 2016 13:04:14 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":{"id":"SV_bpCTGQvjOqgd4RD","name":"test","ownerId":"owner_id","organizationId":"organizationid","isActive":true,"creationDate":"2016-04-01T09:12:05Z","lastModifiedDate":"2016-04-06T15:04:28Z","expiration":{"startDate":null,"endDate":null},"questions":{},"exportColumnMap":{},"blocks":{},"flow":[],"embeddedData":[],"responseCounts":{"auditable":0,"generated":2,"deleted":2}},"meta":{"httpStatus":"200
+        - OK"}}'
+    http_version: 
+  recorded_at: Wed, 13 Apr 2016 13:04:14 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/survey_collection_fetch_sucess.yml

@@ -32,4 +32,36 @@ http_interactions:
         - OK"}}'
     http_version: 
   recorded_at: Mon, 11 Apr 2016 13:04:55 GMT
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/surveys?offset=10
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      content-type:
+      - application/json; charset=utf-8
+      request-time:
+      - '573'
+      content-length:
+      - '1737'
+      date:
+      - Mon, 11 Apr 2016 13:04:55 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":{"elements":[],"nextPage":null},"meta":{"httpStatus":"200
+        - OK"}}'
+    http_version: 
+  recorded_at: Mon, 11 Apr 2016 13:04:55 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/survey_find.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/surveys/SV_0fEV92PdRg8a2e9
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - 6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      content-type:
+      - application/json; charset=utf-8
+      request-time:
+      - '642'
+      content-length:
+      - '1339'
+      date:
+      - Wed, 13 Apr 2016 13:04:14 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":{"id":"SV_0fEV92PdRg8a2e9","name":"test","ownerId":"owner_id","organizationId":"organizationid","isActive":true,"creationDate":"2016-04-01T09:12:05Z","lastModifiedDate":"2016-04-06T15:04:28Z","expiration":{"startDate":null,"endDate":null},"questions":{},"exportColumnMap":{},"blocks":{},"flow":[],"embeddedData":[],"responseCounts":{"auditable":0,"generated":2,"deleted":2}},"meta":{"httpStatus":"200
+        - OK"}}'
+    http_version: 
+  recorded_at: Wed, 13 Apr 2016 13:04:14 GMT
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/surveys/SV_0fEV92PdRg8a2e0
+    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:
+      - '106'
+      date:
+      - Wed, 13 Apr 2016 13:04:18 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"meta":{"httpStatus":"404 - Not Found","error":{"errorMessage":"Survey
+        not found.","errorCode":"GSI_2"}}}'
+    http_version: 
+  recorded_at: Wed, 13 Apr 2016 13:04:19 GMT
+recorded_with: VCR 2.9.3

data/lib/qualtrics_api/base_collection.rb

@@ -6,7 +6,45 @@ module QualtricsAPI
     include QualtricsAPI::Extensions::SerializableCollection
     include QualtricsAPI::Connectable
 
-    def_delegator :all, :each
-    def_delegator :all, :size
+    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
+    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))
+      end
+    end
+
+    def find(id)
+      response = QualtricsAPI.connection(self).get(endpoint(id))
+      return nil unless response.status == 200
+      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|
+        build_result(element).propagate_connection(self)
+      end
+      @next_endpoint = response.body["result"]["nextPage"]
+      @fetched = true
+    end
   end
 end

data/lib/qualtrics_api/client.rb

@@ -7,15 +7,15 @@ module QualtricsAPI
     end
 
     def surveys(options = {})
-      @surveys ||= QualtricsAPI::SurveyCollection.new(options).propagate_connection(self)
+      QualtricsAPI::SurveyCollection.new(options).propagate_connection(self)
     end
 
     def response_exports(options = {})
-      @response_exports ||= QualtricsAPI::ResponseExportCollection.new(options).propagate_connection(self)
+      QualtricsAPI::ResponseExportCollection.new(options).propagate_connection(self)
     end
 
     def panels(options = {})
-      @panels ||= QualtricsAPI::PanelCollection.new(options).propagate_connection(self)
+      QualtricsAPI::PanelCollection.new(options).propagate_connection(self)
     end
 
     private

data/lib/qualtrics_api/panel_collection.rb

@@ -1,31 +1,21 @@
 module QualtricsAPI
   class PanelCollection < BaseCollection
-    values do
-      attribute :all, Array, :default => []
-    end
-
-    def fetch()
-      @all = []
-      parse_fetch_response(QualtricsAPI.connection(self).get('mailinglists'))
-      self
-    end
-
     def [](panel_id)
       find(panel_id)
     end
 
-    def find(panel_id)
-      @all.detect do |panel|
-        panel.id == panel_id
-      end || QualtricsAPI::Panel.new("panelId" => panel_id).propagate_connection(self)
+    private
+  
+    def build_result(element)
+      QualtricsAPI::Panel.new(element)
     end
 
-    private
+    def list_endpoint
+      'mailinglists'
+    end
 
-    def parse_fetch_response(response)
-      @all = response.body["result"]["elements"].map do |elements|
-        QualtricsAPI::Panel.new(elements).propagate_connection(self)
-      end
+    def endpoint(id)
+      "mailinglists/#{id}"
     end
   end
 end

data/lib/qualtrics_api/panel_member_collection.rb

@@ -2,15 +2,8 @@ module QualtricsAPI
   class PanelMemberCollection < BaseCollection
     values do
       attribute :id, String
-      attribute :all, Array, :default => []
     end
   
-    def fetch(_options = {})
-      @all = []
-      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')
@@ -22,22 +15,26 @@ module QualtricsAPI
       QualtricsAPI::PanelImport.new(id: import_id, panel_id: id).propagate_connection(self)
     end
 
+    def find(id)
+      raise QualtricsAPI::NotSupported, 'Find not supported for panel member'
+    end
+
     def [](member_id)
       find(member_id)
     end
-    
-    def find(member_id)
-      @all.detect do |panel_member|
-        panel_member.id == member_id
-      end || QualtricsAPI::PanelMember.new(:id => member_id).propagate_connection(self)
-    end
 
     private
+  
+    def build_result(element)
+      QualtricsAPI::PanelMember.new(element)
+    end
+
+    def list_endpoint
+      "mailinglists/#{id}/contacts"
+    end
 
-    def parse_fetch_response(response)
-      @all = response.body["result"]["elements"].map do |element|
-        QualtricsAPI::PanelMember.new(element).propagate_connection(self)
-      end
+    def endpoint(member_id)
+      "mailinglists/#{id}/contacts/#{member_id}"
     end
   end
 end

data/lib/qualtrics_api/request_error_handler.rb

@@ -26,8 +26,10 @@ module QualtricsAPI
     end
   end
 
+  class NotYetFetchedError < StandardError; end
   class NotFoundError < StandardError; end
   class BadRequestError < StandardError; end
   class UnauthorizedError < StandardError; end
   class InternalServerError < StandardError; end
+  class NotSupported < StandardError; end
 end

data/lib/qualtrics_api/response_export_collection.rb

@@ -1,17 +1,14 @@
 module QualtricsAPI
-  class ResponseExportCollection < BaseCollection
-    values do
-      attribute :all, Array, :default => []
-    end
+  class ResponseExportCollection
+    include Virtus.value_object
+    include QualtricsAPI::Connectable
 
     def [](export_id)
       find(export_id)
     end
     
     def find(export_id)
-      @all.detect do |response_export|
-        response_export.id == export_id
-      end || QualtricsAPI::ResponseExport.new(:id => export_id).propagate_connection(self)
+      QualtricsAPI::ResponseExport.new(:id => export_id).propagate_connection(self)
     end
   end
 end

data/lib/qualtrics_api/survey_collection.rb

@@ -1,31 +1,21 @@
 module QualtricsAPI
   class SurveyCollection < BaseCollection
-    values do
-      attribute :all, Array, :default => []
-    end
-
-    def fetch
-      @all = []
-      parse_fetch_response(QualtricsAPI.connection(self).get('surveys'))
-      self
-    end
-
     def [](survey_id)
       find(survey_id)
     end
 
-    def find(survey_id)
-      @all.detect do |survey|
-        survey.id == survey_id
-      end || QualtricsAPI::Survey.new("id" => survey_id)
+    private
+
+    def build_result(element)
+      QualtricsAPI::Survey.new(element)
     end
 
-    private
+    def list_endpoint
+      'surveys'
+    end
 
-    def parse_fetch_response(response)
-      @all = response.body["result"]['elements'].map do |elements|
-        QualtricsAPI::Survey.new(elements).propagate_connection(self)
-      end
+    def endpoint(id)
+      "surveys/#{id}"
     end
   end
 end

data/lib/qualtrics_api/version.rb

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

data/qualtrics_api.gemspec

@@ -30,6 +30,4 @@ Gem::Specification.new do |spec|
   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"
 end

data/spec/lib/client_spec.rb

@@ -7,20 +7,12 @@ describe QualtricsAPI::Client do
     it "returns a ResponseExportCollection" do
       expect(subject.response_exports).to be_a QualtricsAPI::ResponseExportCollection
     end
-
-    it "caches the collection" do
-      expect(subject.response_exports.object_id).to eq subject.response_exports.object_id
-    end
   end
 
   describe "#surveys" do
     it "returns a SurveyCollection" do
       expect(subject.surveys).to be_a QualtricsAPI::SurveyCollection
     end
-
-    it "caches the surveys" do
-      expect(subject.surveys.object_id).to eq subject.surveys.object_id
-    end
   end
 
   describe "#initialize" do

data/spec/lib/panel_collection_spec.rb

@@ -1,32 +1,38 @@
 require 'spec_helper'
 
 describe QualtricsAPI::PanelCollection do
-  it "has no @all when initialized" do
-    expect(subject.all).to eq []
+  it "has no @page when initialized" do
+    expect(subject.page).to eq []
   end
 
-  describe "#find, #[]" do
-    let(:panel_1) { QualtricsAPI::Panel.new "panelId" => "p1" }
-    let(:panel_2) { QualtricsAPI::Panel.new "panelId" => "p2" }
-
-    it "finds the panel by id" do
-      subject.instance_variable_set :@all, [panel_1, panel_2]
-      expect(subject.find("p1")).to eq panel_1
-      expect(subject["p2"]).to eq panel_2
-    end
+  describe "integration" do
+    describe "#find" do
+      let(:result) do
+        VCR.use_cassette("panel_find") do
+          subject.find(panel_id)
+        end
+      end
 
-    it "returns a new panel with the id" do
-      new_panel = subject["p3"]
-      expect(new_panel).to be_a QualtricsAPI::Panel
-      expect(new_panel.id).to eq "p3"
+      context 'when exists' do
+        let(:panel_id) { 'ML_00c5BS2WNUCWQIt' } 
+      
+        it 'populates the result' do
+          expect(result.attributes).to eq(:id => "ML_00c5BS2WNUCWQIt", :library_id => "UR_5dURLpfp5tm43EV", :name => "Panel name", :category => "Unassigned")
+        end
+      end
+    
+      context 'when does not exists' do
+        let(:panel_id) { 'ML_00c5BS2WNUCWQI0' } 
+      
+        it 'raises bad request error' do
+          expect { result }.to raise_error(QualtricsAPI::BadRequestError)
+        end
+      end
     end
-  end
-
-  describe "integration" do
     describe "#fetch" do
       describe "when success" do
         before do
-          expect(subject.size).to eq 0
+          expect(subject.page.size).to eq 0
         end
 
         let!(:result) do
@@ -36,7 +42,7 @@ describe QualtricsAPI::PanelCollection do
         end
 
         it "populates the collection" do
-          expect(subject.size).to eq 1
+          expect(subject.page.size).to eq 1
           expect(subject.first).to be_a QualtricsAPI::Panel
         end
 
@@ -46,23 +52,27 @@ describe QualtricsAPI::PanelCollection do
       end
 
       describe "when failed" do
-        it "resets panels" do
-          subject.instance_variable_set :@all, [QualtricsAPI::Panel.new({})]
-          expect {
+        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
-              subject.fetch rescue nil
+              begin
+                subject.fetch
+              rescue
+                nil
+              end
             end
-          }.to change { subject.all }.to([])
+          end.not_to change { subject.page }
         end
       end
     end
   end
 
   describe 'equality' do
-    subject { described_class.new(all: [QualtricsAPI::Panel.new("panelId" => "p1"), QualtricsAPI::Panel.new("panelId" => "p2")]) }
+    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(all: subject.all))
+        expect(subject).to eq(described_class.new(page: subject.page))
       end
     end
   

data/spec/lib/panel_member_collection_spec.rb

@@ -1,34 +1,41 @@
 require 'spec_helper'
 
 describe QualtricsAPI::PanelMemberCollection do
-  it "has no @all when initialized" do
-    expect(subject.all).to eq []
+  it "has no @page when initialized" do
+    expect(subject.page).to eq []
   end
 
-  describe "#find, #[]" do
-    let(:panel_member_1) { QualtricsAPI::PanelMember.new("panelMemberId" => "p1") }
-    let(:panel_member_2) { QualtricsAPI::PanelMember.new("panelMemberId" => "p2") }
+  describe "integration" do
+    subject { described_class.new(id: 'ABCD') }
 
-    it "finds the panel member by id" do
-      subject.instance_variable_set :@all, [panel_member_1, panel_member_2]
-      expect(subject.find("p1")).to eq panel_member_1
-      expect(subject["p2"]).to eq panel_member_2
-    end
+    describe "#find" do
+      let(:result) do
+        VCR.use_cassette("survey_find") do
+          subject.find(survey_id)
+        end
+      end
 
-    it "returns a new panel with the id" do
-      new_panel_member = subject["p3"]
-      expect(new_panel_member).to be_a QualtricsAPI::PanelMember
-      expect(new_panel_member.id).to eq "p3"
+      context 'when exists' do
+        let(:survey_id) { 'SV_0fEV92PdRg8a2e9' } 
+      
+        it 'raises error' do
+          expect { result }.to raise_error(QualtricsAPI::NotSupported, 'Find not supported for panel member')
+        end
+      end
+    
+      context 'when does not exists' do
+        let(:survey_id) { 'SV_0fEV92PdRg8a2e0' } 
+      
+        it 'raises error' do
+          expect { result }.to raise_error(QualtricsAPI::NotSupported, 'Find not supported for panel member')
+        end
+      end
     end
-  end
-
-  describe "integration" do
-    subject { described_class.new(id: 'ABCD') }
 
     describe "#fetch" do
       describe "when success" do
         before do
-          expect(subject.size).to eq 0
+          expect(subject.page.size).to eq 0
         end
 
         let!(:result) do
@@ -38,7 +45,7 @@ describe QualtricsAPI::PanelMemberCollection do
         end
 
         it "populates the collection" do
-          expect(subject.size).to eq 1
+          expect(subject.page.size).to eq 1
           expect(subject.first).to be_a QualtricsAPI::PanelMember
         end
 
@@ -48,13 +55,13 @@ describe QualtricsAPI::PanelMemberCollection do
       end
 
       describe "when failed" do
-        it "resets panels" do
-          subject.instance_variable_set :@all, [QualtricsAPI::PanelMember.new({})]
+        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.to change { subject.all }.to([])
+          end.not_to change { subject.page }
         end
       end
     end
@@ -62,7 +69,7 @@ describe QualtricsAPI::PanelMemberCollection do
     describe "#create" do
       let(:result) do
         VCR.use_cassette(cassette, record: :once) do
-          QualtricsAPI.panels.fetch['ML_0APx3C4rmHER6w5'].members.create(panel_members)
+          QualtricsAPI.panels.find('ML_0APx3C4rmHER6w5').members.create(panel_members)
         end
       end
 
@@ -95,10 +102,10 @@ describe QualtricsAPI::PanelMemberCollection do
   end
 
   describe 'equality' do
-    subject { described_class.new(all: [QualtricsAPI::PanelMember.new("recipientID" => "p1"), QualtricsAPI::PanelMember.new("recipientID" => "p1")]) }
+    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(all: subject.all))
+        expect(subject).to eq(described_class.new(page: subject.page))
       end
     end
   

data/spec/lib/response_export_collection_spec.rb

@@ -1,16 +1,12 @@
 require 'spec_helper'
 
 describe QualtricsAPI::ResponseExportCollection do
-  it "has no @all when initialized" do
-    expect(subject.all).to eq []
-  end
-
   describe "#find, #[]" do
     let(:export_1) { QualtricsAPI::ResponseExport.new(:id => "export1") }
     let(:export_2) { QualtricsAPI::ResponseExport.new(:id => "export2") }
 
     it "finds the export by id" do
-      subject.instance_variable_set :@all, [export_1, export_2]
+      subject.instance_variable_set :@page, [export_1, export_2]
       expect(subject.find("export1")).to eq export_1
       expect(subject["export2"]).to eq export_2
     end
@@ -21,19 +17,4 @@ describe QualtricsAPI::ResponseExportCollection do
       expect(sut.id).to eq "eee 3"
     end
   end
-
-  describe 'equality' do
-    subject { described_class.new(all: [QualtricsAPI::ResponseExport.new(:id => "export1"), QualtricsAPI::ResponseExport.new(:id => "export2")]) }
-    context 'when same' do
-      it 'returns true' do
-        expect(subject).to eq(described_class.new(all: subject.all))
-      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,34 +1,41 @@
 require 'spec_helper'
 
 describe QualtricsAPI::SurveyCollection do
-  it "has no @all when initialized" do
-    expect(subject.all).to eq []
-  end
-
-  describe "#find, #[]" do
-    let(:survey_1) { QualtricsAPI::Survey.new "id" => "s1" }
-    let(:survey_2) { QualtricsAPI::Survey.new "id" => "s2" }
-
-    it "finds the survey by id" do
-      subject.instance_variable_set :@all, [survey_1, survey_2]
-      expect(subject.find("s1")).to eq survey_1
-      expect(subject["s2"]).to eq survey_2
-    end
-
-    it "returns a new survey with the id" do
-      sut = subject["s3"]
-      expect(sut).to be_a QualtricsAPI::Survey
-      expect(sut.id).to eq "s3"
-    end
+  it "has no @page when initialized" do
+    expect(subject.page).to eq []
   end
 
   describe "integration" do
     subject { described_class.new }
 
+    describe "#find" do
+      let(:result) do
+        VCR.use_cassette("survey_find") do
+          subject.find(survey_id)
+        end
+      end
+
+      context 'when exists' do
+        let(:survey_id) { 'SV_0fEV92PdRg8a2e9' } 
+      
+        it 'populates the result' do
+          expect(result.attributes).to eq(:id => "SV_0fEV92PdRg8a2e9", :name => "test", :owner_id => "owner_id", :last_modified => nil, :is_active => true)
+        end
+      end
+    
+      context 'when does not exists' do
+        let(:survey_id) { 'SV_0fEV92PdRg8a2e0' } 
+      
+        it 'populates the result' do
+          expect { result }.to raise_error(QualtricsAPI::NotFoundError)
+        end
+      end
+    end
+    
     describe "#fetch" do
       describe "when success" do
         before do
-          expect(subject.size).to eq 0
+          expect(subject.page.size).to eq 0
         end
 
         let!(:result) do
@@ -38,7 +45,7 @@ describe QualtricsAPI::SurveyCollection do
         end
 
         it "populates the collection" do
-          expect(subject.size).to eq 1
+          expect(subject.page.size).to eq 1
           expect(subject.first).to be_a QualtricsAPI::Survey
         end
 
@@ -48,23 +55,59 @@ describe QualtricsAPI::SurveyCollection do
       end
 
       describe "when failed" do
-        it "resets surveys" do
-          subject.instance_variable_set :@all, [QualtricsAPI::Survey.new({})]
-          expect {
+        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
-              subject.fetch rescue nil
+              begin
+                subject.fetch
+              rescue
+                nil
+              end
             end
-          }.to change { subject.all }.to([])
+          end.not_to change { subject.page }
+        end
+      end
+    end
+  
+    describe 'pagination' do
+      it 'fetches pages from list endpoint' do
+        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)
         end
       end
     end
   end
 
   describe 'equality' do
-    subject { described_class.new(all: [QualtricsAPI::Survey.new("id" => "s1"), QualtricsAPI::Survey.new("id" => "s2")]) }
+    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(all: subject.all))
+        expect(subject).to eq(described_class.new(page: subject.page))
       end
     end
   

data/spec/qualtrics_api_spec.rb

@@ -22,7 +22,7 @@ describe QualtricsAPI do
     context 'chains' do
       it 'does propagate default connection' do
         members = VCR.use_cassette('panel_member_collection_create_success') do
-          QualtricsAPI.panels.fetch['ML_bC2c5xBz1DxyOYB'].members
+          QualtricsAPI.panels.find('ML_bC2c5xBz1DxyOYB').members
         end
         expect(members.connection).to eq(QualtricsAPI.connection)
       end
@@ -31,7 +31,7 @@ describe QualtricsAPI do
         let(:client) { QualtricsAPI::Client.new(TEST_API_TOKEN) }
         let(:members) do
           VCR.use_cassette('panel_member_collection_create_success') do
-            client.panels.fetch['ML_bC2c5xBz1DxyOYB'].members
+            client.panels.find('ML_bC2c5xBz1DxyOYB').members
           end
         end
 
@@ -42,12 +42,12 @@ describe QualtricsAPI do
         it 'has propagated exception to members' do
           expect(members.connection).to eq(client.connection)
         end
-      
+
         context 'with different client' do
           let(:client_2) { QualtricsAPI::Client.new(TEST_API_TOKEN) }
           let(:members_2) do
             VCR.use_cassette('panel_member_collection_create_success') do
-              client_2.panels.fetch['ML_bC2c5xBz1DxyOYB'].members
+              client_2.panels.find('ML_bC2c5xBz1DxyOYB').members
             end
           end
 

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require 'qualtrics_api'
-require 'pry'
 require 'vcr'
 
 TEST_API_TOKEN = "6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ".freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qualtrics_api
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Yurui Zhang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -110,34 +110,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.5'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.1
 description: |-
   A Ruby wrapper for Qualtrics REST API version 3.0.
                             See https://co1.qualtrics.com/APIDocs/ for API documents.
@@ -159,6 +131,7 @@ files:
 - Rakefile
 - fixtures/vcr_cassettes/panel_collection_fetch_fail.yml
 - fixtures/vcr_cassettes/panel_collection_fetch_success.yml
+- fixtures/vcr_cassettes/panel_find.yml
 - fixtures/vcr_cassettes/panel_import_update_success.yml
 - fixtures/vcr_cassettes/panel_member_collection_create_fail.yml
 - fixtures/vcr_cassettes/panel_member_collection_create_success.yml
@@ -168,6 +141,7 @@ files:
 - fixtures/vcr_cassettes/response_export_update_success.yml
 - fixtures/vcr_cassettes/survey_collection_fetch_fail.yml
 - fixtures/vcr_cassettes/survey_collection_fetch_sucess.yml
+- fixtures/vcr_cassettes/survey_find.yml
 - lib/qualtrics_api.rb
 - lib/qualtrics_api/base_collection.rb
 - lib/qualtrics_api/base_model.rb