fuelsdk 0.0.3 → 0.0.4

data/README.md

@@ -18,22 +18,25 @@ gem 'fuelsdk'
 
 If you have not registered your application or you need to lookup your Application Key or Application Signature values, please go to App Center at [Code@: ExactTarget's Developer Community](http://code.exacttarget.com/appcenter "Code@ App Center").
 
+## Backwards Compatibility ##
+Previous versions of the Fuel SDK exposed objects with the prefix "ET_". For backwards compatibility you can still access objects this way.
+Subscriber can be accessed FuelSDK::Subscriber or ET_Subscriber.
+
 ## Example Request ##
-All ExactTarget objects exposed through the Fuel SDK begin with be prefixed with "ET\_".  Start by working with the ET_List object:
 
 Add a require statement to reference the Fuel SDK's functionality:
 > require 'fuelsdk'
 
-Next, create an instance of the ET_Client class:
-> myClient = FuelSDK::ET_Client.new {'client' => { 'id' => CLIENTID, 'secret' => SECRET }}
+Next, create an instance of the Client class:
+> myClient = FuelSDK::Client.new {'client' => { 'id' => CLIENTID, 'secret' => SECRET }}
 
 Create an instance of the object type we want to work with:
-> list = FuelSDK::ET_List.new
+> list = FuelSDK::List.new
 
-Associate the ET_Client to the object using the authStub property:
-> list.authStub = myClient
+Associate the Client to the object using the client property:
+> list.client = myClient
 
-Utilize one of the ET_List methods:
+Utilize one of the List methods:
 > response = list.get
 
 Print out the results for viewing
@@ -42,36 +45,34 @@ Print out the results for viewing
 **Example Output:**
 
 <pre>
-#&lt;ET_Get:0x355bc48
-	@results=[
-		{
-			:client=>{
-				:id=>"1000001",
-				:partner_client_key=>nil
-				},
-			:partner_key=>nil,
-			:created_date=>#&lt;DateTime: 2009-06-12T14:42:06+00:00 ((2454995j,52926s,100000000n),+0s,2299161j)&gt;,
-			:modified_date=>#&lt;DateTime: 2011-08-17T14:50:30+00:00 ((2455791j,53430s,697000000n),+0s,2299161j)&gt;,
-			:id=>"1718921",
-			:object_id=>"f41c7d1b-8957-de11-92ee-001cc494ae9e",
-			:customer_key=>"All Subscribers - 578623",
-			:list_name=>"All Subscribers",
-			:category=>"578623",
-			:type=>"Private",
-			:description=>"Contains all subscribers",
-			:list_classification=>"ExactTargetList",
-			:"@xsi:type"=>"List"}
-		],
-	@code=200,
-	@success?=true,
-	@more?=false,
-	@request_id="41f0f293-954f-4ac7-8e7a-0a5756022218"
->
+<FuelSDK::SoapResponse:0x007fb86abcf190
+ @body= {:retrieve_response_msg=> {:overall_status=>"OK", :request_id=>"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", :results=>..}
+ @code= 200,
+ @message= 'OK',
+ @request_id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+ @results=
+  [{:client=>{:id=>"xxxx"},
+    :partner_key=>nil,
+    :created_date=>
+     #<DateTime: 2013-05-30T23:02:00+00:00 ((2456443j,82920s,0n),+0s,2299161j)>,
+    :id=>"xxxx",
+    :object_id=>nil,
+    :email_address=>"xxxx",
+    :attributes=>
+     [{:name=>"Full Name", :value=>"Justin Barber"},
+      {:name=>"Gender", :value=>nil},
+      {:name=>"Email Address", :value=>"xxx"},
+      {:name=>"User Defined", :value=>"02/02/1982"}],
+    :subscriber_key=>"xxxx",
+    :status=>"Active",
+    :email_type_preference=>"HTML",
+    :"@xsi:type"=>"Subscriber"},
+ @success=true>
 </pre>
 
-## ET\_Client Class ##
+## Client Class ##
 
-The ET\_Client class takes care of many of the required steps when accessing ExactTarget's API, including retrieving appropriate access tokens, handling token state for managing refresh, and determining the appropriate endpoints for API requests.  In order to leverage the advantages this class provides, use a single instance of this class for an entire session.  Do not instantiate a new ET_Client object for each request made.
+The Client class takes care of many of the required steps when accessing ExactTarget's API, including retrieving appropriate access tokens, handling token state for managing refresh, and determining the appropriate endpoints for API requests.  In order to leverage the advantages this class provides, use a single instance of this class for an entire session.  Do not instantiate a new Client object for each request made.
 
 ## Responses ##
 All methods on Fuel SDK objects return a generic object that follows the same structure, regardless of the type of call.  This object contains a common set of properties used to display details about the request.
@@ -80,9 +81,6 @@ All methods on Fuel SDK objects return a generic object that follows the same st
 - code: HTTP Error Code (will always be 200 for SOAP requests)
 - message: Text values containing more details in the event of an error
 - results: Collection containing the details unique to the method called.
-
-Get Methods also return an addition value to indicate if more information is available (that information can be retrieved using the getMoreResults method):
-
  - more? - Boolean value that indicates on Get requests if more data is available.
 
 

data/lib/fuelsdk.rb

@@ -13,6 +13,22 @@ module FuelSDK
   require 'fuelsdk/objects'
 end
 
+# backwards compatability
+ET_Client = FuelSDK::Client
+ET_BounceEvent = FuelSDK::BounceEvent
+ET_ClickEvent = FuelSDK::ClickEvent
+ET_ContentArea = FuelSDK::ContentArea
+ET_DataFolder = FuelSDK::DataFolder
+ET_Folder = FuelSDK::Folder
+ET_Email = FuelSDK::Email
+ET_List = FuelSDK::List
+ET_OpenEvent = FuelSDK::OpenEvent
+ET_SentEvent = FuelSDK::SentEvent
+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

data/lib/fuelsdk/client.rb

@@ -1,5 +1,5 @@
 module FuelSDK
-  class ET_Response
+  class Response
     # not doing accessor so user, can't update these values from response.
     # You will see in the code some of these
     # items are being updated via back doors and such.
@@ -21,7 +21,6 @@ module FuelSDK
       @client = client # keep connection with client in case we request more
       @results = []
       @raw = raw
-      @body = raw.body
       unpack raw
     rescue => ex # all else fails return raw
       puts ex.message
@@ -38,7 +37,7 @@ module FuelSDK
       end
   end
 
-  class ET_Client
+  class Client
     attr_accessor :debug, :access_token, :auth_token, :internal_token, :refresh_token,
       :id, :secret, :signature
 

data/lib/fuelsdk/http_request.rb

@@ -4,7 +4,7 @@ require 'json'
 
 module FuelSDK
 
-  class HTTPResponse < FuelSDK::ET_Response
+  class HTTPResponse < FuelSDK::Response
 
     def initialize raw, client, request
       super raw, client

data/lib/fuelsdk/objects.rb

@@ -1,119 +1,132 @@
 module FuelSDK
-  module ET_SoapGet
-    def get
-      client.soap_get id, properties, filter
-    end
+  module Objects
+    module SoapRead
+      def get
+        client.soap_get id, properties, filter
+      end
 
-    def info
-      client.soap_describe id
+      def info
+        client.soap_describe id
+      end
     end
-  end
 
-  module ET_SoapCUD #create, update, delete
-    def post
-      client.soap_post id, properties
-    end
+    module SoapCUD #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 ET_RestGet
-    def get
-      client.rest_get id, properties
+    module RestRead
+      def get
+        client.rest_get id, properties
+      end
     end
-  end
 
-  module ET_RestCUD
-    def post
-      client.rest_post id, properties
-    end
+    module RestCUD
+      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 ET_Base
-    attr_accessor :filter, :properties, :client
-    attr_reader :id
+    class Base
+      attr_accessor :filter, :properties, :client
+      attr_reader :id
 
-    alias props= properties= # backward compatibility
-    alias authStub= client= # backward compatibility
+      alias props= properties= # backward compatibility
+      alias authStub= client= # backward compatibility
 
-    def id
-      self.class.name.split('::').pop.split('_').pop
+      def id
+        self.class.id
+      end
+
+      class << self
+        def id
+          self.name.split('::').pop
+        end
+      end
     end
   end
 
-  class ET_BounceEvent < ET_Base
-    include ET_SoapGet
+  class BounceEvent < Objects::Base
+    include Objects::SoapRead
   end
 
-  class ET_ClickEvent < ET_Base
-    include ET_SoapGet
+  class ClickEvent < Objects::Base
+    include Objects::SoapRead
   end
 
-  class ET_ContentArea < ET_Base
-    include ET_SoapGet
-    include ET_SoapCUD
+  class ContentArea < Objects::Base
+    include Objects::SoapRead
+    include Objects::SoapCUD
   end
 
-  class ET_Folder < ET_Base
-    include ET_SoapGet
-    include ET_SoapCUD
-    def id
-      'DataFolder'
+  class DataFolder < Objects::Base
+    include Objects::SoapRead
+    include Objects::SoapCUD
+  end
+
+  class Folder < DataFolder
+    class << self
+      def id
+        DataFolder.id
+      end
     end
   end
 
-  class ET_Email < ET_Base
-    include ET_SoapGet
-    include ET_SoapCUD
+  class Email < Objects::Base
+    include Objects::SoapRead
+    include Objects::SoapCUD
   end
 
-  class ET_List < ET_Base
-    include ET_SoapGet
-    include ET_SoapCUD
+  class List < Objects::Base
+    include Objects::SoapRead
+    include Objects::SoapCUD
 
-    class Subscriber < ET_Base
-      include ET_SoapGet
+    class Subscriber < Objects::Base
+      include Objects::SoapRead
       def id
         'ListSubscriber'
       end
     end
   end
 
-  class ET_OpenEvent < ET_Base
-    include ET_SoapGet
+  class OpenEvent < Objects::Base
+    include Objects::SoapRead
   end
 
-  class ET_SentEvent < ET_Base
-    include ET_SoapGet
+  class SentEvent < Objects::Base
+    include Objects::SoapRead
   end
 
-  class ET_Subscriber < ET_Base
-    include ET_SoapGet
-    include ET_SoapCUD
+  class Subscriber < Objects::Base
+    include Objects::SoapRead
+    include Objects::SoapCUD
   end
 
-  class ET_UnsubEvent < ET_Base
-    include ET_SoapGet
+  class UnsubEvent < Objects::Base
+    include Objects::SoapRead
   end
 
-  class ET_TriggeredSend < ET_Base
+  class TriggeredSend < Objects::Base
     attr_accessor :subscribers
-    include ET_SoapGet
-    include ET_SoapCUD
+    include Objects::SoapRead
+    include Objects::SoapCUD
     def id
       'TriggeredSendDefinition'
     end
@@ -122,10 +135,9 @@ module FuelSDK
     end
   end
 
-  class ET_Campaign < ET_Base
-    include ET_RestGet
-    include ET_RestCUD
-
+  class Campaign < Objects::Base
+    include Objects::RestRead
+    include Objects::RestCUD
 
     def properties
       @properties ||= {}
@@ -137,9 +149,9 @@ module FuelSDK
       "https://www.exacttargetapis.com/hub/v1/campaigns/%{id}"
     end
 
-    class Asset < ET_Base
-      include ET_RestGet
-      include ET_RestCUD
+    class Asset < Objects::Base
+      include Objects::RestRead
+      include Objects::RestCUD
 
       def properties
         @properties ||= {}

data/lib/fuelsdk/soap.rb

@@ -1,7 +1,7 @@
 require 'savon'
 module FuelSDK
 
-  class SoapResponse < FuelSDK::ET_Response
+  class SoapResponse < FuelSDK::Response
 
     def continue
       rsp = nil
@@ -15,43 +15,61 @@ module FuelSDK
     end
 
     private
-      def unpack raw
-        @code = raw.http.code
+      def unpack_body raw
+        @body = raw.body
         @request_id = raw.body[raw.body.keys.first][:request_id]
+        unpack_msg raw
+      rescue
+        @message = raw.http.body
+        @body = raw.http.body unless @body
+      end
 
-        @message = parse_msg raw
+      def unpack raw
+        @code = raw.http.code
+        unpack_body raw
         @success = @message == 'OK'
-
-
-        @results += (parse_rslts raw)
+        @results += (unpack_rslts raw)
       end
 
-      def parse_msg raw
-        raw.soap_fault? ? raw.body[:fault][:faultstring] : raw.body[raw.body.keys.first][:overall_status]
+      def unpack_msg raw
+        @message = raw.soap_fault? ? raw.body[:fault][:faultstring] : raw.body[raw.body.keys.first][:overall_status]
       end
 
-      def parse_rslts raw
+      def unpack_rslts raw
         @more = (raw.body[raw.body.keys.first][:overall_status] == 'MoreDataAvailable')
         rslts = raw.body[raw.body.keys.first][:results] || []
         rslts = [rslts] unless rslts.kind_of? Array
         rslts
+      rescue
+        []
       end
   end
 
   class DescribeResponse < SoapResponse
-    attr_reader :properties, :retrievable, :updatable, :required
+    attr_reader :properties, :retrievable, :updatable, :required, :extended, :viewable, :editable
     private
-      def parse_rslts raw
-        @retrievable, @updatable, @required, @properties = [], [], [], [], []
-        rslts = raw.body[raw.body.keys.first][:object_definition][:properties]
-        rslts.each do  |r|
-          @retrievable << r[:name] if r[:is_retrievable]
-          @updatable << r[:name] if r[:is_updatable]
-          @required << r[:name] if r[:is_required]
-          @properties << r[:name]
+
+      def unpack_rslts raw
+        @retrievable, @updatable, @required, @properties, @extended, @viewable, @editable = [], [], [], [], [], [], [], []
+        definition = raw.body[raw.body.keys.first][:object_definition]
+        _props = definition[:properties]
+        _props.each do  |p|
+          @retrievable << p[:name] if p[:is_retrievable]
+          @updatable << p[:name] if p[:is_updatable]
+          @required << p[:name] if p[:is_required]
+          @properties << p[:name]
+        end
+        # ugly, but a necessary evil
+        _exts = definition[:extended_properties].nil? ? {} : definition[:extended_properties] # if they have no extended properties nil is returned
+        _exts = _exts[:extended_property] || [] # if no properties nil and we need an array to iterate
+        _exts = [_exts] unless _exts.kind_of? Array # if they have only one extended property we need to wrap it in array to iterate
+        _exts.each do  |p|
+          @viewable << p[:name] if p[:is_viewable]
+          @editable << p[:name] if p[:is_editable]
+          @extended << p[:name]
         end
         @success = true # overall_status is missing from definition response, so need to set here manually
-        rslts
+        _props + _exts
       rescue
         @message = "Unable to describe #{raw.locals[:message]['DescribeRequests']['ObjectDefinitionRequest']['ObjectType']}"
         @success = false
@@ -103,7 +121,7 @@ module FuelSDK
         }
       }
 
-      DescribeResponse.new soap_client.call(:describe, :message => message), self
+      soap_request :describe, message
     end
 
     def soap_get object_type, properties=nil, filter=nil
@@ -136,7 +154,7 @@ module FuelSDK
       end
       message = {'RetrieveRequest' => message}
 
-      soap_request :retrieve, :message => message
+      soap_request :retrieve, message
     end
 
     def soap_post object_type, properties
@@ -151,28 +169,56 @@ module FuelSDK
       soap_cud :delete, object_type, properties
     end
 
+    def format_attributes attributes
+      attrs = []
+      attributes.each do |name, value|
+        attrs.push 'Name' => name, 'Value' => value
+      end
+
+      attrs
+    end
+
     private
+
       def soap_cud action, object_type, properties
+        # get a list of attributes so we can seperate
+        # them from standard object properties
+        type_attrs = soap_describe(object_type).editable
+
+        properties = [properties] unless properties.kind_of? Array
+        properties.each do |p|
+          formated_attrs = []
+          p.each do |k, v|
+            if type_attrs.include? k
+              p.delete k
+              attrs = format_attributes k => v
+              formated_attrs.concat attrs
+            end
+          end
+          (p['Attributes'] ||= []).concat formated_attrs unless formated_attrs.empty?
+        end
+
         message = {
           'Objects' => properties,
           :attributes! => { 'Objects' => { 'xsi:type' => ('tns:' + object_type) } }
         }
-        soap_request action, :message => message
+        soap_request action, message
       end
 
       def soap_request action, message
-          retried = false
-          begin
-            rsp = soap_client.call(action, message)
-          rescue
-            raise if retried
-            retried = true
-            retry
-          end
-          SoapResponse.new rsp, self
+        response = action.eql?(:describe) ? DescribeResponse : SoapResponse
+        retried = false
+        begin
+          rsp = soap_client.call(action, :message => message)
+        rescue
+          raise if retried
+          retried = true
+          retry
+        end
+        response.new rsp, self
       rescue
         raise if rsp.nil?
-        SoapResponse.new rsp, self
+        response.new rsp, self
       end
   end
 end