exact_target_sdk 0.2.0 → 0.3.0

data/CHANGELOG.rdoc

@@ -1,5 +1,8 @@
 = ExactTarget SDK
 
+== Version 0.3.0
+* Implementing Update method
+
 == Version 0.2.0
 * Adding Attribute object
 * Adding Attributes property to TriggeredSend

data/README.rdoc

@@ -10,9 +10,9 @@ outlined in the guide linked above are used. This is done in an attempt to be
 as transparent as possible, so that the API may be used by referring only to
 the guide linked above.
 
-Note this SDK is currently very incomplete, allowing you only to create
-subscribers and trigger sends. The framework is in place, however, to very
-easily implement new objects by simply declaring their properties.
+Note this SDK is currently very incomplete, allowing you only to create and
+update subscribers and trigger sends. The framework is in place, however, to
+very easily implement new objects by simply declaring their properties.
 
 == Synopsis:
 

data/lib/exact_target_sdk.rb

@@ -11,5 +11,7 @@ module ExactTargetSDK
   autoload :Subscriber, 'exact_target_sdk/subscriber'
   autoload :TriggeredSend, 'exact_target_sdk/triggered_send'
   autoload :TriggeredSendDefinition, 'exact_target_sdk/triggered_send_definition'
+  autoload :UpdateResponse, 'exact_target_sdk/update_response'
+  autoload :UpdateResult, 'exact_target_sdk/update_result'
 
 end

data/lib/exact_target_sdk/client.rb

@@ -64,6 +64,38 @@ class Client
     CreateResponse.new(response)
   end
 
+  # Invokes the Update method.
+  #
+  # The provided arguments should each be sub-classes of APIObject, and each
+  # provided object will be updated in order.
+  #
+  # 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 an UpdateResponse object.
+  def Update(*args)
+    # TODO: implement and accept UpdateOptions
+
+    api_objects = args
+
+    response = execute_request 'Update' do |xml|
+      xml.UpdateRequest do
+        xml.Options  # TODO: support UpdateOptions
+
+        api_objects.each do |api_object|
+          xml.Objects "xsi:type" => api_object.type_name do
+            api_object.render!(xml)
+          end
+        end
+      end
+    end
+
+    UpdateResponse.new(response)
+  end
+
   def logger
     config[:logger]
   end

data/lib/exact_target_sdk/update_response.rb

@@ -0,0 +1,25 @@
+module ExactTargetSDK
+class UpdateResponse
+
+  attr_reader :OverallStatus, :RequestID, :Results
+
+  def initialize(response)
+    response = response.to_hash[:update_response]
+    @OverallStatus = response[:overall_status]
+    @RequestID = response[:request_id]
+    @Results = []
+
+    results = if response[:results].is_a? Array
+      response[:results]
+    elsif response[:results].is_a? Hash
+      [ response[:results] ]
+    else
+      []
+    end
+    results.each do |result|
+      @Results << UpdateResult.new(result)
+    end
+  end
+
+end
+end

data/lib/exact_target_sdk/update_result.rb

@@ -0,0 +1,23 @@
+require 'active_support/inflector'
+
+module ExactTargetSDK
+class UpdateResult
+
+  PROPERTIES = [
+    'StatusCode',
+    'StatusMessage',
+    'ErrorCode'
+  ]
+
+  PROPERTIES.each do |property|
+    attr_reader property
+  end
+
+  def initialize(hash)
+    PROPERTIES.each do |property|
+      instance_variable_set("@#{property}", hash[property.underscore.to_sym])
+    end
+  end
+
+end
+end

data/lib/exact_target_sdk/version.rb

@@ -1,3 +1,3 @@
 module ExactTargetSDK
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: exact_target_sdk
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - David Dawson
@@ -98,6 +98,8 @@ files:
 - lib/exact_target_sdk/subscriber.rb
 - lib/exact_target_sdk/triggered_send.rb
 - lib/exact_target_sdk/triggered_send_definition.rb
+- lib/exact_target_sdk/update_response.rb
+- lib/exact_target_sdk/update_result.rb
 - lib/exact_target_sdk/version.rb
 - lib/exact_target_sdk.rb
 - README.rdoc