responsys-api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjJjY2JmYjg3NDBmZmQ4NDBhMGM0ZWNiNDIxYzBlZjdmODQzYmQ5YQ==
+    OTNjZTgyNjk2Zjk4OTgyY2E5MzYwMTgwZDk1MjUzZWE3ZDNiYzI1Yg==
   data.tar.gz: !binary |-
-    OGIyMTU3ZmY5Mzg3NmIwYmJlMWFhZmViMGNhYWUxMWM5NGQ3MzMwMg==
+    ZjZmMDFhMThmYmE3N2NkOTM2YjAyNzA0MDEwMDUyZjEwOWE3ZGI1Mg==
 SHA512:
   metadata.gz: !binary |-
-    YjNiZjc5OTAwYjMwMWI2YzZjZjBkYTQyOGI0N2E4YTc5NjgzYjA4MDc5NGVj
-    YmFjMmIzYTQwYjQxMTIyNWQxY2NhZjNhZWJjMzY2NzcyZWE5MjcwMmM1ODll
-    ZmM1N2Q4MjJlZmZhMTdjMzAyMTA2Mjc0MjZhZWEzNTdiMmE0Nzk=
+    ZGI2ZGQxNDAxM2QyMmY4ZjJhNTIyNmMyZjhkY2MwMWMyNGU0NDgyNTY2MWMz
+    MGVlNWQ4NDg0NWQ0N2M1M2FhODg1MjI3M2JjMjI3MjNjODU3M2E3YjJhODVi
+    MzkzZjQwZDk5OWY5NTI2MzgzMzZhNDQwYjdkNmM2MjIzZGE3N2M=
   data.tar.gz: !binary |-
-    N2YwNmFhY2RkZTNkZDdmZjA1N2E4ZjJhMDc3NTcxODk3ZmEwNDlmYjU0MDQ2
-    NzU4OTdlMTgxODcwMzMyYjIzYzQ1OTc5NjRlOWIyM2E2MGRjMTIzYTM4MDgy
-    OGFjNzMwNmUwZDNhM2JiZTExMmQzZmZmMDg1ZTIzZDc1Mjc5MzM=
+    OTAwYjkyMjEzYTk5ODkzYmU1YmQ5MDVlY2MwMWE3ZmQxNzBiZTkxOThhYWVh
+    NWQ1N2E1MDcxMTdhMTBkMWM1Mzc0YjRhYmQ3MzZiYzEwNzFmMzY1N2VkNDRh
+    NTc5MzljZjY2ZDMyYmFlNTk2ODE0OGVmZGI2ZTgwMGVlOGY1YmI=

data/README.md

@@ -1,6 +1,6 @@
 # ResponsysApi
 
-A gem to help you communicate to the Responsys Interact SOAP API.
+A gem to help you communicate to the Responsys Interact SOAP API. Currently supporting version 6.20.
 
 ## Documentation
 
@@ -83,6 +83,20 @@ The API client used by the gem logs in as soon as a the first method is called.
 Responsys::Api::Client.instance.logout
 ```
 
+###Notes
+
+####Invalid email format
+If you try to call the API on a user that has an invalid email format, the API and the GEM will then reply with this message :
+```
+{
+	:status=>"ok", 
+	:result=>{
+		:recipient_id=>"-1", 
+		:error_message=>"Record 0 = BAD EMAIL FORMAT"
+	}
+}
+```
+
 ## Contributing
 
 1. Fork it

data/lib/responsys/api/campaign.rb

@@ -4,12 +4,12 @@ module Responsys
   module Api
     module Campaign
       include Responsys::Exceptions
-      
+
       def trigger_message(campaign, recipients)
         raise ParameterException, I18n.t("api.campaign.incorrect_recipients_type") unless recipients.is_a? Array
         message = {
           campaign: campaign.to_api,
-          recipientData: recipients.map(&:to_api) 
+          recipientData: recipients.map(&:to_api)
         }
         api_method(:trigger_campaign_message, message)
       end
@@ -23,4 +23,4 @@ module Responsys
       end
     end
   end
-end
+end

data/lib/responsys/api/object/optional_data.rb

@@ -20,4 +20,4 @@ module Responsys
       end
     end
   end
-end
+end

data/lib/responsys/api/object/recipient_data.rb

@@ -4,7 +4,7 @@ module Responsys
       class RecipientData
         attr_accessor :recipient, :optional_data
 
-        def initialize(recipient, optional_data = Responsys::Api::Object::OptionalData.new)
+        def initialize(recipient, optional_data = [Responsys::Api::Object::OptionalData.new])
           @recipient = recipient
           @optional_data = optional_data
         end
@@ -12,7 +12,7 @@ module Responsys
         def to_api
           {
             recipient: @recipient.to_api,
-            optionalData: @optional_data.to_api
+            optionalData: @optional_data.map(&:to_api)
           }
         end
       end

data/lib/responsys/member.rb

@@ -13,11 +13,23 @@ module Responsys
       @client = Client.instance
     end
 
-    def add_to_list(list, subscribe = false)
+    def add_to_list(list, subscribe = false, details = {}, update_record = false)
       data = { EMAIL_ADDRESS_:  @email, EMAIL_PERMISSION_STATUS_: subscribe ? "I" : "O" }
+
+      safe_details = {}
+      details.each do |k,v|
+        next if reserved_fields.include? r_key(k)
+        if [Time, Date, DateTime].include?(v.class)
+          safe_details[r_key(k)] = details[k].strftime('%Y-%m-%dT%H:%M:%S%z')
+        else
+          safe_details[r_key(k)] = details[k]
+        end
+      end
+
+      data = data.merge( safe_details )
       record = RecordData.new([data])
 
-      @client.merge_list_members_riid(list, record, ListMergeRule.new(insertOnNoMatch: true, updateOnMatch: "NO_UPDATE"))
+      @client.merge_list_members_riid(list, record, ListMergeRule.new(insertOnNoMatch: true, updateOnMatch: ( update_record ? 'REPLACE_ALL' : 'NO_UPDATE' )))
     end
 
     def retrieve_profile_extension(profile_extension, fields)
@@ -69,6 +81,26 @@ module Responsys
 
     private
 
+    def r_key(k)
+      k.to_s.upcase.to_sym
+    end
+
+    def reserved_fields
+      # There are also the MOBILE and POSTAL fields.  We should allow those to be set via this method
+      [
+        :RIID_,
+        :CREATED_SOURCE_IP_,
+        :CUSTOMER_ID_,
+        :EMAIL_ADDRESS_,
+        :EMAIL_DOMAIN_,
+        :EMAIL_ISP_,
+        :EMAIL_FORMAT_,
+        :EMAIL_PERMISSION_STATUS_,
+        :EMAIL_DELIVERABILITY_STATUS_,
+        :EMAIL_PERMISSION_REASON_,
+      ]
+    end
+
     def lookup_profile_via_key(profile_extension, key, value)
       @client.retrieve_profile_extension_records(profile_extension, QueryColumn.new(key), %w(RIID_), [value])
     end

data/responsys-api.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "responsys-api"
-  spec.version       = "0.0.4"
+  spec.version       = "0.0.5"
   spec.authors       = ["Dan DeMeyere", "Florian Lorrain", "Morgan Griggs", "Mike Rocco"]
   spec.email         = ["dan@thredup.com", "florian.lorrain@thredup.com", "morgan@thredup.com", "michael.rocco@thredup.com"]
   spec.description   = "A gem to integrate with the Responsys SOAP API"

data/spec/api/object/recipient_data_spec.rb

@@ -16,7 +16,7 @@ describe Responsys::Api::Object::RecipientData do
     end
 
     it "should have an optional_data attribute of type Array" do
-      expect(@recipient_data.optional_data).to be_a(Responsys::Api::Object::OptionalData)
+      expect(@recipient_data.optional_data).to include(Responsys::Api::Object::OptionalData)
     end
   end
 
@@ -37,7 +37,7 @@ describe Responsys::Api::Object::RecipientData do
     end
 
     it "should have an optionalData attribute of type Array" do
-      expect(@recipient_data.to_api[:optionalData]).to be_a(Hash)
+      expect(@recipient_data.to_api[:optionalData]).to be_a(Array)
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: responsys-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Dan DeMeyere
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyntlm