hps 1.0.1

data/lib/hps/entities/hps_token_data.rb

@@ -0,0 +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
+end

data/lib/hps/entities/hps_transaction.rb

@@ -0,0 +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
+

data/lib/hps/entities/hps_transaction_details.rb

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

data/lib/hps/entities/hps_transaction_header.rb

@@ -0,0 +1,9 @@
+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

@@ -0,0 +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
+end

data/lib/hps/entities/hps_void.rb

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

data/lib/hps/infrastructure/api_connection_exception.rb

@@ -0,0 +1,11 @@
+module Hps
+  class ApiConnectionException < HpsException
+
+    def initialize(message, inner_exception, code)
+
+      super(message, code, inner_exception)
+
+    end
+    
+  end
+end

data/lib/hps/infrastructure/authentication_exception.rb

@@ -0,0 +1,11 @@
+module Hps
+  class AuthenticationException < HpsException
+
+    def initialize(message)
+
+      super(message, nil)
+
+    end
+    
+  end
+end

data/lib/hps/infrastructure/card_exception.rb

@@ -0,0 +1,15 @@
+module Hps
+  class CardException < HpsException
+
+  	attr_accessor :transaction_id
+
+    def initialize(transaction_id, code, message)
+
+      @transaction_id=transaction_id
+
+      super(message, code)
+
+    end
+
+  end
+end

data/lib/hps/infrastructure/exceptions.json

@@ -0,0 +1,469 @@
+{
+   "version": "1.0.0",
+   
+   "exception_mappings":[
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "02",
+            "03",
+            "04",
+            "05",
+            "41",
+            "43",
+            "44",
+            "51",
+            "56",
+            "61",
+            "62",
+            "63",
+            "65",
+            "78"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"card_declined",
+         "mapping_message":"Exception_Message_CardDeclined"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "06",
+            "07",
+            "12",
+            "15",
+            "19",
+            "12",
+            "52",
+            "53",
+            "57",
+            "58",
+            "76",
+            "77",
+            "91",
+            "96",
+            "EC"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"processing_error",
+         "mapping_message":"Exception_Message_ProcessingError"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "13"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"invalid_amount",
+         "mapping_message":"Exception_Message_ChargeAmount"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "14"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"incorrect_number",
+         "mapping_message":"Exception_Message_IncorrectNumber"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "54"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"expired_card",
+         "mapping_message":"Exception_Message_CardExpired"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "55"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"invalid_pin",
+         "mapping_message":"Exception_Message_InvalidPin"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "75"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"pin_retries_exceeded",
+         "mapping_message":"Exception_Message_PinExceeded"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "80"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"invalid_expiry",
+         "mapping_message":"Exception_Message_InvalidExpiry"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "80"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"invalid_expiry",
+         "mapping_message":"Exception_Message_InvalidExpiry"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "86"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"pin_verification",
+         "mapping_message":"Exception_Message_PinVerification"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"issuer",
+         "exception_codes":[
+            "EB",
+            "N7"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"incorrect_cvc",
+         "mapping_message":"Exception_Message_IncorrectCvc"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"gateway",
+         "exception_codes":[
+            "-2"
+         ],
+         "mapping_type":"AuthenticationException",
+         "mapping_message":"Exception_Message_AuthenticationError"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"gateway",
+         "exception_codes":[
+            "1"
+         ],
+         "mapping_type":"HpsException"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"gateway",
+         "exception_codes":[
+            "3"
+         ],
+         "mapping_type":"HpsException",
+         "mapping_code":"invalid_original_transaction"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"gateway",
+         "exception_codes":[
+            "5"
+         ],
+         "mapping_type":"HpsException",
+         "mapping_code":"no_open_batch"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"gateway",
+         "param":"card",
+         "exception_codes":[
+            "12"
+         ],
+         "mapping_type":"InvalidRequestException",
+         "mapping_code":"invalid_cpc_data",
+         "mapping_message":"Exception_Message_InvalidCpcData"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"gateway",
+         "param":"card",
+         "exception_codes":[
+            "13"
+         ],
+         "mapping_type":"InvalidRequestException",
+         "mapping_code":"invalid_card_data",
+         "mapping_message":"Exception_Message_InvalidCardData"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"gateway",
+         "exception_codes":[
+            "14"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"invalid_number",
+         "mapping_message":"Exception_Message_InvalidNumber"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"gateway",
+         "exception_codes":[
+            "30"
+         ],
+         "mapping_type":"HpsException",
+         "mapping_message":"Exception_Message_GatewayTimedOut"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "param":"gatewayTransactionId",
+         "exception_codes":[
+            "0"
+         ],
+         "mapping_type":"InvalidRequestException",
+         "mapping_code":"invalid_transaction_id",
+         "mapping_message":"Exception_Message_TransactionIdLessThanEqualZero"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "param":"HpsServiceUri",
+         "exception_codes":[
+            "1"
+         ],
+         "mapping_type":"InvalidRequestException",
+         "mapping_code":"sdk_exception",
+         "mapping_message":"Exception_Message_InvalidGatewayUrl"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "exception_codes":[
+            "2"
+         ],
+         "mapping_type":"ApiConnectionException",
+         "mapping_code":"sdk_exception",
+         "mapping_message":"Exception_Message_UnableToProcessTransaction"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "param":"start",
+         "exception_codes":[
+            "3"
+         ],
+         "mapping_type":"InvalidRequestException",
+         "mapping_code":"invalid_date",
+         "mapping_message":"Exception_Message_FutureDate"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "param":"end",
+         "exception_codes":[
+            "4"
+         ],
+         "mapping_type":"InvalidRequestException",
+         "mapping_code":"invalid_date",
+         "mapping_message":"Exception_Message_FutureDate"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "param":"currency",
+         "exception_codes":[
+            "5"
+         ],
+         "mapping_type":"InvalidRequestException",
+         "mapping_code":"missing_currency",
+         "mapping_message":"Exception_Message_ArgumentNull"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "param":"currency",
+         "exception_codes":[
+            "6"
+         ],
+         "mapping_type":"InvalidRequestException",
+         "mapping_code":"invalid_currency",
+         "mapping_message":"Exception_Message_InvalidCurrency"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "param":"amount",
+         "exception_codes":[
+            "7"
+         ],
+         "mapping_type":"InvalidRequestException",
+         "mapping_code":"invalid_amount",
+         "mapping_message":"Exception_Message_ChargeAmount"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "exception_codes":[
+            "8"
+         ],
+         "mapping_type":"HpsException",
+         "mapping_code":"gateway_timeout",
+         "mapping_message":"Exception_Message_UnableToReverseTransactionAfterGatewayTimeout"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "exception_codes":[
+            "9"
+         ],
+         "mapping_type":"HpsException",
+         "mapping_code":"issuer_timeout",
+         "mapping_message":"Exception_Message_UnableToReverseTransactionAfterIssuerTimeout"
+      },
+      {
+         "object":"exception_mapping",
+         "category":"sdk",
+         "exception_codes":[
+            "10"
+         ],
+         "mapping_type":"CardException",
+         "mapping_code":"processing_error",
+         "mapping_message":"Exception_Message_ProcessingError"
+      }
+   ],
+   "exception_messages":[
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_ArgumentNull",
+         "message":"Argument can't be null."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_AuthenticationError",
+         "message":"Authentication error. Please double check your service configuration."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_CardDeclined",
+         "message":"The card was declined."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_CardExpired",
+         "message":"The card has expired."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_ChargeAmount",
+         "message":"Must be greater than or equal 0."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_FutureDate",
+         "message":"Date can not be in the future."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_IncorrectCvc",
+         "message":"The card's security code is incorrect."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_IncorrectNumber",
+         "message":"The card number is incorrect."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_InvalidConfig",
+         "message":"The HPS SDK has not been properly configured. Please make sure to initialize the config either in a service constructor or in your App.config or Web.config file."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_InvalidCurrency",
+         "message":"The only supported currency is \"usd\""
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_InvalidExpiry",
+         "message":"Card expiration date is invalid."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_InvalidNumber",
+         "message":"The card number is not a valid credit card number."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_InvalidPin",
+         "message":"The 4-digit pin is invalid."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_PinExceeded",
+         "message":"Maximum number of pin retries exceeded."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_PinVerification",
+         "message":"Can't verify card pin number."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_ProcessingError",
+         "message":"An error occurred while processing the card."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_TransactionIdLessThanEqualZero",
+         "message":"Transaction ID must be greater than zero."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_UnexpectedResponseCode",
+         "message":"Unsuccessful response code ({0}) received from HPS Gateway."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_UnexpectedResponseType",
+         "message":"Received unexpected response from POS Gateway. (Request and response transaction types don't match)."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_InvalidCpcData",
+         "message":"Invalid CPC data."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_InvalidCardData",
+         "message":"Invalid card data."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_GatewayTimedOut",
+         "message":"Gateway timed out."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_InvalidGatewayUrl",
+         "message":"Invalid HpsServiceUri."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_UnableToProcessTransaction",
+         "message":"Unable to process the payment transaction."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_UnableToReverseTransactionAfterGatewayTimeout",
+         "message":"Error occurred while reversing a charge due to HPS gateway time-out."
+      },
+      {
+         "object":"exception_message",
+         "code":"Exception_Message_UnableToReverseTransactionAfterIssuerTimeout",
+         "message":"Error occurred while reversing a charge due to issuer time-out."
+      }
+   ]
+}