netsuite 0.1.0 → 0.2.0

data/lib/netsuite/actions/search.rb

@@ -1,4 +1,3 @@
-# TODO: Tests
 module NetSuite
   module Actions
     class Search
@@ -12,23 +11,20 @@ module NetSuite
       private
 
       def request
-        # https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteFlex/WebServices/STP_SettingSearchPreferences.html#N2028598271-3
+        # https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/SettingSearchPreferences.html
+        # https://webservices.netsuite.com/xsd/platform/v2012_2_0/messages.xsd
+
         preferences = NetSuite::Configuration.auth_header
-        preferences = preferences.merge((@options[:preferences] || {}).inject({}) do |h, (k, v)|
-          h[k.to_s.lower_camelcase] = v
-          h
-        end)
-
-        NetSuite::Configuration.connection(
-          namespaces: {
-            'xmlns:platformMsgs' => "urn:messages_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
-            'xmlns:platformCore' => "urn:core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
-            'xmlns:platformCommon' => "urn:common_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
-            'xmlns:listRel' => "urn:relationships_#{NetSuite::Configuration.api_version}.lists.webservices.netsuite.com",
-            'xmlns:tranSales' => "urn:sales_#{NetSuite::Configuration.api_version}.transactions.webservices.netsuite.com",
-          },
-          soap_header: preferences
-        ).call :search, :message => request_body
+        preferences = preferences.merge(
+          (@options[:preferences] || {}).inject({'platformMsgs:SearchPreferences' => {}}) do |h, (k, v)|
+            h['platformMsgs:SearchPreferences'][k.to_s.lower_camelcase] = v
+            h
+          end
+        )
+
+        NetSuite::Configuration
+          .connection(soap_header: preferences)
+          .call (@options.has_key?(:search_id)? :search_more_with_id : :search), :message => request_body
       end
 
       # basic search XML
@@ -46,41 +42,151 @@ module NetSuite
       # </soap:Body>
 
       def request_body
+        if @options.has_key?(:search_id)
+          return {
+            'pageIndex' => @options[:page_index],
+            'searchId' => @options[:search_id],
+          }
+        end
+
+        # columns is only needed for advanced search results
+        columns = @options[:columns] || {}
         criteria = @options[:criteria] || @options
 
-        # TODO wish there was a cleaner way to do this: we need the namespace of the record
+        # TODO find cleaner solution for pulling the namespace of the record, which is a instance method
         example_instance = @klass.new
         namespace = example_instance.record_namespace
 
-        # extract the class name without the module
+        # extract the class name
         class_name = @klass.to_s.split("::").last
 
-        search_record = {}
+        criteria_structure = {}
+        columns_structure = columns
+        saved_search_id = criteria.delete(:saved)
 
-        criteria.each_pair do |condition_category, conditions|
-          search_record["#{namespace}:#{condition_category}"] = conditions.inject({}) do |h, condition|
-            h["platformCommon:#{condition[:field]}"] = {
-              "platformCore:searchValue" => condition[:value]
-            }
+        # TODO this whole thing needs to be refactored so we can apply some of the same logic to the
+        #      column creation xml
 
-            (h[:attributes!] ||= {}).merge!({
-              "platformCommon:#{condition[:field]}" => {
-                'operator' => condition[:operator]
+        criteria.each_pair do |condition_category, conditions|
+          criteria_structure["#{namespace}:#{condition_category}"] = conditions.inject({}) do |h, condition|
+            element_name = "platformCommon:#{condition[:field]}"
+
+            case condition[:field]
+            when 'recType'
+              # TODO this seems a bit brittle, look into a way to handle this better
+              h[element_name] = {
+                :@internalId => condition[:value].internal_id
+              }
+            when 'customFieldList'
+              # === START CUSTOM FIELD
+
+              # there isn't a clean way to do lists of the same element
+              # Gyoku doesn't seem support the nice :@attribute and :content! syntax for lists of elements of the same name
+              # https://github.com/savonrb/gyoku/issues/18#issuecomment-17825848
+
+              # TODO with the latest version of savon we can easily improve the code here, should be rewritten with new attribute syntax
+
+              custom_field_list = condition[:value].map do |h|
+                if h[:value].is_a?(Array) && h[:value].first.respond_to?(:to_record)
+                  {
+                    "platformCore:searchValue" => h[:value].map(&:to_record),
+                    :attributes! => {
+                      'platformCore:searchValue' => {
+                        'internalId' => h[:value].map(&:internal_id)
+                      }
+                    }
+                  }
+                elsif h[:value].respond_to?(:to_record)
+                  {
+                    "platformCore:searchValue" => {
+                      :content! => h[:value].to_record,
+                      :@internalId => h[:value].internal_id
+                    }
+                  }
+                else
+                  { "platformCore:searchValue" => h[:value] }
+                end
+              end
+
+              h[element_name] = {
+                'platformCore:customField' => custom_field_list,
+                :attributes! => {
+                  'platformCore:customField' => {
+                    'internalId' => condition[:value].map { |h| h[:field] },
+                    'operator' => condition[:value].map { |h| h[:operator] },
+                    'xsi:type' => condition[:value].map { |h| "platformCore:#{h[:type]}" }
+                  }
+                }
               }
-            })
+
+              # === END CUSTOM FIELD
+            else
+              if condition[:value].is_a?(Array) && condition[:value].first.respond_to?(:to_record)
+                # TODO need to update to the latest savon so we don't need to duplicate the same workaround above again
+                # TODO it's possible that this might break, not sure if platformCore:SearchMultiSelectField is the right type in every situation
+
+                h[element_name] = {
+                  '@operator' => condition[:operator],
+                  '@xsi:type' => 'platformCore:SearchMultiSelectField',
+                  "platformCore:searchValue" => {
+                    :content! => condition[:value].map(&:to_record),
+                    '@internalId' => condition[:value].map(&:internal_id),
+                    '@xsi:type' => 'platformCore:RecordRef',
+                    '@type' => 'account'
+                  }
+                }
+              elsif condition[:value].is_a?(Array) && condition[:type] == 'SearchDateField'
+                # date ranges are handled via searchValue (start range) and searchValue2 (end range)
+
+                h[element_name] = {
+                  '@operator' => condition[:operator],
+                  "platformCore:searchValue" => condition[:value].first.to_s,
+                  "platformCore:searchValue2" => condition[:value].last.to_s
+                }
+              else
+                h[element_name] = {
+                  :content! => { "platformCore:searchValue" => condition[:value] },
+                }
+
+                h[element_name][:@operator] = condition[:operator] if condition[:operator]
+              end
+            end
 
             h
           end
         end
 
-        {
-          'searchRecord' => search_record,
-          :attributes! => {
+        # TODO this needs to be DRYed up a bit
+
+        if saved_search_id
+          {
+            'searchRecord' => {
+              '@savedSearchId' => saved_search_id,
+              '@xsi:type' => "#{namespace}:#{class_name}SearchAdvanced",
+              :content! => {
+                "#{namespace}:criteria" => criteria_structure
+                # TODO need to optionally support columns here
+              }
+            }
+          }
+        elsif !columns_structure.empty?
+          {
+            'searchRecord' => {
+              '@xsi:type' => "#{namespace}:#{class_name}SearchAdvanced",
+              :content! => {
+                "#{namespace}:criteria" => criteria_structure,
+                "#{namespace}:columns" => columns_structure
+              }
+            }
+          }
+        else
+          {
             'searchRecord' => {
-              'xsi:type' => "#{namespace}:#{class_name}Search"
-            },
+              :content! => criteria_structure,
+              '@xsi:type' => "#{namespace}:#{class_name}Search"
+            }
           }
-        }
+        end
       end
 
       def response_header
@@ -96,13 +202,22 @@ module NetSuite
       end
 
       def search_result
-        @search_result = @response.body[:search_response][:search_result]
+        @search_result = if @response.body.has_key?(:search_more_with_id_response)
+          @response.body[:search_more_with_id_response]
+        else
+          @response.body[:search_response]
+        end[:search_result]
       end
 
       def success?
         @success ||= search_result[:status][:@is_success] == 'true'
       end
 
+      protected
+        def method_name
+
+        end
+
       module Support
         def self.included(base)
           base.extend(ClassMethods)

data/lib/netsuite/actions/search_more_with_id.rb

@@ -1,5 +1,6 @@
-# TODO: Tests
-# TODO: DBC
+# TODO Tests
+# TODO this is broken with the current search implementation
+
 module NetSuite
   module Actions
     class SearchMoreWithId

data/lib/netsuite/actions/update.rb

@@ -9,17 +9,19 @@ module NetSuite
       end
 
       def request
+        api_version = NetSuite::Configuration.api_version
+        
         NetSuite::Configuration.connection(
           namespaces: {
-            'xmlns:platformMsgs'   => "urn:messages_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
-            'xmlns:platformCore'   => "urn:core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
-            'xmlns:listRel'        => "urn:relationships_#{NetSuite::Configuration.api_version}.lists.webservices.netsuite.com",
-            'xmlns:tranSales'      => "urn:sales_#{NetSuite::Configuration.api_version}.transactions.webservices.netsuite.com",
-            'xmlns:platformCommon' => "urn:common_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
-            'xmlns:listAcct'       => "urn:accounting_#{NetSuite::Configuration.api_version}.lists.webservices.netsuite.com",
-            'xmlns:actSched'       => "urn:scheduling_#{NetSuite::Configuration.api_version}.activities.webservices.netsuite.com",
-            'xmlns:tranCust'       => "urn:customers_#{NetSuite::Configuration.api_version}.transactions.webservices.netsuite.com",
-            'xmlns:setupCustom'    => "urn:customization_#{NetSuite::Configuration.api_version}.setup.webservices.netsuite.com",
+            'xmlns:platformMsgs'   => "urn:messages_#{api_version}.platform.webservices.netsuite.com",
+            'xmlns:platformCore'   => "urn:core_#{api_version}.platform.webservices.netsuite.com",
+            'xmlns:listRel'        => "urn:relationships_#{api_version}.lists.webservices.netsuite.com",
+            'xmlns:tranSales'      => "urn:sales_#{api_version}.transactions.webservices.netsuite.com",
+            'xmlns:platformCommon' => "urn:common_#{api_version}.platform.webservices.netsuite.com",
+            'xmlns:listAcct'       => "urn:accounting_#{api_version}.lists.webservices.netsuite.com",
+            'xmlns:actSched'       => "urn:scheduling_#{api_version}.activities.webservices.netsuite.com",
+            'xmlns:tranCust'       => "urn:customers_#{api_version}.transactions.webservices.netsuite.com",
+            'xmlns:setupCustom'    => "urn:customization_#{api_version}.setup.webservices.netsuite.com",
           },
         ).call :update, :message => request_body
       end
@@ -31,20 +33,18 @@ module NetSuite
       # </platformMsgs:update>
       def request_body
         hash = {
-          'platformMsgs:record' => updated_record.to_record,
-          :attributes! => {
-            'platformMsgs:record' => {
-              'xsi:type' => updated_record.record_type
-            }
+          'platformMsgs:record' => {
+            :content! => updated_record.to_record,
+            '@xsi:type' => updated_record.record_type
           }
         }
 
         if updated_record.respond_to?(:internal_id) && updated_record.internal_id
-          hash[:attributes!]['platformMsgs:record']['platformMsgs:internalId'] = updated_record.internal_id
+          hash['platformMsgs:record']['@platformMsgs:internalId'] = updated_record.internal_id
         end
 
         if updated_record.respond_to?(:external_id) && updated_record.external_id
-          hash[:attributes!]['platformMsgs:record']['platformMsgs:externalId'] = updated_record.external_id
+          hash['platformMsgs:record']['@platformMsgs:externalId'] = updated_record.external_id
         end
         
         hash

data/lib/netsuite/configuration.rb

@@ -12,12 +12,13 @@ module NetSuite
 
     def connection(params = {})
       Savon.client({
-          wsdl: wsdl,
-          read_timeout: read_timeout,
-          soap_header: auth_header,
-          pretty_print_xml: true,
-          logger: logger
-          # open_timeout: ???
+        wsdl: wsdl,
+        read_timeout: read_timeout,
+        namespaces: namespaces,
+        soap_header: auth_header,
+        pretty_print_xml: true,
+        logger: logger
+        # open_timeout: ???
       }.merge(params))
     end
 
@@ -70,23 +71,36 @@ module NetSuite
           'platformCore:email'    => email,
           'platformCore:password' => password,
           'platformCore:account'  => account.to_s,
-          'platformCore:role'     => role.to_record,
-          :attributes! => {
-            'platformCore:role' => role.attributes!
-          }
+          'platformCore:role'     => { :'@type' => 'role', :@internalId => role }
         }
       }
     end
-    
+
+    def namespaces
+      {
+        'xmlns:platformMsgs'   => "urn:messages_#{api_version}.platform.webservices.netsuite.com",
+        'xmlns:platformCore'   => "urn:core_#{api_version}.platform.webservices.netsuite.com",
+        'xmlns:platformCommon' => "urn:common_#{api_version}.platform.webservices.netsuite.com",
+        'xmlns:listRel'        => "urn:relationships_#{api_version}.lists.webservices.netsuite.com",
+        'xmlns:tranSales'      => "urn:sales_#{api_version}.transactions.webservices.netsuite.com",
+        'xmlns:actSched'       => "urn:scheduling_#{api_version}.activities.webservices.netsuite.com",
+        'xmlns:setupCustom'    => "urn:customization_#{api_version}.setup.webservices.netsuite.com",
+        'xmlns:listAcct'       => "urn:accounting_#{api_version}.lists.webservices.netsuite.com",
+        'xmlns:tranCust'       => "urn:customers_#{api_version}.transactions.webservices.netsuite.com",
+        'xmlns:listSupport'    => "urn:support_#{api_version}.lists.webservices.netsuite.com",
+        'xmlns:tranGeneral'    => "urn:general_#{api_version}.transactions.webservices.netsuite.com",
+      }
+    end
+
     def role=(role)
-      attributes[:role] = NetSuite::Records::RecordRef.new(:internal_id => role, :type => 'role')
+      attributes[:role] = role
     end
-    
+
     def role(role = nil)
       if role
         self.role = role
-      else 
-        attributes[:role] ||= NetSuite::Records::RecordRef.new(:internal_id => '3', :type => 'role')
+      else
+        attributes[:role] ||= '3'
       end
     end
 

data/lib/netsuite/namespaces/list_support.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  	module Namespaces
+    	module ListSupport
+
+    		def record_namespace
+        		'listSupport'
+      		end
+      		
+    	end
+	end
+end

data/lib/netsuite/records/account.rb

@@ -3,6 +3,7 @@ module NetSuite
     class Account
       include Support::Fields
       include Support::RecordRefs
+      include Support::Records
       include Support::Actions
 
       actions :get, :add, :delete

data/lib/netsuite/records/base_ref_list.rb

@@ -0,0 +1,33 @@
+# TODO needs spec
+
+module NetSuite
+  module Records
+    class BaseRefList
+      include Support::Fields
+      include Support::Actions
+      include Namespaces::PlatformCore
+
+      actions :get_select_value
+
+      fields :base_ref
+
+      def initialize(attrs = {})
+        initialize_from_attributes_hash(attrs)
+      end
+
+      def base_ref=(refs)
+        case refs
+        when Hash
+          self.base_ref << RecordRef.new(refs)
+        when Array
+          refs.each { |ref| self.base_ref << RecordRef.new(ref) }
+        end
+      end
+
+      def base_ref
+        @base_ref ||= []
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/cash_sale.rb

@@ -0,0 +1,7 @@
+module NetSuite
+  module Records
+    class CashSale < SalesOrder
+
+    end
+  end
+end

data/lib/netsuite/records/custom_field.rb

@@ -4,7 +4,8 @@ module NetSuite
       include Support::Fields
       include Support::Records
 
-      attr_reader :internal_id, :type
+      attr_reader :internal_id
+      attr_accessor :type
 
       def initialize(attributes = {})
         @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)

data/lib/netsuite/records/custom_field_list.rb

@@ -20,39 +20,89 @@ module NetSuite
       end
       
       def method_missing(sym, *args, &block)
-        return @custom_fields_assoc[sym] if @custom_fields_assoc.include? sym
+        # read custom field if already set
+        if @custom_fields_assoc.include?(sym)
+          return @custom_fields_assoc[sym]
+        end
+
+        # write custom field
+        if sym.to_s.end_with?('=')
+          return create_custom_field(sym.to_s[0..-2], args.first)
+        end
+
         super(sym, *args, &block)
       end
 
       def respond_to?(sym, include_private = false)
-        return true if @custom_fields_assoc.include? sym
+        return true if @custom_fields_assoc.include?(sym)
         super
       end
 
       def to_record
-        # TODO this is the best way I could find to handle this, there *has* to be a better way
-        # http://stackoverflow.com/questions/7001957/savon-array-of-xml-tags
-
         {
-          "#{record_namespace}:customField" => custom_fields.map(&:to_record),
-          :attributes! => {
-            "#{record_namespace}:customField" => {
-              'internalId' => custom_fields.map(&:internal_id),
-              'xsi:type' => custom_fields.map(&:type)
+          "#{record_namespace}:customField" => custom_fields.map do |custom_field|
+            if custom_field.value.respond_to?(:to_record)
+              custom_field_value = custom_field.value.to_record
+            else
+              custom_field_value = custom_field.value.to_s
+            end
+
+            {
+              "platformCore:value" => custom_field_value,
+              '@internalId' => custom_field.internal_id,
+              '@xsi:type' => custom_field.type
             }
-          }
+          end
         }
       end
 
       private
         def extract_custom_field(custom_field_data)
-          # TODO this needs to be cleaned up & tested; very messy
+          # TODO this seems brittle, but might sufficient, watch out for this if something breaks
           if custom_field_data[:"@xsi:type"] == "platformCore:SelectCustomFieldRef"
             custom_field_data[:value] = CustomRecordRef.new(custom_field_data.delete(:value))
           end
 
           custom_fields << CustomField.new(custom_field_data)
         end
+
+        def create_custom_field(internal_id, field_value)
+          # all custom fields need types; infer type based on class sniffing
+          field_type = case
+          when field_value.is_a?(Hash)
+            'SelectCustomFieldRef'
+          when field_value.is_a?(DateTime),
+               field_value.is_a?(Time),
+               field_value.is_a?(Date)
+            'DateCustomFieldRef'
+          when field_value.is_a?(FalseClass),
+               field_value.is_a?(TrueClass)
+            'BooleanCustomFieldRef'
+          else
+            'StringCustomFieldRef'
+          end
+
+          # TODO seems like DateTime doesn't need the iso8601 call
+          #      not sure if this is specific to my env though
+
+          custom_field_value = case 
+          when field_value.is_a?(Hash)
+            CustomRecordRef.new(field_value)
+          when field_value.is_a?(Time)
+            field_value.iso8601
+          else
+            field_value
+          end
+
+          custom_field = CustomField.new(
+            internal_id: internal_id,
+            value: custom_field_value,
+            type: "#{record_namespace}:#{field_type}"
+          )
+
+          custom_fields << custom_field
+          @custom_fields_assoc[internal_id.to_sym] = custom_field
+        end
     end
   end
 end