netsuite 0.8.5 → 0.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 89b1dc6dad276f5db8f657634a3d125643ca198b
-  data.tar.gz: 586f0a9f83e7b1919a637a34f2d8fce536b8f2b4
+SHA256:
+  metadata.gz: 322dc4e1ca618901cbe11d81ed9d22351557188e4c64db465e433d9a26079e19
+  data.tar.gz: dd9aebc4902c3fbb61ad2df4feb2d0ea634606e6778bf2981b2722803596af99
 SHA512:
-  metadata.gz: 76be28871d569715347328833f9521f8178879f17b93bb940fc10b9c960ef70652110ee85c4a277d02c6c21128f52c7cd762913331edcdacdc1463c853b81c7a
-  data.tar.gz: a9b49255201b452651df24646fc4d96e96b6d90b1b723a4170eb7f3fc276ea2f9281c609c440702be11e732f1a6e9145cfa67fdcb8537fca3c8f48d94d4057bb
+  metadata.gz: 0b9f90448959b2ee6abf9d93480700bf15cca9758d2e9632ac3e755edc09eec033a2248f9ee40bfbd21dfb8b992c4bd53bc1af3d7bb322aa9e8428a6ca055553
+  data.tar.gz: 15666ea4627c96749dfa5bc9f664466f78aeeaf54d0f9bf95c21d568e4e5f429b44edc2bad5b4336507c068aa1657cd4cabbe8d13a54360b4722611122d585e1

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/.ruby-version

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

data/.tool-versions

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

data/Gemfile

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

data/HISTORY.md

@@ -0,0 +1,32 @@
+## Unreleased
+
+### Added
+
+*
+*
+
+### Fixed
+
+*
+*
+
+## 0.8.9
+
+### Fixed
+
+* Fixed issue where search only fields could be specified when an existing field exists. https://github.com/NetSweet/netsuite/pull/488
+
+## 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,28 +54,44 @@ 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
 
 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/)
 
-For most use-cases, the following configuration will be sufficient:
+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
 
-  # use `NetSuite::Utilities.netsuite_data_center_urls('TSTDRV1576318')` to retrieve the URL
-  # you'll want to do this in a background proces and strip the protocol out of the return string
+  # 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
 ```
 
@@ -106,9 +120,16 @@ NetSuite.configure do
   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')
 
+  # 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'
@@ -121,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'
@@ -133,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
@@ -148,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
 ```
 
@@ -395,7 +421,10 @@ NetSuite::Records::SalesOrder.search({
     'tranSales:basic' => [
       'platformCommon:internalId/' => {},
       'platformCommon:email/' => {},
-      'platformCommon:tranDate/' => {}
+      'platformCommon:tranDate/' => {},
+      # If you include columns that are only part of the *SearchRowBasic (ie. TransactionSearchRowBasic), 
+      # they'll be readable on the resulting record just like regular fields (my_record.close_date).
+      'platformCommon:closeDate/' => {}
     ],
     'tranSales:accountJoin' => [
       'platformCommon:internalId/' => {}
@@ -409,7 +438,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"
         }
       ]
@@ -587,7 +618,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/configuration.rb

@@ -17,6 +17,7 @@ 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,
@@ -94,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
@@ -350,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
@@ -370,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

data/lib/netsuite/records/accounting_period.rb

@@ -8,12 +8,12 @@ module NetSuite
 
       actions :get, :get_list, :add, :delete, :upsert, :search
 
-      fields :allow_non_gl_changes, :end_date, :is_adjust, :is_quarter, :is_year, :period_name, :start_date
+      fields :allow_non_gl_changes, :end_date, :is_adjust, :is_quarter, :is_year, :period_name, :start_date, :closed
 
       record_refs :parent
 
       attr_reader :internal_id
-      attr_accessor :external_id
+      attr_accessor :external_id, :search_joins
 
       def initialize(attributes = {})
         @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)

data/lib/netsuite/records/assembly_unbuild.rb

@@ -12,7 +12,7 @@ module NetSuite
         :search
 
       fields :bin_numbers, :built, :created_date, :expiration_date,
-        :last_modified_date, :memo, :quantity, :serial_numbers, :total,
+        :last_modified_date, :memo, :quantity, :serial_numbers,
         :tran_date, :tran_id
 
 	  read_only_fields :total
@@ -36,5 +36,3 @@ module NetSuite
     end
   end
 end
-
-

data/lib/netsuite/records/classification.rb

@@ -9,9 +9,12 @@ module NetSuite
 
       actions :add, :get, :get_list, :delete, :upsert, :search
 
-      fields :name, :include_children, :is_inactive, :class_translation_list, :custom_field_list, :parent
+      fields :name, :include_children, :is_inactive, :class_translation_list
 
       field :subsidiary_list, RecordRefList
+      field :custom_field_list, CustomFieldList
+
+      record_refs :parent
 
       attr_reader   :internal_id
       attr_accessor :external_id

data/lib/netsuite/records/contact.rb

@@ -7,7 +7,7 @@ module NetSuite
       include Support::Actions
       include Namespaces::ListRel
 
-      actions :get, :get_list, :add, :delete, :delete_list, :search, :update, :upsert
+      actions :get, :get_deleted, :get_list, :add, :delete, :delete_list, :search, :update, :upsert, :upsert_list
 
       fields :salutation, :first_name, :middle_name, :last_name, :title, :phone, :fax, :email, :default_address,
              :entity_id, :phonetic_name, :alt_email, :office_phone, :home_phone, :mobile_phone, :supervisor_phone,

data/lib/netsuite/records/cost_category.rb

@@ -0,0 +1,28 @@
+module NetSuite
+  module Records
+    class CostCategory
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::ListAcct
+
+      actions :add, :delete, :delete_list, :get, :get_all, :get_list, :get_select_value, :search, :update, :update_list, :upsert, :upsert_list
+      # TODO: Add add_list when supported by gem
+
+      fields :is_inactive, :item_cost_type, :name
+
+      record_refs :account
+
+      attr_reader :internal_id
+      attr_accessor :external_id
+
+      def initialize(attributes = {})
+        @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)
+        @external_id = attributes.delete(:external_id) || attributes.delete(:@external_id)
+        initialize_from_attributes_hash(attributes)
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/credit_memo.rb

@@ -17,7 +17,7 @@ module NetSuite
         :sales_effective_date, :shipping_cost, :shipping_tax1_rate, :shipping_tax2_rate, :source, :status,
         :sync_partner_teams, :sync_sales_teams, :tax2_total, :tax_rate, :to_be_emailed, :to_be_faxed,
         :to_be_printed, :total_cost_estimate, :tran_date, :tran_id, :tran_is_vsoe_bundle, :vat_reg_num,
-        :vsoe_auto_calc
+        :vsoe_auto_calc, :tax_details_override, :tax_reg_override
 
       field :custom_field_list,        CustomFieldList
       field :item_list,                CreditMemoItemList

data/lib/netsuite/records/currency_rate.rb

@@ -12,7 +12,7 @@ module NetSuite
 
       actions :get, :get_list, :search
 
-      fields :base_currency, :effective_date, :exchange_rate, :transaction_currency
+      fields :effective_date, :exchange_rate
 
       record_refs :base_currency, :transaction_currency
 

data/lib/netsuite/records/custom_field_list.rb

@@ -110,10 +110,16 @@ module NetSuite
             attrs = custom_field_data.clone
             type = (custom_field_data[:"@xsi:type"] || custom_field_data[:type])
 
-            if type == "platformCore:SelectCustomFieldRef"
+            case type
+            when "platformCore:SelectCustomFieldRef", "platformCore:SearchColumnSelectCustomField"
               attrs[:value] = CustomRecordRef.new(custom_field_data[:value])
-            elsif type == 'platformCore:MultiSelectCustomFieldRef'
-              attrs[:value] = custom_field_data[:value].map do |entry|
+            when 'platformCore:MultiSelectCustomFieldRef', 'platformCore:SearchColumnMultiSelectCustomField'
+              # if there is only a single selection, `:value` will be hash not an array
+              attrs[:value] = if custom_field_data[:value].is_a?(Array)
+                custom_field_data[:value]
+              else
+                [custom_field_data[:value]]
+              end.map do |entry|
                 CustomRecordRef.new(entry)
               end
             end