rnsap 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b08656a22732937af89f8dff31270e6e1be78b64bc54ffc6ebd66e5e2c1f6b8a
-  data.tar.gz: 6ef4877da02494a42b50ad96279b53f7b6a6266cf7a2186b0aa9a53f6d46f59b
+  metadata.gz: 4f007a1ea7e705a5e9d6071a22eda01f95debc6c5f2190df7720c2cc5359022e
+  data.tar.gz: aab89dd84c193006677e4f952e5703cfde3a28babdb6db445fdad3bc29ca316f
 SHA512:
-  metadata.gz: d08e2404802ae98c3d318a77f7a2a97be10dc81a50d0b00309a3f19c0f73f1e6f39f996d9fbe7c917e1fe75960fdb7a64581a2f8364518cbd463aee8ff4c6ca1
-  data.tar.gz: 91031854f317b89ac641010efbd804be84b9a69589aaa3446a3a0b2cb72237d27412530f3dc5222de936fb345a966296a51c7fec89572cd8f8f527cfdbe5a89e
+  metadata.gz: d04e02c23e7fee1f3af3577ede5195c8ba096062d81cd50be1a0c1a60203fffbd5637c24cb167072cbf2e7cf8dec98102485c5f9d339aa298d521e4f2903185a
+  data.tar.gz: 6b6f07b8d353fdfd91db749c67a2b67640d3e8c815a03b648a5ae97f0af720d594299b0d8e5441680a6b4c53a03f02e63fda7e45339685c09f280d82bdb25592

data/lib/rnsap.rb

@@ -4,35 +4,59 @@ require 'nwrfc'
 
 include NWRFC
 
+# Module for SAP helper methods. RnSap allows for a simpler
+# manner to access SAP servers calling RFC BAPIs.
+# @author Rogerio Nascimento
 module RnSap
+  # This is the central class responsible for SAP remote function calls.
+  # Currently the RFC_READ_TABLE BAPI is implemented.
+  #
+  # * TODO
+  #
+  # Implement other SAP BAPIs, such as BAPI_GOODS_MOVEMENT.
   class Sap
+    # keeps the SAP connection alive during the Sap instance lifecycle
     attr_reader :conn
 
     # Constructor requires to receive connection parameters,
     # a hash containint necessary information to logon to SAP
-    def initialize(_conn_parms)
-      @conn = Connection.new(_conn_parms)
+    # @param conn_parms [Hash] SAP Connection Parameters
+    def initialize(conn_parms)
+      @conn = Connection.new(conn_parms)
     end
 
-    # Closes SAP connection
+    # Closes the instance's SAP connection#
     def close
       conn.disconnect
     end
 
-    # def read_table(params = {})
-    #   return [] unless params[:name].present?
-    #   return [] unless params[:fields].present?
-
-    #   name = params[:name]
-    #   fields = params[:fields]
-    #   clauses = params[:clauses].present? ? params[:clauses] : []
-    #   rowskips = params[:row_skip].present? ? params[:row_skip] : 0
-    #   rowcount = params[:row_count].present? ? params[:row_count] : 0
-
-    #   read_table(name, fields, clauses, rowskips, rowcount)
+    # Invokes SAP RFC_READ_TABLE function module remotely, passing
+    # the table to be read and receiving back a list of objects of that
+    # table.
+    #
+    # Example:
+    #
+    # - name: 'lfa1'
+    # - fields: ['name1', 'land1']
+    #
+    # The return will be an array of object <b>Lfa1</b> with the
+    # attributes <b>name1</b> and <b>land1</b>.
+    #
+    # ```ruby
+    # conn = RnSap::Sap.new(conn_parms)
+    # list = conn.read_table('lfa1', ['name1', 'land1'])
+    # list.each do |item|
+    #    puts item.name1
     # end
-
-    def read_table(name = '', fields = [], clauses = [], _row_skip = 0, _row_count = 0)
+    # ```
+    #
+    # @param name [String] Name of SAP table to be read
+    # @param fields [Array] Array of strings containing the table field names to be retrieved
+    # @param clauses [Array] Optional 'where' clauses applicable to the table reading. respects SAP sintax
+    # @param _row_skip [Integer]  number of rows to be skipped within the selected data
+    # @param _row_count [Integer] max number of rows to be returned
+    # @return [Array] Array of the Objects named after the table (i.e. Lfa1, Mara, Bkpf) with its selected columns as attributes (see example)
+    def read_table(name, fields = [], clauses = [], _row_skip = 0, _row_count = 0)
       if name.is_a?(Hash)
         fields = name[:fields]
         clauses = name[:clauses]
@@ -101,6 +125,7 @@ module RnSap
 
     attr_writer :conn
 
+    # Dumps to the output the content of an object
     def dump_instance_variables(obj)
       puts "Class: #{obj.class} -> #{obj}"
       obj.instance_variables.map do |var|
@@ -108,6 +133,11 @@ module RnSap
       end
     end
 
+    # Dynamically returns a class instance with the name 'name' and with each
+    # of its fields as an attribute
+    # @param name [String] name of the intended class instance
+    # @param fields [Array] array of strings containing the list of attributes to be available in the class instance
+    # @return [Object] instance of the object 'Name'
     def get_class_instance(name, fields)
       # puts "Class name: #{name}"
       klass = Object.const_set(name, Class.new).new # , Struct.new(*attributes)
@@ -118,6 +148,8 @@ module RnSap
     end
   end
 
+  # class used to represent a Table Column. Used internally
+  # to map SAP's returned working area (WA) into class instances
   class TableColumn
     attr_accessor :field_name, :offset, :length, :type, :description
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rnsap
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Rogerio Nascimento