mastercard_psp_payment 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82a7ceb0830b93a631af697f53a0b62c8366ac9d
+  data.tar.gz: 13b97bd9370ec0d1ee2407469873c3f7cdef8812
+SHA512:
+  metadata.gz: 67e7da3fe5e72ad0f1a51482a9a4ff15d63ccedc3f550a75969adfdc322f34a567aa8740450f3e9d066bf44343bfb86f7cb7dd88529b107094b1d1b09d516169
+  data.tar.gz: d30874fbc593b13ea98e8aebe67d4ce42e84c432ea9cfc88ec93f7843762db241d36e25c448ced4ca0f508e8cfb97149075c5ed467e583bf2456e9cf950041a2

data/LICENSE.txt

@@ -0,0 +1,24 @@
+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:
+
+Redistributions of source code must retain the above copyright notice, this list of 
+conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of 
+conditions and the following disclaimer in the documentation and/or other materials 
+provided with the distribution.
+Neither the name of the MasterCard International Incorporated nor the names of its 
+contributors may be used to endorse or promote products derived from this software 
+without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
+SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,53 @@
+# MastercardPspPayment
+Masterpass™ is Mastercard’s integrated digital wallet and checkout solution.
+Masterpass enables consumers to store and manage their payment, shipping, and loyalty program information in their Masterpass Wallet, and to quickly and seamlessly access this information to make secure payments wherever they see the "Buy with MasterPass" button on a merchant website or mobile application.
+
+From a cardholder's perspective, Masterpass significantly speeds up the checkout process, removing the need to re-enter payment, shipping or loyalty program details during checkout.
+The Masterpass solution is simple, secure and easy for merchants to integrate into their existing website or application.
+  
+For more information, refer [Masterpass PSP Integration](https://developer.mastercard.com/documentation/masterpass-integration-psp).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mastercard_psp_payment'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mastercard_psp_payment
+
+
+## Copyright
+Copyright (c) 2017, Mastercard International Incorporated. See LICENSE for details.
+
+## LICENSE
+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:
+
+Redistributions of source code must retain the above copyright notice, this list of 
+conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of 
+conditions and the following disclaimer in the documentation and/or other materials 
+provided with the distribution.
+Neither the name of the Mastercard International Incorporated nor the names of its 
+contributors may be used to endorse or promote products derived from this software 
+without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
+SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
+SUCH DAMAGE.

data/lib/mastercard_psp_payment/api/psp_payment_data_api.rb

@@ -0,0 +1,36 @@
+require 'uri'
+require 'mastercard_core_sdk'
+require_relative '../../mastercard_psp_payment/models/payment_data'
+ 
+
+module MastercardPspPayment
+ module Api
+
+  class PSPPaymentDataApi
+    include MastercardCoreSdk::Core, MastercardCoreSdk::Client, MastercardCoreSdk::Exceptions
+	  include MastercardPspPayment::Tracker
+
+
+    # PSP PaymentData Service : 
+    # This service is used by PSP to retrieve the consumer's payment, shipping address, and personal information.
+    # @param transaction_id This is a transaction identifier.
+    # @param api_config Optional ApiConfig object specifying configuration : consumer key, private key, host URL. 
+    # @return [PaymentData]
+    def self.show(transaction_id, api_config = nil)
+		 path = "/masterpass/psp-paymentdata/{transactionId}"
+	 	 service_request = ServiceRequest.new
+     service_request.path_params["transactionId"] = transaction_id
+	   service_request.content_type = "application/json"
+	   api_client = ApiClient.new(api_config)
+     api_client.api_tracker = SdkApiTracker.new
+     api_client.error_handler = ErrorHandler.new
+	   return api_client.call(path, service_request, "GET",PaymentData)
+    end
+
+  end
+
+ end
+end
+
+
+

data/lib/mastercard_psp_payment/models/address.rb

@@ -0,0 +1,255 @@
+require 'date'
+require 'roxml'
+ 
+
+module MastercardPspPayment
+  # This class contains methods to get the consumer's address details.
+  class Address
+    include ROXML
+    
+    xml_name "Address"
+    
+    # @!attribute city
+    # @return [String] the cardholder's city.
+    xml_accessor :city, :from =>"city"
+   
+    # @!attribute country
+    # @return [String] the cardholder's country as defined by ISO 3166-1 alpha-2 digit country codes; for example, US is the United States, AU is Australia, CA is Canada, GB is the United Kingdom, and so on.
+    xml_accessor :country, :from =>"country"
+   
+    # @!attribute subdivision
+    # @return [String] the cardholder's country's subdivision as defined by ISO 3166-1 alpha-2 digit code; for example, US-VA is Virginia, US-OH is Ohio, and so on.
+    xml_accessor :subdivision, :from =>"subdivision"
+   
+    # @!attribute line1
+    # @return [String] the address in line 1 is used for the street number and the street name.
+    xml_accessor :line1, :from =>"line1"
+   
+    # @!attribute line2
+    # @return [String] the address in line 2 is used for the apartment number, suite number, and so on.
+    xml_accessor :line2, :from =>"line2"
+   
+    # @!attribute line3
+    # @return [String] the address in line 3 is used to enter the remaining address information if it does not fit in lines 1 and 2.
+    xml_accessor :line3, :from =>"line3"
+   
+    # @!attribute line4
+    # @return [String] the address in line 4 is used to enter the remaining address information if it does not fit in lines 1, 2 and 3.
+    xml_accessor :line4, :from =>"line4"
+   
+    # @!attribute line5
+    # @return [String] the address in line 5 is used to enter the remaining address information if it does not fit in lines 1,2,3 and 4.
+    xml_accessor :line5, :from =>"line5"
+   
+    # @!attribute postal_code
+    # @return [String] the postal code or zip code appended to the mailing address for the purpose of sorting mail.
+    xml_accessor :postal_code, :from =>"postalCode"
+   
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :city => :city ,
+        :country => :country ,
+        :subdivision => :subdivision ,
+        :line1 => :line1 ,
+        :line2 => :line2 ,
+        :line3 => :line3 ,
+        :line4 => :line4 ,
+        :line5 => :line5 ,
+        :postal_code => :postalCode 
+        
+      }
+    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?(:city)
+        self.city = attributes[:city]
+      end
+      
+      if attributes.has_key?(:country)
+        self.country = attributes[:country]
+      end
+      
+      if attributes.has_key?(:subdivision)
+        self.subdivision = attributes[:subdivision]
+      end
+      
+      if attributes.has_key?(:line1)
+        self.line1 = attributes[:line1]
+      end
+      
+      if attributes.has_key?(:line2)
+        self.line2 = attributes[:line2]
+      end
+      
+      if attributes.has_key?(:line3)
+        self.line3 = attributes[:line3]
+      end
+      
+      if attributes.has_key?(:line4)
+        self.line4 = attributes[:line4]
+      end
+      
+      if attributes.has_key?(:line5)
+        self.line5 = attributes[:line5]
+      end
+      
+      if attributes.has_key?(:postal_code)
+        self.postal_code = attributes[:postal_code]
+      end
+      
+    end
+    
+ 
+	
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          city == o.city &&
+          country == o.country &&
+          subdivision == o.subdivision &&
+          line1 == o.line1 &&
+          line2 == o.line2 &&
+          line3 == o.line3 &&
+          line4 == o.line4 &&
+          line5 == o.line5 &&
+          postal_code == o.postal_code
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [city, country, subdivision, line1, line2, line3, line4, line5, postal_code].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 = MastercardPspPayment.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 ? { "Address" => 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
+      {
+        :city => 'String',
+        :country => 'String',
+        :subdivision => 'String',
+        :line1 => 'String',
+        :line2 => 'String',
+        :line3 => 'String',
+        :line4 => 'String',
+        :line5 => 'String',
+        :postal_code => 'String'
+        
+      }
+    end
+  end
+
+
+end

data/lib/mastercard_psp_payment/models/authentication_options.rb

@@ -0,0 +1,255 @@
+require 'date'
+require 'roxml'
+ 
+
+module MastercardPspPayment
+  # This class contains methods to set different authentication options required during DSRP.
+  class AuthenticationOptions
+    include ROXML
+    
+    xml_name "AuthenticationOptions"
+    
+    # @!attribute authenticate_method
+    # @return [String] the method used to authenticate the cardholder at checkout. Valid values are MERCHANT ONLY, 3DS and No Authentication.
+    xml_accessor :authenticate_method, :from =>"authenticateMethod"
+   
+    # @!attribute card_enrollment_method
+    # @return [String] the method by which the card was added to the wallet. Valid values are: Manual Direct Provisioned 3DS Manual NFC Tap.
+    xml_accessor :card_enrollment_method, :from =>"cardEnrollmentMethod"
+   
+    # @!attribute c_avv
+    # @return [String] the (CAVV) Cardholder Authentication Verification Value generated by card issuer upon successful authentication of the cardholder. This must be passed in the authorization message.
+    xml_accessor :c_avv, :from =>"cAvv"
+   
+    # @!attribute eci_flag
+    # @return [String] the Electronic commerce indicator (ECI) flag. Possible values are as follows: Mastercard: 00:No Authentication 01:Attempts (Card Issuer Liability) 02:Authenticated by ACS (Card Issuer Liability) 03:Maestro (MARP) 05:Risk Based Authentication (Issuer, not in use) 06:Risk Based Authentication (Merchant, not in use) Visa: 05:Authenticated (Card Issuer Liability) 06:Attempts (Card Issuer Liability) 07:No 3DS Authentication (Merchant Liability)
+    xml_accessor :eci_flag, :from =>"eciFlag"
+   
+    # @!attribute master_card_assigned_id
+    # @return [String] the value assigned by Mastercard and represents programs associated directly with Maestro cards. This field should be supplied in the authorization request by the merchant.
+    xml_accessor :master_card_assigned_id, :from =>"masterCardAssignedID"
+   
+    # @!attribute pa_res_status
+    # @return [String] the message formatted, digitally signed, and sent from the ACS (issuer) to the MPI providing the results of the issuer's Mastercard SecureCode/Verified by Visa cardholder authentication. Possible values are: Y-The card was successfully authenticated via 3-D Secure A-signifies that either (a) the transaction was successfully authenticated via a 3-D Secure attempts transaction or (b)the cardholder was prompted to activate 3-D Secure during shopping but declined (Visa). U-Authentication results were unavailable.
+    xml_accessor :pa_res_status, :from =>"paResStatus"
+   
+    # @!attribute sc_enrollment_status
+    # @return [String] the Mastercard SecureCode Enrollment Status. Indicates if the issuer of the card supports payer authentication for this card. Possible values are as follows: Y-The card is eligible for 3-D Secure authentication. N-The card is not eligible for 3-D Secure authentication. U-Lookup of the card's 3-D Secure eligibility status was either unavailable, or the card is inapplicable (for example, prepaid cards).
+    xml_accessor :sc_enrollment_status, :from =>"scEnrollmentStatus"
+   
+    # @!attribute signature_verification
+    # @return [String] the signature verification. Possible values are as follows: Y-Indicates that the signature of the PaRes has been validated successfully and the message contents can be trusted. N-Indicates that for a variety of reasons (tampering, certificate expiration, and so on) the PaRes could not be validated, and the result should not be trusted.
+    xml_accessor :signature_verification, :from =>"signatureVerification"
+   
+    # @!attribute xid
+    # @return [String] the transaction identifier resulting from authentication processing.
+    xml_accessor :xid, :from =>"xid"
+   
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :authenticate_method => :authenticateMethod ,
+        :card_enrollment_method => :cardEnrollmentMethod ,
+        :c_avv => :cAvv ,
+        :eci_flag => :eciFlag ,
+        :master_card_assigned_id => :masterCardAssignedID ,
+        :pa_res_status => :paResStatus ,
+        :sc_enrollment_status => :scEnrollmentStatus ,
+        :signature_verification => :signatureVerification ,
+        :xid => :xid 
+        
+      }
+    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?(:authenticate_method)
+        self.authenticate_method = attributes[:authenticate_method]
+      end
+      
+      if attributes.has_key?(:card_enrollment_method)
+        self.card_enrollment_method = attributes[:card_enrollment_method]
+      end
+      
+      if attributes.has_key?(:c_avv)
+        self.c_avv = attributes[:c_avv]
+      end
+      
+      if attributes.has_key?(:eci_flag)
+        self.eci_flag = attributes[:eci_flag]
+      end
+      
+      if attributes.has_key?(:master_card_assigned_id)
+        self.master_card_assigned_id = attributes[:master_card_assigned_id]
+      end
+      
+      if attributes.has_key?(:pa_res_status)
+        self.pa_res_status = attributes[:pa_res_status]
+      end
+      
+      if attributes.has_key?(:sc_enrollment_status)
+        self.sc_enrollment_status = attributes[:sc_enrollment_status]
+      end
+      
+      if attributes.has_key?(:signature_verification)
+        self.signature_verification = attributes[:signature_verification]
+      end
+      
+      if attributes.has_key?(:xid)
+        self.xid = attributes[:xid]
+      end
+      
+    end
+    
+ 
+	
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          authenticate_method == o.authenticate_method &&
+          card_enrollment_method == o.card_enrollment_method &&
+          c_avv == o.c_avv &&
+          eci_flag == o.eci_flag &&
+          master_card_assigned_id == o.master_card_assigned_id &&
+          pa_res_status == o.pa_res_status &&
+          sc_enrollment_status == o.sc_enrollment_status &&
+          signature_verification == o.signature_verification &&
+          xid == o.xid
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [authenticate_method, card_enrollment_method, c_avv, eci_flag, master_card_assigned_id, pa_res_status, sc_enrollment_status, signature_verification, xid].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 = MastercardPspPayment.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 ? { "AuthenticationOptions" => 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
+      {
+        :authenticate_method => 'String',
+        :card_enrollment_method => 'String',
+        :c_avv => 'String',
+        :eci_flag => 'String',
+        :master_card_assigned_id => 'String',
+        :pa_res_status => 'String',
+        :sc_enrollment_status => 'String',
+        :signature_verification => 'String',
+        :xid => 'String'
+        
+      }
+    end
+  end
+
+
+end