exact_target_sdk 0.7.0 → 0.8.0

data/CHANGELOG.rdoc

@@ -1,5 +1,15 @@
 = ExactTarget SDK
 
+== Version 0.8.0
+* Implemented APIProperty object
+* Implemented DataExtension object
+* Implemented DataExtensionField object
+* Implemented DataExtensionObject object
+* Implemented Perform method
+* Implemented PerformResponse object
+* Refactored property, array_property, and int_property to accept options
+* Allowed array_properties to be specified as nested
+
 == Version 0.7.0
 * Implemented Client#Delete method
 

data/lib/exact_target_sdk.rb

@@ -4,15 +4,20 @@ require 'exact_target_sdk/errors'
 module ExactTargetSDK
 
   autoload :APIObject, 'exact_target_sdk/api_object'
+  autoload :APIProperty, 'exact_target_sdk/api_property'
   autoload :Attribute, 'exact_target_sdk/attribute'
   autoload :Client, 'exact_target_sdk/client'
   autoload :ComplexFilterPart, 'exact_target_sdk/complex_filter_part'
   autoload :ContentArea, 'exact_target_sdk/content_area'
   autoload :CreateResponse, 'exact_target_sdk/create_response'
   autoload :CreateResult, 'exact_target_sdk/create_result'
+  autoload :DataExtension, 'exact_target_sdk/data_extension'
+  autoload :DataExtensionField, 'exact_target_sdk/data_extension_field'
+  autoload :DataExtensionObject, 'exact_target_sdk/data_extension_object'
   autoload :DeleteResponse, 'exact_target_sdk/delete_response'
   autoload :DeleteResult, 'exact_target_sdk/delete_result'
   autoload :FilterPart, 'exact_target_sdk/filter_part'
+  autoload :PerformResponse, 'exact_target_sdk/perform_response'
   autoload :Result, 'exact_target_sdk/result'
   autoload :RetrieveResponse, 'exact_target_sdk/retrieve_response'
   autoload :RetrieveResult, 'exact_target_sdk/retrieve_result'

data/lib/exact_target_sdk/api_object.rb

@@ -1,4 +1,5 @@
 require 'active_model'
+require 'active_support/inflector'
 
 module ExactTargetSDK
 
@@ -18,7 +19,11 @@ class APIObject
     #
     # Provides a getter and setter for this property, keeping track of
     # whether or not it has been set and registering it for rendering.
-    def property(name, required = false)
+    def property(name, options = {})
+      options = {
+        :required => false
+      }.merge(options)
+
       name = name.to_s
       attr_reader name.to_sym
       class_eval <<-__EOF__
@@ -27,10 +32,10 @@ class APIObject
           @#{name} = value
         end
       __EOF__
-      if required
+      if options[:required]
         validates name.to_sym, :presence => true
       end
-      register_property!(name)
+      register_property!(name, options)
     end
 
     # Declares a property as an array of values.
@@ -41,9 +46,15 @@ class APIObject
     #
     # Note that once the property has been either read or written to, it
     # will be rendered.
-    def array_property(name)
+    def array_property(name, options = {})
       # TODO: type validation would be nice
       name = name.to_s
+
+      options = {
+        :nest_children => false,
+        :singular => name.singularize
+      }.merge(options)
+
       class_eval <<-__EOF__
         def #{name}
           @_set_#{name} = true
@@ -54,19 +65,22 @@ class APIObject
           @#{name} = value
         end
       __EOF__
-      register_property!(name)
+      register_property!(name, options)
     end
 
     # Same as #property, adding validation the the provided value is an
     # integer.
-    def int_property(name, required = false)
-      property(name, required)
+    def int_property(name, options = {})
+      options = {
+        :required => false
+      }.merge(options)
+      property(name, options)
       validates name.to_sym, :numericality => { :allow_nil => true, :only_integer => true }
     end
 
     # Returns an array of all registered properties.
     def properties
-      @properties || []
+      @properties || {}
     end
 
     def type_name
@@ -76,10 +90,9 @@ class APIObject
     private
 
     # Stores the given property name to be used at render time.
-    def register_property!(name)
-      @properties ||= []
-      @properties << name
-      @properties.uniq!
+    def register_property!(name, options = {})
+      @properties ||= {}
+      @properties[name] = options
     end
 
   end
@@ -115,21 +128,31 @@ class APIObject
   #
   # May be overridden.
   def render_properties!(xml)
-    self.class.properties.each do |property|
+    self.class.properties.each do |property, options|
       next unless instance_variable_get("@_set_#{property}")
       property_value = self.send(property)
-      render_property!(property, property_value, xml)
+      render_property!(property, property_value, xml, options)
     end
   end
 
-  def render_property!(property_name, property_value, xml)
+  def render_property_array!(property_name, array, xml)
+    array.each do |current|
+      render_property!(property_name, current, xml)
+    end
+  end
+
+  def render_property!(property_name, property_value, xml, options = {})
     if property_value.is_a?(APIObject)
       xml.__send__(property_name, { "xsi:type" => property_value.type_name } ) do
         property_value.render!(xml)
       end
     elsif property_value.is_a?(Array)
-      property_value.each do |current|
-        render_property!(property_name, current, xml)
+      if options[:nest_children]
+        xml.__send__(property_name) do
+          render_property_array!(options[:singular], property_value, xml)
+        end
+      else
+        render_property_array!(property_name, property_value, xml)
       end
     else
       xml.__send__(property_name, property_value.to_s)

data/lib/exact_target_sdk/api_property.rb

@@ -0,0 +1,8 @@
+module ExactTargetSDK
+class APIProperty < APIObject
+
+  property 'Name'
+  property 'Value'
+
+end
+end

data/lib/exact_target_sdk/attribute.rb

@@ -1,7 +1,7 @@
 module ExactTargetSDK
 class Attribute < APIObject
 
-  property 'Name', true
+  property 'Name', :required => true
   property 'Value'
 
 end

data/lib/exact_target_sdk/client.rb

@@ -167,6 +167,42 @@ class Client
     DeleteResponse.new(response)
   end
 
+  # Invokes the Perform method.
+  #
+  # The provided arguments should each be definitions that are sub-classes
+  # of APIObject.
+  #
+  # Possible exceptions are:
+  #   HTTPError         if an HTTP error (such as a timeout) occurs
+  #   SOAPFault         if a SOAP fault occurs
+  #   Timeout           if there is a timeout waiting for the response
+  #   InvalidAPIObject  if any of the provided objects don't pass validation
+  #
+  # Returns a PerformResponse object.
+  def Perform(action, *args)
+    # TODO: implement and accept PerformOptions
+
+    definitions = args
+
+    response = execute_request 'Perform' do |xml|
+      xml.PerformRequestMsg do
+        xml.Action action
+
+        xml.Definitions do
+          definitions.each do |definition|
+            xml.Definition "xsi:type" => definition.type_name do
+              definition.render!(xml)
+            end
+          end
+        end
+
+        xml.Options  # TODO: support PerformOptions
+      end
+    end
+
+    PerformResponse.new(response)
+  end
+
   def logger
     config[:logger]
   end

data/lib/exact_target_sdk/complex_filter_part.rb

@@ -1,9 +1,9 @@
 module ExactTargetSDK
 class ComplexFilterPart < FilterPart
 
-  property 'LeftOperand', true
-  property 'LogicalOperator', true
-  property 'RightOperand', true
+  property 'LeftOperand', :required => true
+  property 'LogicalOperator', :required => true
+  property 'RightOperand', :required => true
 
 end
 end

data/lib/exact_target_sdk/data_extension.rb

@@ -0,0 +1,9 @@
+module ExactTargetSDK
+class DataExtension < APIObject
+
+  property 'CustomerKey'
+  array_property 'Fields', :nest_children => true
+  property 'Name'
+
+end
+end

data/lib/exact_target_sdk/data_extension_field.rb

@@ -0,0 +1,12 @@
+module ExactTargetSDK
+class DataExtensionField < APIObject
+
+  property 'CustomerKey'
+  property 'FieldType'
+  property 'IsRequired'
+  property 'IsPrimaryKey'
+  property 'MaxLength'
+  property 'Name'
+
+end
+end

data/lib/exact_target_sdk/data_extension_object.rb

@@ -0,0 +1,8 @@
+module ExactTargetSDK
+class DataExtensionObject < APIObject
+
+  property 'CustomerKey'
+  array_property 'Properties', :nest_children => true
+
+end
+end

data/lib/exact_target_sdk/perform_response.rb

@@ -0,0 +1,14 @@
+module ExactTargetSDK
+class PerformResponse
+
+  attr_reader :OverallStatus, :OverallStatusMessage, :RequestID
+
+  def initialize(response)
+    response = response.to_hash[:perform_response_msg]
+    @OverallStatus = response[:overall_status]
+    @OverallStatusMessage = response[:overall_status_message]
+    @RequestID = response[:request_id]
+  end
+
+end
+end

data/lib/exact_target_sdk/simple_filter_part.rb

@@ -1,8 +1,8 @@
 module ExactTargetSDK
 class SimpleFilterPart < FilterPart
 
-  property 'Property', true
-  property 'SimpleOperator', true
+  property 'Property', :required => true
+  property 'SimpleOperator', :required => true
   array_property 'Value'
 
 end

data/lib/exact_target_sdk/subscriber.rb

@@ -13,8 +13,8 @@ module ExactTargetSDK
 # new email address.
 class Subscriber < APIObject
 
-  property 'SubscriberKey', true
-  property 'EmailAddress', true
+  property 'SubscriberKey', :required => true
+  property 'EmailAddress', :required => true
   property 'EmailTypePreference'
   array_property 'Attributes'
 

data/lib/exact_target_sdk/triggered_send.rb

@@ -3,7 +3,7 @@ class TriggeredSend < APIObject
 
   array_property 'Attributes'
   array_property 'Subscribers'
-  property 'TriggeredSendDefinition', true
+  property 'TriggeredSendDefinition', :required => true
 
 end
 end

data/lib/exact_target_sdk/triggered_send_definition.rb

@@ -1,7 +1,7 @@
 module ExactTargetSDK
 class TriggeredSendDefinition < APIObject
 
-  property 'CustomerKey', true
+  property 'CustomerKey', :required => true
 
 end
 end

data/lib/exact_target_sdk/version.rb

@@ -1,3 +1,3 @@
 module ExactTargetSDK
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: exact_target_sdk
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 63
   prerelease: 
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - David Dawson
@@ -89,6 +89,7 @@ extra_rdoc_files:
 - LICENSE.txt
 files: 
 - lib/exact_target_sdk/api_object.rb
+- lib/exact_target_sdk/api_property.rb
 - lib/exact_target_sdk/attribute.rb
 - lib/exact_target_sdk/client.rb
 - lib/exact_target_sdk/complex_filter_part.rb
@@ -96,10 +97,14 @@ files:
 - lib/exact_target_sdk/content_area.rb
 - lib/exact_target_sdk/create_response.rb
 - lib/exact_target_sdk/create_result.rb
+- lib/exact_target_sdk/data_extension.rb
+- lib/exact_target_sdk/data_extension_field.rb
+- lib/exact_target_sdk/data_extension_object.rb
 - lib/exact_target_sdk/delete_response.rb
 - lib/exact_target_sdk/delete_result.rb
 - lib/exact_target_sdk/errors.rb
 - lib/exact_target_sdk/filter_part.rb
+- lib/exact_target_sdk/perform_response.rb
 - lib/exact_target_sdk/result.rb
 - lib/exact_target_sdk/retrieve_response.rb
 - lib/exact_target_sdk/retrieve_result.rb