sapnwrfc 0.23-i686-linux → 0.24-i686-linux

data/ChangeLog

@@ -0,0 +1,28 @@
+2012-04-10  Michele Franzin  <michele.franzin@gmail.com>
+  * bump to version 0.24
+  * rdocs & build toolchain updates
+
+2011-05-27  Michele Franzin  <michele.franzin@gmail.com>
+  * create github project
+  * upgrade to ruby 1.9.x
+
+2007-01-24  Piers Harding  <piers@ompka.net>
+  * Initial Release
+	This is the first release of sapnw for Ruby
+	it contains support for full interface discovery, and all SAP ABAP datatypes
+	in structures or parameters, and some support for deep structures
+
+Fri May 18 10:07:59 BST 2007
+  * fix up ambiguities in the build process
+
+Wed May 30 17:54:09 BST 2007
+  * add in support for nested tables in parameters
+
+Fri Jun  1 16:42:30 BST 2007
+  * add in nested table support: parameter -> field -> table ...
+
+Thu Jun 26 18:51:20 NZST 2008
+  * removed connection attributes that are no longer supported
+
+Thu Dec 11 09:51:47 NZDT 2008
+  * make sure that close cannot be called twice

data/README.rdoc

@@ -0,0 +1,72 @@
+= sapnwrfc - SAP Netweaver RFC support for Ruby 1.9.x
+
+== Summary
+
+Welcome to the sapnwrfc Ruby package.  This package is intended to facilitate RFC calls to an SAP R/3 system of release NW2004x and above.  It may work for earlier versions but it hasn't been tested.
+The fundamental purpose of the production of this package, is to provide a clean object oriented interface to RFC calls from within Ruby.  This will hopefully have a number of effects:
+
+(1) make it really easy to do RFC calls to SAP from Ruby in an object oriented fashion (Doh!)
+
+(2) promote Ruby as the interface/scripting/glue language of choice for interaction with SAP R/3.
+
+(3) make the combination of Linux, Apache, and Ruby the killer app for internet connectivity with SAP.
+
+(4) Establish a small fun open source project that people are more than welcome to contribute to, if they so wish.
+
+== Installation
+
+After you have unpacked your kit, you should have all the files listed
+in the MANIFEST.
+
+In brief, the following should work on most systems:
+  ruby setup.rb 
+
+if your rfcsdk is not findable in the system search path, then use the command line switches
+for mkmf/setup.rb like so:
+  ruby setup.rb config  --with-nwrfcsdk-dir=/path/to/rfcsdk
+  ruby setup.rb setup
+
+Now you can either install like so:
+  ruby setup.rb install
+
+or build the gem and install that like so:
+  gem build sapnwrfc.linux.gemspec
+  gem uninstall sapnwrfc
+  gem install sapnwrfc-<version>-<architecture>.gem
+
+
+VERY IMPORTANT - make sure that you add the library path to LD_LIBRARY_PATH
+eg - mine is:
+  export LD_LIBRARY_PATH=/home/piers/code/sap/nwrfcsdk/lib
+
+
+== Documents and Tests
+
+[doc/*]
+   Module Documentation
+
+[tests/*.rb]
+   Test basic connection, and some rfc call examples
+
+== Credits
+
+GitHub repo:: Michele Franzin <michele@franzin.net>
+Ruby 1.9.x porting:: Michele Franzin <michele@franzin.net>
+
+== License
+
+saprfc is Copyright (c) 2006-2008 Piers Harding.  It is free software, and
+may be redistributed under the terms specified in the README file of
+the Ruby distribution.
+
+One last thing - The SAP RFCSDK is a prerequisite for this perl package to work.
+The RFCSDK is proprietrary software owned by SAP AG.
+For this reason I will not supply ANY component part of the RFCSDK with this perl package, and further more you must obtain it through the normal channels with SAP AG - ie. you must have a licensed SAP R/3 installation at your disposal.
+
+
+= Other stuff
+
+Author::   Piers Harding <piers@ompka.net>
+Requires:: Ruby 1.9.x or later
+License::  Copyright (c) 2006-2008 Piers Harding
+           Released under Ruby's License

data/lib/sapnwrfc.rb

@@ -9,9 +9,9 @@
 #
 # = Download and Documentation
 #
-# Documentation at: http://www.piersharding.com/download/ruby/sapnwrfc/doc/
+# Documentation at: http://rubydoc.info/github/fuzziness/sapnwrfc/frames
 #
-# Project and Download at: http://raa.ruby-lang.org/project/sapnwrfc
+# Project and Download at: https://github.com/fuzziness/sapnwrfc
 #
 # = Functionality
 #
@@ -166,9 +166,10 @@
 #
 # = Thanks to:
 #
-# * Olivier Boudry - an Open Source guy
-# * Craig Cmehil   - SAP, and SDN
-# * Ulrich Schmidt - SAP
+# * Olivier Boudry  - an Open Source guy
+# * Craig Cmehil    - SAP, and SDN
+# * Ulrich Schmidt  - SAP
+# * Michele Franzin - ruby 1.9.x porting
 # For their help in making this possible.
 #
 #
@@ -176,7 +177,7 @@
 #
 # Author::   Piers Harding <piers@ompka.net>
 # License::  Copyright (c) 2006-2008 Piers Harding. sapnwrfc is free software, and may be redistributed under the terms specified in the README file of the Ruby distribution.
-# Requires:: Ruby 1.9.0 or later
+# Requires:: Ruby 1.9.x or later
 #
 
 
@@ -191,6 +192,7 @@ SAP_LOGGER = Logger.new(STDERR)
 SAP_LOGGER.datetime_format = "%Y-%m-%d %H:%M:%S"
 SAP_LOGGER.level = Logger::WARN
 
+require 'sapnwrfc/version'
 require 'sapnwrfc/base'
 
 # C extension

data/lib/sapnwrfc/base.rb

@@ -7,8 +7,10 @@
 # sapnwrfc is a RFC based connector to SAP specifically designed for use with the
 # next generation RFC SDK supplied by SAP for NW2004+ .
 #
+# Author::   Piers Harding <piers@ompka.net>
+# Author::   Michele Franzin <michele@franzin.net>
+# Requires:: Ruby 1.9 or later
 #
-# 
 
 module SAPNW
 

data/lib/sapnwrfc/config.rb

@@ -55,6 +55,7 @@
 #
 #
 # Author::   Piers Harding <piers@ompka.net>
+# Author::   Michele Franzin <michele@franzin.net>
 # Requires:: Ruby 1.9 or later
 #
 

data/lib/sapnwrfc/connection.rb

@@ -3,6 +3,7 @@
 # the Ruby distribution.
 #
 # Author::   Piers Harding <piers@ompka.net>
+# Author::   Michele Franzin <michele@franzin.net>
 # Requires:: Ruby 1.9 or later
 #
 

data/lib/sapnwrfc/functions.rb

@@ -3,6 +3,7 @@
 # the Ruby distribution.
 #
 # Author::   Piers Harding <piers@ompka.net>
+# Author::   Michele Franzin <michele@franzin.net>
 # Requires:: Ruby 1.9 or later
 #
 

data/lib/sapnwrfc/parameters.rb

@@ -3,6 +3,7 @@
 # the Ruby distribution.
 #
 # Author::   Piers Harding <piers@ompka.net>
+# Author::   Michele Franzin <michele@franzin.net>
 # Requires:: Ruby 1.9 or later
 #
 

data/lib/sapnwrfc/server.rb

@@ -3,6 +3,7 @@
 # the Ruby distribution.
 #
 # Author::   Piers Harding <piers@ompka.net>
+# Author::   Michele Franzin <michele@franzin.net>
 # Requires:: Ruby 1.9 or later
 #
 

data/lib/sapnwrfc/version.rb

@@ -0,0 +1,3 @@
+module SAPNW
+  VERSION = "0.24"
+end

data/test/sap.yml

@@ -0,0 +1,11 @@
+ashost: gecko.local.net
+sysnr: "01"
+client: "001"
+user: developer
+passwd: developer
+lang: EN
+trace: 1
+loglevel: warn
+tpname: wibble.rfcexec
+gwhost: gecko.local.net
+gwserv: "3301"

data/test/test_attributes.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby
+$:.unshift(File.dirname(__FILE__) + '/lib')
+$:.unshift(File.dirname(__FILE__) + '/ext/nwsaprfc')
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__) + '/../ext/nwsaprfc')
+
+require 'sapnwrfc'
+
+$TEST_FILE = ENV.has_key?('SAP_YML') ? ENV['SAP_YML'] : 'sap.yml'
+
+require 'test/unit'
+require 'test/unit/assertions'
+
+class SAPConnectionAttributeTest < Test::Unit::TestCase
+	def setup
+	  #SAP_LOGGER.warn "Current DIR: #{Dir.pwd}\n"
+	  if FileTest.exists?($TEST_FILE)
+  	  SAPNW::Base.config_location = $TEST_FILE
+		else
+  	  SAPNW::Base.config_location = 'test/' + $TEST_FILE
+		end
+	  SAPNW::Base.load_config
+    #SAP_LOGGER.warn "program: #{$0}\n"
+	end
+	
+	def test_BASIC_00010_Connection_Attributes
+	  assert(conn = SAPNW::Base.rfc_connect)
+		attrib = conn.connection_attributes
+		SAP_LOGGER.debug "Connection Attributes: #{attrib.inspect}\n"
+		assert(attrib.length > 10)
+		assert(attrib['sysId'].rstrip.length == 3)
+		assert(attrib['progName'].strip == "SAPLSYST")
+		assert(attrib['rfcRole'] == 'C')
+		assert(conn.close)
+	end
+	
+	def test_BASIC_00010_Connection_Attributes_Volume
+	  50.times do
+	    assert(conn = SAPNW::Base.rfc_connect)
+		  attrib = conn.connection_attributes
+		  SAP_LOGGER.debug "Connection Attributes: #{attrib.inspect}\n"
+		  assert(attrib.length > 10)
+		  assert(attrib['sysId'].rstrip.length == 3)
+		  assert(attrib['progName'].strip == "SAPLSYST")
+		  assert(attrib['rfcRole'] == 'C')
+		  assert(conn.close)
+		end
+	end
+
+	def teardown
+	end
+end

data/test/test_call.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/ruby
+$:.unshift(File.dirname(__FILE__) + '/lib')
+$:.unshift(File.dirname(__FILE__) + '/ext/nwsaprfc')
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__) + '/../ext/nwsaprfc')
+
+require 'sapnwrfc'
+
+$ITER = 50
+$TEST_FILE = ENV.has_key?('SAP_YML') ? ENV['SAP_YML'] : 'sap.yml'
+
+require 'test/unit'
+require 'test/unit/assertions'
+
+class SAPCallTest < Test::Unit::TestCase
+	def setup
+	  #SAP_LOGGER.warn "Current DIR: #{Dir.pwd}\n"
+	  if FileTest.exists?($TEST_FILE)
+  	  SAPNW::Base.config_location = $TEST_FILE
+		else
+  	  SAPNW::Base.config_location = 'test/' + $TEST_FILE
+		end
+	  SAPNW::Base.load_config
+    #SAP_LOGGER.warn "program: #{$0}\n"
+	end
+	
+	def test_BASIC_00010_Program_Read
+	  $ITER.to_i.times do
+			begin 
+	      assert(conn = SAPNW::Base.rfc_connect)
+		    attrib = conn.connection_attributes
+		    #SAP_LOGGER.warn "Connection Attributes: #{attrib.inspect}\n"
+		    fd = conn.discover("RPY_PROGRAM_READ")
+		    assert(fd.name == "RPY_PROGRAM_READ")
+        f = fd.new_function_call
+		    assert(fd.parameters.has_key?("PROGRAM_NAME"))
+		    assert(f.parameters.has_key?("PROGRAM_NAME"))
+		    assert(f.name == "RPY_PROGRAM_READ")
+				f.PROGRAM_NAME = 'SAPLGRFC'
+			  #SAP_LOGGER.warn "FunctionCall: #{f.inspect}\n"
+			  #SAP_LOGGER.warn "FunctionCall PROGRAM_NAME: #{f.PROGRAM_NAME}/#{f.parameters['PROGRAM_NAME'].type}\n"
+				assert(f.PROGRAM_NAME == 'SAPLGRFC')
+				begin
+				  f.invoke
+				rescue SAPNW::RFC::FunctionCallException => e
+				  SAP_LOGGER.warn "FunctionCallException: #{e.error.inspect}\n"
+				  raise "gone"
+				end
+				#SAP_LOGGER.warn "#{f.PROG_INF.has_key?('PROG')}\n"
+				#SAP_LOGGER.warn "#{f.PROG_INF.inspect}\n"
+				#f.PROG_INF.each_pair do |k, v|
+				#  SAP_LOGGER.warn "#{k} => #{v}\n"
+				#end
+				#SAP_LOGGER.warn "PROGNAME: #{f.PROG_INF['PROGNAME'].rstrip}#\n"
+				assert(f.PROG_INF['PROGNAME'].rstrip == "SAPLGRFC")
+				assert(f.SOURCE_EXTENDED.length > 10)
+				#f.SOURCE_EXTENDED.each do |row|
+				#  SAP_LOGGER.warn "Line: #{row['LINE']}\n"
+				#end
+		    assert(conn.close)
+			rescue SAPNW::RFC::ConnectionException => e
+			  SAP_LOGGER.warn "ConnectionException ERROR: #{e.inspect} - #{e.error.inspect}\n"
+			end
+		end
+	  GC.start
+	end
+
+
+	def test_BASIC_00020_Program_Read_Volume
+	  assert(conn = SAPNW::Base.rfc_connect)
+		attrib = conn.connection_attributes
+		fd = conn.discover("RPY_PROGRAM_READ")
+		assert(fd.name == "RPY_PROGRAM_READ")
+	  $ITER.to_i.times do |iter|
+      f = fd.new_function_call
+		  assert(fd.parameters.has_key?("PROGRAM_NAME"))
+		  assert(f.parameters.has_key?("PROGRAM_NAME"))
+		  assert(f.name == "RPY_PROGRAM_READ")
+			f.PROGRAM_NAME = 'SAPLGRFC'
+			assert(f.PROGRAM_NAME == 'SAPLGRFC')
+			begin
+			  f.invoke
+			rescue SAPNW::RFC::FunctionCallException => e
+			  SAP_LOGGER.warn "FunctionCallException: #{e.error.inspect}\n"
+			  raise "gone"
+			end
+			assert(f.PROG_INF['PROGNAME'].rstrip == "SAPLGRFC")
+			assert(f.SOURCE_EXTENDED.length > 10)
+	    GC.start unless iter % 50
+		end
+		assert(conn.close)
+	  GC.start
+	end
+
+
+	def test_BASIC_00030_Read_table
+	  assert(conn = SAPNW::Base.rfc_connect)
+		attrib = conn.connection_attributes
+		fd = conn.discover("RFC_READ_TABLE")
+		assert(fd.name == "RFC_READ_TABLE")
+	  $ITER.to_i.times do |iter|
+      f = fd.new_function_call
+		  assert(fd.parameters.has_key?("QUERY_TABLE"))
+		  assert(f.parameters.has_key?("QUERY_TABLE"))
+		  assert(f.name == "RFC_READ_TABLE")
+			f.QUERY_TABLE = 'T000'
+			f.DELIMITER = '|'
+			f.ROWCOUNT = 2
+			assert(f.QUERY_TABLE == 'T000')
+			begin
+			  f.invoke
+			rescue SAPNW::RFC::FunctionCallException => e
+			  SAP_LOGGER.warn "FunctionCallException: #{e.error.inspect}\n"
+			  raise "gone"
+			end
+			assert(f.DATA.length > 1)
+			#f.DATA.each do |row|
+			#  SAP_LOGGER.warn "Line: #{row.inspect}\n"
+			#end
+	    GC.start unless iter % 50
+		end
+		assert(conn.close)
+	  GC.start
+	end
+
+	def teardown
+	end
+end

data/test/test_changing.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/ruby
+$KCODE = 'u'
+$:.unshift(File.dirname(__FILE__) + '/lib')
+$:.unshift(File.dirname(__FILE__) + '/ext/nwsaprfc')
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__) + '/../ext/nwsaprfc')
+
+require 'sapnwrfc'
+
+$TEST_FILE = ENV.has_key?('SAP_YML') ? ENV['SAP_YML'] : 'sap.yml'
+
+$ITER = 50
+
+require 'test/unit'
+require 'test/unit/assertions'
+
+class SAPChangingTest < Test::Unit::TestCase
+	def setup
+	  #SAP_LOGGER.warn "Current DIR: #{Dir.pwd}\n"
+	  if FileTest.exists?($TEST_FILE)
+  	  SAPNW::Base.config_location = $TEST_FILE
+		else
+  	  SAPNW::Base.config_location = 'test/' + $TEST_FILE
+		end
+	  SAPNW::Base.load_config
+    #SAP_LOGGER.warn "program: #{$0}\n"
+	end
+	
+	def test_BASIC_00010_Test_Changing
+		begin 
+		  $ITER.times do |iter|
+	      assert(conn = SAPNW::Base.rfc_connect)
+	      attrib = conn.connection_attributes
+	      SAP_LOGGER.debug "Connection Attributes: #{attrib.inspect}\n"
+		    fd = conn.discover("STFC_CHANGING")
+	      SAP_LOGGER.debug "Parameters: #{fd.parameters.keys.inspect}\n"
+        f = fd.new_function_call
+			  f.START_VALUE = iter
+			  f.COUNTER = iter
+		    f.invoke
+	      SAP_LOGGER.debug "RESULT: #{f.RESULT}\n"
+	      SAP_LOGGER.debug "COUNTER: #{f.COUNTER}\n"
+			  assert(f.RESULT == iter + iter)
+			  assert(f.COUNTER == iter + 1)
+		    assert(conn.close)
+			  GC.start unless iter % 50
+			end
+		rescue SAPNW::RFC::FunctionCallException => e
+		  SAP_LOGGER.warn "FunctionCallException: #{e.error.inspect}\n"
+		  raise "gone"
+		end
+	end
+	
+	def test_BASIC_00020_Test_Changing
+		begin 
+	      assert(conn = SAPNW::Base.rfc_connect)
+	      attrib = conn.connection_attributes
+	      SAP_LOGGER.debug "Connection Attributes: #{attrib.inspect}\n"
+		    fd = conn.discover("STFC_CHANGING")
+	      SAP_LOGGER.debug "Parameters: #{fd.parameters.keys.inspect}\n"
+		    $ITER.times do |iter|
+			    GC.start unless iter % 50
+          f = fd.new_function_call
+			    f.START_VALUE = iter
+			    f.COUNTER = iter
+		      f.invoke
+	        SAP_LOGGER.debug "RESULT: #{f.RESULT}\n"
+	        SAP_LOGGER.debug "COUNTER: #{f.COUNTER}\n"
+			    assert(f.RESULT == iter + iter)
+			    assert(f.COUNTER == iter + 1)
+			  end
+		    assert(conn.close)
+		rescue SAPNW::RFC::FunctionCallException => e
+		  SAP_LOGGER.warn "FunctionCallException: #{e.error.inspect}\n"
+		  raise "gone"
+		end
+	end
+
+	def teardown
+	end
+end