mastercard_merchant_checkout 2.0.0 → 2.1.0

data/lib/mastercard_merchant_checkout/models/pairing.rb

@@ -0,0 +1,167 @@
+require 'date'
+require 'roxml'
+ 
+
+module MastercardMerchantCheckout
+  # This class contains methods to set or get the pairing detail(s).
+  class Pairing
+    include ROXML
+    
+    xml_name "Pairing"
+    
+    # @!attribute pairing_id
+    # @return [String] the new pairing token identifier used to fetch pre-checkout data.
+    xml_accessor :pairing_id, :from =>"pairingId"
+   
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :pairing_id => :pairingId 
+        
+      }
+    end
+
+    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}
+
+      
+      if attributes.has_key?(:pairing_id)
+        self.pairing_id = attributes[:pairing_id]
+      end
+      
+    end
+    
+ 
+	
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          pairing_id == o.pairing_id
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [pairing_id].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
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      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 = MastercardMerchantCheckout.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(include_root = false)
+      attributes_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
+      attributes_hash = include_root ? { "Pairing" => hash } : hash  
+      return attributes_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
+    def after_parse
+      self.send(:remove_instance_variable, :@roxml_references) if defined? self.roxml_references
+    end
+    
+    # Attribute datatype mapping.
+    def self.datatype_map
+      {
+        :pairing_id => 'String'
+        
+      }
+    end
+  end
+
+
+end

data/lib/mastercard_merchant_checkout/models/payment_data.rb

@@ -4,17 +4,18 @@ require_relative '../../mastercard_merchant_checkout/models/address'
 require_relative '../../mastercard_merchant_checkout/models/authentication_options'
 require_relative '../../mastercard_merchant_checkout/models/card'
 require_relative '../../mastercard_merchant_checkout/models/personal_info'
+require_relative '../../mastercard_merchant_checkout/models/tokenization'
  
 
 module MastercardMerchantCheckout
-  # This class contains various methods to get paymentData response parameters returned by paymentDataApi.
+  # This class contains various methods to get paymentData response parameters returned by PaymentDataApi.
   class PaymentData
     include ROXML
     
     xml_name "PaymentData"
     
     # @!attribute card
-    # @return [Card] the card details.
+    # @return [Card] the payment card details.
     xml_accessor :card, :from =>"card",:as => Card
    
     # @!attribute shipping_address
@@ -25,14 +26,26 @@ module MastercardMerchantCheckout
     # @return [PersonalInfo] the recipient's personal information.
     xml_accessor :personal_info, :from =>"personalInfo",:as => PersonalInfo
    
+    # @!attribute tokenization
+    # @return [Tokenization] the tokenized card information.
+    xml_accessor :tokenization, :from =>"tokenization",:as => Tokenization
+   
     # @!attribute wallet_id
-    # @return [String] the value which helps to identify origin wallet.
+    # @return [String] the unique identifier for a wallet that helps identify the origin wallet for the transaction.
     xml_accessor :wallet_id, :from =>"walletId"
    
+    # @!attribute wallet_name
+    # @return [String] the wallet name.
+    xml_accessor :wallet_name, :from =>"walletName"
+   
     # @!attribute authentication_options
     # @return [AuthenticationOptions] the authentication information.
     xml_accessor :authentication_options, :from =>"authenticationOptions",:as => AuthenticationOptions
    
+    # @!attribute pairing_id
+    # @return [String] the new pairingId.
+    xml_accessor :pairing_id, :from =>"pairingId"
+   
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -40,8 +53,11 @@ module MastercardMerchantCheckout
         :card => :card ,
         :shipping_address => :shippingAddress ,
         :personal_info => :personalInfo ,
+        :tokenization => :tokenization ,
         :wallet_id => :walletId ,
-        :authentication_options => :authenticationOptions 
+        :wallet_name => :walletName ,
+        :authentication_options => :authenticationOptions ,
+        :pairing_id => :pairingId 
         
       }
     end
@@ -65,14 +81,26 @@ module MastercardMerchantCheckout
         self.personal_info = attributes[:personal_info]
       end
       
+      if attributes.has_key?(:tokenization)
+        self.tokenization = attributes[:tokenization]
+      end
+      
       if attributes.has_key?(:wallet_id)
         self.wallet_id = attributes[:wallet_id]
       end
       
+      if attributes.has_key?(:wallet_name)
+        self.wallet_name = attributes[:wallet_name]
+      end
+      
       if attributes.has_key?(:authentication_options)
         self.authentication_options = attributes[:authentication_options]
       end
       
+      if attributes.has_key?(:pairing_id)
+        self.pairing_id = attributes[:pairing_id]
+      end
+      
     end
     
  
@@ -85,8 +113,11 @@ module MastercardMerchantCheckout
           card == o.card &&
           shipping_address == o.shipping_address &&
           personal_info == o.personal_info &&
+          tokenization == o.tokenization &&
           wallet_id == o.wallet_id &&
-          authentication_options == o.authentication_options
+          wallet_name == o.wallet_name &&
+          authentication_options == o.authentication_options &&
+          pairing_id == o.pairing_id
     end
 
     # @see the `==` method
@@ -96,7 +127,7 @@ module MastercardMerchantCheckout
 
     # Calculate hash code according to all attributes.
     def hash
-      [card, shipping_address, personal_info, wallet_id, authentication_options].hash
+      [card, shipping_address, personal_info, tokenization, wallet_id, wallet_name, authentication_options, pairing_id].hash
     end
 
     # build the object from hash
@@ -132,7 +163,7 @@ module MastercardMerchantCheckout
       when :Float
         value.to_f
       when :BOOLEAN
-        if value =~ /^(true|t|yes|y|1)$/i
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
           false
@@ -204,8 +235,11 @@ module MastercardMerchantCheckout
         :card => 'Card',
         :shipping_address => 'Address',
         :personal_info => 'PersonalInfo',
+        :tokenization => 'Tokenization',
         :wallet_id => 'String',
-        :authentication_options => 'AuthenticationOptions'
+        :wallet_name => 'String',
+        :authentication_options => 'AuthenticationOptions',
+        :pairing_id => 'String'
         
       }
     end

data/lib/mastercard_merchant_checkout/models/personal_info.rb

@@ -3,7 +3,7 @@ require 'roxml'
  
 
 module MastercardMerchantCheckout
-  # This class contains methods to get the recipient's personal details.
+  # The recipient's personal information.
   class PersonalInfo
     include ROXML
     
@@ -108,7 +108,7 @@ module MastercardMerchantCheckout
       when :Float
         value.to_f
       when :BOOLEAN
-        if value =~ /^(true|t|yes|y|1)$/i
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
           false

data/lib/mastercard_merchant_checkout/models/postback.rb

@@ -10,19 +10,19 @@ module MastercardMerchantCheckout
     xml_name "Postback"
     
     # @!attribute transaction_id
-    # @return [String] the transaction Id.
+    # @return [String] the transaction identifiers. Identifies the transaction for which to return the consumer’s payment data. This is the oauth_verifier value sent by Masterpass in callback URL after the Masterpass user interface is closed.
     xml_accessor :transaction_id, :from =>"transactionId"
    
     # @!attribute currency
-    # @return [String] the currency for the transaction; for example, USD.
+    # @return [String] the ISO-4217 code for currency of the transaction.
     xml_accessor :currency, :from =>"currency"
    
     # @!attribute amount
-    # @return [Float] the transaction order amount.
+    # @return [Float] the transaction amount as an integer (10050 for $100.50).
     xml_accessor :amount, :from =>"amount"
    
     # @!attribute payment_successful
-    # @return [BOOLEAN] the payment status indicator. It is set to true if payment successful with PSP else false.
+    # @return [BOOLEAN] the payment status indicator. It is set to true if payment successful with payment processor else false.
     xml_accessor :payment_successful, :from =>"paymentSuccessful"
    
     # @!attribute payment_code
@@ -33,6 +33,10 @@ module MastercardMerchantCheckout
     # @return [DateTime] the date of purchase.
     xml_accessor :payment_date, :from =>"paymentDate"
    
+    # @!attribute pre_checkout_transaction_id
+    # @return [String] the preCheckoutTransactionId from the ExpressCheckout response.
+    xml_accessor :pre_checkout_transaction_id, :from =>"preCheckoutTransactionId"
+   
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -42,7 +46,8 @@ module MastercardMerchantCheckout
         :amount => :amount ,
         :payment_successful => :paymentSuccessful ,
         :payment_code => :paymentCode ,
-        :payment_date => :paymentDate 
+        :payment_date => :paymentDate ,
+        :pre_checkout_transaction_id => :preCheckoutTransactionId 
         
       }
     end
@@ -78,6 +83,10 @@ module MastercardMerchantCheckout
         self.payment_date = attributes[:payment_date]
       end
       
+      if attributes.has_key?(:pre_checkout_transaction_id)
+        self.pre_checkout_transaction_id = attributes[:pre_checkout_transaction_id]
+      end
+      
     end
     
  
@@ -92,7 +101,8 @@ module MastercardMerchantCheckout
           amount == o.amount &&
           payment_successful == o.payment_successful &&
           payment_code == o.payment_code &&
-          payment_date == o.payment_date
+          payment_date == o.payment_date &&
+          pre_checkout_transaction_id == o.pre_checkout_transaction_id
     end
 
     # @see the `==` method
@@ -102,7 +112,7 @@ module MastercardMerchantCheckout
 
     # Calculate hash code according to all attributes.
     def hash
-      [transaction_id, currency, amount, payment_successful, payment_code, payment_date].hash
+      [transaction_id, currency, amount, payment_successful, payment_code, payment_date, pre_checkout_transaction_id].hash
     end
 
     # build the object from hash
@@ -138,7 +148,7 @@ module MastercardMerchantCheckout
       when :Float
         value.to_f
       when :BOOLEAN
-        if value =~ /^(true|t|yes|y|1)$/i
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
           false
@@ -212,7 +222,8 @@ module MastercardMerchantCheckout
         :amount => 'Float',
         :payment_successful => 'BOOLEAN',
         :payment_code => 'String',
-        :payment_date => 'DateTime'
+        :payment_date => 'DateTime',
+        :pre_checkout_transaction_id => 'String'
         
       }
     end

data/lib/mastercard_merchant_checkout/models/pre_checkout_card.rb

@@ -0,0 +1,233 @@
+require 'date'
+require 'roxml'
+ 
+
+module MastercardMerchantCheckout
+  # This class contains precheckout cards details.
+  class PreCheckoutCard
+    include ROXML
+    
+    xml_name "PreCheckoutCard"
+    
+    # @!attribute brand_name
+    # @return [String] the card brand full name (Mastercard, American Express, Diners Club, Discover, JCB, Maestro, Visa).
+    xml_accessor :brand_name, :from =>"brandName"
+   
+    # @!attribute card_holder_name
+    # @return [String] the cardholder's name for a card in the wallet.
+    xml_accessor :card_holder_name, :from =>"cardHolderName"
+   
+    # @!attribute card_id
+    # @return [String] the unique indenifier for a card in the wallet.
+    xml_accessor :card_id, :from =>"cardId"
+   
+    # @!attribute default
+    # @return [BOOLEAN] the Boolean value that identifies a card as the default card for the wallet (Specified by the user).
+    xml_accessor :default, :from =>"default"
+   
+    # @!attribute expiry_year
+    # @return [Integer] the PAN expiration year, returned as a two-digit string (for the year 2020, Masterpass will return 20).
+    xml_accessor :expiry_year, :from =>"expiryYear"
+   
+    # @!attribute expiry_month
+    # @return [Integer] the PAN expiration month, returned as a two-digit string.
+    xml_accessor :expiry_month, :from =>"expiryMonth"
+   
+    # @!attribute last_four
+    # @return [String] the last four digits of the PAN.
+    xml_accessor :last_four, :from =>"lastFour"
+   
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :brand_name => :brandName ,
+        :card_holder_name => :cardHolderName ,
+        :card_id => :cardId ,
+        :default => :default ,
+        :expiry_year => :expiryYear ,
+        :expiry_month => :expiryMonth ,
+        :last_four => :lastFour 
+        
+      }
+    end
+
+    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}
+
+      
+      if attributes.has_key?(:brand_name)
+        self.brand_name = attributes[:brand_name]
+      end
+      
+      if attributes.has_key?(:card_holder_name)
+        self.card_holder_name = attributes[:card_holder_name]
+      end
+      
+      if attributes.has_key?(:card_id)
+        self.card_id = attributes[:card_id]
+      end
+      
+      if attributes.has_key?(:default)
+        self.default = attributes[:default]
+      end
+      
+      if attributes.has_key?(:expiry_year)
+        self.expiry_year = attributes[:expiry_year]
+      end
+      
+      if attributes.has_key?(:expiry_month)
+        self.expiry_month = attributes[:expiry_month]
+      end
+      
+      if attributes.has_key?(:last_four)
+        self.last_four = attributes[:last_four]
+      end
+      
+    end
+    
+ 
+	
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          brand_name == o.brand_name &&
+          card_holder_name == o.card_holder_name &&
+          card_id == o.card_id &&
+          default == o.default &&
+          expiry_year == o.expiry_year &&
+          expiry_month == o.expiry_month &&
+          last_four == o.last_four
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [brand_name, card_holder_name, card_id, default, expiry_year, expiry_month, last_four].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
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      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 = MastercardMerchantCheckout.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(include_root = false)
+      attributes_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
+      attributes_hash = include_root ? { "PreCheckoutCard" => hash } : hash  
+      return attributes_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
+    def after_parse
+      self.send(:remove_instance_variable, :@roxml_references) if defined? self.roxml_references
+    end
+    
+    # Attribute datatype mapping.
+    def self.datatype_map
+      {
+        :brand_name => 'String',
+        :card_holder_name => 'String',
+        :card_id => 'String',
+        :default => 'BOOLEAN',
+        :expiry_year => 'Integer',
+        :expiry_month => 'Integer',
+        :last_four => 'String'
+        
+      }
+    end
+  end
+
+
+end