netsuite_rails 0.2.2 → 0.3.1

data/lib/netsuite_rails/record_sync/push_manager.rb

@@ -8,7 +8,10 @@ module NetSuiteRails
           # TODO check to see if anything is changed before moving forward
           # if changes_keys.blank? && local_record.netsuite_manual_fields
 
-          if opts[:modified_fields]
+          # always include the full netsuite field mapping, regardless of which
+          # fields were modfified locally, when initially creating the netsuite record
+
+          if opts[:modified_fields] && !local_record.new_netsuite_record?
             # if Array, we need to convert info fields hash based on the record definition
             if opts[:modified_fields].is_a?(Array)
               opts[:modified_fields] = all_netsuite_fields(local_record).select { |k,v| opts[:modified_fields].include?(k) }
@@ -21,17 +24,10 @@ module NetSuiteRails
 
           local_record.netsuite_execute_callbacks(local_record.class.before_netsuite_push, netsuite_record)
 
-          if !local_record.new_netsuite_record?
-            push_update(local_record, netsuite_record, opts)
-          else
+          if opts[:push_method] == :upsert || local_record.new_netsuite_record?
             push_add(local_record, netsuite_record, opts)
-          end
-
-          # :aggressive is for custom fields which are based on input – need pull updated values after
-          # the push to netsuite to retrieve the calculated values
-
-          if local_record.netsuite_sync == :aggressive
-            local_record.netsuite_pull
+          else
+            push_update(local_record, netsuite_record, opts)
           end
 
           local_record.netsuite_execute_callbacks(local_record.class.after_netsuite_push, netsuite_record)
@@ -40,12 +36,19 @@ module NetSuiteRails
         end
 
         def push_add(local_record, netsuite_record, opts = {})
-          if netsuite_record.add
-            # update_column to avoid triggering another save
-            local_record.update_column(:netsuite_id, netsuite_record.internal_id)
+          # push_method is either :add or :upsert
+          if netsuite_record.send(opts[:push_method] || :add)
+            Rails.logger.info "NetSuite: action=#{opts[:push_method]}, local_record=#{local_record.class}[#{local_record.id}]" +
+                              "netsuite_record_type=#{netsuite_record.class}, netsuite_record_id=#{netsuite_record.internal_id}"
+
+            if is_active_record_model?(local_record)
+              # update_column to avoid triggering another save
+              local_record.update_column(:netsuite_id, netsuite_record.internal_id)
+            else
+              netsuite_record.internal_id
+            end
           else
-            # TODO use NS error class
-            raise "NetSuite: error creating record #{netsuite_record.errors}"
+            raise "NetSuite: error. action=#{opts[:push_method]}, netsuite_record_type=#{netsuite_record.class}, errors=#{netsuite_record.errors}"
           end
         end
 
@@ -54,8 +57,17 @@ module NetSuiteRails
           # NS could have logic which could change field functionality depending on
           # input data; it's safest to limit the number of field changes pushed to NS
 
+          # exclude fields that map to procs: they don't indicate which netsuite field
+          # the local rails field maps to, so the user must specify this manually in `netsuite_manual_fields`
+
+          # TODO add option for model to mark `custom_field_list = true` if custom field mapping to a
+          #      proc is detected. This is helpful for users mapping a local field to a custom field
+
           custom_field_list = local_record.netsuite_field_map[:custom_field_list] || {}
+          custom_field_list = custom_field_list.select { |local_field, netsuite_field| !netsuite_field.is_a?(Proc) }
+
           modified_fields_list = opts[:modified_fields]
+          modified_fields_list = modified_fields_list.select { |local_field, netsuite_field| !netsuite_field.is_a?(Proc) }
 
           update_list = {}
 
@@ -87,7 +99,10 @@ module NetSuiteRails
             update_list[:rec_type] = netsuite_record.rec_type
           end
 
-          # TODO consider using upsert here
+          Rails.logger.info "NetSuite: Update #{netsuite_record.class} #{netsuite_record.internal_id}, list #{update_list.keys}"
+
+          # don't update if list is empty
+          return if update_list.empty?
 
           if netsuite_record.update(update_list)
             true
@@ -97,19 +112,13 @@ module NetSuiteRails
         end
 
         def build_netsuite_record(local_record, opts = {})
-          netsuite_record = build_netsuite_record_reference(local_record)
-
-          # TODO need to normalize datetime fields
+          netsuite_record = build_netsuite_record_reference(local_record, opts)
 
           all_field_list = opts[:modified_fields]
           custom_field_list = local_record.netsuite_field_map[:custom_field_list] || {}
           field_hints = local_record.netsuite_field_hints
 
-          reflections = if NetSuiteRails.rails4?
-            local_record.class.reflections
-          else
-            local_record.reflections
-          end
+          reflections = relationship_attributes_list(local_record)
 
           all_field_list.each do |local_field, netsuite_field|
             # allow Procs as field mapping in the record definition for custom mapping
@@ -118,7 +127,7 @@ module NetSuiteRails
               next
             end
 
-            # TODO pretty sure this will break if we are dealing with has_many 
+            # TODO pretty sure this will break if we are dealing with has_many
 
             netsuite_field_value = if reflections.has_key?(local_field)
               if (remote_internal_id = local_record.send(local_field).try(:netsuite_id)).present?
@@ -131,7 +140,7 @@ module NetSuiteRails
             end
 
             if field_hints.has_key?(local_field) && netsuite_field_value.present?
-              netsuite_field_value = NetSuiteRails::Transformations.transform(field_hints[local_field], netsuite_field_value)
+              netsuite_field_value = NetSuiteRails::Transformations.transform(field_hints[local_field], netsuite_field_value, :push)
             end
 
             # TODO should we skip setting nil values completely? What if we want to nil out fields on update?
@@ -148,10 +157,16 @@ module NetSuiteRails
           netsuite_record
         end
 
-        def build_netsuite_record_reference(local_record)
+        def build_netsuite_record_reference(local_record, opts = {})
           # must set internal_id for records on new; will be set to nil if new record
 
-          netsuite_record = local_record.netsuite_record_class.new(internal_id: local_record.netsuite_id)
+          init_hash = if opts[:use_external_id]
+            { external_id: local_record.netsuite_external_id }
+          else
+            { internal_id: local_record.netsuite_id }
+          end
+
+          netsuite_record = local_record.netsuite_record_class.new(init_hash)
 
           if local_record.netsuite_custom_record?
             netsuite_record.rec_type = NetSuite::Records::CustomRecord.new(internal_id: local_record.class.netsuite_custom_record_type_id)
@@ -163,7 +178,11 @@ module NetSuiteRails
         def modified_local_fields(local_record)
           synced_netsuite_fields = all_netsuite_fields(local_record)
 
-          changed_keys = changed_attributes(local_record)
+          changed_keys = if is_active_record_model?(local_record)
+            changed_attributes(local_record)
+          else
+            local_record.changed_attributes
+          end
 
           # filter out unchanged keys when updating record
           unless local_record.new_netsuite_record?
@@ -186,11 +205,7 @@ module NetSuiteRails
 
           # TODO think about has_many / join table changes
 
-          reflections = if NetSuiteRails.rails4?
-            local_record.class.reflections
-          else
-            local_record.reflections
-          end
+          reflections = relationship_attributes_list(local_record)
 
           association_field_key_mapping = reflections.values.reject(&:collection?).inject({}) do |h, a|
             begin
@@ -205,8 +220,16 @@ module NetSuiteRails
 
           changed_attributes_keys = local_record.changed_attributes.keys
 
-          # TODO documentation about serialized values
-          changed_attributes_keys += local_record.serialized_attributes.keys.map do |k|
+          serialized_attrs = if NetSuiteRails.rails4?
+            local_record.class.serialized_attributes
+          else
+            local_record.serialized_attributes
+          end
+
+          # changes_attributes does not track serialized attributes, although it does track the storage key
+          # if a serialized attribute storage key is dirty assume that all keys in the hash are dirty as well
+
+          changed_attributes_keys += serialized_attrs.keys.map do |k|
             local_record.send(k.to_sym).keys.map(&:to_s)
           end.flatten
 
@@ -216,9 +239,24 @@ module NetSuiteRails
           end
         end
 
+        def relationship_attributes_list(local_record)
+          if is_active_record_model?(local_record)
+            if NetSuiteRails.rails4?
+              local_record.class.reflections
+            else
+              local_record.reflections
+            end
+          else
+            local_record.respond_to?(:reflections) ? local_record.reflections : {}
+          end
+        end
+
+        def is_active_record_model?(local_record)
+          local_record.class.ancestors.include?(ActiveRecord::Base)
+        end
 
       end
     end
 
   end
-end
+end

data/lib/netsuite_rails/record_sync.rb

@@ -84,7 +84,7 @@ module NetSuiteRails
         self.netsuite_record_class == NetSuite::Records::CustomRecord
       end
 
-      # :read, :aggressive (push & update on save), :write_only, :read_write
+      # :read, :write_only, :read_write
       def netsuite_sync(flag = nil, opts = {})
         if !flag.nil?
           self.netsuite_sync_options = opts
@@ -96,7 +96,11 @@ module NetSuiteRails
     end
 
     module InstanceMethods
-      attr_accessor :netsuite_manual_fields
+      attr_writer :netsuite_manual_fields
+
+      def netsuite_manual_fields
+        @netsuite_manual_fields ||= []
+      end
 
       # these methods are here for easy model override
 
@@ -130,12 +134,23 @@ module NetSuiteRails
         @netsuite_pulled ||= false
       end
 
+      def netsuite_async_jobs?
+        self.netsuite_sync_options[:sync_mode] == :async || (self.netsuite_sync_options[:sync_mode].blank? && NetSuiteRails::Configuration.netsuite_sync_mode == :async)
+      end
+
+      # TODO need to support the opts hash
       def netsuite_pull(opts = {})
-        # TODO need to support the opts hash
         netsuite_extract_from_record(netsuite_pull_record)
+
+        if self.netsuite_async_jobs?
+          # without callbacks?
+          self.save
+        end
       end
 
       def netsuite_pull_record
+        # TODO support use_external_id / netsuite_external_id
+
         if netsuite_custom_record?
           NetSuite::Records::CustomRecord.get(
             internal_id: self.netsuite_id,
@@ -152,6 +167,8 @@ module NetSuiteRails
 
       # TODO move this login into separate service object
       def netsuite_extract_from_record(netsuite_record)
+        Rails.logger.info "NetSuite: Pull #{netsuite_record.class} #{netsuite_record.internal_id}"
+
         @netsuite_pulling = true
 
         field_hints = self.netsuite_field_hints
@@ -161,10 +178,11 @@ module NetSuiteRails
         all_field_list = self.netsuite_field_map.except(:custom_field_list) || {}
         all_field_list.merge!(custom_field_list)
 
-        # self.netsuite_normalize_datetimes(:pull)
+        # TODO should have a helper module for common push/pull methods
+        reflection_attributes = NetSuiteRails::RecordSync::PushManager.relationship_attributes_list(self)
 
         # handle non-collection associations
-        association_keys = self.reflections.values.reject(&:collection?).map(&:name)
+        association_keys = reflection_attributes.values.reject(&:collection?).map(&:name)
 
         all_field_list.each do |local_field, netsuite_field|
           is_custom_field = custom_field_list.keys.include?(local_field)
@@ -186,7 +204,10 @@ module NetSuiteRails
           end
 
           if association_keys.include?(local_field)
-            field_value = self.reflections[local_field].klass.where(netsuite_id: field_value.internal_id).first_or_initialize
+            field_value = reflection_attributes[local_field].
+              klass.
+              where(netsuite_id: field_value.internal_id).
+              first_or_initialize
           elsif is_custom_field
             field_value = NetSuiteRails::RecordSync::PullManager.extract_custom_field_value(field_value)
           else
@@ -195,12 +216,8 @@ module NetSuiteRails
 
           # TODO should we just check for nil? vs present?
 
-          # TODO should be moved to Transformations with a direction flag
           if field_hints.has_key?(local_field) && field_value.present?
-            case field_hints[local_field]
-            when :datetime
-              field_value = field_value.change(offset: "00:00") - (Time.zone.utc_offset / 3600).hours + (8 + NetSuiteRails::Configuration.netsuite_instance_time_zone_offset).hours
-            end
+            field_value = NetSuiteRails::Transformations.transform(field_hints[local_field], field_value, :pull)
           end
 
           self.send(:"#{local_field}=", field_value)

data/lib/netsuite_rails/routines/company_contact_match.rb

@@ -0,0 +1,98 @@
+module NetSuiteRails
+  module Routines
+    module CompanyContactMatch
+      extend self
+
+      def match(company_customer, contact_data)
+        # TODO set page size to a large number for this search
+        search = NetSuite::Records::Contact.search({
+          customerJoin: [
+            {
+              field: 'internalId',
+              operator: 'anyOf',
+              value: [
+                NetSuite::Records::Customer.new(internal_id: company_customer.internal_id)
+              ]
+            }
+          ]
+        })
+
+        match_data = {
+          email: contact_data[:email].dup,
+          first_name: contact_data[:first_name].dup,
+          last_name: contact_data[:last_name].dup
+        }
+
+        match_data.
+          values.
+          each(&:strip!).
+          each(&:downcase!)
+
+        # TODO search error checking
+
+        # try name match first; NS will throw an error if a contact is created or updated if the name already exists
+        search.results.each do |contact|
+          contact_first_name = contact.first_name.downcase.strip rescue ''
+          contact_last_name = contact.last_name.downcase.strip rescue ''
+
+          # if no email match & name data is present try fuzzy matching
+          if match_data[:first_name] && match_data[:last_name] && !contact_first_name.empty? && !contact_last_name.empty?
+
+            # TODO consider `self.fuzzy_name_matches?(contact_first_name, contact_last_name, match_data[:first_name], match_data[:last_name])`
+            if contact_first_name == match_data[:first_name] && contact_last_name == match_data[:last_name]
+              return contact
+            end
+          end
+        end
+
+        # try email match second
+        # search.results.each do |contact|
+        #   contact_first_name = contact.first_name.downcase.strip rescue ''
+        #   contact_last_name = contact.last_name.downcase.strip rescue ''
+
+        #   # match on email
+        #   if match_data[:email] && contact.email && contact.email.downcase.strip == match_data[:email]
+        #     if match_data[:first_name] != contact_first_name || match_data[:last_name] != contact_last_name
+        #       # first name and/or last name did not match the input, update contact information
+
+        #       result = contact.update(
+        #         # use the first & last name from the payload; the match_data versions have been transformed
+        #         first_name: order_payload[:shipping_address][:firstname],
+        #         last_name: order_payload[:shipping_address][:lastname]
+        #       )
+
+        #       unless result
+        #         raise 'error updating name on contact placing order'
+        #       end
+        #     end
+
+        #     return contact
+        #   end
+        # end
+
+        nil
+      end
+
+      # TODO consider optionally using fuzzy name matches in the future
+      # def fuzzy_name_matches?(first_name_1, last_name_1, first_name_2, last_name_2)
+      #   @fuzzy_comparison ||= FuzzyStringMatch::JaroWinkler.create
+
+      #   # Jarow-Winkler returns 1 for exact match
+      #   if @fuzzy_comparison.getDistance(last_name_1, last_name_2) > 0.90
+      #     # check for a match on the first name
+      #     if @fuzzy_comparison.getDistance(first_name_1, first_name_2) > 0.90
+      #       return true
+      #     end
+
+      #     # if fuzzy on first name failed; try to see if there are any nickname equivilents
+      #     if Monikers.equivalents?(first_name_1, first_name_2)
+      #       return true
+      #     end
+      #   end
+
+      #   false
+      # end
+
+    end
+  end
+end

data/lib/netsuite_rails/spec/disabler.rb

@@ -0,0 +1,27 @@
+module NetSuiteRails
+  module Spec
+    module TestDisabler
+
+      def disable_netsuite_communication
+        before do
+          @_push_disabled = NetSuiteRails::Configuration.netsuite_push_disabled
+          @_pull_disabled = NetSuiteRails::Configuration.netsuite_pull_disabled
+
+          NetSuiteRails::Configuration.netsuite_push_disabled true
+          NetSuiteRails::Configuration.netsuite_pull_disabled true
+        end
+
+        after do
+          NetSuiteRails::Configuration.netsuite_push_disabled @_push_disabled
+          NetSuiteRails::Configuration.netsuite_pull_disabled @_pull_disabled
+        end
+      end
+
+
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend NetSuiteRails::Spec::TestDisabler
+end

data/lib/netsuite_rails/spec/query_helpers.rb

@@ -0,0 +1,93 @@
+module NetSuiteRails
+  module Spec
+    module QueryHelpers
+
+      def self.included(base)
+        base.before { netsuite_timestamp(DateTime.now) }
+      end
+
+      def netsuite_timestamp(stamp = nil)
+        if stamp.nil?
+          @netsuite_timestamp ||= (Time.now - (60 * 2)).to_datetime
+        else
+          @netsuite_timestamp = stamp
+        end
+      end
+
+      def get_last_netsuite_object(record)
+        # TODO support passing custom record ref
+
+        if record.is_a?(Class)
+          record_class = record
+          is_custom_record = false
+        else
+          record_class = record.netsuite_record_class
+          is_custom_record = record.netsuite_custom_record?
+        end
+
+        search = record_class.search({
+          criteria: {
+            basic:
+            (
+            if is_custom_record
+              [
+                {
+                  field: 'recType',
+                  operator: 'is',
+                  value: NetSuite::Records::CustomRecordRef.new(internal_id: record.class.netsuite_custom_record_type_id)
+                },
+                {
+                  field: 'lastModified',
+                  operator: 'after',
+                  value: netsuite_timestamp
+                }
+              ]
+            else
+              [
+                {
+                  field: 'lastModifiedDate',
+                  operator: 'after',
+                  value: netsuite_timestamp
+                }
+              ]
+            end + 
+
+            if [ NetSuite::Records::SalesOrder, NetSuite::Records::ItemFulfillment, NetSuite::Records::Invoice ].include?(record_class)
+              [
+                {
+                  field: 'type',
+                  operator: 'anyOf',
+                  value: [ '_' + record_class.name.demodulize.lower_camelcase ]
+                }
+              ]
+            else
+              []
+            end
+            )
+          }
+        })
+
+        return nil if search.results.blank?
+
+        if is_custom_record
+          NetSuite::Records::CustomRecord.get(
+            internal_id: search.results.first.internal_id.to_i,
+            type_id: record.class.netsuite_custom_record_type_id
+          )
+        else
+          record_class.get(search.results.first.internal_id.to_i)
+        end
+      end
+      
+      # convenience method for inspecting objects in a live IRB session
+      def netsuite_url(object)
+        `open "#{NetSuiteRails::UrlHelper.netsuite_url(object)}"`
+      end
+
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include NetSuiteRails::Spec::QueryHelpers
+end

data/lib/netsuite_rails/spec/spec_helper.rb

@@ -1,86 +1,9 @@
 require 'netsuite'
 require 'savon/mock/spec_helper'
 
-module NetSuiteRails::TestHelpers
-
-  def self.included(base)
-    base.before { netsuite_timestamp(DateTime.now) }
-  end
-
-  def netsuite_timestamp(stamp = nil)
-    if stamp.nil?
-      @netsuite_timestamp ||= (Time.now - (60 * 2)).to_datetime
-    else
-      @netsuite_timestamp = stamp
-    end
-  end
-
-  def get_last_netsuite_object(record)
-    # TODO support passing custom record ref
-
-    if record.is_a?(Class)
-      record_class = record
-      is_custom_record = false
-    else
-      record_class = record.netsuite_record_class
-      is_custom_record = record.netsuite_custom_record?
-    end
-
-    search = record_class.search({
-      criteria: {
-        basic:
-        (
-        if is_custom_record
-          [
-            {
-              field: 'recType',
-              operator: 'is',
-              value: NetSuite::Records::CustomRecordRef.new(internal_id: record.class.netsuite_custom_record_type_id)
-            },
-            {
-              field: 'lastModified',
-              operator: 'after',
-              value: netsuite_timestamp
-            }
-          ]
-        else
-          [
-            {
-              field: 'lastModifiedDate',
-              operator: 'after',
-              value: netsuite_timestamp
-            }
-          ]
-        end + 
-
-        if record_class == NetSuite::Records::SalesOrder
-          [
-            {
-              field: 'type',
-              operator: 'anyOf',
-              value: [ '_salesOrder' ]
-            }
-          ]
-        else
-          []
-        end
-        )
-      }
-    })
-
-    if is_custom_record
-      NetSuite::Records::CustomRecord.get(
-        internal_id: search.results.first.internal_id.to_i,
-        type_id: record.class.netsuite_custom_record_type_id
-      )
-    else
-      record_class.get(search.results.first.internal_id.to_i)
-    end
-  end
-
-end
+require 'netsuite_rails/spec/query_helpers'
+require 'netsuite_rails/spec/disabler'
 
 RSpec.configure do |config|
-  config.include NetSuiteRails::TestHelpers, type: :feature
   config.include Savon::SpecHelper
 end