netsuite_rails 0.1.0 → 0.2.0

data/.gitignore

@@ -1,2 +1,5 @@
+db/
+tmp/
+.bundle/
 Gemfile.lock
 vendor/

data/.travis.yml

@@ -0,0 +1,3 @@
+notifications:
+  email: false
+script: bundle exec rspec

data/Gemfile

@@ -2,10 +2,20 @@ source 'https://rubygems.org'
 gemspec
 
 # TODO would like to support easy NetSuite VCR recording in the future
-# group :test do
-#   gem 'vcr'
-#   gem 'rspec', '~> 2.14'
-#   gem 'rack-test'
-#   gem 'webmock'
-#   gem 'shoulda-matchers'
-# end
+group :test do
+  # gem 'vcr'
+  # gem 'rspec', '~> 2.14'
+  # gem 'rack-test'
+  # gem 'webmock'
+
+  gem 'faker'
+  gem 'shoulda-matchers'
+  gem 'rails', '3.2.16'
+  gem 'sqlite3', :platform => :ruby
+
+  gem 'rspec-rails', '~> 3.1'
+  gem 'pry-nav'
+  
+  gem 'rerun'
+  gem 'rb-fsevent'
+end

data/README.md

@@ -1,8 +1,10 @@
+[![Build Status](https://travis-ci.org/NetSweet/netsuite_rails.svg?branch=master)](https://travis-ci.org/NetSweet/netsuite_rails)
+
 # NetSuite Rails
 
 **Note:** Documentation is horrible... look at the code for details.
 
-Build custom rails application that sync to NetSuite.
+Build custom Ruby on Rails applications that sync to NetSuite.
 
 ## Installation
 
@@ -19,9 +21,8 @@ rails g netsuite_rails:install
 ### Date & Time
 
 ```ruby
-NetSuiteRails.configure do
-	
-end
+# set your timezone offset
+NetSuiteRails::Configuration.netsuite_instance_time_zone_offset(-6)
 ```
 
 ## Usage
@@ -32,6 +33,10 @@ When using a proc in a NS mapping, you are responsible for setting local and rem
 
 for pushing tasks to DJ https://github.com/collectiveidea/delayed_job/wiki/Rake-Task-as-a-Delayed-Job
 
+`:if` for controlling when syncing occurs
+
+TODO hooks for before/after push/pull
+
 ### Syncing
 
 ```bash

data/lib/netsuite_rails/configuration.rb

@@ -2,6 +2,8 @@ module NetSuiteRails
   module Configuration
     extend self
 
+    NETSUITE_MAX_PAGE_SIZE = 1000
+
     def reset!
       attributes.clear
     end
@@ -44,7 +46,7 @@ module NetSuiteRails
 
     def polling_page_size(size = nil)
       if size.nil?
-        attributes[:size] ||= 1000
+        attributes[:size] ||= NETSUITE_MAX_PAGE_SIZE
       else
         attributes[:size] = size
       end

data/lib/netsuite_rails/list_sync/poll_manager.rb

@@ -0,0 +1,30 @@
+module NetSuiteRails
+  module ListSync
+    module PollManager
+      extend self
+
+      def poll(klass, opts = {})
+        custom_list = NetSuite::Records::CustomList.get(klass.netsuite_list_id)
+
+        process_results(klass, opts, custom_list.custom_value_list.custom_value)
+      end
+
+      def process_results(klass, opts, list)
+        list.each do |custom_value|
+          local_record = klass.where(netsuite_id: custom_value.attributes[:value_id]).first_or_initialize
+
+          if local_record.respond_to?(:value=)
+            local_record.value = custom_value.attributes[:value]
+          end
+
+          if local_record.respond_to?(:inactive=)
+            local_record.inactive = custom_value.attributes[:is_inactive]
+          end
+
+          local_record.save!
+        end
+      end
+
+    end
+  end
+end

data/lib/netsuite_rails/list_sync.rb

@@ -4,7 +4,7 @@ module NetSuiteRails
     def self.included(klass)
       klass.send(:extend, ClassMethods)
 
-      PollManager.attach(klass)
+      PollTrigger.attach(klass)
     end
 
     module ClassMethods
@@ -17,7 +17,7 @@ module NetSuiteRails
       end
 
       def netsuite_poll(opts = {})
-        NetSuiteRails::ListSync::PullManager.poll(self, opts)
+        NetSuiteRails::ListSync::PollManager.poll(self, opts)
       end
     end
 

data/lib/netsuite_rails/netsuite_rails.rb

@@ -1,18 +1,28 @@
+require 'netsuite'
+
 require 'netsuite_rails/configuration'
 require 'netsuite_rails/poll_timestamp'
 require 'netsuite_rails/transformations'
-require 'netsuite_rails/poll_manager'
+require 'netsuite_rails/url_helper'
+
+require 'netsuite_rails/poll_trigger'
 require 'netsuite_rails/sync_trigger'
 require 'netsuite_rails/sub_list_sync'
+
 require 'netsuite_rails/record_sync'
+require 'netsuite_rails/record_sync/poll_manager'
 require 'netsuite_rails/record_sync/pull_manager'
 require 'netsuite_rails/record_sync/push_manager'
+
 require 'netsuite_rails/list_sync'
-require 'netsuite_rails/list_sync/pull_manager'
-require 'netsuite_rails/url_helper'
+require 'netsuite_rails/list_sync/poll_manager'
 
 module NetSuiteRails
 
+  def self.rails4?
+    Rails::VERSION::MAJOR >= 4
+  end
+
   class Railtie < ::Rails::Railtie
     rake_tasks do
       load 'netsuite_rails/tasks/netsuite.rb'

data/lib/netsuite_rails/poll_timestamp.rb

@@ -4,8 +4,13 @@ module NetSuiteRails
 
     validates :key, presence: true, uniqueness: true
 
+    def self.for_class(klass)
+      self.where(key: "netsuite_poll_#{klass.to_s.downcase}timestamp").first_or_initialize
+    end
+
     def self.table_name_prefix
       'netsuite_'
     end
+    
   end
 end

data/lib/netsuite_rails/{poll_manager.rb → poll_trigger.rb}

@@ -1,5 +1,5 @@
 module NetSuiteRails
-  class PollManager
+  class PollTrigger
 
     class << self
 
@@ -33,7 +33,7 @@ module NetSuiteRails
 
           Rails.logger.info "NetSuite: Syncing #{klass.to_s}"
           
-          preference = PollTimestamp.where(key: "netsuite_poll_#{klass.to_s.downcase}timestamp").first_or_initialize
+          preference = PollTimestamp.for_class(klass)
 
           # check if we've never synced before
           if preference.new_record?
@@ -43,7 +43,7 @@ module NetSuiteRails
             last_poll_date = preference.value
             last_poll_date = DateTime.parse(last_poll_date) unless last_poll_date.is_a?(DateTime)
 
-            if DateTime.now - last_poll_date > sync_frequency
+            if DateTime.now.to_i - last_poll_date.to_i > sync_frequency
               Rails.logger.info "NetSuite: Syncing #{klass} modified since #{last_poll_date}"
               klass.netsuite_poll({ last_poll: last_poll_date }.merge(opts))
             else
@@ -55,6 +55,21 @@ module NetSuiteRails
           preference.save!
         end
       end
+
+      def update_local_records(opts = {})
+        record_models = opts[:record_models] || @record_models
+        list_models = opts[:list_models] || @list_models
+
+        # TODO only records are supported right now
+        # list_models.each do |klass|
+        #   Rails.logger.info "NetSuite: Syncing #{klass}"
+        #   klass.netsuite_poll
+        # end
+
+        record_models.each do |klass|
+          NetSuiteRails::RecordSync::PollManager.update_local_records(klass, opts)
+        end
+      end
       
     end
 

data/lib/netsuite_rails/record_sync/poll_manager.rb

@@ -0,0 +1,186 @@
+module NetSuiteRails
+  module RecordSync
+    module PollManager
+      extend self
+
+      def update_local_records(klass, opts = {})
+        klass.select([:netsuite_id, :id]).find_in_batches(batch_size: NetSuiteRails::Configuration.polling_page_size) do |local_batch|
+          netsuite_batch = if klass.netsuite_custom_record?
+            NetSuite::Records::CustomRecord.get_list(
+              list: local_batch.map(&:netsuite_id),
+              type_id: klass.netsuite_custom_record_type_id,
+              allow_incomplete: true
+            )
+          else
+            klass.netsuite_record_class.get_list(
+              list: local_batch.map(&:netsuite_id),
+              allow_incomplete: true
+            )
+          end
+
+          unless netsuite_batch
+            binding.pry
+          end
+
+          netsuite_batch.each do |netsuite_record|
+            self.process_search_result_item(klass, opts, netsuite_record)
+          end
+        end
+      end
+
+      def poll(klass, opts = {})
+        opts = {
+          import_all: false,
+          page_size: NetSuiteRails::Configuration.polling_page_size,
+        }.merge(opts)
+
+        opts[:netsuite_record_class] ||= klass.netsuite_record_class
+        opts[:saved_search_id] ||= klass.netsuite_sync_options[:saved_search_id]
+
+        search = opts[:netsuite_record_class].search(
+          poll_criteria(klass, opts).merge({
+            preferences: {
+              body_fields_only: false,
+              page_size: opts[:page_size]
+            }
+          })
+        )
+
+        # TODO more robust error reporting
+        unless search
+          raise 'error running netsuite sync'
+        end
+
+        process_search_results(klass, opts, search)
+      end
+
+      def poll_criteria(klass, opts)
+        search_criteria = {
+          criteria: {
+            basic: poll_basic_criteria(klass, opts)
+          }
+        }
+
+        if opts[:saved_search_id]
+          search_criteria[:criteria][:saved] = opts[:saved_search_id]
+        end
+
+        if needs_get_list?(opts)
+          search_criteria[:columns] = {
+            'listRel:basic' => [
+              'platformCommon:internalId/' => {},
+            ],
+          }
+        end
+
+        search_criteria
+      end
+
+      def poll_basic_criteria(klass, opts)
+        opts = {
+          criteria: [],
+          # last_poll: DateTime
+        }.merge(opts)
+
+        # allow custom criteria to be passed directly to the sync call
+        criteria = opts[:criteria] || []
+
+        # allow custom criteria from the model level
+        criteria += klass.netsuite_sync_options[:criteria] || []
+
+        if opts[:netsuite_record_class] == NetSuite::Records::CustomRecord
+          opts[:netsuite_custom_record_type_id] ||= klass.netsuite_custom_record_type_id
+          
+          criteria << {
+            field: 'recType',
+            operator: 'is',
+            value: NetSuite::Records::CustomRecordRef.new(internal_id: opts[:netsuite_custom_record_type_id])
+          }
+        end
+
+        unless opts[:import_all]
+          criteria << {
+            # CustomRecordSearchBasic uses lastModified instead of the standard lastModifiedDate
+            field: (klass.netsuite_custom_record?) ? 'lastModified' : 'lastModifiedDate',
+            operator: 'after',
+            value: opts[:last_poll]
+          }
+        end
+
+        criteria
+      end
+
+      def process_search_results(klass, opts, search)
+        opts = {
+          skip_existing: false,
+          full_record_data: -1,
+        }.merge(opts)
+
+        Rails.logger.info "NetSuite: Processing #{search.total_records} over #{search.total_pages} pages"
+
+        # TODO need to improve the conditional here to match the get_list call conditional belo
+        if opts[:import_all] && opts[:skip_existing]
+          synced_netsuite_list = klass.pluck(:netsuite_id)
+        end
+        
+        search.results_in_batches do |batch|
+          # a saved search is processed as a advanced search; advanced search often does not allow you to retrieve
+          # all of the fields (ex: addressbooklist on customer) that a normal search does
+          # the only way to get those fields is to pull down the full record again using getAll
+
+          if needs_get_list?(opts)
+            filtered_netsuite_id_list = batch.map(&:internal_id).map(&:to_i)
+
+            if opts[:skip_existing] == true
+              filtered_netsuite_id_list.reject! { |netsuite_id| synced_netsuite_list.include?(netsuite_id) }
+            end
+
+            if filtered_netsuite_id_list.present?
+              opts[:netsuite_record_class].get_list(list: filtered_netsuite_id_list)
+            else
+              []
+            end
+          else
+            batch
+          end.each do |netsuite_record|
+            self.process_search_result_item(klass, opts, netsuite_record)
+          end
+        end
+      end
+
+      def process_search_result_item(klass, opts, netsuite_record)
+        local_record = klass.where(netsuite_id: netsuite_record.internal_id).first_or_initialize
+
+        # when importing lots of records during an import_all skipping imported records is important
+        return if opts[:skip_existing] == true && !local_record.new_record?
+
+        local_record.netsuite_extract_from_record(netsuite_record)
+
+        # TODO optionally throw fatal errors; we want to skip fatal errors on intial import
+
+        unless local_record.save
+          Rails.logger.error "NetSuite: Error pulling record #{klass} NS ID #{netsuite_record.internal_id} #{local_record.errors.full_messages}"
+        end
+      end
+
+      def needs_get_list?(opts)
+        (opts[:saved_search_id].present? && opts[:full_record_data] != false) || opts[:full_record_data] == true
+      end
+
+      # TODO this should remain in the pull manager
+
+      def extract_custom_field_value(custom_field_value)
+        if custom_field_value.present? && custom_field_value.is_a?(Hash) && custom_field_value.has_key?(:name)
+          custom_field_value = custom_field_value[:name]
+        end
+
+        if custom_field_value.present? && custom_field_value.is_a?(NetSuite::Records::CustomRecordRef)
+          custom_field_value = custom_field_value.attributes[:name]
+        end
+
+        custom_field_value
+      end
+      
+    end
+  end
+end

data/lib/netsuite_rails/record_sync/pull_manager.rb

@@ -1,147 +1,20 @@
 module NetSuiteRails
   module RecordSync
+    module PullManager
+      extend self
 
-    class PullManager
-      class << self
-
-        def poll(klass, opts = {})
-          opts = {
-            import_all: false,
-            page_size: NetSuiteRails::Configuration.polling_page_size,
-          }.merge(opts)
-
-          opts[:netsuite_record_class] ||= klass.netsuite_record_class
-
-          search = opts[:netsuite_record_class].search(
-            poll_criteria(klass, opts).merge({
-              preferences: {
-                body_fields_only: false,
-                page_size: opts[:page_size]
-              }
-            })
-          )
-
-          # TODO more robust error reporting
-          unless search
-            raise 'error running netsuite sync'
-          end
-
-          process_search_results(klass, opts, search)
+      def extract_custom_field_value(custom_field_value)
+        if custom_field_value.present? && custom_field_value.is_a?(Hash) && custom_field_value.has_key?(:name)
+          custom_field_value = custom_field_value[:name]
         end
 
-        def poll_criteria(klass, opts)
-          search_criteria = {
-            criteria: {
-              basic: poll_basic_criteria(klass, opts)
-            }
-          }
-
-          saved_search_id = opts[:saved_search_id] || klass.netsuite_sync_options[:saved_search_id]
-
-          if saved_search_id
-            search_criteria[:criteria][:saved] = saved_search_id
-          end
-
-          if needs_get_list?(opts)
-            search_criteria[:columns] = {
-              'listRel:basic' => [
-                'platformCommon:internalId/' => {},
-              ],
-            }
-          end
-
-          search_criteria
-        end
-
-        def poll_basic_criteria(klass, opts)
-          opts = {
-            criteria: [],
-            # last_poll: DateTime
-          }.merge(opts)
-
-          # allow custom criteria to be passed directly to the sync call
-          criteria = opts[:criteria] || []
-
-          # allow custom criteria from the model level
-          criteria += klass.netsuite_sync_options[:criteria] || []
-
-          if opts[:netsuite_record_class] == NetSuite::Records::CustomRecord
-            opts[:netsuite_custom_record_type_id] ||= klass.netsuite_custom_record_type_id
-            
-            criteria << {
-              field: 'recType',
-              operator: 'is',
-              value: NetSuite::Records::CustomRecordRef.new(internal_id: opts[:netsuite_custom_record_type_id])
-            }
-          end
-
-          unless opts[:import_all]
-            criteria << {
-              # CustomRecordSearchBasic uses lastModified instead of the standard lastModifiedDate
-              field: (klass.netsuite_custom_record?) ? 'lastModified' : 'lastModifiedDate',
-              operator: 'after',
-              value: opts[:last_poll]
-            }
-          end
-
-          criteria
-        end
-
-        def process_search_results(klass, opts, search)
-          opts = {
-            skip_existing: false,
-            full_record_data: -1,
-          }.merge(opts)
-
-          Rails.logger.info "NetSuite: Processing #{search.total_records} over #{search.total_pages} pages"
-
-          # TODO need to improve the conditional here to match the get_list call conditional belo
-          if opts[:import_all] && opts[:skip_existing]
-            synced_netsuite_list = klass.pluck(:netsuite_id)
-          end
-          
-          search.results_in_batches do |batch|
-            # a saved search is processed as a advanced search; advanced search often does not allow you to retrieve
-            # all of the fields (ex: addressbooklist on customer) that a normal search does
-            # the only way to get those fields is to pull down the full record again using getAll
-
-            if needs_get_list?(opts)
-              filtered_netsuite_id_list = batch.map(&:internal_id)
-
-              if opts[:skip_existing] == true
-                filtered_netsuite_id_list.reject! { |netsuite_id| synced_netsuite_list.include?(netsuite_id) }
-              end
-
-              opts[:netsuite_record_class].get_list(list: batch.map(&:internal_id))
-            else
-              batch
-            end.each do |netsuite_record|
-              self.process_search_result_item(klass, opts, netsuite_record)
-            end
-          end
-        end
-
-        def process_search_result_item(klass, opts, netsuite_record)
-          local_record = klass.where(netsuite_id: netsuite_record.internal_id).first_or_initialize
-
-          # when importing lots of records during an import_all skipping imported records is important
-          return if opts[:skip_existing] == true && !local_record.new_record?
-
-          local_record.netsuite_extract_from_record(netsuite_record)
-
-          # TODO optionally throw fatal errors; we want to skip fatal errors on intial import
-
-          unless local_record.save
-            Rails.logger.error "NetSuite: Error pulling record #{klass} NS ID #{netsuite_record.internal_id} #{local_record.errors.full_messages}"
-          end
-        end
-
-        def needs_get_list?(opts)
-          (opts[:saved_search_id].present? && opts[:full_record_data] != false) || opts[:full_record_data] == true
+        if custom_field_value.present? && custom_field_value.is_a?(NetSuite::Records::CustomRecordRef)
+          custom_field_value = custom_field_value.attributes[:name]
         end
 
+        custom_field_value
       end
-    end
 
+    end
   end
-end
+end