hps 2.2.5 → 2.3.2

data/lib/hps/entities/hps_gift_card.rb

@@ -0,0 +1,133 @@
+module Hps
+  #  ===============
+  #  = HpsGiftCard =
+  #  ===============
+  class HpsGiftCard
+    attr_accessor :number, :track_data, :alias, :token_value,
+                  :encryption_data, :pin
+
+    def initialize(number = nil)
+      self.number = number
+    end
+  end # HpsGiftCard
+
+  #  =======================
+  #  = HpsGiftCardActivate =
+  #  =======================
+  class HpsGiftCardActivate < HpsTransaction
+    # Values used in the card activate response
+    attr_accessor :authorization_code, :balance_amount, :points_balance_amount
+
+    # The rewards (dollars or points) added to the account as
+    # a result of the transaction
+    attr_accessor :rewards
+
+    # Notes contain reward messages to be displayed on a receipt,
+    # mobile app, or web page to inform an account holder about
+    # special rewards or promotions available on their account
+    attr_accessor :notes
+
+    def self.from_response(response, txn_type, return_type = nil)
+      activation_response = response['Transaction'][txn_type]
+
+      activation = return_type ? return_type.constantize.new : self.new
+
+      activation.transaction_id = response['Header']['GatewayTxnId']
+      activation.authorization_code = activation_response['AuthCode']
+      activation.balance_amount = activation_response['BalanceAmt']
+      activation.points_balance_amount = activation_response['PointsBalanceAmt']
+      activation.rewards = activation_response['Rewards']
+      activation.notes = activation_response['Notes']
+      activation.response_code = activation_response['RspCode']
+      activation.response_text = activation_response['RspText']
+
+      return activation
+    end # from_response
+  end # HpsGiftCardActivate
+
+  #  =========================
+  #  = HpsGiftCardDeactivate =
+  #  =========================
+  class HpsGiftCardDeactivate < HpsGiftCardActivate
+
+  end # HpsGiftCardDeactivate
+
+  #  ======================
+  #  = HpsGiftCardReplace =
+  #  ======================
+  class HpsGiftCardReplace < HpsGiftCardActivate
+
+  end # HpsGiftCardReplace
+
+  #  =======================
+  #  = HpsGiftCardReversal =
+  #  =======================
+  class HpsGiftCardReversal < HpsGiftCardActivate
+
+  end # HpsGiftCardReversal
+
+  #  =====================
+  #  = HpsGiftCardReward =
+  #  =====================
+  class HpsGiftCardReward < HpsGiftCardActivate
+
+  end # HpsGiftCardReward
+
+  #  ======================
+  #  = HpsGiftCardBalance =
+  #  ======================
+  class HpsGiftCardBalance < HpsGiftCardActivate
+
+  end # HpsGiftCardBalance
+
+  #  =======================
+  #  = HpsGiftCardAddValue =
+  #  =======================
+  class HpsGiftCardAddValue < HpsGiftCardActivate
+
+  end # HpsGiftCardAddValue
+
+  #  ===================
+  #  = HpsGiftCardVoid =
+  #  ===================
+  class HpsGiftCardVoid < HpsGiftCardActivate
+
+  end # HpsGiftCardVoid
+
+  #  ===================
+  #  = HpsGiftCardSale =
+  #  ===================
+  class HpsGiftCardSale < HpsGiftCardActivate
+    attr_accessor :split_tender_card_amount, :split_tender_balance_due
+
+    def self.from_response(response, txn_type)
+      transaction = response['Transaction']
+
+      sale = self.superclass.from_response(response, txn_type, self.name)
+
+      sale.split_tender_card_amount = transaction['SplitTenderCardAmt']
+      sale.split_tender_balance_due = transaction['SplitTenderBalanceDueAmt']
+
+      return sale
+    end # from_response
+  end # HpsGiftCardSale
+
+  #  ====================
+  #  = HpsGiftCardAlias =
+  #  ====================
+  class HpsGiftCardAlias < HpsTransaction
+    attr_accessor :gift_card
+
+    def self.from_response(response, txn_type)
+      alias_response = response['Transaction'][txn_type]
+
+      alias_item = HpsGiftCardAlias.new
+      alias_item.transaction_id = response['Header']['GatewayTxnId']
+      alias_item.gift_card = HpsGiftCard.new(alias_response['CardData'])
+      alias_item.response_code = alias_response['RspCode']
+      alias_item.response_text = alias_response['RspText']
+
+      return alias_item
+    end # from_response
+  end # HpsGiftCardAlias
+end # Hps

data/lib/hps/infrastructure/exceptions.json

@@ -1,7 +1,81 @@
 {
-   "version": "1.0.0",
-   
+   "version": "1.0.1",
+
    "exception_mappings":[
+      {
+        "object":"exception_mapping",
+        "category":"gift",
+        "exception_codes":[
+            "3",
+            "8"
+        ],
+        "mapping_type":"CardException",
+        "mapping_code":"invalid_card_data",
+        "mapping_message":"Exception_Message_InvalidCardData"
+      },
+      {
+        "object":"exception_mapping",
+        "category":"gift",
+        "exception_codes":[
+            "4"
+        ],
+        "mapping_type":"CardException",
+        "mapping_code":"expired_card",
+        "mapping_message":"Exception_Message_CardExpired"
+      },
+      {
+        "object":"exception_mapping",
+        "category":"gift",
+        "exception_codes":[
+            "5",
+            "12"
+        ],
+        "mapping_type":"CardException",
+        "mapping_code":"card_declined",
+        "mapping_message":"Exception_Message_CardDeclined"
+      },
+      {
+        "object":"exception_mapping",
+        "category":"gift",
+        "exception_codes":[
+            "6",
+            "7",
+            "10"
+        ],
+        "mapping_type":"CardException",
+        "mapping_code":"processing_error",
+        "mapping_message":"Exception_Message_ProcessingError"
+      },
+      {
+        "object":"exception_mapping",
+        "category":"gift",
+        "exception_codes":[
+            "9"
+        ],
+        "mapping_type":"CardException",
+        "mapping_code":"invalid_amount",
+        "mapping_message":"Exception_Message_ChargeAmount"
+      },
+      {
+        "object":"exception_mapping",
+        "category":"gift",
+        "exception_codes":[
+            "13"
+        ],
+        "mapping_type":"CardException",
+        "mapping_code":"partial_approval",
+        "mapping_message":"Exception_Message_PartialApproval"
+      },
+      {
+        "object":"exception_mapping",
+        "category":"gift",
+        "exception_codes":[
+            "14"
+        ],
+        "mapping_type":"CardException",
+        "mapping_code":"invalid_pin",
+        "mapping_message":"Exception_Message_InvalidPin"
+      },
       {
          "object":"exception_mapping",
          "category":"issuer",
@@ -332,6 +406,11 @@
          "mapping_type":"CardException",
          "mapping_code":"processing_error",
          "mapping_message":"Exception_Message_ProcessingError"
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_PartialApproval",
+         "message":"The amount was partially approved."
       }
    ],
    "exception_messages":[

data/lib/hps/infrastructure/hps_exception_mapper.rb

@@ -7,7 +7,7 @@ module Hps
 
 		def initialize
 			path = File.join( File.dirname(__FILE__), "exceptions.json")
-			
+
 			File.open(path, "r") do |f|
 				@exceptions = JSON.load(f)
 			end
@@ -23,22 +23,33 @@ module Hps
 
 			unless mapping.nil?
 				message = message_for_mapping(mapping, response_text)
-				code = mapping["mapping_code"]			
-				return CardException.new(transaction_id, code, message)				
+				code = mapping["mapping_code"]
+				return CardException.new(transaction_id, code, message)
 			else
 				return CardException.new(transaction_id, "unknown_card_exception", response_text)
 			end
 
 		end
 
+		def map_gift_card_exception(transaction_id, response_code, response_text)
+		 mapping = exception_for_category_and_code("gift", response_code)
+		 unless mapping.nil?
+			 message = message_for_mapping(mapping, response_text)
+			 code = mapping["mapping_code"]
+			 return CardException.new(transaction_id, code, message)
+		 else
+			 return CardException.new(transaction_id, "unknown_card_exception", response_text)
+		 end
+	 end
+
 		def map_gateway_exception(transaction_id, response_code, response_text)
 
 			mapping = exception_for_category_and_code("gateway", response_code)
 			message = message_for_mapping(mapping, response_text)
-      
+
 			unless mapping.nil?
 
-				code = mapping["mapping_code"]	
+				code = mapping["mapping_code"]
 				exception_type = mapping["mapping_type"]
 
 				if exception_type == "AuthenticationException"
@@ -52,10 +63,10 @@ module Hps
 				elsif exception_type == "InvalidRequestException"
 
 					return InvalidRequestException.new(message, mapping["param"], code)
-				
+
 				elsif !code.nil?
 
-					return HpsException.new(response_text, code)			
+					return HpsException.new(response_text, code)
 
 				end
 
@@ -78,8 +89,8 @@ module Hps
 			unless mapping.nil?
 
 					message = message_for_mapping(mapping, response_text)
-					code = mapping["mapping_code"]	
-					exception_type = mapping["mapping_type"]	
+					code = mapping["mapping_code"]
+					exception_type = mapping["mapping_type"]
 
 					if exception_type == "InvalidRequestException"
 
@@ -88,12 +99,12 @@ module Hps
 					elsif exception_type == "ApiConnectionException"
 
 						return ApiConnectionException.new(message, inner_exception, code)
-					
+
 					elsif !code.nil?
 
-						return HpsException.new(message, code)			
+						return HpsException.new(message, code)
 
-					end						
+					end
 
 			end
 
@@ -111,7 +122,7 @@ module Hps
 
 			unless message.nil?
 
-				mapping_message = @exceptions["exception_messages"].detect { |m| 			
+				mapping_message = @exceptions["exception_messages"].detect { |m|
 					m["code"] == message
 				}
 
@@ -125,8 +136,8 @@ module Hps
 
 		def exception_for_category_and_code(category, code)
 
-			@exceptions["exception_mappings"].detect { |m| 
-				m["category"] == category and m["exception_codes"].include?(code.to_s) 
+			@exceptions["exception_mappings"].detect { |m|
+				m["category"] == category and m["exception_codes"].include?(code.to_s)
 			}
 
 		end

data/lib/hps/infrastructure/hps_input_validation.rb

@@ -2,7 +2,7 @@ module Hps
   class HpsInputValidation
     def self.check_amount(amount)
       if amount < 0 || amount == nil
-        raise InvalidRequestException
+        raise InvalidRequestException.new "Amount must be greater than or equal 0."
       end
 
       return amount if amount.is_a? Float

data/lib/hps/services/hps_gift_card_service.rb

@@ -0,0 +1,301 @@
+module Hps
+  class HpsGiftCardService < HpsService
+    def activate(giftcard, amount, currency = "USD")
+      HpsInputValidation.check_amount(amount)
+      txn_type = "GiftCardActivate"
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps txn_type.to_sym do
+          xml.hps :Block1 do
+            xml.hps :Amt, amount
+
+            if giftcard.is_a? HpsTokenData
+              card_data = HpsGiftCard.new
+              card_data.token_value = giftcard.token_value
+            else
+              card_data = giftcard
+            end
+
+            hydrate_gift_card_data(giftcard, xml)
+          end
+        end
+      end
+      submit_transaction(xml.target!, txn_type)
+    end # activate
+
+    def add_value(giftcard, amount, currency = "USD")
+      HpsInputValidation.check_amount(amount)
+      txn_type = "GiftCardAddValue"
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps txn_type.to_sym do
+          xml.hps :Block1 do
+            xml.hps :Amt, amount
+
+            if giftcard.is_a? HpsTokenData
+              card_data = HpsGiftCard.new
+              card_data.token_value = giftcard.token_value
+            else
+              card_data = giftcard
+            end
+
+            hydrate_gift_card_data(giftcard, xml)
+          end
+        end
+      end
+      submit_transaction(xml.target!, txn_type)
+    end # add_value
+
+    def balance(giftcard)
+      txn_type = "GiftCardBalance"
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps txn_type.to_sym do
+          xml.hps :Block1 do
+
+            if giftcard.is_a? HpsTokenData
+              card_data = HpsGiftCard.new
+              card_data.token_value = giftcard.token_value
+            else
+              card_data = giftcard
+            end
+
+            hydrate_gift_card_data(giftcard, xml)
+          end
+        end
+      end
+      submit_transaction(xml.target!, txn_type)
+    end # balance
+
+    def deactivate(giftcard)
+      txn_type = "GiftCardDeactivate"
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps txn_type.to_sym do
+          xml.hps :Block1 do
+
+            if giftcard.is_a? HpsTokenData
+              card_data = HpsGiftCard.new
+              card_data.token_value = giftcard.token_value
+            else
+              card_data = giftcard
+            end
+
+            hydrate_gift_card_data(giftcard, xml)
+          end
+        end
+      end
+      submit_transaction(xml.target!, txn_type)
+    end # deactivate
+
+    def replace(old_card, new_card)
+      txn_type = "GiftCardReplace"
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps txn_type.to_sym do
+          xml.hps :Block1 do
+
+            hydrate_gift_card_data(old_card, xml, 'OldCardData')
+            hydrate_gift_card_data(new_card, xml, 'NewCardData')
+
+          end
+        end
+      end
+      submit_transaction(xml.target!, txn_type)
+    end # replace
+
+    def reward(giftcard, amount, currency = "USD", gratuity = nil, tax = nil)
+      HpsInputValidation.check_amount(amount)
+      txn_type = "GiftCardReward"
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps txn_type.to_sym do
+          xml.hps :Block1 do
+            xml.hps :Amt, amount
+
+            if giftcard.is_a? HpsTokenData
+              card_data = HpsGiftCard.new
+              card_data.token_value = giftcard.token_value
+            else
+              card_data = giftcard
+            end
+
+            hydrate_gift_card_data(giftcard, xml)
+
+            if ["USD", "POINTS"].include? currency.upcase
+              xml.hps :Currency, currency.upcase
+            end
+
+            if gratuity
+              xml.hps :GratuityAmtInfo, gratuity
+            end
+
+            if tax
+              xml.hps :TaxAmtInfo, tax
+            end
+
+          end
+        end
+      end
+      submit_transaction(xml.target!, txn_type)
+    end # reward
+
+    def sale(giftcard, amount, currency = "USD", gratuity = nil, tax = nil)
+      HpsInputValidation.check_amount(amount)
+      txn_type = "GiftCardSale"
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps txn_type.to_sym do
+          xml.hps :Block1 do
+            xml.hps :Amt, amount
+
+            if giftcard.is_a? HpsTokenData
+              card_data = HpsGiftCard.new
+              card_data.token_value = giftcard.token_value
+            else
+              card_data = giftcard
+            end
+
+            hydrate_gift_card_data(giftcard, xml)
+
+            if ["USD", "POINTS"].include? currency.upcase
+              xml.hps :Currency, currency.upcase
+            end
+
+            if gratuity
+              xml.hps :GratuityAmtInfo, gratuity
+            end
+
+            if tax
+              xml.hps :TaxAmtInfo, tax
+            end
+
+          end
+        end
+      end
+      submit_transaction(xml.target!, txn_type)
+    end # sale
+
+    def void(txn_id)
+      txn_type = "GiftCardVoid"
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps txn_type.to_sym do
+          xml.hps :Block1 do
+            xml.hps :GatewayTxnId, txn_id
+          end
+        end
+      end
+      submit_transaction(xml.target!, txn_type)
+    end # void
+
+    def reverse(giftcard, amount)
+      HpsInputValidation.check_amount(amount)
+      txn_type = "GiftCardReversal"
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps txn_type.to_sym do
+          xml.hps :Block1 do
+            xml.hps :Amt, amount
+
+            if giftcard.is_a? HpsTokenData
+              xml.hps :TokenValue, giftcard.token_value
+            elsif giftcard.is_a? HpsGiftCard
+              card_data = giftcard
+              hydrate_gift_card_data(card_data, xml)
+            else
+              xml.hps :GatewayTxnId, giftcard
+            end
+
+          end
+        end
+      end
+      submit_transaction(xml.target!, txn_type)
+    end # reverse
+
+    private
+      def hydrate_gift_card_data(gift_card, xml, element_name = 'CardData')
+        xml.hps element_name.to_sym do
+          if gift_card.number
+            xml.hps :CardNbr, gift_card.number
+          elsif gift_card.track_data
+            xml.hps :TrackData, gift_card.track_data
+          elsif gift_card.alias
+            xml.hps :Alias, gift_card.alias
+          elsif gift_card.token_value
+            xml.hps :TokenValue, gift_card.token_value
+          end
+
+          if gift_card.encryption_data
+            hydrate_encryption_data(gift_card.encryption_data, xml)
+          end
+
+          if gift_card.pin
+            xml.hps :PIN, gift_card.pin
+          end
+        end
+      end # hydrate_gift_card_data
+
+    def hydrate_encryption_data(encryption_data, xml)
+      xml.hps :EncryptionData do
+        if encryption_data.encrypted_track_number
+          xml.hps :EncryptedTrackNumber, encryption_data.encrypted_track_number
+        end
+        xml.hps :KSN, encryption_data.ksn
+        xml.hps :KTB, encryption_data.ktb
+        xml.hps :Version, encryption_data.version
+      end
+    end # hydrate_encryption_data
+
+    def submit_transaction(transaction, txn_type, client_txn_id = nil)
+        response = doTransaction(transaction, client_txn_id)
+
+        header = response['Header']
+        transaction_response = response["Transaction"][txn_type]
+
+        if !transaction_response["RspCode"].eql? "0"
+          raise @exception_mapper.map_gift_card_exception(header["GatewayTxnId"], transaction_response["RspCode"], transaction_response["RspText"])
+        end
+
+        if !header["GatewayRspCode"].eql? "0"
+          raise @exception_mapper.map_gateway_exception(header["GatewayTxnId"], header["GatewayRspCode"], header["GatewayRspMsg"])
+        end
+
+        rvalue = ''
+        case txn_type
+          when 'GiftCardActivate'
+            rvalue = HpsGiftCardActivate::from_response(response, txn_type)
+          when 'GiftCardAddValue'
+            rvalue = HpsGiftCardAddValue::from_response(response, txn_type)
+          when 'GiftCardAlias'
+            rvalue = HpsGiftCardAlias::from_response(response, txn_type)
+          when 'GiftCardBalance'
+            rvalue = HpsGiftCardBalance::from_response(response, txn_type)
+          when 'GiftCardDeactivate'
+            rvalue = HpsGiftCardDeactivate::from_response(response, txn_type)
+          when 'GiftCardReplace'
+            rvalue = HpsGiftCardReplace::from_response(response, txn_type)
+          when 'GiftCardReward'
+            rvalue = HpsGiftCardReward::from_response(response, txn_type)
+          when 'GiftCardSale'
+            rvalue = HpsGiftCardSale::from_response(response, txn_type)
+          when 'GiftCardVoid'
+            rvalue = HpsGiftCardVoid::from_response(response, txn_type)
+          when 'GiftCardReversal'
+            rvalue = HpsGiftCardReversal::from_response(response, txn_type)
+        end
+
+        return rvalue;
+    end # submit_transaction
+
+  end # HpsGiftCardService
+end # Hps