netsuite 0.8.4 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4706d84cf53e7897cc7f420a4af5c22230f764d0
-  data.tar.gz: a0e4db30c9a0288633a73988b7bd74916a3dbc20
+SHA256:
+  metadata.gz: acf21d9a2b7a9ee0eedee971c7ebd1af50c05c28a1a5a03dea740fc1eb22529c
+  data.tar.gz: 6b740ed5e9b8d76926d63ca2895d0370b11b0c0656bd2581f15b9133f7d7edec
 SHA512:
-  metadata.gz: 2afc60b0287c25b4a9cb4d271a363da58c5089ee0eb60d10d6f2334b06ac1bd1bbd902fce592034f53f0fe0a600147184a51668b3bf7c903513d3a1c1e310069
-  data.tar.gz: 5dadd1b9eae507ff201e01f3ab7f2d49e6e6a930d5ec1825fcc7ee2dd8087b71025a9e66700aa491b598a61606085b2c37a1f2f6f29457ade3693fe2809db925
+  metadata.gz: 2a7d9f98b1574b63a6da20d65376e1edb936f8d16d44019871b8d7e2e7f1354956eac101d038f756bc8a2256977c6afbd0742c7f7badbd6ec89a8165fdde77f8
+  data.tar.gz: 6a268c38ec15d63e50f5c713363b7cf9f8b5faf67b1a4f40c4cdadc8728a27b1d2928d36debab70db278b26d36661d5e908ba04a3235464f0b23487ac1c6b91c

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.7, 2.6, 2.5, 2.4, 2.3, 2.2, 2.1]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 vendor/
+.tags*

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.7.3

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.3

data/Gemfile

@@ -7,8 +7,5 @@ gem 'pry-nav'
 gem 'pry-rescue'
 
 # optional dependency for more accurate timezone conversion
-gem 'tzinfo'
-
-# required for CircleCI to build properly with ruby 1.9.3
-gem 'json', '~> 1.8.3'
-gem 'rack', '~> 1.6.4'
+gem 'tzinfo', '1.2.5'
+# gem 'tzinfo', '2.0.0'

data/HISTORY.md

@@ -0,0 +1,26 @@
+## Unreleased
+
+### Added
+
+*
+*
+
+### Fixed
+
+*
+*
+
+## 0.8.8
+
+### Added
+
+* Adding serialized assembly item to get_item
+* Add CostCategory record (#482)
+* Introduce search only fields (#483)
+
+### Fixed
+
+* Fix accessing custom field values returned in advanced search results (#480)
+* Fixing bug where single-selection custom multi select fields would incorrectly be parsed 3377c971d0cb727d81f4b4bc6e30edfbdfaccfd1
+* Fixed some field definitions on serialized assembly item
+* Properly extract external_id from advanced search results (#478)

data/README.md

@@ -1,6 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+**Table of Contents**
 
 - [NetSuite SuiteTalk API Ruby Gem](#netsuite-suitetalk-api-ruby-gem)
 - [Help & Support](#help--support)
@@ -13,35 +13,33 @@
   - [Custom Records & Fields](#custom-records--fields)
   - [Searching](#searching)
   - [Non-standard Operations](#non-standard-operations)
-- [About SuiteSync](#about-suitesync)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-[![Circle CI](https://circleci.com/gh/NetSweet/netsuite/tree/master.svg?style=svg)](https://circleci.com/gh/NetSweet/netsuite/tree/master)
+[![Ruby](https://github.com/NetSweet/netsuite/actions/workflows/main.yml/badge.svg)](https://github.com/NetSweet/netsuite/actions/workflows/main.yml)
 [![Slack Status](https://opensuite-slackin.herokuapp.com/badge.svg)](http://opensuite-slackin.herokuapp.com)
 [![Gem Version](https://badge.fury.io/rb/netsuite.svg)](http://badge.fury.io/rb/netsuite)
 
 # NetSuite SuiteTalk API Ruby Gem
 
 * This gem will act as a wrapper around the NetSuite SuiteTalk WebServices API.
-* The gem does not cover the entire API, only the subset contributors have used so far.
-* NetSuite is a complex system. There's a lot to learn and sparse resources available to learn from. Here's a list of [NetSuite Development Resources](https://github.com/NetSweet/netsuite/wiki/NetSuite-Development-Resources) that might make things a bit less painful.
+* The gem does not cover the entire API, only the subset contributors have used so far. Please submit a PR for any functionality that's missing!
+* NetSuite is a complex system. There's a lot to learn and sparse resources available to learn from. Here's a list of [NetSuite Development Resources](https://github.com/NetSweet/netsuite/wiki/NetSuite-Development-Resources).
 
 # Help & Support
 
 Join the [slack channel](http://opensuite-slackin.herokuapp.com) for help with any NetSuite issues. Please do not post usage questions as issues in GitHub.
 
-Messages in the Slack ground are [archived here](https://suitechat.slackarchive.io). Search the archives to see if your question has been answered before.
-
 There is some additional helpful resources for NetSuite development [listed here](https://dashboard.suitesync.io/docs/resources#netsuite).
 
 # Testing
 
 Before contributing a patch make sure all existing tests pass.
 
-```
+```shell
 git clone git://github.com/NetSweet/netsuite.git
 cd netsuite
+
 bundle
 bundle exec rspec
 ```
@@ -56,18 +54,56 @@ gem 'netsuite'
 
 If you'd like more accurate time conversion support, include the `tzinfo` gem.
 
-This gem is built for ruby 1.9.x+, checkout the [1-8-stable](https://github.com/NetSweet/netsuite/tree/1-8-stable) branch for ruby 1.8.x support.
+This gem is built for ruby 2.6.x+, but should work on older versions down to 1.9. There's a [1-8-stable](https://github.com/NetSweet/netsuite/tree/1-8-stable) branch for ruby 1.8.x support.
 
 ## Configuration
 
-Not sure how to find your account id? Search for "web service preferences" in the NetSuite global search.
+The most important thing you'll need is your NetSuite account ID. Not sure how to find your account id? [Here's a guide.](http://mikebian.co/find-netsuite-web-services-account-number/)
+
+How you connect to NetSuite has changed a lot over the years and differs between API versions. For instance:
+
+* Older API versions (~2015) allowed authentication via username and password
+* Newever API versions (> 2016) still allowed for username and password authentication, but required an application ID
+* "OAuth", which requires four separate keys to be manually generated, was supported sometime after 2015
+* API versions greater than 2018_2 require `endpoint` to be set directly ([more info](https://github.com/NetSweet/netsuite/pull/473))
+
+Here's an example connection configuration. You don't want to actually use username + password config; token based authentication is detailed below in a separate section:
+
+```ruby
+NetSuite.configure do
+  reset!
+
+  # production & sandbox account numbers will differ
+  account  'TSTDRV1576318'
+  api_version '2018_2'
+
+  # password-based login information
+  # in most cases you should use token based authentication instead
+  email 'email@example.com'
+  password 'password'
+  role 10
+
+  # recent API versions require a account-specific endpoint o be set
+  # use `NetSuite::Utilities.data_center_url('TSTDRV1576318')` to retrieve wsdl URL
+  # you'll want to do this in a background process and strip the protocol out of the return string
+  wsdl_domain 'tstdrv1576318.suitetalk.api.netsuite.com'
+
+  # the endpoint indicated in the > 2018_2 wsdl is invalid
+  # you must set the endpoint directly
+  # https://github.com/NetSweet/netsuite/pull/473
+  endpoint "https://#{wsdl_domain}/services/NetSuitePort_#{api_version}"
+end
+```
+
+The `wsdl_domain` configuration is most important. Note that if you use `wsdl` or other configuration options below, you'll want to look at the configuration source to understand more about how the different options interact with each other. Some of the configuration options will mutate the state of other options.
+
+Here's the various options that are are available for configuration:
 
 ```ruby
 NetSuite.configure do
   reset!
 
-  # optional, defaults to 2011_2
-  api_version	'2012_1'
+  api_version	'2018_2'
 
   # optionally specify full wsdl URL (to switch to sandbox, for example)
   wsdl          "https://webservices.sandbox.netsuite.com/wsdl/v#{api_version}_0/netsuite.wsdl"
@@ -79,21 +115,25 @@ NetSuite.configure do
   # construct the full wsdl location - e.g. "https://#{wsdl_domain}/wsdl/v#{api_version}_0/netsuite.wsdl"
   wsdl_domain   "webservices.na2.netsuite.com"
 
-  # or specify the sandbox flag if you don't want to deal with specifying a full URL
-  sandbox       true
-
   # often the netsuite servers will hang which would cause a timeout exception to be raised
-  # if you don't mind waiting (e.g. processing NS via DJ), increasing the timeout should fix the issue
-  read_timeout  100000
+  # if you don't mind waiting (e.g. processing NS via a background worker), increasing the timeout should fix the issue
+  read_timeout  100_000
 
   # you can specify a file or file descriptor to send the log output to (defaults to STDOUT)
+  # If using within a Rails app, consider setting to `Rails.logger` to leverage existing
+  # application-level log configuration
   log           File.join(Rails.root, 'log/netsuite.log')
 
-  # login information
-  email    	'email@domain.com'
-  password 	'password'
+  # Defaults to :debug level logging for Savon API calls. Decrease the verbosity
+  # by setting log_level to `:info`, for example
+  # log_level   :debug
+
+  # password-based login information
+  # in most cases you should use token based authentication instead
+  email    	  'email@domain.com'
+  password 	  'password'
   account   	'12345'
-  role      	1111
+  role        1111
 
   # optional, ensures that read-only fields don't cause API errors
   soap_header	'platformMsgs:preferences' => {
@@ -102,9 +142,9 @@ NetSuite.configure do
 end
 ```
 
-If you'd like to use a API endpoints greater than 2015_1 you'll need to specify an application ID:
+If are using username + password authentication (which you shouldn't be!) *and* you'd like to use a API endpoints greater than 2015_1 you'll need to specify an application ID:
 
-```
+```ruby
 NetSuite::Configuration.soap_header = {
    'platformMsgs:ApplicationInfo' => {
       'platformMsgs:applicationId' => 'your-netsuite-app-id'
@@ -114,7 +154,7 @@ NetSuite::Configuration.soap_header = {
 
 ### Token based Authentication
 
-OAuth credentials are also supported. [Learn more about how to set up token based authentication here](http://mikebian.co/using-netsuites-token-based-authentication-with-suitetalk/).
+OAuth credentials are supported and the recommended authentication approach. [Learn more about how to set up token based authentication here](http://mikebian.co/using-netsuites-token-based-authentication-with-suitetalk/).
 
 ```ruby
 NetSuite.configure do
@@ -129,6 +169,11 @@ NetSuite.configure do
 
   # oauth does not work with API versions less than 2015_2
   api_version      '2016_2'
+
+  # the endpoint indicated in the > 2018_2 wsdl is invalid
+  # you must set the endpoint directly
+  # https://github.com/NetSweet/netsuite/pull/473
+  endpoint "https://#{wsdl_domain}/services/NetSuitePort_#{api_version}"
 end
 ```
 
@@ -390,7 +435,9 @@ NetSuite::Records::SalesOrder.search({
     'tranSales:itemJoin' => [
       'platformCommon:customFieldList' => [
         'platformCore:customField/' => {
-          '@internalId' => 'custitem_apcategoryforsales',
+          '@scriptId' => 'custitem_apcategoryforsales',
+          # Or, for API versions 2013.1 and older:
+          # '@internalId' => 'custitem_apcategoryforsales',
           '@xsi:type' => "platformCore:SearchColumnSelectCustomField"
         }
       ]
@@ -568,7 +615,3 @@ states = NetSuite::Configuration.connection.call(:get_all, message: {
 })
 states.to_array.first[:get_all_response][:get_all_result][:record_list][:record].map { |r| { country: r[:country], abbr: r[:shortname], name: r[:full_name] } }
 ```
-
-# About SuiteSync
-
-[SuiteSync, the Stripe-NetSuite integration](http://suitesync.io) uses this gem and funds the majority of it's development and maintenance.

data/Rakefile

@@ -7,7 +7,7 @@ task :default => :spec
 
 desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = './spec/**/*_spec.rb'
+  # t.pattern = './spec/**/*_spec.rb'
 end
 
 desc 'Generate code coverage'

data/lib/netsuite.rb

@@ -95,6 +95,7 @@ module NetSuite
     autoload :CashRefundItemList,               'netsuite/records/cash_refund_item_list'
     autoload :Campaign,                         'netsuite/records/campaign'
     autoload :Classification,                   'netsuite/records/classification'
+    autoload :CostCategory,                     'netsuite/records/cost_category'
     autoload :CreditMemo,                       'netsuite/records/credit_memo'
     autoload :CreditMemoApply,                  'netsuite/records/credit_memo_apply'
     autoload :CreditMemoApplyList,              'netsuite/records/credit_memo_apply_list'
@@ -112,6 +113,8 @@ module NetSuite
     autoload :CustomerAddressbook,              'netsuite/records/customer_addressbook'
     autoload :CustomerAddressbookList,          'netsuite/records/customer_addressbook_list'
     autoload :CustomerCategory,                 'netsuite/records/customer_category'
+    autoload :CustomerCreditCards,              'netsuite/records/customer_credit_cards'
+    autoload :CustomerCreditCardsList,          'netsuite/records/customer_credit_cards_list'
     autoload :CustomerCurrency,                 'netsuite/records/customer_currency'
     autoload :CustomerCurrencyList,             'netsuite/records/customer_currency_list'
     autoload :CustomerDeposit,                  'netsuite/records/customer_deposit'
@@ -121,6 +124,8 @@ module NetSuite
     autoload :CustomerPayment,                  'netsuite/records/customer_payment'
     autoload :CustomerPaymentApply,             'netsuite/records/customer_payment_apply'
     autoload :CustomerPaymentApplyList,         'netsuite/records/customer_payment_apply_list'
+    autoload :CustomerPaymentCredit,            'netsuite/records/customer_payment_credit'
+    autoload :CustomerPaymentCreditList,        'netsuite/records/customer_payment_credit_list'
     autoload :CustomerPartner,                  'netsuite/records/customer_partner'
     autoload :CustomerRefund,                   'netsuite/records/customer_refund'
     autoload :CustomerRefundApply,              'netsuite/records/customer_refund_apply'
@@ -156,6 +161,9 @@ module NetSuite
     autoload :Duration,                         'netsuite/records/duration'
     autoload :Employee,                         'netsuite/records/employee'
     autoload :EntityCustomField,                'netsuite/records/entity_custom_field'
+    autoload :Estimate,                         'netsuite/records/estimate'
+    autoload :EstimateItem,                     'netsuite/records/estimate_item'
+    autoload :EstimateItemList,                 'netsuite/records/estimate_item_list'
     autoload :File,                             'netsuite/records/file'
     autoload :GiftCertificate,                  'netsuite/records/gift_certificate'
     autoload :GiftCertificateItem,              'netsuite/records/gift_certificate_item'
@@ -206,8 +214,10 @@ module NetSuite
     autoload :Location,                         'netsuite/records/location'
     autoload :LocationsList,                    'netsuite/records/locations_list'
     autoload :LotNumberedAssemblyItem,          'netsuite/records/lot_numbered_assembly_item'
+    autoload :LotNumberedInventoryItem,         'netsuite/records/lot_numbered_inventory_item'
     autoload :MatrixOptionList,                 'netsuite/records/matrix_option_list'
     autoload :MemberList,                       'netsuite/records/member_list'
+    autoload :Message,                          'netsuite/records/message'
     autoload :NonInventorySaleItem,             'netsuite/records/non_inventory_sale_item'
     autoload :NonInventoryPurchaseItem,         'netsuite/records/non_inventory_purchase_item'
     autoload :NonInventoryResaleItem,           'netsuite/records/non_inventory_resale_item'
@@ -261,6 +271,7 @@ module NetSuite
     autoload :Subsidiary,                       'netsuite/records/subsidiary'
     autoload :SubtotalItem,                     'netsuite/records/subtotal_item'
     autoload :SupportCase,                      'netsuite/records/support_case'
+    autoload :SupportCaseType,                  'netsuite/records/support_case_type'
     autoload :TaxType,                          'netsuite/records/tax_type'
     autoload :TaxGroup,                         'netsuite/records/tax_group'
     autoload :Task,                             'netsuite/records/task'
@@ -289,6 +300,8 @@ module NetSuite
     autoload :VendorCreditItemList,             'netsuite/records/vendor_credit_item_list'
     autoload :VendorCreditExpense,              'netsuite/records/vendor_credit_expense'
     autoload :VendorCreditExpenseList,          'netsuite/records/vendor_credit_expense_list'
+    autoload :VendorCurrencyList,               'netsuite/records/vendor_currency_list'
+    autoload :VendorCurrency,                   'netsuite/records/vendor_currency'
     autoload :VendorReturnAuthorization,        'netsuite/records/vendor_return_authorization'
     autoload :VendorReturnAuthorizationItem,    'netsuite/records/vendor_return_authorization_item'
     autoload :VendorReturnAuthorizationItemList, 'netsuite/records/vendor_return_authorization_item_list'
@@ -309,23 +322,4 @@ module NetSuite
     NetSuite::Configuration.instance_eval(&block)
   end
 
-  def self.configure_from_env(&block)
-    NetSuite.configure do
-      reset!
-
-      email         ENV['NETSUITE_EMAIL']     unless ENV['NETSUITE_EMAIL'].nil?
-      password      ENV['NETSUITE_PASSWORD']  unless ENV['NETSUITE_PASSWORD'].nil?
-      account       ENV['NETSUITE_ACCOUNT']   unless ENV['NETSUITE_ACCOUNT'].nil?
-      role          ENV['NETSUITE_ROLE']      unless ENV['NETSUITE_ROLE'].nil?
-      api_version   ENV['NETSUITE_API']       unless ENV['NETSUITE_API'].nil?
-      sandbox       (ENV['NETSUITE_PRODUCTION'].nil? || ENV['NETSUITE_PRODUCTION'] != 'true')
-      wsdl          ENV['NETSUITE_WSDL']      unless ENV['NETSUITE_WSDL'].nil?
-      silent        (!ENV['NETSUITE_SILENT'].nil? && ENV['NETSUITE_SILENT'] == 'true')
-
-      read_timeout  100_000
-    end
-
-    self.configure(&block) if block
-  end
-
 end

data/lib/netsuite/actions/login.rb

@@ -28,6 +28,14 @@ module NetSuite
       # </platformCore:wsRoleList>
 
       def self.call(credentials)
+
+        soap_header = {}
+        if !credentials[:application_id].nil? && !credentials[:application_id].empty?
+          soap_header = NetSuite::Configuration.soap_header.dup
+          soap_header['platformMsgs:ApplicationInfo'] ||= {}
+          soap_header['platformMsgs:ApplicationInfo']['platformMsgs:applicationId'] = credentials[:application_id]
+        end
+
         passport = NetSuite::Configuration.auth_header.dup
 
 
@@ -39,13 +47,13 @@ module NetSuite
         if passport['platformMsgs:tokenPassport']
           passport['platformMsgs:passport']['platformCore:account'] ||= passport['platformMsgs:tokenPassport']['platformCore:account']
         end
-        
+
         passport['platformMsgs:passport']['platformCore:account'] = credentials[:account] if !credentials[:account].nil?
 
         passport.delete('platformMsgs:tokenPassport')
 
         begin
-          response = NetSuite::Configuration.connection(soap_header: {}).call :login, message: passport
+          response = NetSuite::Configuration.connection(soap_header: soap_header).call :login, message: passport
         rescue Savon::SOAPFault => e
           error_details = e.to_hash[:fault]
 

data/lib/netsuite/actions/upsert.rb

@@ -37,6 +37,8 @@ module NetSuite
           hash['platformMsgs:record']['@platformMsgs:externalId'] = @object.external_id
         end
 
+        # setting the internal ID on upsert will result in `CANT_SET_INTERNALID`
+
         hash
       end
 

data/lib/netsuite/configuration.rb

@@ -17,7 +17,9 @@ module NetSuite
     def connection(params={}, credentials={})
       client = Savon.client({
         wsdl: cached_wsdl || wsdl,
+        endpoint: endpoint,
         read_timeout: read_timeout,
+        open_timeout: open_timeout,
         namespaces: namespaces,
         soap_header: auth_header(credentials).update(soap_header),
         pretty_print_xml: true,
@@ -93,6 +95,18 @@ module NetSuite
       attributes[:api_version] = version
     end
 
+    def endpoint=(endpoint)
+      attributes[:endpoint] = endpoint
+    end
+
+    def endpoint(endpoint=nil)
+      if endpoint
+        self.endpoint = endpoint
+      else
+        attributes[:endpoint]
+      end
+    end
+
     def sandbox=(flag)
       if attributes[:sandbox] != flag
         attributes[:wsdl] = nil
@@ -326,6 +340,18 @@ module NetSuite
       end
     end
 
+    def open_timeout=(timeout)
+      attributes[:open_timeout] = timeout
+    end
+
+    def open_timeout(timeout = nil)
+      if timeout
+        self.open_timeout = timeout
+      else
+        attributes[:open_timeout]
+      end
+    end
+
     def log=(path)
       attributes[:log] = path
     end
@@ -337,7 +363,10 @@ module NetSuite
 
     def logger(value = nil)
       if value.nil?
-        attributes[:logger] ||= ::Logger.new((log && !log.empty?) ? log : $stdout)
+        # if passed a IO object (like StringIO) `empty?` won't exist
+        valid_log = log && !(log.respond_to?(:empty?) && log.empty?)
+
+        attributes[:logger] ||= ::Logger.new(valid_log ? log : $stdout)
       else
         attributes[:logger] = value
       end
@@ -357,12 +386,13 @@ module NetSuite
     end
 
     def log_level(value = nil)
-      self.log_level = value || :debug
-      attributes[:log_level]
+      self.log_level = value if value
+
+      attributes[:log_level] || :debug
     end
 
     def log_level=(value)
-      attributes[:log_level] ||= value
+      attributes[:log_level] = value
     end
   end
 end