SVClient 1.0.2.2

data/lib/SVClient/SVStatus.rb

@@ -0,0 +1,82 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+# @author Nityananda
+# 
+#= Overview
+#    Class that contains the different Status Codes.
+#
+
+class SVStatus
+  public
+  # SUCCESS - Return value that indicates SUCCESS
+  SUCCESS = 0
+  
+  HTTP_OK = 200
+	
+  # TOTALS_MATCH_BATCH_CLOSED - Batch Closed/Settlement Done. Totals at the Client end and QwikCilver Server end match.
+  TOTALS_MATCH_BATCH_CLOSED = 0
+	
+  # TOTALS_MISMATCH_BATCH_CLOSED - Batch Closed/Settlement Done. Totals at the Client End and QwikCilver Server end do not match.
+  TOTALS_MISMATCH_BATCH_CLOSED = 99
+	
+  # UNKNOWN_ERROR - Unknown Error (Generic Error code).
+  UNKNOWN_ERROR = 801
+	
+  # INVALID_PARAM - Invalid Parameters, Usually thrown if there are any invalid or type mismatch parameters found. 
+  INVALID_PARAM = 802
+	
+  # NOT_INITIALIZED_ERROR - If a factory method is called without initializing the SV Client library.
+  NOT_INITIALIZED_ERROR = 803
+	
+  # SERVICE_UNAVAILABLE_ERROR - If server returns a bad response or if the server is down.
+  SERVICE_UNAVAILABLE_ERROR = 804
+	
+  # OPERATION_FAILED_ERROR - Describes if the requested operation was failed due to various reasons such as server error, network down time etc.,
+  OPERATION_FAILED_ERROR = 805
+	
+  # CONNECTION_TIMEOUT_ERROR - Thrown if the connection is timed out for the transaction's response.
+  CONNECTION_TIMEOUT_ERROR = 806
+	
+  # REQUEST_SEND_ERROR - Unable to send the request to the server.
+  REQUEST_SEND_ERROR = 807
+	
+  # UNSUPPORTED_TYPE_ERROR - The requested interface or the POSType is currently not supported.
+  UNSUPPORTED_TYPE_ERROR = 808
+	
+  # MISSING_MANDATORY_ATTRIBUTES - One or more of the required attributes missing.
+  MISSING_MANDATORY_ATTRIBUTES = 809
+	
+  # UNSUPPORTED_POS_TYPE - The requested POSType is currently not supported by the client.
+  UNSUPPORTED_POS_TYPE = 810
+	
+  # INVALID_VALUE - Invalid value.
+  INVALID_VALUE = -1
+  
+  private
+  ERROR_MESSAGES = { 
+    SVStatus::UNKNOWN_ERROR => "Encountered Error(UNKNOWN) while performing this operation",
+    SVStatus::INVALID_PARAM => "Invalid Parameter",
+    SVStatus::NOT_INITIALIZED_ERROR => "SVClient Library is Not Initialized",
+    SVStatus::SERVICE_UNAVAILABLE_ERROR => "Service Unavailable",
+    SVStatus::OPERATION_FAILED_ERROR => "Operation Failed. Did not receive any response",
+    SVStatus::CONNECTION_TIMEOUT_ERROR => "The Connection for this operation timed out",
+    SVStatus::REQUEST_SEND_ERROR => "Unable to send the request data to the Server",
+    SVStatus::UNSUPPORTED_TYPE_ERROR => "This API currently does not support the requested interface type",
+    SVStatus::MISSING_MANDATORY_ATTRIBUTES => "One or More of the Mandatory attributes does not have a valid value",
+    SVStatus::UNSUPPORTED_POS_TYPE => "This API currently does not support the requested POSType",
+    SVStatus::INVALID_VALUE => "Invalid Code"
+  }
+      
+  public 
+  # Use this function to get the proper error message for the respective error code.
+  def self.getmessage(code)
+    return nil if code == nil
+    return SVStatus::ERROR_MESSAGES[INVALID_VALUE] if ERROR_MESSAGES[code] == nil
+    return SVStatus::ERROR_MESSAGES[code]
+  end
+  
+  def self.gethttpmessage(httpresponse)
+    return "HTTP Error [ #{httpresponse}]"
+  end
+end

data/lib/SVClient/SVTags.rb

@@ -0,0 +1,142 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+#
+# Description of SVTags
+# @author Nityananda
+# 
+#= Overview
+#    Description of SVTags
+#
+
+class SVTags
+  CARD_NUMBER                          = "CardNumber"
+  CARD_PROGRAM_GROUP_NAME              = "CardProgramGroupName"
+  CARD_PIN                             = "CardPIN"
+  ADDON_CARD_NUMBER                    = "AddonCardNumber"
+  TRANSACTION_TYPE_ID                  = "TransactionTypeID"
+  AMOUNT                               = "Amount"
+  DATE_AT_CLIENT                       = "DateAtClient"
+  TRANSACTION_ID                       = "TransactionId"
+  DATE_AT_SERVER                       = "DateAtServer"
+  EXPIRY                               = "Expiry"
+  POS_ENTRY_MODE                       = "POSEntryMode"
+  POS_TYPE_ID                          = "POSTypeId"
+  ACQUIRER_ID                          = "AcquirerId"
+  TRACK_DATA                           = "TrackData"
+  ADDON_CARD_TRACK_DATA                = "AddonCardTrackData"
+  INVOICE_NUMBER                       = "InvoiceNumber"
+  APPROVAL_CODE                        = "ApprovalCode"
+  RESPONSE_CODE                        = "ResponseCode"
+  TERMINAL_ID                          = "TerminalId"
+  ORGANIZATION_NAME                    = "OrgName"
+  MERCHANT_NAME                        = "MerchantName"
+  MERCHANT_OUTLET_NAME                 = "MerchantOutletName"
+  RESPONSE_MESSAGE                     = "ResponseMessage"
+  OUTLET_ADDRESS_1                     = "OutletAddress1"
+  OUTLET_ADDRESS_2                     = "OutletAddress2"
+  OUTLET_CITY                          = "OutletCity"
+  OUTLET_STATE                         = "OutletState"
+  OUTLET_PIN_CODE                      = "OutletPinCode"
+  OUTLET_TELEPHONE                     = "OutletTelephone"
+  USER_ID                              = "UserId"
+  PASSWORD                             = "Password"
+  CURRENT_BATCH_NUMBER                 = "CurrentBatchNumber"
+  ACTIVATION_COUNT                     = "ActivationCount"
+  ACTIVATION_AMOUNT                    = "ActivationAmount"
+  REDEEM_COUNT                         = "RedemptionCount"
+  REDEEM_AMOUNT                        = "RedemptionAmount"
+  RELOAD_COUNT                         = "ReloadCount"
+  RELOAD_AMOUNT                        = "ReloadAmount"
+  NEW_BATCH_NUMBER                     = "NewBatchNumber"
+  INVOICE_NUMBER_MANDATORY             = "InvoiceNumberMandatory"
+  MESSAGE_AUTHENTICATION_CODE          = "MessageAuthenticationCode"
+  MASK_CARD_NUMBER                     = "MaskCardNumber"
+  PRINT_MERCHANT_COPY                  = "PrintMerchantCopy"
+  CORPORATE_NAME                       = "CorporateName"
+  CARD_TYPE                            = "CardType"
+  RECEIPT_FOOTER_LINE_1                = "ReceiptFooterLine1"
+  RECEIPT_FOOTER_LINE_2                = "ReceiptFooterLine2"
+  RECEIPT_FOOTER_LINE_3                = "ReceiptFooterLine3"
+  RECEIPT_FOOTER_LINE_4                = "ReceiptFooterLine4"
+  ORIGINAL_INVOICE_NUMBER              = "OriginalInvoiceNumber"
+  ORIGINAL_TRANSACTION_ID              = "OriginalTransactionId"
+  ORIGINAL_BATCH_NUMBER                = "OriginalBatchNumber"
+  ORIGINAL_AMOUNT                      = "Amount"
+  ORIGINAL_APPROVAL_CODE               = "OriginalApprovalCode"
+  CANCEL_LOAD_COUNT                    = "CancelLoadCount"
+  CANCEL_LOAD_AMOUNT                   = "CancelLoadAmount"
+  CANCEL_REDEEM_COUNT                  = "CancelRedeemCount"
+  CANCEL_REDEEM_AMOUNT                 = "CancelRedeemAmount"
+  POS_NAME                             = "POSName"
+  INTEGER_AMOUNTS                      = "IntegerAmounts"
+  NUMERIC_USER_PASSWORD                = "NumericUserPwd"
+  TERMINAL_APP_VERSION                 = "TermAppVersion"
+  CANCEL_ACTIVATION_COUNT              = "CancelActivationCount"
+  CANCEL_ACTIVATION_AMOUNT             = "CancelActivationAmount"
+  FIRST_NAME                           = "Firstname"
+  LAST_NAME                            = "Lastname"
+  PHONE_NUMBER                         = "Phone"
+  TRANSFER_CARD_NUMBER                 = "TransferCardNumber"
+  TRANSFER_CARD_BALANCE                = "TransferCardBalance"
+  TRANSFER_CARD_EXPIRY                 = "TransferCardExpiry"
+  FORWARDING_ENTITY_ID                 = "ForwardingEntityId"
+  FORWARDING_ENTITY_PASSWORD           = "ForwardingEntityPwd"
+  DEACTIVATION_COUNT                   = "DeactivationCount"
+  DEACTIVATION_AMOUNT                  = "DeactivationAmount"
+  NOTES                                = "Notes" 
+  ADJUSTMENT_AMOUNT                    = "AdjustmentAmount"
+  CURRENCY_CONVERSION_RATE             = "CurrencyConversionRate"
+  CARD_CURRENCY_SYMBOL                 = "CardCurrencySymbol" 
+  CURRENCY_CONVERTED_AMOUNT            = "CurrencyConvertedAmount"
+  EMPLOYEE_ID                          = "EmployeeId"
+  CARD_HOLDER_NAME                     = "CardHolderName"
+  PREV_BALANCE                         = "PreviousBalance"
+  SALUTATION                           = "Salutation"
+  ADDRESS1                             = "Address1"
+  ADDRESS2                             = "Address2"
+  AREA                                 = "Area"
+  CITY                                 = "City"
+  STATE                                = "State"
+  COUNTRY                              = "Country"
+  PIN_CODE                             = "PinCode"
+  PHONE_ALTERNATE                      = "PhoneAlternate"
+  EMAIL                                = "Email"
+  DOB                                  = "DOB"
+  ANNIVERSARY                          = "Anniversary"
+  GENDER                               = "Gender"
+  MARITAL_STATUS                       = "MaritalStatus"
+  XACTION_AMOUNT                       = "XactionAmount"
+  CARD_PROGRAM_ID                      = "CardProgramID"
+  ENROLLED_STORE                       = "EnrolledStore"
+  ENROLLED_SINCE                       = "EnrolledSince"
+  CARD_STATUS                          = "CardStatus"
+  OUTSTANDING_BALANCE                  = "OutstandingBalance"
+  CARD_EXPIRY_DATE                     = "CardExpiryDate"
+  CUSTOMER_VALIDATION_FOR_REDEMPTION   = "CustomerValidationForRedemption"
+  MEETS_MINIMUM_REDEMPTION_CRITERIA    = "MeetsMinimumRedemptionCriteria"
+  READY_FOR_REDEMPTION                 = "ReadyForRedemption"
+  IS_PROXY                             = "IsProxy"
+  IS_OFFLINE                           = "IsOffline"
+  ACTUAL_MERCHANT_OUTLET_NAME          = "ActualMerchantOutletName"
+  ADDITIONAL_TXN_REF_1                 = "AdditionalTxnRef1"
+  CARD_BALANCE                         = "Amount"
+  SETTLEMENT_DATE                      = "SettlementDate"
+  EMBOSSING_RECORD                     = "EmbossingFileRecord"
+  IIN                                  = "IIN"
+  CULTURE_NAME                         = "CultureName"
+  CURRENCY_SYMBOL                      = "CurrencySymbol"
+  CURRENCY_POSITION                    = "CurrencyPosition"
+  CURRENCY_DECIMAL_DIGITS              = "CurrencyDecimalDigits"
+  DISPLAY_UNIT_FOR_POINTS              = "DisplayUnitForPoints"
+  FROM_CARD_NUMBER                     = "FromCardNumber"
+  FROM_CARD_PIN                        = "FromCardPin"
+  TO_CARD_NUMBER                       = "ToCardNumber"
+  BILL_AMOUNT                          = "BillAmount"
+  PROMOTIONAL_VALUE                    = "PromotionalValue"
+  TRANSACTION_AMOUNT_CONVERTED_VALUE   = "XactionAmountConvertedValue"
+  SV_TYPE                              = "SVType"
+  SV_CONVERTED_AMOUNT                  = "SVConvertedAmount"
+  EARNED_VALUE                         = "EarnedValue"
+  RECENT_TRANSACTIONS                  = "RecentTransactions"
+end

data/lib/SVClient/SVType.rb

@@ -0,0 +1,16 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+#
+# Description of SVTags
+# @author Nityananda
+# 
+#= Overview
+#    Supported SVTypes
+#
+
+class SVType 
+  SWITCH_LOYALTY = 1
+  WEBPOS_GIFTCARD = 2
+  WEBPOS_LOYALTY = 3
+end

data/lib/SVClient/SVUtils.rb

@@ -0,0 +1,81 @@
+#
+# © 2011 QwikCilver Solutions Private Limited, All Rights Reserved.
+#
+# @author Nityananda
+# 
+#= Overview
+#    Class that contains utility methods.
+#
+
+require 'SVClient/SVGiftRecentTransactions'
+
+class SVUtils
+  QC_DATE_TIME_FORMAT = '%d%m%Y%H%M%S'
+  QC_DATE_FORMAT = '%d%m%Y'
+  
+  def self.isnullorempty (value)
+    return true if (value == nil)
+    value = value.to_s
+    return ((value.strip.length) <= 0) ? true : false
+  end
+  
+  require 'date'
+  
+  def self.getdate (value, format = nil)
+    return nil if isnullorempty(value)
+    return nil if isnullorempty(format)
+    begin
+      return DateTime.strptime(value, format)
+    rescue
+      return nil
+    end
+  end
+  
+  def self.getcurrentdate
+    d = DateTime.now
+    return d.strftime(SVUtils::QC_DATE_TIME_FORMAT)
+  end
+  
+  # Function to format the currency to standard notation which was received from server's locale currency format.
+  def self.getfloat(value)
+    retval = -1
+    value = (value == nil) ? "" : value.to_s.strip()
+    
+    return -1 if (value.length <= 0)
+    
+    iindex = value.index(/[.]/, 0)
+    if (iindex == nil)
+      return value.gsub(/[^0-9]/, "").to_f
+    else
+      decimalpart = value[iindex + 1, value.length]
+      wholepart = value[0, iindex]
+      ilen = decimalpart.length
+      if( (ilen == 1) || (ilen == 2) || (ilen == 3) )
+        fullnumber = wholepart.gsub(/[^0-9]/, "")
+        fullnumber = fullnumber + "." + decimalpart
+      else
+        fullnumber = value.gsub(/[^0-9]/, "")
+      end
+    end
+    
+    begin
+      retval = fullnumber.to_f
+    rescue
+      retval = -1
+    end 
+    return retval
+  end
+  
+  def self.parsegiftrecenttransactions(value)
+    arr = Array.new
+    value[0].split(/[{]/n).each do |row|
+      next if (row == nil || row == "")
+      grt = SVGiftRecentTransactions.new
+      row.chomp('}').split(/[|]/).each do |keypaircollection|
+        grt.setvalue(keypaircollection)
+      end
+      arr << grt
+    end
+    return arr
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: SVClient
+version: !ruby/object:Gem::Version
+  version: 1.0.2.2
+platform: ruby
+authors:
+- Nitya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies: []
+description: SVClient API Library for QwikCilver integration
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/SVClient/GCWebPos.rb
+- lib/SVClient/SVBalanceEnquiry.rb
+- lib/SVClient/SVCancelRedeem.rb
+- lib/SVClient/SVClient.rb
+- lib/SVClient/SVGiftCardCodes.rb
+- lib/SVClient/SVGiftRecentTransactions.rb
+- lib/SVClient/SVParamDownload.rb
+- lib/SVClient/SVProperties.rb
+- lib/SVClient/SVQcsData.rb
+- lib/SVClient/SVRecentTransactions.rb
+- lib/SVClient/SVRedeem.rb
+- lib/SVClient/SVRequest.rb
+- lib/SVClient/SVResponse.rb
+- lib/SVClient/SVStatus.rb
+- lib/SVClient/SVTags.rb
+- lib/SVClient/SVType.rb
+- lib/SVClient/SVUtils.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: SVClient API Library for QwikCilver integration
+test_files: []