rnsap 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a17557c7181bcd65a32fb58814b567f43744c17915ece180710bb3b4ebecfcb
-  data.tar.gz: 185a5c0b02c274c44f47794345ac5b2509463c47a55a68249728568d12175d9d
+  metadata.gz: 5dd7ba84b18711bdaf64bc605af4003b21f41296896cba5ae13681b41244750f
+  data.tar.gz: 51728b725b3aaa900a517425aa0897b25f449fd44f962fa7ce3ab346917d4a53
 SHA512:
-  metadata.gz: a45fa39484dae3cd8ae6a95215cd3de1b820285706df7b2cb7ba11f8537814b4c1e01e6a45d82d9e66511519c2da96f040f9061a2993bb6e5a9cc00f76043d45
-  data.tar.gz: b4bf0e054498ad13c5de3e28efb0e4dd12046f4bec1c8dd6d08cde8baa8d3af0623f3c97c7d283e6f5361ea06bac396495f488bd6c59ad6d3abb3fef35267872
+  metadata.gz: a1de3138f78004c63c9174e5c97441babc5e83efb7e930ec8bdb4986a5768f6f3aca8fefdc762c1548350bb8116cbf532c76370b969ccfad7c963513ecf3b968
+  data.tar.gz: d6fcd634233711dccb18da6ba342c9bf9ddccef11ca50917c31bb39d53767fcfc2b7e41996d7fa41445e07740b371b84a6083cae24cfec5e4d956e37c98f1b92

data/lib/helper/util_helper.rb

@@ -0,0 +1,39 @@
+module UtilHelper
+  require 'JSON'
+
+  def log(msg='no message')
+    puts obj_to_s(msg)
+  end
+  
+  def obj_to_s(msg)
+    case msg.class
+    when Hash
+      JSON.pretty_generate(msg)
+    else
+      begin
+        JSON.pretty_generate(JSON.parse(msg.to_json))
+      rescue 
+        msg
+      end
+    end    
+  end
+
+  # def api_return(*options)
+  #   puts 'options'
+  #   log api_return2(options[1], options[0]) if options[0].class.to_s == 'Integer'
+  #   log(options)
+  # end
+  
+
+  def api_return(rc=0, message ='', obj=nil, exception=nil )
+    ret = {
+      rc: exception ? (rc > 0 ? rc : 8) : rc,
+      message: message
+    }
+    ret[:exception] = exception.to_s if exception
+    ret[:return] = obj if obj
+    ret
+  end
+  
+  
+end

data/lib/rnsap.rb

@@ -16,8 +16,10 @@ require 'preq_release_info/preq_release_posted'
 require 'preq_release_info/preq_release_final'
 require 'return'
 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.
@@ -57,9 +59,7 @@ module RnSap
 
       fn_commit.invoke
 
-      {
-        tb_return: fn_commit[:RETURN],
-      }
+      api_return_success({tb_return: fn_commit[:RETURN]})
     end
     
     def rollback(conn)
@@ -69,9 +69,7 @@ module RnSap
 
       fn_rollback.invoke
 
-      {
-        tb_return: fn_rollback[:RETURN],
-      }      
+      api_return_success({tb_return: fn_rollback[:RETURN]})
     end
 
     # Invokes SAP RFC_READ_TABLE function module remotely, passing
@@ -214,17 +212,24 @@ module RnSap
       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,
-      }
+      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 = "")
@@ -245,14 +250,19 @@ module RnSap
       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,
-      }
+      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="00000", use_exceptions="")
@@ -276,11 +286,18 @@ module RnSap
       fn_preq_exec_release.invoke
 
       tb_return = get_object_list(fn_preq_exec_release[:RETURN], Return.to_s)
-      {
-        status_new: fn_preq_exec_release[:REL_STATUS_NEW],
-        indicator_new: fn_preq_exec_release[:REL_INDICATOR_NEW],
-        tb_return: tb_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)
@@ -291,6 +308,15 @@ module RnSap
       []
     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')
@@ -305,21 +331,26 @@ module RnSap
         fun_call.invoke
       rescue Exception => ex
         if ex.to_s.include?('USER_IS_AUTHORIZED')
-          {
-            rc: 0,
-            message: 'Authorized.'
-          }      
+          api_return(0,'Authorized');
         else
-          {
-            rc: 10, 
-            message: 'User is not authorized.',
-            exception: ex
-          }
+          api_return(8,'User is not authorized.')
         end
       end
 
     end
 
+    def api_return_success(obj=nil )
+      UtilHelper.api_return(0, 'Success!', obj)
+    end
+
+    def api_return_error(obj={}, exception=nil)
+      UtilHelper.api_return(8, 'Error.', obj, exception)
+    end
+
+    def api_return(rc=0, message ='', obj=nil, exception=nil )
+      UtilHelper.api_return(rc, message, obj, exception)
+    end
+
     private
 
     attr_writer :conn

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rnsap
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Rogerio Nascimento
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/helper/rfc_helper.rb
+- lib/helper/util_helper.rb
 - lib/preq_detail/preq_acct_assignment.rb
 - lib/preq_detail/preq_contract_limits.rb
 - lib/preq_detail/preq_item.rb