rnsap 0.1.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de8d3ecd20abc0e38c20c9377f12df1a84a4b76183bce4ddcadf6f9a7f1dc45e
-  data.tar.gz: f5c211b156e4c3ad98e3498dd04cb4831faa0299a0c0d7d0d3bccec641871290
+  metadata.gz: f44b42cb85ce971b63caafa40e57062a287861ac3dc221f5627d931c9d2792d6
+  data.tar.gz: 5403af8af25304f9de38fecb09f380e7ccd9a9c9bb684ae63f5f080e51d44aab
 SHA512:
-  metadata.gz: 3d3c3c8ef05a04b4d64876b986c9b0b703f52867d0ebca8b2b1f70424b93e9394a64c60d3737dd9886dc91224816cfb97edc74938e60471a466e557afe30ad30
-  data.tar.gz: fc04fed83c93e830527a4b7f298272fbcba0f20f684c94c8f9107324a04f90fb65113c060cc3e7048e576758d83708a31c815122ff4d8fd2b4461fdc928163bb
+  metadata.gz: db5a0dd7f38e5b31dc1136dfda6d6bfba3db5ba8d437fc13711f64a6c6f060aa92148a1e9d996e7612db6dc479c566d9945aab06b782012683b3aa55ca7281ec
+  data.tar.gz: ebcdcf12bae1cad45e498748b444da864b8e3f3de67031ab8431c16caf43454f985f004b11be060ef8f32f3a863119417d950cf44cb9b8d2a23d7c7be9338a57

data/lib/rnsap.rb

@@ -1,22 +1,69 @@
 # frozen_string_literal: true
 
 require 'nwrfc'
-require 'json'
-require 'yaml'
 
 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
 
-    def initialize(_conn_parms)
-      puts 'initialized'
-      @conn = Connection.new(_conn_parms)
-      dump_instance_variables(:conn)
+    # Constructor requires to receive connection parameters,
+    # a hash containint necessary information to logon to SAP
+    # @param conn_parms [Hash] SAP Connection Parameters
+    def initialize(conn_parms)
+      @conn = Connection.new(conn_parms)
     end
 
-    def read_table(name, fields, _clause)
+    # Closes the instance's SAP connection#
+    def close
+      conn.disconnect
+    end
+
+    # 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
+    # ```
+    #
+    # @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]
+        _row_skip = name[:row_skip]
+        _row_count = name[:row_count]
+        name = name[:name]
+      end
       klass_name = name.capitalize
       fields_up = []
       fields_down = []
@@ -24,19 +71,28 @@ module RnSap
         fields_up << field.upcase
         fields_down << field.downcase
       end
+
       base_obj = get_class_instance(klass_name, fields_down)
 
       #-- Read Table
-      dump_instance_variables(conn)
+      # dump_instance_variables(conn)
       fn_read_table = @conn.get_function('RFC_READ_TABLE')
       fc_read_table = fn_read_table.get_function_call
 
       fc_read_table[:QUERY_TABLE] = name.upcase
+      fc_read_table[:ROWSKIPS] = _row_skip
+      fc_read_table[:ROWCOUNT] = _row_count
+      fc_read_table[:DELIMITER] = '|'
       fields_up.each do |field|
         row = fc_read_table[:FIELDS].new_row
         row[:FIELDNAME] = field
       end
 
+      clauses.each do |clause|
+        row = fc_read_table[:OPTIONS].new_row
+        row[:TEXT] = clause
+      end
+
       fc_read_table.invoke
 
       columns_hash = {}
@@ -65,15 +121,45 @@ module RnSap
       list
     end
 
-    # Close connection
-    def close
-      conn.disconnect
+    def preq_detail(preq = 0, acc_assignment = 'X', item_text = 'X', services = 'X', services_texts = 'X')
+      #-- Execute BAPI_REQUISITION_GETDETAIL
+      fn_preq_detail = @conn.get_function('BAPI_REQUISITION_GETDETAIL')
+      fc_preq_detail = fn_preq_detail.get_function_call
+      
+      fc_preq_detail[:NUMBER] = preq
+      fc_preq_detail[:ACCOUNT_ASSIGNMENT] = acc_assignment
+      fc_preq_detail[:ITEM_TEXTS] = item_text
+      fc_preq_detail[:SERVICES] = services
+      fc_preq_detail[:SERVICE_TEXTS] = services_texts
+      
+      fc_preq_detail.invoke
+      
+      list = []
+      avoid_list = ['!','__','+', '=','!', '?','~','>', '<']
+      fc_preq_detail[:REQUISITION_ITEMS].each do |row|
+        preq = PreqItem.new
+        preq.class.instance_methods.each do |method_name|
+          begin
+            if preq.respond_to?("#{method_name}=")
+              unless avoid_list.any? { |word| method_name.to_s.include?(word)}
+                value = row[method_name]
+                eval("preq.#{method_name} = '#{value}'")
+              end
+            end
+          rescue
+          end
+        end
+        list.push(preq)
+      end
+
+      list
     end
 
     private
 
     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|
@@ -81,6 +167,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)
@@ -91,7 +182,4 @@ module RnSap
     end
   end
 
-  class TableColumn
-    attr_accessor :field_name, :offset, :length, :type, :description
-  end
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: rnsap
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.4.0
 platform: ruby
 authors:
 - Rogerio Nascimento
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2020-04-30 00:00:00.000000000 Z
@@ -24,8 +24,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.9
-description: ''
-email: 
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: By encapsulating SAPs NW RFC library calls, Ruby routines can access
+  SAP power in a simpler manner
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -36,7 +51,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/rnasc/rnsap
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Facilitates SAP RFC calls in Ruby
 test_files: []