netsuite 0.6.3 → 0.6.4

data/README.md

@@ -7,24 +7,22 @@
 
 * This gem will act as a wrapper around the NetSuite SuiteTalk WebServices API. Wow, that is a mouthful.
 * The gem does not cover the entire API, only the subset that we have found useful to cover so far.
-* Extending the wrapper is pretty simple. Check out the [contribution help doc](https://github.com/NetSweet/netsuite/wiki/Contributing-to-the-Supported-NetSuite-API)
+* Extending the wrapper is pretty simple, check out recent commits for an example of how to add support for additional records.
 * NetSuite development is overall a pretty poor experience. We have a list of [NetSuite Development Resources](https://github.com/NetSweet/netsuite/wiki/NetSuite-Development-Resources) that might make things a bit less painful.
 
-## Installation
-
-Add this line to your application's Gemfile:
+# Help & Support
 
-    gem 'netsuite'
+Join the [slack channel](http://opensuite-slackin.herokuapp.com) for help with any NetSuite issues.
 
-And then execute:
-
-    $ bundle
+## Installation
 
-Or install it yourself as:
+Add this line to your application's Gemfile:
 
-    $ gem install netsuite
+```
+gem 'netsuite'
+```
 
-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 1.9.x+, checkout the [1-8-stable](https://github.com/NetSweet/netsuite/tree/1-8-stable) branch for ruby 1.8.x support.
 
 ## Testing
 Before contributing a patch make sure all existing tests pass.
@@ -32,6 +30,7 @@ Before contributing a patch make sure all existing tests pass.
 ```
 git clone git://github.com/NetSweet/netsuite.git
 cd netsuite
+
 bundle
 bundle exec rspec
 ```
@@ -74,6 +73,21 @@ end
 
 There is a [convenience method](https://github.com/NetSweet/netsuite/blob/56fe7fae92908a2e3d6812ecc56516f773cacd45/lib/netsuite.rb#L180) to configure NetSuite based on ENV variables.
 
+OAuth credentials are also supported:
+
+```ruby
+NetSuite.configure do
+  reset!
+
+  account       ENV['NETSUITE_ACCOUNT']
+
+  consumer_key     ENV['NETSUITE_CONSUMER_KEY']
+  consumer_secret  ENV['NETSUITE_CONSUMER_SECRET']
+  token_id         ENV['NETSUITE_TOKEN_ID']
+  token_secret     ENV['NETSUITE_TOKEN_SECRET']
+end
+```
+
 ### Examples
 
 #### CRUD Operations
@@ -377,6 +391,9 @@ search.results_in_batches do |batch|
   puts batch.map(&:internal_id)
 end
 
+# search on transaction status
+NetSuite::Records::InventoryItem
+
 # item search
 NetSuite::Records::InventoryItem.search({
   criteria: {

data/lib/netsuite.rb

@@ -167,6 +167,9 @@ module NetSuite
     autoload :PhoneCall,                        'netsuite/records/phone_call'
     autoload :PricingMatrix,                    'netsuite/records/pricing_matrix'
     autoload :PromotionCode,                    'netsuite/records/promotion_code'
+    autoload :PurchaseOrder,                    'netsuite/records/purchase_order'
+    autoload :PurchaseOrderItemList,            'netsuite/records/purchase_order_item_list'
+    autoload :PurchaseOrderItem,                'netsuite/records/purchase_order_item'
     autoload :Roles,                            'netsuite/records/roles'
     autoload :RecordRef,                        'netsuite/records/record_ref'
     autoload :RecordRefList,                    'netsuite/records/record_ref_list'
@@ -190,6 +193,8 @@ module NetSuite
     autoload :TimeBill,                         'netsuite/records/time_bill'
     autoload :Transaction,                      'netsuite/records/transaction'
     autoload :TransferOrder,                    'netsuite/records/transfer_order'
+    autoload :TransferOrderItemList,            'netsuite/records/transfer_order_item_list'
+    autoload :TransferOrderItem,                'netsuite/records/transfer_order_item'
     autoload :UnitsType,                        'netsuite/records/units_type'
     autoload :UnitsTypeUomList,                 'netsuite/records/units_type_uom_list'
     autoload :UnitsTypeUom,                     'netsuite/records/units_type_uom'

data/lib/netsuite/configuration.rb

@@ -17,12 +17,25 @@ module NetSuite
         namespaces: namespaces,
         soap_header: auth_header(credentials).update(soap_header),
         pretty_print_xml: true,
+        filters: filters,
         logger: logger,
         log_level: log_level,
-        log: !silent,   # turn off logging entirely if configured
+        log: !silent, # turn off logging entirely if configured
       }.update(params))
     end
 
+    def filters(list = nil)
+      if list
+        self.filters = list
+      else
+        attributes[:filters] ||= [:password, :email]
+      end
+    end
+
+    def filters=(list)
+      attributes[:filters] = list
+    end
+
     def api_version(version = nil)
       if version
         self.api_version = version

data/lib/netsuite/records/purchase_order.rb

@@ -0,0 +1,52 @@
+module NetSuite
+  module Records
+    class PurchaseOrder
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::TranPurch
+
+      actions :get, :get_list, :add, :initialize, :delete, :update, :upsert, :search
+
+      fields :created_date, :currency_name, :due_date, :email, :exchange_rate,
+             :fax, :fob, :interco_status, :interco_transaction, :last_modified_date,
+             :linked_tracking_numbers, :memo, :message, :other_ref_num, :ship_date,
+             :ship_is_residential, :ship_to, :source, :status, :sub_total, :supervisor_approval,
+             :tax2_total, :tax_total, :to_be_emailed, :to_be_faxed, :to_be_printed,
+             :total, :tracking_numbers, :tran_date, :tran_id, :vat_reg_num
+
+      field :billing_address,   Address
+      field :shipping_address,  Address
+      field :custom_field_list, CustomFieldList
+      field :item_list,         PurchaseOrderItemList
+
+      # TODO custom lists
+      # :ship_address_list
+      # :expense_list
+
+      record_refs :approval_status, :bill_address_list, :klass, :created_from, :currency,
+                  :custom_form, :department, :employee, :entity, :location, :next_approver,
+                  :order_status, :purchase_contract, :ship_method, :subsidiary, :terms
+
+      attr_reader :internal_id
+      attr_accessor :external_id
+      attr_accessor :search_joins
+
+      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
+
+      def self.search_class_name
+        "Transaction"
+      end
+
+      def self.search_class_namespace
+        'tranSales'
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/purchase_order_item.rb

@@ -0,0 +1,42 @@
+module NetSuite
+  module Records
+    class PurchaseOrderItem
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Namespaces::TranPurch
+
+      fields :amount, :description, :expected_receipt_date, :gross_amt, :is_billable,
+             :is_closed, :line, :match_bill_to_receipt, :quantity, :quantity_available,
+             :quantity_billed, :quantity_on_hand, :quantity_received, :rate, :serial_numbers,
+             :tax1_amt, :tax_rate1, :tax_rate2, :vendor_name
+
+      field :custom_field_list, CustomFieldList
+
+      record_refs :bill_variance_status, :klass, :created_from, :customer, :department,
+                  :inventory_detail, :item, :landed_cost_category, :linked_order_list,
+                  :location, :options, :purchase_contract, :tax_code, :units
+
+      def initialize(attributes_or_record = {})
+        case attributes_or_record
+        when Hash
+          initialize_from_attributes_hash(attributes_or_record)
+        when self.class
+          initialize_from_record(attributes_or_record)
+        end
+      end
+
+      def initialize_from_record(record)
+        self.attributes = record.send(:attributes)
+      end
+
+      def to_record
+        rec = super
+        if rec["#{record_namespace}:customFieldList"]
+          rec["#{record_namespace}:customFieldList!"] = rec.delete("#{record_namespace}:customFieldList")
+        end
+        rec
+      end
+    end
+  end
+end

data/lib/netsuite/records/purchase_order_item_list.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Records
+    class PurchaseOrderItemList < Support::Sublist
+      include Namespaces::TranPurch
+
+      sublist :item, PurchaseOrderItem
+
+      alias :items :item
+    end
+  end
+end

data/lib/netsuite/records/sales_order_item.rb

@@ -1,8 +1,5 @@
 module NetSuite
   module Records
-    # Beaware of possible gotcha when closing sales order. You need to set the
-    # SalesOrder#custom_form to "Basic Sales Order Form" otherwise you might get
-    # errors when trying to close it
     class SalesOrderItem
       include Support::Fields
       include Support::RecordRefs

data/lib/netsuite/records/transfer_order.rb

@@ -19,8 +19,8 @@ module NetSuite
                   :ship_method, :order_status, :employee, :handling_tax_code,
                   :location, :custom_form, :department, :klass, :ship_address_list
 
-      field :custom_field_list,        CustomFieldList
-      # :item_list TransferOrderItemList
+      field :custom_field_list,   CustomFieldList
+      field :item_list,           TransferOrderItemList
 
       attr_reader :internal_id
       attr_accessor :external_id

data/lib/netsuite/records/transfer_order_item.rb

@@ -0,0 +1,43 @@
+module NetSuite
+  module Records
+    class TransferOrderItem
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Namespaces::TranInvt
+
+      fields :amount, :average_cost, :klass, :commit_inventory, :description,
+             :expected_receipt_date, :expected_ship_date, :is_closed, :last_purchase_price,
+             :line, :options, :order_priority, :quantity, :quantity_available,
+             :quantity_back_ordered, :quantity_committed, :quantity_fulfilled,
+             :quantity_on_hand, :quantity_packed, :quantity_picked, :quantity_received,
+             :rate, :serial_numbers
+
+      field :options, CustomFieldList
+      field :custom_field_list, CustomFieldList
+
+      record_refs :department, :inventory_detail, :item, :units
+
+      def initialize(attributes_or_record = {})
+        case attributes_or_record
+        when Hash
+          initialize_from_attributes_hash(attributes_or_record)
+        when self.class
+          initialize_from_record(attributes_or_record)
+        end
+      end
+
+      def initialize_from_record(record)
+        self.attributes = record.send(:attributes)
+      end
+
+      def to_record
+        rec = super
+        if rec["#{record_namespace}:customFieldList"]
+          rec["#{record_namespace}:customFieldList!"] = rec.delete("#{record_namespace}:customFieldList")
+        end
+        rec
+      end
+    end
+  end
+end

data/lib/netsuite/records/transfer_order_item_list.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Records
+    class TransferOrderItemList < Support::Sublist
+      include Namespaces::TranInvt
+
+      sublist :item, TransferOrderItem
+
+      alias :items :item
+    end
+  end
+end

data/lib/netsuite/version.rb

@@ -1,3 +1,3 @@
 module Netsuite
-  VERSION = '0.6.3'
+  VERSION = '0.6.4'
 end

data/spec/netsuite/configuration_spec.rb

@@ -16,6 +16,18 @@ describe NetSuite::Configuration do
     end
   end
 
+  describe '#filters' do
+    it 'filters out email and password by default' do
+      expect(config.filters).to eq([:password, :email])
+    end
+
+    it 'allows the user to set custom filters' do
+      config.filters([:special])
+
+      expect(config.filters).to eq([:special])
+    end
+  end
+
   describe '#connection' do
     it 'returns a Savon::Client object that allows requests to the service' do
       # reset clears out the password info

data/spec/netsuite/records/basic_record_spec.rb

@@ -27,6 +27,7 @@ describe 'basic records' do
       NetSuite::Records::File,
       NetSuite::Records::TransferOrder,
       NetSuite::Records::Partner,
+      NetSuite::Records::PurchaseOrder,
     ]
   }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netsuite
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -205,6 +205,9 @@ files:
 - lib/netsuite/records/phone_call.rb
 - lib/netsuite/records/pricing_matrix.rb
 - lib/netsuite/records/promotion_code.rb
+- lib/netsuite/records/purchase_order.rb
+- lib/netsuite/records/purchase_order_item.rb
+- lib/netsuite/records/purchase_order_item_list.rb
 - lib/netsuite/records/record_ref.rb
 - lib/netsuite/records/record_ref_list.rb
 - lib/netsuite/records/rev_rec_schedule.rb
@@ -227,6 +230,8 @@ files:
 - lib/netsuite/records/term.rb
 - lib/netsuite/records/time_bill.rb
 - lib/netsuite/records/transfer_order.rb
+- lib/netsuite/records/transfer_order_item.rb
+- lib/netsuite/records/transfer_order_item_list.rb
 - lib/netsuite/records/units_type.rb
 - lib/netsuite/records/units_type_uom.rb
 - lib/netsuite/records/units_type_uom_list.rb