mastercard_core_sdk 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70baa13d8f8b4684d46d10f1447d213c1b4f79a9
-  data.tar.gz: 536119e0d246a3e11b01ee4fd1bae3440c42a12c
+  metadata.gz: 7304d039b64910aa3f8fc16a2f798172480f61e8
+  data.tar.gz: e678aba02e0b2af6ae4fa6e13c8305c8a433954e
 SHA512:
-  metadata.gz: 5564f83d9186449a34d4a5ae88ee6f3b565e46a26c81182c8a8d0be2e4b7279265036fbd83df813b46eff66921738f9f2f3defaaf4b8f4aac22280cf74008463
-  data.tar.gz: 952f07b940667b6bf92bdf58617cc0207535aafbc76388f9cf9c3a593ba909470bcae7994af374936b39a69edfee22e8576b6f4a404533ccbbd1433ef490cd1f
+  metadata.gz: 24adf61809aac72ed89494f5e954bacd94b1dda3e5ed62ce9203f1221f75a87a7af0432f5a24acc9b17a55c7e4129347ce20b526430d8e5c2a2dca8a5ffbf06d
+  data.tar.gz: 3691d34e13f729bb6d9f89be6e02ac60f2bdeb396677332dc89f62ec73ed46593c25197d59eae6a91154dec973e480e9be7960ce2d162246e71c063f942cefee

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016, MasterCard International Incorporated
+Copyright (c) 2017, MasterCard International Incorporated
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are 

data/README.md

@@ -2,7 +2,7 @@
 
 This is core SDK containing the configuration part for checkout SDK.
 
-The merchant checkout SDK - MastercardMasterpassMerchant requires this MastercardCoreSdk as dependency for calling the checkout API services. 
+The merchant checkout SDK - MastercardMerchantCheckout requires this MastercardCoreSdk as dependency for calling the checkout API services. 
 
 Features include : 
 
@@ -12,7 +12,7 @@ Features include :
 
 • ApiTracker - ApiTracker tracks the details of SDK from which API services are called. 
 
-For more information, refer [mastercard's developer site](https://developer.mastercard.com). 
+For more information, refer [Masterpass Merchant Integration](https://developer.mastercard.com/documentation/masterpass-merchant-integration). 
 
 ## Installation
 
@@ -43,21 +43,20 @@ MastercardCoreSdk.configure do |config|
 end
 ```
 
-Set configurations for private key and consumer key to call API: 
+Set configurations for Consumer Key & Private Key from [Mastercard's developer's site](https://developer.mastercard.com/): 
 
 ```
 MasterCardApiConfiguration.consumer_key = <Consumer Key>
 MasterCardApiConfiguration.private_key = OpenSSL::PKCS12.new(File.open(<Path to P12 file>), <Password>).key
-MasterCardApiConfiguration.sandbox = false  #By default SANDBOX environment is set, Set sandbox to false to use Production environment
+MasterCardApiConfiguration.sandbox = false  #By default Sandbox environment is set to true, Set sandbox to false to use Production environment.
 
-request_token_response = RequestTokenApi.create(<URL>)
 ```
 
 ## Copyright
-Copyright (c) 2016, MasterCard International Incorporated. See LICENSE for details.
+Copyright (c) 2017, MasterCard International Incorporated. See LICENSE for details.
 
 ## LICENSE
-Copyright (c) 2016, MasterCard International Incorporated. All rights reserved.
+Copyright (c) 2017, MasterCard International Incorporated. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are 
 permitted provided that the following conditions are met:

data/lib/mastercard_core_sdk/client/api_client.rb

@@ -11,12 +11,13 @@ require_relative '../interceptors/signature_builder'
 require_relative '../interceptors/logger_builder'
 require_relative '../interceptors/api_tracker_builder'
 require_relative '../converters/sdk_converter_factory'
+require_relative '../util/jose'
 
 module MastercardCoreSdk
   module Client
     # ApiClient is the base class to invoke the API. It is responsible for to convert all request and response according to the content type.
     class ApiClient
-      include MastercardCoreSdk::Core, MastercardCoreSdk::Interceptors, MastercardCoreSdk::Converters, MastercardCoreSdk::Tracker
+      include MastercardCoreSdk::Util, MastercardCoreSdk::Core, MastercardCoreSdk::Interceptors, MastercardCoreSdk::Converters, MastercardCoreSdk::Tracker
 
       @@logger = Logging.logger[self]
 
@@ -66,6 +67,7 @@ module MastercardCoreSdk
       # @return [String] Response body
       def call(path, service_request, http_method, return_type)
         request = build_request(http_method, path, service_request, @api_config)
+        Jose.api_config = @api_config
         response_body, response_code, response_headers = call_api(request, return_type)
 
         return response_body
@@ -80,19 +82,19 @@ module MastercardCoreSdk
         @mastercard_authenticator.api_tracker = @api_tracker
         @mastercard_authenticator.authenticate  
         response = request.run
-
+        
         # Clearing callbacks
         request.on_complete.clear
         Typhoeus.before.clear
-        
+       
         unless response.success?
           error_response = ErrorResponse.new(:response => response, :response_code => response.response_code)
           @error_handler.handle_error(error_response)
         end
-
+       
         if return_type
           converter = SDKConverterFactory.get_converter(response.headers['Content-Type'])
-          data = converter.response_body_converter(response.response_body, return_type)
+          data = converter.response_body_converter(response, return_type)
         else
           data = nil
         end
@@ -103,7 +105,7 @@ module MastercardCoreSdk
       # Builds the HTTP request
       #
       # @param [String] http_method HTTP method/verb (e.g. POST)
-      # @param [String] path URL path (e.g. /account/new)
+      # @param [String] path URL path 
       # @param [Object] request ServiceRequest object
       # @param [Object] api_config ApiConfig object
       # @return [Typhoeus::Request] A Typhoeus Request

data/lib/mastercard_core_sdk/constants/constants.rb

@@ -49,6 +49,7 @@ module MastercardCoreSdk
   HTTP_CODE = "HttpCode"
 
   BASE_SDK_VERSION = "base_sdk_version="
+  TOKEN_SDK_VERSION = "token_sdk_version="
   CLIENT_SDK_VERSION = "client_sdk_version="
   LANG_NAME = "lang_name="
   LANG_VERSION = "lang_version="
@@ -82,6 +83,8 @@ module MastercardCoreSdk
   ERR_MSG_CONVERSION = "Conversion failed."
   ERR_MSG_API_CONFIG = "Api Config cannot be null."
   ERR_MSG_HOST_URL = "Host URL cannot be empty."
+  ERR_MSG_JOSE_CONVERSION = "Jose conversion not supported."
+  ERR_MSG_JOSE_DECRYPTION = "Decryption failed, Invalid authentication tag."
 
   NULL_RESPONSE_PARAMETERS_ERROR = "Response parameters cannot be null."
   NULL_OAUTH_PARAMETERS_ERROR = "Oauth parameters cannot be null."
@@ -90,6 +93,8 @@ module MastercardCoreSdk
   CONTENT_TYPE_XML = "XML"
   CONTENT_TYPE_JSON = "JSON"
   CONTENT_TYPE_URL_ENCODED = "WWW-FORM-URLENCODED"
+  CONTENT_TYPE_JOSE = "JOSE"
   ERR_MSG_CONTENT_TYPE = "Content-type is not supported :"
+  
 
 end

data/lib/mastercard_core_sdk/converters/encoded_url_converter.rb

@@ -22,7 +22,7 @@ module MastercardCoreSdk
         # @param return_type Defines converted object type; examples: "RequestTokenResponse", "AccessTokenResponse"
         # @return [Object]
         def response_body_converter(response, return_type)
-          body = response
+          body = response.response_body
           return nil if body.nil? || body.empty?
                    
           begin 

data/lib/mastercard_core_sdk/converters/jose_converter.rb

@@ -0,0 +1,96 @@
+require 'logging'
+require 'json'
+require_relative '../core/mastercard_api_configuration'
+require_relative '../core/api_config'
+require_relative '../exceptions/sdk_conversion_error'
+
+module MastercardCoreSdk
+  module Converters
+    # Handles conversion for content-type : "application/jose"
+    class JoseConverter
+      include MastercardCoreSdk::Core, MastercardCoreSdk::Exceptions, MastercardCoreSdk::Util
+
+      @@logger = Logging.logger[self]
+      attr_accessor :skip_root
+      
+      def initialize
+        @skip_root = false
+      end
+      
+      # Convert object (array, hash, object, etc) to JSON.
+      # @param object to be converted into JSON string
+      # @raise [SDKConversionError] Error for conversion.
+      def request_body_converter(object)
+        @@logger.error ERR_MSG_JOSE_CONVERSION
+        raise SDKConversionError.new(:error_message => ERR_MSG_JOSE_CONVERSION, :source => self.class)
+      end
+      
+      # Convert the response to the given return type.
+      # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
+      def response_body_converter(response, return_type)
+        body = response.response_body
+        request = response.request
+        return nil if body.nil? || body.empty?
+        begin
+          headers = request.original_options[:headers]
+          # api_config = MasterCardApiConfiguration.api_config(headers[ApiConfig::CONFIG_NAME_HEADER])
+          api_config = Jose.api_config 
+          plain_text = Jose.decrypt(body, api_config.private_key)
+          data = JSON.parse("[#{plain_text}]", :symbolize_names => true)[0]
+        rescue JSON::ParserError => e
+          if %w(String Date DateTime).include?(return_type.to_s)
+            data = body
+          else
+            @@logger.error e.message
+            raise SDKConversionError.new(:error_message => e.message, :source => self.class)
+          end
+        end
+        convert_to_type data, return_type
+      end
+      
+      private
+      
+      # Convert data to the given return type.
+      def convert_to_type(data, return_type)
+        return nil if data.nil?
+        case return_type.to_s
+        when 'String'
+          data.to_s
+        when 'Integer'
+          data.to_i
+        when 'Float'
+          data.to_f
+        when 'BOOLEAN'
+          data == true
+        when 'DateTime'
+          # parse date time (expecting ISO 8601 format)
+          DateTime.parse data
+        when 'Date'
+          # parse date time (expecting ISO 8601 format)
+          Date.parse data
+        when 'Object'
+          # generic object, return directly
+          data
+        when /\AArray<(.+)>\z/
+          # e.g. Array<Pet>
+          sub_type = $1
+          data.map {|item| convert_to_type(item, sub_type) }
+        when /\AHash\<String, (.+)\>\z/
+          # e.g. Hash<String, Integer>
+          sub_type = $1
+          {}.tap do |hash|
+            data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
+          end
+        else
+          if skip_root
+            data = data[data.keys[0]]
+          end 
+          return_type.new.tap do |model|
+            model.build_from_hash data
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/mastercard_core_sdk/converters/json_converter.rb

@@ -10,6 +10,12 @@ module MastercardCoreSdk
 
       @@logger = Logging.logger[self]
       
+      attr_accessor :skip_root
+      
+      def initialize
+        @skip_root = false
+      end
+      
       # Convert object (array, hash, object, etc) to JSON.
       # @param object to be converted into JSON string
       # @return [String] JSON string representation of the object
@@ -36,7 +42,7 @@ module MastercardCoreSdk
       #
       # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
       def response_body_converter(response, return_type)
-        body = response
+        body = response.response_body
         return nil if body.nil? || body.empty?
         begin
           data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
@@ -96,6 +102,9 @@ module MastercardCoreSdk
             data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
           end
         else
+          if skip_root
+            data = data[data.keys[0]]
+          end  
           return_type.new.tap do |model|
             model.build_from_hash data
           end

data/lib/mastercard_core_sdk/converters/sdk_converter_factory.rb

@@ -12,7 +12,7 @@ module MastercardCoreSdk
       class << self
         include MastercardCoreSdk::Exceptions
         
-        # Get converter as per mime-type.
+        # Get converter as per content-type.
         # @param mime String specifying content-type for request.
         # @return [Hash]
         def get_converter(mime)
@@ -26,6 +26,8 @@ module MastercardCoreSdk
               converter = JsonConverter.new
             elsif content_type.include?(CONTENT_TYPE_URL_ENCODED)
               converter = EncodedURLConverter.new
+            elsif content_type.include?(CONTENT_TYPE_JOSE)
+              converter = JoseConverter.new
             else
               @@logger.debug "#{ERR_MSG_CONTENT_TYPE} #{content_type}"
               raise SDKConversionError.new(:error_message => "#{ERR_MSG_CONTENT_TYPE} #{content_type}", :source => self.class)
@@ -57,6 +59,8 @@ module MastercardCoreSdk
             mime_sub_type = CONTENT_TYPE_XML
           elsif urlencoded_mime?(mime)
             mime_sub_type = CONTENT_TYPE_URL_ENCODED
+          elsif jose_mime?(mime)
+            mime_sub_type = CONTENT_TYPE_JOSE
           else
             @@logger.debug "#{ERR_MSG_CONTENT_TYPE} #{mime}"
             raise SDKConversionError.new(:error_message => "#{ERR_MSG_CONTENT_TYPE} #{mime}", :source => self.class)
@@ -85,6 +89,13 @@ module MastercardCoreSdk
           !!(mime =~ /www-form-urlencoded/i)
         end
         
+        # Check if the given MIME is a JOSE mime.
+        # @param mime String specifying mime-type.
+        # @return [Boolean]
+        def jose_mime?(mime)
+          !!(mime =~ /jose/i)
+        end
+        
       end
     end
   end

data/lib/mastercard_core_sdk/converters/xml_converter.rb

@@ -34,7 +34,7 @@ module MastercardCoreSdk
       # @param return_type specifies model; examples: "RequestTokenResponse", "AccessTokenResponse"
       # @return [Object]
       def response_body_converter(response, return_type)
-        body = response
+        body = response.response_body
         
         return nil if body.nil? || body.empty?
 

data/lib/mastercard_core_sdk/core/api_config.rb

@@ -4,18 +4,20 @@ module MastercardCoreSdk
     class ApiConfig
       
        CONFIG_NAME_HEADER = "__config_name__"
-       attr_accessor :name, :consumer_key, :private_key, :host_url
+       attr_accessor :name, :consumer_key, :private_key, :host_url, :additional_properties
        
        # Constructs ApiConfig object.
        # @param name the environment name. e.g. "SANDBOX"
        # @param consumer_key the consumer key (Generated from mastercard developer zone). 
        # @param private_key the private key, to be fetched from the certificate.
        # @param host_url the environment host url. e.g. "https://sandbox.api.mastercard.com" 
-       def initialize(name, consumer_key, private_key, host_url)
+       # @param additional_properties the additional properties for plugins information.
+       def initialize(name, consumer_key, private_key, host_url, additional_properties = {})
          @name = name
          @consumer_key = consumer_key
          @private_key = private_key
          @host_url = host_url 
+         @additional_properties = additional_properties
        end
        
     end

data/lib/mastercard_core_sdk/core/api_config_builder.rb

@@ -35,14 +35,22 @@ module MastercardCoreSdk
         return self
       end
       
-      # Build and register the ApiConfig object.
+	    # Sets additional properties for plugins
+      # @param additional_properties [Hash] the plugin details as hash with plugin_version as key.
+      # @return [ApiConfigBuilder]
+      def additional_properties(additional_properties = {})
+        @additional_properties= additional_properties
+        return self
+      end
+      
+      # Register the ApiConfig with MasterCardApiConfiguration.
       # @return [ApiConfig]
       def build
-        api_config = ApiConfig.new(@name, @consumer_key, @private_key, @host_url)
+        api_config = ApiConfig.new(@name, @consumer_key, @private_key, @host_url, @additional_properties)
         MasterCardApiConfiguration.register_config(api_config)
         return api_config
       end
       
     end
   end
-end
+end

data/lib/mastercard_core_sdk/core/mastercard_api_configuration.rb

@@ -1,4 +1,4 @@
-require "logging"
+require 'logging'
 require_relative '../exceptions/sdk_validation_error'
 require_relative 'api_config_builder'
 
@@ -56,6 +56,7 @@ module MastercardCoreSdk
         # @param api_config the ApiConfig object.
         def register_config(api_config)
           self.configs.merge!({ api_config.name => api_config })
+          MasterCardApiConfiguration.additional_properties = api_config.additional_properties if !api_config.additional_properties.nil? && !api_config.additional_properties.empty?
         end
         
         # Check if environment is Sandbox.

data/lib/mastercard_core_sdk/core/request_response_logger.rb

@@ -1,5 +1,6 @@
 require 'nokogiri'
-require "logging"
+require 'logging'
+require 'json'
 require_relative  '../exceptions/sdk_validation_error'
 
 module MastercardCoreSdk
@@ -69,10 +70,20 @@ module MastercardCoreSdk
 
           if response.response_body
             response_body = response.response_body
-            
             xml_mime = !!(response.headers['Content-Type'] =~ /xml/i)
-            if xml_mime && response_body.include?("AccountNumber")
-              response_body = mask_data(response_body)
+            json_mime = !!(response.headers['Content-Type'] =~ /json/i)
+            
+            if json_mime 
+               if response_body.include?("accountNumber")
+                 response_hash = JSON.parse(response_body)
+                 response_body = mask_json_data(response_hash).to_json
+               end
+              
+            elsif xml_mime
+              if response_body.include?("AccountNumber")
+                xml_doc = Nokogiri::XML(response_body)
+                response_body = mask_xml_data(xml_doc).serialize(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML).sub("\n","").strip
+              end
             end
             
             log_str += NEWLINE + response_body.to_s
@@ -89,13 +100,26 @@ module MastercardCoreSdk
 	  
 	    private
       
-      def self.mask_data(response_body)
-        xmldoc = Nokogiri::XML(response_body)
-        xmldoc.at("Card").search("AccountNumber").each do |node|
+      def self.mask_xml_data(xml_doc)
+        xml_doc.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
+        return xml_doc
+      end
+      
+      def self.mask_json_data(response_hash)
+        if response_hash.is_a? Hash
+          response_hash.each do |key, value|
+            if key == "card" && response_hash[key].key?("accountNumber")
+               response_hash["card"]["accountNumber"] = response_hash["card"]["accountNumber"].gsub(/.(?=\d{4})/,'*')
+               return response_hash
+            elsif value.is_a? Array
+               value.each do |hash|
+                  mask_json_data(hash)
+               end
+            end
+          end
+        end
       end
 	  
     end

data/lib/mastercard_core_sdk/core/service_request.rb

@@ -16,7 +16,7 @@ module MastercardCoreSdk
       # @return [Hash]
       def query_params=(query_params)
         if query_params && query_params.params
-          query_params.params.map{|hash| @query_params.merge!(hash)}
+          @query_params.merge!(query_params.params)
         end
       end
 

data/lib/mastercard_core_sdk/exceptions/error_handler.rb

@@ -61,7 +61,7 @@ module MastercardCoreSdk
         
         begin
           converter = SDKConverterFactory.get_converter(content_type)
-          errors = converter.response_body_converter(response_body, Errors)
+          errors = converter.response_body_converter(error_response.response, Errors)
           raise SDKResponseError.new(:errors_object => errors, :status_code => response_status_code)
 
         rescue SDKConversionError => err

data/lib/mastercard_core_sdk/models/detail.rb

@@ -19,8 +19,8 @@ module MastercardCoreSdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :name => :Name,
-        :value => :Value
+        :name => :name,
+        :value => :value
       }
     end
 

data/lib/mastercard_core_sdk/models/details.rb

@@ -17,7 +17,7 @@ module MastercardCoreSdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :detail => :Detail
+        :detail => :detail
       }
     end
 

data/lib/mastercard_core_sdk/models/error.rb

@@ -38,11 +38,11 @@ module MastercardCoreSdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :description => :Description,
-        :reason_code => :ReasonCode,
-        :recoverable => :Recoverable,
-        :source => :Source,
-        :details => :Details,
+        :description => :description,
+        :reason_code => :reasonCode,
+        :recoverable => :recoverable,
+        :source => :source,
+        :details => :details,
         :extension_point => :ExtensionPoint
       }
     end

data/lib/mastercard_core_sdk/models/errors.rb

@@ -16,7 +16,7 @@ module MastercardCoreSdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :error => :Error
+        :error => :errors
       }
     end
 
@@ -109,8 +109,8 @@ module MastercardCoreSdk
           end
         end
       else # model
-      _model = MastercardCoreSdk.const_get(type).new
-      _model.build_from_hash(value)
+        _model = MastercardCoreSdk.const_get(type).new
+        _model.build_from_hash(value)
       end
     end
 

data/lib/mastercard_core_sdk/oauth/oauth_util.rb

@@ -27,8 +27,7 @@ module MastercardCoreSdk
             @signature_base_string = @auth_header = @signed_signature_base_string = @header = ''
             
             headers = api_request.options[:headers]
-            url = api_request.base_url
-           
+            url = api_request.url
             body = api_request.options[:body] || ""
             
             @api_config = MasterCardApiConfiguration.api_config(headers[ApiConfig::CONFIG_NAME_HEADER])

data/lib/mastercard_core_sdk/util/jose.rb

@@ -0,0 +1,127 @@
+require 'openssl'
+require 'json'
+require 'securerandom'
+require 'base64'
+require_relative '../exceptions/sdk_validation_error'
+
+module MastercardCoreSdk
+  module Util
+    class Jose
+      
+      SEGMENTS = 5
+      
+      class << self
+        include MastercardCoreSdk::Core, MastercardCoreSdk::Exceptions
+        
+        attr_accessor :api_config, :alg, :enc, :plain_text, :cipher_text, :private_key, :public_key 
+        attr_accessor :jwe_protected_header,:cek, :encrypted_cek, :hmac_key, :hmac_input, :aes_enc_key, :iv, :aad, :al, :auth_tag
+        
+        def to_s
+          [
+            jwe_protected_header,
+            encrypted_cek,
+            iv,
+            cipher_text,
+            auth_tag
+          ].collect do |segment|
+            url_safe_encode64 segment.to_s
+          end.join('.')
+        end
+  
+        def sha_size
+          case enc.to_sym
+          when :'A128CBC-HS256'
+            256
+          when :'A256CBC-HS512'
+            512
+          else
+            raise 'Unknown Hash Size'
+          end
+        end
+    
+        # Returns the Base64Url decoded version of `binary` without padding.
+        # @param [String] binary
+        # @return [String]
+        def url_safe_decode64(binary)
+          binary = binary.tr('-_', '+/')
+          case binary.bytesize % 4
+          when 2
+            binary += '=='
+          when 3
+            binary += '='
+          end
+          return Base64.decode64(binary)
+        end
+    
+        # Returns the Base64Url encoded version of `binary` without padding.
+        # @param [String] binary
+        # @return [String]
+        def url_safe_encode64(binary)
+          return Base64.strict_encode64(binary).tr('+/', '-_').delete('=')
+        end
+    
+        def decode_compact_serialized(input)
+          unless input.count('.') + 1 == SEGMENTS
+            raise SDKValidationError.new("Invalid format, should include #{SEGMENTS} segments.")
+          end
+          header, self.encrypted_cek, self.iv, self.cipher_text, self.auth_tag = input.split('.').collect do |segment|
+            url_safe_decode64 segment
+          end
+          self.aad = input.split('.').first
+          self.jwe_protected_header = JSON.load(header)
+        end
+    
+        def decrypt(input, private_key)
+          decode_compact_serialized input
+          self.alg = jwe_protected_header["alg"]
+          self.enc = jwe_protected_header["enc"]
+          self.private_key = private_key
+          cipher = OpenSSL::Cipher.new 'AES-128-CBC'
+          cipher.decrypt
+          self.cek = private_key.private_decrypt encrypted_cek, OpenSSL::PKey::RSA::PKCS1_OAEP_PADDING
+          self.hmac_key, self.aes_enc_key = derive_encryption_and_hmac_keys
+          cipher.key = aes_enc_key
+          cipher.iv = iv
+          self.plain_text = cipher.update(cipher_text) + cipher.final
+          self.al = derive_al
+          self.hmac_input = [ aad, iv, cipher_text, al ].join
+          verify_cbc_authentication_tag!
+          return self.plain_text
+        end
+    
+        def derive_al
+          [(aad.bytesize * 8)].pack('Q>')
+        end
+    
+        def derive_encryption_and_hmac_keys
+          cek.unpack(
+            "a#{cek.length / 2}" * 2
+          )
+        end
+    
+        def verify_cbc_authentication_tag!
+          expected_auth_tag = OpenSSL::HMAC.digest(
+            OpenSSL::Digest.new("SHA#{sha_size}"), hmac_key, hmac_input
+          )[0, sha_size / 2 / 8]
+          unless secure_compare(auth_tag, expected_auth_tag)
+            raise SDKValidationError.new(ERR_MSG_JOSE_DECRYPTION)
+          end
+        end
+    
+        def secure_compare(a, b)
+          return false unless a.bytesize == b.bytesize
+  
+          l = a.unpack "C#{a.bytesize}"
+  
+          res = 0
+          b.each_byte { |byte| res |= byte ^ l.shift }
+          res == 0
+        end
+        
+      end
+    end
+  end
+end
+
+
+

data/lib/mastercard_core_sdk/version.rb

@@ -1,3 +1,3 @@
 module MastercardCoreSdk
-   VERSION = "1.3.0"
+   VERSION = "2.0.0"
 end

data/lib/mastercard_core_sdk.rb

@@ -10,11 +10,6 @@ require_relative 'mastercard_core_sdk/core/configuration'
 
 #tracker
 require_relative 'mastercard_core_sdk/tracker/api_tracker'
-require_relative 'mastercard_core_sdk/tracker/token_api_tracker'
-
-#api
-require_relative 'mastercard_core_sdk/api/request_token_api'
-require_relative 'mastercard_core_sdk/api/access_token_api'
 
 #client
 require_relative 'mastercard_core_sdk/client/api_client'
@@ -36,24 +31,26 @@ require_relative 'mastercard_core_sdk/interceptors/api_tracker_builder'
 require_relative 'mastercard_core_sdk/interceptors/logger_builder'
 
 #models
-require_relative 'mastercard_core_sdk/models/access_token_response'
 require_relative 'mastercard_core_sdk/models/detail'
 require_relative 'mastercard_core_sdk/models/details'
 require_relative 'mastercard_core_sdk/models/error'
 require_relative 'mastercard_core_sdk/models/errors'
 require_relative 'mastercard_core_sdk/models/extension_point'
-require_relative 'mastercard_core_sdk/models/request_token_response'
 require_relative 'mastercard_core_sdk/models/error_response'
 
 # OAuth
 require_relative 'mastercard_core_sdk/oauth/oauth_util'
 require_relative 'mastercard_core_sdk/oauth/oauth_parameters'
 
+# OAuth
+require_relative 'mastercard_core_sdk/util/jose'
+
 #converters
 require_relative 'mastercard_core_sdk/converters/sdk_converter_factory'
 require_relative 'mastercard_core_sdk/converters/xml_converter'
 require_relative 'mastercard_core_sdk/converters/json_converter'
 require_relative 'mastercard_core_sdk/converters/encoded_url_converter'
+require_relative 'mastercard_core_sdk/converters/jose_converter'
 
 # MultiConfig Environments
 require_relative 'mastercard_core_sdk/core/api_config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mastercard_core_sdk
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
-- MasterCard
+- Mastercard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,8 +132,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.3
-description: MasterCard Core API SDK. See https://developer.mastercard.com
-email: openapi@mastercard.com
+description: Mastercard Core API SDK.
+email:
+- support@masterpass.com
+- merchant_support@masterpass.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -143,11 +145,10 @@ files:
 - LICENSE.txt
 - README.md
 - lib/mastercard_core_sdk.rb
-- lib/mastercard_core_sdk/api/access_token_api.rb
-- lib/mastercard_core_sdk/api/request_token_api.rb
 - lib/mastercard_core_sdk/client/api_client.rb
 - lib/mastercard_core_sdk/constants/constants.rb
 - lib/mastercard_core_sdk/converters/encoded_url_converter.rb
+- lib/mastercard_core_sdk/converters/jose_converter.rb
 - lib/mastercard_core_sdk/converters/json_converter.rb
 - lib/mastercard_core_sdk/converters/sdk_converter_factory.rb
 - lib/mastercard_core_sdk/converters/xml_converter.rb
@@ -168,22 +169,20 @@ files:
 - lib/mastercard_core_sdk/interceptors/api_tracker_builder.rb
 - lib/mastercard_core_sdk/interceptors/logger_builder.rb
 - lib/mastercard_core_sdk/interceptors/signature_builder.rb
-- lib/mastercard_core_sdk/models/access_token_response.rb
 - lib/mastercard_core_sdk/models/detail.rb
 - lib/mastercard_core_sdk/models/details.rb
 - lib/mastercard_core_sdk/models/error.rb
 - lib/mastercard_core_sdk/models/error_response.rb
 - lib/mastercard_core_sdk/models/errors.rb
 - lib/mastercard_core_sdk/models/extension_point.rb
-- lib/mastercard_core_sdk/models/request_token_response.rb
 - lib/mastercard_core_sdk/oauth/oauth_parameters.rb
 - lib/mastercard_core_sdk/oauth/oauth_util.rb
 - lib/mastercard_core_sdk/tracker/api_tracker.rb
-- lib/mastercard_core_sdk/tracker/token_api_tracker.rb
+- lib/mastercard_core_sdk/util/jose.rb
 - lib/mastercard_core_sdk/version.rb
 homepage: https://developer.mastercard.com
 licenses:
-- MasterCard
+- Mastercard
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -193,7 +192,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -204,5 +203,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: MasterCard Core API SDK
+summary: Mastercard Core API SDK
 test_files: []

data/lib/mastercard_core_sdk/api/access_token_api.rb

@@ -1,38 +0,0 @@
-require_relative '../core/service_request'
-require_relative '../client/api_client'
-require_relative '../exceptions/error_handler'
-require_relative '../models/access_token_response'
-
-module MastercardCoreSdk
-  module Api
-   # Invokes AccessTokenApi.
-   class AccessTokenApi
-      include MastercardCoreSdk::Core, MastercardCoreSdk::Client, MastercardCoreSdk::Exceptions, MastercardCoreSdk::Tracker
-      
-      # This API call is used to exchange a request token for a long access token from the Masterpass service. 
-      # For Pairing during checkout, this service will need to be called twice: 
-      # 1. To request the checkout access token, which is used to retrieve checkout data.
-      # 2. To request the long access token, which is used to retrieve precheckout data.
-      # You will need the Request Token (oauth_token) and Verifier (oauth_verifier) from the merchant callback to get an access token.
-      #
-      # @note Since version 1.2.0, the method signature for {create} has changed.
-      # @param oauth_token the oauth token, which is used to retrieve checkout data.
-      # @param oauth_verifier the oauth verifier.
-      # @param api_config Optional ApiConfig object.
-      # @return [AccessTokenResponse]
-      def self.create(oauth_token, oauth_verifier, api_config = nil)
-        path = "/oauth/consumer/v1/access_token"
-        
-        service_request = ServiceRequest.new
-        service_request.headers = {"oauth_verifier" => oauth_verifier, "oauth_token" => oauth_token}  
-        service_request.content_type = "application/xml"
-        api_client = ApiClient.new(api_config)
-
-        api_client.api_tracker = TokenApiTracker.new
-        api_client.error_handler = ErrorHandler.new
-        return api_client.call(path, service_request, "POST", AccessTokenResponse)
-      end
-      
-    end
-  end
-end

data/lib/mastercard_core_sdk/api/request_token_api.rb

@@ -1,33 +0,0 @@
-require_relative '../core/service_request'
-require_relative '../client/api_client'
-require_relative '../exceptions/error_handler'
-require_relative '../models/request_token_response'
-
-module MastercardCoreSdk
-  module Api
-    # Invokes RequestTokenApi.
-    class RequestTokenApi
-      include MastercardCoreSdk::Core, MastercardCoreSdk::Client, MastercardCoreSdk::Exceptions, MastercardCoreSdk::Tracker
-      
-      # This api call used to get the request token.This must be executed when a
-      # consumer clicks Buy with MasterPass or Connect with MasterPass buttons on your site/app.
-      #
-      # @param oauth_callback_url the oauth callback URL.
-      # @param api_config Optional ApiConfig object.
-      # @return [RequestTokenResponse]
-      def self.create(oauth_callback_url, api_config = nil)
-        path = "/oauth/consumer/v1/request_token"
-
-        service_request = ServiceRequest.new
-        service_request.headers = {"oauth_callback" => oauth_callback_url}
-        service_request.content_type = "application/xml"
-        api_client = ApiClient.new(api_config)
-
-        api_client.api_tracker = TokenApiTracker.new
-        api_client.error_handler = ErrorHandler.new
-        return api_client.call(path, service_request, "POST", RequestTokenResponse)
-      end
-      
-    end
-  end
-end

data/lib/mastercard_core_sdk/models/access_token_response.rb

@@ -1,148 +0,0 @@
-module MastercardCoreSdk
-      
-    # Defines attributes for access token response.
-    class AccessTokenResponse
-      
-      # @!attribute oauth_token_secret
-      # @return [String]
-      attr_accessor :oauth_token_secret
-       
-      # @!attribute oauth_token
-      # @return [String]
-      attr_accessor :oauth_token
-      
-      # Attribute mapping from ruby-style variable name to JSON key.
-      def self.attribute_map
-       {
-          :oauth_token => :OauthToken,
-          :oauth_token_secret => :OauthTokenSecret
-       }
-      end
-    
-      #Initializing object attributes.
-      def initialize(attributes = {})
-        return unless attributes.is_a?(Hash)
-        # convert string to symbol for hash key
-        attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-        self.class.datatype_map.each_pair do |key, type|
-          if attributes.has_key?(key) 
-            send "#{key}=", _deserialize(type, attributes[key])
-          end
-        end
-      end
-    
-      # Check equality by comparing each attribute.
-      def ==(o)
-        return true if self.equal?(o)
-        self.class == o.class &&
-            oauth_token == o.oauth_token &&
-            oauth_token_secret == o.oauth_token_secret 
-      end
-  
-      # @see the `==` method
-      def eql?(o)
-        self == o
-      end
-
-      # Calculate hash code according to all attributes.
-      def hash
-        [oauth_token, oauth_token_secret].hash
-      end
-
-      # build the object from hash
-      def build_from_hash(attributes)
-        return nil unless attributes.is_a?(Hash)
-        self.class.datatype_map.each_pair do |key, type|
-          if type =~ /^Array<(.*)>/i
-            if attributes[self.class.attribute_map[key]].is_a?(Array)
-              self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
-            else
-              #TODO show warning in debug mode
-            end
-          elsif !attributes[self.class.attribute_map[key]].nil?
-            self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-          else
-            # data not found in attributes(hash), not an issue as the data can be optional
-          end
-        end
-        self
-      end
-    
-      def _deserialize(type, value)
-        case type.to_sym
-        when :DateTime
-          DateTime.parse(value)
-        when :Date
-          Date.parse(value)
-        when :String
-          value.to_s
-        when :Integer
-          value.to_i
-        when :Float
-          value.to_f
-        when :BOOLEAN
-          !!(value.to_s =~ /^(true|t|yes|y|1)$/i)
-        when /\AArray<(?<inner_type>.+)>\z/
-          inner_type = Regexp.last_match[:inner_type]
-          value.map { |v| _deserialize(inner_type, v) }
-        when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
-          k_type = Regexp.last_match[:k_type]
-          v_type = Regexp.last_match[:v_type]
-          {}.tap do |hash|
-            value.each do |k, v|
-              hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-            end
-          end
-        else # model
-          _model = MastercardCoreSdk.const_get(type).new
-          _model.build_from_hash(value)
-        end
-      end
-
-      def to_s
-        to_hash.to_s
-      end
-
-      # to_body is an alias to to_body (backward compatibility))
-      def to_body
-        to_hash
-      end
-
-      # return the object in the form of hash
-      def to_hash
-        hash = {}
-        self.class.attribute_map.each_pair do |attr, param|
-          value = self.send(attr)
-          next if value.nil?
-          hash[param] = _to_hash(value)
-        end
-        hash
-      end
-
-      # Method to output non-array value in the form of hash
-      # For object, use to_hash. Otherwise, just return the value
-      def _to_hash(value)
-        if value.is_a?(Array)
-          value.compact.map{ |v| _to_hash(v) }
-        elsif value.is_a?(Hash)
-          {}.tap do |hash|
-            value.each { |k, v| hash[k] = _to_hash(v) }
-          end
-        elsif value.respond_to? :to_hash
-          value.to_hash
-        else
-          value
-        end
-      end
-      
-      private
-      # Attribute to datatype mapping.
-      def self.datatype_map
-       {
-          :oauth_token => 'String',
-          :oauth_token_secret => 'String'
-       }
-      end
-      
-  end
-end

data/lib/mastercard_core_sdk/models/request_token_response.rb

@@ -1,170 +0,0 @@
-require 'uri'
-
-module MastercardCoreSdk
-
-  # Defines attributes for request token response.  
-  class RequestTokenResponse 
-    
-    # @!attribute xoauth_request_auth_url
-    # @return [String]
-    attr_accessor :xoauth_request_auth_url 
-    
-    # @!attribute oauth_token
-    # @return [String]
-    attr_accessor :oauth_token
-    
-    # @!attribute oauth_token_secret 
-    # @return [String]
-    attr_accessor :oauth_token_secret
-    
-    # @!attribute oauth_expires_in
-    # @return [Integer] no. of seconds after which oauth_token expires
-    attr_accessor :oauth_expires_in
-    
-    # @!attribute oauth_callback_confirmed 
-    # @return [Boolean]
-    attr_accessor :oauth_callback_confirmed 
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-     {
-        :xoauth_request_auth_url => :XoauthRequestAuthUrl,
-        :oauth_token => :OauthToken,
-        :oauth_token_secret => :OauthTokenSecret,
-        :oauth_expires_in => :OauthExpiresIn,
-        :oauth_callback_confirmed => :OauthCallbackConfirmed
-     }
-    end
-    
-    #Initializing object attributes with response parameters
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-      # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-      self.class.datatype_map.each_pair do |key, type|
-        if attributes.has_key?(key) 
-          send "#{key}=", (key.to_s == "xoauth_request_auth_url") ? URI.decode(_deserialize(type, attributes[key])) : _deserialize(type, attributes[key])
-        end
-      end
-    end
-    
-    # Check equality by comparing each attribute.
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          xoauth_request_auth_url == o.xoauth_request_auth_url &&
-          oauth_token == o.oauth_token &&
-          oauth_token_secret == o.oauth_token_secret &&
-          oauth_expires_in == o.oauth_expires_in && 
-          oauth_callback_confirmed == o.oauth_callback_confirmed
-    end
-
-    # @see the `==` method
-    def eql?(o)
-      self == o
-    end
-
-    # Calculate hash code according to all attributes.
-    def hash
-      [currency_code, subtotal, shopping_cart_item, extension_point].hash
-    end
-
-    # build the object from hash
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.datatype_map.each_pair do |key, type|
-        if type =~ /^Array<(.*)>/i
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
-          else
-            #TODO show warning in debug mode
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
-      end
-      self
-    end
-    
-    def _deserialize(type, value)
-      case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :BOOLEAN
-        !!(value.to_s =~ /^(true|t|yes|y|1)$/i)
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        _model = MastercardCoreSdk.const_get(type).new
-        _model.build_from_hash(value)
-      end
-    end
-
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_body (backward compatibility))
-    def to_body
-      to_hash
-    end
-
-    # return the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        next if value.nil?
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Method to output non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-      
-    private
-    # Attribute to datatype mapping.
-    def self.datatype_map
-     {
-        :xoauth_request_auth_url => 'String',
-        :oauth_token => 'String',
-        :oauth_token_secret => 'String',
-        :oauth_expires_in => 'Integer',
-        :oauth_callback_confirmed => 'BOOLEAN'
-     }
-    end
-  end
-end

data/lib/mastercard_core_sdk/tracker/token_api_tracker.rb

@@ -1,52 +0,0 @@
-require_relative '../core/mastercard_api_configuration'
-require_relative '../tracker/api_tracker'
-
-module MastercardCoreSdk
-  module Tracker
-    # Provides tracking api information and user-agent information for Token services.
-    class TokenApiTracker
-      include MastercardCoreSdk::Core, MastercardCoreSdk::Tracker::ApiTracker
-
-      # Defines the programming language.
-      #
-      # @return [String]
-      attr_accessor :language
-
-      # Defines the programming language version.
-      #
-      # @return [String]
-      attr_accessor :language_version
-
-      # Defines the plugin version if any defined in {MasterCardApiConfiguration} as additional_properties.
-      #
-      # @return [String]
-      attr_reader :plugin_version
-      
-      def initialize
-        @language = "Ruby"
-        @language_version = RUBY_VERSION
-
-        additional_track_info = MasterCardApiConfiguration.additional_properties
-        if (additional_track_info && additional_track_info.size > 0 && additional_track_info.key?(PLUGIN_VERSION))
-          @plugin_version = additional_track_info[PLUGIN_VERSION]
-        end
-      end
-
-      # Overriding {ApiTracker#tracking_info} method.
-      # Get tracking information set in User-Agent header.
-      # @return [String]
-      def tracking_info
-        api_tracker_string =  LANG_NAME + language + SEPERATOR + LANG_VERSION + language_version
-        api_tracker_string += SEPERATOR + PLUGIN_VERSION + EQUAL + plugin_version unless plugin_version.nil?
-        return api_tracker_string
-      end
-
-      # Overriding {ApiTracker#user_agent_info} method.
-      #
-      # @return [String]
-      def user_agent_info
-        return USER_AGENT
-      end
-    end
-  end
-end