markety 1.4.3 → 2.0

data/lib/markety/response/sync_lead_response.rb

@@ -0,0 +1,32 @@
+require 'markety/lead'
+require 'markety/response/generic_response'
+
+module Markety
+  module Response
+    # Response class for SyncLead commands
+    class SyncLeadResponse < GenericResponse
+      
+      # +:created+ or +:updated+ (or nil if unsuccessful)
+      attr_reader :update_type
+      # the updated or created Lead (or nil if unsuccessful)
+      attr_reader :updated_lead
+      # the ID of the created or updated Lead (or nil if unsuccessful)
+      attr_reader :lead_id
+
+      def initialize(response)
+        super(:sync_response,response)
+        h = self.to_hash
+
+        if self.success?
+          sync_status = h[:success_sync_lead][:result][:sync_status]
+          @lead_id = sync_status[:lead_id]
+          @update_type = sync_status[:status].downcase.to_sym
+          @updated_lead = ::Markety::Lead.from_hash(h[:success_sync_lead][:result][:lead_record])
+        else
+          # overwrite super's crap error message with useful one
+          @error_message = h[:fault][:detail][:service_exception][:message]
+        end
+      end
+    end
+  end
+end

data/lib/markety/version.rb

@@ -1,5 +1,3 @@
 module Markety
-
-  VERSION = "1.4.3"
-
+  VERSION = "2.0"
 end

data/spec/markety/lead_key_spec.rb

@@ -4,29 +4,28 @@ module Markety
   describe LeadKeyType do
     it "should define the correct types" do
       LeadKeyType::IDNUM.should == 'IDNUM'
-      LeadKeyType::COOKIE.should == 'COOKIE'
       LeadKeyType::EMAIL.should == 'EMAIL'
-      LeadKeyType::LEADOWNEREMAIL.should == 'LEADOWNEREMAIL'
-      LeadKeyType::SFDCACCOUNTID.should == 'SFDCACCOUNTID'
-      LeadKeyType::SFDCCONTACTID.should == 'SFDCCONTACTID'
-      LeadKeyType::SFDCLEADID.should == 'SFDCLEADID'
-      LeadKeyType::SFDCLEADOWNERID.should == 'SFDCLEADOWNERID'
-      LeadKeyType::SFDCOPPTYID.should == 'SFDCOPPTYID'
+      #LeadKeyType::COOKIE.should == 'COOKIE'
+      #LeadKeyType::LEADOWNEREMAIL.should == 'LEADOWNEREMAIL'
+      #LeadKeyType::SFDCACCOUNTID.should == 'SFDCACCOUNTID'
+      #LeadKeyType::SFDCCONTACTID.should == 'SFDCCONTACTID'
+      #LeadKeyType::SFDCLEADID.should == 'SFDCLEADID'
+      #LeadKeyType::SFDCLEADOWNERID.should == 'SFDCLEADOWNERID'
+      #LeadKeyType::SFDCOPPTYID.should == 'SFDCOPPTYID'
     end
   end
 
   describe LeadKey do
+    KEY_VALUE = 'a value'
+    KEY_TYPE = LeadKeyType::IDNUM
+
     it "should store type and value on construction" do
-      KEY_VALUE = 'a value'
-      KEY_TYPE = LeadKeyType::IDNUM
       lead_key = LeadKey.new(KEY_TYPE, KEY_VALUE)
       lead_key.key_type.should == KEY_TYPE
       lead_key.key_value.should == KEY_VALUE
     end
 
     it "should to_hash correctly" do
-      KEY_VALUE = 'a value'
-      KEY_TYPE = LeadKeyType::IDNUM
       lead_key = LeadKey.new(KEY_TYPE, KEY_VALUE)
 
       lead_key.to_hash.should == {

data/spec/markety/{lead_record_spec.rb → lead_spec.rb}

@@ -6,22 +6,22 @@ module Markety
   
   
 
-  describe LeadRecord do
+  describe Lead do
     it "should store the idnum" do
-      lead_record = LeadRecord.new(EMAIL, IDNUM)
+      lead_record = Lead.new(email:EMAIL, idnum:IDNUM)
       lead_record.idnum.should == IDNUM
     end
 
     it "should store the email" do
-      LeadRecord.new(EMAIL, IDNUM).email.should == EMAIL
+      Lead.new(email:EMAIL, idnum:IDNUM).email.should == EMAIL
     end
 
     it "should implement == sensibly" do
-      lead_record1 = LeadRecord.new(EMAIL, IDNUM)
+      lead_record1 = Lead.new(email:EMAIL, idnum:IDNUM)
       lead_record1.set_attribute('favourite color', 'red')
       lead_record1.set_attribute('age', '100')
 
-      lead_record2 = LeadRecord.new(EMAIL, IDNUM)
+      lead_record2 = Lead.new(email:EMAIL, idnum:IDNUM)
       lead_record2.set_attribute('favourite color', 'red')
       lead_record2.set_attribute('age', '100')
 
@@ -29,35 +29,18 @@ module Markety
     end
 
     it "should store when attributes are set" do
-      lead_record = LeadRecord.new(EMAIL, IDNUM)
+      lead_record = Lead.new(email:EMAIL, idnum:IDNUM)
       lead_record.set_attribute('favourite color', 'red')
       lead_record.get_attribute('favourite color').should == 'red'
     end
 
     it "should store when attributes are updated" do
-      lead_record = LeadRecord.new(EMAIL, IDNUM)
+      lead_record = Lead.new(email:EMAIL, idnum:IDNUM)
       lead_record.set_attribute('favourite color', 'red')
       lead_record.set_attribute('favourite color', 'green')
       lead_record.get_attribute('favourite color').should == 'green'
     end
 
-    it "should yield all attributes through each_attribute_pair" do
-      lead_record = LeadRecord.new(EMAIL, IDNUM)
-      lead_record.set_attribute('favourite color', 'red')
-      lead_record.set_attribute('favourite color', 'green')
-      lead_record.set_attribute('age', '99')
-
-      pairs       = []
-      lead_record.each_attribute_pair do |attribute_name, attribute_value|
-        pairs << [attribute_name, attribute_value]
-      end
-
-      pairs.size.should == 3
-      pairs.should include(['favourite color', 'green'])
-      pairs.should include(['age', '99'])
-      pairs.should include(['Email', EMAIL])
-    end
-    
     it 'should be instantiable from savon hash with no attributes' do
       savon_hash = {
         :id => IDNUM,
@@ -67,8 +50,8 @@ module Markety
         :lead_attribute_list => nil
       }
       
-      actual = LeadRecord.from_hash(savon_hash)
-      expected = LeadRecord.new(EMAIL, IDNUM)
+      actual = Lead.from_hash(savon_hash)
+      expected = Lead.new(email:EMAIL, idnum:IDNUM)
       
       actual.should == expected
     end
@@ -84,9 +67,9 @@ module Markety
           {:attribute => { :attr_name => 'FirstName', :attr_value => 'Yaya', :attr_type => 'string'}}
       }
       
-      actual = LeadRecord.from_hash(savon_hash)
+      actual = Lead.from_hash(savon_hash)
       
-      expected = LeadRecord.new(EMAIL, IDNUM)
+      expected = Lead.new(email:EMAIL, idnum:IDNUM)
       expected.set_attribute('FirstName', 'Yaya')
       
       actual.should == expected
@@ -107,9 +90,9 @@ module Markety
           :id => IDNUM
       }
 
-      actual = LeadRecord.from_hash(savon_hash)
+      actual = Lead.from_hash(savon_hash)
 
-      expected = LeadRecord.new(EMAIL, IDNUM)
+      expected = Lead.new(email:EMAIL, idnum:IDNUM)
       expected.set_attribute('Company', 'Yaya')
       expected.set_attribute('FirstName', 'James')
       expected.set_attribute('LastName', 'O\'Brien')

data/spec/markety/response/get_lead_response_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+module Markety
+  module Response
+    describe GetLeadResponse do
+
+      let(:success_xml) { <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://www.marketo.com/mktows/">
+  <SOAP-ENV:Body>
+    <ns1:successGetLead>
+      <result>
+        <count>1</count>
+        <leadRecordList>
+          <leadRecord>
+            <Id>1001081</Id>
+            <Email>foo@example.com</Email>
+            <ForeignSysPersonId xsi:nil="true"/>
+            <ForeignSysType xsi:nil="true"/>
+            <leadAttributeList>
+              <attribute>
+                <attrName>FirstName</attrName>
+                <attrType>string</attrType>
+                <attrValue>Burt</attrValue>
+              </attribute>
+              <attribute>
+                <attrName>LastName</attrName>
+                <attrType>string</attrType>
+                <attrValue>Reynolds</attrValue>
+              </attribute>
+            </leadAttributeList>
+          </leadRecord>
+        </leadRecordList>
+      </result>
+    </ns1:successGetLead>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+END
+      }
+
+      let(:success_xml_two_leads) { <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://www.marketo.com/mktows/">
+  <SOAP-ENV:Body>
+    <ns1:successGetLead>
+      <result>
+        <count>2</count>
+        <leadRecordList>
+          <leadRecord>
+            <Id>1001084</Id>
+            <Email>foo@example.com</Email>
+            <ForeignSysPersonId xsi:nil="true"/>
+            <ForeignSysType xsi:nil="true"/>
+            <leadAttributeList>
+              <attribute>
+                <attrName>Company</attrName>
+                <attrType>string</attrType>
+                <attrValue>The Price is Right</attrValue>
+              </attribute>
+              <attribute>
+                <attrName>FirstName</attrName>
+                <attrType>string</attrType>
+                <attrValue>Bob</attrValue>
+              </attribute>
+              <attribute>
+                <attrName>LastName</attrName>
+                <attrType>string</attrType>
+                <attrValue>Barker</attrValue>
+              </attribute>
+            </leadAttributeList>
+          </leadRecord>
+          <leadRecord>
+            <Id>1001081</Id>
+            <Email>foo@example.com</Email>
+            <ForeignSysPersonId xsi:nil="true"/>
+            <ForeignSysType xsi:nil="true"/>
+            <leadAttributeList>
+              <attribute>
+                <attrName>Company</attrName>
+                <attrType>string</attrType>
+                <attrValue>foo</attrValue>
+              </attribute>
+              <attribute>
+                <attrName>FirstName</attrName>
+                <attrType>string</attrType>
+                <attrValue>foo</attrValue>
+              </attribute>
+              <attribute>
+                <attrName>LastName</attrName>
+                <attrType>string</attrType>
+                <attrValue>foo</attrValue>
+              </attribute>
+              <attribute>
+                <attrName>LeadStatus</attrName>
+                <attrType>string</attrType>
+                <attrValue>Inactive</attrValue>
+              </attribute>
+            </leadAttributeList>
+          </leadRecord>
+        </leadRecordList>
+      </result>
+    </ns1:successGetLead>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+END
+      }
+
+      let(:failure_xml) { <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
+  <SOAP-ENV:Body>
+    <SOAP-ENV:Fault>
+      <faultcode>SOAP-ENV:Client</faultcode>
+      <faultstring>20103 - Lead not found</faultstring>
+      <detail>
+        <ns1:serviceException xmlns:ns1="http://www.marketo.com/mktows/">
+          <name>mktServiceException</name>
+          <message>No lead found with EMAIL = pants@example.com (20103)</message>
+          <code>20103</code>
+        </ns1:serviceException>
+      </detail>
+    </SOAP-ENV:Fault>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+END
+      }
+
+
+      it 'can construct from a success - one lead' do
+        savon_resp = SavonHelper.create_response(success_xml)
+        r = GetLeadResponse.new(savon_resp)
+
+        # GenericResponse fields
+        r.success?.should == true
+        r.error_message.should be_nil
+
+        # SyncLeadResponse fields
+        r.leads.length.should == 1
+	r.leads.first.get_attribute("FirstName").should == "Burt"
+      end
+
+      it 'can construct from a success - two leads' do
+        savon_resp = SavonHelper.create_response(success_xml_two_leads)
+        r = GetLeadResponse.new(savon_resp)
+
+        # GenericResponse fields
+        r.success?.should == true
+        r.error_message.should be_nil
+
+        # SyncLeadResponse fields
+        r.leads.length.should == 2
+	r.leads[0].get_attribute("Company").should == "The Price is Right"
+	r.leads[1].get_attribute("Company").should == "foo"
+      end
+
+
+      it 'can construct from a failure' do
+        savon_resp = SavonHelper.create_response(failure_xml)
+        r = GetLeadResponse.new(savon_resp)
+
+        # GenericResponse fields
+        r.success?.should == false
+        r.error_message.should == "No lead found with EMAIL = pants@example.com (20103)"
+
+        # SyncLeadResponse fields
+        r.leads.empty?.should be true
+      end
+    end
+  end
+end

data/spec/markety/response/list_operation_response_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+module Markety
+  module Response
+    describe ListOperationResponse do
+
+      let(:success_xml) {<<END
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.marketo.com/mktows/">
+  <SOAP-ENV:Body>
+    <ns1:successListOperation>
+      <result>
+        <success>true</success>
+        <statusList>
+          <leadStatus>
+            <leadKey>
+              <keyType>IDNUM</keyType>
+              <keyValue>1001088</keyValue>
+            </leadKey>
+            <status>true</status>
+          </leadStatus>
+        </statusList>
+      </result>
+    </ns1:successListOperation>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+END
+      }
+
+      let(:failure_xml) {<<END
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.marketo.com/mktows/">
+  <SOAP-ENV:Body>
+    <ns1:successListOperation>
+      <result>
+        <success>false</success>
+        <statusList>
+          <leadStatus>
+            <leadKey>
+              <keyType>IDNUM</keyType>
+              <keyValue>1001086</keyValue>
+            </leadKey>
+            <status>false</status>
+          </leadStatus>
+        </statusList>
+      </result>
+    </ns1:successListOperation>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+END
+      }
+
+
+      it 'can construct from a success' do
+        savon_resp = SavonHelper.create_response(success_xml)
+        r = ListOperationResponse.new(savon_resp)
+
+        # GenericResponse fields
+        r.success?.should == true
+        r.error_message.should be_nil
+
+        r.list_operation_success?.should == true
+      end
+
+      it 'can construct from a failure' do
+        savon_resp = SavonHelper.create_response(failure_xml)
+        r = ListOperationResponse.new(savon_resp)
+
+        # GenericResponse fields
+        r.success?.should == true
+        r.error_message.should be_nil
+
+        r.list_operation_success?.should == false
+      end
+
+    end
+  end
+end

data/spec/markety/response/sync_lead_response_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+module Markety
+  module Response
+    describe SyncLeadResponse do
+
+      let(:success_xml) { <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://www.marketo.com/mktows/">
+  <SOAP-ENV:Body>
+    <ns1:successSyncLead>
+      <result>
+        <leadId>1001064</leadId>
+        <syncStatus>
+          <leadId>1001064</leadId>
+          <status>CREATED</status>
+          <error xsi:nil="true"/>
+        </syncStatus>
+        <leadRecord>
+          <Id>1001064</Id>
+          <Email>spiderman@example.com</Email>
+          <ForeignSysPersonId xsi:nil="true"/>
+          <ForeignSysType xsi:nil="true"/>
+          <leadAttributeList>
+            <attribute>
+              <attrName>FirstName</attrName>
+              <attrType>string</attrType>
+              <attrValue>Peter</attrValue>
+            </attribute>
+            <attribute>
+              <attrName>LastName</attrName>
+              <attrType>string</attrType>
+              <attrValue>Parker</attrValue>
+            </attribute>
+            <attribute>
+              <attrName>Website</attrName>
+              <attrType>url</attrType>
+              <attrValue>example.com</attrValue>
+            </attribute>
+          </leadAttributeList>
+        </leadRecord>
+      </result>
+    </ns1:successSyncLead>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+END
+      }
+
+      let(:failure_xml) { <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
+  <SOAP-ENV:Body>
+    <SOAP-ENV:Fault>
+      <faultcode>SOAP-ENV:Client</faultcode>
+      <faultstring>20105 - Unknown lead field</faultstring>
+      <detail>
+        <ns1:serviceException xmlns:ns1="http://www.marketo.com/mktows/">
+          <name>mktServiceException</name>
+          <message>syncLead operation failed: unknown fields for import: pants (20105)</message>
+          <code>20105</code>
+        </ns1:serviceException>
+      </detail>
+    </SOAP-ENV:Fault>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+END
+      }
+
+
+
+      it 'can construct from a success' do
+        savon_resp = SavonHelper.create_response(success_xml)
+
+        r = SyncLeadResponse.new(savon_resp)
+
+        # GenericResponse fields
+        r.success?.should == true
+        r.error_message.should be_nil
+        # to_xml
+        # to_hash
+
+        # SyncLeadResponse fields
+        r.lead_id.should == "1001064"
+        r.update_type.should == :created
+        r.updated_lead.is_a?(::Markety::Lead).should == true
+      end
+
+      it 'can construct from a failure' do
+        savon_resp = SavonHelper.create_response(failure_xml)
+
+        r = SyncLeadResponse.new(savon_resp)
+
+        # GenericResponse fields
+        r.success?.should == false
+        r.error_message.should == "syncLead operation failed: unknown fields for import: pants (20105)"
+        # to_xml
+        # to_hash
+
+        # SyncLeadResponse fields
+        r.lead_id.should be_nil
+        r.update_type.should be_nil
+        r.updated_lead.should be_nil
+      end
+
+    end #describe SyncLeadResponse
+  end #module Response
+end #module Markety