rnsap 0.4.2 → 0.4.10

data/lib/rnsap.rb

@@ -2,22 +2,20 @@
 
 require 'nwrfc'
 require 'read_table/table_column'
-require 'preq_detail/preq_item'
-require 'preq_detail/preq_acct_assignment'
-require 'preq_detail/preq_text'
-require 'preq_detail/preq_limits'
-require 'preq_detail/preq_contract_limits'
-require 'preq_detail/preq_services'
-require 'preq_detail/preq_services_texts'
-require 'preq_detail/preq_srv_accass_values'
-require 'preq_release_info/preq_gen_release_info'
-require 'preq_release_info/preq_release_prerequisites'
-require 'preq_release_info/preq_release_posted'
-require 'preq_release_info/preq_release_final'
+
 require 'return'
+
+require 'preq_detail/all'
+require 'preq_release_info/all'
+
+require 'po_detail/all'
+require 'po_release_info/all'
+
 require 'helper/rfc_helper'
+require 'helper/util_helper'
 
 include NWRFC
+include UtilHelper
 
 # Module for SAP helper methods. RnSap allows for a simpler
 # manner to access SAP servers calling RFC BAPIs.
@@ -33,6 +31,9 @@ module RnSap
     # keeps the SAP connection alive during the Sap instance lifecycle
     attr_reader :conn
 
+    INT_TYPES ||= ['b','N']
+    FLOAT_TYPES ||= ['P']
+    DATE_TYPES ||=['D']
     # Constructor requires to receive connection parameters,
     # a hash containint necessary information to logon to SAP
     # @param conn_parms [Hash] SAP Connection Parameters
@@ -45,36 +46,26 @@ module RnSap
       conn.disconnect
     end
 
-    def commit()
+    def commit(conn)
+
       #-- Execute BAPI_TRANSACTION_COMMIT
-      fn_commit = @conn.get_function('BAPI_REQUISITION_RELEASE')
+      fn_commit = conn.get_function('BAPI_TRANSACTION_COMMIT')
       fn_commit = fn_commit.get_function_call
-      fn_commit[:NUMBER] = preq
-      fn_commit[:REL_CODE] = rel_code
-      fn_commit[:ITEM] = item
-      fn_commit[:USE_EXCEPTIONS] = use_exeptions
-      fn_commit[:NO_COMMIT_WORK] = no_commit
+      fn_commit[:WAIT] = 'X'
+
       fn_commit.invoke
-      tb_return = get_object_list(fn_commit[:RETURN], Return.to_s)
-      {
-        tb_return: tb_return,
-      }
+
+      api_return_success({tb_return: fn_commit[:RETURN]})
     end
     
-    def rollback()
+    def rollback(conn)
       #-- Execute BAPI_TRANSACTION_ROLLBACK
-      fn_rollback = @conn.get_function('BAPI_REQUISITION_RELEASE')
+      fn_rollback = conn.get_function('BAPI_TRANSACTION_ROLLBACK')
       fn_rollback = fn_rollback.get_function_call
-      fn_rollback[:NUMBER] = preq
-      fn_rollback[:REL_CODE] = rel_code
-      fn_rollback[:ITEM] = item
-      fn_rollback[:USE_EXCEPTIONS] = use_exeptions
-      fn_rollback[:NO_COMMIT_WORK] = no_commit
+
       fn_rollback.invoke
-      tb_return = get_object_list(fn_rollback[:RETURN], Return.to_s)
-      {
-        tb_return: tb_return,
-      }      
+
+      api_return_success({tb_return: fn_rollback[:RETURN]})
     end
 
     # Invokes SAP RFC_READ_TABLE function module remotely, passing
@@ -154,13 +145,38 @@ module RnSap
       end
 
       list = []
+
       fc_read_table[:DATA].each do |row|
         obj = base_obj.class.new
-        wa = row[:WA]
+        wa = row[:WA].split('|')
+        pos = -1
         fields_down.each do |field|
+          pos = pos + 1
           column = columns_hash[field.upcase]
-          value = wa[column.offset.to_i, column.length.to_i]
-          eval("obj.#{field} = '#{value.strip}'")
+          # value = wa[column.offset.to_i, column.length.to_i]
+          if INT_TYPES.include?(column.type)
+            value = wa[pos].to_i
+            eval("obj.#{field} = #{value}")
+          elsif FLOAT_TYPES.include?(column.type)
+            value = wa[pos].to_f
+            eval("obj.#{field} = #{value}")
+          elsif DATE_TYPES.include?(column.type)
+            value = wa[pos].strip
+            if value == '00000000'
+              eval("obj.#{field} = nil")
+            else
+              value = Date.new(
+                value[0..3], 
+                value[4..5], 
+                value[6..7]
+              )
+              eval("obj.#{field} = #{value}")
+            end            
+          else
+            value = wa[pos].strip
+            eval("obj.#{field} = '#{value}'")
+          end
+
         end
         list << obj
       end
@@ -182,27 +198,34 @@ module RnSap
       fc_preq_detail.invoke
 
       #-- Execute conversions for returned tables to a designated list (array)
-      preq_items = get_object_list(fc_preq_detail[:REQUISITION_ITEMS], PreqItem.to_s)
-      preq_acct_assignment = get_object_list(fc_preq_detail[:REQUISITION_ACCOUNT_ASSIGNMENT], PreqAcctAssignment.to_s)
-      preq_text = get_object_list(fc_preq_detail[:REQUISITION_TEXT], PreqText.to_s)
-      preq_limits = get_object_list(fc_preq_detail[:REQUISITION_LIMITS], PreqLimits.to_s)
-      preq_contract_limits = get_object_list(fc_preq_detail[:REQUISITION_CONTRACT_LIMITS], PreqContractLimits.to_s)
-      preq_services = get_object_list(fc_preq_detail[:REQUISITION_SERVICES], PreqItem.to_s)
-      preq_services_texts = get_object_list(fc_preq_detail[:REQUISITION_SERVICES_TEXTS], PreqServicesText.to_s)
-      preq_srv_accass_values = get_object_list(fc_preq_detail[:REQUISITION_SRV_ACCASS_VALUES], PreqServicesAccassValues.to_s)
-      tb_return = get_object_list(fc_preq_detail[:RETURN], Return.to_s)
-
-      {
-        preq_items: preq_items,
-        preq_acct_assignment: preq_acct_assignment,
-        preq_text: preq_text,
-        preq_limits: preq_limits,
-        preq_contract_limits: preq_contract_limits,
-        preq_services: preq_services,
-        preq_services_texts: preq_services_texts,
-        preq_srv_accass_values: preq_srv_accass_values,
-        tb_return: tb_return,
-      }
+      preq_items = get_object_list(fc_preq_detail[:REQUISITION_ITEMS], PreqItem)
+      preq_acct_assignment = get_object_list(fc_preq_detail[:REQUISITION_ACCOUNT_ASSIGNMENT], PreqAcctAssignment)
+      preq_text = get_object_list(fc_preq_detail[:REQUISITION_TEXT], PreqText)
+      preq_limits = get_object_list(fc_preq_detail[:REQUISITION_LIMITS], PreqLimits)
+      preq_contract_limits = get_object_list(fc_preq_detail[:REQUISITION_CONTRACT_LIMITS], PreqContractLimits)
+      preq_services = get_object_list(fc_preq_detail[:REQUISITION_SERVICES], PreqItem)
+      preq_services_texts = get_object_list(fc_preq_detail[:REQUISITION_SERVICES_TEXTS], PreqServicesText)
+      preq_srv_accass_values = get_object_list(fc_preq_detail[:REQUISITION_SRV_ACCASS_VALUES], PreqServicesAccassValues)
+      tb_return = get_object_list(fc_preq_detail[:RETURN], Return)
+
+      retcode = tb_return.detect{|r| r.type == 'E'} 
+
+      if retcode
+        api_return_error(retcode)
+      else
+        api_return_success({
+          preq_items: preq_items,
+          preq_acct_assignment: preq_acct_assignment,
+          preq_text: preq_text,
+          preq_limits: preq_limits,
+          preq_contract_limits: preq_contract_limits,
+          preq_services: preq_services,
+          preq_services_texts: preq_services_texts,
+          preq_srv_accass_values: preq_srv_accass_values,
+          tb_return: tb_return,
+        })
+      end
+      
     end
 
     def preq_release_strategy_info(preq = 0, item = "00000", rel_code = "")
@@ -217,50 +240,214 @@ module RnSap
       fn_preq_rel_strat_info.invoke
 
       #-- Execute conversions for returned tables to a designated list (array)
-      preq_gen_release_info = get_object_list(fn_preq_rel_strat_info[:GENERAL_RELEASE_INFO], PreqGenReleaseInfo.to_s)
-      preq_release_prerequisites = get_object_list(fn_preq_rel_strat_info[:RELEASE_PREREQUISITES], PreqReleasePrerequisites.to_s)
-      preq_release_posted = get_object_list(fn_preq_rel_strat_info[:RELEASE_ALREADY_POSTED], PreqReleasePosted.to_s)
-      preq_release_final = get_object_list(fn_preq_rel_strat_info[:RELEASE_FINAL], PreqReleaseFinal.to_s)
-      tb_return = get_object_list(fn_preq_rel_strat_info[:RETURN], Return.to_s)
-
-      {
-        preq_gen_release_info: preq_gen_release_info,
-        preq_release_prerequisites: preq_release_prerequisites,
-        preq_release_posted: preq_release_posted,
-        preq_release_final: preq_release_final,
-        tb_return: tb_return,
-      }
+      preq_gen_release_info = get_object_list(fn_preq_rel_strat_info[:GENERAL_RELEASE_INFO], PreqGenReleaseInfo)
+      preq_release_prerequisites = get_object_list(fn_preq_rel_strat_info[:RELEASE_PREREQUISITES], PreqReleasePrerequisites)
+      preq_release_posted = get_object_list(fn_preq_rel_strat_info[:RELEASE_ALREADY_POSTED], PreqReleasePosted)
+      preq_release_final = get_object_list(fn_preq_rel_strat_info[:RELEASE_FINAL], PreqReleaseFinal)
+      tb_return = get_object_list(fn_preq_rel_strat_info[:RETURN], Return)
 
+      retcode = tb_return.detect{|r| r.type == 'E'} 
+
+      if retcode
+        api_return_error(retcode)
+      else
+        api_return_success({
+          preq_gen_release_info: preq_gen_release_info,
+          preq_release_prerequisites: preq_release_prerequisites,
+          preq_release_posted: preq_release_posted,
+          preq_release_final: preq_release_final,
+          tb_return: tb_return,
+        })
+      end
     end
 
-    def preq_release(preq = 0, rel_code = "", no_commit="", item="0000", use_exeptions="X")
+    def preq_release(preq = 0, rel_code = "", no_commit="", item="00000", use_exceptions="")
       #Validate if will release by item ou general
-      if item = "0000" or item = nil or item.empty?
+      if item == "00000" or item == nil or item.empty?
         #-- Execute BAPI_REQUISITION_RELEASE_GEN
         fn_preq_exec_release = @conn.get_function('BAPI_REQUISITION_RELEASE_GEN')
+        fn_preq_exec_release = fn_preq_exec_release.get_function_call
       else
         #-- Execute BAPI_REQUISITION_RELEASE
         fn_preq_exec_release = @conn.get_function('BAPI_REQUISITION_RELEASE')
+        fn_preq_exec_release = fn_preq_exec_release.get_function_call
         fn_preq_exec_release[:ITEM] = item
-        fn_preq_exec_release[:USE_EXCEPTIONS] = use_exeptions
+        fn_preq_exec_release[:USE_EXCEPTIONS] = use_exceptions
       end
-      fn_preq_exec_release = fn_preq_exec_release.get_function_call
+
       fn_preq_exec_release[:NUMBER] = preq
       fn_preq_exec_release[:REL_CODE] = rel_code
       fn_preq_exec_release[:NO_COMMIT_WORK] = no_commit
+
       fn_preq_exec_release.invoke
-      tb_return = get_object_list(fn_preq_exec_release[:RETURN], Return.to_s)
-      {
-        tb_return: tb_return,
-      }      
+
+      tb_return = get_object_list(fn_preq_exec_release[:RETURN], Return)
+
+      retcode = tb_return.detect{|r| r.type == 'E'} 
+
+      if retcode
+        api_return_error(retcode)
+      else
+        api_return_success({
+          status_new: fn_preq_exec_release[:REL_STATUS_NEW],
+          indicator_new: fn_preq_exec_release[:REL_INDICATOR_NEW],
+          tb_return: tb_return,
+        })
+      end
+    end
+
+    def po_detail(po = 0, acc_assignment = "", item_text = "", header_text = "", delivery_address = "", version = "", services = "", serialnumbers = "", invoiceplan = "")
+      #-- Execute BAPI_PO_GETDETAIL1
+      fn_po_detail = @conn.get_function('BAPI_PO_GETDETAIL1')
+      fc_po_detail = fn_po_detail.get_function_call
+      
+      fc_po_detail[:PURCHASEORDER] = po
+      fc_po_detail[:ACCOUNT_ASSIGNMENT] = acc_assignment 
+      fc_po_detail[:ITEM_TEXT] = item_text
+      fc_po_detail[:HEADER_TEXT] =  header_text
+      fc_po_detail[:DELIVERY_ADDRESS] = delivery_address
+      fc_po_detail[:VERSION] = version
+      fc_po_detail[:SERVICES] = services
+      fc_po_detail[:SERIALNUMBERS] = serialnumbers
+      fc_po_detail[:INVOICEPLAN] = invoiceplan
+      
+      fc_po_detail.invoke
+
+      #-- Execute conversions for returned tables to a designated list (array)
+      po_item =  get_object_list(fc_po_detail[:POITEM], PoItem)
+      po_addrdelivery =  get_object_list(fc_po_detail[:POADDRDELIVERY], PoAddrDelivery)
+      po_schedule =  get_object_list(fc_po_detail[:POSCHEDULE], PoSchedule)
+      po_account =  get_object_list(fc_po_detail[:POACCOUNT], PoAccount)
+      po_cond_header =  get_object_list(fc_po_detail[:POCONDHEADER], PoCondHeader)
+      po_cond =  get_object_list(fc_po_detail[:POCOND], PoCond)
+      po_limits =  get_object_list(fc_po_detail[:POLIMITS], PoLimits)
+      po_contract_limits =  get_object_list(fc_po_detail[:POCONTRACTLIMITS], PoContractLimits)
+      po_services =  get_object_list(fc_po_detail[:POSERVICES], PoServices)
+      po_srv_access_values =  get_object_list(fc_po_detail[:POSRVACCESSVALUES], PoSrvAccessValues)
+      po_text_header =  get_object_list(fc_po_detail[:POTEXTHEADER], PoTextHeader)
+      po_text_item =  get_object_list(fc_po_detail[:POTEXTITEM], PoTextItem)
+      po_exp_imp_item =  get_object_list(fc_po_detail[:POEXPIMPITEM], PoExpImpItem)
+      po_components =  get_object_list(fc_po_detail[:POCOMPONENTS], PoComponents)
+      po_shipping_exp =  get_object_list(fc_po_detail[:POSHIPPINGEXP], PoShippingExp)
+      po_history =  get_object_list(fc_po_detail[:POHISTORY], PoHistory)
+      po_history_totals =  get_object_list(fc_po_detail[:POHISTORY_TOTALS], PoHistoryTotals)
+      po_confirmation =  get_object_list(fc_po_detail[:POCONFIRMATION], PoConfirmation)
+      po_all_versions =  get_object_list(fc_po_detail[:ALLVERSIONS], PoAllVersions)
+      po_partner =  get_object_list(fc_po_detail[:POPARTNER], PoPartner)
+      po_extension_out =  get_object_list(fc_po_detail[:EXTENSIONOUT], PoExtensionOut)
+      po_serial_number =  get_object_list(fc_po_detail[:SERIALNUMBER], PoSerialNumber)
+      po_inv_plan_header =  get_object_list(fc_po_detail[:INVPLANHEADER], PoInvPlanHeader)
+      po_inv_plan_item =  get_object_list(fc_po_detail[:INVPLANITEM], PoInvPlanItem)
+      po_history_ma =  get_object_list(fc_po_detail[:POHISTORY_MA], PoHistoryMa)
+      po_header =  get_object(fc_po_detail[:POHEADER], PoHeader)
+      po_exp_imp_header =  get_object(fc_po_detail[:POEXPIMPHEADER], PoExpImpHeader)
+      tb_return = get_object_list(fc_po_detail[:RETURN], Return)
+      
+      retcode = tb_return.detect{|r| r.type == 'E'} 
+
+      if retcode
+        api_return_error(retcode)
+      else
+        api_return_success({
+          po_item: po_item,
+          po_addrdelivery: po_addrdelivery,
+          po_schedule: po_schedule,
+          po_account: po_account,
+          po_cond_header: po_cond_header,
+          po_cond: po_cond,
+          po_limits: po_limits,
+          po_contract_limits: po_contract_limits,
+          po_services: po_services,
+          po_srv_access_values: po_srv_access_values,
+          po_text_header: po_text_header,
+          po_text_item: po_text_item,
+          po_exp_imp_item: po_exp_imp_item,
+          po_components: po_components,
+          po_shipping_exp: po_shipping_exp,
+          po_history: po_history,
+          po_history_totals: po_history_totals,
+          po_confirmation: po_confirmation,
+          po_all_versions: po_all_versions,
+          po_partner: po_partner,
+          po_extension_out: po_extension_out,
+          po_serial_number: po_serial_number,
+          po_inv_plan_header: po_inv_plan_header,
+          po_inv_plan_item: po_inv_plan_item,
+          po_history_ma: po_history_ma,
+          po_header: po_header,
+          po_exp_imp_header: po_exp_imp_header,
+          tb_return: tb_return,
+        })
+      end
+    end
+
+    def po_release_strategy_info(po = 0, po_rel_code = "")
+      #-- Execute BAPI_PO_GETRELINFO
+      fn_po_rel_strat_info = @conn.get_function('BAPI_PO_GETRELINFO')
+      fc_po_rel_strat_info = fn_po_rel_strat_info.get_function_call
+      
+      fc_po_rel_strat_info[:PURCHASEORDER] = po
+      fc_po_rel_strat_info[:PO_REL_CODE] = po_rel_code
+      
+      fc_po_rel_strat_info.invoke
+
+      #-- Execute conversions for returned tables to a designated list (array)
+      po_release_final =  get_object_list(fc_po_rel_strat_info[:RELEASE_FINAL], PoReleaseFinal.to_s)
+      tb_return = get_object_list(fc_po_rel_strat_info[:RETURN], Return.to_s)
+
+      retcode = tb_return.detect{|r| r.type == 'E'} 
+
+      if retcode
+        api_return_error(retcode)
+      else
+        api_return_success({
+          po_release_final: po_release_final,
+          tb_return: tb_return,
+        })
+      end
+    end
+
+    # Performs SAP Authority check on a certain authorization
+    # object. For more details on SAP authorization, 
+    # this link will provide good details:
+    # * https://www.sdn.sap.com/irj/scn/index?rid=/library/uuid/a92195a9-0b01-0010-909c-f330ea4a585c&overridelayout=true
+    # * https://blogs.sap.com/2020/11/14/some-important-information-about-sap-authorization-objects/
+    # @param user [String] SAP userid for which authorization will be performed
+    # @param auth_object [String] Authorization object to be checked in SAP
+    # @param field [String] Authorization field checked within the authorization object
+    # @param value [String] Authorization value to be checked. (i.e. 01 for creation, 02 for change, XX for release code)
+    def authority_check(user, auth_object, field, value)
+      #-- Execute AUTHORITY_CHECK
+      function = @conn.get_function('AUTHORITY_CHECK')
+      fun_call = function.get_function_call
+      
+      fun_call[:USER] = user
+      fun_call[:OBJECT] = auth_object
+      fun_call[:FIELD1] = field
+      fun_call[:VALUE1] = value
+
+      begin
+        fun_call.invoke
+      rescue Exception => ex
+        if ex.to_s.include?('USER_IS_AUTHORIZED')
+          api_return(0,'Authorized');
+        else
+          api_return(8,'User is not authorized.')
+        end
+      end
+
+    end
+
+    def api_return_success(obj=nil )
+      UtilHelper.api_return(0, 'Success!', obj)
     end
 
-    def po_detail(po = 0)
-      []
+    def api_return_error(obj={}, exception=nil)
+      UtilHelper.api_return(8, 'Error.', obj, exception)
     end
 
-    def po_release_strategy_info(po = 1)
-      []
+    def api_return(rc=0, message ='', obj=nil, exception=nil )
+      UtilHelper.api_return(rc, message, obj, exception)
     end
 
     private

data/lib/rnsap_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'yaml'
+require_relative '../lib/rnsap'
+require_relative '../lib/preq_detail/preq_item'
+
+describe RnSap::Sap do
+  let(:params) do
+    file = File.expand_path(File.join(File.dirname(__FILE__), '..', 'secrets.yml'))
+    YAML.safe_load(File.read(file))
+  end
+
+  let(:logon_info) do
+    { 'user' => params['user'],
+      'passwd' => params['password'],
+      'trace' => params['trace'],
+      'client' => params['client'],
+      'ashost' => params['ashost'],
+      'sysnr' => params['sysnr'] }
+  end
+
+  let(:test_data) do
+    file = File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_data.yml'))
+    YAML.safe_load(File.read(file))
+  end
+
+  let(:conn) do
+    RnSap::Sap.new(logon_info)
+  end
+
+  context 'Based on connection available parameters' do
+    it 'connects to SAP' do
+      expect(conn).not_to be_nil
+    end
+  end
+
+  context 'Reads table information from SAP' do
+    it 'gets at least one vendor' do
+      list = conn.read_table('lfa1', %w[NAME1 LIFNR LAND1])
+      expect(list.count).to be > 0
+    end
+    it 'gets at least one Raw material' do
+      list = conn.read_table('mara', %w[matnr ernam], ["MTART = 'ROH'"])
+      expect(list.count).to be > 0
+    end
+
+    it 'gets a two Raw materials skipping the first in the database' do
+      list = conn.read_table({ name: 'mara', fields: %w[matnr ernam], clauses: ["MTART = 'ROH'"], row_skip: 1, row_count: 2 })
+      expect(list.count).to eq(2)
+    end
+  end
+
+  context 'Gets information from a Purchase Requisition' do
+    it 'Obtains details from purchase requisition' do
+      pr = test_data['preqs']['number']
+      puts "    -> Pesquisando P.Req: #{pr}"
+      details = conn.preq_detail(pr)
+
+      expect(details).not_to be_nil 
+      expect(details.class).to be(Hash)
+    end
+
+    it 'gets purchase requisition Release Strategy info' do
+      pr = test_data['preqs']['number']
+      details = conn.preq_release_strategy_info(pr)
+
+      expect(details).not_to be_nil 
+      expect(details.class).to be(Hash)
+    end
+  end
+
+  context 'Gets information from a Purchase Order' do
+    it 'Obtains details from purchase requisition' do
+      po = test_data['po']['number']
+      puts "    -> Pesquisando P.Order: #{po}"
+      details = conn.po_detail(po)
+
+      expect(details).not_to be_nil 
+      expect(details.class).to be(Array)
+    end
+
+    it 'gets purchase requisition Release Strategy info' do
+      po = test_data['po']['number']
+      details = conn.po_release_strategy_info(po)
+
+      expect(details).not_to be_nil 
+      expect(details.class).to be(Array)
+    end
+  end
+
+  
+end