hps 2.2.5 → 2.4.0

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/entities/hps_manage_tokens.rb

@@ -1,9 +1,9 @@
-module Hps
-  class HpsManageTokens < HpsTransaction
-
-    def initialize(header)
-      super(header)
-    end
-
-  end
+module Hps
+  class HpsManageTokens < HpsTransaction
+
+    def initialize(header)
+      super(header)
+    end
+
+  end
 end

data/lib/hps/entities/hps_refund.rb

@@ -1,9 +1,9 @@
-module Hps
-	class HpsRefund < HpsTransaction
-
-		def initialize(header)
-			super(header)
-		end
-
-	end
+module Hps
+	class HpsRefund < HpsTransaction
+
+		def initialize(header)
+			super(header)
+		end
+
+	end
 end

data/lib/hps/entities/hps_report_transaction_details.rb

@@ -1,11 +1,11 @@
-module Hps
-	class HpsReportTransactionDetails < HpsAuthorization
-
-		attr_accessor :original_transaction_id, :masked_card_number, :transaction_type, :transaction_date, :exceptions
-
-		def initialize(header)
-			super(header)
-		end
-
-	end
+module Hps
+	class HpsReportTransactionDetails < HpsAuthorization
+
+		attr_accessor :original_transaction_id, :masked_card_number, :transaction_type, :transaction_date, :exceptions
+
+		def initialize(header)
+			super(header)
+		end
+
+	end
 end

data/lib/hps/entities/hps_report_transaction_summary.rb

@@ -1,7 +1,7 @@
-module Hps
-	class HpsReportTransactionSummary < HpsTransaction
-
-		attr_accessor :amount, :original_transaction_id, :masked_card_number, :transaction_type, :transaction_date, :exceptions
-
-	end
+module Hps
+	class HpsReportTransactionSummary < HpsTransaction
+
+		attr_accessor :amount, :original_transaction_id, :masked_card_number, :transaction_type, :transaction_date, :exceptions
+
+	end
 end

data/lib/hps/entities/hps_reversal.rb

@@ -1,11 +1,11 @@
-module Hps
-	class HpsReversal < HpsTransaction
-
-		attr_accessor :avs_result_code, :avs_result_text, :cvv_result_code, :cvv_result_text, :cpc_indicator
-
-		def initialize(header)
-			super(header)
-		end
-
-	end
+module Hps
+	class HpsReversal < HpsTransaction
+
+		attr_accessor :avs_result_code, :avs_result_text, :cvv_result_code, :cvv_result_text, :cpc_indicator
+
+		def initialize(header)
+			super(header)
+		end
+
+	end
 end

data/lib/hps/entities/hps_token_data.rb

@@ -1,11 +1,11 @@
-module Hps
-	class HpsTokenData
-
-		attr_accessor :token_value, :response_code, :response_message
-
-		def initialize(response_message = nil)
-			@response_message = response_message			
-		end
-
-	end
+module Hps
+	class HpsTokenData
+
+		attr_accessor :token_value, :response_code, :response_message
+
+		def initialize(response_message = nil)
+			@response_message = response_message			
+		end
+
+	end
 end

data/lib/hps/entities/hps_track_data.rb

@@ -1,5 +1,5 @@
-module Hps
-  class Hps::HpsTrackData
-    attr_accessor :value, :method_obtained
-  end
-end
+module Hps
+  class Hps::HpsTrackData
+    attr_accessor :value, :method_obtained
+  end
+end

data/lib/hps/entities/hps_transaction.rb

@@ -1,161 +1,161 @@
-module Hps
-
-	class HpsTransaction
-
-		attr_accessor :transaction_header, :transaction_id, :response_code, :response_text, :reference_number
-
-		def initialize(transaction_header=nil)
-			@transaction_header = transaction_header
-		end
-
-	end
-
-	def self.transaction_type_to_service_name(transaction_type)
-
-		case transaction_type
-
-		when Hps::HpsTransactionType::AUTHORIZE
-			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAuth
-
-		when Hps::HpsTransactionType::CAPTURE
-			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAddToBatch
-
-		when Hps::HpsTransactionType::CHARGE
-			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditSale
-
-		when Hps::HpsTransactionType::REFUND
-			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditReturn
-
-		when Hps::HpsTransactionType::REVERSE
-			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditReversal
-
-		when Hps::HpsTransactionType::VERIFY
-			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAccountVerify
-
-		when Hps::HpsTransactionType::LIST
-			Hps::ItemChoiceTypePosResponseVer10Transaction::ReportActivity
-
-		when Hps::HpsTransactionType::GET
-			Hps::ItemChoiceTypePosResponseVer10Transaction::ReportTxnDetail
-
-		when Hps::HpsTransactionType::VOID
-			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditVoid
-
-		when Hps::HpsTransactionType::BATCH_CLOSE
-			Hps::ItemChoiceTypePosResponseVer10Transaction::BatchClose
-
-		when Hps::HpsTransactionType::SECURITY_ERROR
-			"SecurityError"
-		else
-			""				
-		end
-
-	end
-
-	def self.service_name_to_transaction_type(service_name)
-
-		if service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAuth
-			Hps::HpsTransactionType::AUTHORIZE	
-
-		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAddToBatch
-			 Hps::HpsTransactionType::CAPTURE
-
-		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditSale
-			Hps::HpsTransactionType::CHARGE
-
-		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditReturn
-			Hps::HpsTransactionType::REFUND
-
-		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditReversal
-			Hps::HpsTransactionType::REVERSE
-
-		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAccountVerify
-			Hps::HpsTransactionType::VERIFY
-
-		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::ReportActivity
-			Hps::HpsTransactionType::LIST
-
-		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::ReportTxnDetail
-			Hps::HpsTransactionType::GET
-
-		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditVoid
-			Hps::HpsTransactionType::Void
-
-		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::BatchClose
-			Hps::HpsTransactionType::BATCH_CLOSE
-
-		elsif service_name == "SecurityError"
-			Hps::HpsTransactionType::SECURITY_ERROR
-		else
-			nil				
-		end
-
-	end
-
-	module ItemChoiceTypePosResponseVer10Transaction
-
-		AddAttachment = "AddAttachment"
-	  Authenticate = "Authenticate"
-	  BatchClose = "BatchClose"
-	  CancelImpersonation = "CancelImpersonation"
-	  CheckSale = "CheckSale"
-	  CheckVoid = "CheckVoid"
-	  CreditAccountVerify = "CreditAccountVerify"
-	  CreditAddToBatch = "CreditAddToBatch"
-	  CreditAuth = "CreditAuth"
-	  CreditCPCEdit = "CreditCPCEdit"
-	  CreditIncrementalAuth = "CreditIncrementalAuth"
-	  CreditOfflineAuth = "CreditOfflineAuth"
-	  CreditOfflineSale = "CreditOfflineSale"
-	  CreditReturn = "CreditReturn"
-	  CreditReversal = "CreditReversal"
-	  CreditSale = "CreditSale"
-	  CreditTxnEdit = "CreditTxnEdit"
-	  CreditVoid = "CreditVoid"
-	  DebitAddValue = "DebitAddValue"
-	  DebitReturn = "DebitReturn"
-	  DebitReversal = "DebitReversal"
-	  DebitSale = "DebitSale"
-	  EBTBalanceInquiry = "EBTBalanceInquiry"
-	  EBTCashBackPurchase = "EBTCashBackPurchase"
-	  EBTCashBenefitWithdrawal = "EBTCashBenefitWithdrawal"
-	  EBTFSPurchase = "EBTFSPurchase"
-	  EBTFSReturn = "EBTFSReturn"
-	  EBTVoucherPurchase = "EBTVoucherPurchase"
-	  EndToEndTest = "EndToEndTest"
-	  FindTransactions = "FindTransactions"
-	  GetAttachments = "GetAttachments"
-	  GetUserDeviceSettings = "GetUserDeviceSettings"
-	  GetUserSettings = "GetUserSettings"
-	  GiftCardActivate = "GiftCardActivate"
-	  GiftCardAddValue = "GiftCardAddValue"
-	  GiftCardBalance = "GiftCardBalance"
-	  GiftCardCurrentDayTotals = "GiftCardCurrentDayTotals"
-	  GiftCardDeactivate = "GiftCardDeactivate"
-	  GiftCardPreviousDayTotals = "GiftCardPreviousDayTotals"
-	  GiftCardReplace = "GiftCardReplace"
-	  GiftCardReversal = "GiftCardReversal"
-	  GiftCardSale = "GiftCardSale"
-	  GiftCardVoid = "GiftCardVoid"
-	  Impersonate = "Impersonate"
-	  InvalidateAuthentication = "InvalidateAuthentication"
-	  ManageSettings = "ManageSettings"
-	  ManageUsers = "ManageUsers"
-	  PrePaidAddValue = "PrePaidAddValue"
-	  PrePaidBalanceInquiry = "PrePaidBalanceInquiry"
-	  RecurringBilling = "RecurringBilling"
-	  ReportActivity = "ReportActivity"
-	  ReportBatchDetail = "ReportBatchDetail"
-	  ReportBatchHistory = "ReportBatchHistory"
-	  ReportBatchSummary = "ReportBatchSummary"
-	  ReportOpenAuths = "ReportOpenAuths"
-	  ReportSearch = "ReportSearch"
-	  ReportTxnDetail = "ReportTxnDetail"
-	  SendReceipt = "SendReceipt"
-	  TestCredentials = "TestCredentials"
-
-	end
-
-
-end
-
+module Hps
+
+	class HpsTransaction
+
+		attr_accessor :transaction_header, :transaction_id, :response_code, :response_text, :reference_number
+
+		def initialize(transaction_header=nil)
+			@transaction_header = transaction_header
+		end
+
+	end
+
+	def self.transaction_type_to_service_name(transaction_type)
+
+		case transaction_type
+
+		when Hps::HpsTransactionType::AUTHORIZE
+			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAuth
+
+		when Hps::HpsTransactionType::CAPTURE
+			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAddToBatch
+
+		when Hps::HpsTransactionType::CHARGE
+			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditSale
+
+		when Hps::HpsTransactionType::REFUND
+			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditReturn
+
+		when Hps::HpsTransactionType::REVERSE
+			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditReversal
+
+		when Hps::HpsTransactionType::VERIFY
+			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAccountVerify
+
+		when Hps::HpsTransactionType::LIST
+			Hps::ItemChoiceTypePosResponseVer10Transaction::ReportActivity
+
+		when Hps::HpsTransactionType::GET
+			Hps::ItemChoiceTypePosResponseVer10Transaction::ReportTxnDetail
+
+		when Hps::HpsTransactionType::VOID
+			Hps::ItemChoiceTypePosResponseVer10Transaction::CreditVoid
+
+		when Hps::HpsTransactionType::BATCH_CLOSE
+			Hps::ItemChoiceTypePosResponseVer10Transaction::BatchClose
+
+		when Hps::HpsTransactionType::SECURITY_ERROR
+			"SecurityError"
+		else
+			""				
+		end
+
+	end
+
+	def self.service_name_to_transaction_type(service_name)
+
+		if service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAuth
+			Hps::HpsTransactionType::AUTHORIZE	
+
+		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAddToBatch
+			 Hps::HpsTransactionType::CAPTURE
+
+		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditSale
+			Hps::HpsTransactionType::CHARGE
+
+		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditReturn
+			Hps::HpsTransactionType::REFUND
+
+		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditReversal
+			Hps::HpsTransactionType::REVERSE
+
+		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditAccountVerify
+			Hps::HpsTransactionType::VERIFY
+
+		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::ReportActivity
+			Hps::HpsTransactionType::LIST
+
+		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::ReportTxnDetail
+			Hps::HpsTransactionType::GET
+
+		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::CreditVoid
+			Hps::HpsTransactionType::Void
+
+		elsif service_name == Hps::ItemChoiceTypePosResponseVer10Transaction::BatchClose
+			Hps::HpsTransactionType::BATCH_CLOSE
+
+		elsif service_name == "SecurityError"
+			Hps::HpsTransactionType::SECURITY_ERROR
+		else
+			nil				
+		end
+
+	end
+
+	module ItemChoiceTypePosResponseVer10Transaction
+
+		AddAttachment = "AddAttachment"
+	  Authenticate = "Authenticate"
+	  BatchClose = "BatchClose"
+	  CancelImpersonation = "CancelImpersonation"
+	  CheckSale = "CheckSale"
+	  CheckVoid = "CheckVoid"
+	  CreditAccountVerify = "CreditAccountVerify"
+	  CreditAddToBatch = "CreditAddToBatch"
+	  CreditAuth = "CreditAuth"
+	  CreditCPCEdit = "CreditCPCEdit"
+	  CreditIncrementalAuth = "CreditIncrementalAuth"
+	  CreditOfflineAuth = "CreditOfflineAuth"
+	  CreditOfflineSale = "CreditOfflineSale"
+	  CreditReturn = "CreditReturn"
+	  CreditReversal = "CreditReversal"
+	  CreditSale = "CreditSale"
+	  CreditTxnEdit = "CreditTxnEdit"
+	  CreditVoid = "CreditVoid"
+	  DebitAddValue = "DebitAddValue"
+	  DebitReturn = "DebitReturn"
+	  DebitReversal = "DebitReversal"
+	  DebitSale = "DebitSale"
+	  EBTBalanceInquiry = "EBTBalanceInquiry"
+	  EBTCashBackPurchase = "EBTCashBackPurchase"
+	  EBTCashBenefitWithdrawal = "EBTCashBenefitWithdrawal"
+	  EBTFSPurchase = "EBTFSPurchase"
+	  EBTFSReturn = "EBTFSReturn"
+	  EBTVoucherPurchase = "EBTVoucherPurchase"
+	  EndToEndTest = "EndToEndTest"
+	  FindTransactions = "FindTransactions"
+	  GetAttachments = "GetAttachments"
+	  GetUserDeviceSettings = "GetUserDeviceSettings"
+	  GetUserSettings = "GetUserSettings"
+	  GiftCardActivate = "GiftCardActivate"
+	  GiftCardAddValue = "GiftCardAddValue"
+	  GiftCardBalance = "GiftCardBalance"
+	  GiftCardCurrentDayTotals = "GiftCardCurrentDayTotals"
+	  GiftCardDeactivate = "GiftCardDeactivate"
+	  GiftCardPreviousDayTotals = "GiftCardPreviousDayTotals"
+	  GiftCardReplace = "GiftCardReplace"
+	  GiftCardReversal = "GiftCardReversal"
+	  GiftCardSale = "GiftCardSale"
+	  GiftCardVoid = "GiftCardVoid"
+	  Impersonate = "Impersonate"
+	  InvalidateAuthentication = "InvalidateAuthentication"
+	  ManageSettings = "ManageSettings"
+	  ManageUsers = "ManageUsers"
+	  PrePaidAddValue = "PrePaidAddValue"
+	  PrePaidBalanceInquiry = "PrePaidBalanceInquiry"
+	  RecurringBilling = "RecurringBilling"
+	  ReportActivity = "ReportActivity"
+	  ReportBatchDetail = "ReportBatchDetail"
+	  ReportBatchHistory = "ReportBatchHistory"
+	  ReportBatchSummary = "ReportBatchSummary"
+	  ReportOpenAuths = "ReportOpenAuths"
+	  ReportSearch = "ReportSearch"
+	  ReportTxnDetail = "ReportTxnDetail"
+	  SendReceipt = "SendReceipt"
+	  TestCredentials = "TestCredentials"
+
+	end
+
+
+end
+

data/lib/hps/entities/hps_transaction_details.rb

@@ -1,7 +1,7 @@
-module Hps
-  class HpsTransactionDetails
-    
-    attr_accessor :memo, :invoice_number, :customer_id
-    
-  end
+module Hps
+  class HpsTransactionDetails
+    
+    attr_accessor :memo, :invoice_number, :customer_id
+    
+  end
 end

data/lib/hps/entities/hps_transaction_header.rb

@@ -1,9 +1,9 @@
-module Hps
-	class HpsTransactionHeader
-
-		attr_accessor :gateway_response_code, :gateway_response_message, :response_dt, :client_txn_id
-
-		
-
-	end
+module Hps
+	class HpsTransactionHeader
+
+		attr_accessor :gateway_response_code, :gateway_response_message, :response_dt, :client_txn_id
+
+		
+
+	end
 end

data/lib/hps/entities/hps_transaction_type.rb

@@ -1,17 +1,17 @@
-module Hps
-	module HpsTransactionType
-
-		AUTHORIZE = 0
-		CAPTURE = 1
-		CHARGE = 2
-		REFUND = 3
-		REVERSE = 4
-		VERIFY = 5
-		LIST = 6
-		GET = 7
-		VOID = 8
-		SECURITY_ERROR = 9
-		BATCH_CLOSE = 10
-
-	end
+module Hps
+	module HpsTransactionType
+
+		AUTHORIZE = 0
+		CAPTURE = 1
+		CHARGE = 2
+		REFUND = 3
+		REVERSE = 4
+		VERIFY = 5
+		LIST = 6
+		GET = 7
+		VOID = 8
+		SECURITY_ERROR = 9
+		BATCH_CLOSE = 10
+
+	end
 end

data/lib/hps/entities/hps_void.rb

@@ -1,9 +1,9 @@
-module Hps
-  class HpsVoid < HpsTransaction
-
-    def initialize(header)
-      super(header)
-    end
-
-  end
+module Hps
+  class HpsVoid < HpsTransaction
+
+    def initialize(header)
+      super(header)
+    end
+
+  end
 end