fuelsdk 0.0.4 → 0.0.5

data/lib/fuelsdk.rb

@@ -5,6 +5,7 @@ require 'date'
 require 'jwt'
 
 module FuelSDK
+  require 'fuelsdk/utils'
   autoload :HTTPRequest, 'fuelsdk/http_request'
   autoload :Targeting, 'fuelsdk/targeting'
   autoload :Soap, 'fuelsdk/soap'
@@ -18,6 +19,7 @@ ET_Client = FuelSDK::Client
 ET_BounceEvent = FuelSDK::BounceEvent
 ET_ClickEvent = FuelSDK::ClickEvent
 ET_ContentArea = FuelSDK::ContentArea
+ET_DataExtension = FuelSDK::DataExtension
 ET_DataFolder = FuelSDK::DataFolder
 ET_Folder = FuelSDK::Folder
 ET_Email = FuelSDK::Email
@@ -28,227 +30,3 @@ ET_Subscriber = FuelSDK::Subscriber
 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

data/lib/fuelsdk/client.rb

@@ -100,42 +100,26 @@ module FuelSDK
       refresh true
     end
 
-    #def AddSubscriberToList(emailAddress, listIDs, subscriberKey = nil)
-    #  newSub = FuelSDK::ET_Subscriber.new
-    #  newSub.authStub = self
-    #  lists = []
-
-    #  listIDs.each{ |p|
-    #    lists.push({"ID"=> p})
-    #  }
-
-    #  newSub.props = {"EmailAddress" => emailAddress, "Lists" => lists}
-    #  if !subscriberKey.nil? then
-    #    newSub.props['SubscriberKey']  = subscriberKey;
-    #  end
-
-    #  # Try to add the subscriber
-    #  postResponse = newSub.post
-
-    #  if postResponse.status == false then
-    #    # If the subscriber already exists in the account then we need to do an update.
-    #    # Update Subscriber On List
-    #    if postResponse.results[0][:error_code] == "12014" then
-    #      patchResponse = newSub.patch
-    #      return patchResponse
-    #    end
-    #  end
-    #  return postResponse
-    #end
-
-    #def CreateDataExtensions(dataExtensionDefinitions)
-    #  newDEs = FuelSDK::ET_DataExtension.new
-    #  newDEs.authStub = self
-
-    #  newDEs.props = dataExtensionDefinitions
-    #  postResponse = newDEs.post
-
-    #  return postResponse
-    #end
+    def AddSubscriberToList(email, ids, subscriber_key = nil)
+      s = FuelSDK::Subscriber.new
+      s.client = self
+      lists = ids.collect{|id| {'ID' => id}}
+      s.properties = {"EmailAddress" => email, "Lists" => lists}
+      s.propertiess['SubscriberKey'] = subscriber_key if subscriber_key
+
+      # Try to add the subscriber
+      if(rsp = s.post and rsp.results.first[:error_code] == '12014')
+        # subscriber already exists we need to update.
+        rsp = s.patch
+      end
+      rsp
+    end
+
+    def CreateDataExtensions(definitions)
+      de = FuelSDK::DataExtension.new
+      de.client = self
+      de.properties = definitions
+      de.post
+    end
   end
 end

data/lib/fuelsdk/objects.rb

@@ -1,56 +1,66 @@
 module FuelSDK
   module Objects
-    module SoapRead
-      def get
-        client.soap_get id, properties, filter
-      end
+    module Soap
+      module Read
+        attr_accessor :filter
+        def get _id=nil
+          client.soap_get _id||id, properties, filter
+        end
 
-      def info
-        client.soap_describe id
+        def info
+          client.soap_describe id
+        end
       end
-    end
 
-    module SoapCUD #create, update, delete
-      def post
-        client.soap_post id, properties
-      end
+      module CUD #create, update, delete
+        def post
+          client.soap_post id, properties
+        end
 
-      def patch
-        client.soap_patch id, properties
-      end
+        def patch
+          client.soap_patch id, properties
+        end
 
-      def delete
-        client.soap_delete id, properties
+        def delete
+          client.soap_delete id, properties
+        end
       end
     end
 
-    module RestRead
-      def get
-        client.rest_get id, properties
+    module Rest
+      module Read
+        def get
+          client.rest_get id, properties
+        end
       end
-    end
 
-    module RestCUD
-      def post
-        client.rest_post id, properties
-      end
+      module CUD
+        def post
+          client.rest_post id, properties
+        end
 
-      def patch
-        client.rest_patch id, properties
-      end
+        def patch
+          client.rest_patch id, properties
+        end
 
-      def delete
-        client.rest_delete id, properties
+        def delete
+          client.rest_delete id, properties
+        end
       end
     end
 
     class Base
-      attr_accessor :filter, :properties, :client
+      attr_accessor :properties, :client
       attr_reader :id
 
       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
@@ -64,21 +74,21 @@ module FuelSDK
   end
 
   class BounceEvent < Objects::Base
-    include Objects::SoapRead
+    include Objects::Soap::Read
   end
 
   class ClickEvent < Objects::Base
-    include Objects::SoapRead
+    include Objects::Soap::Read
   end
 
   class ContentArea < Objects::Base
-    include Objects::SoapRead
-    include Objects::SoapCUD
+    include Objects::Soap::Read
+    include Objects::Soap::CUD
   end
 
   class DataFolder < Objects::Base
-    include Objects::SoapRead
-    include Objects::SoapCUD
+    include Objects::Soap::Read
+    include Objects::Soap::CUD
   end
 
   class Folder < DataFolder
@@ -90,16 +100,16 @@ module FuelSDK
   end
 
   class Email < Objects::Base
-    include Objects::SoapRead
-    include Objects::SoapCUD
+    include Objects::Soap::Read
+    include Objects::Soap::CUD
   end
 
   class List < Objects::Base
-    include Objects::SoapRead
-    include Objects::SoapCUD
+    include Objects::Soap::Read
+    include Objects::Soap::CUD
 
     class Subscriber < Objects::Base
-      include Objects::SoapRead
+      include Objects::Soap::Read
       def id
         'ListSubscriber'
       end
@@ -107,26 +117,26 @@ module FuelSDK
   end
 
   class OpenEvent < Objects::Base
-    include Objects::SoapRead
+    include Objects::Soap::Read
   end
 
   class SentEvent < Objects::Base
-    include Objects::SoapRead
+    include Objects::Soap::Read
   end
 
   class Subscriber < Objects::Base
-    include Objects::SoapRead
-    include Objects::SoapCUD
+    include Objects::Soap::Read
+    include Objects::Soap::CUD
   end
 
   class UnsubEvent < Objects::Base
-    include Objects::SoapRead
+    include Objects::Soap::Read
   end
 
   class TriggeredSend < Objects::Base
+    include Objects::Soap::Read
+    include Objects::Soap::CUD
     attr_accessor :subscribers
-    include Objects::SoapRead
-    include Objects::SoapCUD
     def id
       'TriggeredSendDefinition'
     end
@@ -135,9 +145,199 @@ module FuelSDK
     end
   end
 
+  class DataExtension < Objects::Base
+    include Objects::Soap::Read
+    include Objects::Soap::CUD
+    attr_accessor :fields
+    alias columns= fields= # backward compatibility
+
+    def post
+      munge_fields self.properties
+      super
+    end
+
+    def patch
+      munge_fields self.properties
+      super
+    end
+
+    class Column < Objects::Base
+      include Objects::Soap::Read
+      def id
+        'DataExtensionField'
+      end
+      def get
+        if filter and filter.kind_of? Hash and \
+          filter.include? 'Property' and filter['Property'] == 'CustomerKey'
+          filter['Property'] = 'DataExtension.CustomerKey'
+        end
+        super
+      end
+    end
+
+    class Row < Objects::Base
+      include Objects::Soap::Read
+      include Objects::Soap::CUD
+
+      attr_accessor :name, :customer_key
+
+      # backward compatibility
+      alias Name= name=
+      alias CustomerKey= customer_key=
+
+      def id
+        'DataExtensionObject'
+      end
+
+      def get
+        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
+        munge_properties self.properties
+        super
+      end
+
+      def patch
+        munge_properties self.properties
+        super
+      end
+
+      def delete
+        munge_keys self.properties
+        super
+      end
+
+      private
+        #::TODO::
+        # opportunity for meta programming here... but need to get this out the door
+        def munge_keys d
+          d.each do |o|
+
+            next if explicit_keys(o) && explicit_customer_key(o)
+
+            formatted = []
+            o['CustomerKey'] = customer_key unless explicit_customer_key o
+            unless explicit_properties(o)
+              o.each do |k, v|
+                next if k == 'CustomerKey'
+                formatted.concat FuelSDK.format_name_value_pairs k => v
+                o.delete k
+              end
+              o['Keys'] = {'Key' => formatted }
+            end
+          end
+        end
+
+        def explicit_keys h
+          h['Keys'] and h['Keys']['Key']
+        end
+
+        def munge_properties d
+          d.each do |o|
+
+            next if explicit_properties(o) && explicit_customer_key(o)
+
+            formatted = []
+            o['CustomerKey'] = customer_key unless explicit_customer_key o
+            unless explicit_properties(o)
+              o.each do |k, v|
+                next if k == 'CustomerKey'
+                formatted.concat FuelSDK.format_name_value_pairs k => v
+                o.delete k
+              end
+              o['Properties'] = {'Property' => formatted }
+            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
+          # 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
+            filter = {
+              'Property' => @name.nil? ? 'CustomerKey' : 'Name',
+              'SimpleOperator' => 'equals',
+              'Value' => @customer_key || @name
+            }
+            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]
+            else
+              raise 'Unable to process DataExtension::Row'
+            end
+          end
+        end
+    end
+
+    private
+
+      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
+
+        d.each do |de|
+
+          if (explicit_fields(de) and (de['columns'] || de['fields'] || has_fields)) or
+            (de['columns'] and (de['fields'] || has_fields)) or
+            (de['fields'] and has_fields)
+            raise 'Fields are defined in too many ways. Please only define once.' # ahhh what, to do...
+          end
+
+          # let users who chose, to define fields explicitly within the hash definition
+          next if explicit_fields de
+
+          de['Fields'] = {'Field' => de['columns'] || de['fields'] || fields}
+          # sanitize
+          de.delete 'columns'
+          de.delete 'fields'
+          raise 'DataExtension needs atleast one field.' unless de['Fields']['Field']
+        end
+      end
+
+      def explicit_fields h
+        h['Fields'] and h['Fields']['Field']
+      end
+
+      def has_fields
+        fields and !fields.empty?
+      end
+  end
+
   class Campaign < Objects::Base
-    include Objects::RestRead
-    include Objects::RestCUD
+    include Objects::Rest::Read
+    include Objects::Rest::CUD
 
     def properties
       @properties ||= {}
@@ -150,8 +350,8 @@ module FuelSDK
     end
 
     class Asset < Objects::Base
-      include Objects::RestRead
-      include Objects::RestCUD
+      include Objects::Rest::Read
+      include Objects::Rest::CUD
 
       def properties
         @properties ||= {}