SVClient 1.0.2.2

data/lib/SVClient/SVGiftCardCodes.rb

@@ -0,0 +1,35 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+# @author Nityananda
+# 
+#=Overview
+#   List of Gift card supported transactions and the respective transaction type id's
+# 
+
+class SVGiftCardCodes
+  PURCHASE_ONLY = 21
+  PURCHASE_ONLY_REVERSAL = 105
+  ACTIVATE_ONLY = 22
+  ACTIVATE_ONLY_REVERSAL = 105
+  ACTIVATE = 5
+  ACTIVATE_REVERSAL = 105
+  CREATE_AND_ISSUE = 5
+  CREATE_AND_ISSUE_REVERSAL = 105
+  REDEEM = 2
+  REDEEM_REVERSAL = 102
+  BALANCE = 6
+  RELOAD = 3
+  RELOAD_REVERSAL = 103
+  PARAM_DOWNLOAD = 19
+  BATCH_CLOSE = 20
+  CANCEL_RELOAD = 13
+  CANCEL_RELOAD_REVERSAL = 113
+  CANCEL_REDEEM = 12
+  CANCEL_REDEEM_REVERSAL = 112
+  DEACTIVATE = 4
+  CANCEL_ACTIVATE = 28
+  CANCEL_ACTIVATE_REVERSAL = 128
+  VIEW_LAST_TRANSACTION = 18
+  GET_CUSTOMER_INFO = 129
+end

data/lib/SVClient/SVGiftRecentTransactions.rb

@@ -0,0 +1,96 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+# @author Nityananda
+# 
+
+require 'SVClient/SVRecentTransactions'
+
+# =Overview
+# This class contains values of Recent Transaction attributes which is returned from the server.
+#     
+# SVResponse.getgiftrecenttransactions() method would return the Array of objects of this class type.
+# If server responds with any recent transactions in the response.
+class SVGiftRecentTransactions < SVRecentTransactions
+  
+  # ===return
+  # String - the Card Number of the selected recent transaction.
+  def getcardnumber
+    @cardnumber
+  end
+  
+  # ===return
+  # DateTime - the transaction date at which the selected recent transaction happened.
+  def gettransactiondate
+    SVUtils::getdate(@transactiondate, SVUtils::QC_DATE_FORMAT)
+  end
+  
+  # ===return
+  # DateTime - the transaction date at server on which the selected recent transaction happened.
+  # If this date differs from Transaction Date then the transaction might have happened offline.
+  def gettransactiondateatserver
+    @transactiondateatserver
+  end
+  
+  # ===return
+  # String - the descriptive Outlet Name on which the selected recent transaction happened.
+  def getoutletname
+    @outletname
+  end
+  
+  # ===return
+  # String - the descriptive Outlet Code on which the selected recent transaction happened.
+  def getoutletcode
+    @outletcode
+  end
+  
+  # ===return
+  # String - the Invoice Number of the selected recent transaction.
+  def getinvoicenumber
+    @invoicenumber
+  end
+  
+  # ===return
+  # String - the Transaction Type of the selected recent transaction.
+  def gettransactiontype
+    @transactiontype
+  end
+  
+  # ===return
+  # Float - the Transaction Amount of the selected recent transaction.
+  def gettransactionamount
+    @transactionamount
+  end
+  
+  # ===return
+  # Float - the Card Balance of the selected recent transaction.
+  def getcardbalance
+    @cardbalance
+  end
+  
+  def setvalue(keypaircollection)
+    tempcoll = keypaircollection.split(/~/)
+    key = tempcoll[0]
+    value = tempcoll[1]
+    case key
+    when "CardNumber"
+      @cardnumber = value
+    when "TransactionDate"
+      @transactiondate = value
+    when "TransactionDateAtServer"
+      @transactiondateatserver = value
+    when "OutletName"
+      @outletname = value
+    when "OutletCode"
+      @outletcode = value
+    when "InvoiceNumber"
+      @invoicenumber = value
+    when "TransactionType"
+      @transactiontype = value
+    when "TransactionAmount"
+      @transactionamount = value
+    when "CardBalance"
+      @cardbalance = value
+    end
+  end
+end

data/lib/SVClient/SVParamDownload.rb

@@ -0,0 +1,24 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+# @author Nityananda
+# 
+
+require 'SVClient/SVRequest'
+require 'SVClient/SVGiftCardCodes'
+
+class SVParamDownload < SVRequest
+  def initialize(type)
+    super(type)
+  end
+  
+  protected
+  def gettransactiontypeid
+    @txntypeid = 0
+    case @requestType
+    when SVType::WEBPOS_GIFTCARD
+      @txntypeid = SVGiftCardCodes::PARAM_DOWNLOAD      
+    end
+    return @txntypeid
+  end
+end

data/lib/SVClient/SVProperties.rb

@@ -0,0 +1,329 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+# @author Nityananda
+# 
+
+require 'SVClient/SVTags'
+require 'SVClient/SVType'
+
+# =Overview
+# This class contains values of parameters required to perform transactions with QwikCilver Server.
+# Create an instance of this class, Populate the necessary parameters and pass it as a parameter to GCWebPos.initlibrary() method.
+#     
+# GCWebPos.initlibrary() method returns an instance of this class which contains values of parameters provided by QwikCilver Server. 
+# The values contained in the returned object MUST be provided to each operation that needs to be performed with the QwikCilver Server
+class SVProperties
+  
+  protected
+  attr_accessor :parameters
+  
+  private
+  @@DEFAULT_CONNECTION_TIMEOUT = 17000
+  @@CONNECTION_TIMEOUT = 'connectionTimeout'
+  @@TRANSACTION_TIMEOUT = 'transactionTimeout'
+  @@SVTYPE = 'svType'
+  @@SERVER_URL = 'serverURL'
+  @@ERROR_CODE = 'errorCode'
+  @@ERROR_MESSAGE = 'errorMessage'
+  
+  def getvalue(key)
+    return nil if (key == nil)
+    return @parameters[key]
+  end
+  
+  def setvalue(key, value = nil)
+    @parameters[key] = value
+  end
+  
+  def update(src)
+    src.parameters.each { |key, value| 
+      setvalue(key, value) 
+    }
+  end
+  
+  public 
+  def initialize(src = nil)
+    @parameters = Hash.new
+    setvalue(@@CONNECTION_TIMEOUT, @@DEFAULT_CONNECTION_TIMEOUT)
+    setvalue(@@TRANSACTION_TIMEOUT, @@DEFAULT_CONNECTION_TIMEOUT)
+    setvalue(SVTags::TERMINAL_APP_VERSION, '0101')
+    update(src) if (src != nil)
+    setvalue(@@SVTYPE, SVType::WEBPOS_GIFTCARD)
+  end
+  
+  # ===return 
+  # String - the Forwarding Entity ID
+  def getforwardingentityid
+    return getvalue(SVTags::FORWARDING_ENTITY_ID)
+  end
+  
+  # The value for this is pre-assigned by QwikCilver and provided to the Caller
+  #
+  # ===param 
+  # String - Forwarding entity ID
+  def setforwardingentityid(value)
+    setvalue(SVTags::FORWARDING_ENTITY_ID, value)
+  end
+  
+  # ===return 
+  # String - The ForwardingEntityPassword
+  def getforwardingentitypassword
+    return getvalue(SVTags::FORWARDING_ENTITY_PASSWORD)
+  end
+  
+  # The value for this is pre-assigned by QwikCilver and provided to the Caller
+  #
+  # ===param 
+  # String - Forwarding Entity Password
+  def setforwardingentitypassword(value)
+    setvalue(SVTags::FORWARDING_ENTITY_PASSWORD, value)
+  end
+
+  # ===return 
+  # String - The Server URL
+  def getserverurl
+    return getvalue(@@SERVER_URL)
+  end
+   
+  # The value for this is pre-assigned by QwikCilver and provided to the Caller
+  #
+  # ===param 
+  # String - Server URL
+  def setserverurl(value)
+    setvalue(@@SERVER_URL, value)
+  end
+     
+  # ===return 
+  # String - the Connection Timeout    
+  def getconnectiontimeout()
+    return getvalue(@@CONNECTION_TIMEOUT)
+  end
+    
+  # Set the Time Out value (in seconds) used for connections to QwikCilver Server.
+  # The value for this should have been pre-approved by QwikCilver
+  #  
+  # ===param 
+  # String - The Time Out value (in seconds) used for connections to QwikCilver Server
+  def setconnectiontimeout(timeout)
+    setvalue(@@CONNECTION_TIMEOUT, timeout)
+  end
+
+  # ===return 
+  # String - The TransactionTimeout
+  def gettransactiontimeout()
+    return getvalue(@@TRANSACTION_TIMEOUT)
+  end
+    
+  # Set the Time Out value (in seconds) used for connections to QwikCilver Server.
+  # The value for this should have been pre-approved by QwikCilver
+  #     
+  # ===param 
+  # String - The Time Out value (in seconds) used for connections to QwikCilver Server
+  def settransactiontimeout(timeout)
+    setvalue(@@TRANSACTION_TIMEOUT, timeout)
+  end
+     
+  # ===return string - the acquirerId   
+  def getacquirerid()
+    return getvalue(SVTags::ACQUIRER_ID)
+  end
+    
+  # The value for this is pre-assigned by QwikCilver and provided to the Caller
+  #      
+  # ===param 
+  # String - Acquirer Id   
+  def setacquirerid(value)
+    setvalue(SVTags::ACQUIRER_ID, value)
+  end
+    
+  # ===return 
+  # String - The username   
+  def getusername()
+    return getvalue(SVTags::USER_ID)
+  end
+     
+  # ===param 
+  # String - username      
+  def setusername(value)
+    setvalue(SVTags::USER_ID, value)
+  end
+    
+     
+  # ===return 
+  # String - the password 
+  def getpassword()
+    return getvalue(SVTags::PASSWORD)
+  end
+    
+  # ===param 
+  # String - password
+  def setpassword(value)
+    setvalue(SVTags::PASSWORD, value)
+  end
+    
+     
+  # ===return 
+  # String - The Terminal ID
+  def getterminalid()
+    return getvalue(SVTags::TERMINAL_ID)
+  end
+    
+  # ===param 
+  # String - Terminal ID 
+  def setterminalid(value)
+    setvalue(SVTags::TERMINAL_ID, value)
+  end
+    
+  # ===return 
+  # String - The Terminal App Version
+  def getterminalappversion()
+    return getvalue(SVTags::TERMINAL_APP_VERSION)
+  end
+     
+  # ===param 
+  # String - The Terminal App Version
+  def setterminalappversion(value)
+    setvalue(SVTags::TERMINAL_APP_VERSION, value)
+  end
+    
+  # ===return
+  # String - The Merchant Outlet Name
+  def getmerchantoutletname()
+    return getvalue(SVTags::MERCHANT_OUTLET_NAME)
+  end
+    
+  # ===param 
+  # String - Merchant Outlet Name
+  def setmerchantoutletname(value)
+    setvalue(SVTags::MERCHANT_OUTLET_NAME, value)
+  end
+    
+  # ===return 
+  # String - The Organization Name
+  def getorganizationname()
+    return getvalue(SVTags::ORGANIZATION_NAME)
+  end
+    
+  # ===param 
+  # String - Organization Name
+  def setorganizationname(value)
+    setvalue(SVTags::ORGANIZATION_NAME, value)
+  end
+     
+  # ===return 
+  # String - The Pos Name
+  def getposname()
+    return getvalue(SVTags::POS_NAME)
+  end
+    
+  # ===param 
+  # String - Pos Name 
+  def setposname(value)
+    setvalue(SVTags::POS_NAME, value)
+  end
+     
+  # ===return 
+  # String - The Track Data 
+  def gettrackdata()
+    return getvalue(SVTags::TRACK_DATA)
+  end
+
+  # ===param 
+  # String - Track Data  
+  def settrackdata(value)
+    setvalue(SVTags::TRACK_DATA, value)
+  end
+    
+  # ===return 
+  # String - The Current Batch Number
+  def getcurrentbatchnumber()
+    return getvalue(SVTags::CURRENT_BATCH_NUMBER)
+  end
+   
+  # ===param 
+  # String - Current Batch Number
+  def setcurrentbatchnumber(value)
+    setvalue(SVTags::CURRENT_BATCH_NUMBER, value)
+  end
+     
+  # ===return 
+  # String - The Transaction ID
+  def gettransactionid()
+    return getvalue(SVTags::TRANSACTION_ID)
+  end
+    
+  # ===param 
+  # String - Transaction ID
+  def settransactionid(transactionId)
+    setvalue(SVTags::TRANSACTION_ID, transactionId)
+  end
+     
+  # ===return
+  # String - The Pos Type ID
+  def getpostypeid()
+    return getvalue(SVTags::POS_TYPE_ID)
+  end
+
+  # ===param 
+  # String - POS Type ID
+  def setpostypeid(value)
+    setvalue(SVTags::POS_TYPE_ID, value)
+  end
+
+  # ===return 
+  # String - The Pos Entry Mode 
+  def getposentrymode()
+    return getvalue(SVTags::POS_ENTRY_MODE)
+  end
+
+  # ===param 
+  # String - POS Entry Mode
+  def setposentrymode(value)
+    setvalue(SVTags::POS_ENTRY_MODE, value)
+  end
+    
+  # ===return 
+  # String - The Merchant Name
+  def getmerchantname()
+    return getvalue(SVTags::MERCHANT_NAME)
+  end
+
+  # ===param 
+  # String - Merchant Name
+  def setmerchantname(value)
+    setvalue(SVTags::MERCHANT_NAME, value)
+  end
+
+  # ===return 
+  # Fixnum - The return value which indicates SUCESS or FAILURE 
+  def geterrorcode()
+    return getvalue(@@ERROR_CODE)
+  end
+
+  # ===param 
+  # Fixnum - Error code
+  def seterrorcode(value)
+    setvalue(@@ERROR_CODE, value)
+  end
+     
+  # ===return 
+  # String - The Error message
+  def geterrormessage()
+    return getvalue(@@ERROR_MESSAGE)
+  end
+     
+  # ===param 
+  # String - Error message
+  def seterrormessage(value)
+    setvalue(@@ERROR_MESSAGE, value)
+  end
+     
+  def setsvtype(type)  
+    setvalue(@@SVTYPE, type)
+  end
+     
+  def getsvtype()  
+    return getvalue(@@SVTYPE)
+  end
+end