responsys-api 0.0.3 → 0.0.4

data/spec/fixtures/vcr_cassettes/member/present2.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://wsxxxx.responsys.net/webservices/services/ResponsysWSService
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="urn:ws.rsys.com"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Header><sessionHeader><sessionId>bBvxPCXScxL40VhQx6JFG6ziO9</sessionId></sessionHeader></env:Header><env:Body><tns:retrieveListMembers><tns:list><tns:folderName>another_test_folder</tns:folderName><tns:objectName>test_list</tns:objectName></tns:list><tns:queryColumn>RIID</tns:queryColumn><tns:fieldList>EMAIL_PERMISSION_STATUS_</tns:fieldList><tns:idsToRetrieve>1225</tns:idsToRetrieve></tns:retrieveListMembers></env:Body></env:Envelope>
+    headers:
+      Cookie:
+      - JSESSIONID=EF4D2D3574EA896D10416D6FF9DE184E.ws01-ri5
+      Soapaction:
+      - ! '"retrieveListMembers"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '677'
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '383'
+      Content-Type:
+      - text/xml; charset=UTF-8
+      Date:
+      - Fri, 29 Aug 2014 22:31:03 GMT
+      Server:
+      - Apache
+      Set-Cookie:
+      - BIGipServerDC2-APIGEE-I5-9051-SSL=3617446922.23331.0000; path=/
+    body:
+      encoding: US-ASCII
+      string: <?xml version='1.0' encoding='UTF-8'?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><retrieveListMembersResponse
+        xmlns="urn:ws.rsys.com"><result><recordData><fieldNames>EMAIL_PERMISSION_STATUS_</fieldNames><records><fieldValues>I</fieldValues></records></recordData></result></retrieveListMembersResponse></soapenv:Body></soapenv:Envelope>
+    http_version: 
+  recorded_at: Fri, 29 Aug 2014 22:31:03 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr_cassettes/member/present3.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://wsxxxx.responsys.net/webservices/services/ResponsysWSService
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="urn:ws.rsys.com"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Header><sessionHeader><sessionId>bBvxPCXScxL40VhQx6JFG6ziO9</sessionId></sessionHeader></env:Header><env:Body><tns:retrieveListMembers><tns:list><tns:folderName>another_test_folder</tns:folderName><tns:objectName>test_list</tns:objectName></tns:list><tns:queryColumn>EMAIL_ADDRESS</tns:queryColumn><tns:fieldList>EMAIL_PERMISSION_STATUS_</tns:fieldList><tns:idsToRetrieve>thisemailis@notpresent.com</tns:idsToRetrieve></tns:retrieveListMembers></env:Body></env:Envelope>
+    headers:
+      Cookie:
+      - JSESSIONID=EF4D2D3574EA896D10416D6FF9DE184E.ws01-ri5
+      Soapaction:
+      - ! '"retrieveListMembers"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '708'
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 500
+      message: Internal Server Error
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '462'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Date:
+      - Fri, 29 Aug 2014 22:31:03 GMT
+      Server:
+      - Apache
+      Set-Cookie:
+      - BIGipServerDC2-APIGEE-I5-9051-SSL=3617446922.23331.0000; path=/
+    body:
+      encoding: US-ASCII
+      string: <?xml version='1.0' encoding='UTF-8'?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><soapenv:Fault><faultcode>soapenv:Server</faultcode><faultstring>ListFault</faultstring><detail><ListFault
+        xmlns="urn:fault.ws.rsys.com"><exceptionCode>RECORD_NOT_FOUND</exceptionCode><exceptionMessage>No
+        records found in the list for given ids</exceptionMessage></ListFault></detail></soapenv:Fault></soapenv:Body></soapenv:Envelope>
+    http_version: 
+  recorded_at: Fri, 29 Aug 2014 22:31:03 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr_cassettes/member/present4.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://wsxxxx.responsys.net/webservices/services/ResponsysWSService
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="urn:ws.rsys.com"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Header><sessionHeader><sessionId>bBvxPCXScxL40VhQx6JFG6ziO9</sessionId></sessionHeader></env:Header><env:Body><tns:retrieveListMembers><tns:list><tns:folderName>another_test_folder</tns:folderName><tns:objectName>test_list</tns:objectName></tns:list><tns:queryColumn>RIID</tns:queryColumn><tns:fieldList>EMAIL_PERMISSION_STATUS_</tns:fieldList><tns:idsToRetrieve>000001</tns:idsToRetrieve></tns:retrieveListMembers></env:Body></env:Envelope>
+    headers:
+      Cookie:
+      - JSESSIONID=EF4D2D3574EA896D10416D6FF9DE184E.ws01-ri5
+      Soapaction:
+      - ! '"retrieveListMembers"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '679'
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 500
+      message: Internal Server Error
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '462'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Date:
+      - Fri, 29 Aug 2014 22:31:04 GMT
+      Server:
+      - Apache
+      Set-Cookie:
+      - BIGipServerDC2-APIGEE-I5-9051-SSL=3617446922.23331.0000; path=/
+    body:
+      encoding: US-ASCII
+      string: <?xml version='1.0' encoding='UTF-8'?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><soapenv:Fault><faultcode>soapenv:Server</faultcode><faultstring>ListFault</faultstring><detail><ListFault
+        xmlns="urn:fault.ws.rsys.com"><exceptionCode>RECORD_NOT_FOUND</exceptionCode><exceptionMessage>No
+        records found in the list for given ids</exceptionMessage></ListFault></detail></soapenv:Fault></soapenv:Body></soapenv:Envelope>
+    http_version: 
+  recorded_at: Fri, 29 Aug 2014 22:31:04 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr_cassettes/member/present5.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://wsxxxx.responsys.net/webservices/services/ResponsysWSService
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="urn:ws.rsys.com"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Header><sessionHeader><sessionId>bBvxPCXScxL40VhQx6JFG6ziO9</sessionId></sessionHeader></env:Header><env:Body><tns:retrieveListMembers><tns:list><tns:folderName>another_test_folder</tns:folderName><tns:objectName>test_list</tns:objectName></tns:list><tns:queryColumn>RIID</tns:queryColumn><tns:fieldList>EMAIL_PERMISSION_STATUS_</tns:fieldList><tns:idsToRetrieve>000001</tns:idsToRetrieve></tns:retrieveListMembers></env:Body></env:Envelope>
+    headers:
+      Cookie:
+      - JSESSIONID=EF4D2D3574EA896D10416D6FF9DE184E.ws01-ri5
+      Soapaction:
+      - ! '"retrieveListMembers"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '679'
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 500
+      message: Internal Server Error
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '462'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Date:
+      - Fri, 29 Aug 2014 22:31:04 GMT
+      Server:
+      - Apache
+      Set-Cookie:
+      - BIGipServerDC2-APIGEE-I5-9051-SSL=3617446922.23331.0000; path=/
+    body:
+      encoding: US-ASCII
+      string: <?xml version='1.0' encoding='UTF-8'?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><soapenv:Fault><faultcode>soapenv:Server</faultcode><faultstring>ListFault</faultstring><detail><ListFault
+        xmlns="urn:fault.ws.rsys.com"><exceptionCode>RECORD_NOT_FOUND</exceptionCode><exceptionMessage>No
+        records found in the list for given ids</exceptionMessage></ListFault></detail></soapenv:Fault></soapenv:Body></soapenv:Envelope>
+    http_version: 
+  recorded_at: Fri, 29 Aug 2014 22:31:04 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr_cassettes/member/retrieve_profile_extension.yml

@@ -0,0 +1,87 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://wsxxxx.responsys.net/webservices/services/ResponsysWSService
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="urn:ws.rsys.com"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Header><sessionHeader><sessionId>bBvxPCXScxL40VhQx6JFG6ziO9</sessionId></sessionHeader></env:Header><env:Body><tns:retrieveProfileExtensionRecords><tns:profileExtension><tns:folderName>demo_folder2</tns:folderName><tns:objectName>customers_extension</tns:objectName></tns:profileExtension><tns:queryColumn>RIID</tns:queryColumn><tns:fieldList>RIID_</tns:fieldList><tns:idsToRetrieve>1125</tns:idsToRetrieve></tns:retrieveProfileExtensionRecords></env:Body></env:Envelope>
+    headers:
+      Cookie:
+      - JSESSIONID=EF4D2D3574EA896D10416D6FF9DE184E.ws01-ri5
+      Soapaction:
+      - ! '"retrieveProfileExtensionRecords"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '709'
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '391'
+      Content-Type:
+      - text/xml; charset=UTF-8
+      Date:
+      - Fri, 29 Aug 2014 22:31:04 GMT
+      Server:
+      - Apache
+      Set-Cookie:
+      - BIGipServerDC2-APIGEE-I5-9051-SSL=3617446922.23331.0000; path=/
+    body:
+      encoding: US-ASCII
+      string: <?xml version='1.0' encoding='UTF-8'?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><retrieveProfileExtensionRecordsResponse
+        xmlns="urn:ws.rsys.com"><result><recordData><fieldNames>RIID_</fieldNames><records><fieldValues>1125</fieldValues></records></recordData></result></retrieveProfileExtensionRecordsResponse></soapenv:Body></soapenv:Envelope>
+    http_version: 
+  recorded_at: Fri, 29 Aug 2014 22:31:04 GMT
+- request:
+    method: post
+    uri: https://wsxxxx.responsys.net/webservices/services/ResponsysWSService
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="urn:ws.rsys.com"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Header><sessionHeader><sessionId>bBvxPCXScxL40VhQx6JFG6ziO9</sessionId></sessionHeader></env:Header><env:Body><tns:retrieveProfileExtensionRecords><tns:profileExtension><tns:folderName>demo_folder2</tns:folderName><tns:objectName>customers_extension</tns:objectName></tns:profileExtension><tns:queryColumn>RIID</tns:queryColumn><tns:fieldList>RIID_</tns:fieldList><tns:fieldList>EMAIL_ADDRESS</tns:fieldList><tns:idsToRetrieve>1125</tns:idsToRetrieve></tns:retrieveProfileExtensionRecords></env:Body></env:Envelope>
+    headers:
+      Cookie:
+      - JSESSIONID=EF4D2D3574EA896D10416D6FF9DE184E.ws01-ri5
+      Soapaction:
+      - ! '"retrieveProfileExtensionRecords"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '753'
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '471'
+      Content-Type:
+      - text/xml; charset=UTF-8
+      Date:
+      - Fri, 29 Aug 2014 22:31:04 GMT
+      Server:
+      - Apache
+      Set-Cookie:
+      - BIGipServerDC2-APIGEE-I5-9051-SSL=3617446922.23331.0000; path=/
+    body:
+      encoding: US-ASCII
+      string: <?xml version='1.0' encoding='UTF-8'?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><retrieveProfileExtensionRecordsResponse
+        xmlns="urn:ws.rsys.com"><result><recordData><fieldNames>RIID_</fieldNames><fieldNames>EMAIL_ADDRESS</fieldNames><records><fieldValues>1125</fieldValues><fieldValues>user@email.com</fieldValues></records></recordData></result></retrieveProfileExtensionRecordsResponse></soapenv:Body></soapenv:Envelope>
+    http_version: 
+  recorded_at: Fri, 29 Aug 2014 22:31:04 GMT
+recorded_with: VCR 2.5.0

data/spec/member_spec.rb

@@ -0,0 +1,136 @@
+require "spec_helper.rb"
+require "responsys/api/client"
+
+describe Responsys::Member do
+
+  before(:all) do
+    @email = "user@email.com"
+  end
+
+  context "New member" do
+
+    xit "should call mergeListMembers" do
+    end
+
+  end
+
+  context "Subscribing" do
+
+    before(:each) do
+      @connection = double "connection"
+
+      allow(Responsys::Api::Client).to receive(:instance).and_return(@connection)
+
+      @member = Responsys::Member.new(@email)
+      @list = Responsys::Api::Object::InteractObject.new("list_folder","list_object_name")
+      @query_column = Responsys::Api::Object::QueryColumn.new("EMAIL_ADDRESS")
+    end
+
+    it "should check the user is present in the list" do
+      expect(@member).to receive(:present_in_list?).with(@list)
+
+      @member.subscribe(@list)
+    end
+
+    it "should check the user has subscribed" do
+      response_expected = { status: "ok", data: [{ EMAIL_PERMISSION_STATUS_: "I" }] }
+
+      allow(@connection).to receive(:retrieve_list_members).with(@list, kind_of(Responsys::Api::Object::QueryColumn), %w(EMAIL_PERMISSION_STATUS_), %W(#{@member.email})).and_return(response_expected)
+
+      expect(@member.subscribed?(@list)).to eq(true)
+    end
+
+  end
+
+  context "Existing member" do
+
+    before(:all) do
+      @list = Responsys::Api::Object::InteractObject.new("another_test_folder","test_list")
+      @riid = 1225
+    end
+
+    it "should be ok, the email is present" do
+      VCR.use_cassette("member/present1") do
+        member_without_riid = Responsys::Member.new(@email)
+        bool = member_without_riid.present_in_list?(@list)
+
+        expect(bool).to eq(true)
+      end
+    end
+
+    it "should be ok, the email and riid is present" do
+      VCR.use_cassette("member/present2") do
+        member_with_riid = Responsys::Member.new(@email, @riid)
+        bool = member_with_riid.present_in_list?(@list)
+
+        expect(bool).to eq(true)
+      end
+    end
+
+    it "should fail, the email is not present" do
+      VCR.use_cassette("member/present3") do
+        member_with_fake_email = Responsys::Member.new("thisemailis@notpresent.com")
+        bool = member_with_fake_email.present_in_list?(@list)
+
+        expect(bool).to eq(false)
+      end
+    end
+
+    it "should fail, the email is present but not the riid" do
+      VCR.use_cassette("member/present4") do
+        member_with_fake_riid = Responsys::Member.new(@email, "000001")
+        bool = member_with_fake_riid.present_in_list?(@list)
+
+        expect(bool).to eq(false)
+      end
+    end
+
+    it "should return the record_not_found code message" do
+      VCR.use_cassette("member/present5") do
+        member_with_fake_riid = Responsys::Member.new(@email, "000001")
+        response = member_with_fake_riid.subscribed?(@list)
+
+        expect(response[:error][:code]).to eq("record_not_found")
+      end
+    end
+
+  end
+
+  context "Get profile extension data" do
+
+    before(:each) do
+      VCR.use_cassette("member/login") do
+        @profile_extension = Responsys::Api::Object::InteractObject.new("demo_folder2", "customers_extension")
+        @riid = 1125
+        @member_without_riid = Responsys::Member.new(@email)
+        @member_with_riid = Responsys::Member.new(@email, @riid)
+        @fields = %w(RIID_ EMAIL_ADDRESS)
+      end
+    end
+
+    it "should set the status to failure if no riid provided" do
+      VCR.use_cassette("member/retrieve_profile_extension_fail") do
+        response = @member_without_riid.retrieve_profile_extension(@profile_extension, @fields)
+
+        expect(response[:status]).to eq("failure")
+      end
+    end
+
+    it "should set a i18n message in the response if no riid provided" do
+      VCR.use_cassette("member/retrieve_profile_extension_fail") do
+        response = @member_without_riid.retrieve_profile_extension(@profile_extension, @fields)
+
+        expect(response[:error][:message]).to eq(I18n.t("member.riid_missing"))
+      end
+    end
+
+    it "should set the status to ok" do
+      VCR.use_cassette("member/retrieve_profile_extension") do
+        response = @member_with_riid.retrieve_profile_extension(@profile_extension, @fields)
+
+        expect(response[:status]).to eq("ok")
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,30 @@
-require 'bundler/setup'
+require "bundler/setup"
 Bundler.setup
 
-require './lib/responsys_api.rb'
+require "responsys_api.rb"
+require "vcr"
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  c.hook_into :webmock
+end
+
+Responsys.configure do |config|
+  config.settings = {
+    username: "your_responsys_username",
+    password: "your_responsys_password",
+    wsdl: "https://wsxxxx.responsys.net/webservices/wsdl/ResponsysWS_Level1.wsdl",
+    debug: false
+  }
+end
+
+# Responsys.configure do |config|
+#   config.settings = {
+#     username: "your_responsys_username",
+#     password: "your_responsys_password",
+#     wsdl: "https://wsxxxx.responsys.net/webservices/wsdl/ResponsysWS_Level1.wsdl",
+#     debug: false
+#   }
+# end
+
+I18n.enforce_available_locales = false