netsuite_rails 0.1.0 → 0.2.0

data/lib/netsuite_rails/sync_trigger.rb

@@ -1,104 +1,109 @@
 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
+  module SyncTrigger
+    extend 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
+        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
+          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)
+            unless self.netsuite_pulled?
+              SyncTrigger.record_pull_trigger(self)
             end
-
-            @netsuite_sync_record_import = false
+          else
+            SyncTrigger.record_push_trigger(self)
           end
-        end
 
-        # TODO think on NetSuiteRails::ListSync
+          @netsuite_sync_record_import = false
+        end
       end
 
-      def record_pull_trigger(local)
-        return if NetSuiteRails::Configuration.netsuite_pull_disabled
+      # TODO think on NetSuiteRails::ListSync
+    end
 
-        record_trigger_action(local, :netsuite_pull)
-      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?
 
-      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
 
-        return if NetSuiteRails::Configuration.netsuite_push_disabled
+      # don't update if a read only record
+      return if netsuite_record_rep.netsuite_sync == :read
 
-        # don't update if a read only record
-        return if netsuite_record_rep.netsuite_sync == :read
+      sync_options = netsuite_record_rep.netsuite_sync_options
 
-        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])
 
-        # :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
+
+      action_options = {
 
-        record_trigger_action(netsuite_record_rep, :netsuite_push)
+      }
+
+      if sync_options.has_key?(:credentials)
+        action_options[:credentials] = local.instance_exec(&sync_options[:credentials])
       end
 
-      def record_trigger_action(local, action)
-        sync_options = local.netsuite_sync_options
+      # 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
 
-        credentials = if sync_options.has_key?(:credentials)
-          local.instance_exec(&sync_options[:credentials])
-        end
+      if sync_options[:mode] == :sync || NetSuiteRails::Configuration.netsuite_sync_mode == :sync
+        local.send(action)
+      else
+        action_options[:modified_fields] = NetSuiteRails::RecordSync::PushManager.modified_local_fields(local).keys
 
-        # 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
+        # TODO support the rails4 DJ implementation
 
-        if sync_options[:mode] == :sync || NetSuiteRails::Configuration.netsuite_sync_mode == :sync
-          local.send(action)
+        if local.respond_to?(:delay)
+          local.delay.send(action, action_options)
         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
+          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
+    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

data/lib/netsuite_rails/tasks/netsuite.rb

@@ -1,21 +1,8 @@
 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!
-
+  def generate_options
     opts = {
-      skip_existing: ENV['SKIP_EXISTING'].present?
+      skip_existing: ENV['SKIP_EXISTING'].present? && ENV['SKIP_EXISTING'] == "true"
     }
 
     if ENV['RECORD_MODELS'].present?
@@ -26,27 +13,36 @@ namespace :netsuite do
       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
 
+    # TODO make push disabled configurable
     NetSuiteRails::Configuration.netsuite_push_disabled true
 
-    NetSuiteRails::PollManager.sync(opts)
+    opts
   end
 
-end
+  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!
 
-# 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
+    NetSuiteRails::PollTrigger.sync(self.generate_options)
+  end
+
+  desc "sync all local netsuite records"
+  task :sync_local => :environment do
+    NetSuiteRails::PollTrigger.update_local_records(generate_options)
+  end
+
+end

data/lib/netsuite_rails/url_helper.rb

@@ -6,13 +6,22 @@ module NetSuiteRails
     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
+      if record.class.to_s.start_with?('NetSuite::Records')
+        record_class = record.class
+        internal_id = record.internal_id
+        is_custom_record = false
+      else
+        record_class = record.netsuite_record_class
+        internal_id = record.netsuite_id
+        is_custom_record = record.netsuite_custom_record?
+      end
+
+      # TODO support NS classes, should jump right to the list for the class
 
       # 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?
+      if is_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}"

data/netsuite_rails.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name          = "netsuite_rails"
-  s.version       = "0.1.0"
+  s.version       = "0.2.0"
   s.authors       = ["Michael Bianco"]
   s.email         = ["mike@cliffsidemedia.com"]
   s.summary       = %q{Write Rails applications that integrate with NetSuite}
@@ -16,10 +16,10 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency 'netsuite', '~> 0.3'
+  s.add_dependency 'netsuite', '~> 0.3.2'
   s.add_dependency 'rails', '>= 3.2.16'
 
   s.add_development_dependency "bundler", "~> 1.6"
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec", '~> 3.1'
 end

data/spec/models/poll_manager_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe NetSuiteRails::RecordSync::PollManager do
+  include ExampleModels
+
+  # TODO fake a couple items in the list
+
+  let(:empty_search_results) { OpenStruct.new(results: [ OpenStruct.new(internal_id: 0) ]) }
+
+  it "should poll record sync objects" do
+  	allow(NetSuite::Records::Customer).to receive(:search).and_return(empty_search_results)
+
+  	StandardRecord.netsuite_poll(import_all: true)
+
+  	expect(NetSuite::Records::Customer).to have_received(:search)
+  end
+
+  skip "should poll and then get_list on saved search" do
+    # TODO SS enabled record
+    # TODO mock search to return one result
+    # TODO mock out get_list
+  end
+
+  it "should poll list sync objects" do
+  	allow(NetSuite::Records::CustomList).to receive(:get).and_return(OpenStruct.new(custom_value_list: OpenStruct.new(custom_value: [])))
+
+  	StandardList.netsuite_poll(import_all: true)
+
+  	expect(NetSuite::Records::CustomList).to have_received(:get)
+  end
+
+  it "should sync only available local records" do
+    NetSuiteRails::Configuration.netsuite_push_disabled true
+    StandardRecord.create! netsuite_id: 123
+    NetSuiteRails::Configuration.netsuite_push_disabled false
+
+    allow(NetSuite::Records::Customer).to receive(:get_list).and_return([OpenStruct.new(internal_id: 123)])
+    allow(NetSuiteRails::RecordSync::PollManager).to receive(:process_search_result_item)
+
+    NetSuiteRails::PollTrigger.update_local_records
+
+    expect(NetSuite::Records::Customer).to have_received(:get_list)
+  end
+
+end

data/spec/models/poll_trigger_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe NetSuiteRails::PollTrigger do
+  include ExampleModels
+
+  it "should properly sync for the first time" do
+  	allow(StandardRecord).to receive(:netsuite_poll).with(hash_including(:import_all => true))
+
+  	NetSuiteRails::PollTrigger.sync list_models: []
+
+  	expect(StandardRecord).to have_received(:netsuite_poll)
+  end
+
+  it "should trigger syncing when the time has passed is greater than frequency" do
+  	allow(StandardRecord).to receive(:netsuite_poll)
+
+  	StandardRecord.netsuite_sync_options[:frequency] = 5.minutes
+  	timestamp = NetSuiteRails::PollTimestamp.for_class(StandardRecord)
+  	timestamp.value = DateTime.now - 7.minutes
+  	timestamp.save!
+
+  	NetSuiteRails::PollTrigger.sync list_models: []
+
+  	expect(StandardRecord).to have_received(:netsuite_poll)
+  end
+end

data/spec/models/spec_helper_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+require 'netsuite_rails/spec/spec_helper'
+
+describe NetSuiteRails::TestHelpers do
+  include NetSuiteRails::TestHelpers
+  include ExampleModels
+
+  let(:fake_search_results) { OpenStruct.new(results: [ OpenStruct.new(internal_id: 0) ]) }
+
+  before do
+    allow(NetSuite::Records::Customer).to receive(:search).and_return(fake_search_results)
+    allow(NetSuite::Records::Customer).to receive(:get)
+  end
+
+  it "should accept a standard NS gem object" do
+    get_last_netsuite_object(NetSuite::Records::Customer)
+
+    expect(NetSuite::Records::Customer).to have_received(:search)
+    expect(NetSuite::Records::Customer).to have_received(:get)
+  end
+
+  it "should accept a record sync enabled object" do
+    get_last_netsuite_object(StandardRecord.new)
+
+    expect(NetSuite::Records::Customer).to have_received(:search)
+    expect(NetSuite::Records::Customer).to have_received(:get)
+  end
+end

data/spec/models/sync_trigger_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe NetSuiteRails::SyncTrigger do
+  include ExampleModels
+  
+  before do
+    allow(NetSuiteRails::RecordSync::PushManager).to receive(:push_add)
+    allow(NetSuiteRails::RecordSync::PushManager).to receive(:push_update)
+  end
+
+  it "should push new record when saved" do
+    s = StandardRecord.new
+    s.phone = Faker::PhoneNumber.phone_number
+    s.save!
+
+    expect(NetSuiteRails::RecordSync::PushManager).to have_received(:push_add)
+    expect(NetSuiteRails::RecordSync::PushManager).to_not have_received(:push_update)
+  end
+
+  it "should not push update on a pull record" do
+    s = StandardRecord.new netsuite_id: 123
+    allow(s).to receive(:netsuite_pull)
+    s.save!
+
+    expect(s).to have_received(:netsuite_pull)
+    expect(NetSuiteRails::RecordSync::PushManager).to_not have_received(:push_add)
+    expect(NetSuiteRails::RecordSync::PushManager).to_not have_received(:push_update)
+  end
+
+  it "should push an update on an existing record" do
+    s = StandardRecord.new netsuite_id: 123
+    allow(s).to receive(:netsuite_pull)
+    s.save!
+
+    s.phone = Faker::PhoneNumber.phone_number
+    s.save!
+
+    expect(NetSuiteRails::RecordSync::PushManager).to_not have_received(:push_add)
+    expect(NetSuiteRails::RecordSync::PushManager).to have_received(:push_update)
+  end
+
+  it "should push the modified attributes to the model" do
+    s = StandardRecord.new netsuite_id: 123
+    allow(s).to receive(:netsuite_pull)
+    s.save!
+
+    # delayed_job isn't included in this gem; hack it into the current record instance
+    s.instance_eval { def delay; self; end }
+    allow(s).to receive(:delay).and_return(s)
+
+    NetSuiteRails::Configuration.netsuite_sync_mode :async
+
+    s.phone = Faker::PhoneNumber.phone_number
+    s.save!
+
+    NetSuiteRails::Configuration.netsuite_sync_mode :sync
+
+    expect(s).to have_received(:delay)
+    expect(NetSuiteRails::RecordSync::PushManager).to have_received(:push_update).with(anything, anything, {:modified_fields=>{:phone=> :phone}})
+  end
+
+end

data/spec/models/url_helper_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe NetSuiteRails::UrlHelper do
+	include ExampleModels
+
+  it 'should handle a netsuite record' do
+  	c = NetSuite::Records::Customer.new internal_id: 123
+  	url = NetSuiteRails::UrlHelper.netsuite_url(c)
+
+  	expect(url).to include("cust")
+  end
+
+  it "should handle a record sync enabled record" do
+  	s = StandardRecord.new netsuite_id: 123
+  	url = NetSuiteRails::UrlHelper.netsuite_url(s)
+
+  	expect(url).to include("cust")
+  end
+
+  it "should handle a list sync enabled record" do
+  	
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,20 @@
+require 'rails/all'
+
+require 'shoulda/matchers'
+require 'rspec/rails'
+require 'faker'
+require 'pry'
+
+require 'netsuite_rails'
+
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f }
+
+TestApplication::Application.initialize!
+NetSuiteRails::PollTimestamp.delete_all
+
 RSpec.configure do |config|
+  config.color = true
+
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
@@ -6,4 +22,4 @@ RSpec.configure do |config|
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end
-end
+end

data/spec/support/config/database.yml

@@ -0,0 +1,11 @@
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/support/dynamic_models/class_builder.rb

@@ -0,0 +1,48 @@
+# https://github.com/thoughtbot/shoulda-matchers/raw/2a4b9f1e163fa9c5b84f223962d5f8e099032420/spec/support/class_builder.rb
+
+module ClassBuilder
+  def self.included(example_group)
+    example_group.class_eval do
+      after do
+        teardown_defined_constants
+      end
+    end
+  end
+
+  def define_class(class_name, base = Object, &block)
+    class_name = class_name.to_s.camelize
+
+    if Object.const_defined?(class_name)
+      Object.__send__(:remove_const, class_name)
+    end
+
+    # FIXME: ActionMailer 3.2 calls `name.underscore` immediately upon
+    # subclassing. Class.new.name == nil. So, Class.new(ActionMailer::Base)
+    # errors out since it's trying to do `nil.underscore`. This is very ugly but
+    # allows us to test against ActionMailer 3.2.x.
+    eval <<-A_REAL_CLASS_FOR_ACTION_MAILER_3_2
+    class ::#{class_name} < #{base}
+    end
+    A_REAL_CLASS_FOR_ACTION_MAILER_3_2
+
+    Object.const_get(class_name).tap do |constant_class|
+      constant_class.unloadable
+
+      if block_given?
+        constant_class.class_eval(&block)
+      end
+
+      if constant_class.respond_to?(:reset_column_information)
+        constant_class.reset_column_information
+      end
+    end
+  end
+
+  def teardown_defined_constants
+    ActiveSupport::Dependencies.clear
+  end
+end
+
+RSpec.configure do |config|
+  config.include ClassBuilder
+end

data/spec/support/dynamic_models/model_builder.rb

@@ -0,0 +1,83 @@
+# https://github.com/thoughtbot/shoulda-matchers/blob/master/spec/support/unit/helpers/model_builder.rb
+
+module ModelBuilder
+  def self.included(example_group)
+    example_group.class_eval do
+      before do
+        @created_tables ||= []
+      end
+
+      after do
+        drop_created_tables
+        ActiveSupport::Dependencies.clear
+      end
+    end
+  end
+
+  def create_table(table_name, options = {}, &block)
+    connection = ActiveRecord::Base.connection
+
+    begin
+      connection.execute("DROP TABLE IF EXISTS #{table_name}")
+      connection.create_table(table_name, options, &block)
+      @created_tables << table_name
+      connection
+    rescue Exception => e
+      connection.execute("DROP TABLE IF EXISTS #{table_name}")
+      raise e
+    end
+  end
+
+  def define_model_class(class_name, &block)
+    define_class(class_name, ActiveRecord::Base, &block)
+  end
+
+  def define_active_model_class(class_name, options = {}, &block)
+    define_class(class_name) do
+      include ActiveModel::Validations
+
+      options[:accessors].each do |column|
+        attr_accessor column.to_sym
+      end
+
+      if block_given?
+        class_eval(&block)
+      end
+    end
+  end
+
+  def define_model(name, columns = {}, &block)
+    class_name = name.to_s.pluralize.classify
+    table_name = class_name.tableize
+    table_block = lambda do |table|
+      columns.each do |name, specification|
+        if specification.is_a?(Hash)
+          table.column name, specification[:type], specification[:options]
+        else
+          table.column name, specification
+        end
+      end
+    end
+
+    if columns.key?(:id) && columns[:id] == false
+      columns.delete(:id)
+      create_table(table_name, id: false, &table_block)
+    else
+      create_table(table_name, &table_block)
+    end
+
+    define_model_class(class_name, &block)
+  end
+
+  def drop_created_tables
+    connection = ActiveRecord::Base.connection
+
+    @created_tables.each do |table_name|
+      connection.execute("DROP TABLE IF EXISTS #{table_name}")
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include ModelBuilder
+end