SVClient 1.0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f33a0988b40491e1ba93f5bfe8c31b42a31da04b
+  data.tar.gz: 1a6db3c401a1ad44be462d296b166758dbbcf2dc
+SHA512:
+  metadata.gz: 676eba0435d9bb49a33357fd144ed7559db375a8fef16f44100e88f0a867838e546f64c91734e0426b22bb1563a37125c219e02382cd5bad0466622a0f503939
+  data.tar.gz: d6bb6939a16f0ced7f49d1d69da89183a2df93f009f8721f999ff25b1a84097dafad15e53d0a0f6bd2483518d65a905d153c3d0f8183167c694d285fa0503f1b

data/lib/SVClient/GCWebPos.rb

@@ -0,0 +1,338 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+# @author Nityananda
+# 
+
+require 'SVClient/SVUtils'
+require 'SVClient/SVClient'
+require 'SVClient/SVProperties'
+require 'SVClient/SVBalanceEnquiry'
+require 'SVClient/SVRedeem'
+require 'SVClient/SVCancelRedeem'
+
+#
+# This Class provides the Gift Card related API for a QwikCilver WebPos Client to interface with QwikCilver Server.
+# 
+# This class provides:
+# - A method to initialize this library
+# - A set of factory methods to get/create an SVRequest instance pertaining to the operation that needs to be performed
+# 
+# *NOTE:* The caller must first initialize this library by calling GCWebPos::initlibrary method
+# before any operation can be performed by this library. This method needs to be called after starting
+# the web server and needs to be called only once.
+#
+# After this library has been initialized the caller calls the appropriate factory method to create
+# an instance of SVRequest that will be used to perform the desired operation.
+#
+# Once an SVRequest instance has been created/obtained the caller can
+# set any optional attributes, as desired, by calling the SVRequest.setvalue() method
+# 
+# Once the desired attributes have been set the caller must call
+# SVRequest.execute() method to perform the operation.
+# SVRequest.execute() method will return SVResponse object.
+# 
+# To check if the operation was performed successfully by QwikCilver Server
+# call SVResponse.getErrorCode() method.
+# 
+# If the return  value of SVResponse.geterrorcode() method is NOT EQUAL TO SVStatus.SUCCESS then the caller should call
+# SVResponse.geterrormessage() to get a detailed error message on why the operation failed.
+# 
+# If the return  value of SVResponse.geterrorcode() method
+# is EQUAL TO SVStatus.SUCCESS then the caller should call
+# the appropriate getters in SVResponse object to get the
+# data returned by QwikCilver Server after successful execution of this operation.
+class GCWebPos
+  
+  # This method is used to initialize the SVClient Library.
+  # This method needs to be called once before using this library.
+  # 
+  # The required/mandatory attributes for initializing this library are pre-assigned
+  # by QwikCilver and provided to the Caller.
+  # 
+  # The list of mandatory and optional
+  # attributes are:
+  # * serverURL (Mandatory) - Server URL provided by QwikCilver
+  # * forwardingEntityId (Mandatory) - Forwarding Entity Id provided by QwikCilver
+  # * forwardingEntityPassword (Mandatory) - Forwarding Entity Password provided by QwikCilver
+  # * terminalId (Mandatory) - TerminalId is provided by QwikCilver
+  # * username (Mandatory) - username provided by QwikCilver
+  # * password (Mandatory) - password provided by QwikCilver
+  # * connectionTimeout (Optional) - default value is 17 seconds (17000 milliseconds). Actual value is provided by QwikCilver
+  # * transactionTimeout (Optional) - default value is 17 seconds (17000 milliseconds). Actual value is provided by QwikCilver
+  # 
+  # To initialize this library the caller needs to create an instance of SVProperties and set the Mandatory attributes and optional
+  # attributes, as needed, and call this method by passing the SVProperties instance as a parameter to this method.
+  #
+  # ===params
+  # SVProperties - SVProperties instance that contains the attributes for initializing
+  # this library
+  #
+  # ===return
+  # SVProperties which contains QwikCilver server specific data
+  # to check if the GCWebPos.initlibrary() operation was performed successfully by QwikCilver Server
+  # call SVProperties.geterrorcode() method and check its return value.
+  # If the return  value of SVProperties.geterrorcode() method
+  # is NOT EQUAL TO SVStatus.SUCCESS then the caller should call
+  # SVProperties.geterrormessage() to get a detailed error message on why the operation failed.
+  # If the return value is EQUAL TO SVStatus.SUCCESS then save this object
+  # as it needs to be passed to subsequent calls to perform card related operations.
+  #
+  # ===raises
+  # Exception  If input parameter is nil or if any of the *Mandatory*
+  # attributes are nil or empty.
+  def self.initlibrary(webposprops)
+
+    if(webposprops == nil)
+      raise "Input is null"
+    end
+    if( (SVUtils::isnullorempty(webposprops.getserverurl())) ||
+          (SVUtils::isnullorempty(webposprops.getforwardingentityid())) ||
+          (SVUtils::isnullorempty(webposprops.getforwardingentitypassword())) ||
+          (SVUtils::isnullorempty(webposprops.getterminalid())) ||
+          (SVUtils::isnullorempty(webposprops.getusername())) ||
+          (SVUtils::isnullorempty(webposprops.getpassword())))
+      raise "One or More of the Mandatory attributes does not have a valid value"
+    end
+
+    webposprops.setsvtype(SVType::WEBPOS_GIFTCARD)
+    return SVClient::initlibrary(webposprops)
+  end
+  
+  # Use this factory method to create an instance of SVRequest
+  # that can be used to perform *BalanceEnquiry* operation.
+  # 
+  # After the caller gets the SVRequest instance, the caller
+  # may set any of the optional attributes using the SVRequest.setvalue() method
+  # 
+  # Then call SVRequest.execute() method.
+  # SVRequest.execute() method returns an instance of SVResponse.
+  # To check if the operation was performed successfully by QwikCilver Server
+  # call SVResponse.geterrorcode() method and check its return value.
+  # 
+  # If the return value is EQUAL TO SVStatus.SUCCESS
+  # then read the values of the following attributes returned by QwikCilver Server
+  # using the appropriate getters
+  # 
+  # * SVResponse.gettransactionid()
+  # * SVResponse.getcardbalance()
+  # * SVResponse.getcardexpiry()
+  # * SVResponse.getapprovalcode()  
+  # 
+  # ===params
+  # SVProperties - *Mandatory* - Data returned by QwikCilver Server in the GCWebPos.initlibrary() call.
+  # 
+  # String - *Mandatory* - Card Number
+  # 
+  # String  - *Mandatory* - Card Pin
+  # 
+  # Fixnum  - *Mandatory* - Transaction ID
+  # 
+  # String - *Optional* - Track Data. Can be nil
+  # 
+  # String -  *Optional* - Notes use as any unique cross-reference, e.g. ApprovalCode, RRN etc. Can be nil
+  # 
+  # ===return
+  # SVRequest instance that should be used to perform <B>BalanceEnquiry</B> operation
+  #
+  # ===raises
+  # Exception  If any input parameter that is *Mandatory* is nil or empty
+  def self.balanceenquiry(
+      serverproperties,   #mandatory
+      cardnumber,         #mandatory
+      cardpin,            #mandatory
+      transactionid,      #mandatory
+      trackdata = nil,    #optional
+      notes = nil )       #optional, Use as any unique cross-reference, e.g. ApprovalCode, RRN etc, can also be nil
+    
+    #Validate Mandatory attributes
+    if( ( (serverproperties == nil) ) ||
+          ( SVUtils::isnullorempty(cardnumber) ) ||
+          ( SVUtils::isnullorempty(cardpin) ) ||
+          ( SVUtils::isnullorempty(transactionid) )
+      )
+      raise "One or More of the Mandatory attributes does not have a valid value"
+    end
+        
+    serverproperties.setsvtype(SVType::WEBPOS_GIFTCARD)
+    @svrequest = SVBalanceEnquiry.new(serverproperties)
+    @svrequest.setcardnumber(cardnumber)
+    @svrequest.setcardpin(cardpin)
+    @svrequest.settransactionid(transactionid)
+    @svrequest.settrackdata(trackdata)
+    @svrequest.setnotes(notes)
+    return @svrequest
+  end
+  
+  # Use this factory method to create an instance of @link  SVRequest  SVRequestend
+  # that can be used to perform <B>Redeem</B> operation.
+  # 
+  # After the caller gets the SVRequest instance, the caller
+  # may set any of the optional attributes using the SVRequest.setvalue method
+  # 
+  # Then call SVRequest.execute() method.
+  # SVRequest.execute() method returns an instance of SVResponse
+  # to check if the operation was performed successfully by QwikCilver Server
+  # call SVResponse.geterrorcode() method and check its return value.
+  # 
+  # If the return value is EQUAL TO SVStatus.SUCCESS
+  # then read the values of the following attributes returned by QwikCilver Server
+  # using the appropriate getters
+  # * SVResponse.gettransactionid()
+  # * SVResponse.getcardbalance()
+  # * SVResponse.getcardexpiry()
+  # * SVResponse.getapprovalcode()
+  # * SVResponse.getterminalid()
+  # * SVResponse.gettransfercardnumber()
+  # * SVResponse.gettransfercardbalance()
+  # * SVResponse.gettransfercardexpiry()
+  #
+  # ===params
+  # SVProperties  [Mandatory] Data returned by QwikCilver Server in the initLibrary call
+  # 
+  # String - *Mandatory* - Card Number
+  # 
+  # String - *Mandatory* - Card Pin
+  # 
+  # Fixnum - *Mandatory* - Transaction ID
+  # 
+  # String - *Mandatory* - Invoice Number
+  # 
+  # Float - *Mandatory* - Amount to redeem on the Card 
+  #  
+  # String - *Optional* - Track Data
+  # 
+  # String - *Optional* - Notes use as any unique cross-reference, e.g. ApprovalCode, RRN etc. Can be nil
+  # 
+  # Float - *Optional* Total Bill Amount
+  #
+  # ===return
+  # SVRequest SVRequest instance that should be used to perform <B>Redeem</B> operation
+  #
+  # ===raises
+  # Exception  If any input parameter that is *Mandatory* is nil or empty
+  def self.redeem(
+      serverproperties,   #mandatory
+      cardnumber,         #mandatory
+      cardpin,            #mandatory
+      invoicenumber,      #mandatory
+      amount,             #mandatory
+      transactionid,      #mandatory
+      trackdata = nil,    #optional
+      notes = nil,         #optional, Use as any unique cross-reference, e.g. ApprovalCode, RRN etc, can also be nil
+      billamount = nil)   #optional
+    
+    #Validate Mandatory attributes
+    if( ( (serverproperties == nil) ) ||
+          ( SVUtils::isnullorempty(cardnumber) ) ||
+          ( SVUtils::isnullorempty(cardpin) ) ||
+          ( SVUtils::isnullorempty(transactionid) ) ||
+          ( SVUtils::isnullorempty(invoicenumber) ) ||
+          ( amount <= 0 )
+      )
+      raise "One or More of the Mandatory attributes does not have a valid value"
+    end
+        
+    serverproperties.setsvtype(SVType::WEBPOS_GIFTCARD)
+    @svrequest = SVRedeem.new(serverproperties)
+    @svrequest.setcardnumber(cardnumber)
+    @svrequest.setcardpin(cardpin)
+    @svrequest.settransactionid(transactionid)
+    @svrequest.setinvoicenumber(invoicenumber)
+    @svrequest.setamount(amount)
+    @svrequest.setbillamount(billamount) if ( billamount != nil )
+    @svrequest.settrackdata(trackdata)
+    @svrequest.setnotes(notes)
+    return @svrequest
+  end
+  
+  # Use this factory method to create an instance of SVRequest
+  # that can be used to perform <B>CancelRedeem</B> operation.
+  # 
+  # After the caller gets the SVRequest instance, the caller
+  # may set any of the optional attributes using the SVRequest.setvalue method
+  # 
+  # Then call SVRequest.execute() method.
+  # SVRequest.execute() method returns an instance of SVResponse 
+  # to check if the operation was performed successfully by QwikCilver Server
+  # call SVResponse.geterrorcode() method and check its return value.
+  # 
+  # If the return value is EQUAL TO SVStatus.SUCCESS
+  # then read the values of the following attributes returned by QwikCilver Server
+  # using the appropriate getters
+  # 
+  # * SVResponse.gettransactionid
+  # * SVResponse.getcardbalance
+  # * SVResponse.getcardexpiry
+  # * SVResponse.getapprovalcode
+  # * SVResponse.getterminalid
+  # * SVResponse.gettransfercardnumber
+  # * SVResponse.gettransfercardbalance
+  # * SVResponse.gettransfercardexpiry
+  # 
+  # ===param
+  # SVProperties - *Mandatory* - Data returned by QwikCilver Server in the GCWebPos.initlibrary call
+  #
+  # String - *Mandatory* - Card Number 
+  #
+  # String - *Mandatory* - Original Invoice Number
+  #
+  # Bignum - *Mandatory* - Original Transaction Id of the Redeem operation we are trying to Cancel
+  #
+  # Bignum - *Mandatory* - Original Batch Number
+  #
+  # Float - *Mandatory* - Original Amount
+  #
+  # Bignum - *Mandatory* - Transaction Id of the Redeem operation we are trying to Cancel
+  #
+  # String - *Optional* - Original Approval Code of the Redeem operation we are trying to Cancel. Can be nil
+  #
+  # String - *Optional* - Track Data. Can be nil
+  #
+  # String - *Optional* - Use as any unique cross-reference, e.g. ApprovalCode, RRN etc. Can be nil
+  #
+  # ===return
+  # SVRequest instance that should be used to perform <B>CancelRedeem</B> operation
+  #
+  # ===raises
+  # Exception If any input parameter that is *Mandatory* is nil or empty
+  #
+  def self.cancelredeem(
+      serverproperties,               #mandatory
+      cardnumber,                     #mandatory
+      originalinvoicenumber,          #mandatory
+      originaltransactionid,          #mandatory
+      originalbatchno,                #mandatory
+      originalamount,                 #mandatory
+      transactionid,                  #mandatory
+      cardpin = nil,                  #optional
+      originalapprovalcode = nil,     #Optional
+      trackdata = nil,                #Optional
+      notes = nil )                   #optional, Use as any unique cross-reference, e.g. ApprovalCode, RRN etci, can also be nil
+    
+    #Validate Mandatory attributes
+    if( ( (serverproperties == nil) ) ||
+          ( SVUtils::isnullorempty(cardnumber) ) ||
+          ( SVUtils::isnullorempty(originalinvoicenumber) ) ||
+          ( originaltransactionid <= 0 ) ||
+          ( originalbatchno <= 0 ) ||
+          ( originalamount <= 0 ) ||
+          ( SVUtils::isnullorempty(transactionid) )
+      )
+      raise "One or More of the Mandatory attributes does not have a valid value"
+    end
+        
+    serverproperties.setsvtype(SVType::WEBPOS_GIFTCARD)
+    @svrequest = SVCancelRedeem.new(serverproperties)
+    @svrequest.setcardnumber(cardnumber)
+    @svrequest.setoriginalinvoicenumber(originalinvoicenumber)
+    @svrequest.setoriginaltransactionid(originaltransactionid)
+    @svrequest.setoriginalbatchnumber(originalbatchno)
+    @svrequest.setoriginalapprovalcode(originalapprovalcode)
+    @svrequest.setoriginalamount(originalamount)
+    @svrequest.settransactionid(transactionid)
+    @svrequest.setcardpin(cardpin)
+    @svrequest.setnotes(notes)
+    return @svrequest
+  end
+end

data/lib/SVClient/SVBalanceEnquiry.rb

@@ -0,0 +1,28 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+# @author Nityananda
+# 
+#=Overview
+#   Class used by GCWebPos to perform Balance Enquiry transaction
+#
+
+require 'SVClient/SVRequest'
+require 'SVClient/SVGiftCardCodes'
+require 'SVClient/SVType'
+
+class SVBalanceEnquiry < SVRequest
+  def initialize(type)
+    super(type)
+  end
+  
+  protected
+  def gettransactiontypeid
+    @txntypeid = 0
+    case @requestType
+    when SVType::WEBPOS_GIFTCARD
+      @txntypeid = SVGiftCardCodes::BALANCE
+    end
+    return @txntypeid
+  end
+end

data/lib/SVClient/SVCancelRedeem.rb

@@ -0,0 +1,28 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+# @author Nityananda
+# 
+#=Overview
+#   Class used by GCWebPos to perform Balance Enquiry transaction
+#
+
+require 'SVClient/SVRequest'
+require 'SVClient/SVGiftCardCodes'
+require 'SVClient/SVType'
+
+class SVCancelRedeem < SVRequest
+  def initialize(type)
+    super(type)
+  end
+  
+  protected
+  def gettransactiontypeid
+    @txntypeid = 0
+    case @requestType
+    when SVType::WEBPOS_GIFTCARD
+      @txntypeid = SVGiftCardCodes::CANCEL_REDEEM
+    end
+    return @txntypeid
+  end
+end

data/lib/SVClient/SVClient.rb

@@ -0,0 +1,65 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+# @author Nityananda
+# 
+
+require 'SVClient/SVParamDownload'
+
+class SVClient
+  public
+  def self.initlibrary(svprops)
+    return SVClient::getparamsfromserver(svprops)
+  end
+  
+  private
+  def self.getparamsfromserver(svprops)
+    if(svprops == nil)
+      @retprops = SVProperties.new()
+      @retprops.seterrorcode(SVStatus::INVALID_PARAM)
+      @retprops.seterrormessage(SVStatus::getmessage(SVStatus::INVALID_PARAM))
+      return @retprops
+    end
+    
+    case svprops.getsvtype
+    when SVType::WEBPOS_GIFTCARD
+      @svrequest = SVClient::getwebposgiftcardparamdownload(svprops)
+    else
+      return SVStatus::UNSUPPORTED_TYPE_ERROR
+    end
+    
+    @svresponse = @svrequest.execute()
+    @retval = @svresponse.geterrorcode()
+    if (@retval != SVStatus::SUCCESS.to_i)
+      @retprops = SVProperties.new()
+      @retprops.seterrorcode(@retval)
+      @retprops.seterrormessage(@svresponse.geterrormessage())
+      return @retprops
+    end
+    
+    @serverprops = SVProperties.new(svprops)
+    @serverprops.settransactionid(@svresponse.gettransactionid)
+    @serverprops.setposentrymode(@svresponse.getposentrymode)
+    @serverprops.setpostypeid(@svresponse.getpostypeid)
+    @serverprops.setacquirerid(@svresponse.getacquirerid)
+    @serverprops.setorganizationname(@svresponse.getorganizationname)
+    @serverprops.setmerchantname(@svresponse.getmerchantname)
+    @serverprops.setmerchantoutletname(@svresponse.getmerchantoutletname)
+    @serverprops.setposname(@svresponse.getposname)
+    @serverprops.setcurrentbatchnumber(@svresponse.getcurrentbatchnumber)
+    @serverprops.seterrorcode(@svresponse.geterrorcode)
+    @serverprops.seterrormessage(@svresponse.geterrormessage)
+    return @serverprops
+  end
+  
+  def self.getwebposgiftcardparamdownload(svprops)
+    @svrequest = SVParamDownload.new(svprops)
+    @svrequest.setforwardingentityid(svprops.getforwardingentityid())
+    @svrequest.setforwardingentitypassword(svprops.getforwardingentitypassword())
+    @svrequest.setterminalid(svprops.getterminalid())
+    @svrequest.setusername(svprops.getusername())
+    @svrequest.setpassword(svprops.getpassword())
+    @svrequest.settransactionid(1)
+    return @svrequest
+  end
+end