netsuite_rails 0.1.0

data/lib/netsuite_rails/record_sync.rb

@@ -0,0 +1,235 @@
+module NetSuiteRails
+  module RecordSync
+
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
+
+      SyncTrigger.attach(klass)
+      PollManager.attach(klass)
+    end
+
+    module ClassMethods
+      def netsuite_poll(opts = {})
+        RecordSync::PullManager.poll(self, opts)
+      end
+
+      attr_accessor :netsuite_custom_record_type_id
+      attr_accessor :netsuite_sync_options
+      attr_accessor :netsuite_credentials
+
+      # TODO is there a better way to implement callback chains?
+      #      https://github.com/rails/rails/blob/0c0f278ab20f3042cdb69604166e18a61f8605ad/activesupport/lib/active_support/callbacks.rb#L491
+
+      def before_netsuite_push(callback = nil, &block)
+        @before_netsuite_push ||= []
+        @before_netsuite_push << (callback || block) if callback || block
+        @before_netsuite_push
+      end
+
+      def after_netsuite_push(callback = nil, &block)
+        @after_netsuite_push ||= []
+        @after_netsuite_push << (callback || block) if callback || block
+        @after_netsuite_push
+      end
+
+      def after_netsuite_pull(callback = nil, &block)
+        @after_netsuite_pull ||= []
+        @after_netsuite_pull << (callback || block) if callback || block
+        @after_netsuite_pull
+      end
+
+      def netsuite_field_map(field_mapping = nil)
+        if field_mapping.nil?
+          @netsuite_field_map ||= {}
+        else
+          @netsuite_field_map = field_mapping
+        end
+
+        @netsuite_field_map
+      end
+
+      def netsuite_local_fields
+        @netsuite_field_map.except(:custom_field_list).keys + (@netsuite_field_map[:custom_field_list] || {}).keys
+      end
+
+      def netsuite_field_hints(list = nil)
+        if list.nil?
+          @netsuite_field_hints ||= {}
+        else
+          @netsuite_field_hints = list
+        end
+      end
+
+      # TODO persist type for CustomRecordRef
+      def netsuite_record_class(record_class = nil, custom_record_type_id = nil)
+        if record_class.nil?
+          @netsuite_record_class
+        else
+          @netsuite_record_class = record_class
+          @netsuite_custom_record_type_id = custom_record_type_id
+        end
+      end
+
+      # there is a model level of this method in order to be based on the model level record class
+      def netsuite_custom_record?
+        self.netsuite_record_class == NetSuite::Records::CustomRecord
+      end
+
+      # :read_only, :aggressive (push & update on save), :write_only, :read_write
+      def netsuite_sync(flag = nil, opts = {})
+        if flag.nil?
+          @netsuite_sync_options ||= {}
+          @netsuite_sync ||= :read_only
+        else
+          @netsuite_sync = flag
+          @netsuite_sync_options = opts
+        end
+      end
+    end
+
+    attr_accessor :netsuite_manual_fields
+
+    # these methods are here for easy model override
+
+    def netsuite_sync_options
+      self.class.netsuite_sync_options
+    end
+
+    def netsuite_sync
+      self.class.netsuite_sync
+    end
+
+    def netsuite_record_class
+      self.class.netsuite_record_class
+    end
+
+    def netsuite_field_map
+      self.class.netsuite_field_map
+    end
+
+    def netsuite_field_hints
+      self.class.netsuite_field_hints
+    end
+
+    # assumes netsuite_id field on activerecord
+
+    def netsuite_pulling?
+      @netsuite_pulling ||= false
+    end
+
+    def netsuite_pulled?
+      @netsuite_pulled ||= false
+    end
+
+    def netsuite_pull
+      netsuite_extract_from_record(netsuite_pull_record)
+    end
+
+    def netsuite_pull_record
+      if netsuite_custom_record?
+        NetSuite::Records::CustomRecord.get(
+          internal_id: self.netsuite_id,
+          type_id: self.class.netsuite_custom_record_type_id
+        )
+      else
+        self.netsuite_record_class.get(self.netsuite_id)
+      end
+    end
+
+    def netsuite_push(opts = {})
+      NetSuiteRails::RecordSync::PushManager.push(self, opts)
+    end
+
+    def netsuite_extract_from_record(netsuite_record)
+      @netsuite_pulling = true
+
+      field_hints = self.netsuite_field_hints
+
+      custom_field_list = self.netsuite_field_map[:custom_field_list] || {}
+
+      all_field_list = self.netsuite_field_map.except(:custom_field_list) || {}
+      all_field_list.merge!(custom_field_list)
+
+      # self.netsuite_normalize_datetimes(:pull)
+
+      # handle non-collection associations
+      association_keys = self.reflections.values.reject(&:collection?).map(&:name)
+
+      all_field_list.each do |local_field, netsuite_field|
+        is_custom_field = custom_field_list.keys.include?(local_field)
+
+        if netsuite_field.is_a?(Proc)
+          netsuite_field.call(self, netsuite_record, :pull)
+          next
+        end
+
+        field_value = if is_custom_field
+          netsuite_record.custom_field_list.send(netsuite_field).value rescue ""
+        else
+          netsuite_record.send(netsuite_field)
+        end
+
+        if field_value.blank?
+          # TODO possibly nil out the local value?
+          next
+        end
+
+        if association_keys.include?(local_field)
+          field_value = self.reflections[local_field].klass.where(netsuite_id: field_value.internal_id).first_or_initialize
+        elsif is_custom_field
+          # TODO I believe this only handles a subset of all the possibly CustomField values
+          if field_value.present? && field_value.is_a?(Hash) && field_value.has_key?(:name)
+            field_value = field_value[:name]
+          end
+
+          if field_value.present? && field_value.is_a?(NetSuite::Records::CustomRecordRef)
+            field_value = field_value.attributes[:name]
+          end
+        else
+          # then it's not a custom field
+        end
+
+        # 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
+        end
+
+        self.send(:"#{local_field}=", field_value)
+      end
+
+      netsuite_execute_callbacks(self.class.after_netsuite_pull, netsuite_record)
+
+      @netsuite_pulling = false
+      @netsuite_pulled = true
+
+      # return netsuite record for debugging
+      netsuite_record
+    end
+
+    def new_netsuite_record?
+      self.netsuite_id.blank?
+    end
+
+    def netsuite_custom_record?
+      self.netsuite_record_class == NetSuite::Records::CustomRecord
+    end
+
+    # TODO this should be protected; it needs to be pushed down to the Push/Pull manager level
+
+    def netsuite_execute_callbacks(list, record)
+      list.each do |callback|
+        if callback.is_a?(Symbol)
+          self.send(callback, record)
+        else
+          instance_exec(record, &callback)
+        end
+      end
+    end
+
+  end
+end

data/lib/netsuite_rails/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+require 'netsuite'
+
+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)
+    search = record.netsuite_record_class.search({
+      criteria: {
+        basic:
+        if record.netsuite_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.netsuite_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.netsuite_record_class.get(search.results.first.internal_id.to_i)
+    end
+  end
+
+end

data/lib/netsuite_rails/sub_list_sync.rb

@@ -0,0 +1,31 @@
+module NetSuiteRails
+  module SubListSync
+
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
+
+      NetSuiteRails::SyncTrigger.attach(klass)
+    end
+
+    # one issue here is that sublist items dont' have an internal ID until
+    # they are created, but they are created in the context of a parent record
+
+    # some sublists don't have an internal ID at all, from the docs:
+    # "...non-keyed sublists contain no referencing keys (or handles)"
+    # "...Instead, you must interact with the sublist as a whole.
+    # In non-keyed sublists, the replaceAll attribute is ignored and behaves as if
+    # it were set to TRUE for all requests. Consequently, an update operation is
+    # similar to the add operation with respect to non-keyed sublists."
+
+    module ClassMethods
+      def netsuite_sublist_parent(parent = nil)
+        if parent.nil?
+          @netsuite_sublist_parent
+        else
+          @netsuite_sublist_parent = parent
+        end
+      end
+    end
+
+  end
+end

data/lib/netsuite_rails/sync_trigger.rb

@@ -0,0 +1,104 @@
+module NetSuiteRails
+  class SyncTrigger
+    class << self
+
+      # TODO think about a flag to push to NS on after_validation vs after_commit
+      # TODO think about background async record syncing (re: multiple sales order updates)
+      # TODO need to add hook for custom proc to determine if data should be pushed to netsuite
+      #      if a model has a pending/complete state we might want to only push on complete
+
+      def attach(klass)
+        if klass.include?(SubListSync)
+          klass.after_save { SyncTrigger.sublist_trigger(self) }
+          klass.after_destroy { SyncTrigger.sublist_trigger(self) }
+        elsif klass.include?(RecordSync)
+
+          # during the initial pull we don't want to push changes up
+          klass.before_save do
+            @netsuite_sync_record_import = self.new_record? && self.netsuite_id.present?
+
+            # if false record will not save
+            true
+          end
+
+          klass.after_save do
+            # need to implement this conditional on the save hook level
+            # because the coordination class doesn't know about model persistence state
+
+            if @netsuite_sync_record_import
+              # pull the record down if it has't been pulled yet
+              # this is useful when this is triggered by a save on a parent record which has this
+              # record as a related record
+
+              unless self.netsuite_pulled?
+                SyncTrigger.record_pull_trigger(self)
+              end
+            else
+              SyncTrigger.record_push_trigger(self)
+            end
+
+            @netsuite_sync_record_import = false
+          end
+        end
+
+        # TODO think on NetSuiteRails::ListSync
+      end
+
+      def record_pull_trigger(local)
+        return if NetSuiteRails::Configuration.netsuite_pull_disabled
+
+        record_trigger_action(local, :netsuite_pull)
+      end
+
+      def record_push_trigger(netsuite_record_rep)
+        # don't update when fields are updated because of a netsuite_pull
+        return if netsuite_record_rep.netsuite_pulling?
+
+        return if NetSuiteRails::Configuration.netsuite_push_disabled
+
+        # don't update if a read only record
+        return if netsuite_record_rep.netsuite_sync == :read
+
+        sync_options = netsuite_record_rep.netsuite_sync_options
+
+        # :if option is a block that returns a boolean
+        return if sync_options.has_key?(:if) && !netsuite_record_rep.instance_exec(&sync_options[:if])
+
+        record_trigger_action(netsuite_record_rep, :netsuite_push)
+      end
+
+      def record_trigger_action(local, action)
+        sync_options = local.netsuite_sync_options
+
+        credentials = if sync_options.has_key?(:credentials)
+          local.instance_exec(&sync_options[:credentials])
+        end
+
+        # TODO need to pass off the credentials to the NS push command
+        
+        # You can force sync mode in different envoirnments with the global configuration variables
+
+        if sync_options[:mode] == :sync || NetSuiteRails::Configuration.netsuite_sync_mode == :sync
+          local.send(action)
+        else
+          # TODO support the rails4 DJ implementation
+          
+          if local.respond_to?(:delay)
+            local.delay.send(action)
+          else
+            raise 'no supported delayed job method found'
+          end
+        end
+      end
+
+      def sublist_trigger(sublist_item_rep)
+        parent = sublist_item_rep.send(sublist_item_rep.class.netsuite_sublist_parent)
+        
+        if parent.class.include?(RecordSync)
+          record_push_trigger(parent)
+        end
+      end
+
+    end
+  end
+end

data/lib/netsuite_rails/tasks/netsuite.rb

@@ -0,0 +1,52 @@
+namespace :netsuite do
+
+  desc "Sync all NetSuite records using import_all"
+  task :fresh_sync => :environment do
+    NetSuiteRails::PollTimestamp.delete_all
+
+    ENV['SKIP_EXISTING'] = "true"
+
+    Rake::Task["netsuite:sync"].invoke
+  end
+
+  desc "sync all netsuite records"
+  task :sync => :environment do
+    # need to eager load to ensure that all classes are loaded into the poll manager
+    Rails.application.eager_load!
+
+    opts = {
+      skip_existing: ENV['SKIP_EXISTING'].present?
+    }
+
+    if ENV['RECORD_MODELS'].present?
+      opts[:record_models] = ENV['RECORD_MODELS'].split(',').map(&:constantize)
+    end
+
+    if ENV['LIST_MODELS'].present?
+      opts[:list_models] = ENV['LIST_MODELS'].split(',').map(&:constantize)
+    end
+
+    # TODO make push disabled configurable
+
+    # field values might change on import because of remote data structure changes
+    # stop all pushes on sync & fresh_sync to avoid pushing up data that really hasn't
+    # changed for each record
+
+    NetSuiteRails::Configuration.netsuite_push_disabled true
+
+    NetSuiteRails::PollManager.sync(opts)
+  end
+
+end
+
+# TODO could use this for a "updates local records with a netsuite_id with remote NS data"
+# Model.select([:netsuite_id, :id]).find_in_batches do |batch|
+#   NetSuite::Records::CustomRecord.get_list(
+#     list: batch.map(&:netsuite_id),
+#     type_id: Model::NETSUITE_RECORD_TYPE_ID
+#   ).each do |record|
+#     model = Model.find_by_netsuite_id(record.internal_id)
+#     model.extract_from_netsuite_record(record)
+#     model.save!
+#   end      
+# end

data/lib/netsuite_rails/transformations.rb

@@ -0,0 +1,44 @@
+module NetSuiteRails
+  module Transformations
+    class << self
+
+      def transform(type, value)
+        self.send(type, value)
+      end
+
+      # NS limits firstname fields to 33 characters
+      def firstname(firstname)
+        firstname[0..33]
+      end
+
+      def phone(phone)
+        formatted_phone = phone.strip
+          .gsub(/ext(ension)?/, 'x')
+          .gsub(/[^0-9x ]/, '')
+          .gsub(/[ ]{2,}/m, ' ')
+        
+        formatted_phone.gsub!(/x.*$/, '') if formatted_phone.size > 22
+
+        formatted_phone
+      end
+
+      # NS will throw an error if whitespace bumpers the email string
+      def email(email)
+        email.strip
+      end
+
+      # https://www.reinteractive.net/posts/168-dealing-with-timezones-effectively-in-rails
+      # http://stackoverflow.com/questions/16818180/ruby-rails-how-do-i-change-the-timezone-of-a-time-without-changing-the-time
+      # http://alwayscoding.ca/momentos/2013/08/22/handling-dates-and-timezones-in-ruby-and-rails/
+
+      def date(date)
+        date.change(offset: "-07:00", hour: 24 - (8 + NetSuiteRails::Configuration.netsuite_instance_time_zone_offset))
+      end
+
+      def datetime(datetime)
+        datetime.change(offset: "-08:00") - (8 + NetSuiteRails::Configuration.netsuite_instance_time_zone_offset).hours
+      end
+
+    end
+  end
+end

data/lib/netsuite_rails/url_helper.rb

@@ -0,0 +1,31 @@
+module NetSuiteRails
+  module UrlHelper
+
+    # TODO create a xxx_netsuite_url helper generator
+
+    def self.netsuite_url(record = self)
+      prefix = "https://system#{".sandbox" if NetSuite::Configuration.sandbox}.netsuite.com/app"
+
+      record_class = record.netsuite_record_class
+      internal_id = record.netsuite_id
+
+      # https://system.sandbox.netsuite.com/app/common/scripting/scriptrecordlist.nl
+      # https://system.sandbox.netsuite.com/app/common/scripting/script.nl
+
+      if record.netsuite_custom_record?
+        "#{prefix}/common/custom/custrecordentry.nl?id=#{internal_id}&rectype=#{record.class.netsuite_custom_record_type_id}"
+      elsif [ NetSuite::Records::InventoryItem, NetSuite::Records::NonInventorySaleItem, NetSuite::Records::AssemblyItem].include?(record_class)
+        "#{prefix}/common/item/item.nl?id=#{internal_id}"
+      elsif record_class == NetSuite::Records::Task
+        "#{prefix}/crm/calendar/task.nl?id=#{internal_id}"
+      elsif record_class == NetSuite::Records::Customer
+        "#{prefix}/common/entity/custjob.nl?id=#{internal_id}"
+      elsif record_class == NetSuite::Records::Contact
+        "#{prefix}/common/entity/contact.nl?id=#{internal_id}"
+      elsif [ NetSuite::Records::SalesOrder, NetSuite::Records::Invoice, NetSuite::Records::CustomerRefund ].include?(record_class)
+        "#{prefix}/accounting/transactions/transaction.nl?id=#{internal_id}"
+      end
+    end
+
+  end
+end

data/lib/netsuite_rails.rb

@@ -0,0 +1 @@
+require 'netsuite_rails/netsuite_rails'

data/netsuite_rails.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = "netsuite_rails"
+  s.version       = "0.1.0"
+  s.authors       = ["Michael Bianco"]
+  s.email         = ["mike@cliffsidemedia.com"]
+  s.summary       = %q{Write Rails applications that integrate with NetSuite}
+  s.homepage      = "http://github.com/netsweet/netsuite_rails"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'netsuite', '~> 0.3'
+  s.add_dependency 'rails', '>= 3.2.16'
+
+  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end