netsuite-soap 2025.2.3

data/spec/netsuite/support/refresh_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe 'NetSuite::Records::*#refresh' do
+  it 'should refresh a netsuite object in place' do
+    shutter_fly_record = NetSuite::Records::Customer.new({ :internal_id => 123, :external_id => 'extid', :entity_id => 'Shutter Fly', :company_name => 'Shutter Fly, Inc.' })
+    shutter_fly_record.errors = ['error 1', 'error 2']
+
+    allow(NetSuite::Records::Customer).to receive(:get).and_return(shutter_fly_record)
+
+    customer = NetSuite::Records::Customer.get({:internal_id => 123})
+
+    expect(customer.errors.size).to eq(2)
+    expect(customer.entity_id).to eq('Shutter Fly')
+    expect(customer.company_name).to eq('Shutter Fly, Inc.')
+    expect(customer.external_id).to eq('extid')
+    expect(customer.internal_id).to eq(123)
+
+    allow(NetSuite::Records::Customer).to receive(:get).and_return(NetSuite::Records::Customer.new({ :external_id => 'newextid', :entity_id => 'Totally New', :account_number => '1234' }))
+    customer.refresh
+
+    expect(customer.errors).to be_nil
+    expect(customer.entity_id).to_not eq('Shutter Fly')
+    expect(customer.account_number).to eq('1234')
+    expect(customer.company_name).to be_nil
+    expect(customer.external_id).to eq('newextid')
+    expect(customer.internal_id).to eq(123)
+  end
+end

data/spec/netsuite/support/requests_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe NetSuite::Support::Requests do
+  # Minimal class that implements the interface so partial-double stubs are valid.
+  let(:requestable_class) do
+    Class.new do
+      include NetSuite::Support::Requests
+      def request(*) end
+      def success?; true; end
+      def response_body; {}; end
+    end
+  end
+  let(:instance) { requestable_class.new }
+
+  describe '#call' do
+    before do
+      allow(instance).to receive(:request)
+      allow(instance).to receive(:success?)
+      allow(instance).to receive(:response_body)
+    end
+
+    it 'calls #request' do
+      expect(instance).to receive(:request)
+      instance.call
+    end
+
+    it 'calls #build_response' do
+      expect(instance).to receive(:build_response)
+      instance.call
+    end
+
+    it 'returns a NetSuite::Response object' do
+      response = instance.call
+      expect(response).to be_kind_of(NetSuite::Response)
+    end
+  end
+
+end

data/spec/netsuite/support/search_result_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe NetSuite::Support::SearchResult do
+  before(:all) { savon.mock! }
+  after(:all) { savon.unmock! }
+
+  describe '#results' do
+    context 'empty page' do
+      it 'returns empty array' do
+        response_body = {
+          :status => {:@is_success=>"true"},
+          :total_records => "242258",
+          :page_size => "10",
+          :total_pages => "24226",
+          :page_index => "99",
+          :search_id => "WEBSERVICES_4132604_SB1_051620191060155623420663266_336cbf12",
+          :record_list => nil,
+          :"@xmlns:platform_core" => "urn:core_2016_2.platform.webservices.netsuite.com"
+        }
+        response = NetSuite::Response.new(body: response_body)
+
+        results = described_class.new(response, NetSuite::Actions::Search, {}).results
+        expect(results).to eq []
+      end
+
+      it 'returns empty search_row_list' do
+        response_body = {
+          :status => {:@is_success=>"true"},
+          :total_records => "242258",
+          :page_size => "10",
+          :total_pages => "24226",
+          :page_index => "99",
+          :search_id => "WEBSERVICES_4132604_SB1_051620191060155623420663266_336cbf12",
+          :search_row_list => nil,
+          :"@xmlns:platform_core" => "urn:core_2016_2.platform.webservices.netsuite.com"
+        }
+        response = NetSuite::Response.new(body: response_body)
+
+        results = described_class.new(response, NetSuite::Actions::Search, {}).results
+        expect(results).to eq []
+      end
+    end
+
+    it 'handles a recordList with a single element' do
+      response = File.read('spec/support/fixtures/search/single_search_result.xml')
+      savon.expects(:search).with(message: {}).returns(response)
+
+      results = NetSuite::Records::Account.search(basic: [])
+
+      expect(results.results.count).to eq 1
+    end
+  end
+end

data/spec/netsuite/support/sublist_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe NetSuite::Records::ItemFulfillmentItemList do
+	it "should create a list with a single hash as an argument" do
+		i = NetSuite::Records::ItemFulfillmentItemList.new(item: {
+			quantity: 2,
+			item_receive: true
+		})
+
+		expect(i.item.size).to eq(1)
+		expect(i.to_record["tranSales:item"].size).to eq(1)
+	end
+
+	it "should create a list with a list of hashes" do
+		i = NetSuite::Records::ItemFulfillmentItemList.new(item: [
+			{
+				quantity: 2,
+				item_receive: true
+			},
+			{
+				quantity: 1,
+				item_receive: false
+			}
+		])
+
+		expect(i.item.size).to eq(2)
+		expect(i.to_record["tranSales:item"].size).to eq(2)
+	end
+
+	it "should properly render the replace_all option" do
+		i = NetSuite::Records::ItemFulfillmentItemList.new(replace_all: false)
+
+		expect(i.sublist_key).to eq(:item)
+		expect(i.to_record["tranSales:replaceAll"]).to eq(false)
+	end
+
+	it "should accept the shorthand append syntax" do
+		i = NetSuite::Records::ItemFulfillmentItemList.new
+		i << { quantity: 1 }
+		expect(i.item.size).to eq(1)
+	end
+end

data/spec/netsuite/utilities/data_center_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe NetSuite::Utilities::DataCenter do
+  describe '#get' do
+    let(:wsdl) { "https://webservices.na1.netsuite.com" }
+    let(:account) { "BOGUSACCT" }
+    let(:response) do
+      double(
+        success?: true,
+        body: {
+          get_data_center_urls_response: {
+            get_data_center_urls_result: {
+              data_center_urls: { webservices_domain: wsdl }
+            }
+          }
+        }
+      )
+    end
+
+    context 'without caching' do
+      it 'hits the API more than once' do
+        allow(described_class).to receive(:make_data_center_call)
+          .with(account)
+          .and_return(response)
+        10.times { described_class.get(account) }
+
+        expect(described_class).to have_received(:make_data_center_call)
+          .with(account).exactly(10).times
+      end
+
+    end
+
+    context 'when caching is enabled' do
+
+      it 'doesnt hit the API when cached response is present' do
+        described_class.class_exec(account) {|acct| cache[acct] = "wsdl" }
+        allow(described_class).to receive(:make_data_center_call)
+        described_class.get(account, cache: true)
+
+        expect(described_class).to_not have_received(:make_data_center_call)
+      end
+
+      it 'hits the API at most once' do
+        allow(described_class).to receive(:make_data_center_call)
+          .with(account)
+          .and_return(response)
+        10.times { described_class.get(account, cache: true) }
+
+        expect(described_class).to have_received(:make_data_center_call)
+          .with(account).exactly(1).times
+      end
+
+      it 'hits the API after its cache is cleared' do
+        described_class.class_exec(account) {|acct| cache[acct] = "wsdl" }
+        allow(described_class).to receive(:make_data_center_call)
+          .with(account)
+          .and_return(response)
+        described_class.get(account, cache: true)
+
+        expect(described_class).to_not have_received(:make_data_center_call)
+
+        described_class.clear_cache!
+        described_class.get(account, cache: true)
+
+        expect(described_class).to have_received(:make_data_center_call)
+          .with(account).exactly(1).times
+      end
+
+      it 'hits the API if the cache contains another response' do
+        described_class.class_eval { cache["BOGUS"] = "wsdl" }
+        allow(described_class).to receive(:make_data_center_call)
+          .with(account)
+          .and_return(response)
+        expect(account).to_not eq("BOGUS")
+        described_class.get(account, cache: true)
+
+        expect(described_class).to have_received(:make_data_center_call)
+          .with(account).exactly(1).times
+      end
+    end
+
+    context 'when cache is empty' do
+
+      it 'does hit the API' do
+        expect( described_class.class_eval { cache }).to eq({})
+        allow(described_class).to receive(:make_data_center_call)
+          .with(account)
+          .and_return(response)
+
+        described_class.get(account, cache: true)
+
+        expect(described_class).to have_received(:make_data_center_call)
+          .with(account).exactly(1).times
+      end
+
+      it 'stores API response' do
+        expect( described_class.class_eval { cache }).to eq({})
+        allow(described_class).to receive(:make_data_center_call)
+          .with(account)
+          .and_return(response)
+
+        described_class.get(account, cache: true)
+
+        expect( described_class.class_eval { cache }).to eq(
+          { account => wsdl }
+        )
+      end
+    end
+  end
+end

data/spec/netsuite/utilities/request_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe NetSuite::Rest::Utilities::Request do
+  subject { described_class }
+
+  describe '#get' do
+    it { is_expected.to respond_to :get }
+    let(:default_args) do
+      { email: 'jim@godaddy.com', password: 'secret', uri: '/sandwich'}
+    end
+
+    [:email, :password, :uri].each do |key|
+      it "throws an error if no #{key} key is given" do
+        expect{
+          subject.get(default_args.delete_if{|x| x == key})
+        }.to raise_error(KeyError)
+      end
+    end
+
+    it 'returns an array with the response code and parsed body' do
+      allow(subject).to receive(:make_request).and_return(
+        double(:response, code: "200", body: [{great: :body}].to_json)
+      )
+      expect( subject.get(default_args) ).to eq ["200", [{"great" => "body"}]]
+    end
+  end
+
+
+end

data/spec/netsuite/utilities/roles_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+describe NetSuite::Rest::Utilities::Roles do
+
+  describe '#get' do
+    subject { described_class }
+    it { is_expected.to respond_to :get }
+
+    it 'invokes the request module' do
+      expect( NetSuite::Rest::Utilities::Request ).to receive(:get)
+      subject.get(email: 'jimbob@netzero.com', password: 'pickles')
+    end
+
+    it 'formats the API response if successful' do
+      allow( NetSuite::Rest::Utilities::Request ).to receive(:get).and_return(
+        ["200", {parsed: :response}]
+      )
+      expect( subject ).to receive(:format_response).with({parsed: :response}).and_return nil
+      subject.get(email: 'jimbob@netzero.com', password: 'pickles')
+    end
+
+    it 'returns the full error message if unsuccessful' do
+      allow( NetSuite::Rest::Utilities::Request ).to receive(:get).and_return(
+        ["500", {oh: :no!}]
+      )
+      expect( subject ).to_not receive(:format_response)
+      expect( subject.get(email: 'jimbob@netzero.com', password: 'pickles') ).to eq({oh: :no!})
+    end
+  end
+
+  describe '#format_response' do
+    subject { described_class.send(:format_response, parsed) }
+
+    let(:parsed) do
+      [
+        {
+          "account"=>{
+            "internalId"=>"TSTDRV15",
+            "name"=>"Honeycomb Mfg SDN (Leading)"},
+          "role"=>{
+            "internalId"=>3,
+            "name"=>"Administrator"},
+          "dataCenterURLs"=>{
+            "webservicesDomain"=>"https://webservices.na1.netsuite.com",
+            "restDomain"=>"https://rest.na1.netsuite.com",
+            "systemDomain"=>"https://system.na1.netsuite.com"}
+        },
+        {
+          "account"=>{
+            "internalId"=>"TSTDRV15",
+            "name"=>"Honeycomb Mfg SDN (Leading)"},
+          "role"=>{
+            "internalId"=>1,
+            "name"=>"Accountant"},
+           "dataCenterURLs"=>{
+             "webservicesDomain"=>"https://webservices.na1.netsuite.com",
+             "restDomain"=>"https://rest.na1.netsuite.com",
+             "systemDomain"=>"https://system.na1.netsuite.com"}
+        },
+        {
+          "account"=>{
+            "internalId"=>"TSTDRV14",
+            "name"=>"Honeycomb Mfg SDN (Leading)"},
+          "role"=>{
+            "internalId"=>1,
+            "name"=>"Accountant"},
+          "dataCenterURLs"=>{
+            "webservicesDomain"=>"https://webservices.netsuite.com",
+            "restDomain"=>"https://rest.netsuite.com",
+            "systemDomain"=>"https://system.netsuite.com"}
+        },
+      ]
+    end
+
+    it 'groups by uniq account ids' do
+      expect( subject.count ).to eq 2
+    end
+
+    it 'returns the account name and id' do
+      expect( subject.first ).to be_a Hash
+      expect( subject.first[:account_id] ).to be_a String
+      expect( subject.first[:account_name] ).to be_a String
+    end
+
+    it 'returns the account roles' do
+      expect( subject.first[:roles] ).to be_an Array
+      expect( subject.first[:roles].first ).to be_a Hash
+      expect( subject.first[:roles].first[:id] ).to be_an Integer
+      expect( subject.first[:roles].first[:name] ).to be_a String
+    end
+
+    it 'returns the wsdls' do
+      expect( subject.first[:wsdls] ).to be_a Hash
+      expect( subject.first[:wsdls][:webservices] ).to be_an Array
+      expect( subject.first[:wsdls][:rest] ).to be_an Array
+      expect( subject.first[:wsdls][:system] ).to be_an Array
+    end
+
+    it 'parses correctly' do
+      expect(subject).to eq(
+        [
+          { account_id: 'TSTDRV15',
+            account_name: 'Honeycomb Mfg SDN (Leading)',
+            roles: [
+              {
+                id: 3,
+                name: 'Administrator'
+              },
+              {
+                id: 1,
+                name: 'Accountant'
+              }
+            ],
+            wsdls: {
+              webservices:  ["https://webservices.na1.netsuite.com"],
+              rest:         ["https://rest.na1.netsuite.com"],
+              system:       ["https://system.na1.netsuite.com"]
+            }
+          },
+          { account_id: 'TSTDRV14',
+            account_name: 'Honeycomb Mfg SDN (Leading)',
+            roles: [
+              {
+                id: 1,
+                name: 'Accountant'
+              }
+            ],
+            wsdls: {
+              webservices:  ["https://webservices.netsuite.com"],
+              rest:         ["https://rest.netsuite.com"],
+              system:       ["https://system.netsuite.com"]
+            }
+          }
+        ]
+      )
+    end
+
+    it 'handles an empty response body' do
+      expect{
+        described_class.send(:format_response, [])
+      }.to_not raise_error
+    end
+
+  end
+end

data/spec/netsuite/utilities_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+require 'tzinfo'
+
+describe NetSuite::Utilities do
+  describe 'time utilities' do
+    it '#normalize_time_to_netsuite_date' do
+      ['Etc/UTC', 'America/Los_Angeles', 'America/Denver'].each do |zone|
+        ENV['TZ'] = zone
+
+        stamp = DateTime.parse('Wed, 27 Jul 2016 00:00:00 -0000')
+        formatted_date = NetSuite::Utilities.normalize_time_to_netsuite_date(stamp.to_time.to_i)
+        expect(formatted_date).to eq('2016-07-27T00:00:00-07:00')
+
+        no_dst_stamp = DateTime.parse('Sun, November 6 2017 00:00:00 -0000')
+        formatted_date = NetSuite::Utilities.normalize_time_to_netsuite_date(no_dst_stamp.to_time.to_i)
+        expect(formatted_date).to eq('2017-11-06T00:00:00-08:00')
+
+        no_dst_stamp_with_time = DateTime.parse('Sun, November 6 2017 12:11:10 -0000')
+        formatted_date = NetSuite::Utilities.normalize_time_to_netsuite_date(no_dst_stamp_with_time.to_time.to_i)
+        expect(formatted_date).to eq('2017-11-06T00:00:00-08:00')
+      end
+    end
+  end
+
+  it "#netsuite_data_center_urls" do
+    # Avoid live NetSuite calls in tests by stubbing the SOAP client response.
+    fake_client = double('Savon client')
+    allow(fake_client).to receive(:call) do |action, message:|
+      account = message['platformMsgs:account']
+      data_center_urls = case account
+                         when 'TSTDRV1576318'
+                           {
+                             webservices_domain: 'https://tstdrv1576318.suitetalk.api.netsuite.com',
+                             system_domain: 'https://tstdrv1576318.app.netsuite.com'
+                           }
+                         when '4810331'
+                           {
+                             webservices_domain: 'https://4810331.suitetalk.api.netsuite.com',
+                             system_domain: 'https://4810331.app.netsuite.com'
+                           }
+                         else
+                           { webservices_domain: nil, system_domain: nil }
+                         end
+
+      double(
+        success?: true,
+        body: {
+          get_data_center_urls_response: {
+            get_data_center_urls_result: {
+              data_center_urls: data_center_urls
+            }
+          }
+        }
+      )
+    end
+    allow(NetSuite::Configuration).to receive(:connection).and_return(fake_client)
+
+    domains = NetSuite::Utilities.netsuite_data_center_urls('TSTDRV1576318')
+    expect(domains[:webservices_domain]).to eq('https://tstdrv1576318.suitetalk.api.netsuite.com')
+    expect(domains[:system_domain]).to eq('https://tstdrv1576318.app.netsuite.com')
+
+    # ensure domains returned don't change when sandbox is enabled
+    NetSuite.configure do
+      reset!
+      sandbox true
+    end
+
+    domains = NetSuite::Utilities.netsuite_data_center_urls('TSTDRV1576318')
+    expect(domains[:webservices_domain]).to eq('https://tstdrv1576318.suitetalk.api.netsuite.com')
+    expect(domains[:system_domain]).to eq('https://tstdrv1576318.app.netsuite.com')
+
+    NetSuite.configure do
+      reset!
+      api_version '2025_2'
+    end
+
+    domains = NetSuite::Utilities.netsuite_data_center_urls('TSTDRV1576318')
+    expect(domains[:webservices_domain]).to eq('https://tstdrv1576318.suitetalk.api.netsuite.com')
+    expect(domains[:system_domain]).to eq('https://tstdrv1576318.app.netsuite.com')
+
+    domains = NetSuite::Utilities.netsuite_data_center_urls('4810331')
+    expect(domains[:webservices_domain]).to eq('https://4810331.suitetalk.api.netsuite.com')
+    expect(domains[:system_domain]).to eq('https://4810331.app.netsuite.com')
+  end
+
+  describe '#get_record' do
+    context 'caching' do
+      it 'does not hit the netsuite API' do
+        ns_account_id = 123
+        allow(NetSuite::Records::Account).to receive(:get).with(ns_account_id).once.and_return(
+          NetSuite::Records::Account.new(internal_id: ns_account_id)
+        )
+
+        ns_account = NetSuite::Utilities.get_record(NetSuite::Records::Account, ns_account_id, cache: true)
+        expect(ns_account.internal_id).to eq(ns_account_id)
+
+        ns_account = NetSuite::Utilities.get_record(NetSuite::Records::Account, ns_account_id, cache: true)
+        expect(ns_account.internal_id).to eq(ns_account_id)
+      end
+
+      it 'works on missing records' do
+        ns_account_id = 123
+        allow(NetSuite::Records::Account).to receive(:get).with(ns_account_id) do
+          raise NetSuite::RecordNotFound
+        end
+
+        20.times do
+          expect(
+            NetSuite::Utilities.get_record(
+              NetSuite::Records::Account, ns_account_id, cache: true
+            )
+          ).to eq nil
+        end
+
+        expect(NetSuite::Records::Account).to have_received(:get).exactly(1).times
+      end
+    end
+
+    it 'pulls a record by internal id' do
+      ns_account_id = 123
+      ns_account_external_id = "abc"
+      allow(NetSuite::Records::Account).to receive(:get).with({ external_id: ns_account_external_id }).once.and_return(
+        NetSuite::Records::Account.new(internal_id: ns_account_id)
+      )
+
+      ns_account = NetSuite::Utilities.get_record(NetSuite::Records::Account, ns_account_external_id, external_id: true)
+      expect(ns_account.internal_id).to eq(ns_account_id)
+    end
+
+    it 'pulls a record by external id' do
+      ns_account_id = 123
+      allow(NetSuite::Records::Account).to receive(:get).with(ns_account_id).once.and_return(
+        NetSuite::Records::Account.new(internal_id: ns_account_id)
+      )
+
+      ns_account = NetSuite::Utilities.get_record(NetSuite::Records::Account, ns_account_id)
+      expect(ns_account.internal_id).to eq(ns_account_id)
+    end
+  end
+end

data/spec/netsuite_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe NetSuite do
+  let(:config) { NetSuite::Configuration }
+
+  before do
+    config.reset!
+  end
+
+  describe '#configure' do
+    it 'allows the Configuration #email instance method to be called with instance eval' do
+      NetSuite.configure do
+        email 'me@example.com'
+      end
+      expect(config.email).to eql('me@example.com')
+    end
+
+    it 'allows the Configuration #password instance method to be called with instance eval' do
+      NetSuite.configure do
+        password 'myPassword'
+      end
+      expect(config.password).to eql('myPassword')
+    end
+
+    it 'allows the Configuration #account instance method to be called with instance eval' do
+      NetSuite.configure do
+        account 1234
+      end
+      expect(config.account).to eql(1234)
+    end
+
+    it 'allows the Configuration #wsdl instance method to be called with instance_eval' do
+      NetSuite.configure do
+        wsdl 'https://system.sandbox.netsuite.com/wsdl/v2025_2_0/netsuite.wsdl'
+      end
+      expect(config.wsdl).to eql('https://system.sandbox.netsuite.com/wsdl/v2025_2_0/netsuite.wsdl')
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..') ))
+
+require "rubygems"
+require "bundler/setup"
+
+# Silence duplicate-constant warnings caused by net-protocol being both stdlib
+# and a gem dependency under Ruby < 3.1.
+if RUBY_VERSION < "3.1.0" && Warning.respond_to?(:warn)
+  Warning.singleton_class.class_eval do
+    unless method_defined?(:_netsuite_warn)
+      alias_method :_netsuite_warn, :warn
+
+      def warn(message)
+        if message.include?("net/protocol.rb") &&
+           (message.include?("already initialized constant Net::") ||
+            message.include?("previous definition of"))
+          return
+        end
+
+        _netsuite_warn(message)
+      end
+    end
+  end
+end
+
+Bundler.require
+
+if ENV['CI'] || ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_filter '/vendor/'
+  end
+end
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir['spec/support/**/*.rb'].each { |f| require f }
+
+require "webmock/rspec"
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |m|
+    m.verify_partial_doubles = true
+  end
+  config.color = true
+  config.example_status_persistence_file_path = "tmp/rspec_examples.txt"
+  config.filter_run_when_matching :focus
+end