mastercard_core_sdk 1.1.3

data/lib/mastercard_core_sdk/converters/xml_converter.rb

@@ -0,0 +1,52 @@
+require 'logging'
+require 'roxml'
+require_relative '../exceptions/sdk_conversion_error'
+
+module MastercardCoreSdk
+  module Converters
+    # Handles conversion for content-type : "application/xml"
+    class XmlConverter
+      include ROXML
+      include MastercardCoreSdk::Exceptions
+
+      @@logger = Logging.logger[self]
+      
+      # Convert object (array, hash, object, etc) to XML.
+      # @param object to be converted into XML string
+      # @return [String] XML string representation of the object
+      def request_body_converter(object)
+        return nil if object.nil?
+        begin
+          if object.respond_to?(:to_xml)
+            serialized_xml = object.to_xml.serialize(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML)
+          else
+            serialized_xml = object
+          end
+          return serialized_xml.to_s
+        rescue => err
+          @@logger.error err.message
+          raise SDKConversionError.new(:error_message => err.message, :source => self.class)
+        end
+      end
+
+      # Convert the response XML string to the given return type of model.
+      # @param response XML string to be converted to object
+      # @param return_type specifies model; examples: "RequestTokenResponse", "AccessTokenResponse"
+      # @return [Object]
+      def response_body_converter(response, return_type)
+        body = response
+        
+        return nil if body.nil? || body.empty?
+
+        begin
+          object = return_type.from_xml(body) if return_type.respond_to?(:from_xml)
+          return object
+        rescue => err
+          @@logger.error err.message
+          raise SDKConversionError.new(:error_message => err.message, :source => self.class)
+        end
+      end
+
+    end
+  end
+end

data/lib/mastercard_core_sdk/core/api_config.rb

@@ -0,0 +1,18 @@
+module MastercardCoreSdk
+  module Core
+    # Defines consumer key, private key from developer's site and name, host URL for environment other than sandbox/production.
+    class ApiConfig
+      
+       CONFIG_NAME_HEADER = "__config_name__"
+       attr_accessor :name, :consumer_key, :private_key, :host_url
+       
+       def initialize(name, consumer_key, private_key, host_url)
+         @name = name
+         @consumer_key = consumer_key
+         @private_key = private_key
+         @host_url = host_url 
+       end
+       
+    end
+  end
+end

data/lib/mastercard_core_sdk/core/api_config_builder.rb

@@ -0,0 +1,48 @@
+module MastercardCoreSdk
+  module Core
+    # To be defined by application developer : environment name, consumer key, private key and host URL. 
+    class ApiConfigBuilder
+      
+      # Sets environment name
+      # @param name Environment.
+      # @return [ApiConfigBuilder]
+      def name(name)
+        @name = name
+        return self
+      end
+      
+      # Sets consumer key
+      # @param consumer_key Consumer key from developer's site.
+      # @return [ApiConfigBuilder]
+      def consumer_key(consumer_key)
+        @consumer_key = consumer_key
+        return self
+      end
+      
+      # Sets private key
+      # @param private_key Private key from developer's site.
+      # @return [ApiConfigBuilder]
+      def private_key(private_key)
+        @private_key = private_key
+        return self
+      end
+      
+      # Sets host URL as per environment(Sandbox/Production)
+      # @param host_url Host URL for the environment.
+      # @return [ApiConfigBuilder]
+      def host_url(host_url)
+        @host_url = host_url
+        return self
+      end
+      
+      # Register the ApiConfig with MasterCardApiConfiguration.
+      # @return [ApiConfig]
+      def build
+        api_config = ApiConfig.new(@name, @consumer_key, @private_key, @host_url)
+        MasterCardApiConfiguration.register_config(api_config)
+        return api_config
+      end
+      
+    end
+  end
+end

data/lib/mastercard_core_sdk/core/configuration.rb

@@ -0,0 +1,81 @@
+require 'uri'
+
+module MastercardCoreSdk
+  module Core
+      class Configuration
+        # Defines url scheme
+        attr_accessor :scheme
+    
+        # Defines url host
+        attr_accessor :host
+    
+        # Defines url base path
+        attr_accessor :base_path
+    
+        # The time limit for HTTP request in seconds.
+        # Default to 0 (never times out).
+        attr_accessor :timeout
+    
+        ### TLS/SSL
+        # Set this to false to skip verifying SSL certificate when calling API from https server.
+        # Default to true.
+        #
+        # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+        #
+        # @return [true, false]
+        attr_accessor :verify_ssl
+    
+        attr_accessor :inject_format
+    
+        attr_accessor :force_ending_format
+    
+        attr_accessor :format, :user_agent, :default_headers
+        
+         
+        def initialize
+          @scheme = 'https'
+          @host = 'api.mastercard.com'
+          @base_path = ''
+          @timeout = 0
+          @verify_ssl = false #To be set to true for production
+          @inject_format = false
+          @force_ending_format = false
+          @format = ""
+          @default_headers = {}
+    
+          yield(self) if block_given?
+        end
+    
+        # The default Configuration object.
+        def self.default
+          @@default ||= Configuration.new
+        end
+    
+        def configure
+          yield(self) if block_given?
+        end
+    
+        def scheme=(scheme)
+          # remove :// from scheme
+          @scheme = scheme.sub(/:\/\//, '')
+        end
+    
+        def host=(host)
+          # remove http(s):// and anything after a slash
+          @host = host.sub(/https?:\/\//, '').split('/').first
+        end
+    
+        def base_path=(base_path)
+          # Add leading and trailing slashes to base_path
+          @base_path = "/#{base_path}".gsub(/\/+/, '/')
+          @base_path = "" if @base_path == "/"
+        end
+    
+        def base_url
+          url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+          URI.encode(url)
+        end
+    
+      end
+   end
+end

data/lib/mastercard_core_sdk/core/mastercard_api_configuration.rb

@@ -0,0 +1,100 @@
+require "logging"
+require_relative '../exceptions/sdk_validation_error'
+require_relative 'api_config_builder'
+
+module MastercardCoreSdk
+  module Core
+    # Setting MasterCard API configuration parameters for API calls
+    class MasterCardApiConfiguration
+
+      @@logger = Logging.logger[self]
+      PROD_KEY = "__PROD__"
+      SANDBOX_KEY = "__SANDBOX__"
+      SANDBOX_URL = "https://sandbox.api.mastercard.com"
+      PROD_URL = "https://api.mastercard.com"
+            
+      class << self
+        include MastercardCoreSdk::Exceptions 
+        
+        # Defines consumer key from developer site.
+        attr_accessor :consumer_key
+
+        # Defines private key from p12 file from developer site.
+        attr_accessor :private_key
+        
+        # Defines additional_properties for plugin.
+        attr_accessor :additional_properties
+        
+        # Defines Hash having environment name as key and api_config object as value. 
+        attr_accessor :configs
+        
+        # Determines if environment is Sandbox.
+        attr_accessor :sandbox
+        
+        # Validates private key, consumer key and host_url for api_config.
+        # @raise [SDKValidationError] if validation fails
+        def validate_config(config)
+          if config.nil?
+            @@logger.error ERR_MSG_API_CONFIG
+            raise SDKValidationError.new(ERR_MSG_API_CONFIG)
+          end
+          if config.consumer_key.to_s.empty?
+            @@logger.error ERR_MSG_CONSUMER_KEY
+            raise SDKValidationError.new(ERR_MSG_CONSUMER_KEY)
+          end
+          if config.private_key.nil?
+            @@logger.error ERR_MSG_PRIVATE_KEY
+            raise SDKValidationError.new(ERR_MSG_PRIVATE_KEY)
+          end
+          if config.host_url.to_s.empty?
+            @@logger.error ERR_MSG_HOST_URL
+            raise SDKValidationError.new(ERR_MSG_HOST_URL)
+          end
+        end
+
+        # Registers the API configuration.
+        # @param api_config The API configuration.
+        def register_config(api_config)
+          self.configs.merge!({ api_config.name => api_config })
+        end
+        
+        # Check if environment is Sandbox.
+        # @return [Boolean]
+        def sandbox?
+          self.sandbox
+        end
+            
+        # Determine api_config object.
+        # @param name The environment name.
+        # @return [ApiConfig]
+        def api_config(name = nil)
+          if name
+            return self.configs[name]
+          else
+            if sandbox?
+              @@sandbox.private_key(self.private_key)
+              @@sandbox.consumer_key(self.consumer_key)
+              return @@sandbox.build
+            else
+              @@production.private_key(self.private_key)
+              @@production.consumer_key(self.consumer_key)
+              return @@production.build
+            end
+          end
+        end
+      end
+      
+      self.additional_properties = {}
+      self.configs = {}
+      self.sandbox = true
+      
+      # Initialize builders hash with sandbox/production environment configurations.
+      @@builders = {}
+      @@sandbox = ApiConfigBuilder.new.name(SANDBOX_KEY).host_url(SANDBOX_URL)
+      @@production = ApiConfigBuilder.new.name(PROD_KEY).host_url(PROD_URL)
+      @@builders.merge!({ SANDBOX_KEY => @@sandbox })
+      @@builders.merge!({ PROD_KEY => @@production })
+      
+    end
+  end
+end

data/lib/mastercard_core_sdk/core/mastercard_authenticator.rb

@@ -0,0 +1,25 @@
+require "logging"
+require "typhoeus"
+
+require_relative '../interceptors/signature_builder'
+require_relative '../interceptors/logger_builder'
+require_relative '../interceptors/api_tracker_builder'
+
+module MastercardCoreSdk
+  module Core
+    # Setting MasterCard API configuration parameters for API calls
+    class MastercardAuthenticator
+      include MastercardCoreSdk::Interceptors
+      
+      attr_accessor :api_tracker
+      
+      def authenticate
+        Typhoeus.before do |request|
+          SignatureBuilder.build(request)
+          ApiTrackerBuilder.new(@api_tracker, request)
+          LoggerBuilder.log(request)
+        end
+      end
+    end
+  end
+end

data/lib/mastercard_core_sdk/core/query_params.rb

@@ -0,0 +1,23 @@
+module MastercardCoreSdk
+  module Core
+    class QueryParams
+
+      attr_reader :params
+      
+      def initialize
+        @params = {}
+      end
+
+      def add(key, value)
+        key = key.to_sym if key.is_a?(String)
+        @params.merge!({ key => value })
+        return self
+      end
+
+      def params
+        @params
+      end
+
+    end
+  end
+end

data/lib/mastercard_core_sdk/core/request_response_logger.rb

@@ -0,0 +1,101 @@
+require 'nokogiri'
+require "logging"
+require_relative  '../exceptions/sdk_validation_error'
+
+module MastercardCoreSdk
+  module Core
+    # Class for defining log statements; it is called by logging interceptor for logging.
+    class RequestResponseLogger
+      include MastercardCoreSdk::Exceptions
+
+      NEWLINE = "\n"
+      @@logger = Logging.logger[self]
+      
+      # Method called by interceptor to log request
+      def self.log_request(request)
+        if request
+
+          log_str = LOG_REQUEST_INFORMATION
+          request_api_info = NEWLINE + LOG_REQUEST + request.options[:method].to_s.upcase + HYPHEN + request.base_url + NEWLINE
+          log_str += request_api_info
+
+          headers = request.options[:headers]
+          body = request.options[:body]
+
+          if headers && headers.size > 0
+            headers.each do |param,value|
+              log_str += NEWLINE + param.to_s + COLON + value.to_s
+            end
+          end
+
+          if body
+            log_str += NEWLINE + body.to_s
+          end
+          log_str += NEWLINE
+
+        @@logger.info request_api_info
+        @@logger.debug log_str
+        else
+          @@logger.error ERR_MSG_NULL_REQUEST
+          raise SDKValidationError.new(ERR_MSG_NULL_REQUEST)
+        end
+      end
+
+      # Method called by interceptor to log response
+      def self.log_response(response)
+        if response
+
+          log_str = NEWLINE + LOG_RESPONSE_INFORMATION
+
+          response_api_info = NEWLINE + LOG_RESPONSE + response.return_message + HYPHEN + response.return_code.to_s.upcase + HYPHEN + response.code.to_s.upcase
+          response_uri_info = NEWLINE + LOG_URI + HYPHEN + response.options[:effective_url]
+
+          log_str += response_api_info + response_uri_info
+          headers = response.headers
+
+          if headers && headers.size > 0
+            headers.each do |param, value|
+              if value.is_a?(Array)
+                value.each do |v|
+                  log_str += NEWLINE + param + COLON + v
+                end
+              else
+                log_str += NEWLINE + param + COLON + value
+              end
+            end
+          end
+
+          if response.response_body
+            response_body = response.response_body
+            
+            xml_mime = !!(response.headers['Content-Type'] =~ /\Aapplication\/xml(;.*)?\z/i)
+            if xml_mime && response_body.include?("AccountNumber")
+              response_body = mask_data(response_body)
+            end
+            
+            log_str += NEWLINE + response_body.to_s
+          end
+          log_str += NEWLINE
+
+        @@logger.info response_api_info
+        @@logger.debug log_str
+        else
+          @@logger.error ERR_MSG_NULL_RESPONSE
+          raise SDKValidationError.new(ERR_MSG_NULL_RESPONSE)
+        end
+      end
+	  
+	  private
+      
+      def self.mask_data(response_body)
+        xmldoc = Nokogiri::XML(response_body)
+        xmldoc.at("Card").search("AccountNumber").each do |node|
+          node.content = node.content.gsub(/.(?=\d{4})/,'*')
+        end
+        response_body = xmldoc.serialize(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML).sub("\n","").strip
+        return response_body
+      end
+	  
+    end
+  end
+end

data/lib/mastercard_core_sdk/core/service_request.rb

@@ -0,0 +1,24 @@
+module MastercardCoreSdk
+  module Core
+    class ServiceRequest
+
+      attr_accessor :headers, :path_params, :query_params, :body, :content_type
+      
+      def initialize
+        @headers = {}
+        @path_params = {}
+        @query_params = {}
+      end
+
+      # Set request path parameters
+      # @param query_params Hash specifying request query parameters
+      # @return [Hash]
+      def query_params=(query_params)
+        if query_params && query_params.params
+          query_params.params.map{|hash| @query_params.merge!(hash)}
+        end
+      end
+
+    end
+  end
+end

data/lib/mastercard_core_sdk/exceptions/error_handler.rb

@@ -0,0 +1,130 @@
+require 'logging'
+
+require_relative '../converters/sdk_converter_factory'
+require_relative '../exceptions/sdk_response_error'
+require_relative '../exceptions/sdk_conversion_error'
+
+module MastercardCoreSdk
+  module Exceptions
+    # Raises custom errors as per error response details.
+    class ErrorHandler
+      include MastercardCoreSdk::Converters
+
+      @@logger = Logging.logger[self]
+
+      ERR_DESC_NULL_RES = "Received null response: "
+      ERR_DESC_EMPTY_RES = "Received empty body: "
+      ERR_REASON_NULL_RES = "NULL_RESPONSE"
+      ERR_REASON_EMPTY_BODY_RES = "EMPTY_BODY"
+      ERR_REASON_INVALID_RES = "INVALID_RESPONSE"
+      ERR_REASON_NT_TIMEOUT = "NETWORK_TIMEOUT"
+      ERR_MSG_INVALID_RES = "Received invalid response: ["
+      ERR_MSG_UNKN_RES = "Unknown reason for failure, please check logs."
+      ERR_SRC_UNKN = "Unknown"
+      ERR_NETWORK = "NETWORK_ERROR"
+      ERR_UNKN_REASON = "GENERAL_ERROR"
+      ERR_INTERNAL = "INTERNAL_PROCESSING_ERROR"
+      SEP_COLON = "]: "
+      OAUTH_MIME_TYPE = "WWW-FORM-URLENCODED"
+      ERR_MSG_RES_PARSE = "Exception occurred during response parsing."
+      
+      # Raise custom error as per response error object.
+      # @param error_response The Typheous::Response object containing error details.
+      # @raise [SDKResponseError]  
+      def handle_error(error_response)
+        errors = nil
+        response_body = error_response.response.response_body
+        response_status_code = error_response.response_code
+
+        if response_body.empty?
+          errors = get_errors_object(ERR_DESC_EMPTY_RES, ERR_REASON_EMPTY_BODY_RES, ERR_SRC_UNKN)
+          @@logger.error "400 #{ERR_SRC_UNKN}"
+          raise SDKResponseError.new(:errors_object => errors, :status_code => 400)
+          
+        elsif response_status_code == 200
+          # In some cases, response code is 200 and response body is empty.
+          # Received response, but could not be matched to the appropriate response object.
+          description = ERR_MSG_INVALID_RES + response_body + SEP_COLON
+          errors = get_errors_object(description, ERR_REASON_INVALID_RES, ERR_SRC_UNKN)
+          @@logger.error "400 #{ERR_MSG_INVALID_RES}"
+          raise SDKResponseError.new(:errors_object => errors, :status_code => 400)
+        end
+
+        content_type = mime_sub_type(error_response.response.headers['Content-Type']) rescue nil
+       
+        begin
+          converter = SDKConverterFactory.get_converter(content_type)
+          errors = converter.response_body_converter(response_body, Errors)
+          raise SDKResponseError.new(:errors_object => errors, :status_code => response_status_code)
+
+        rescue SDKConversionError => err
+          # For request and access token call if any require parameter missing in header server send response as encodedURL.
+          # Below code set the received response as description and raise Errors object.
+          if content_type.include?(OAUTH_MIME_TYPE)
+            description = response_body
+          else
+            description = err.message
+          end
+
+          case response_status_code
+          when 400
+            errors = get_errors_object(description, nil, "")
+          when 502
+            # Request timeout
+            errors = get_errors_object(description, ERR_REASON_NT_TIMEOUT, ERR_NETWORK)
+          else
+            # Unknown error
+            errors = get_errors_object(ERR_MSG_UNKN_RES, ERR_UNKN_REASON, ERR_SRC_UNKN)
+          end
+          @@logger.error "#{response_status_code}\n#{errors.error}"
+          raise SDKResponseError.new(:errors_object => errors, :status_code => response_status_code)
+        end
+      end
+
+      private
+
+      def get_errors_object(description, reason_code, source)
+        error = Error.new(:description => description, :reason_code => reason_code, :source => source, :recoverable => false)
+        return Errors.new(:error => [error])
+      end
+      
+      def mime_sub_type(content_type)
+        mime_type = ""
+        if json_mime?(content_type)
+          mime_type = JSON_MIME_TYPE 
+        elsif xml_mime?(content_type)
+          mime_type = XML_MIME_TYPE
+        elsif urlencoded_mime?(content_type)
+          mime_type = URLENCODED_MIME_TYPE
+        end
+        return mime_type
+      end
+
+      # Check if the given MIME is a JSON MIME.
+      # JSON MIME examples:
+      #   application/json
+      #   application/json; charset=UTF8
+      #   APPLICATION/JSON
+      def json_mime?(mime)
+        !!(mime =~ /\Aapplication\/json(;.*)?\z/i)
+      end
+
+      # Check if the given MIME is a XML MIME.
+      # XML MIME examples:
+      #   application/xml
+      #   application/xml; charset=UTF8
+      #   APPLICATION/XML
+      def xml_mime?(mime)
+        !!(mime =~ /\Aapplication\/xml(;.*)?\z/i)
+      end
+     
+      # Check if the given MIME is a X-WWW-FORM_URLENCODED MIME.
+      # XML MIME examples:
+      #   application/x-www-form-urlencoded
+      def urlencoded_mime?(mime)
+        !!(mime =~ /\Aapplication\/x-www-form-urlencoded(;.*)?\z/i)
+      end
+
+    end
+  end
+end

data/lib/mastercard_core_sdk/exceptions/sdk_base_error.rb

@@ -0,0 +1,28 @@
+module MastercardCoreSdk
+  module Exceptions
+    # Defines base error class for all the custom errors.
+    class SDKBaseError < RuntimeError
+      attr_accessor :errors_object, :status_code, :error_message
+      # Usage examples:
+      #   SDKBaseError.new
+      #   SDKBaseError.new("message")
+      #   SDKBaseError.new(:status_code => 500, :error_message => "", :errors_object => Errors)
+      #   SDKBaseError.new(:status_code => 404, :error_message => "Not Found")
+      def initialize(arg = nil)
+        if arg.is_a? Hash
+          arg.each do |k, v|
+            if k.to_s == 'error_message'
+              @error_message = v
+              super v
+            else
+              instance_variable_set "@#{k}", v
+            end
+          end
+        else
+          super arg
+        end
+      end
+    end
+  end
+end
+

data/lib/mastercard_core_sdk/exceptions/sdk_conversion_error.rb

@@ -0,0 +1,18 @@
+require_relative  '../exceptions/sdk_base_error'
+
+module MastercardCoreSdk
+  module Exceptions
+    # Defines error to be raised on conversion failure.
+    class SDKConversionError < SDKBaseError
+      
+      attr_accessor :error_message, :source
+      
+      def initialize(args)
+        @error_message = args[:error_message]
+        @source = args[:source]
+        super(args[:error_message])
+      end
+
+    end
+  end
+end

data/lib/mastercard_core_sdk/exceptions/sdk_oauth_error.rb

@@ -0,0 +1,16 @@
+require_relative  '../exceptions/sdk_base_error'
+
+module MastercardCoreSdk
+  module Exceptions
+    # Defines error to be raised for OAuth calls.
+    class SDKOAuthError < SDKBaseError
+      attr_accessor :error_message
+      
+      def initialize(error_message)
+        @error_message = error_message
+        super(error_message)
+      end
+
+    end
+  end
+end

data/lib/mastercard_core_sdk/exceptions/sdk_response_error.rb

@@ -0,0 +1,17 @@
+require_relative  '../exceptions/sdk_base_error'
+
+module MastercardCoreSdk
+  module Exceptions
+    # Defines error to be raised with details in error object.
+    class SDKResponseError < SDKBaseError
+      
+      attr_accessor :errors_object, :status_code
+      
+      def initialize(args)
+        @errors_object = args[:errors_object]
+        @status_code = args[:status_code]
+      end
+
+    end
+  end
+end