mastercard_api_core 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 944203e87ee923b74bf1ff75a6bdfc7197cd4b32
-  data.tar.gz: 6fbf644b3b92a6a58165da9fe1f14ce654c211f9
+  metadata.gz: eaace8e42ca4512e5c646aeb38a80e618f24ac15
+  data.tar.gz: 2103ad5fd5f01b2c32463eac4f2cebc8e1619bfd
 SHA512:
-  metadata.gz: e873d63a12ca97afe302b75f12182509d882650717e0a8eb216807acbab89046d3c8c11add4c50bb87a520f849ec9424b4b863274101e86008744ffe3f29e1ed
-  data.tar.gz: 9f98769a65e6682c31c468e4d25eef3b80fe5c9d1f9f546fda3478a9b1699f0e9b0ba9ccc16689b82eb1cb22c0e10b134246efa6dbf4ce7ddae89b5aea95049c
+  metadata.gz: bbfecc3d34189d931472d46032f186305aea93451d966f8095e1a30876438902c61141eab82239613de84b2fa1255e1357a9188d64f341b9005ce3b9f5a53bf3
+  data.tar.gz: 1b29b096869b4b6048db37068c1d851b183b4fb1fe546bbf3385bd744db0906765e87bda82bd18362e7a6e6c859365de0750be9467cae4936d8ca8a8c11293a9

data/lib/mastercard/core/baseobject.rb

@@ -0,0 +1,87 @@
+require "mastercard/core/controller"
+require "mastercard/core/model"
+
+module MasterCard
+  module Core
+    module Model      
+      ################################################################################
+      # BaseObject
+      ################################################################################
+
+      class BaseObject < RequestMap
+        include MasterCard::Core::Controller
+        include MasterCard::Core::Model
+
+        def initialize(requestMap = nil)
+
+          #call the base class constructor
+          super()
+
+          unless requestMap.nil?
+            setAll(requestMap.getObject())
+          end
+
+        end
+
+
+        protected
+        
+        def self.getOperationConfig(uuid)
+          raise NotImplementedError.new("Child class must define getOperationConfig method to use this class")
+        end
+
+        def self.getOperationMetadata()
+          raise NotImplementedError.new("Child class must define getOperationMetadata method to use this class")
+        end
+        
+        def self.execute(operationUUID,inputObject)
+          
+          
+          config = inputObject.class.getOperationConfig(operationUUID)
+          metadata = inputObject.class.getOperationMetadata()
+
+          response = APIController.new.execute(config,metadata,inputObject.getObject())
+          returnObjClass = inputObject.class
+
+          if config.getAction().upcase == APIController::ACTION_LIST
+            returnObj = []
+
+            if response.is_a?(Hash) && response.key?(RequestMap::KEY_LIST)
+              response = response[RequestMap::KEY_LIST]
+            end
+
+            if response.is_a?(Hash)
+
+              response.each do |key,value|
+
+                requestMap = RequestMap.new
+                requestMap.setAll(value)
+                returnObj.push(returnObjClass.new(requestMap))
+
+              end
+
+            elsif response.is_a?(Array)
+
+              response.each do |value|
+                requestMap = RequestMap.new
+                requestMap.setAll(value)
+                returnObj.push(returnObjClass.new(requestMap))
+
+              end
+
+            end
+            return returnObj
+          else
+
+            requestMap = RequestMap.new
+            requestMap.setAll(response)
+            return returnObjClass.new(requestMap)
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/mastercard/core/constants.rb

@@ -34,6 +34,8 @@ module MasterCard
     module Environment
       PRODUCTION  = "production"
       SANDBOX     = "sandbox"
+      SANDBOX_MTF     = "sandbox_mtf"
+      SANDBOX_ITF     = "sandbox_itf"
       STAGE       = "stage"
       DEV         = "dev"
       PRODUCTION_MTF         = "production_mtf"
@@ -45,6 +47,8 @@ module MasterCard
       MAPPING     = {
           "production" => ["https://api.mastercard.com", nil],
           "sandbox"  => ["https://sandbox.api.mastercard.com", nil],
+          "sandbox_mtf"  => ["https://sandbox.api.mastercard.com", "mtf"],
+          "sandbox_itf"  => ["https://sandbox.api.mastercard.com", "itf"],
           "stage"  => ["https://stage.api.mastercard.com", nil],
           "dev"  => ["https://dev.api.mastercard.com", nil],
           "production_mtf" => ["https://api.mastercard.com", "mtf"],

data/lib/mastercard/core/exceptions.rb

@@ -24,6 +24,9 @@
 # IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 # SUCH DAMAGE.
 #
+
+require 'mastercard/core/model'
+
 module MasterCard
   module Core
     module Exceptions
@@ -32,69 +35,80 @@ module MasterCard
       # APIException
       ################################################################################
       class APIException  < StandardError
+        include MasterCard::Core::Model
         #
         # Base Class for all the API exceptions
-        def initialize(message,status=nil, error_data=nil)
+        def initialize(message,http_status=nil, error_data=nil)
           #Call the base class constructor
           super(message)
 
           @message    = message
-          @status     = status
-          @error_data = error_data
-          @error_code = nil
+          @http_status     = http_status
+          @raw_error_data = error_data
+          @reason_code = nil
+          @source = nil
+          @description = nil
 
           #If error_data is not nil set the appropriate message
           unless error_data.nil?
 
-            error_hash = Hash.new
-            # If error_data is of type hash and has Key 'Errors' which has a key 'Error'
-            if error_data.is_a?(Hash) && error_data.key?("Errors") && error_data["Errors"].key?("Error")
+            @raw_error_data = SmartMap.new
+            @raw_error_data.setAll(error_data);
 
-              error_hash = error_data["Errors"]["Error"]
+            error_data_case_insensitive = parseMap(error_data)
+
+            # If error_data is of type hash and has Key 'Errors' which has a key 'Error'
+            if error_data_case_insensitive.key?("errors") && error_data_case_insensitive["errors"].key?("error")
+              error_hash = error_data_case_insensitive["errors"]["error"]
 
               #Case of multiple errors take the first one
-              if error_hash.is_a?(Array)
+              if error_hash.is_a?(Hash)
+                initDataFromHash(error_hash)
+
+              #If error Data is of Type Array
+              elsif error_hash.is_a?(Array)
+                #Take the first error
                 error_hash = error_hash[0]
+                initDataFromHash(error_hash)
               end
-
-              initDataFromHash(error_hash)
-
-            #If error Data is of Type Array
-            elsif error_data.is_a?(Array)
-              #Take the first error
-              error_hash = error_data[0]
-              initDataFromHash(error_hash)
             end
           end
-
         end
 
         def getMessage()
-          return @message
+          if @description.nil?
+            return @message
+          else
+            return @description
+          end
+        end
+
+        def getHttpStatus()
+          return @http_status
         end
 
-        def getStatus()
-          return @status
+        def getReasonCode()
+          return @reason_code
         end
 
-        def getErrorCode()
-          return @error_code
+        def getSource()
+          return @source
         end
 
-        def getErrorData()
-          return @error_data
+        def getRawErrorData()
+          return @raw_error_data
         end
 
         def describe()
           exception = self.class.name
           exception << ": \""
           exception << getMessage()
-          exception << "\" (status: "
-          exception << "%s" % getStatus()
-          errorCode = getErrorCode()
+          exception << "\" (http_status: "
+          exception << "%s" % getHttpStatus()
+          errorCode = getReasonCode()
           unless errorCode.nil?
-            exception << ", error code: "
-            exception << "%s" % getErrorCode()
+            exception << ", reason_code: "
+            exception << "%s" % getReasonCode()
           end
           exception << ")"
           return exception
@@ -107,219 +121,40 @@ module MasterCard
         private
 
         def initDataFromHash(error_hash)
-          @error_code = error_hash.fetch("ReasonCode","")
-          @message    = error_hash.fetch("Message",@message)
-        end
-
-      end
-
-      ################################################################################
-      # ApiConnectionException
-      ################################################################################
-
-      class APIConnectionException < APIException
-        #
-        #Exception raised when there are communication problems contacting the API.
-        def initialize(message=nil,status=nil,error_data=nil)
-
-
-          if status.nil?
-              status = 500
-          end
-
-          #Call the base class constructor
-          super(message,status,error_data)
-        end
-      end
-
-
-      ################################################################################
-      # ObjectNotFoundException
-      ################################################################################
-
-      class ObjectNotFoundException < APIException
-        #
-        #Exception raised when the endpoint does not exist.
-        def initialize(message=nil,status=nil,error_data=nil)
-
-
-          if status.nil?
-              status = 404
-          end
-
-          #Call the base class constructor
-          super(message,status,error_data)
-        end
-      end
-
-      ################################################################################
-      # AuthenticationException
-      ################################################################################
-
-      class AuthenticationException < APIException
-        #
-        #Exception raised where there are problems authenticating a request.
-        def initialize(message=nil,status=nil,error_data=nil)
-
-
-          if status.nil?
-              status = 401
-          end
-
-          #Call the base class constructor
-          super(message,status,error_data)
-        end
-      end
-
-      ################################################################################
-      # InvalidRequestException
-      ################################################################################
-
-      class InvalidRequestException < APIException
-        #
-        #Exception raised when the API request contains errors.
-
-        def initialize(message=nil,status=nil,error_data=nil)
-
-          if status.nil?
-              status = 400
-          end
-
-          #Call the base class constructor
-          super(message,status,error_data)
-
-          @fieldErrors = []
-
-          #If error_data is not nil set the appropriate message
-          unless error_data.nil?
-
-            error_hash = Hash.new
-            # If error_data is of type hash and has Key 'Errors' which has a key 'Error'
-            if error_data.is_a?(Hash) && error_data.key?("Errors") && error_data["Errors"].key?("Error")
-
-              error_hash = error_data["Errors"]["Error"]
-
-              #Case of multiple errors take the first one
-              if error_hash.is_a?(Array)
-                error_hash = error_hash[0]
-              end
-
-              initFieldDataFromHash(error_hash)
-
-            #If error Data is of Type Array
-            elsif error_data.is_a?(Array)
-              #Take the first error
-              error_hash = error_data[0]
-              initFieldDataFromHash(error_hash)
+          @reason_code  = error_hash.fetch("reasoncode",nil)
+          @description      = error_hash.fetch("description",@message)
+          @source       = error_hash.fetch("source",nil)
+        end
+
+        def parseMap(map)
+          parsedMap = {}
+          map.each do |k, v|
+            if v.is_a?(Array)
+              parsedMap[k.to_s.downcase] = parseList(v)
+            elsif v.is_a?(Hash)
+              parsedMap[k.to_s.downcase] = parseMap(v)
+            else
+              parsedMap[k.to_s.downcase] = v
             end
           end
-        end
-
-
-        def hasFieldErrors
-          return @fieldErrors.length != 0
-        end
-
-        def getFieldErrors
-          return @fieldErrors
-        end
-
-        def describe
-          des = super()
-          @fieldErrors.each do |field_error|
-            des << "\n #{field_error}"
-          end
-          return des
-        end
-
-        def to_s
-          return "%s"%describe()
-        end
-
-        private
-
-        def initFieldDataFromHash(error_hash)
-          if error_hash.key?("FieldErrors")
-            error_hash.fetch("FieldErrors").each do |field_error|
-              @fieldErrors << "%s"%FieldError.new(field_error)
+          return parsedMap
+        end
+
+        def parseList(l)
+          parsedList = []
+          l.each do |v|
+            if v.is_a?(Array)
+              parsedList << parseList(v) 
+            elsif v.is_a?(Hash)
+              parsedList << parseMap(v)
+            else
+              parsedList << v
             end
           end
+          return parsedList
         end
 
-
-
       end
-
-      ################################################################################
-      # NotAllowedException
-      ################################################################################
-
-      class NotAllowedException < APIException
-        #
-        #Exception when a request was not allowed.
-        def initialize(message=nil,status=nil,error_data=nil)
-
-
-          if status.nil?
-              status = 403
-          end
-
-          #Call the base class constructor
-          super(message,status,error_data)
-
-        end
-      end
-
-
-      ################################################################################
-      # SystemException
-      ################################################################################
-
-      class SystemException < APIException
-        #
-        #Exception when there was a system error processing a request.
-        def initialize(message=nil,status=nil,error_data=nil)
-
-
-          if status.nil?
-              status = 500
-          end
-
-          #Call the base class constructor
-          super(message,status,error_data)
-        end
-      end
-
-      ################################################################################
-      # FieldError
-      ################################################################################
-
-      class FieldError
-
-        def initialize(params)
-
-          @name    = params.fetch("field","")
-          @message = params.fetch("message","")
-          @code    = params.fetch("code")
-        end
-
-        def getFieldName
-          return @name
-        end
-
-        def getErrorMessage
-          return @message
-        end
-
-        def getErrorCode
-          return @code
-        end
-
-        def to_s
-          return "Field Error: #{@name} \"#{@message}\" (#{@code})"
-        end
-      end
-
     end
   end
 end

data/lib/mastercard/core/model.rb

@@ -24,16 +24,14 @@
 # IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 # SUCH DAMAGE.
 #
-require "mastercard/core/controller"
-
 module MasterCard
   module Core
     module Model
       ################################################################################
-      # RequestMap
+      # SmartMap
       ################################################################################
 
-      class RequestMap
+      class SmartMap
 
         KEY_LIST = "list"
 
@@ -400,83 +398,18 @@ module MasterCard
       end
 
       ################################################################################
-      # BaseObject
+      # RequestMap
       ################################################################################
 
-      class BaseObject < RequestMap
-        include MasterCard::Core::Controller
-
-        def initialize(requestMap = nil)
-
+      class RequestMap < SmartMap
+        def initialize
           #call the base class constructor
           super()
-
-          unless requestMap.nil?
-            setAll(requestMap.getObject())
-          end
-
-        end
-
-
-        protected
-        
-        def self.getOperationConfig(uuid)
-          raise NotImplementedError.new("Child class must define getOperationConfig method to use this class")
-        end
-
-        def self.getOperationMetadata()
-          raise NotImplementedError.new("Child class must define getOperationMetadata method to use this class")
-        end
-        
-        def self.execute(operationUUID,inputObject)
-          
-          
-          config = inputObject.class.getOperationConfig(operationUUID)
-          metadata = inputObject.class.getOperationMetadata()
-
-          response = APIController.new.execute(config,metadata,inputObject.getObject())
-          returnObjClass = inputObject.class
-
-          if config.getAction().upcase == APIController::ACTION_LIST
-            returnObj = []
-
-            if response.is_a?(Hash) && response.key?(RequestMap::KEY_LIST)
-              response = response[RequestMap::KEY_LIST]
-            end
-
-            if response.is_a?(Hash)
-
-              response.each do |key,value|
-
-                requestMap = RequestMap.new
-                requestMap.setAll(value)
-                returnObj.push(returnObjClass.new(requestMap))
-
-              end
-
-            elsif response.is_a?(Array)
-
-              response.each do |value|
-                requestMap = RequestMap.new
-                requestMap.setAll(value)
-                returnObj.push(returnObjClass.new(requestMap))
-
-              end
-
-            end
-            return returnObj
-          else
-
-            requestMap = RequestMap.new
-            requestMap.setAll(response)
-            return returnObjClass.new(requestMap)
-
-          end
-
         end
-
       end
 
+      
+
 
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mastercard_api_core
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - MasterCard Worldwide
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -46,6 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/mastercard/core/baseobject.rb
 - lib/mastercard/core/config.rb
 - lib/mastercard/core/constants.rb
 - lib/mastercard/core/controller.rb