mastercard_merchant_checkout 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d3013606b83bbc5205c1fb604e17c3bc39c09ad
+  data.tar.gz: dce52cdb88b5ebb3f90fd24cb85661a3450f45d0
+SHA512:
+  metadata.gz: 087a2cd184634dde1a36585a2b66e866157c607ebd12ecab21a7b6698e0ab5851886f726455701e3137f6f04fe95db0dbcabe36002a8b790b0625dbd57483b54
+  data.tar.gz: 82282ca011385ef0952a1ab19b75f077865af73fd5fb3ecd95d46933be272bfa6db528d270108507e6efc629763e5981793f7e17e0233e8e1b4f4510a66a33a8

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,73 @@
+# MastercardMerchantCheckout
+  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 Merchant Integration](https://developer.mastercard.com/documentation/masterpass-merchant-integration/v7).
+  
+## Features
+
+ Simplified merchant checkout flow with new Masterpass checkout API services.
+ 
+ Supports Masterpass Standard checkout.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mastercard_merchant_checkout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mastercard_merchant_checkout
+
+## Usage
+Set configurations for Consumer Key & Private Key from [Mastercard's developer's site](https://developer.mastercard.com/) to call Mastercard's checkout APIs: 
+
+```
+require 'mastercard_core_sdk'
+require 'mastercard_merchant_checkout'
+ 
+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 to true, Set sandbox to false to use Production environment.
+```
+
+## 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_merchant_checkout.rb

@@ -0,0 +1,32 @@
+# Common files
+require_relative 'mastercard_merchant_checkout/version'
+require_relative 'mastercard_merchant_checkout/tracker/sdk_api_tracker'
+
+# Models
+
+require_relative 'mastercard_merchant_checkout/models/payment_data'
+
+require_relative 'mastercard_merchant_checkout/models/card'
+
+require_relative 'mastercard_merchant_checkout/models/address'
+
+require_relative 'mastercard_merchant_checkout/models/personal_info'
+
+require_relative 'mastercard_merchant_checkout/models/postback'
+
+require_relative 'mastercard_merchant_checkout/models/authentication_options'
+
+
+# APIs
+
+
+require_relative 'mastercard_merchant_checkout/api/postback_api'
+
+require_relative 'mastercard_merchant_checkout/api/payment_data_api'
+
+
+
+
+module MastercardMerchantCheckout
+  
+end

data/lib/mastercard_merchant_checkout/api/payment_data_api.rb

@@ -0,0 +1,40 @@
+require 'uri'
+require 'mastercard_core_sdk'
+require_relative '../../mastercard_merchant_checkout/models/payment_data'
+ 
+
+module MastercardMerchantCheckout
+ module Api
+
+  class PaymentDataApi
+    include MastercardCoreSdk::Core, MastercardCoreSdk::Client, MastercardCoreSdk::Exceptions
+	  include MastercardMerchantCheckout::Tracker
+
+
+    # PaymentData Service
+    # This service is used to retrieve the consumer's payment, shipping address, and recipient personal information from Masterpass.
+    # @param transaction_id This is a transaction identifier.
+    # @param query_params The query parameters.
+    # @param api_config Optional ApiConfig object specifying configuration : consumer key, private key, host URL. 
+    # @return [PaymentData]
+    def self.show(transaction_id, query_params, api_config = nil)
+		 path = "/masterpass/paymentdata/{transactionId}"
+	 	 service_request = ServiceRequest.new
+     service_request.path_params["transactionId"] = transaction_id
+	 
+	   
+	 service_request.query_params = query_params
+	   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_merchant_checkout/api/postback_api.rb

@@ -0,0 +1,39 @@
+require 'uri'
+require 'mastercard_core_sdk'
+require_relative '../../mastercard_merchant_checkout/models/postback'
+ 
+
+module MastercardMerchantCheckout
+ module Api
+
+  class PostbackApi
+    include MastercardCoreSdk::Core, MastercardCoreSdk::Client, MastercardCoreSdk::Exceptions
+	  include MastercardMerchantCheckout::Tracker
+
+
+    # Postback Service
+    # The final step of the Masterpass transaction, Masterpass Postback is a service call from the merchant to Masterpass communicating the result of the transaction (success or failure). This is a mandatory step. Abandoned transactions do not need to be reported.
+    # @param postback This is the merchant's transaction details.
+    # @param api_config Optional ApiConfig object specifying configuration : consumer key, private key, host URL. 
+    # @return [nil]
+    def self.create(postback, api_config = nil)
+		 path = "/masterpass/postback"
+	 	 service_request = ServiceRequest.new
+     
+	   
+	   service_request.body = postback
+	 
+	   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, "POST",nil)
+    end
+
+  end
+
+ end
+end
+
+
+

data/lib/mastercard_merchant_checkout/models/address.rb

@@ -0,0 +1,255 @@
+require 'date'
+require 'roxml'
+ 
+
+module MastercardMerchantCheckout
+  # 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 line 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 =~ /^(true|t|yes|y|1)$/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 ? { "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