qualtrics_api 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3bf9143b4c37cceea6b973651341c7d22a51adf
-  data.tar.gz: 435d996160fa0f5eb8b8c6c73e30ee9f60c5d006
+  metadata.gz: a61e69c480b7a2b20a2f64d820d0dee7ef906b30
+  data.tar.gz: 96f38df517d7b6b061f0b110cd44c24f94b83a0f
 SHA512:
-  metadata.gz: 3aa43a3d8216203905e042156a272cccc79dac959c3a690529ffa4d8e1eab61552aab8cc28adbbcf15204c59296623a432e5eb0bc6eae784ec25e21db6f1bc34
-  data.tar.gz: 66d4225b2e86180e52102b3bfba52392b2a3c0c53a036e02a64c47d9bc24b60f9f811d69cac14bb76b83fee342655aa801f2b0bb854a4e82658b7e32ca85d760
+  metadata.gz: 0460ac8586c6f6afcd345a8e7cda73a0e7d8c93fb4f34f12cc0620253aeb07ea18e42109a47ad7f3b2f73e5cdb3a02bcb68cac15042c759d7ab81e2a6f62116f
+  data.tar.gz: 74010e87087b798bf4e80a53a719de558e7b4d707f7ed1aace8fe5da45f341d09f2cc1c70281b85b99fc45f60179a00a26248199e21f54751a2cfca3dbe0b61e

data/lib/qualtrics_api.rb

@@ -9,12 +9,14 @@ require "qualtrics_api/url"
 require "qualtrics_api/request_error_handler"
 
 require "qualtrics_api/configurable"
+require "qualtrics_api/connectable"
 require "qualtrics_api/client"
 
 require "qualtrics_api/extensions/serializable_model"
 require "qualtrics_api/extensions/serializable_collection"
 
 require "qualtrics_api/base_model"
+require "qualtrics_api/base_collection"
 
 require "qualtrics_api/survey"
 require "qualtrics_api/survey_collection"
@@ -31,6 +33,21 @@ require "qualtrics_api/services/response_export_service"
 module QualtricsAPI
   class << self
     include QualtricsAPI::Configurable
-    include QualtricsAPI::Client
+    extend Forwardable
+
+    def_delegator :client, :surveys
+    def_delegator :client, :response_exports
+    def_delegator :client, :panels
+
+    def connection(parent = nil)
+      return parent.connection if parent && parent.connection
+      client.connection
+    end
+
+    private
+
+    def client
+      @client ||= QualtricsAPI::Client.new(QualtricsAPI.api_token)
+    end
   end
 end

data/lib/qualtrics_api/base_collection.rb

@@ -0,0 +1,12 @@
+module QualtricsAPI
+  class BaseCollection
+    extend Forwardable
+    include Enumerable
+    include Virtus.value_object
+    include QualtricsAPI::Extensions::SerializableCollection
+    include QualtricsAPI::Connectable
+
+    def_delegator :all, :each
+    def_delegator :all, :size
+  end
+end

data/lib/qualtrics_api/base_model.rb

@@ -2,8 +2,10 @@ module QualtricsAPI
   class BaseModel
     include Virtus.value_object
     include QualtricsAPI::Extensions::SerializableModel
+    include QualtricsAPI::Connectable
 
     def initialize(options = {})
+      @connection = options[:connection]
       attributes_mappings.each do |key, qualtrics_key|
         instance_variable_set "@#{key}", options[qualtrics_key]
       end
@@ -15,6 +17,5 @@ module QualtricsAPI
     def attributes_mappings
       {}
     end
-
   end
 end

data/lib/qualtrics_api/client.rb

@@ -1,23 +1,28 @@
 module QualtricsAPI
-  module Client
-    include Virtus.value_object
+  class Client
+    include QualtricsAPI::Connectable
+
+    def initialize(api_token)
+      @connection = establish_connection(api_token || fail('Please provide api token!'))
+    end
 
     def surveys(options = {})
       @surveys = nil if @surveys && @surveys.scope_id != options[:scope_id]
-      @surveys ||= QualtricsAPI::SurveyCollection.new(options)
+      @surveys ||= QualtricsAPI::SurveyCollection.new(options).propagate_connection(self)
     end
 
     def response_exports(options = {})
-      @response_exports ||= QualtricsAPI::ResponseExportCollection.new(options)
+      @response_exports ||= QualtricsAPI::ResponseExportCollection.new(options).propagate_connection(self)
     end
 
     def panels(options = {})
-      @panels ||= QualtricsAPI::PanelCollection.new(options)
+      @panels ||= QualtricsAPI::PanelCollection.new(options).propagate_connection(self)
     end
 
-    def connection
-      api_token ||= QualtricsAPI.api_token || fail('Please configure api token!')
-      @conn ||= Faraday.new(url: QualtricsAPI::URL, params: { apiToken: api_token }) do |faraday|
+    private
+
+    def establish_connection(api_token)
+      Faraday.new(url: QualtricsAPI::URL, params: { apiToken: api_token }) do |faraday|
         faraday.request :url_encoded
         faraday.response :json, :content_type => /\bjson$/
 

data/lib/qualtrics_api/connectable.rb

@@ -0,0 +1,10 @@
+module QualtricsAPI
+  module Connectable
+    attr_reader :connection
+  
+    def propagate_connection(connectable)
+      @connection = connectable.connection
+      self
+    end
+  end
+end

data/lib/qualtrics_api/panel.rb

@@ -8,7 +8,7 @@ module QualtricsAPI
     end
 
     def members(options = {})
-      @members ||= QualtricsAPI::PanelMemberCollection.new(options.merge(id: id))
+      @members ||= QualtricsAPI::PanelMemberCollection.new(options.merge(id: id)).propagate_connection(self)
     end
 
     private

data/lib/qualtrics_api/panel_collection.rb

@@ -1,20 +1,12 @@
 module QualtricsAPI
-  class PanelCollection
-    extend Forwardable
-    include Enumerable
-    include Virtus.value_object
-    include QualtricsAPI::Extensions::SerializableCollection
-
+  class PanelCollection < BaseCollection
     values do
       attribute :all, Array, :default => []
     end
 
-    def_delegator :all, :each
-    def_delegator :all, :size
-
     def fetch(_options = {})
       @all = []
-      parse_fetch_response(QualtricsAPI.connection.get('panels'))
+      parse_fetch_response(QualtricsAPI.connection(self).get('panels'))
       self
     end
 
@@ -25,14 +17,14 @@ module QualtricsAPI
     def find(panel_id)
       @all.detect do |panel|
         panel.id == panel_id
-      end || QualtricsAPI::Panel.new("panelId" => panel_id)
+      end || QualtricsAPI::Panel.new("panelId" => panel_id).propagate_connection(self)
     end
 
     private
 
     def parse_fetch_response(response)
       @all = response.body["result"].map do |result|
-        QualtricsAPI::Panel.new(result)
+        QualtricsAPI::Panel.new(result).propagate_connection(self)
       end
     end
   end

data/lib/qualtrics_api/panel_import.rb

@@ -1,14 +1,12 @@
 module QualtricsAPI
-  class PanelImport
-    include Virtus.value_object
-
+  class PanelImport < BaseModel
     values do
       attribute :id, String
       attribute :panel_id, String
     end
 
     def update_status
-      res = QualtricsAPI.connection.get("panels/#{panel_id}/members/panelImports/#{id}").body["result"]
+      res = QualtricsAPI.connection(self).get("panels/#{panel_id}/members/panelImports/#{id}").body["result"]
       @import_progress = res["percentComplete"]
       @completed = true if @import_progress == 100.0
       self

data/lib/qualtrics_api/panel_member_collection.rb

@@ -1,29 +1,22 @@
 module QualtricsAPI
-  class PanelMemberCollection
-    extend Forwardable
-    include Enumerable
-    include Virtus.value_object
-
+  class PanelMemberCollection < BaseCollection
     values do
       attribute :id, String
       attribute :all, Array, :default => []
     end
   
-    def_delegator :all, :each
-    def_delegator :all, :size
-
     def fetch(_options = {})
       @all = []
-      parse_fetch_response(QualtricsAPI.connection.get("panels/#{id}/members"))
+      parse_fetch_response(QualtricsAPI.connection(self).get("panels/#{id}/members"))
       self
     end
 
     def create(panel_members)
-      res = QualtricsAPI.connection
-            .post("panels/#{id}/members", QualtricsAPI.connection.params.merge(panelMembers: panel_members.to_json))
+      res = QualtricsAPI.connection(self)
+            .post("panels/#{id}/members", QualtricsAPI.connection(self).params.merge(panelMembers: panel_members.to_json))
             .body["result"]
       import_id = res['importStatus'].split('/').last
-      QualtricsAPI::PanelImport.new(id: import_id, panel_id: id)
+      QualtricsAPI::PanelImport.new(id: import_id, panel_id: id).propagate_connection(self)
     end
 
     def [](member_id)
@@ -33,14 +26,14 @@ module QualtricsAPI
     def find(member_id)
       @all.detect do |panel_member|
         panel_member.id == member_id
-      end || QualtricsAPI::PanelMember.new(:id => member_id)
+      end || QualtricsAPI::PanelMember.new(:id => member_id).propagate_connection(self)
     end
 
     private
 
     def parse_fetch_response(response)
       @all = response.body["result"].map do |result|
-        QualtricsAPI::PanelMember.new(result)
+        QualtricsAPI::PanelMember.new(result).propagate_connection(self)
       end
     end
   end

data/lib/qualtrics_api/response_export.rb

@@ -1,13 +1,11 @@
 module QualtricsAPI
-  class ResponseExport
-    include Virtus.value_object
-
+  class ResponseExport < BaseModel
     values do
       attribute :id, String
     end
 
     def update_status
-      res = QualtricsAPI.connection.get('surveys/responseExports/' + id).body["result"]
+      res = QualtricsAPI.connection(self).get('surveys/responseExports/' + id).body["result"]
       @export_progress = res["percentComplete"]
       @file_url = res["fileUrl"]
       @completed = true if @export_progress == 100.0

data/lib/qualtrics_api/response_export_collection.rb

@@ -1,16 +1,9 @@
 module QualtricsAPI
-  class ResponseExportCollection
-    extend Forwardable
-    include Enumerable
-    include Virtus.value_object
-
+  class ResponseExportCollection < BaseCollection
     values do
       attribute :all, Array, :default => []
     end
 
-    def_delegator :all, :each
-    def_delegator :all, :size
-
     def [](export_id)
       find(export_id)
     end
@@ -18,7 +11,7 @@ module QualtricsAPI
     def find(export_id)
       @all.detect do |response_export|
         response_export.id == export_id
-      end || QualtricsAPI::ResponseExport.new(:id => export_id)
+      end || QualtricsAPI::ResponseExport.new(:id => export_id).propagate_connection(self)
     end
   end
 end

data/lib/qualtrics_api/services/response_export_service.rb

@@ -1,28 +1,28 @@
 module QualtricsAPI
   module Services
-    class ResponseExportService
-      include Virtus.value_object
-
-      attribute :survey_id, String
-      attribute :response_set_id, String
-      attribute :file_type, String, :default => 'CSV'
-      attribute :last_response_id, String
-      attribute :start_date, String
-      attribute :end_date, String
-      attribute :limit, String
-      attribute :included_question_ids, String
-      attribute :max_rows, String
-      attribute :use_labels, Boolean, :default => false
-      attribute :decimal_format, String, :default => '.'
-      attribute :seen_unanswered_recode, String
-      attribute :use_local_time, Boolean, :default => false
-      attribute :spss_string_length, String
-      attribute :id, String
+    class ResponseExportService < QualtricsAPI::BaseModel
+      values do
+        attribute :survey_id, String
+        attribute :response_set_id, String
+        attribute :file_type, String, :default => 'CSV'
+        attribute :last_response_id, String
+        attribute :start_date, String
+        attribute :end_date, String
+        attribute :limit, String
+        attribute :included_question_ids, String
+        attribute :max_rows, String
+        attribute :use_labels, Boolean, :default => false
+        attribute :decimal_format, String, :default => '.'
+        attribute :seen_unanswered_recode, String
+        attribute :use_local_time, Boolean, :default => false
+        attribute :spss_string_length, String
+        attribute :id, String
+      end
       
       attr_reader :result
 
       def start
-        response = QualtricsAPI.connection.get("surveys/#{survey_id}/responseExports", export_params)
+        response = QualtricsAPI.connection(self).get("surveys/#{survey_id}/responseExports", export_params)
         export_id = response.body["result"]["exportStatus"].split('/').last
         @result = ResponseExport.new(id: export_id)
       end

data/lib/qualtrics_api/survey.rb

@@ -10,7 +10,7 @@ module QualtricsAPI
     end
 
     def export_responses(export_options = {})
-      QualtricsAPI::Services::ResponseExportService.new(export_options.merge(survey_id: id))
+      QualtricsAPI::Services::ResponseExportService.new(export_options.merge(survey_id: id)).propagate_connection(self)
     end
 
     private

data/lib/qualtrics_api/survey_collection.rb

@@ -1,9 +1,5 @@
 module QualtricsAPI
-  class SurveyCollection
-    extend Forwardable
-    include Enumerable
-    include Virtus.value_object
-
+  class SurveyCollection < BaseCollection
     values do
       attribute :scope_id, String
       attribute :all, Array, :default => []
@@ -11,13 +7,10 @@ module QualtricsAPI
 
     attr_writer :scope_id
 
-    def_delegator :all, :each
-    def_delegator :all, :size
-
     def fetch(options = {})
       @all = []
       update_query_attributes(options)
-      parse_fetch_response(QualtricsAPI.connection.get('surveys', query_params))
+      parse_fetch_response(QualtricsAPI.connection(self).get('surveys', query_params))
       self
     end
 
@@ -57,7 +50,7 @@ module QualtricsAPI
 
     def parse_fetch_response(response)
       @all = response.body["result"].map do |result|
-        QualtricsAPI::Survey.new result
+        QualtricsAPI::Survey.new(result).propagate_connection(self)
       end
     end
   end

data/lib/qualtrics_api/version.rb

@@ -1,3 +1,3 @@
 module QualtricsAPI
-  VERSION = "0.0.7"
+  VERSION = "0.0.8".freeze
 end

data/spec/lib/client_spec.rb

@@ -26,4 +26,16 @@ describe QualtricsAPI::Client do
       expect(subject.surveys.object_id).to eq subject.surveys.object_id
     end
   end
+
+  describe "#initialize" do
+    subject { QualtricsAPI::Client }
+
+    it "fails if api_token not provided" do
+      expect { subject.new(nil) }.to raise_error('Please provide api token!')
+    end
+
+    it 'establishes connection when api_token' do
+      subject.new('sample_token')
+    end
+  end
 end

data/spec/lib/survey_spec.rb

@@ -47,7 +47,7 @@ describe QualtricsAPI::Survey do
 
     it "inits a ResponseExportService with options" do
       expect(QualtricsAPI::Services::ResponseExportService).to receive(:new).with(start_date: options[:start_date],
-                                                                                  survey_id: subject.id)
+                                                                                  survey_id: subject.id).and_return(QualtricsAPI::Services::ResponseExportService.new)
 
       subject.export_responses(options)
     end

data/spec/qualtrics_api_spec.rb

@@ -4,8 +4,62 @@ describe QualtricsAPI do
   describe "#new" do
     subject { QualtricsAPI }
 
-    it "initializes a Client with the token passed" do
-      expect(subject).to be_kind_of(QualtricsAPI::Client)
+    it 'two clients have different connection' do
+      client_1 = QualtricsAPI::Client.new('some_id')
+      client_2 = QualtricsAPI::Client.new('other_id')
+      expect(client_1.connection).not_to eq(client_2.connection)
+    end
+
+    it 'reuses connection if globally configured' do
+      expect(QualtricsAPI.connection).to eq(QualtricsAPI.connection)
+    end
+
+    it 'does not reuse connection with client' do
+      client = QualtricsAPI::Client.new('some_id')
+      expect(client.connection).not_to eq(QualtricsAPI.connection)
+    end
+
+    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
+        end
+        expect(members.connection).to eq(QualtricsAPI.connection)
+      end
+
+      context 'with client' 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
+          end
+        end
+
+        it 'has client connection' do
+          expect(client.connection).not_to be_nil
+        end
+
+        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
+            end
+          end
+
+          it 'has propagated exception to members' do
+            expect(members_2.connection).to eq(client_2.connection)
+          end
+
+          it 'does not conflict with different client' do
+            expect(client_2.connection).not_to eq(client.connection)
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qualtrics_api
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Yurui Zhang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -170,9 +170,11 @@ files:
 - fixtures/vcr_cassettes/survey_collection_fetch_sucess.yml
 - fixtures/vcr_cassettes/survey_collection_fetch_with_scopeId_success.yml
 - lib/qualtrics_api.rb
+- lib/qualtrics_api/base_collection.rb
 - lib/qualtrics_api/base_model.rb
 - lib/qualtrics_api/client.rb
 - lib/qualtrics_api/configurable.rb
+- lib/qualtrics_api/connectable.rb
 - lib/qualtrics_api/extensions/serializable_collection.rb
 - lib/qualtrics_api/extensions/serializable_model.rb
 - lib/qualtrics_api/panel.rb