netsuite 0.8.2 → 0.8.7

data/lib/netsuite/support/search_result.rb

@@ -17,9 +17,10 @@ module NetSuite
       #   <platformCore:pageIndex>1</platformCore:pageIndex>
       #   <platformCore:searchId>WEBSERVICES_738944_SB2_03012013650784545962753432_28d96bd280</platformCore:searchId>
 
-      def initialize(response, result_class)
+      def initialize(response, result_class, credentials)
         @result_class = result_class
         @response = response
+        @credentials = credentials
 
         @total_records = response.body[:total_records].to_i
         @total_pages = response.body[:total_pages].to_i
@@ -28,8 +29,19 @@ module NetSuite
         if @total_records > 0
           if response.body.has_key?(:record_list)
             # basic search results
-            record_list = response.body[:record_list][:record]
-            record_list = [record_list] unless record_list.is_a?(Array)
+
+            #  `recordList` node can contain several nested `record` nodes, only one node or be empty
+            #  so we have to handle all these cases:
+            #    * { record_list: nil }
+            #    * { record_list: { record: => {...} } }
+            #    * { record_list: { record: => [{...}, {...}, ...] } }
+            record_list = if response.body[:record_list].nil?
+              []
+            elsif response.body[:record_list][:record].is_a?(Array)
+              response.body[:record_list][:record]
+            else
+              [response.body[:record_list][:record]]
+            end
 
             record_list.each do |record|
               results << result_class.new(record)
@@ -98,8 +110,11 @@ module NetSuite
           yield results
 
           next_search = @result_class.search(
-            search_id: @response.body[:search_id],
-            page_index: @response.body[:page_index].to_i + 1
+            {
+              search_id: @response.body[:search_id],
+              page_index: @response.body[:page_index].to_i + 1
+            },
+            @credentials
           )
 
           @results = next_search.results

data/lib/netsuite/utilities.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module NetSuite
   module Utilities
     extend self
@@ -37,6 +39,36 @@ module NetSuite
       server_time_response.body[:get_server_time_response][:get_server_time_result][:server_time]
     end
 
+    def netsuite_data_center_urls(account_id)
+      data_center_call_response = NetSuite::Configuration.connection({
+        # NOTE force a production WSDL so the sandbox settings are ignored
+        #      as of 1/20/18 NS will start using the account ID to determine
+        #      if a account is sandbox (123_SB1) as opposed to using a sandbox domain
+
+        wsdl: 'https://webservices.netsuite.com/wsdl/v2017_2_0/netsuite.wsdl',
+
+        # NOTE don't inherit default namespace settings, it includes the API version
+        namespaces: {
+          'xmlns:platformCore' => "urn:core_2017_2.platform.webservices.netsuite.com"
+        },
+
+        soap_header: {}
+      }).call(:get_data_center_urls, message: {
+        'platformMsgs:account' => account_id
+      })
+
+      if data_center_call_response.success?
+        data_center_call_response.body[:get_data_center_urls_response][:get_data_center_urls_result][:data_center_urls]
+      else
+        false
+      end
+    end
+
+    # TODO consider what to dop with this duplicate data center implementation
+    def data_center_url(*args)
+      DataCenter.get(*args)
+    end
+
     def backoff(options = {})
       # TODO the default backoff attempts should be customizable the global config
       options[:attempts] ||= 8
@@ -46,7 +78,7 @@ module NetSuite
       begin
         count += 1
         yield
-      rescue Exception => e
+      rescue StandardError => e
         exceptions_to_retry = [
           Errno::ECONNRESET,
           Errno::ETIMEDOUT,
@@ -83,12 +115,20 @@ module NetSuite
           # https://github.com/stripe/stripe-netsuite/issues/815
           if !e.message.include?("Only one request may be made against a session at a time") &&
             !e.message.include?('java.util.ConcurrentModificationException') &&
+            !e.message.include?('java.lang.NullPointerException') &&
+            !e.message.include?('java.lang.IllegalStateException') &&
+            !e.message.include?('java.lang.reflect.InvocationTargetException') &&
             !e.message.include?('com.netledger.common.exceptions.NLDatabaseOfflineException') &&
             !e.message.include?('com.netledger.database.NLConnectionUtil$NoCompanyDbsOnlineException') &&
             !e.message.include?('com.netledger.cache.CacheUnavailableException') &&
+            !e.message.include?('java.lang.IllegalStateException') &&
             !e.message.include?('An unexpected error occurred.') &&
+            !e.message.include?('An unexpected error has occurred.  Technical Support has been alerted to this problem.') &&
             !e.message.include?('Session invalidation is in progress with different thread') &&
+            !e.message.include?('[missing resource APP:ERRORMESSAGE:WS_AN_UNEXPECTED_ERROR_OCCURRED] [missing resource APP:ERRORMESSAGE:ERROR_ID_1]') &&
             !e.message.include?('SuiteTalk concurrent request limit exceeded. Request blocked.') &&
+            # maintenance is the new outage: this message is being used for intermittent errors
+            !e.message.include?('The account you are trying to access is currently unavailable while we undergo our regularly scheduled maintenance.') &&
             !e.message.include?('The Connection Pool is not intialized.') &&
             # it looks like NetSuite mispelled their error message...
             !e.message.include?('The Connection Pool is not intiialized.')
@@ -109,15 +149,16 @@ module NetSuite
 
     def request_failed?(ns_object)
       return false if ns_object.errors.nil? || ns_object.errors.empty?
+      ns_object.errors.any? { |x| x.type == "ERROR" }
+    end
 
-      warnings = ns_object.errors.select { |x| x.type == "WARN" }
-      errors = ns_object.errors.select { |x| x.type == "ERROR" }
-
-      # warnings.each do |warn|
-      #   log.warn(warn.message, code: warn.code)
-      # end
+    def get_field_options(recordType, fieldName)
+      options = NetSuite::Records::BaseRefList.get_select_value(
+        field: fieldName,
+        recordType: recordType
+      )
 
-      return errors.size > 0
+      options.base_refs
     end
 
     def get_item(ns_item_internal_id, opts = {})
@@ -133,6 +174,7 @@ module NetSuite
       ns_item ||= NetSuite::Utilities.get_record(NetSuite::Records::KitItem, ns_item_internal_id, opts)
       ns_item ||= NetSuite::Utilities.get_record(NetSuite::Records::SerializedInventoryItem, ns_item_internal_id, opts)
       ns_item ||= NetSuite::Utilities.get_record(NetSuite::Records::LotNumberedAssemblyItem, ns_item_internal_id, opts)
+      ns_item ||= NetSuite::Utilities.get_record(NetSuite::Records::LotNumberedInventoryItem, ns_item_internal_id, opts)
 
       if ns_item.nil?
         fail NetSuite::RecordNotFound, "item with ID #{ns_item_internal_id} not found"
@@ -196,7 +238,11 @@ module NetSuite
           field_name = 'email'
         end
 
-        field_name ||= 'name'
+        field_name ||= if record.to_s.end_with?('Item')
+          'displayName'
+        else
+          'name'
+        end
 
         # TODO remove backoff when it's built-in to search
         search = backoff { record.search({
@@ -217,25 +263,41 @@ module NetSuite
       nil
     end
 
-    def data_center_url(*args)
-      DataCenter.get(*args)
-    end
-
     # http://mikebian.co/notes-on-dates-timezones-with-netsuites-suitetalk-api/
+    # https://wyeworks.com/blog/2016/6/22/behavior-changes-in-ruby-2.4
+    # https://github.com/rails/rails/commit/c9c5788a527b70d7f983e2b4b47e3afd863d9f48
+
     # assumes UTC0 unix timestamp
     def normalize_time_to_netsuite_date(unix_timestamp)
       # convert to date to eliminate hr/min/sec
-      time = Time.at(unix_timestamp).utc.to_date.to_datetime
-
-      offset = 8
-      time = time.new_offset("-08:00")
-
-      if time.to_time.dst?
-        offset = 7
+      time = Time.at(unix_timestamp).
+        utc.
+        to_date.
+        to_datetime
+
+      # tzinfo allows us to determine the dst status of the time being passed in
+      # NetSuite requires that the time be passed to the API with the PDT TZ offset
+      # of the time passed in (i.e. not the current TZ offset of PDT)
+
+      if defined?(TZInfo)
+        # if no version is defined, less than 2.0
+        # https://github.com/tzinfo/tzinfo/blob/master/CHANGES.md#added
+        if !defined?(TZInfo::VERSION)
+          # https://stackoverflow.com/questions/2927111/ruby-get-time-in-given-timezone
+          offset = TZInfo::Timezone.get("America/Los_Angeles").period_for_utc(time).utc_total_offset_rational
+          time = time.new_offset(offset)
+        else
+          time = TZInfo::Timezone.get("America/Los_Angeles").utc_to_local(time)
+          offset = time.offset
+        end
+      else
+        # if tzinfo is not installed, let's give it our best guess: -7
+        offset = Rational(-7, 24)
         time = time.new_offset("-07:00")
       end
 
-      (time + Rational(offset, 24)).iso8601
+      time = (time + (offset * -1))
+      time.iso8601
     end
 
   end

data/lib/netsuite/version.rb

@@ -1,3 +1,3 @@
 module NetSuite
-  VERSION = '0.8.2'
+  VERSION = '0.8.7'
 end

data/netsuite.gemspec

@@ -2,8 +2,9 @@
 require File.expand_path('../lib/netsuite/version', __FILE__)
 
 Gem::Specification.new do |gem|
+  gem.licenses      = ['MIT']
   gem.authors       = ['Ryan Moran', 'Michael Bianco']
-  gem.email         = ['ryan.moran@gmail.com', 'mike@cliffsidemedia.com']
+  gem.email         = ['ryan.moran@gmail.com', 'mike@mikebian.co']
   gem.description   = %q{NetSuite SuiteTalk API Wrapper}
   gem.summary       = %q{NetSuite SuiteTalk API (SOAP) Wrapper}
   gem.homepage      = 'https://github.com/NetSweet/netsuite'
@@ -15,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = NetSuite::VERSION
 
-  gem.add_dependency 'savon', '>= 2.3.0'
+  gem.add_dependency 'savon', '>= 2.3.0', '<= 2.11.1'
 
-  gem.add_development_dependency 'rspec', '~> 3.1.0'
+  gem.add_development_dependency 'rspec', '~> 3.8.0'
 end

data/spec/netsuite/actions/login_spec.rb

@@ -41,4 +41,27 @@ describe NetSuite::Actions::Login do
       role: 234
     }) }.to raise_error(Savon::SOAPFault)
   end
+
+  it 'handles a login call when token based auth is in place' do
+    NetSuite.configure do
+      consumer_key '123'
+      consumer_secret '123'
+      token_id '123'
+      token_secret '123'
+
+      api_version '2017_2'
+    end
+
+    message = {"platformMsgs:passport"=>{"platformCore:email"=>"email", "platformCore:password"=>"password", "platformCore:account"=>"1234", "platformCore:role"=>234}}
+    savon.expects(:login).with(:message => message).returns(File.read('spec/support/fixtures/login/success.xml'))
+
+    result = NetSuite::Actions::Login.call({
+      email: 'email',
+      password: 'password',
+      role: 234
+    })
+
+    expect(result.success?).to eq(true)
+    expect(result.body[:user_id]).to_not be_nil
+  end
 end

data/spec/netsuite/actions/update_list_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe NetSuite::Actions::UpdateList do
+  before { savon.mock! }
+  after { savon.unmock! }
+
+  context 'Items' do
+    context 'one item' do
+      let(:item) do
+        [
+          NetSuite::Records::InventoryItem.new(internal_id: '624113', item_id: 'Target', upccode: 'Target')
+        ]
+      end
+
+      before do
+        savon.expects(:update_list).with(:message =>
+          {
+            'record' => [{
+              'listAcct:itemId' => 'Target',
+              '@xsi:type' => 'listAcct:InventoryItem',
+              '@internalId' => '624113'
+            }]
+          }).returns(File.read('spec/support/fixtures/update_list/update_list_one_item.xml'))
+      end
+
+      it 'makes a valid request to the NetSuite API' do
+        NetSuite::Actions::UpdateList.call(item)
+      end
+
+      it 'returns a valid Response object' do
+        response = NetSuite::Actions::UpdateList.call(item)
+        expect(response).to be_kind_of(NetSuite::Response)
+        expect(response).to be_success
+      end
+    end
+
+    context 'two items' do
+      let(:items) do
+        [
+          NetSuite::Records::InventoryItem.new(internal_id: '624172', item_id: 'Shutter Fly', upccode: 'Shutter Fly, Inc.'),
+          NetSuite::Records::InventoryItem.new(internal_id: '624113', item_id: 'Target', upccode: 'Target')
+        ]
+      end
+
+      before do
+        savon.expects(:update_list).with(:message =>
+          {
+            'record' => [{
+                'listAcct:itemId' => 'Shutter Fly',
+                '@xsi:type' => 'listAcct:InventoryItem',
+                '@internalId' => '624172'
+              },
+              {
+                'listAcct:itemId' => 'Target',
+                '@xsi:type' => 'listAcct:InventoryItem',
+                '@internalId' => '624113'
+              }
+            ]
+          }).returns(File.read('spec/support/fixtures/update_list/update_list_items.xml'))
+      end
+
+      it 'makes a valid request to the NetSuite API' do
+        NetSuite::Actions::UpdateList.call(items)
+      end
+
+      it 'returns a valid Response object' do
+        response = NetSuite::Actions::UpdateList.call(items)
+        expect(response).to be_kind_of(NetSuite::Response)
+        expect(response).to be_success
+      end
+    end
+  end
+
+  context 'with errors' do
+    let(:items) do
+      [
+        NetSuite::Records::InventoryItem.new(internal_id: '624172-bad', item_id: 'Shutter Fly', upccode: 'Shutter Fly, Inc.'),
+        NetSuite::Records::InventoryItem.new(internal_id: '624113-bad', item_id: 'Target', upccode: 'Target')
+      ]
+    end
+
+    before do
+      savon.expects(:update_list).with(:message =>
+        {
+          'record' => [{
+            'listAcct:itemId' => 'Shutter Fly',
+            '@xsi:type' => 'listAcct:InventoryItem',
+            '@internalId' => '624172-bad'
+          },
+          {
+            'listAcct:itemId' => 'Target',
+            '@xsi:type' => 'listAcct:InventoryItem',
+            '@internalId' => '624113-bad'
+          }
+          ]
+        }).returns(File.read('spec/support/fixtures/update_list/update_list_with_errors.xml'))
+    end
+
+    it 'constructs error objects' do
+      response = NetSuite::Actions::UpdateList.call(items)
+      expect(response.errors.keys).to match_array(['624172', '624113'])
+      expect(response.errors['624172'].first.code).to eq('USER_ERROR')
+      expect(response.errors['624172'].first.message).to eq('Please enter value(s) for: ItemId')
+      expect(response.errors['624172'].first.type).to eq('ERROR')
+    end
+  end
+end

data/spec/netsuite/actions/update_spec.rb

@@ -19,6 +19,48 @@ describe NetSuite::Actions::Update do
       }
     end
 
+    describe 'updating the external ID' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      # https://github.com/NetSweet/netsuite/pull/416
+      #   if the external ID is set, and the external ID field is ommitted on an update, the external ID field does not change
+      #   if the external_id field is set to nil, it should not be passed to netsuite
+      #   passing an empty string to the external ID field does not remove it
+
+      it 'does not pass the external ID to an update call if not modified or included in update options' do
+        expect(NetSuite::Actions::Update).to receive(:call).
+            with([customer.class, {}], {}).
+            and_return(response)
+
+        expect(customer.update).to be_truthy
+      end
+
+      it 'should update the external ID when the attribute on the record is set' do
+        expect(NetSuite::Actions::Update).to receive(:call).
+            with([customer.class, {external_id: 'foo'}], {}).
+            and_return(response)
+
+        customer.external_id = 'foo'
+        expect(customer.update).to be_truthy
+      end
+
+      it 'should update the external ID to nil when the attribute on the record is set' do
+        expect(NetSuite::Actions::Update).to receive(:call).
+            with([customer.class, {external_id: nil}], {}).
+            and_return(response)
+
+        expect(customer.update(external_id: nil)).to be_truthy
+      end
+
+      it 'should update the external ID to the options value not the attribute value' do
+        expect(NetSuite::Actions::Update).to receive(:call).
+            with([customer.class, {external_id: 'bar'}], {}).
+            and_return(response)
+
+        customer.external_id = 'foo'
+        expect(customer.update(external_id: 'bar')).to be_truthy
+      end
+    end
 
     context 'when successful' do
 

data/spec/netsuite/configuration_spec.rb

@@ -29,10 +29,12 @@ describe NetSuite::Configuration do
   end
 
   describe '#connection' do
+    EXAMPLE_ENDPOINT = 'https://1023.suitetalk.api.netsuite.com/services/NetSuitePort_2020_2'
     before(:each) do
       # reset clears out the password info
       config.email       'me@example.com'
       config.password    'me@example.com'
+      config.endpoint    EXAMPLE_ENDPOINT
       config.account     1023
       config.wsdl        "my_wsdl"
       config.api_version "2012_2"
@@ -57,6 +59,19 @@ describe NetSuite::Configuration do
 
       expect(config).to have_received(:cached_wsdl)
     end
+
+    it 'sets the endpoint on the Savon client' do
+      # this is ugly/brittle, but it's hard to see how else to test this
+      savon_configs = config.connection.globals.instance_eval {@options}
+      expect(savon_configs.fetch(:endpoint)).to eq(EXAMPLE_ENDPOINT)
+    end
+
+    it 'handles a nil endpoint' do
+      config.endpoint = nil
+      # this is ugly/brittle, but it's hard to see how else to test this
+      savon_configs = config.connection.globals.instance_eval {@options}
+      expect(savon_configs.fetch(:endpoint)).to eq(nil)
+    end
   end
 
   describe '#wsdl' do
@@ -166,6 +181,23 @@ describe NetSuite::Configuration do
     end
   end
 
+  describe '#endpoint' do
+    it 'can be set with endpoint=' do
+      config.endpoint = 42
+      expect(config.endpoint).to eq(42)
+    end
+
+    it 'can be set with just endpoint(value)' do
+      config.endpoint(42)
+      expect(config.endpoint).to eq(42)
+    end
+
+    it 'supports nil endpoints' do
+      config.endpoint = nil
+      expect(config.endpoint).to eq(nil)
+    end
+  end
+
   describe '#auth_header' do
     context 'when doing user authentication' do
       before do
@@ -326,15 +358,11 @@ describe NetSuite::Configuration do
 
   describe "#credentials" do
     context "when none are defined" do
-      skip "should properly create the auth credentials" do
-
-      end
+      skip "should properly create the auth credentials"
     end
 
     context "when they are defined" do
-      it "should properly replace the default auth credentials" do
-
-      end
+      skip "should properly replace the default auth credentials"
     end
   end
 
@@ -371,4 +399,81 @@ describe NetSuite::Configuration do
     end
   end
 
+  describe "#log" do
+    it 'allows a file path to be set as the log destination' do
+      file_path = Tempfile.new.path
+      config.log = file_path
+      config.logger.info "foo"
+
+      log_contents = open(file_path).read
+      expect(log_contents).to include("foo")
+    end
+
+    it 'allows an IO device to bet set as the log destination' do
+      stream = StringIO.new
+      config.log = stream
+      config.logger.info "foo"
+
+      expect(stream.string).to include("foo")
+    end
+  end
+
+  describe '#log_level' do
+    it 'defaults to :debug' do
+      expect(config.log_level).to eq(:debug)
+    end
+
+    it 'can be initially set to any log level' do
+      config.log_level(:info)
+
+      expect(config.log_level).to eq(:info)
+    end
+
+    it 'can override itself' do
+      config.log_level = :info
+
+      expect(config.log_level).to eq(:info)
+
+      config.log_level(:debug)
+
+      expect(config.log_level).to eq(:debug)
+    end
+  end
+
+  describe '#log_level=' do
+    it 'can set the initial log_level' do
+      config.log_level = :info
+
+      expect(config.log_level).to eq(:info)
+    end
+
+    it 'can override a previously set log level' do
+      config.log_level = :info
+
+      expect(config.log_level).to eq(:info)
+
+      config.log_level = :debug
+
+      expect(config.log_level).to eq(:debug)
+    end
+  end
+
+  describe 'timeouts' do
+    it 'has defaults' do
+      expect(config.read_timeout).to eql(60)
+      expect(config.open_timeout).to be_nil
+    end
+
+    it 'sets timeouts' do
+      config.read_timeout = 100
+      config.open_timeout = 60
+
+      expect(config.read_timeout).to eql(100)
+      expect(config.open_timeout).to eql(60)
+
+      # ensure no exception is raised
+      config.connection
+    end
+  end
+
 end