cybersource_rest_client 0.0.79 → 0.0.80

data/lib/cybersource_rest_client/models/upv1capturecontexts_data_payment_information_card.rb

@@ -0,0 +1,196 @@
+=begin
+#CyberSource Merged Spec
+
+#All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
+
+OpenAPI spec version: 0.0.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.38
+=end
+
+require 'date'
+
+module CyberSource
+  class Upv1capturecontextsDataPaymentInformationCard
+    # The card type selection indicator
+    attr_accessor :type_selection_indicator
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type_selection_indicator' => :'typeSelectionIndicator'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'type_selection_indicator' => :'type_selection_indicator'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'type_selection_indicator' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'typeSelectionIndicator')
+        self.type_selection_indicator = attributes[:'typeSelectionIndicator']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type_selection_indicator Value to be assigned
+    def type_selection_indicator=(type_selection_indicator)
+      @type_selection_indicator = type_selection_indicator
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          type_selection_indicator == o.type_selection_indicator
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [type_selection_indicator].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      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
+        temp_model = CyberSource.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns 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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+  end
+end

data/lib/cybersource_rest_client/models/upv1capturecontexts_data_processing_information.rb

@@ -13,6 +13,7 @@ require 'date'
 
 module CyberSource
   class Upv1capturecontextsDataProcessingInformation
+    # The reconciliation ID
     attr_accessor :reconciliation_id
 
     attr_accessor :authorization_options

data/lib/cybersource_rest_client/models/upv1capturecontexts_data_processing_information_authorization_options.rb

@@ -13,18 +13,40 @@ require 'date'
 
 module CyberSource
   class Upv1capturecontextsDataProcessingInformationAuthorizationOptions
+    # The AFT indicator
     attr_accessor :aft_indicator
 
+    # The authorization indicator
+    attr_accessor :auth_indicator
+
+    # Ignore the CV result
+    attr_accessor :ignore_cv_result
+
+    # Ignore the AVS result
+    attr_accessor :ignore_avs_result
+
     attr_accessor :initiator
 
+    # The business application Id
     attr_accessor :business_application_id
 
+    # The commerce indicator
+    attr_accessor :commerce_indicator
+
+    # The processing instruction
+    attr_accessor :processing_instruction
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'aft_indicator' => :'aftIndicator',
+        :'auth_indicator' => :'authIndicator',
+        :'ignore_cv_result' => :'ignoreCvResult',
+        :'ignore_avs_result' => :'ignoreAvsResult',
         :'initiator' => :'initiator',
-        :'business_application_id' => :'businessApplicationId'
+        :'business_application_id' => :'businessApplicationId',
+        :'commerce_indicator' => :'commerceIndicator',
+        :'processing_instruction' => :'processingInstruction'
       }
     end
 
@@ -32,8 +54,13 @@ module CyberSource
     def self.json_map
       {
         :'aft_indicator' => :'aft_indicator',
+        :'auth_indicator' => :'auth_indicator',
+        :'ignore_cv_result' => :'ignore_cv_result',
+        :'ignore_avs_result' => :'ignore_avs_result',
         :'initiator' => :'initiator',
-        :'business_application_id' => :'business_application_id'
+        :'business_application_id' => :'business_application_id',
+        :'commerce_indicator' => :'commerce_indicator',
+        :'processing_instruction' => :'processing_instruction'
       }
     end
 
@@ -41,8 +68,13 @@ module CyberSource
     def self.swagger_types
       {
         :'aft_indicator' => :'BOOLEAN',
+        :'auth_indicator' => :'String',
+        :'ignore_cv_result' => :'BOOLEAN',
+        :'ignore_avs_result' => :'BOOLEAN',
         :'initiator' => :'Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator',
-        :'business_application_id' => :'String'
+        :'business_application_id' => :'String',
+        :'commerce_indicator' => :'String',
+        :'processing_instruction' => :'String'
       }
     end
 
@@ -58,6 +90,18 @@ module CyberSource
         self.aft_indicator = attributes[:'aftIndicator']
       end
 
+      if attributes.has_key?(:'authIndicator')
+        self.auth_indicator = attributes[:'authIndicator']
+      end
+
+      if attributes.has_key?(:'ignoreCvResult')
+        self.ignore_cv_result = attributes[:'ignoreCvResult']
+      end
+
+      if attributes.has_key?(:'ignoreAvsResult')
+        self.ignore_avs_result = attributes[:'ignoreAvsResult']
+      end
+
       if attributes.has_key?(:'initiator')
         self.initiator = attributes[:'initiator']
       end
@@ -65,6 +109,14 @@ module CyberSource
       if attributes.has_key?(:'businessApplicationId')
         self.business_application_id = attributes[:'businessApplicationId']
       end
+
+      if attributes.has_key?(:'commerceIndicator')
+        self.commerce_indicator = attributes[:'commerceIndicator']
+      end
+
+      if attributes.has_key?(:'processingInstruction')
+        self.processing_instruction = attributes[:'processingInstruction']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -86,14 +138,31 @@ module CyberSource
       @business_application_id = business_application_id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] commerce_indicator Value to be assigned
+    def commerce_indicator=(commerce_indicator)
+      @commerce_indicator = commerce_indicator
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] processing_instruction Value to be assigned
+    def processing_instruction=(processing_instruction)
+      @processing_instruction = processing_instruction
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           aft_indicator == o.aft_indicator &&
+          auth_indicator == o.auth_indicator &&
+          ignore_cv_result == o.ignore_cv_result &&
+          ignore_avs_result == o.ignore_avs_result &&
           initiator == o.initiator &&
-          business_application_id == o.business_application_id
+          business_application_id == o.business_application_id &&
+          commerce_indicator == o.commerce_indicator &&
+          processing_instruction == o.processing_instruction
     end
 
     # @see the `==` method
@@ -105,7 +174,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [aft_indicator, initiator, business_application_id].hash
+      [aft_indicator, auth_indicator, ignore_cv_result, ignore_avs_result, initiator, business_application_id, commerce_indicator, processing_instruction].hash
     end
 
     # Builds the object from hash

data/lib/cybersource_rest_client/models/upv1capturecontexts_data_processing_information_authorization_options_initiator.rb

@@ -13,6 +13,7 @@ require 'date'
 
 module CyberSource
   class Upv1capturecontextsDataProcessingInformationAuthorizationOptionsInitiator
+    # Store the credential on file
     attr_accessor :credential_stored_on_file
 
     attr_accessor :merchant_initiated_transaction

data/lib/cybersource_rest_client/models/upv1capturecontexts_data_recipient_information.rb

@@ -31,6 +31,12 @@ module CyberSource
     # The account type of the recipient
     attr_accessor :account_type
 
+    # The date of birth of the recipient
+    attr_accessor :date_of_birth
+
+    # The postal code of the recipient
+    attr_accessor :postal_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,7 +46,9 @@ module CyberSource
         :'country' => :'country',
         :'account_id' => :'accountId',
         :'administrative_area' => :'administrativeArea',
-        :'account_type' => :'accountType'
+        :'account_type' => :'accountType',
+        :'date_of_birth' => :'dateOfBirth',
+        :'postal_code' => :'postalCode'
       }
     end
 
@@ -53,7 +61,9 @@ module CyberSource
         :'country' => :'country',
         :'account_id' => :'account_id',
         :'administrative_area' => :'administrative_area',
-        :'account_type' => :'account_type'
+        :'account_type' => :'account_type',
+        :'date_of_birth' => :'date_of_birth',
+        :'postal_code' => :'postal_code'
       }
     end
 
@@ -66,7 +76,9 @@ module CyberSource
         :'country' => :'String',
         :'account_id' => :'String',
         :'administrative_area' => :'String',
-        :'account_type' => :'String'
+        :'account_type' => :'String',
+        :'date_of_birth' => :'String',
+        :'postal_code' => :'String'
       }
     end
 
@@ -105,6 +117,14 @@ module CyberSource
       if attributes.has_key?(:'accountType')
         self.account_type = attributes[:'accountType']
       end
+
+      if attributes.has_key?(:'dateOfBirth')
+        self.date_of_birth = attributes[:'dateOfBirth']
+      end
+
+      if attributes.has_key?(:'postalCode')
+        self.postal_code = attributes[:'postalCode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -162,6 +182,18 @@ module CyberSource
       @account_type = account_type
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] date_of_birth Value to be assigned
+    def date_of_birth=(date_of_birth)
+      @date_of_birth = date_of_birth
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      @postal_code = postal_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -173,7 +205,9 @@ module CyberSource
           country == o.country &&
           account_id == o.account_id &&
           administrative_area == o.administrative_area &&
-          account_type == o.account_type
+          account_type == o.account_type &&
+          date_of_birth == o.date_of_birth &&
+          postal_code == o.postal_code
     end
 
     # @see the `==` method
@@ -185,7 +219,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [first_name, middle_name, last_name, country, account_id, administrative_area, account_type].hash
+      [first_name, middle_name, last_name, country, account_id, administrative_area, account_type, date_of_birth, postal_code].hash
     end
 
     # Builds the object from hash

data/lib/cybersource_rest_client/models/upv1capturecontexts_order_information.rb

@@ -12,6 +12,7 @@ Swagger Codegen version: 2.4.38
 require 'date'
 
 module CyberSource
+  # If you need to include any fields within the data object, you must use the orderInformation object that is nested inside the data object. This ensures proper structure and compliance with the Unified Checkout schema. This top-level orderInformation field is not intended for use when working with the data object.
   class Upv1capturecontextsOrderInformation
     attr_accessor :amount_details
 

data/lib/cybersource_rest_client/utilities/capture_context/capture_context_parsing_utility.rb

@@ -0,0 +1,113 @@
+require_relative '../../../AuthenticationSDK/util/JWT/JWTUtility'
+require_relative '../../../AuthenticationSDK/util/JWT/JWTExceptions'
+require_relative '../../../AuthenticationSDK/util/Cache'
+require_relative 'public_key_fetcher'
+
+module CyberSource
+  module Utilities
+    module CaptureContext
+      # CaptureContextParser Class
+      #
+      # Parses and validates capture context JWT responses from CyberSource.
+      # Provides functionality to parse JWT tokens and optionally verify their
+      # signatures using public keys fetched from the CyberSource API.
+      #
+      # @category Class
+      # @package  CyberSource::Authentication::Util::CaptureContext
+      # @author   CyberSource
+      class CaptureContextParser
+        class << self
+          # Parses a capture context JWT response and optionally verifies its signature
+          #
+          # @param jwt_value [String] The JWT token to parse
+          # @param merchant_config [Object] The merchant configuration object
+          # @return [Hash] The parsed JWT payload
+          # @raise [CyberSource::Authentication::Util::JWT::InvalidJwtException] If JWT is invalid
+          # @raise [CyberSource::Authentication::Util::JWT::JwtSignatureValidationException] If signature verification fails
+          # @raise [ArgumentError] If required parameters are missing
+          # @raise [StandardError] For other errors during processing
+          #
+          # @example Parse with verification
+          #   payload = CaptureContextParser.parse_capture_context_response(jwt_token, config)
+          def parse_capture_context_response(jwt_value, merchant_config)
+            verify_jwt = true
+            # Always validate JWT value first
+            if jwt_value.nil? || jwt_value.strip.empty?
+              raise CyberSource::Authentication::Util::JWT::InvalidJwtException.new('JWT value is null or undefined')
+            end
+            
+            # Validate verification requirements before parsing
+            if verify_jwt
+              raise ArgumentError, 'merchantConfig is required' unless merchant_config
+              
+              run_environment = merchant_config.runEnvironment
+              raise ArgumentError, 'Run environment not found in merchant config' if run_environment.nil? || run_environment.strip.empty?
+            end
+            
+            # Parse JWT (actual operation)
+            parsed_jwt = CyberSource::Authentication::Util::JWT::JWTUtility.parse(jwt_value)
+            
+            # Return early if no verification needed
+            return parsed_jwt[:payload] unless verify_jwt
+            
+            # Validate kid exists in parsed JWT
+            kid = parsed_jwt[:header]['kid']
+            if kid.nil? || kid.strip.empty?
+              raise CyberSource::Authentication::Util::JWT::JwtSignatureValidationException.new(
+                'JWT header missing or empty key ID (kid) field'
+              )
+            end
+            
+            # Verify signature (actual operation)
+            verify_jwt_signature(jwt_value, parsed_jwt[:payload], kid, run_environment)
+          end
+
+          private
+
+          def verify_jwt_signature(jwt_value, payload, kid, run_environment)
+            public_key = get_public_key(kid, run_environment)
+            
+            begin
+              CyberSource::Authentication::Util::JWT::JWTUtility.verify_jwt(jwt_value, public_key)
+              payload
+            rescue CyberSource::Authentication::Util::JWT::JwtSignatureValidationException => e
+              # If verification failed with cached key, try once more with fresh key from API
+              public_key = fetch_public_key_from_api(kid, run_environment)
+              cache = Cache.new
+              cache.addPublicKeyToCache(run_environment, kid, public_key) rescue nil
+              
+              CyberSource::Authentication::Util::JWT::JWTUtility.verify_jwt(jwt_value, public_key)
+              payload
+            end
+          end
+
+          def get_public_key(kid, run_environment)
+            cache = Cache.new
+            cached_key = cache.getPublicKeyFromCache(run_environment, kid) rescue nil
+            return cached_key if cached_key
+            
+            public_key = fetch_public_key_from_api(kid, run_environment)
+            
+            cache.addPublicKeyToCache(run_environment, kid, public_key) rescue nil
+            
+            public_key
+          end
+
+          def fetch_public_key_from_api(kid, run_environment)
+            PublicKeyFetcher.fetch_public_key(kid, run_environment)
+          rescue ArgumentError => e
+            if e.message.include?('Invalid Runtime URL') || e.message.include?('run_environment')
+              raise ArgumentError.new('Invalid Runtime URL in Merchant Config', e)
+            else
+              raise
+            end
+          rescue CyberSource::Authentication::Util::JWT::InvalidJwkException
+            raise
+          rescue StandardError => e
+            raise StandardError.new('Error while trying to retrieve public key from server', e)
+          end
+        end
+      end
+    end
+  end
+end