netsuite 0.3.3 → 0.4.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjYyYWE4ZTFiZjRkZjc2ZGM0MmEyY2YzZjA1NGVkYzM2NjMwNWZiZg==
+  data.tar.gz: !binary |-
+    MGZiNTNiN2YwNmM3MmM3Yzc1Yzc4Mjg4ZGNkYmM1NDRkYjRjYzI2Mw==
+SHA512:
+  metadata.gz: !binary |-
+    MDE4NDFiN2UxODAzNzcxNTQzMDQ2MWU5NWZiZGIyY2VlY2I4NmY0MjhmNmI1
+    NmU4NWI0ZGEwZmU4MGYzZmY5YzUzOTk1NDhkMDM2OWQ5MjdmNTQ2MjNmYmQ1
+    YTY0MGE1YzQ4NmNkZjY0ZmZlMTM5MjZjZGRkOTBmMmVhODI4ZDc=
+  data.tar.gz: !binary |-
+    ZmJkY2ZlYTMxYTZiMGQwMGNjYzlkYjYwNWY4MzMwNTA3MTY0Njk2MWUyZDA3
+    YTEyYmMyNmNmNWY4ZDkzNDdiZTM2MGY5NjkyNGJjY2ZhMzhhYjA3OWUwMzM3
+    NDk2Y2VkMTNjM2I0NWU2NjJiZmY0MWE2NjE0ZGY1ZDdiM2JkMzE=

data/README.md

@@ -4,8 +4,8 @@
 
 * 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/RevolutionPrep/netsuite/wiki/Contributing-to-the-Supported-NetSuite-API)
-* NetSuite development is overall a pretty poor experience. We have a list of [NetSuite Development Resources](https://github.com/RevolutionPrep/netsuite/wiki/NetSuite-Development-Resources) that might make things a bit less painful.
+* Extending the wrapper is pretty simple. Check out the [contribution help doc](https://github.com/NetSweet/netsuite/wiki/Contributing-to-the-Supported-NetSuite-API)
+* 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
 
@@ -21,13 +21,13 @@ Or install it yourself as:
 
     $ gem install netsuite
 
-This gem is built for ruby 1.9.x, checkout the [1-8-stable](https://github.com/RevolutionPrep/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.
 
 ```
-git clone git://github.com/RevolutionPrep/netsuite.git
+git clone git://github.com/NetSweet/netsuite.git
 cd netsuite
 bundle
 bundle exec rspec
@@ -41,23 +41,23 @@ Not sure how to find your account id? Search for "web service preferences" in th
 ```ruby
 NetSuite.configure do
   reset!
-  
+
   # optional, defaults to 2011_2
   api_version	'2012_1'
-  
+
   # optionally specify full wsdl URL (to switch to sandbox, for example)
   wsdl          "https://webservices.sandbox.netsuite.com/wsdl/v#{api_version}_0/netsuite.wsdl"
-  
+
   # 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
-  
+
   # you can specify a file or file descriptor to send the log output to (defaults to STDOUT)
   log           File.join(Rails.root, 'log/netsuite.log')
-  
+
   # login information
   email    	'email@domain.com'
   password 	'password'
@@ -66,6 +66,8 @@ NetSuite.configure do
 end
 ```
 
+There is a [convenience method](https://github.com/NetSweet/netsuite/blob/56fe7fae92908a2e3d6812ecc56516f773cacd45/lib/netsuite.rb#L180) to configure NetSuite based on ENV variables.
+
 ### Examples
 
 #### CRUD Operations
@@ -235,7 +237,7 @@ NetSuite::Records::Transaction.search({
           Time.parse("30/07/2013").iso8601,
 
           # or you can use a string. Note that the format below is different from the format of the above code
-          # but it matches exactly what NS returns 
+          # but it matches exactly what NS returns
           # "2012-01-01T22:00:00.000-07:00",
           # "2013-07-30T22:00:00.000-07:00"
         ]
@@ -268,7 +270,7 @@ NetSuite::Records::Transaction.search({
       }
     ]
   },
-  
+
   # the column syntax is a WIP. This will change in the future
   columns: {
     'tranSales:basic' => [

data/lib/netsuite.rb

@@ -24,6 +24,7 @@ module NetSuite
     autoload :TranGeneral,    'netsuite/namespaces/tran_general'
     autoload :TranInvt,       'netsuite/namespaces/tran_invt'
     autoload :TranSales,      'netsuite/namespaces/tran_sales'
+    autoload :TranPurch,      'netsuite/namespaces/tran_purch'
     autoload :SetupCustom,    'netsuite/namespaces/setup_custom'
     autoload :ListEmp,        'netsuite/namespaces/list_emp'
     autoload :ListMkt,        'netsuite/namespaces/list_mkt'
@@ -45,6 +46,7 @@ module NetSuite
   module Actions
     autoload :Add,              'netsuite/actions/add'
     autoload :Delete,           'netsuite/actions/delete'
+    autoload :DeleteList,       'netsuite/actions/delete_list'
     autoload :Get,              'netsuite/actions/get'
     autoload :GetAll,           'netsuite/actions/get_all'
     autoload :GetList,          'netsuite/actions/get_list'
@@ -70,6 +72,8 @@ module NetSuite
     autoload :BillingScheduleRecurrenceList,    'netsuite/records/billing_schedule_recurrence_list'
     autoload :BinNumberList,                    'netsuite/records/bin_number_list'
     autoload :CashSale,                         'netsuite/records/cash_sale'
+    autoload :CashSaleItem,                     'netsuite/records/cash_sale_item'
+    autoload :CashSaleItemList,                 'netsuite/records/cash_sale_item_list'
     autoload :CashRefund,                       'netsuite/records/cash_refund'
     autoload :CashRefundItem,                   'netsuite/records/cash_refund_item'
     autoload :CashRefundItemList,               'netsuite/records/cash_refund_item_list'
@@ -168,6 +172,14 @@ module NetSuite
     autoload :UnitsTypeUomList,                 'netsuite/records/units_type_uom_list'
     autoload :UnitsTypeUom,                     'netsuite/records/units_type_uom'
     autoload :Vendor,                           'netsuite/records/vendor'
+    autoload :VendorBill,                       'netsuite/records/vendor_bill'
+    autoload :VendorBillExpense,                'netsuite/records/vendor_bill_expense'
+    autoload :VendorBillExpenseList,            'netsuite/records/vendor_bill_expense_list'
+    autoload :VendorBillItem,                   'netsuite/records/vendor_bill_item'
+    autoload :VendorBillItemList,               'netsuite/records/vendor_bill_item_list'
+    autoload :VendorPayment,                    'netsuite/records/vendor_payment'
+    autoload :VendorPaymentApply,               'netsuite/records/vendor_payment_apply'
+    autoload :VendorPaymentApplyList,           'netsuite/records/vendor_payment_apply_list'
     autoload :WorkOrder,                        'netsuite/records/work_order'
     autoload :WorkOrderItem,                    'netsuite/records/work_order_item'
     autoload :WorkOrderItemList,                'netsuite/records/work_order_item_list'
@@ -177,7 +189,7 @@ module NetSuite
     NetSuite::Configuration.instance_eval(&block)
   end
 
-  def self.configure_from_env
+  def self.configure_from_env(&block)
     NetSuite.configure do
       reset!
       
@@ -188,10 +200,12 @@ module NetSuite
       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'] || false)
+      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/delete_list.rb

@@ -0,0 +1,104 @@
+module NetSuite
+  module Actions
+    class DeleteList
+      include Support::Requests
+
+      def initialize(klass, options = { })
+        @klass = klass
+        @options = options
+      end
+
+      private
+
+      def request(credentials={})
+        NetSuite::Configuration.connection(
+          {namespaces: {
+            'xmlns:platformMsgs' => "urn:messages_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
+            'xmlns:platformCore' => "urn:core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com"
+          }}, credentials
+        ).call :delete_list, message: request_body
+      end
+
+      # <soap:Body>
+      #   <platformMsgs:deleteList>
+      #     <platformMsgs:baseRef internalId="1" type="customer" xsi:type="platformCore:RecordRef"/>
+      #     <platformMsgs:baseRef internalId="2" type="customer" xsi:type="platformCore:RecordRef"/>
+      #   </platformMsgs:deleteList>
+      # </soap:Body>
+      def request_body
+        list = @options.is_a?(Hash) ? @options[:list] : @options
+
+        formatted_list = if @options[:type_id]
+          type_id = @options[:type_id]
+          record_type = 'platformCore:CustomRecordRef'
+
+          list.map do |internal_id|
+            {
+              '@internalId' => internal_id,
+              '@typeId' => type_id,
+              '@xsi:type' => record_type
+            }
+          end
+        else
+          type = @klass.to_s.split('::').last.lower_camelcase
+          record_type = 'platformCore:RecordRef'
+
+          list.map do |internal_id|
+            {
+              '@internalId' => internal_id,
+              '@type' => type,
+              '@xsi:type' => record_type
+            }
+          end
+        end
+
+        {
+          baseRef: formatted_list
+        }
+      end
+
+      def response_list
+        @response_list ||= @response.to_hash[:delete_list_response][:write_response_list][:write_response]
+      end
+
+      def success?
+        @success ||= response_errors.blank?
+      end
+
+      def response_errors
+        if response_list.any? { |r| r[:status][:@is_success] == 'false' }
+          @response_errors ||= errors
+        end
+      end
+
+      def errors
+        errors = response_list.select { |r| r[:status] && r[:status][:status_detail] }.map do |obj|
+          error_obj = obj[:status][:status_detail]
+          error_obj = [error_obj] if error_obj.class == Hash
+          errors = error_obj.map do |error|
+            NetSuite::Error.new(error)
+          end
+
+          [obj[:base_ref][:@internal_id], errors]
+        end
+        Hash[errors]
+      end
+
+      def response_body
+        @response_body ||= response_list
+      end
+
+      module Support
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def delete_list(options = { }, credentials={})
+            response = NetSuite::Actions::DeleteList.call([self, options], credentials)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/netsuite/actions/login.rb

@@ -1,13 +1,37 @@
 # https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/login.html
+
 module NetSuite
   module Actions
     class Login
 
+      # <userId xmlns:platformCore="urn:core_2013_1.platform.webservices.netsuite.com" internalId="460362">
+      #   <platformCore:name>REDACTED ORG NAME</platformCore:name>
+      # </userId>
+      # <platformCore:wsRoleList xmlns:platformCore="urn:core_2013_1.platform.webservices.netsuite.com">
+      #   <platformCore:wsRole>
+      #     <platformCore:role internalId="1047">
+      #       <platformCore:name>REDACTED ROLE</platformCore:name>
+      #     </platformCore:role>
+      #     <platformCore:isDefault>false</platformCore:isDefault>
+      #     <platformCore:isInactive>false</platformCore:isInactive>
+      #     <platformCore:isLoggedInRole>true</platformCore:isLoggedInRole>
+      #   </platformCore:wsRole>
+      #   <platformCore:wsRole>
+      #     <platformCore:role internalId="1047">
+      #       <platformCore:name>REDACTED ROLE</platformCore:name>
+      #     </platformCore:role>
+      #     <platformCore:isDefault>false</platformCore:isDefault>
+      #     <platformCore:isInactive>false</platformCore:isInactive>
+      #     <platformCore:isLoggedInRole>true</platformCore:isLoggedInRole>
+      #   </platformCore:wsRole>
+      # </platformCore:wsRoleList>
+
       def self.call(credentials)
         passport = NetSuite::Configuration.auth_header.dup
         passport['platformMsgs:passport']['platformCore:email'] = credentials[:email] || ''
         passport['platformMsgs:passport']['platformCore:password'] = credentials[:password] || ''
         passport['platformMsgs:passport']['platformCore:role'] = credentials[:role] || ''
+        passport['platformMsgs:passport']['platformCore:account'] = credentials[:account] if !credentials[:account].nil?
 
         begin
           response = NetSuite::Configuration.connection(soap_header: {}).call :login, message: passport
@@ -24,9 +48,10 @@ module NetSuite
           )
         end
 
+        # include more data in body; leave it up to the user to pull the data they are looking for
         NetSuite::Response.new(
           success: response.to_hash[:login_response][:session_response][:status][:@is_success] == 'true',
-          body: response.to_hash[:login_response][:session_response][:base_ref]
+          body: response.to_hash[:login_response][:session_response]
         )
       end
 

data/lib/netsuite/actions/search.rb

@@ -223,10 +223,14 @@ module NetSuite
         @success ||= search_result[:status][:@is_success] == 'true'
       end
 
-      protected
-        def method_name
-
+      # TODO need to figure out a way for the user to access this
+      def errors
+        error_obj = response_hash[:status][:status_detail]
+        error_obj = [error_obj] if error_obj.class == Hash
+        error_obj.map do |error|
+          NetSuite::Error.new(error)
         end
+      end
 
       module Support
         def self.included(base)

data/lib/netsuite/actions/upsert.rb

@@ -33,10 +33,6 @@ module NetSuite
           }
         }
 
-        if @object.respond_to?(:internal_id) && @object.internal_id
-          hash['platformMsgs:record']['@platformMsgs:internalId'] = @object.internal_id
-        end
-
         if @object.respond_to?(:external_id) && @object.external_id
           hash['platformMsgs:record']['@platformMsgs:externalId'] = @object.external_id
         end

data/lib/netsuite/configuration.rb

@@ -96,6 +96,7 @@ module NetSuite
         'xmlns:platformCommon' => "urn:common_#{api_version}.platform.webservices.netsuite.com",
         'xmlns:listRel'        => "urn:relationships_#{api_version}.lists.webservices.netsuite.com",
         'xmlns:tranSales'      => "urn:sales_#{api_version}.transactions.webservices.netsuite.com",
+        'xmlns:tranPurch'      => "urn:purchases_#{api_version}.transactions.webservices.netsuite.com",
         'xmlns:actSched'       => "urn:scheduling_#{api_version}.activities.webservices.netsuite.com",
         'xmlns:setupCustom'    => "urn:customization_#{api_version}.setup.webservices.netsuite.com",
         'xmlns:listAcct'       => "urn:accounting_#{api_version}.lists.webservices.netsuite.com",

data/lib/netsuite/namespaces/tran_purch.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module TranPurch
+
+      def record_namespace
+        'tranPurch'
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/cash_refund.rb

@@ -7,9 +7,9 @@ module NetSuite
       include Support::Actions
       include Namespaces::TranCust
 
-      actions :add, :get, :delete
+      actions :add, :get, :delete, :initialize, :upsert
 
-      fields :tran_date, :to_be_emailed
+      fields :tran_date, :to_be_emailed, :memo, :total
 
       field :item_list, CashRefundItemList
       field :custom_field_list, CustomFieldList

data/lib/netsuite/records/cash_sale.rb

@@ -1,7 +1,47 @@
 module NetSuite
   module Records
-    class CashSale < SalesOrder
+    class CashSale
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::TranSales
 
+      actions :get, :add, :initialize, :delete, :update, :upsert, :search
+
+      fields :alt_handling_cost, :alt_shipping_cost, :auth_code, :bill_address, :cc_approved, :cc_expire_date, :cc_is_purchase_card_bin,
+        :cc_name, :cc_number, :cc_process_as_purchas_card, :cc_security_code, :cc_street, :cc_zip_code, :charge_it, :contrib_pct, :created_date,
+        :currency_name, :debit_card_issue_no, :deferred_revenue, :discount_rate, :discount_total, :email, :end_date, :est_gross_profit,
+        :est_gross_profit_percent, :exchange_rate, :exclude_commission, :exp_cost_disc_amount, :exp_cost_discount, :exp_cost_discprint,
+        :exp_cost_disc_rate, :exp_cost_disc_tax1_amt, :exp_cost_disc_taxable, :exp_cost_tax_rate1, :exp_cost_tax_rate2, :fax, :fob,
+        :gift_cert_applied, :handling_cost, :handling_tax1_rate, :handling_tax2_rate, :ignore_avs, :is_recurring_payment, :is_taxable,
+        :item_cost_disc_amount, :item_cost_disc_print, :item_cost_disc_rate, :item_cost_disc_tax1_amt, :item_cost_disc_taxable, :item_cost_tax_rate1,
+        :item_cost_tax_rate2, :last_modified_date, :linked_tracking_numbers, :memo, :message, :other_ref_num, :paypal_auth_id, :paypal_process,
+        :pay_pal_status, :pay_pay_tran_id, :pn_ref_num, :recognized_revenue, :rev_rec_end_date, :rev_rec_on_rev_commitment, :rev_rec_state_date,
+        :sales_effective_date, :ship_address, :ship_date, :shipping_cost, :shipping_tax1_rate, :shipping_tax2_rate, :source, :start_date, :status,
+        :sub_total, :sync_partners_teams, :sync_sales_teams, :tax2_total, :tax_rate, :tax_total, :three_d_status_code, :time_disc_amount, :time_disc_print,
+        :time_disc_rate, :time_disc_tax1_amt, :time_disc_taxable, :time_tax_rate1, :time_tax_rate2, :to_be_emailed, :to_be_faxed, :total,
+        :total_cost_estimate, :tracking_numbers, :tran_date, :tran_id, :tan_is_vsoe_bundle, :undep_funds, :valid_from, :vat_reg_num, :vsoe_auto_calc
+
+
+      field :transaction_ship_address, ShipAddress
+      field :transaction_bill_address, BillAddress
+      field :custom_field_list,        CustomFieldList
+      field :item_list,                CashSaleItemList
+
+      record_refs :account, :bill_address_list, :billing_schedule, :created_from, :credit_card, :credit_card_processor, :currency, :custom_form,
+        :department, :discount_item, :entity, :exp_cost_discount, :exp_cost_tax_code, :handling_tax_code, :item_cost_discount, :item_cost_tax_code,
+        :job, :klass, :lead_source, :location, :message_sel, :opportunity, :partner, :payment_method, :posting_period, :promo_code, :rev_rec_schedule,
+        :sales_group, :sales_rep, :ship_address_list, :ship_method, :shipping_tax_code, :subsidiary, :tax_item, :time_discount, :time_tax_code
+
+      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/cash_sale_item.rb

@@ -0,0 +1,40 @@
+module NetSuite
+  module Records
+    class CashSaleItem
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Namespaces::TranSales
+
+      fields :amount, :amount_ordered, :bin_numbers, :cost_estimate, :current_percent, :defer_rev_rec, :description, :exclude_from_rate_request,
+        :gift_cert_from, :gift_cert_message, :gift_cert_number, :gift_cert_recipient_email, :gift_cert_recipient_name, :gross_amt, :is_taxable,
+        :item_is_fulfilled, :license_code, :line, :order_line, :percent_complete, :quantity, :quantity_available, :quantity_fulfilled, :quantity_oh_hand,
+        :quantity_ordered, :quantity_remaining, :rate, :rev_rec_end_date, :rev_rec_start_date, :serial_numbers, :ship_group, 
+        :tax1_amt, :tax_rate1, :tax_rate2, :vsoe_allocation, :vsoe_amount, :vsoe_is_estimate, :vsoe_delivered, :vsoe_price
+
+      #field :charges_list,         RecordRefList
+      #field :cost_estimate_type,   ItemCostEstimateType
+      #field :vsoe_deferral,        VsoeDeferral
+      #field :vsoe_permit_discount, VsoePermitDiscount
+      #field :vsoe_sop_group,       VsoeSopGroup
+      field :custom_field_list,    CustomFieldList
+      field :inventory_detail,     InventoryDetail
+      field :options,              CustomFieldList
+
+      record_refs :charge_type, :department, :item, :job, :klass, :location, :price, :rev_rec_schedule, :ship_address, :ship_method, :tax_code, :units
+
+      def initialize(attributes = {})
+        initialize_from_attributes_hash(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