nwrfc 0.0.1 → 0.0.2

data/README.rdoc

@@ -77,6 +77,17 @@ so that ["system2"] at the end points to whatever label you gave it in the YAML
 
 == Release Notes
 
+=== What's new in 0.0.2
+
+* More comprehensive type support
+* More table operations
+
+=== What's new in 0.0.1
+
+* Fix loading sapnw library
+* Fix UTF-8 conversion for Windows
+* Enhanced type support
+
 === What's new in 0.0.0
 
 * Able to call functions
@@ -85,6 +96,6 @@ so that ["system2"] at the end points to whatever label you gave it in the YAML
 
 == Contributing
 
-Improvements to the source code are welcome. Email me at martin dot ceronio at infosize dot co dot za.
-
-Also let me know, please on which platforms you have tested the gem.
+* Improvements to the source code are welcome
+* Indicate on which platforms you have tested the gem
+* Suggestions for improving the API / Hints for idiomatic Ruby

data/lib/nwrfc.rb

@@ -7,6 +7,8 @@
 
 require File.dirname(__FILE__)+'/nwrfc/nwrfclib'
 require File.dirname(__FILE__)+'/nwrfc/datacontainer'
+require File.dirname(__FILE__)+'/nwrfc/server'
+require File.dirname(__FILE__)+'/nwrfc/nwerror'
 
 require 'date'
 require 'time'
@@ -38,9 +40,26 @@ module NWRFC
     [version.read_string_dn.uC, major.read_uint, minor.read_uint, patch.read_uint]
   end
 
+  # Take Hash of connection parameters and returns FFI pointer to an array
+  # for passing to connection
+  def NWRFC.make_conn_params(params) #https://github.com/ffi/ffi/wiki/Structs
+    par = FFI::MemoryPointer.new(NWRFCLib::RFCConnParam, params.length)
+    pars = params.length.times.collect do |i|
+      NWRFCLib::RFCConnParam.new(par + i * NWRFCLib::RFCConnParam.size)
+    end
+    tpar = params.to_a
+    params.length.times do |n|
+      pars[n][:name] = FFI::MemoryPointer.from_string(tpar[n][0].to_s.cU)
+      pars[n][:value] = FFI::MemoryPointer.from_string(tpar[n][1].to_s.cU)
+    end
+    par
+  end
+
   def NWRFC.check_error(error_handle)
-    raise "Error code #{error_handle[:code]} group #{error_handle[:group]} message #{error_handle[:message].get_str}" \
+    raise NWError, error_handle \
       if error_handle[:code] > 0
+    #raise "Error code #{error_handle[:code]} group #{error_handle[:group]} message #{error_handle[:message].get_str}" \
+      
   end
 
   # Represents a connection to a SAP system that can be used to invoke
@@ -54,11 +73,9 @@ module NWRFC
     def initialize(conn_params)
       conn_params.untaint #For params loaded from file, e.g.
       raise "Connection parameters must be a Hash" unless conn_params.instance_of? Hash
-      #NWRFCLib.init
-      @cparams = NWRFCLib.make_conn_params(conn_params)
+      @cparams = NWRFC.make_conn_params(conn_params)
       raise "Could not create valid pointer from parameters" unless @cparams.instance_of? FFI::MemoryPointer
-      #@errp = FFI::MemoryPointer.new(NWRFCLib::RFCError)
-      @error =  NWRFCLib::RFCError.new #@errp
+      @error =  NWRFCLib::RFCError.new
       @handle = NWRFCLib.open_connection(@cparams, conn_params.length, @error.to_ptr)
       NWRFC.check_error(@error)
       self
@@ -108,8 +125,15 @@ module NWRFC
     attr_accessor :handle
 
     # Create a parameter by setting parameter attributes
-    def initialize(*args)
+    def initialize(*args)  
+
       attr = args[0]
+      
+      #TODO: For certain types, e.g. :RFCTYPE_BCD, a length specification is 
+      # required, otherwise a segfault is the result later down the line.
+      # Find and implement all the types where this is required
+      raise "RFCTYPE_BCD requires a length" if attr[:type] == :RFCTYPE_BCD && !(attr[:length])
+
       @handle                 = NWRFCLib::RFCFuncParam.new
       @handle[:name]          = attr[:name].cU if attr[:name]
       @handle[:direction]     = NWRFCLib::RFC_DIRECTION[attr[:direction]] if attr[:direction]
@@ -133,8 +157,10 @@ module NWRFC
   # or by calling Connection#get_function. This only represents the description of the function;
   # to call a function, an instance of a function call must be obtained with #get_function_call
   class Function
-    attr_reader :desc, :connection, :function_name
+    attr_reader :desc, :function_name
+    attr_accessor :connection
 
+    # TODO: Update doc to reflect different calling options
     # Get a function module instance; can also be obtained by calling Connection#get_function
     # Takes either: (connection, function_name) or (function_name)
     # When passed only `function_name`, creates a new function description locally, instead of
@@ -173,17 +199,47 @@ module NWRFC
       pcount.read_uint
     end
 
+    # Return the description of parameters associated with this Function
+    def parameters
+      parameter_count.times.inject({}) do |params, index|
+        param = NWRFCLib::RFCFuncParam.new
+        NWRFCLib.get_parameter_desc_by_index(@desc, index, param.to_ptr, @error.to_ptr)
+        params[param[:name].get_str] = {
+          :type => NWRFCLib::RFC_TYPE[param[:type]],
+          :direction => NWRFCLib::RFC_DIRECTION[param[:direction]],
+          :nucLength => param[:nucLength],
+          :ucLength => param[:ucLength],
+          :decimals => param[:decimals],
+          :typeDescHandle => param[:typeDescHandle],
+          :defaultValue => param[:defaultValue].get_str,
+          :parameterText => param[:parameterText].get_str,
+          :optional => param[:optional]
+        }
+        params
+      end
+    end
+
   end
 
+  # Represents a callable instance of a function
   class FunctionCall < DataContainer
     attr_reader :handle, :desc, :connection, :function
 
-    def initialize(function)
+    # TODO: Update doc to reflect different calling options
+    # Call with either Function or Connection and Function Call instance (handle)
+    def initialize(*args)
+      raise("Must initialize function with 1 or 2 arguments") if args.size != 1 && args.size != 2
       @error = NWRFCLib::RFCError.new
-      @function = function
-      @connection = function.connection
-      @handle = NWRFCLib.create_function(@function.desc, @error.to_ptr)
-      @desc = function.desc
+      if args.size == 2
+        @handle = args[1]
+        @connection = args[0].connection
+        # TODO: Get function description from instance
+      else
+        @function = args[0] #function
+        @connection = args[0].connection
+        @handle = NWRFCLib.create_function(@function.desc, @error.to_ptr)
+        @desc = args[0].desc
+      end
       NWRFC.check_error(@error)
     end
 
@@ -198,7 +254,8 @@ module NWRFC
 
     include Enumerable
 
-    def each(&block)
+    # Iterate over the rows in a table. Each row is yielded as a structure
+    def each(&block) #:yields row
       rc = NWRFCLib.move_to_first_row(@handle, @error)
       NWRFC.check_error(@error) if rc > 0
       size.times do |row|
@@ -210,6 +267,7 @@ module NWRFC
       end
     end
 
+    # Return the number of rows in the table
     def size
       rows = FFI::MemoryPointer.new(:uint)
       rc = NWRFCLib.get_row_count(@handle, rows, @error)
@@ -231,6 +289,20 @@ module NWRFC
       Structure.new(struct_handle)
     end
 
+    # Append a row (structure) to the table
+    def append(row)
+      raise "Must append a structure" unless row.class == NWRFC::Structure
+      rc = NWRFCLib.append_row(@handle, row.handle, @error)
+      NWRFC.check_error(@error) if rc > 0
+    end
+
+    # Add new (empty) row and return the structure handle
+    def new_row
+      s_handle = NWRFCLib.append_new_row(@handle, @error)
+      NWRFC.check_error(@error)
+      Structure.new(s_handle)
+    end
+
   end #class Table
 
   # Represents a structure. An instance is obtained internally by passing the
@@ -241,7 +313,7 @@ module NWRFC
     # Return a list (array) of symbols representing the names of the fields
     # of this structure
     #---
-    # TODO: This is not working!
+    # FIXME: This is not working!
     def fields
       fc = FFI::MemoryPointer.new(:uint)
       rc = NWRFCLib.get_field_count(@handle, fc, @error)

data/lib/nwrfc/datacontainer.rb

@@ -12,157 +12,225 @@ module NWRFC
       NWRFC.check_error(@error)
     end
 
-    # Return the member specified by string or symbol
+    #--
+    # VALUE RETRIEVAL
+    #++
+
+    # Get value from a data container (structure, function instance or table)
     def [](element)
       member = element.to_s.upcase
       metadata = member_metadata(element)
       case metadata[:type]
-      when :RFCTYPE_CHAR
-        # TODO: Try use :string parameter in get_chars
-        return read_chars(metadata)
-      when :RFCTYPE_DATE
-        return Date.parse(read_chars(metadata))
+
+        when :RFCTYPE_CHAR
+          # TODO: Try use :string parameter in get_chars
+          return read_chars(metadata)
+
+        when :RFCTYPE_DATE
+          return Date.parse(read_chars(metadata))
         #return Date.new(date[0..3].to_i, date[4..5].to_i, date[6..7].to_i)
-      when :RFCTYPE_BCD
-        size = metadata[:ucLength]
-        cb = FFI::MemoryPointer.new :char, size * 2
-        rc = NWRFCLib.get_chars(@handle, metadata[:name].cU, cb, size * 2, @error.to_ptr)
-        NWRFC.check_error(@error) if rc > 0
-        cb.read_string(size).uC
-      when :RFCTYPE_TIME
-        # TODO: See whether we can optimize this
-        timec = read_chars(metadata)
-        return Time.parse("#{timec[0..1]}:#{timec[2..3]}:#{timec[4..5]}")
-      when :RFCTYPE_BYTE
-        return read_chars(metadata)
-      when :RFCTYPE_TABLE
-        new_handle = NWRFCLib::RFCDataContainer.new
-        rc = NWRFCLib.get_table(@handle, member.cU, new_handle.to_ptr, @error.to_ptr)
-        NWRFC.check_error(@error) if rc > 0
-        # CAVEAT: Other calls using the handle require "handle" field
-        # of the RFC_DATA_CONTAINER struct for some reason.
-        new_handle = new_handle[:handle]
-        value = Table.new(new_handle)
-      when :RFCTYPE_NUM
-        return read_chars(metadata).to_i
-      when :RFCTYPE_FLOAT
-        double = FFI::MemoryPointer.new :double
-        rc = NWRFCLib.get_float(@handle, member.cU, double, @error)
-        NWRFC.check_error(@error) if rc > 0
-        return double.get_double(0)
-      when :RFCTYPE_INT
-        int = FFI::MemoryPointer.new :int
-        rc = NWRFCLib.get_int(@handle, member.cU, int, @error)
-        NWRFC.check_error(@error) if rc > 0
-        return int.get_int(0)
-      when :RFCTYPE_INT2
-        short = FFI::MemoryPointer.new :short
-        rc = NWRFCLib.get_int2(@handle, member.cU, short, @error)
-        NWRFC.check_error(@error) if rc > 0
-        return short.get_short(0)
-      when :RFCTYPE_INT1
-        int1 = FFI::MemoryPointer.new :uint8
-        rc = NWRFCLib.get_int1(@handle, member.cU, int1, @error)
-        NWRFC.check_error(@error) if rc > 0
-        return int1.get_uint8(0)
-      when :RFCTYPE_NULL
-        raise "Unsupported type RFCTYPE_NULL" #You should never run into this
-      when :RFCTYPE_STRUCTURE
-        new_handle = NWRFCLib::RFCDataContainer.new
-        rc = NWRFCLib.get_structure(@handle, member.cU, new_handle.to_ptr, @error.to_ptr)
-        NWRFC.check_error(@error) if rc > 0
-        new_handle = new_handle[:handle]
-        value = Structure.new(new_handle)
-      when :RFCTYPE_DECF16
-        double = FFI::MemoryPointer.new :double
-        rc = NWRFCLib.get_dec_f16(@handle, member.cU, double, @error)
-        NWRFC.check_error(@error) if rc > 0
-        return double.get_double(0)
-      when :RFCTYPE_DECF34
-        double = FFI::MemoryPointer.new :double, 2
-        rc = NWRFCLib.get_dec_f34(@handle, member.cU, double, @error)
-        NWRFC.check_error(@error) if rc > 0
-        return double.get_double(0)
-      when :RFCTYPE_XMLDATA
-        raise "Unsupported type RFCTYPE_XMLDATA (no longer used)" #You should never run into this
-      when :RFCTYPE_STRING
-        return read_string(metadata)
-      when :RFCTYPE_XSTRING
-        size = FFI::MemoryPointer.new(:uint)
-        rc = NWRFCLib.get_string_length(@handle, metadata[:name].cU, size, @error)
-        NWRFC.check_error(@error) if rc > 0
-        buf_len = size.read_uint
-        sbuf = FFI::MemoryPointer.new :uchar, buf_len
-        rc = NWRFCLib.get_x_string(@handle, metadata[:name].cU, sbuf, buf_len, size, @error)
-        NWRFC.check_error(@error) if rc > 0
-        return sbuf.read_string(sbuf.size)
-      else
-        raise "Illegal member type #{metadata[:type]}"
+
+        when :RFCTYPE_BCD
+          size = metadata[:nucLength] + (metadata[:decimals] || 0)
+          buf = FFI::MemoryPointer.new(:uchar, size*2)
+          rc = NWRFCLib.get_chars(@handle, metadata[:name].cU, buf, size, @error.to_ptr)
+          NWRFC.check_error(@error) if rc > 0
+          return buf.get_bytes(0, size*2).uC.to_f
+        #size = metadata[:ucLength]
+        #cb = FFI::MemoryPointer.new :char, size * 2
+        #rc = NWRFCLib.get_chars(@handle, metadata[:name].cU, cb, size * 2, @error.to_ptr)
+        #NWRFC.check_error(@error) if rc > 0
+        #cb.read_string(size).uC
+
+        when :RFCTYPE_TIME
+          # TODO: See whether we can optimize this
+          timec = read_chars(metadata)
+          return Time.parse("#{timec[0..1]}:#{timec[2..3]}:#{timec[4..5]}")
+
+        when :RFCTYPE_BYTE
+          size = metadata[:ucLength]
+          buf = FFI::MemoryPointer.new(:uchar, size)
+          rc = NWRFCLib.get_bytes(@handle, metadata[:name].cU, buf, size, @error.to_ptr)
+          NWRFC.check_error(@error) if rc > 0
+          return buf.get_bytes(0, size)
+
+        when :RFCTYPE_TABLE
+          # TODO Cache instances of table members and return those where available
+          new_handle = NWRFCLib::RFCDataContainer.new
+          rc = NWRFCLib.get_table(@handle, member.cU, new_handle.to_ptr, @error.to_ptr)
+          NWRFC.check_error(@error) if rc > 0
+          # CAVEAT: Other calls using the handle require "handle" field
+          # of the RFC_DATA_CONTAINER struct for some reason.
+          new_handle = new_handle[:handle]
+          return Table.new(new_handle)
+
+        when :RFCTYPE_NUM
+          return read_chars(metadata)
+
+        when :RFCTYPE_FLOAT
+          double = FFI::MemoryPointer.new :double
+          rc = NWRFCLib.get_float(@handle, member.cU, double, @error)
+          NWRFC.check_error(@error) if rc > 0
+          return double.get_double(0)
+
+        when :RFCTYPE_INT
+          int = FFI::MemoryPointer.new :int
+          rc = NWRFCLib.get_int(@handle, member.cU, int, @error)
+          NWRFC.check_error(@error) if rc > 0
+          return int.get_int(0)
+
+        when :RFCTYPE_INT2
+          short = FFI::MemoryPointer.new :short
+          rc = NWRFCLib.get_int2(@handle, member.cU, short, @error)
+          NWRFC.check_error(@error) if rc > 0
+          return short.get_short(0)
+
+        when :RFCTYPE_INT1
+          int1 = FFI::MemoryPointer.new :uint8
+          rc = NWRFCLib.get_int1(@handle, member.cU, int1, @error)
+          NWRFC.check_error(@error) if rc > 0
+          return int1.get_uint8(0)
+
+        when :RFCTYPE_NULL
+          raise "Unsupported type RFCTYPE_NULL" #You should never run into this
+
+        when :RFCTYPE_STRUCTURE
+          # TODO Cache instances of structure members and return those where available
+          new_handle = NWRFCLib::RFCDataContainer.new
+          rc = NWRFCLib.get_structure(@handle, member.cU, new_handle.to_ptr, @error.to_ptr)
+          NWRFC.check_error(@error) if rc > 0
+          new_handle = new_handle[:handle]
+          return Structure.new(new_handle)
+
+        when :RFCTYPE_DECF16
+          double = FFI::MemoryPointer.new :double
+          rc = NWRFCLib.get_dec_f16(@handle, member.cU, double, @error)
+          NWRFC.check_error(@error) if rc > 0
+          return double.get_double(0)
+
+        when :RFCTYPE_DECF34
+          double = FFI::MemoryPointer.new :double, 2
+          rc = NWRFCLib.get_dec_f34(@handle, member.cU, double, @error)
+          NWRFC.check_error(@error) if rc > 0
+          return double.get_double(0)
+
+        when :RFCTYPE_XMLDATA
+          raise "Unsupported type RFCTYPE_XMLDATA (no longer used)" #You should never run into this
+
+        when :RFCTYPE_STRING
+          return read_string(metadata)
+
+        when :RFCTYPE_XSTRING
+          size = FFI::MemoryPointer.new(:uint)
+          rc = NWRFCLib.get_string_length(@handle, metadata[:name].cU, size, @error)
+          NWRFC.check_error(@error) if rc > 0
+          buf_len = size.read_uint
+          sbuf = FFI::MemoryPointer.new :uchar, buf_len
+          rc = NWRFCLib.get_x_string(@handle, metadata[:name].cU, sbuf, buf_len, size, @error)
+          NWRFC.check_error(@error) if rc > 0
+          return sbuf.read_string(sbuf.size)
+
+        else
+          raise "Illegal member type #{metadata[:type]}"
       end
-      NWRFC.check_error(@error)
-      value
+
     end
 
+    #--
+    # VALUE STORAGE
+    #++
+
+    # Set value on a data container (structure, function instance or table)
     def []=(element, value)
       member = element.to_s.upcase
       metadata = member_metadata(element)
       case metadata[:type]
-      when :RFCTYPE_CHAR
-        NWRFCLib.set_chars(@handle, member.cU, value.cU, value.length, @error.to_ptr)
-      when :RFCTYPE_DATE
-        value = value_to_date(value)
-        NWRFCLib.set_date(@handle, member.cU, value.cU, @error.to_ptr)
-      when :RFCTYPE_BCD
-      when :RFCTYPE_TIME
-        value = value_to_time(value)
-        NWRFCLib.set_time(@handle, member.cU, value.cU, @error.to_ptr)
-      when :RFCTYPE_BYTE
-      when :RFCTYPE_TABLE
-      when :RFCTYPE_NUM
-      when :RFCTYPE_FLOAT
-        NWRFCLib.set_float(@handle, member.cU, value.to_f, @error.to_ptr)
-        #NWRFCLib.set_chars(@handle, member.cU, value.to_s.cU, value.to_s.length, @error.to_ptr)
-      when :RFCTYPE_INT
-        NWRFCLib.set_int(@handle, member.cU, value.to_i, @error.to_ptr)
-      when :RFCTYPE_INT2
-        NWRFCLib.set_int2(@handle, member.cU, value.to_i, @error.to_ptr)
-      when :RFCTYPE_INT1
-        NWRFCLib.set_int1(@handle, member.cU, value.to_i, @error.to_ptr)
-      when :RFCTYPE_NULL
-        raise "Unsupported type RFCTYPE_NULL" #You should never run into this
-      when :RFCTYPE_STRUCTURE
-      when :RFCTYPE_DECF16
-        raise "#{@members[:type]}: decfloat16 not supported yet"
-        double = NWRFCLib::RFC_DECF16.new #FFI::MemoryPointer.new :double
-        double[:align] = value.to_f
-        #double.put_double(0, value.to_f)
-        #double = FFI::Pointer.new 4
-        NWRFCLib.set_dec_f16(@handle, member.cU, double.pointer, @error)
-      when :RFCTYPE_DECF34
-        raise "#{@members[:type]}: decfloat34 not supported yet"
-        #        double = FFI::MemoryPointer.new :double, 2
-        #        double.put_double(0, value.to_f)
-        double = NWRFCLib::RFC_DECF34.new #FFI::MemoryPointer.new :double
-        double[:align] = value.to_f
-        NWRFCLib.set_dec_f34(@handle, member.cU, double, @error)
-      when :RFCTYPE_XMLDATA
-        raise "Unsupported type RFCTYPE_XMLDATA (no longer used)" #You should never run into this
-      when :RFCTYPE_STRING
-      when :RFCTYPE_XSTRING
-        m = FFI::MemoryPointer.new value.size
-        m.put_bytes 0, value
-        NWRFCLib.set_x_string(@handle, member.cU, m, value.size, @error)
-      else
-        raise "Illegal member type #{@members[:type]}"
+
+        when :RFCTYPE_CHAR
+          value = value.to_s
+          NWRFCLib.set_chars(@handle, member.cU, value.cU, value.length, @error.to_ptr)
+
+        when :RFCTYPE_DATE
+          value = value_to_date(value)
+          NWRFCLib.set_date(@handle, member.cU, value.cU, @error.to_ptr)
+
+        when :RFCTYPE_BCD
+          stval = value.to_s.cU
+          m = FFI::MemoryPointer.from_string stval
+          NWRFCLib.set_string(@handle, member.cU, m, value.to_s.size, @error)
+
+        when :RFCTYPE_TIME
+          value = value_to_time(value)
+          NWRFCLib.set_time(@handle, member.cU, value.cU, @error.to_ptr)
+
+        when :RFCTYPE_BYTE
+          m = FFI::MemoryPointer.from_string value.to_s
+          NWRFCLib.set_bytes(@handle, member.cU, m, value.to_s.size, @error.to_ptr)
+
+        when :RFCTYPE_TABLE
+          raise "Value must be of type table" unless value.class == NWRFC::Table
+          NWRFCLib.set_table(@handle, member.cU, value.handle, @error)
+
+        when :RFCTYPE_NUM
+          value = value.to_s
+          NWRFCLib.set_num(@handle, member.cU, value.cU, value.length, @error.to_ptr)
+
+        when :RFCTYPE_FLOAT
+          NWRFCLib.set_float(@handle, member.cU, value.to_f, @error.to_ptr)
+
+        when :RFCTYPE_INT
+          NWRFCLib.set_int(@handle, member.cU, value.to_i, @error.to_ptr)
+
+        when :RFCTYPE_INT2
+          NWRFCLib.set_int2(@handle, member.cU, value.to_i, @error.to_ptr)
+
+        when :RFCTYPE_INT1
+          NWRFCLib.set_int1(@handle, member.cU, value.to_i, @error.to_ptr)
+
+        when :RFCTYPE_NULL
+          raise "Unsupported type RFCTYPE_NULL" #You should never run into this
+
+        when :RFCTYPE_STRUCTURE
+          raise "Value must be of type table" unless value.class == NWRFC::Structure
+          NWRFCLib.set_structure(@handle, member.cU, value.handle, @error)
+
+        when :RFCTYPE_DECF16
+          raise "#{@members[:type]}: decfloat16 not supported yet"
+          double = NWRFCLib::RFC_DECF16.new #FFI::MemoryPointer.new :double
+          double[:align] = value.to_f
+                                            #double.put_double(0, value.to_f)
+                                            #double = FFI::Pointer.new 4
+          NWRFCLib.set_dec_f16(@handle, member.cU, double.pointer, @error)
+
+        when :RFCTYPE_DECF34
+          raise "#{@members[:type]}: decfloat34 not supported yet"
+          #        double = FFI::MemoryPointer.new :double, 2
+          #        double.put_double(0, value.to_f)
+          double = NWRFCLib::RFC_DECF34.new #FFI::MemoryPointer.new :double
+          double[:align] = value.to_f
+          NWRFCLib.set_dec_f34(@handle, member.cU, double, @error)
+
+        when :RFCTYPE_XMLDATA
+          raise "Unsupported type RFCTYPE_XMLDATA (no longer used)" #You should never run into this
+
+        when :RFCTYPE_STRING
+          stval = value.cU
+          m = FFI::MemoryPointer.from_string stval
+          NWRFCLib.set_string(@handle, member.cU, m, value.size, @error)
+
+        when :RFCTYPE_XSTRING
+          m = FFI::MemoryPointer.new value.size
+          m.put_bytes 0, value
+          NWRFCLib.set_x_string(@handle, member.cU, m, value.size, @error)
+
+        else
+          raise "Illegal member type #{@members[:type]}"
       end
       NWRFC.check_error(@error)
     end
 
-    def value_to_time(value)
-      return value.strftime(NW_TIME_FORMAT) if value.respond_to? :strftime
-      value.to_s
-    end
-
+    # Return value as a SAP-formatted date ("YYYYMMDD"). Force value to fit into 8 chars by
+    # truncating or padding with spaces
     def value_to_date(value)
       return value.strftime(NW_DATE_FORMAT) if value.respond_to? :strftime
       # Force the resulting string into 8 characters otherwise
@@ -172,6 +240,8 @@ module NWRFC
       value
     end
 
+    # Return value as a SAP-formatted time ("HHMMSS"). Force value to fit into 6 chars by
+    # truncating or padding with spaces
     def value_to_time(value)
       return value.strftime(NW_TIME_FORMAT) if value.respond_to? :strftime
       # Force the resulting string into 6 characters otherwise
@@ -183,6 +253,7 @@ module NWRFC
 
     # Get the metadata of a member (function, structure or table)
     def member_metadata(member_name)
+      # TODO: Cache metadata definitions; will it be quicker than making a hash of metadata for a given member each time?
       member = member_name.to_s.upcase
       if self.class == NWRFC::FunctionCall
         fpar = NWRFCLib::RFCFuncParam.new
@@ -202,12 +273,12 @@ module NWRFC
     # and a type field
     def member_to_hash(member)
       {
-        :name => member[:name].get_str,
-        :type => NWRFCLib::RFC_TYPE[member[:type]],
-        :nucLength => member[:nucLength],
-        :ucLength => member[:ucLength],
-        :decimals => member[:decimals],
-        :typeDescHandle => member[:typeDescHandle]
+          :name => member[:name].get_str,
+          :type => NWRFCLib::RFC_TYPE[member[:type]],
+          :nucLength => member[:nucLength],
+          :ucLength => member[:ucLength],
+          :decimals => member[:decimals],
+          :typeDescHandle => member[:typeDescHandle]
       }
     end
 

data/lib/nwrfc/nwerror.rb

@@ -0,0 +1,25 @@
+module NWRFC
+  
+  class NWError < Exception
+
+    attr_reader :code, :group, :message, :class, :type, :number
+
+    # Instantiate Error object with a handle to an FFI::MemoryPointer
+    # to an NWRFCLib::RFCError object. The error object is analyzed so that
+    # when the caller intercepts it with Rescue, all the error details are
+    # available
+    def initialize(error)
+      @code =    NWRFCLib::RFC_RC[error[:code]]
+      @group =   NWRFCLib::RFC_ERROR_GROUP[error[:group]]
+      @message = error[:message].get_str
+      @type =    error[:abapMsgType].get_str
+      @number =  error[:abapMsgNumber].get_str
+    end
+
+    def inspect
+      "#{@message} (code #{@code}, group #{@group}, type #{@type}, number #{@number})"
+    end
+
+  end
+
+end

data/lib/nwrfc/nwrfclib.rb

@@ -143,12 +143,16 @@ module NWRFCLib
     :RFCTYPE_INT2   , 9,
     :RFCTYPE_INT1   , 10,
     :RFCTYPE_NULL  , 14,
+    :RFCTYPE_ABAPOBJECT, 16,
     :RFCTYPE_STRUCTURE , 17,
     :RFCTYPE_DECF16  , 23,
     :RFCTYPE_DECF34  , 24,
     :RFCTYPE_XMLDATA , 28,
     :RFCTYPE_STRING , 29,
-    :RFCTYPE_XSTRING , 30
+    :RFCTYPE_XSTRING , 30,
+    :RFCTYPE_BOX, 31,
+    :RFCTYPE_GENERIC_BOX, 32,
+    :_RFCTYPE_max_value
   )
 
   # Connection parameter wrapper (struct RFC_CONNECTION_PARAMETER in sapnwrfc.h)
@@ -267,6 +271,10 @@ module NWRFCLib
   # yet used in our NWRFC library, so calling them may not work. For best results, consult sapnwrfc.h from
   # the SDK
   #############################################################################################################
+  # Callback for function server (function implementation)
+  callback :funcimpl, [:pointer, :pointer, :pointer], :int
+
+  # Function mappings
   [
     [:add_exception, :RfcAddException, [:pointer, :pointer, :pointer], :int],
     [:add_function_desc, :RfcAddFunctionDesc, [:pointer, :pointer, :pointer], :int],
@@ -343,7 +351,7 @@ module NWRFCLib
     [:insert_new_row, :RfcInsertNewRow, [:pointer, :pointer], :pointer],
     [:insert_row, :RfcInsertRow, [:pointer, :pointer, :pointer], :int],
     [:install_generic_server_function, :RfcInstallGenericServerFunction, [:pointer, :pointer, :pointer], :int],
-    [:install_server_function, :RfcInstallServerFunction, [:pointer, :pointer, :pointer, :pointer], :int],
+    [:install_server_function, :RfcInstallServerFunction, [:pointer, :pointer, :funcimpl, :pointer], :int],
     [:install_transaction_handlers, :RfcInstallTransactionHandlers, [:pointer, :pointer, :pointer, :pointer, :pointer, :pointer], :int],
     [:invoke, :RfcInvoke, [:pointer, :pointer, :pointer], :int],
     [:invoke_in_transaction, :RfcInvokeInTransaction, [:pointer, :pointer, :pointer], :int],

data/lib/nwrfc/server.rb

@@ -0,0 +1,36 @@
+module NWRFC
+
+  # Implementation of a server to host RFC functions to be called from an ABAP system
+  # or from another RFC implementation
+  class Server
+
+    TIMEOUT = 200
+
+    # Register a server with the given gateway and program ID
+    def initialize(params)
+      raise "Rarameters must be a Hash" unless params.instance_of? Hash
+      @rparams = NWRFC.make_conn_params(params)
+      raise "Could not create valid pointer from parameters" unless @rparams.instance_of? FFI::MemoryPointer
+      @error =  NWRFCLib::RFCError.new
+      @handle = NWRFCLib.register_server(@rparams, params.size, @error)
+      NWRFC.check_error(@error)
+    end
+
+    def serve(function, &block)
+      # Establish callback handler
+      callback = Proc.new do |connection, function_call, error|
+        fc = 
+        debugger
+        yield(function_call)
+      end
+      rc = NWRFCLib.install_server_function(nil, function.desc, callback, @error)
+      NWRFC.check_error(@error) if rc > 0
+      # Server loop
+      while (rc==NWRFCLib::RFC_RC[:RFC_OK] || rc==NWRFCLib::RFC_RC[:RFC_RETRY] || rc==NWRFCLib::RFC_RC[:RFC_ABAP_EXCEPTION])
+        rc = NWRFCLib.listen_and_dispatch(@handle, TIMEOUT, @error)
+      end
+    end
+
+  end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nwrfc
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Martin Ceronio
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-20 00:00:00 Z
+date: 2012-02-22 00:00:00 Z
 dependencies: []
 
 description: SAP Netweaver RFC Library Wrapper using Ruby-FFI
@@ -30,10 +30,10 @@ files:
 - README.rdoc
 - Rakefile
 - lib/nwrfc.rb
+- lib/nwrfc/server.rb
 - lib/nwrfc/datacontainer.rb
+- lib/nwrfc/nwerror.rb
 - lib/nwrfc/nwrfclib.rb
-- lib/nwrfc/dev_rfc.trc
-- lib/dev_rfc.trc
 homepage: http://rubygems.org/gems/nwrfc
 licenses: []
 

data/lib/dev_rfc.trc

@@ -1,140 +0,0 @@
-
-**** Trace file opened at 2012-02-15, 13:50:29 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 13:51:02 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 14:07:53 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 14:08:23 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 14:09:49 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 14:40:33 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb1
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 14:42:34 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 14:50:05 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 15:19:16 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 15:19:42 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 15:20:37 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 15:21:59 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 15:23:05 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 15:25:42 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 15:26:25 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 22:23:25 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 22:23:59 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 22:27:38 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-15, 22:28:08 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-17, 12:38:41 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated

data/lib/nwrfc/dev_rfc.trc

@@ -1,28 +0,0 @@
-
-**** Trace file opened at 2012-02-17, 14:29:25 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib/nwrfc, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-17, 14:35:20 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib/nwrfc, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-17, 14:50:20 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib/nwrfc, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated
-
-**** Trace file opened at 2012-02-17, 15:04:13 SAST
- RFC library: 720, Current working directory: /home/martin/Development/ruby/sapnwrfc/lib/nwrfc, Program: irb
- Hardware: Intel x86 with Linux i686, Operating_system: Linux 3.0.0-14-generic-pae, Kernel_release: 720 patchlevel 2
- Hostname: martin-laptop, IP address: 127.0.1.1, IP address_v6: 127.0.1.1
-
-ERROR pfuuid_init returns error -> UUIDs cannot be generated