Row posts framed up. updated properties to always return array. updated munge to accept passed so we can in future abstract all munges into own file

Author: barberj

lib/fuelsdk.rb

@@ -29,227 +29,3 @@ module FuelSDK
 ET_UnsubEvent = FuelSDK::UnsubEvent
 ET_TriggeredSend = FuelSDK::TriggeredSend
 ET_Campaign = FuelSDK::Campaign
-
-=begin
-  class ET_DataExtension < ET_CUDSupport
-    attr_accessor :columns
-
-    def initialize
-      super
-      @obj = 'DataExtension'
-    end
-
-    def post
-      originalProps = @props
-
-      if @props.is_a? Array then
-        multiDE = []
-        @props.each { |currentDE|
-          currentDE['Fields'] = {}
-          currentDE['Fields']['Field'] = []
-          currentDE['columns'].each { |key|
-            currentDE['Fields']['Field'].push(key)
-          }
-          currentDE.delete('columns')
-          multiDE.push(currentDE.dup)
-        }
-
-        @props = multiDE
-      else
-        @props['Fields'] = {}
-        @props['Fields']['Field'] = []
-
-        @columns.each { |key|
-        @props['Fields']['Field'].push(key)
-        }
-      end
-
-      obj = super
-      @props = originalProps
-      return obj
-    end
-
-    def patch
-      @props['Fields'] = {}
-      @props['Fields']['Field'] = []
-      @columns.each { |key|
-        @props['Fields']['Field'].push(key)
-      }
-      obj = super
-      @props.delete("Fields")
-      return obj
-    end
-
-    class Column < ET_GetSupport
-      def initialize
-        super
-        @obj = 'DataExtensionField'
-      end
-
-      def get
-
-        if props and props.is_a? Array then
-          @props = props
-        end
-
-        if @props and @props.is_a? Hash then
-          @props = @props.keys
-        end
-
-        if filter and filter.is_a? Hash then
-          @filter = filter
-        end
-
-        fixCustomerKey = false
-        if filter and filter.is_a? Hash then
-          @filter = filter
-          if @filter.has_key?("Property") && @filter["Property"] == "CustomerKey" then
-            @filter["Property"]  = "DataExtension.CustomerKey"
-            fixCustomerKey = true
-          end
-        end
-
-        obj = ET_Get.new(@authStub, @obj, @props, @filter)
-        @lastRequestID = obj.request_id
-
-        if fixCustomerKey then
-          @filter["Property"] = "CustomerKey"
-        end
-
-        return obj
-      end
-    end
-
-    class Row < ET_CUDSupport
-      attr_accessor :Name, :CustomerKey
-
-      def initialize()
-        super
-        @obj = "DataExtensionObject"
-      end
-
-      def get
-        getName
-        if props and props.is_a? Array then
-          @props = props
-        end
-
-        if @props and @props.is_a? Hash then
-          @props = @props.keys
-        end
-
-        if filter and filter.is_a? Hash then
-          @filter = filter
-        end
-
-        obj = ET_Get.new(@authStub, "DataExtensionObject[#{@Name}]", @props, @filter)
-        @lastRequestID = obj.request_id
-
-        return obj
-      end
-
-      def post
-        getCustomerKey
-        originalProps = @props
-        ## FIX THIS
-        if @props.is_a? Array then
- #         multiRow = []
- #         @props.each { |currentDE|
-
- #           currentDE['columns'].each { |key|
- #             currentDE['Fields'] = {}
- #             currentDE['Fields']['Field'] = []
- #             currentDE['Fields']['Field'].push(key)
- #           }
- #           currentDE.delete('columns')
- #           multiRow.push(currentDE.dup)
- #         }
-
- #         @props = multiRow
-        else
-          currentFields = []
-          currentProp = {}
-
-          @props.each { |key,value|
-            currentFields.push({"Name" => key, "Value" => value})
-          }
-          currentProp['CustomerKey'] = @CustomerKey
-          currentProp['Properties'] = {}
-          currentProp['Properties']['Property'] = currentFields
-        end
-
-        obj = ET_Post.new(@authStub, @obj, currentProp)
-        @props = originalProps
-        obj
-      end
-
-      def patch
-        getCustomerKey
-        currentFields = []
-        currentProp = {}
-
-        @props.each { |key,value|
-          currentFields.push({"Name" => key, "Value" => value})
-        }
-        currentProp['CustomerKey'] = @CustomerKey
-        currentProp['Properties'] = {}
-        currentProp['Properties']['Property'] = currentFields
-
-        ET_Patch.new(@authStub, @obj, currentProp)
-      end
-      def delete
-        getCustomerKey
-        currentFields = []
-        currentProp = {}
-
-        @props.each { |key,value|
-          currentFields.push({"Name" => key, "Value" => value})
-        }
-        currentProp['CustomerKey'] = @CustomerKey
-        currentProp['Keys'] = {}
-        currentProp['Keys']['Key'] = currentFields
-
-        ET_Delete.new(@authStub, @obj, currentProp)
-      end
-
-      private
-      def getCustomerKey
-        if @CustomerKey.nil? then
-          if @CustomerKey.nil? && @Name.nil? then
-            raise 'Unable to process DataExtension::Row request due to CustomerKey and Name not being defined on ET_DatExtension::row'
-          else
-            de = ET_DataExtension.new
-            de.authStub = @authStub
-            de.props = ["Name","CustomerKey"]
-            de.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => @Name}
-            getResponse = de.get
-            if getResponse.status && (getResponse.results.length == 1) then
-              @CustomerKey = getResponse.results[0][:customer_key]
-            else
-              raise 'Unable to process DataExtension::Row request due to unable to find DataExtension based on Name'
-            end
-          end
-        end
-      end
-
-      def getName
-        if @Name.nil? then
-          if @CustomerKey.nil? && @Name.nil? then
-            raise 'Unable to process DataExtension::Row request due to CustomerKey and Name not being defined on ET_DatExtension::row'
-          else
-            de = ET_DataExtension.new
-            de.authStub = @authStub
-            de.props = ["Name","CustomerKey"]
-            de.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => @CustomerKey}
-            getResponse = de.get
-            if getResponse.status && (getResponse.results.length == 1) then
-              @Name = getResponse.results[0][:name]
-            else
-              raise 'Unable to process DataExtension::Row request due to unable to find DataExtension based on CustomerKey'
-            end
-          end
-        end
-      end
-    end
-  end
-=end

lib/fuelsdk/objects.rb

@@ -56,6 +56,11 @@ class Base
       alias props= properties= # backward compatibility
       alias authStub= client= # backward compatibility
 
+      def properties
+        @properties = [@properties].compact unless @properties.kind_of? Array
+        @properties
+      end
+
       def id
         self.class.id
       end
@@ -148,12 +153,12 @@ class DataExtension < Objects::Base
 
 
     def post
-      munge_fields
+      munge_fields self.properties
       super
     end
 
     def patch
-      munge_fields
+      munge_fields self.properties
       super
     end
 
@@ -182,44 +187,76 @@ class Row < Objects::Base
       alias CustomerKey= customer_key=
 
       def id
-        retrieve_required
         'DataExtensionObject'
       end
 
       def get
+        retrieve_required
+
         super "#{id}[#{name}]"
       end
 
+      def name
+        unless @name
+          retrieve_required
+        end
+        @name
+      end
+
+      def customer_key
+        unless @customer_key
+          retrieve_required
+        end
+        @customer_key
+      end
+
       def post
-        properties = [properties] unless properties.kind_of? Array
-        properties.each do |p|
-          normalized = {}
-          formatted = []
-          p.each do |k, v|
-            p.delete k
-            formatted.concat client.format_attributes k => v
-          end
-          p['CustomerKey'] = customer_key
-          p['Properties'] = {'Property' => formatted
-        }
+        munge_properties self.properties
+        super
+      end
+
+      def patch
+        munge_properties self.properties
         super
       end
 
       private
+        def munge_properties d
+          d.each do |o|
+
+            next if explicit_properties(o) && explicit_customer_key(o)
+
+            formatted = []
+            o.each do |k, v|
+              formatted.concat client.format_name_value_pairs k => v
+              o['Properties'] = {'Property' => formatted }
+              o['CustomerKey'] = customer_key unless explicit_customer_key o
+              o.delete k
+            end
+          end
+        end
+
+        def explicit_properties h
+          h['Properties'] and h['Properties']['Property']
+        end
+
+        def explicit_customer_key h
+          h['CustomerKey']
+        end
+
         def retrieve_required
-          if !name && !customer_key
+          # have to use instance variables so we don't recursivelly retrieve_required
+          if !@name && !@customer_key
             raise 'Unable to process DataExtension::Row ' \
               'request due to missing CustomerKey and Name'
           end
-          if !name || !customer_key
-            de = DataExtension.new
-            de.client = client
-            de.filter = {
-              'Property' => name.nil? ? 'CustomerKey' : 'Name',
+          if !@name || !@customer_key
+            filter = {
+              'Property' => @name.nil? ? 'CustomerKey' : 'Name',
               'SimpleOperator' => 'equals',
-              'Value' => customer_key || name
+              'Value' => @customer_key || @name
             }
-            rsp = de.get
+            rsp = client.soap_get 'DataExtension', ['Name', 'CustomerKey'], filter
             if rsp.success? && rsp.results.count == 1
               self.name = rsp.results.first[:name]
               self.customer_key = rsp.results.first[:customer_key]
@@ -232,16 +269,16 @@ def retrieve_required
 
     private
 
-      def munge_fields
-        if self.properties.kind_of? Array and (fields and !fields.empty?)
+      def munge_fields d
+        # maybe one day will make it smart enough to zip properties and fields if count is same?
+        if d.kind_of? Array and d.count > 1 and (fields and !fields.empty?)
           # we could map the field to all DataExtensions, but lets make user be explicit.
           # if they are going to use fields attribute properties should
           # be a single DataExtension Defined in a Hash
           raise 'Unable to handle muliple DataExtension definitions and a field definition'
         end
 
-        self.properties = [self.properties] unless self.properties.kind_of? Array
-        self.properties.each do |de|
+        d.each do |de|
 
           if (explicit_fields(de) and (de['columns'] || de['fields'] || has_fields)) or
             (de['columns'] and (de['fields'] || has_fields)) or
@@ -260,8 +297,8 @@ def munge_fields
         end
       end
 
-      def explicit_fields de
-        de['Fields'] and de['Fields']['Field']
+      def explicit_fields h
+        h['Fields'] and h['Fields']['Field']
       end
 
       def has_fields