fuelsdk 0.1.2 → 0.1.3

data/ChangeLog.md

@@ -1,9 +1,16 @@
 FuelSDK-Ruby
 ============
 
+2013-09-18: Version 0.1.3
+```
+  augment soap_cud to handle dataextensions better
+
+  array.wrap so we can be less terse
+```
+
 2013-09-18: Version 0.1.2
 ```
-  get properties for dataextension for retrieve and edit calls
+  get dataextension properties sugar method
 
   clear soap client on refresh so the client gets re-established with header with new token
 

data/lib/fuelsdk.rb

@@ -5,6 +5,18 @@ require 'date'
 require 'jwt'
 require 'active_support/inflector'
 
+class Array
+  class << self
+    def wrap subject
+      if subject.kind_of? Array
+        subject
+      else
+        [subject]
+      end
+    end
+  end
+end
+
 module FuelSDK
   require 'fuelsdk/utils'
   autoload :HTTPRequest, 'fuelsdk/http_request'

data/lib/fuelsdk/soap.rb

@@ -47,7 +47,7 @@ module FuelSDK
       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 = Array.wrap(rslts)
         rslts
       rescue
         []
@@ -71,7 +71,7 @@ module FuelSDK
         # 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 = Array.wrap(_exts) # 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]
@@ -121,16 +121,41 @@ module FuelSDK
       )
     end
 
-    def soap_describe object_type
-      message = {
+    def describe_object_type_message object_type
+      {
         'DescribeRequests' => {
           'ObjectDefinitionRequest' => {
             'ObjectType' => object_type
           }
         }
       }
+    end
 
-      soap_request :describe, message
+    def describe_dataextension_message dataextension
+      {
+        'Property' => "DataExtension.CustomerKey",
+        'SimpleOperator' => 'equals',
+        'Value' => dataextension
+      }
+    end
+
+    def describe_data_extension dataextension
+      soap_get('DataExtensionField',
+        'Name',
+        describe_dataextension_message(dataextension)
+      )
+    end
+
+    def soap_describe object_type
+      soap_request :describe, describe_object_type_message(object_type)
+    end
+
+    def describe object_type
+      rsp = soap_describe(object_type)
+      unless rsp.success?
+        rsp = describe_data_extension object_type
+      end
+      rsp
     end
 
     def get_all_object_properties object_type
@@ -140,12 +165,8 @@ module FuelSDK
     end
 
     def get_dataextension_properties dataextension
-      soap_get('DataExtensionField',
-        'Name',
-        'Property' => "DataExtension.CustomerKey",
-        'SimpleOperator' => 'equals',
-        'Value' => dataextension
-      ).results.collect{|f| f[:name]}
+      describe_dataextension(dataextension)
+        .results.collect{|f| f[:name]}
     end
 
     def cache_properties action, object_type, properties
@@ -168,6 +189,8 @@ module FuelSDK
     def get_retrievable_properties object_type
       if props=retrievable_properties_cached?(object_type)
         props
+      elsif is_a_dataextension? object_type
+        []
       else
         cache_retrievable object_type, get_all_object_properties(object_type).retrievable
       end
@@ -184,6 +207,8 @@ module FuelSDK
     def get_editable_properties object_type
       if props=editable_properties_cached?(object_type)
         props
+      elsif is_a_dataextension? object_type
+        []
       else
         cache_editable object_type, get_all_object_properties(object_type).editable
       end
@@ -263,7 +288,7 @@ module FuelSDK
     end
 
     def create_action_message message_type, object_type, properties, action
-      properties = [properties] unless properties.kind_of? Array
+      properties = Array.wrap(properties)
       {
         'Action' => action,
         message_type => {
@@ -295,14 +320,29 @@ module FuelSDK
       }
     end
 
-    def normalize_properties_for_cud object_type, properties
-      properties = [properties] unless properties.kind_of? Array
-      raise 'Object properties must be a Hash' unless properties.first.kind_of? Hash
+    def format_dataextension_cud_properties properties
+      Array.wrap(properties).each do |p|
+        formated_attrs = []
+        p.each do |k, v|
+          unless k == 'CustomerKey'
+            p.delete k
+            attrs = FuelSDK.format_name_value_pairs k => v
+            formated_attrs.concat attrs
+          end
+        end
+        unless formated_attrs.blank?
+          p['Properties'] ||= {}
+          (p['Properties']['Property'] ||= []).concat formated_attrs
+        end
+      end
+    end
 
-      # get a list of attributes so we can seperate
-      # them from standard object properties
-      type_attrs = get_editable_properties object_type
+    def is_a_dataextension? object_type
+      object_type == 'DataExtensionObject'
+    end
 
+    def format_object_cud_properties object_type, properties
+      type_attrs = get_editable_properties object_type
       properties.each do |p|
         formated_attrs = []
         p.each do |k, v|
@@ -316,6 +356,18 @@ module FuelSDK
       end
     end
 
+    def normalize_properties_for_cud object_type, properties
+      properties = Array.wrap(properties)
+      raise 'Object properties must be a Hash' unless properties.first.kind_of? Hash
+
+      if is_a_dataextension? object_type
+        format_dataextension_cud_properties properties
+      else
+        format_object_cud_properties object_type, properties
+      end
+
+    end
+
     private
 
       def soap_cud action, object_type, properties

data/lib/fuelsdk/version.rb

@@ -1,3 +1,3 @@
 module FuelSDK
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/array_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Array do
+
+  it '#self.wrap returns subject wrapped in an array' do
+    expect(Array.wrap(1)).to eq([1])
+  end
+
+  it '#self.wrap returns subject as is when already wrapped' do
+    expect(Array.wrap([1])).to eq([1])
+  end
+end

data/spec/soap/dataextension_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe FuelSDK::Soap do
+
+  let(:client) { FuelSDK::Client.new }
+
+  subject { client }
+
+  describe '#format_cud_properties_for_dataextension' do
+    let(:de_properties) {
+      [{'CustomerKey' => 'Orders', 'total' => 1}]
+    }
+    it 'leaves CustomerKey alone an puts other attributes in name value pairs under Properies' do
+      expect(client.format_dataextension_cud_properties de_properties).to eq([{
+        'CustomerKey' => 'Orders',
+         'Properties' => {'Property' => [{'Name' => 'total', 'Value' => 1}]}
+       }])
+    end
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fuelsdk
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -196,6 +196,7 @@ files:
 - samples/sample-triggeredsend.rb
 - samples/sample-unsubevent.rb
 - samples/sample_helper.rb
+- spec/array_spec.rb
 - spec/client_spec.rb
 - spec/fuelsdk_response_spec.rb
 - spec/helper_funcs_spec.rb
@@ -204,6 +205,7 @@ files:
 - spec/rest_spec.rb
 - spec/soap/configure_spec.rb
 - spec/soap/cud_spec.rb
+- spec/soap/dataextension_spec.rb
 - spec/soap/describe_error_spec.rb
 - spec/soap/get_spec.rb
 - spec/soap/perform_spec.rb
@@ -254,6 +256,7 @@ test_files:
 - samples/sample-triggeredsend.rb
 - samples/sample-unsubevent.rb
 - samples/sample_helper.rb
+- spec/array_spec.rb
 - spec/client_spec.rb
 - spec/fuelsdk_response_spec.rb
 - spec/helper_funcs_spec.rb
@@ -262,6 +265,7 @@ test_files:
 - spec/rest_spec.rb
 - spec/soap/configure_spec.rb
 - spec/soap/cud_spec.rb
+- spec/soap/dataextension_spec.rb
 - spec/soap/describe_error_spec.rb
 - spec/soap/get_spec.rb
 - spec/soap/perform_spec.rb