qualtrics_api 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a8c584341554937f9191c5092906ecd8132a4e5a35c4bb9b8cfbfb28dda9e1
-  data.tar.gz: fcba2ec7a04c59497951c88bed64ce65655c3a9f4c799b5d0073b16d38f44c83
+  metadata.gz: 614308b0a73ec2d9a904703243f2b7ca0828936113122eb8a104aeff1b34e7be
+  data.tar.gz: dd67d5dc10dc3669679f51a368810161f21fe44516e5a0c796da8b56099bfda8
 SHA512:
-  metadata.gz: bdc4178b2d5c9b5117deaa74c61ee7c93e250f30953fa3c62370f77cc812707b0c06894251bc13012d6451d6e4048efb835a987ddd2922261252df52bfbac26d
-  data.tar.gz: f3cc2c6064c1a2ed083910e7cb87237dd2ef7081d7663991f2d71bc0b1229634c3c60799d22cf57ceead3622d2a84e93d91e6043e35f8e4943e0d5827e64557b
+  metadata.gz: d900c025250a3ff9104ceedb881ebeeff156b43f58b4b898ea3fee86941752f1c59a3f86ee7439a29b39d1efd604f80de557d8d64cf5765127713c9a01cd2698
+  data.tar.gz: 0700d5570105ea93a3ceb7e4c65be6f637a8d239da9d3779929886dbead496ce04a75c872a01c5a5ade6cf1b6d17972c841182e79c448cab65e5aca96bbec848

data/README.md

@@ -197,19 +197,20 @@ panel = QualtricsAPI.panels["panelIdHere"]
 
 #### Panel Members
 
-To add panel members to a panel:
+To import a batch of panel members:
 
 ```ruby
 panel = QualtricsAPI.panels.find("panelIdHere")
 members = [QualtricsAPI::PanelMember.new(first_name: 'John', last_name: 'Doe', email: 'test@test.com')]
-panel.members.create(members)
+panel.import_members(members)
 => #<QualtricsAPI::PanelImport:0x007fb7db984668 ...>
 ```
 
-and update athe status of panel import:
+A `PanelImport` record is returned, you can use it to check the status of panel import:
+
 ```ruby
 members = [QualtricsAPI::PanelMember.new(first_name: 'John', last_name: 'Doe', email: 'test@test.com')]
-panel_import = panel.members.create(members)
+panel_import = panel.members.import_members(members)
 => #<QualtricsAPI::PanelImport:0x007fb7db984668 ...>
 panel_import.status
 => "99.99999%"
@@ -218,6 +219,16 @@ panel_import.status
 => "100.0%"
 ```
 
+To add a single panel member to a panel:
+
+```ruby
+panel = QualtricsAPI.panels.find("panelIdHere")
+member = QualtricsAPI::PanelMember.new(first_name: 'John', last_name: 'Doe', email: 'test@test.com')
+panel.create(member)
+```
+
+A new `PanelMember` record is returned on success; this will give you the ID of the newly created member.
+
 ## Contributing
 
 1. Fork it ( https://github.com/pallymore/qualtrics_api/fork )

data/fixtures/vcr_cassettes/panel_member_single_create_failure.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/mailinglists/ML_ez0Gj1S4SX4TZjv
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - xxx
+      User-Agent:
+      - Faraday v0.13.1
+  response:
+    status:
+      code: 404
+      message: 
+    headers:
+      content-type:
+      - application/json
+      content-length:
+      - '129'
+      x-edgeconnect-midmile-rtt:
+      - '12'
+      x-edgeconnect-origin-mex-latency:
+      - '195'
+      date:
+      - Mon, 08 Jan 2018 16:57:07 GMT
+      connection:
+      - close
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+    body:
+      encoding: UTF-8
+      string: '{"meta":{"httpStatus":"404 - Not Found","error":{"errorMessage":"Mailing
+        List not found","errorCode":"PACC_6"},"requestId":null}}'
+    http_version: 
+  recorded_at: Mon, 08 Jan 2018 16:57:07 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/panel_member_single_create_success.yml

@@ -0,0 +1,82 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v3/mailinglists/ML_ez0Gj1S4SX4TZjv
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-API-TOKEN:
+      - xxx
+      User-Agent:
+      - Faraday v0.13.1
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      request-time:
+      - '429'
+      content-type:
+      - application/json
+      content-length:
+      - '228'
+      x-edgeconnect-midmile-rtt:
+      - '14'
+      x-edgeconnect-origin-mex-latency:
+      - '476'
+      date:
+      - Mon, 08 Jan 2018 16:45:15 GMT
+      connection:
+      - close
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+    body:
+      encoding: UTF-8
+      string: '{"result":{"id":"ML_ez0Gj1S4SX4TZjv","libraryId":"UR_5dURLpfp5tm43EV","name":"NYC05
+        QN-SPS-NYC-STU-EL-6","category":"Unassigned","folder":null},"meta":{"httpStatus":"200
+        - OK","requestId":"66f0f343-665b-4616-b525-c367fecfc760"}}'
+    http_version: 
+  recorded_at: Mon, 08 Jan 2018 16:45:29 GMT
+- request:
+    method: post
+    uri: https://co1.qualtrics.com/API/v3/mailinglists/ML_ez0Gj1S4SX4TZjv/contacts
+    body:
+      encoding: UTF-8
+      string: '{"firstName":"test","lastName":"member","email":"test@test.com"}'
+    headers:
+      X-API-TOKEN:
+      - xxx
+      User-Agent:
+      - Faraday v0.13.1
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      request-time:
+      - '385'
+      content-type:
+      - application/json
+      content-length:
+      - '124'
+      x-edgeconnect-midmile-rtt:
+      - '13'
+      x-edgeconnect-origin-mex-latency:
+      - '438'
+      date:
+      - Mon, 08 Jan 2018 16:45:15 GMT
+      connection:
+      - close
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+    body:
+      encoding: UTF-8
+      string: '{"result":{"id":"MLRP_6lo2XeWwEHBhnk9"},"meta":{"httpStatus":"200 -
+        OK","requestId":"b36a2747-33fb-4b73-b559-082d86051939"}}'
+    http_version: 
+  recorded_at: Mon, 08 Jan 2018 16:45:30 GMT
+recorded_with: VCR 3.0.3

data/lib/qualtrics_api/panel.rb

@@ -11,6 +11,14 @@ module QualtricsAPI
       @members ||= QualtricsAPI::PanelMemberCollection.new(options.merge(id: id)).propagate_connection(self)
     end
 
+    def import_members(mbs)
+      members.import_members(mbs)
+    end
+
+    def create(member)
+      members.create(member)
+    end
+
     private
 
     def attributes_mappings

data/lib/qualtrics_api/panel_member.rb

@@ -15,10 +15,14 @@ module QualtricsAPI
       attributes.to_json
     end
 
+    def to_create_json
+      attributes(attributes_for_create).select{ |k,v| k }.to_json
+    end
+
     alias_method :super_attributes, :attributes
 
-    def attributes
-      Hash[super_attributes.map { |k, v| [attributes_for_save[k], v] }].delete_if { |_k, v| v.nil? }
+    def attributes(attrs = attributes_for_save)
+      Hash[super_attributes.map { |k, v| [attrs[k], v] }].delete_if { |_k, v| v.nil? }
     end
 
     private
@@ -36,6 +40,12 @@ module QualtricsAPI
       }
     end
 
+    def attributes_for_create
+      attrs = attributes_for_save
+      attrs.delete(:id)
+      attrs.merge({ :external_reference => "externalDataRef" })
+    end
+
     def attributes_mappings
       {
         :id => "panelMemberId",

data/lib/qualtrics_api/panel_member_collection.rb

@@ -3,8 +3,16 @@ module QualtricsAPI
     values do
       attribute :id, String
     end
+
+    def create(panel_member)
+      payload = panel_member.to_create_json
+      res = QualtricsAPI.connection(self)
+                  .post("mailinglists/#{id}/contacts", payload)
+                  .body["result"]
+      return QualtricsAPI::PanelMember.new(panel_member.attributes.merge({ id: res['id'] }))
+    end
   
-    def create(panel_members)
+    def import_members(panel_members)
       payload = {
         contacts: Faraday::UploadIO.new(StringIO.new(panel_members.to_json), 'application/json', 'contacts.json')
       }

data/lib/qualtrics_api/version.rb

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

data/spec/lib/panel_member_collection_spec.rb

@@ -53,10 +53,10 @@ describe QualtricsAPI::PanelMemberCollection do
       end
     end
 
-    describe "#create" do
+    describe "#import_members" do
       let(:result) do
         VCR.use_cassette(cassette, record: :once) do
-          QualtricsAPI.panels.find('ML_0APx3C4rmHER6w5').members.create(panel_members)
+          QualtricsAPI.panels.find('ML_0APx3C4rmHER6w5').members.import_members(panel_members)
         end
       end
 
@@ -86,5 +86,35 @@ describe QualtricsAPI::PanelMemberCollection do
         end
       end
     end
+
+    describe '#create' do
+      let(:result) do
+        VCR.use_cassette(cassette, record: :once) do
+          QualtricsAPI.panels.find('ML_ez0Gj1S4SX4TZjv').members.create(panel_member)
+        end
+      end
+
+      describe 'when success' do
+        let(:cassette) { 'panel_member_single_create_success' }
+        let(:panel_member) { QualtricsAPI::PanelMember.new(first_name: 'test', last_name: 'member', email: 'test@test.com') }
+
+        it 'returns PanelMember' do
+          expect(result).to be_a QualtricsAPI::PanelMember
+        end
+
+        it 'returns PanelMember with id' do
+          expect(result.id).to match(/^MLRP_/)
+        end
+      end
+
+      describe 'when failed' do
+        let(:cassette) { 'panel_member_single_create_failure' }
+        let(:panel_member) { QualtricsAPI::PanelMember.new(first_name: 'test', last_name: 'member', email: 'test@test.com') }
+
+        it 'raises exception' do
+          expect{result}.to raise_error{QualtricsAPI::NotFoundError}
+        end
+      end
+    end
   end
 end

data/spec/lib/panel_spec.rb

@@ -55,4 +55,23 @@ describe QualtricsAPI::Panel do
       end
     end
   end
+
+  describe '#import_members' do
+    it 'is delegated to the panel member collection' do
+      collection_double = double()
+      allow(subject).to receive(:members) { collection_double }
+      collection_double.should_receive(:import_members).with([])
+      subject.import_members([])
+    end
+  end
+
+  describe '#create' do
+    let(:member) { QualtricsAPI::PanelMember.new }
+    it 'is delegated to the panel member collection' do
+      collection_double = double()
+      allow(subject).to receive(:members) { collection_double }
+      expect(collection_double).to receive(:create).with(member)
+      subject.create(member)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qualtrics_api
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Yurui Zhang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -145,6 +145,8 @@ files:
 - fixtures/vcr_cassettes/panel_member_collection_create_success.yml
 - fixtures/vcr_cassettes/panel_member_collection_fetch_fail.yml
 - 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/response_export_start_success.yml
 - fixtures/vcr_cassettes/response_export_update_success.yml
 - fixtures/vcr_cassettes/survey_collection_fetch_fail.yml
@@ -208,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for Qualtrics REST API v3.0