netsuite_client 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-12-01
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/netsuite_client.rb
+lib/netsuite_client/client.rb
+test/test_helper.rb
+test/test_netsuite_client.rb

data/README.rdoc

@@ -0,0 +1,54 @@
+= netsuite_client
+
+* http://github.com/vjebelev/netsuite_client
+
+== DESCRIPTION:
+
+Ruby soap4r-based Netsuite client. 
+
+== FEATURES/PROBLEMS:
+
+Provides a simple way to access Netsuite data, such as sales orders, inventory items, invoices etc. A valid Netsuite account and a certain familiarity with Netsuite record data types are required.
+
+Best to be used together with Rails Netsuite plugin which offers tighter integration with Active Record models and easier and more transparent access to netsuite data.
+
+
+== SYNOPSIS:
+
+  client = NetsuiteClient.new(:account_id => 1, :email => 'xxx@xxx.com', :password => 'password')
+  sales_order = client.find_by_internal_id('TransactionSearchBasic', 1)
+  
+
+== REQUIREMENTS:
+
+  * a working Netsuite account
+  * ruby 1.8.6/1.8.7
+  * soap4r
+
+== INSTALL:
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Vlad Jebelev
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/netsuite_client'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'netsuite_client' do
+  self.developer 'Vlad Jebelev', 'vlad@jebelev.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/netsuite_client.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+gem 'soap4r'
+
+require 'netsuite_client/soap_netsuite'
+require 'netsuite_client/string'
+require 'netsuite_client/netsuite_exception'
+require 'netsuite_client/netsuite_result'
+require 'netsuite_client/client'
+
+class NetsuiteClient
+  VERSION = '0.0.1'
+end

data/lib/netsuite_client/client.rb

@@ -0,0 +1,191 @@
+require 'logger'
+require 'net/http'
+require 'net/https'
+
+class NetsuiteClient
+  include NetSuite::SOAP
+
+  class NetsuiteHeader < SOAP::Header::SimpleHandler
+    def initialize(prefs = {})
+      @prefs = self.class::DefaultPrefs.merge(prefs)
+      super(XSD::QName.new(nil, self.class::Name))
+    end
+
+    def on_simple_outbound
+      @prefs
+    end
+  end
+
+  class SearchPreferencesHeaderHandler < NetsuiteHeader
+    Name = 'searchPreferences'
+    DefaultPrefs = {:bodyFieldsOnly => false, :pageSize => 25}
+  end
+
+  class PreferencesHeaderHandler < NetsuiteHeader
+    Name = 'preferences'
+    DefaultPrefs = {:warningAsError => false, :ignoreReadOnlyFields => true}
+  end
+
+  class PassportHeaderHandler < NetsuiteHeader
+    Name = 'passport'
+    DefaultPrefs = {:account => '', :email => '', :password => ''}
+  end
+
+  attr_accessor :logger
+
+  def initialize(config = {})
+    @config = config
+
+    @driver = NetSuitePortType.new(@config[:endpoint_url] || NetSuitePortType::DefaultEndpointUrl)
+    @driver.headerhandler.add(PassportHeaderHandler.new(:email => @config[:email], :password => @config[:password], :account => @config[:account_id]))
+    @driver.headerhandler.add(PreferencesHeaderHandler.new)      
+    @driver.headerhandler.add(SearchPreferencesHeaderHandler.new)
+  end
+
+  def debug=(value)
+    @driver.wiredump_dev = value == true ? $stderr : nil
+  end
+
+  def find_by_internal_id(klass, id)
+    find_by_internal_ids(klass, [id])[0]
+  end
+
+  def find_by_internal_ids(klass, ids)
+    basic = constantize(klass).new
+    basic.internalId = SearchMultiSelectField.new
+    basic.internalId.xmlattr_operator = SearchMultiSelectFieldOperator::AnyOf
+
+    records = []
+    ids.each do |id|
+      record = RecordRef.new
+      record.xmlattr_internalId = id
+      records << record
+    end
+
+    basic.internalId.searchValue = records
+
+    full_basic_search(basic)
+  end
+
+  # Only supports equality for integers and strings for now.
+  def find_by(klass, name, value)
+    basic = constantize(klass).new
+
+    ref = nil
+    case value.class.to_s
+    when 'Fixnum'
+      ref = basic.send("#{name}=".to_sym, SearchLongField.new)
+      ref.xmlattr_operator = SearchLongFieldOperator::EqualTo
+
+    else
+      ref = basic.send("#{name}=".to_sym, SearchStringField.new)
+      ref.xmlattr_operator = SearchStringFieldOperator::Is
+    end
+
+    ref.searchValue = value
+
+    full_basic_search(basic)
+  end
+
+  def get(klass, id)
+    ref = RecordRef.new
+    ref.xmlattr_type = constantize(klass)
+    ref.xmlattr_internalId = id
+
+    res = @driver.get(GetRequest.new(ref))
+    res && res.readResponse.status.xmlattr_isSuccess ? res.readResponse.record : nil
+  end
+
+  def get_all(klass)
+    ref = GetAllRecord.new
+    ref.xmlattr_recordType = constantize(klass)
+
+    res = @driver.getAll(GetAllRequest.new(ref))
+    res && res.getAllResult.status.xmlattr_isSuccess ? res.getAllResult.recordList : []
+  end
+
+  def add(ref)
+    res = @driver.add(AddRequest.new(ref))
+    NetsuiteResult.new(res.writeResponse)
+  end
+
+  def update(ref)
+    res = @driver.update(UpdateRequest.new(ref))
+    NetsuiteResult.new(res.writeResponse)
+  end
+
+  def delete(ref)
+    r = RecordRef.new
+    r.xmlattr_type = ref.class.to_s.split('::').last.sub(/^(\w)/) {|s|$1.downcase}
+    r.xmlattr_internalId = ref.xmlattr_internalId
+
+    res = @driver.delete(DeleteRequest.new(r))
+    NetsuiteResult.new(res.writeResponse)
+  end
+
+  private
+
+  # Get the full result set (possibly across multiple pages).
+  def full_basic_search(basic)
+    records, res = exec_basic_search(basic)
+    unless res && res.status.xmlattr_isSuccess
+      return []
+    end
+
+    if res.totalPages > 1
+      while res.pageIndex < res.totalPages
+        next_records, res = exec_next_search(res.searchId, res.pageIndex+1)
+        records += next_records
+      end
+    end
+
+    records
+  end
+
+  # Get the first page of search results for basic search.
+  def exec_basic_search(basic)
+    exec_with_retry do
+      search = constantize(basic.class.to_s.sub(/Basic/, '')).new
+      search.basic = basic
+
+      res = @driver.search(search)
+      return res.searchResult.recordList, res.searchResult
+    end
+  end
+
+  # Get the next page of results.
+  def exec_next_search(search_id, page)
+    exec_with_retry do
+      res = @driver.searchMoreWithId("searchId" => search_id, "pageIndex" => page)
+      return res.searchResult.recordList, res.searchResult
+    end
+  end
+
+  def exec_with_retry(&block)
+    tries = 5
+
+    begin
+      yield
+
+    rescue => e
+
+      logger.warn "Exception: #{e.message}"
+      sleep 0.1
+
+      if tries > 0
+        tries -= 1
+        logger.debug "#{$$} retrying, tries left: #{tries}"
+        retry
+      end
+
+      raise NetsuiteException.new(e)
+    end
+  end
+
+  def constantize(klass)
+    klass.constantize
+
+    rescue NameError
+      "NetSuite::SOAP::#{klass}".constantize
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/netsuite_client'

data/test/test_netsuite_client.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestNetsuiteClient < Test::Unit::TestCase
+  include NetSuite::SOAP
+
+  def setup
+    ENV['NS_ENDPOINT_URL'] ||= 'https://webservices.sandbox.netsuite.com/services/NetSuitePort_2009_1'
+
+    unless ENV['NS_ACCOUNT_ID'] && ENV['NS_EMAIL'] && ENV['NS_PASSWORD'] 
+      puts "Ensure that your environment variables are set: NS_ACCOUNT_ID, NS_EMAIL, NS_PASSWORD"
+      exit(-1)
+    end
+
+    @client = NetsuiteClient.new(:account_id => ENV['NS_ACCOUNT_ID'], :email => ENV['NS_EMAIL'], :password => ENV['NS_PASSWORD'], :endpoint_url => ENV['NS_ENDPOINT_URL'])
+    #@client.debug = true
+  end
+  
+  def test_init
+    assert_not_nil @client
+  end
+
+  def test_find_by_internal_id
+    records = @client.find_by_internal_ids('TransactionSearchBasic', [1])
+    assert_equal [], records
+  end
+
+  def test_get
+    record = @client.get('RecordType::PaymentMethod', 1)
+    assert_not_nil record
+    assert_equal 1, record.xmlattr_internalId.to_i
+    assert_equal 'NetSuite::SOAP::PaymentMethod', record.class.to_s
+  end
+
+  def test_get_all
+    records = @client.get_all('RecordType::PaymentMethod')
+    assert records.any?
+    assert records.all? {|r| r.class.to_s == 'NetSuite::SOAP::PaymentMethod'}
+  end
+
+  def test_add_inventory_item
+    ref = InventoryItem.new
+    ref.itemId = 'test inventory item'
+    res = @client.add(ref)
+    assert_not_nil res
+    assert res.success? || res.error_code == 'DUP_ITEM'
+  end
+
+  def test_find_by_item_id
+    test_add_inventory_item
+    item = @client.find_by('ItemSearchBasic', 'itemId', 'test inventory item')
+
+    assert_not_nil item
+    assert_equal 'NetSuite::SOAP::RecordList', item.class.to_s
+    assert_equal 1, item.size
+    assert_equal 'NetSuite::SOAP::InventoryItem', item[0].class.to_s
+  end
+
+  def test_update_inventory_item
+    test_add_inventory_item
+    new_name = String.random_string
+
+    item = @client.find_by('ItemSearchBasic', 'itemId', 'test inventory item')[0]
+    assert item.displayName != new_name
+    
+    ref = InventoryItem.new
+    ref.xmlattr_internalId = item.xmlattr_internalId
+    ref.displayName = new_name
+    res = @client.update(ref)
+    assert_not_nil res
+    assert res.success?
+    
+    item = @client.find_by('ItemSearchBasic', 'itemId', 'test inventory item')[0]
+    assert item.displayName == new_name
+  end
+
+  def test_delete_inventory_item
+    test_add_inventory_item
+    item = @client.find_by('ItemSearchBasic', 'itemId', 'test inventory item')[0]
+    assert_not_nil item
+
+    ref = InventoryItem.new
+    ref.xmlattr_internalId = item.xmlattr_internalId
+    res = @client.delete(ref)
+    assert_not_nil res
+    assert res.success?
+    assert_nil @client.find_by('ItemSearchBasic', 'itemId', 'test inventory item')[0]
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: netsuite_client
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Vlad Jebelev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-06 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        - 3
+        version: 2.3.3
+  type: :development
+  version_requirements: *id001
+description: Ruby soap4r-based Netsuite client.
+email: 
+- vlad@jebelev.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/netsuite_client.rb
+- lib/netsuite_client/client.rb
+- test/test_helper.rb
+- test/test_netsuite_client.rb
+has_rdoc: true
+homepage: http://github.com/vjebelev/netsuite_client
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: netsuite_client
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby soap4r-based Netsuite client.
+test_files: 
+- test/test_netsuite_client.rb
+- test/test_helper.rb