netsuite 0.2.4 → 0.2.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTRlZDk0NGYwODZlOTA3OGZmMGQ2MDllMTdmNDNlZDI5YmY4ODNjYw==
+    ZTRiNTZiNjNmNzNhNDY0NzNiYWEwYTBmZmI4MWI3MzA3YTM5N2Q4Nw==
   data.tar.gz: !binary |-
-    ZTA3YTgyYTE5ZDAxNWUyY2ZiNmViODlmNGE1NTY4MjFlY2U2OGI5Ng==
+    ZTdlZTI4Njc5MDlmN2ViNThiMDNjY2Q4ZGE4ZjZkM2JiZGUwNDc0Ng==
 SHA512:
   metadata.gz: !binary |-
-    ZWI1MDEyYWRjNmY3YzNlYWY2ZmUzNDlkNjYzZDgyNGI1YzA5OTg5ZjA0YzQ2
-    N2I3YzUzNDU3NGRjYjA2NjQ0MjZmMWY4ZmNjYTc0MzM4N2UxNjVlMWExZWUy
-    ODUwYzBjM2QzNTI1NGZkNDZiNWM1ODE5M2FmZGVkNWYwNWU0NmQ=
+    NWVkYjczN2Q2ODA0ZTcxMmJmMTlhN2ZhNTg1MmY0Nzc2NGE0MmZhZDJmZWUz
+    ZmE4YWJlZWIxMDQ1NDhjZWVlYjNmYjI3OTdhYjQyNmQxOTUzMWJiYjFlNWFj
+    NmQ3YmU0OTMzOTdhYmI2NzkxMDVjZjE5ZjQ1ZGY2OTE0NzE4ZGU=
   data.tar.gz: !binary |-
-    OTI5Mzc5MWE1NTg1YjUxZWUzYjhlMWIxYmNiZjZkMmVmODUxNDMzOGFkMTg0
-    OGFmZjc5NmMyOGNhZGE0NzJlZTVkYjU2ZWU5YTQwMWYwNmU2NjU2NmExYWNl
-    NDAwZWNmMzk2ZTEzOWM3ZWRhOWJjODg4OTljN2ZkMzU4ZmYwM2Y=
+    NzUzMGVkMDg2ZTQxOTdmMWI3ZWU3ZjgzZWJiMDlmYzQ4M2QzZmFiZWEyZGYw
+    N2ZkZDgwNWUwNzU1MmVhZDRhZjQwYjhkOGU2OTUzMzY1YWYzMGFlMzMwZWRh
+    MDhjYjRlMzZlY2MzMTVhZTg5YWVlNDgyYTFiN2NiZGQxZDVhMTA=

data/README.md

@@ -33,6 +33,9 @@ bundle exec rspec
 ## Usage
 
 ### Configuration
+
+Not sure how to find your account id? Search for "web service preferences" in the NetSuite global search.
+
 ```ruby
 NetSuite.configure do
   reset!
@@ -274,4 +277,33 @@ contact = NetSuite::Records::Contact.get(12345)
 contact.custom_field_list.custentity_alistfield = { internal_id: 1 }
 contact.custom_field_list.custentity_abooleanfield = true
 contact.update(custom_field_list: contact.custom_field_list)
+
+# the getList operation
+NetSuite::Records::CustomRecord.get_list(
+  # netsuite internalIDs
+  list: [1,2,3],
+  # only needed for a custom record
+  type_id: 1234
+).each do |record|
+  # do your thing...
+end
+
+# getting a custom record
+record = NetSuite::Records::CustomRecord.get(
+  # custom record type
+  type_id: 10,
+  # reference to instance of the custom record type
+  internal_id: 100
+)
+
+# adding a custom record
+record = NetSuite::Records::CustomRecord.new
+record.rec_type = NetSuite::Records::CustomRecord.new(internal_id: 10)
+record.custom_field_list.custrecord_locationstate = "New Jersey"
+record.add
+
+# updating a custom record
+record = NetSuite::Records::CustomRecord.new(internal_id: 100)
+record.custom_field_list.custrecord_locationstate = "New Jersey"
+record.update(custom_field_list: record.custom_field_list, rec_type: NetSuite::Records::CustomRecord.new(internal_id: 10))
 ```

data/lib/netsuite.rb

@@ -44,7 +44,7 @@ module NetSuite
     autoload :Update,           'netsuite/actions/update'
     autoload :Upsert,           'netsuite/actions/upsert'
     autoload :Search,           'netsuite/actions/search'
-    autoload :SearchMoreWithId, 'netsuite/actions/search_more_with_id'
+    autoload :Login,            'netsuite/actions/login'
   end
 
   module Records
@@ -84,6 +84,10 @@ module NetSuite
     autoload :Deposit,                    'netsuite/records/deposit'
     autoload :DepositPayment,             'netsuite/records/deposit_payment'
     autoload :DepositPaymentList,         'netsuite/records/deposit_payment_list'
+    autoload :DepositOther,               'netsuite/records/deposit_other'
+    autoload :DepositOtherList,           'netsuite/records/deposit_other_list'
+    autoload :DepositCashBack,            'netsuite/records/deposit_cash_back'
+    autoload :DepositCashBackList,        'netsuite/records/deposit_cash_back_list'
     autoload :Duration,                   'netsuite/records/duration'
     autoload :InventoryItem,              'netsuite/records/inventory_item'
     autoload :Invoice,                    'netsuite/records/invoice'

data/lib/netsuite/actions/add.rb

@@ -11,8 +11,8 @@ module NetSuite
 
       private
 
-      def request
-        NetSuite::Configuration.connection.call :add, :message => request_body
+      def request(credentials={})
+        NetSuite::Configuration.connection({}, credentials).call(:add, :message => request_body)
       end
 
       # <soap:Body>
@@ -70,8 +70,8 @@ module NetSuite
       end
 
       module Support
-        def add
-          response = NetSuite::Actions::Add.call(self)
+        def add(credentials={})
+          response = NetSuite::Actions::Add.call([self], credentials)
 
           @errors = response.errors
 

data/lib/netsuite/actions/delete.rb

@@ -10,13 +10,13 @@ module NetSuite
 
       private
 
-      def request
+      def request(credentials={})
         NetSuite::Configuration.connection(
-          namespaces: {
+          {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"
-          },
-        ).call :delete, :message => request_body
+          }}, credentials
+        ).call :delete, message: request_body
       end
 
       def soap_type
@@ -65,11 +65,11 @@ module NetSuite
       end
 
       module Support
-        def delete(options = {})
+        def delete(options = {}, credentials={})
           response =  if options.empty?
-                        NetSuite::Actions::Delete.call(self)
+                        NetSuite::Actions::Delete.call([self], credentials)
                       else
-                        NetSuite::Actions::Delete.call(self, options)
+                        NetSuite::Actions::Delete.call([self, options], credentials)
                       end
           response.success?
         end

data/lib/netsuite/actions/get.rb

@@ -10,12 +10,12 @@ module NetSuite
 
       private
 
-      def request
+      def request(credentials={})
         NetSuite::Configuration.connection(
-          namespaces: {
+          {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 :get, message: request_body
       end
 
@@ -63,10 +63,10 @@ module NetSuite
 
         module ClassMethods
 
-          def get(options = {})
+          def get(options = {}, credentials = {})
             options = { :internal_id => options } unless options.is_a?(Hash)
 
-            response = NetSuite::Actions::Get.call(self, options)
+            response = NetSuite::Actions::Get.call([self, options], credentials)
             if response.success?
              new(response.body)
             else

data/lib/netsuite/actions/get_list.rb

@@ -10,29 +10,42 @@ module NetSuite
 
       private
 
-      def request
-        NetSuite::Configuration.connection.call :get_list, :message => request_body
+      def request(credentials={})
+        NetSuite::Configuration.connection({}, credentials).call(:get_list, :message => request_body)
       end
 
       def request_body
-        if @options[:type_id]
+        # list of all netsuite types; useful for debugging
+        # https://webservices.netsuite.com/xsd/platform/v2014_1_0/coreTypes.xsd
+
+        list = @options.is_a?(Hash) ? @options[:list] : @options
+
+        formatted_list = if @options[:type_id]
           type = @options[:type_id]
           record_type = 'platformCore:CustomRecordRef'
+
+          list.map do |internal_id|
+            {
+              '@internalId' => internal_id,
+              '@typeId' => type,
+              '@xsi:type' => record_type
+            }
+          end
         else
           type = @klass.to_s.split('::').last.lower_camelcase
           record_type = 'platformCore:RecordRef'
-        end
 
-        list = @options.is_a?(Hash) ? @options[:list] : @options
-
-        {
-          baseRef: list.map do |internal_id|
+          list.map do |internal_id|
             {
               '@internalId' => internal_id,
-              '@typeId' => type,
+              '@type' => type,
               '@xsi:type' => record_type
             }
           end
+        end
+
+        {
+          baseRef: formatted_list
         }
       end
 
@@ -59,8 +72,8 @@ module NetSuite
         end
 
         module ClassMethods
-          def get_list(options = { })
-            response = NetSuite::Actions::GetList.call(self, options)
+          def get_list(options = { }, credentials={})
+            response = NetSuite::Actions::GetList.call([self, options], credentials)
 
             if response.success?
               response.body.map do |record|

data/lib/netsuite/actions/get_select_value.rb

@@ -10,12 +10,12 @@ module NetSuite
 
       private
 
-      def request
+      def request(credentials={})
         NetSuite::Configuration.connection(
-          namespaces: {
+          {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 :get_select_value, :message => @options
       end
 
@@ -39,13 +39,13 @@ module NetSuite
 
         module ClassMethods
 
-          def get_select_value(options = {})
+          def get_select_value(options = {}, credentials={})
             message = {
               pageIndex: (options.delete(:pageIndex) || 1),
               fieldDescription: field_description(options)
             }
 
-            response = NetSuite::Actions::GetSelectValue.call(self, message)
+            response = NetSuite::Actions::GetSelectValue.call([self, message], credentials)
 
             if response.success?
               new(response.body)

data/lib/netsuite/actions/initialize.rb

@@ -8,13 +8,13 @@ module NetSuite
         @object = object
       end
 
-      def request
+      def request(credentials={})
         NetSuite::Configuration.connection(
-          namespaces: {
+          {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",
             'xmlns:platformCoreTyp' => "urn:types.core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
-          },
+          }}, credentials
         ).call :initialize, :message => request_body
       end
 
@@ -64,8 +64,8 @@ module NetSuite
 
         module ClassMethods
 
-          def initialize(object)
-            response = NetSuite::Actions::Initialize.call(self, object)
+          def initialize(object, credentials={})
+            response = NetSuite::Actions::Initialize.call([self, object], credentials)
             if response.success?
               new(response.body)
             else

data/lib/netsuite/actions/login.rb

@@ -0,0 +1,33 @@
+module NetSuite
+  module Actions
+    class Login
+
+      def self.call(credentials)
+        passport = NetSuite::Configuration.auth_header.dup
+        passport['platformMsgs:passport']['platformCore:email'] = credentials[:email] || ''
+        passport['platformMsgs:passport']['platformCore:password'] = credentials[:password] || ''
+
+        begin
+          response = NetSuite::Configuration.connection(soap_header: {}).call :login, message: passport
+        rescue Savon::SOAPFault => e
+          error_details = e.to_hash[:fault]
+
+          return NetSuite::Response.new(
+            success: false,
+            errors: [ NetSuite::Error.new(
+              code: error_details[:detail][:invalid_credentials_fault][:code],
+              message: error_details[:faultstring]
+            )],
+            body: error_details
+          )
+        end
+
+        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]
+        )
+      end
+
+    end
+  end
+end

data/lib/netsuite/actions/search.rb

@@ -17,11 +17,11 @@ module NetSuite
       end
 
       private
-      def request
+      def request(credentials={})
         # https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/SettingSearchPreferences.html
         # https://webservices.netsuite.com/xsd/platform/v2012_2_0/messages.xsd
-        preferences = NetSuite::Configuration.auth_header
-        preferences = preferences.merge(
+
+        preferences = NetSuite::Configuration.auth_header(credentials).update(
           (@options.delete(:preferences) || {}).inject({'platformMsgs:SearchPreferences' => {}}) do |h, (k, v)|
             h['platformMsgs:SearchPreferences'][k.to_s.lower_camelcase] = v
             h
@@ -228,8 +228,8 @@ module NetSuite
         end
 
         module ClassMethods
-          def search(options = { })
-            response = NetSuite::Actions::Search.call(self, options)
+          def search(options = { }, credentials={})
+            response = NetSuite::Actions::Search.call([self, options], credentials)
 
             if response.success?
               NetSuite::Support::SearchResult.new(response, self)

data/lib/netsuite/actions/update.rb

@@ -8,8 +8,8 @@ module NetSuite
         @attributes = attributes
       end
 
-      def request
-        NetSuite::Configuration.connection.call :update, :message => request_body
+      def request(credentials={})
+        NetSuite::Configuration.connection({}, credentials).call :update, :message => request_body
       end
 
       # <platformMsgs:update>
@@ -32,7 +32,7 @@ module NetSuite
         if updated_record.respond_to?(:external_id) && updated_record.external_id
           hash['platformMsgs:record']['@platformMsgs:externalId'] = updated_record.external_id
         end
-        
+
         hash
       end
 
@@ -53,10 +53,10 @@ module NetSuite
       end
 
       module Support
-        def update(options = {})
+        def update(options = {}, credentials={})
           options.merge!(:internal_id => internal_id) if respond_to?(:internal_id) && internal_id
           options.merge!(:external_id => external_id) if respond_to?(:external_id) && external_id
-          response = NetSuite::Actions::Update.call(self.class, options)
+          response = NetSuite::Actions::Update.call([self.class, options], credentials)
           response.success?
         end
       end

data/lib/netsuite/actions/upsert.rb

@@ -11,8 +11,8 @@ module NetSuite
 
       private
 
-      def request
-        NetSuite::Configuration.connection.call :upsert, :message => request_body
+      def request(credentials={})
+        NetSuite::Configuration.connection({}, credentials).call :upsert, :message => request_body
       end
 
       # <soap:Body>
@@ -70,8 +70,8 @@ module NetSuite
       end
 
       module Support
-        def upsert
-          response = NetSuite::Actions::Upsert.call(self)
+        def upsert(credentials={})
+          response = NetSuite::Actions::Upsert.call([self], credentials)
 
           @errors = response.errors
 

data/lib/netsuite/configuration.rb

@@ -10,16 +10,16 @@ module NetSuite
       @attributes ||= {}
     end
 
-    def connection(params = {})
+    def connection(params={}, credentials={})
       Savon.client({
         wsdl: wsdl,
         read_timeout: read_timeout,
         namespaces: namespaces,
-        soap_header: auth_header,
+        soap_header: auth_header(credentials),
         pretty_print_xml: true,
         logger: logger,
         log_level: log_level,
-      }.merge(params))
+      }.update(params))
     end
 
     def api_version(version = nil)
@@ -65,13 +65,13 @@ module NetSuite
       end
     end
 
-    def auth_header
-      attributes[:auth_header] ||= {
+    def auth_header(credentials={})
+      {
         'platformMsgs:passport' => {
-          'platformCore:email'    => email,
-          'platformCore:password' => password,
-          'platformCore:account'  => account.to_s,
-          'platformCore:role'     => { :'@type' => 'role', :@internalId => role }
+          'platformCore:email'    => credentials[:email] || email,
+          'platformCore:password' => credentials[:password] || password,
+          'platformCore:account'  => credentials[:account] || account.to_s,
+          'platformCore:role'     => { :@internalId => credentials[:role] || role }
         }
       }
     end