mastercard_merchant_onboarding 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ebdb9bf7743d2836548774d0a41cdaf815462f5
+  data.tar.gz: 361e3becb40211e883dc35a345d76dadd3509176
+SHA512:
+  metadata.gz: 7bcfba174394afd64ee12aeddd4364f50fc98807e6aee2ec3255b3ef38004816952907b5f65f41c89ce353dd821fa3e9e88bed4cd3b46fea6db805e5d6edf19a
+  data.tar.gz: 08da190d3f450ca7538b6ff75f772a6d34b20456f2c97136b525da01b63acc75e66497aa83acf79cdf36e0d8af48c170f12021a569f892bddbd4849f0bc749ca

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2018, 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,56 @@
+# MastercardMerchantOnboarding
+  Masterpass™ is Mastercard’s integrated digital wallet and checkout solution.
+  MastercardMerchantOnboarding allows to onboard a single merchant to Masterpass™ in real time.
+  It can be used to complete the following tasks:
+  
+• Add an individual merchant to Masterpass.
+
+• Update an individual, existing Masterpass merchant record.
+
+• Delete an individual merchant record from Masterpass.
+
+  Masterpass then provides a real-time response to the API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mastercard_merchant_onboarding'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mastercard_merchant_onboarding
+
+## Copyright
+Copyright (c) 2018, Mastercard International Incorporated. See LICENSE for details.
+
+## LICENSE
+Copyright (c) 2018, 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_onboarding.rb

@@ -0,0 +1,58 @@
+# Common files
+require_relative 'mastercard_merchant_onboarding/version'
+require_relative 'mastercard_merchant_onboarding/tracker/sdk_api_tracker'
+
+# Models
+
+require_relative 'mastercard_merchant_onboarding/models/merchant_upload'
+
+require_relative 'mastercard_merchant_onboarding/models/merchant'
+
+require_relative 'mastercard_merchant_onboarding/models/profile'
+
+require_relative 'mastercard_merchant_onboarding/models/address'
+
+require_relative 'mastercard_merchant_onboarding/models/phone'
+
+require_relative 'mastercard_merchant_onboarding/models/emails'
+
+require_relative 'mastercard_merchant_onboarding/models/acquirer'
+
+require_relative 'mastercard_merchant_onboarding/models/reward_program'
+
+require_relative 'mastercard_merchant_onboarding/models/checkout_brand'
+
+require_relative 'mastercard_merchant_onboarding/models/auth_option'
+
+require_relative 'mastercard_merchant_onboarding/models/merchant_acquirer'
+
+require_relative 'mastercard_merchant_onboarding/models/merchant_acquirer_brand'
+
+require_relative 'mastercard_merchant_onboarding/models/extension_point'
+
+require_relative 'mastercard_merchant_onboarding/models/merchant_download'
+
+require_relative 'mastercard_merchant_onboarding/models/summary'
+
+require_relative 'mastercard_merchant_onboarding/models/project_key_type'
+
+require_relative 'mastercard_merchant_onboarding/models/merchant_response_record'
+
+require_relative 'mastercard_merchant_onboarding/models/validate_file_response'
+
+require_relative 'mastercard_merchant_onboarding/models/validated_merchant'
+
+
+# APIs
+
+
+require_relative 'mastercard_merchant_onboarding/api/single_merchant_validate_api'
+
+require_relative 'mastercard_merchant_onboarding/api/single_merchant_upload_api'
+
+
+
+
+module MastercardMerchantOnboarding
+  
+end

data/lib/mastercard_merchant_onboarding/api/single_merchant_upload_api.rb

@@ -0,0 +1,42 @@
+require 'uri'
+require 'mastercard_core_sdk'
+require_relative '../../mastercard_merchant_onboarding/models/merchant_upload'
+require_relative '../../mastercard_merchant_onboarding/models/merchant_download'
+ 
+
+module MastercardMerchantOnboarding
+ module Api
+
+  class SingleMerchantUploadApi
+    include MastercardCoreSdk::Core, MastercardCoreSdk::Client, MastercardCoreSdk::Exceptions
+	  include MastercardMerchantOnboarding::Tracker
+
+
+    # Single Merchant Upload Service
+    # This service is used by service providers to onboard merchant information one at a time to Masterpass through the project. Returns a MerchantDownload payload that will contain records of merchants that have, or have not, enabled 3-D Secure.
+    # @param project_id Identifier of project created in the Merchant Portal.
+    # @param merchant_upload Merchant upload request.
+    # @param api_config Optional ApiConfig object specifying configuration : consumer key, private key, host URL. 
+    # @return [MerchantDownload]
+    def self.create(project_id, merchant_upload, api_config = nil)
+		 path = "/masterpasspsp/v6/checkoutproject/{projectId}/file"
+	 	 service_request = ServiceRequest.new
+     service_request.path_params["projectId"] = project_id
+	 
+	   
+	   service_request.body = merchant_upload
+	 
+	   service_request.content_type = "application/xml"
+	   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",MerchantDownload)
+    end
+
+  end
+
+ end
+end
+
+
+

data/lib/mastercard_merchant_onboarding/api/single_merchant_validate_api.rb

@@ -0,0 +1,42 @@
+require 'uri'
+require 'mastercard_core_sdk'
+require_relative '../../mastercard_merchant_onboarding/models/merchant_upload'
+require_relative '../../mastercard_merchant_onboarding/models/validate_file_response'
+ 
+
+module MastercardMerchantOnboarding
+ module Api
+
+  class SingleMerchantValidateApi
+    include MastercardCoreSdk::Core, MastercardCoreSdk::Client, MastercardCoreSdk::Exceptions
+	  include MastercardMerchantOnboarding::Tracker
+
+
+    # Single Merchant Validate Service.
+    # This service is used by service providers to validate merchant upload prior to actual onboarding submission. This process mimics the validation XML process via the user interface used within the merchant portal. Returns a ValidateFileResponse payload that will contain 3DS and/or non-3DS merchant status records.
+    # @param project_id Identifier of project created in the Merchant Portal.
+    # @param merchant_upload Merchant upload request.
+    # @param api_config Optional ApiConfig object specifying configuration : consumer key, private key, host URL. 
+    # @return [ValidateFileResponse]
+    def self.create(project_id, merchant_upload, api_config = nil)
+		 path = "/masterpasspsp/v6/checkoutproject/{projectId}/file/validation"
+	 	 service_request = ServiceRequest.new
+     service_request.path_params["projectId"] = project_id
+	 
+	   
+	   service_request.body = merchant_upload
+	 
+	   service_request.content_type = "application/xml"
+	   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",ValidateFileResponse)
+    end
+
+  end
+
+ end
+end
+
+
+

data/lib/mastercard_merchant_onboarding/models/acquirer.rb

@@ -0,0 +1,225 @@
+require 'date'
+require 'roxml'
+require_relative '../../mastercard_merchant_onboarding/models/extension_point'
+ 
+
+module MastercardMerchantOnboarding
+  # This class contains merchant's acquirer details.
+  class Acquirer
+    include ROXML
+    
+    xml_name "Acquirer"
+    
+    # @!attribute action
+    # @return [String] the merchant acquirer action. Valid values are C(Create), U(Update), and D (Delete).
+    xml_accessor :action, :from =>"Action"
+   
+    # @!attribute id
+    # @return [String] the merchant's acquirer id. For example, 453214.
+    xml_accessor :id, :from =>"Id"
+   
+    # @!attribute name
+    # @return [String] the merchant's acquirer name. For example, Test Acquirer. 3DS merchants must reduce their character limit to 250 to meet Cardinal Commerce’s API specifications.
+    xml_accessor :name, :from =>"Name"
+   
+    # @!attribute assigned_merchant_id
+    # @return [String] the acquirer assigned merchant id. For example, 435t6543.
+    xml_accessor :assigned_merchant_id, :from =>"AssignedMerchantId"
+   
+    # @!attribute password
+    # @return [String] the acquirer password for 3DS setup. For example, Visa. 3DS merchants must reduce their character limit to 8 to meet Cardinal Commerce’s API specifications.
+    xml_accessor :password, :from =>"Password"
+   
+    # @!attribute extension_point
+    # @return [ExtensionPoint] the extension point for future enhancement.
+    xml_accessor :extension_point, :from =>"ExtensionPoint",:as => ExtensionPoint
+   
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :action => :Action ,
+        :id => :Id ,
+        :name => :Name ,
+        :assigned_merchant_id => :AssignedMerchantId ,
+        :password => :Password ,
+        :extension_point => :ExtensionPoint 
+        
+      }
+    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?(:action)
+        self.action = attributes[:action]
+      end
+      
+      if attributes.has_key?(:id)
+        self.id = attributes[:id]
+      end
+      
+      if attributes.has_key?(:name)
+        self.name = attributes[:name]
+      end
+      
+      if attributes.has_key?(:assigned_merchant_id)
+        self.assigned_merchant_id = attributes[:assigned_merchant_id]
+      end
+      
+      if attributes.has_key?(:password)
+        self.password = attributes[:password]
+      end
+      
+      if attributes.has_key?(:extension_point)
+        self.extension_point = attributes[:extension_point]
+      end
+      
+    end
+    
+ 
+	
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          action == o.action &&
+          id == o.id &&
+          name == o.name &&
+          assigned_merchant_id == o.assigned_merchant_id &&
+          password == o.password &&
+          extension_point == o.extension_point
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [action, id, name, assigned_merchant_id, password, 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 :Object
+      	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).to_sym] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = MastercardMerchantOnboarding.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 ? { "Acquirer" => 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
+      {
+        :action => 'String',
+        :id => 'String',
+        :name => 'String',
+        :assigned_merchant_id => 'String',
+        :password => 'String',
+        :extension_point => 'ExtensionPoint'
+        
+      }
+    end
+  end
+
+
+end