hps 2.1.2 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef169211a337457fdd345d71363e83dd748525b0
-  data.tar.gz: b40300100b4d8387fcb0cc2620126c0e5b394789
+  metadata.gz: fe094a2e028c26d7589d019cc4b65cddb785eaf9
+  data.tar.gz: e20c7eca17da26e189def2911b818e4483162f32
 SHA512:
-  metadata.gz: daa2fab5fb3fd00b76a94fd2a2d5cb4ed012b010bda993bac41a859e956c9a7fb2a9cee48f209a95e61e20e01e0424a10982ce6092ecf7dbd67671e4f176ebf8
-  data.tar.gz: 732560e30c0b5ebda581441bb5e37362be284fe9773170fbcefff2f702d674e24b676d083259bf4764dd05028eeae86371b3ed9ef75e7d1742a4399c61e55219
+  metadata.gz: '096e7db7554ff2df05fb79f396c31fcc6a4023bb7fe591112e719a9f1076b8b52575f83cf287c7f4b311dd87e174a341457ad1d6704f6ebbcaeff86878d1df33'
+  data.tar.gz: f6876b71ee04b70af33db644226c485ecd7c6d38825a82883be5e371b455cfe49508612ff4d4498972bd13fec8e7b3edbc2acc00accb022abdc43fff9f04bf77

data/README.md

@@ -15,6 +15,8 @@ This SDK makes it easy to integrate your Ruby application with Heartland's [**Po
 
 Supported Gateway Calls
 
+* CheckSale
+* CheckVoid
 * CreditAccountVerify (4.3)
 * CreditAddToBatch (4.4)
 * CreditAuth (4.5)
@@ -31,7 +33,7 @@ Supported Gateway Calls
 | [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-secure)](#data-security)  | [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-resources)](#documentation-and-examples)  | [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-tools)](#certification--testing) | [![](http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-keys)](#api-keys) | <a href="http://developer.heartlandpaymentsystems.com/Account/Register" target="_blank">Register an Account</a> <br> <a href="http://www.heartlandpaymentsystems.com/partners/" target="_blank">Partner with Heartland</a> <br> <a href="http://developer.heartlandpaymentsystems.com/SecureSubmit/Support" target="_blank">Developer Support</a>  |
 
 
-####Developer Support
+#### Developer Support
 
 You are not alone! If you have any questions while you are working through your development process, please feel free to <a href="mailto:entapp_devportal@e-hps.com?Subject=Developer Support Request">reach out to our team for assistance</a>.
 
@@ -113,7 +115,7 @@ Testing your implementation in our Certification/Sandbox environment helps to id
 
 *Quick Tip*: You can get a head start on your certification by reviewing the [certification tests](https://github.com/hps/heartland-ruby/tree/master/tests) in the included test suite.
 
-####Test Card Data
+#### Test Card Data
 
 The following card numbers are used by our Certification environment to verify that your tests worked. Note that while variations (such as 4111111111111111) will work for general testing the cards listed below are required to complete certification.
 
@@ -178,7 +180,7 @@ The following card numbers are used by our Certification environment to verify t
 	</tbody>
 </table>
 
-####Testing Exceptions
+#### Testing Exceptions
 
 During your integration you will want to test for specific issuer responses such as 'Card Declined'. Because our sandbox does not actually reach out to issuers we have devised specific transaction amounts that will trigger  [issuer response codes](https://cert.api2.heartlandportico.com/Gateway/PorticoDevGuide/build/PorticoDeveloperGuide/Issuer%20Response%20Codes.html) and [gateway response codes](https://cert.api2.heartlandportico.com/Gateway/PorticoDevGuide/build/PorticoDeveloperGuide/Gateway%20Response%20Codes.html). Please <a href="mailto:SecureSubmitCert@e-hps.com?subject=Hard Coded Values Spreadsheet Request">contact</a> Heartland for a complete listing of values you can charge to simulate AVS, CVV and Transaction declines, errors, and other responses that you can catch in your code:
 
@@ -207,7 +209,7 @@ All our code is open sourced and we encourage fellow developers to contribute an
 6. Create new Pull Request
 
 
-####Included Test Suite
+#### Included Test Suite
 
 The included test suite can help ensure your contribution doesn't cause unexpected errors and is a terrific resource of working examples that you can reference. As mentioned earlier, the [certification folder](http://github.hps.com/DevPortal/Ruby-SDK/blob/master/tests/cert_tests.rb) contains tests that mirror the types of requirements you will encounter when you certify your integration for production.
 

data/lib/hps.rb

@@ -25,6 +25,10 @@ require "hps/entities/hps_transaction_header"
 require "hps/entities/hps_transaction_type"
 require "hps/entities/hps_transaction_details"
 require "hps/entities/hps_void"
+require "hps/entities/hps_check"
+require "hps/entities/hps_check_holder"
+require "hps/entities/hps_check_response"
+require "hps/entities/hps_check_response_details"
 
 # Infrastructure
 require "hps/infrastructure/hps_sdk_codes"
@@ -35,10 +39,18 @@ require "hps/infrastructure/card_exception"
 require "hps/infrastructure/invalid_request_exception"
 require "hps/infrastructure/hps_exception_mapper"
 require "hps/infrastructure/hps_track_data_method"
+require "hps/infrastructure/hps_account_type"
+require "hps/infrastructure/hps_check_type"
+require "hps/infrastructure/hps_data_entry_mode"
+require "hps/infrastructure/hps_sec_code"
+require "hps/infrastructure/hps_input_validation"
+require "hps/infrastructure/hps_gateway_response_validation"
+require "hps/infrastructure/hps_check_exception"
 
 # Services
 require "hps/services/hps_service"
 require "hps/services/hps_charge_service"
+require "hps/services/hps_check_service"
 require "hps/services/hps_batch_service"
 
 module Hps

data/lib/hps/configuration.rb

@@ -1,17 +1,17 @@
 module Hps
   module Configuration
 
-    VALID_CONFIG_KEYS = [ :service_uri, :user_name, :password, :developer_id, :version_number, :license_id, :device_id, :site_id, :site_trace, :secret_api_key ].freeze    
+    VALID_CONFIG_KEYS = [ :service_uri, :user_name, :password, :developer_id, :version_number, :license_id, :device_id, :site_id, :site_trace, :secret_api_key, :http_options ].freeze
 
     attr_accessor *VALID_CONFIG_KEYS
 
     def configure
       yield self
     end
-    
+
     def options
       Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
     end
-    
+
   end
-end
+end

data/lib/hps/entities/hps_check.rb

@@ -0,0 +1,18 @@
+module Hps
+  class HpsCheck
+    attr_accessor :routing_number,
+                  :account_number,
+                  :check_number,
+                  :check_type,
+                  :check_holder,
+                  :micr_number,
+                  :account_type,
+                  :data_entry_mode,
+                  :check_verify,
+                  :sec_code
+
+    def initialize
+      @data_entry_mode = HpsDataEntryMode.manual
+    end
+  end
+end

data/lib/hps/entities/hps_check_holder.rb

@@ -0,0 +1,10 @@
+module Hps
+  class HpsCheckHolder < HpsCardHolder
+    attr_accessor :check_name,
+                  :dl_state,
+                  :dl_number,
+                  :ssl4,
+                  :dob_year,
+                  :courtesy_card
+  end
+end

data/lib/hps/entities/hps_check_response.rb

@@ -0,0 +1,45 @@
+module Hps
+  class HpsCheckResponse < HpsTransaction
+    attr_accessor :authorization_code,
+                  :customer_id,
+                  :details
+
+    def self.from_hash(rsp, txn_type)
+      header = rsp["Header"]
+      data = rsp["Transaction"][txn_type.to_s]
+
+      result = HpsCheckResponse.new(HpsService.new.hydrate_transaction_header(header))
+      result.transaction_id = header["GatewayTxnId"]
+      result.authorization_code = data["AuthCode"]
+      result.reference_number = data["RefNbr"]
+      result.response_code = data["RspCode"]
+      result.response_text = data["RspMessage"]
+
+      if data["CheckRspInfo"]
+        result.details = []
+        check_info = data["CheckRspInfo"]
+        if check_info.is_a? Hash
+          result.details = HpsCheckResponse.hydrate_rsp_details(check_info)
+        else
+          check_info.map { |details|
+            result.details.push HpsCheckResponse.hydrate_rsp_details(details)
+          }
+        end
+      end
+
+      result
+    end
+
+    private
+
+    def self.hydrate_rsp_details(check_info)
+      details = HpsCheckResponseDetails.new
+      details.message_type = check_info["Type"]
+      details.code = check_info["Code"]
+      details.message = check_info["Message"]
+      details.field_number = check_info["FieldNumber"]
+      details.field_name = check_info["FieldName"]
+      details
+    end
+  end
+end

data/lib/hps/entities/hps_check_response_details.rb

@@ -0,0 +1,9 @@
+module Hps
+  class HpsCheckResponseDetails
+    attr_accessor :message_type,
+                  :code,
+                  :message,
+                  :field_number,
+                  :field_name
+  end
+end

data/lib/hps/infrastructure/hps_account_type.rb

@@ -0,0 +1,11 @@
+module Hps
+  class HpsAccountType
+    def self.checking
+      'CHECKING'
+    end
+
+    def self.savings
+      'SAVINGS'
+    end
+  end
+end

data/lib/hps/infrastructure/hps_check_exception.rb

@@ -0,0 +1,13 @@
+module Hps
+  class HpsCheckException < HpsException
+    attr_accessor :transaction_id,
+                  :details,
+                  :code
+
+    def initialize(transaction_id, details, code, message = nil)
+      @transaction_id = transaction_id
+      @details = details
+      super(message, code)
+    end
+  end
+end

data/lib/hps/infrastructure/hps_check_type.rb

@@ -0,0 +1,11 @@
+module Hps
+  class HpsCheckType
+    def self.personal
+      'PERSONAL'
+    end
+
+    def self.business
+      'BUSINESS'
+    end
+  end
+end

data/lib/hps/infrastructure/hps_data_entry_mode.rb

@@ -0,0 +1,11 @@
+module Hps
+  class HpsDataEntryMode
+    def self.manual
+      'MANUAL'
+    end
+
+    def self.swipe
+      'SWIPE'
+    end
+  end
+end

data/lib/hps/infrastructure/hps_gateway_response_validation.rb

@@ -0,0 +1,20 @@
+module Hps
+  class HpsGatewayResponseValidation
+    def self.check_response(response, expected_type)
+      response_code = response["Header"]["GatewayRspCode"]
+      response_text = response["Header"]["GatewayRspMsg"]
+      transaction_id = response["Header"]["GatewayTxnId"]
+
+      if !response_code.eql? "0"
+        exception = Hps::ExceptionMapper.new.map_gateway_exception(transaction_id, response_code, response_text)
+        exception.response_code = response_code
+        exception.response_text = response_text
+        raise exception
+      end
+
+      unless response["Transaction"] && response["Transaction"][expected_type.to_s]
+        raise HpsGatewayException
+      end
+    end
+  end
+end

data/lib/hps/infrastructure/hps_input_validation.rb

@@ -0,0 +1,13 @@
+module Hps
+  class HpsInputValidation
+    def self.check_amount(amount)
+      if amount < 0 || amount == nil
+        raise InvalidRequestException
+      end
+
+      return amount if amount.is_a? Float
+
+      amount.gsub(/[^0-9\.]/, '')
+    end
+  end
+end

data/lib/hps/infrastructure/hps_sec_code.rb

@@ -0,0 +1,27 @@
+module Hps
+  class HpsSECCode
+    def self.ppd
+      'PPD'
+    end
+
+    def self.ccd
+      'CCD'
+    end
+
+    def self.pop
+      'POP'
+    end
+
+    def self.web
+      'WEB'
+    end
+
+    def self.tel
+      'TEL'
+    end
+
+    def self.e_bronze
+      'eBronze'
+    end
+  end
+end

data/lib/hps/services/hps_charge_service.rb

@@ -1,11 +1,11 @@
 module Hps
-	class HpsChargeService < HpsService
+  class HpsChargeService < HpsService
 
-		def get(transaction_id)
+    def get(transaction_id)
 
-			if transaction_id.nil? or transaction_id == 0
-				raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_transaction_id)
-			end
+      if transaction_id.nil? or transaction_id == 0
+        raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_transaction_id)
+      end
 
       xml = Builder::XmlMarkup.new
       xml.hps :Transaction do
@@ -14,65 +14,65 @@ module Hps
         end
       end
 
-			response = doTransaction(xml.target!)
+      response = doTransaction(xml.target!)
       detail = response["Transaction"]["ReportTxnDetail"]
 
-			header = hydrate_transaction_header(response["Header"])
-			result = HpsReportTransactionDetails.new(header)
-			result.transaction_id = detail["GatewayTxnId"]
-			result.original_transaction_id = detail["OriginalGatewayTxnId"]
-			result.authorized_amount = detail["Data"]["AuthAmt"]
-			result.authorization_code = detail["Data"]["AuthCode"]
-			result.avs_result_code = detail["Data"]["AVSRsltCode"]
-			result.avs_result_text = detail["Data"]["AVSRsltText"]
-			result.card_type = detail["Data"]["CardType"]
-			result.masked_card_number = detail["Data"]["MaskedCardNbr"]
-			result.transaction_type = Hps.service_name_to_transaction_type(detail["ServiceName"])
-			result.transaction_date = detail["RspUtcDT"]
-			result.cpc_indicator = detail["Data"]["CPCInd"]
-			result.cvv_result_code = detail["Data"]["CVVRsltCode"]
-			result.cvv_result_text = detail["Data"]["CVVRsltText"]
+      header = hydrate_transaction_header(response["Header"])
+      result = HpsReportTransactionDetails.new(header)
+      result.transaction_id = detail["GatewayTxnId"]
+      result.original_transaction_id = detail["OriginalGatewayTxnId"]
+      result.authorized_amount = detail["Data"]["AuthAmt"]
+      result.authorization_code = detail["Data"]["AuthCode"]
+      result.avs_result_code = detail["Data"]["AVSRsltCode"]
+      result.avs_result_text = detail["Data"]["AVSRsltText"]
+      result.card_type = detail["Data"]["CardType"]
+      result.masked_card_number = detail["Data"]["MaskedCardNbr"]
+      result.transaction_type = Hps.service_name_to_transaction_type(detail["ServiceName"])
+      result.transaction_date = detail["RspUtcDT"]
+      result.cpc_indicator = detail["Data"]["CPCInd"]
+      result.cvv_result_code = detail["Data"]["CVVRsltCode"]
+      result.cvv_result_text = detail["Data"]["CVVRsltText"]
       result.reference_number = detail["Data"]["RefNbr"]
       result.response_code = detail["Data"]["RspCode"]
       result.response_text = detail["Data"]["RspText"]
 
-			tokenization_message = detail["Data"]["TokenizationMsg"]
+      tokenization_message = detail["Data"]["TokenizationMsg"]
 
-			unless tokenization_message.nil?
-				result.token_data = HpsTokenData.new(tokenization_message)
-			end
+      unless tokenization_message.nil?
+        result.token_data = HpsTokenData.new(tokenization_message)
+      end
 
-			header_response_code = response["Header"]["GatewayRspCode"]
-			data_response_code = detail["Data"]["RspCode"]
+      header_response_code = response["Header"]["GatewayRspCode"]
+      data_response_code = detail["Data"]["RspCode"]
 
-			if header_response_code != "0" or data_response_code != "00"
+      if header_response_code != "0" or data_response_code != "0" or data_response_code != "00"
 
-				exceptions = HpsChargeExceptions.new()
+        exceptions = HpsChargeExceptions.new()
 
-				if header_response_code != "0"
-					message = response["Header"]["GatewayRspMsg"]
-					exceptions.hps_exception = @exception_mapper.map_gateway_exception(result.transaction_id, header_response_code, message)
-				end
+        if header_response_code != "0"
+          message = response["Header"]["GatewayRspMsg"]
+          exceptions.hps_exception = @exception_mapper.map_gateway_exception(result.transaction_id, header_response_code, message)
+        end
 
-				if data_response_code != "0"
-					message = detail["Data"]["RspText"]
-					exceptions.card_exception = @exception_mapper.map_issuer_exception(transaction_id, data_response_code, message)
-				end
+        if data_response_code != "0" || data_response_code != "00"
+          message = detail["Data"]["RspText"]
+          exceptions.card_exception = @exception_mapper.map_issuer_exception(transaction_id, data_response_code, message)
+        end
 
-				result.exceptions = exceptions
+        result.exceptions = exceptions
 
-			end
+      end
 
-			result
+      result
 
-		end
+    end
 
-		def list(start_date, end_date, filter_by = nil)
+    def list(start_date, end_date, filter_by = nil)
 
       if start_date > DateTime.now
-				raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_start_date)
+        raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_start_date)
       elsif end_date > DateTime.now
-				raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_end_date)
+        raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_end_date)
       end
 
       xml = Builder::XmlMarkup.new
@@ -83,62 +83,62 @@ module Hps
         end
       end
 
-			response = doTransaction(xml.target!)
+      response = doTransaction(xml.target!)
 
-			# Gateway exception
-			if response["Header"]["GatewayRspCode"] != "0"
-				transaction_id = response["Header"]["GatewayTxnId"]
-				response_code = response["Header"]["GatewayRspCode"]
-				response_message = response["Header"]["GatewayRspMsg"]
-				raise @exception_mapper.map_gateway_exception(transaction_id, response_code, response_message)
-			end
+      # Gateway exception
+      if response["Header"]["GatewayRspCode"] != "0"
+        transaction_id = response["Header"]["GatewayTxnId"]
+        response_code = response["Header"]["GatewayRspCode"]
+        response_message = response["Header"]["GatewayRspMsg"]
+        raise @exception_mapper.map_gateway_exception(transaction_id, response_code, response_message)
+      end
 
-			result = Array.new
+      result = Array.new
 
       if response["Transaction"]["ReportActivity"]["Header"]["TxnCnt"] == "0"
         return result
       end
 
-			response["Transaction"]["ReportActivity"]["Details"].each { |charge|
+      response["Transaction"]["ReportActivity"]["Details"].each { |charge|
 
-				next if !filter_by.nil? and charge.serviceName != Hps.transaction_type_to_service_name(filter_by)
+        next if !filter_by.nil? and charge.serviceName != Hps.transaction_type_to_service_name(filter_by)
 
-				summary = HpsReportTransactionSummary.new()
-				summary.transaction_id = charge["GatewayTxnId"]
-				summary.original_transaction_id = charge["OriginalGatewayTxnId"]
-				summary.masked_card_number = charge["MaskedCardNbr"]
-				summary.response_code = charge["IssuerRspCode"]
-				summary.response_text = charge["IssuerRspText"]
-				summary.transaction_type = Hps.transaction_type_to_service_name(charge["ServiceName"]) if filter_by.nil? == false
+        summary = HpsReportTransactionSummary.new()
+        summary.transaction_id = charge["GatewayTxnId"]
+        summary.original_transaction_id = charge["OriginalGatewayTxnId"]
+        summary.masked_card_number = charge["MaskedCardNbr"]
+        summary.response_code = charge["IssuerRspCode"]
+        summary.response_text = charge["IssuerRspText"]
+        summary.transaction_type = Hps.transaction_type_to_service_name(charge["ServiceName"]) if filter_by.nil? == false
 
-				gw_response_code = charge["GatewayRspCode"]
-				issuer_response_code = charge["IssuerRspCode"]
+        gw_response_code = charge["GatewayRspCode"]
+        issuer_response_code = charge["IssuerRspCode"]
 
-				if gw_response_code != "0" or issuer_response_code != "00"
+        if gw_response_code != "0" or issuer_response_code != "0" or issuer_response_code != "00"
 
-					exceptions = HpsChargeExceptions.new()
+          exceptions = HpsChargeExceptions.new()
 
-					if gw_response_code != "0"
-						message = charge["GatewayRspMsg"]
-						exceptions.hps_exception = @exception_mapper.map_gateway_exception(charge["GatewayTxnId"], gw_response_code, message)
-					end
+          if gw_response_code != "0"
+            message = charge["GatewayRspMsg"]
+            exceptions.hps_exception = @exception_mapper.map_gateway_exception(charge["GatewayTxnId"], gw_response_code, message)
+          end
 
-					if issuer_response_code != "0"
-						message = charge["IssuerRspText"]
-						exceptions.card_exception = @exception_mapper.map_issuer_exception(charge["GatewayTxnId"], issuer_response_code, message)
-					end
+          if issuer_response_code != "0" || issuer_response_code != "00"
+            message = charge["IssuerRspText"]
+            exceptions.card_exception = @exception_mapper.map_issuer_exception(charge["GatewayTxnId"], issuer_response_code, message)
+          end
 
-					summary.exceptions = exceptions
+          summary.exceptions = exceptions
 
-				end
+        end
 
-				result << summary
-			}
+        result << summary
+      }
 
-			result
-		end
+      result
+    end
 
-		def charge(amount, currency, card, card_holder = nil, request_multi_use_token = false, details = nil, txn_descriptor = nil)
+    def charge(amount, currency, card, card_holder = nil, request_multi_use_token = false, details = nil, txn_descriptor = nil)
       check_amount(amount)
       check_currency(currency)
 
@@ -171,9 +171,9 @@ module Hps
       end
 
       submit_charge(xml.target!, amount, currency)
-		end
+    end
 
-		def charge_swipe(amount, currency, track_data, encryption_data = nil, gratuity = 0, allow_partial_auth = false, txn_descriptor = nil, request_multi_use_token = false, direct_market_data = nil)
+    def charge_swipe(amount, currency, track_data, encryption_data = nil, gratuity = 0, allow_partial_auth = false, txn_descriptor = nil, request_multi_use_token = false, direct_market_data = nil)
       check_amount(amount)
       check_currency(currency)
 
@@ -197,7 +197,7 @@ module Hps
       end
 
       submit_charge(xml.target!, amount, currency)
-		end
+    end
 
     def verify(card, card_holder = nil, request_multi_use_token = false, client_txn_id = nil)
 
@@ -435,16 +435,16 @@ module Hps
 
       submit_void(xml.target!)
     end
-		private
+    private
 
-		def check_amount(amount)
-			raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_amount) if amount.nil? or amount <= 0
-		end
+    def check_amount(amount)
+      raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_amount) if amount.nil? or amount <= 0
+    end
 
-		def check_currency(currency)
-			raise @exception_mapper.map_sdk_exception(SdkCodes.missing_currency) if currency.empty?
-			raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_currency) unless currency.downcase.eql? "usd"
-		end
+    def check_currency(currency)
+      raise @exception_mapper.map_sdk_exception(SdkCodes.missing_currency) if currency.empty?
+      raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_currency) unless currency.downcase.eql? "usd"
+    end
 
     def hydrate_cardholder_data(card_holder)
       xml = Builder::XmlMarkup.new
@@ -719,7 +719,7 @@ module Hps
         exception.response_text = response_text
         raise exception
 
-      elsif !response_code.eql? "00"
+      elsif !response_code.eql? "00" && !response_code.eql? "0"
 
         exception = @exception_mapper.map_issuer_exception(transaction_id, response_code, response_text)
         exception.response_code = response_code
@@ -730,6 +730,6 @@ module Hps
 
     end
 
-	end
+  end
 
 end

data/lib/hps/services/hps_check_service.rb

@@ -0,0 +1,110 @@
+module Hps
+  class HpsCheckService < HpsService
+    def sale(check, amount, client_txn_id = nil)
+      build_transaction('SALE', check, amount, client_txn_id)
+    end
+
+    def void(transaction_id = nil, client_txn_id = nil)
+      if (transaction_id == nil && client_txn_id == nil) ||
+          (transaction_id != nil && client_txn_id != nil)
+        raise Error, 'Please provide either a transaction ID or a client transaction ID'
+      end
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps :CheckVoid do
+          xml.hps :Block1 do
+            xml.hps :GatewayTxnId, transaction_id if transaction_id
+            xml.hps :ClientTxnId, client_txn_id if client_txn_id
+          end
+        end
+      end
+
+      submit_transaction(xml.target!, :CheckVoid)
+    end
+
+    private
+
+    def build_transaction(action, check, amount, client_txn_id)
+      amount = HpsInputValidation::check_amount(amount)
+
+      if check.sec_code == HpsSECCode.ccd &&
+          (check.check_holder == nil || check.check_holder.check_name == nil)
+        raise Error, 'For SEC code CCD, the check name is require', 'check_name'
+      end
+
+      xml = Builder::XmlMarkup.new
+      xml.hps :Transaction do
+        xml.hps :CheckSale do
+          xml.hps :Block1 do
+            xml.hps :Amt, amount
+            xml << hydrate_check_data(check)
+            xml.hps :CheckAction, action
+            xml.hps :SECCode, check.sec_code
+            xml.hps :CheckType, check.check_type if check.check_type
+            xml << hydrate_consumer_info(check.check_holder) if check.check_holder
+          end
+        end
+      end
+
+      submit_transaction(xml.target!, :CheckSale, client_txn_id)
+    end
+
+    def hydrate_check_data(check)
+      xml = Builder::XmlMarkup.new
+      xml.hps :AccountInfo do
+        xml.hps :AccountNumber, check.account_number if check.account_number
+        xml.hps :CheckNumber, check.check_number if check.check_number
+        xml.hps :MICRData, check.micr_number if check.micr_number
+        xml.hps :RoutingNumber, check.routing_number if check.routing_number
+        xml.hps :AccountType, check.account_type if check.account_type
+      end
+      xml.target!
+    end
+
+    def hydrate_consumer_info(check_holder)
+      xml = Builder::XmlMarkup.new
+      xml.hps :ConsumerInfo do
+        if check_holder.address
+          xml.hps :Address1, check_holder.address.address if check_holder.address.address
+          xml.hps :City, check_holder.address.city if check_holder.address.city
+          xml.hps :State, check_holder.address.state if check_holder.address.state
+          xml.hps :Zip, check_holder.address.zip if check_holder.address.zip
+        end
+
+        xml.hps :CheckName, check_holder.check_name if check_holder.check_name
+        xml.hps :CourtesyCard, check_holder.courtesy_card if check_holder.courtesy_card
+        xml.hps :DLNumber, check_holder.dl_number if check_holder.dl_number
+        xml.hps :DLState, check_holder.dl_state if check_holder.dl_state
+        xml.hps :EmailAddress, check_holder.email if check_holder.email_address
+        xml.hps :FirstName, check_holder.first_name if check_holder.first_name
+        xml.hps :LastName, check_holder.last_name if check_holder.last_name
+        xml.hps :PhoneNumber, check_holder.phone if check_holder.phone
+
+        if check_holder.ssl4 || check_holder.dob_year
+          xml.hps :IdentityInfo do
+            xml.hps :SSNL4, check_holder.ssl4 if check_holder.ssl4
+            xml.hps :DOBYear, check_holder.dob_year if check_holder.dob_year
+          end
+        end
+      end
+
+      xml.target!
+    end
+
+    def submit_transaction(xml, txn_type, client_txn_id = nil)
+      response = doTransaction(xml, client_txn_id)
+      HpsGatewayResponseValidation::check_response(response, txn_type)
+      response = HpsCheckResponse::from_hash(response, txn_type)
+
+      return response if response.response_code == '0'
+
+      raise HpsCheckException.new(
+        response.transaction_id,
+        response.details,
+        response.response_code,
+        response.response_text
+      )
+    end
+  end
+end

data/lib/hps/services/hps_service.rb

@@ -20,7 +20,7 @@ module Hps
 
 		#protected
 
-		def doTransaction(transaction)
+		def doTransaction(transaction, client_txn_id = nil)
 
 			if configuration_invalid
       	raise @exception_mapper.map_sdk_exception(SdkCodes.invalid_transaction_id)
@@ -48,6 +48,7 @@ module Hps
           			xml.hps :DeveloperID, self.developer_id if self.developer_id
           			xml.hps :VersionNbr, self.version_number if self.version_number
           			xml.hps :SiteTrace, self.site_trace if self.site_trace
+                xml.hps :ClientTxnId, client_txn_id if client_txn_id
               end
 
               xml << transaction
@@ -62,7 +63,15 @@ module Hps
         uri = URI.parse(self.service_uri)
         http = Net::HTTP.new uri.host, uri.port
         http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+        # allow SSL verification as opt-in
+        if self.http_options && self.http_options.verify_mode
+          http.verify_mode = self.http_options.verify_mode
+          http.ca_file = self.http_options.ca_file if self.http_options.ca_file
+        else
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
         data = xml.target!
 
         response = http.post(uri.path, data, 'Content-type' => 'text/xml')

data/lib/hps/version.rb

@@ -1,3 +1,3 @@
 module Hps
-  VERSION = "2.1.2"
+  VERSION = "2.2.1"
 end

data/tests/check_tests.rb

@@ -0,0 +1,50 @@
+require File.join( File.dirname(__FILE__), "test_helper.rb" )
+
+describe "Check Tests" do
+  before(:each) do
+    Hps::TestHelper.configure_hps_module_secret_key_with_spaces
+    @service = Hps::HpsCheckService.new()
+  end
+
+  it "check should decline" do
+    expect {
+      @service.sale(Hps::TestCheck::decline, 5.00)
+    }.to raise_error(Hps::HpsCheckException) { |error|
+      expect(error.code).to eql("1")
+    }
+  end
+
+  it "should throw check exception" do
+    expect {
+      @service.sale(Hps::TestCheck::invalid_check_holder, 5.00)
+    }.to raise_error(Hps::HpsCheckException) { |error|
+      expect(error.code).to eql("1")
+    }
+  end
+
+  it "check should sale" do
+    result = @service.sale(Hps::TestCheck::approve, 5.00)
+    expect(result).not_to eql(nil)
+    expect(result.response_code).to eql("0")
+    expect(result.response_text).to eql("Transaction Approved")
+  end
+
+  it "check should void" do
+    sale_result = @service.sale(Hps::TestCheck::approve, 5.00)
+    result = @service.void(sale_result.transaction_id)
+    expect(result).not_to eql(nil)
+    expect(result.response_code).to eql("0")
+  end
+
+  it "sale and void with client_txn_id" do
+    client_txn_id = 10244205
+    sale_result = @service.sale(Hps::TestCheck::approve, 5.00, client_txn_id)
+    expect(sale_result).not_to eql(nil)
+    expect(sale_result.response_code).to eql("0")
+    expect(sale_result.response_text).to eql("Transaction Approved")
+
+    void_result = @service.void(nil, client_txn_id)
+    expect(void_result).not_to eql(nil)
+    expect(void_result.response_code).to eql("0")
+  end
+end

data/tests/test_check.rb

@@ -0,0 +1,77 @@
+require 'hps'
+
+module Hps
+  module TestCheck
+    def self.approve
+      check = HpsCheck.new()
+      check.account_number = '24413815'
+      check.routing_number = '490000018'
+      check.check_type = HpsCheckType.personal
+      check.account_type = HpsAccountType.checking
+      check.sec_code = HpsSECCode.ppd
+
+      check.check_holder = HpsCheckHolder.new()
+      check.check_holder.first_name = "Bill"
+      check.check_holder.last_name = "Johnson"
+      check.check_holder.address = HpsAddress.new
+      check.check_holder.address.address = "One Heartland Way"
+      check.check_holder.address.city = "Jeffersonville"
+      check.check_holder.address.state = "IN"
+      check.check_holder.address.zip = "47130"
+      check.check_holder.address.country = "United States"
+      check.check_holder.dl_number = '1234567'
+      check.check_holder.dl_state = 'TX'
+      check.check_holder.phone = '1234567890'
+
+      check
+    end
+
+    def self.invalid_check_holder
+      check = HpsCheck.new()
+      check.account_number = '24413815'
+      check.routing_number = '490000018'
+      check.check_type = HpsCheckType.personal
+      check.account_type = HpsAccountType.checking
+      check.sec_code = HpsSECCode.ppd
+
+      check.check_holder = HpsCheckHolder.new()
+      check.check_holder.first_name = "Bill"
+      check.check_holder.last_name = "Johnson"
+      check.check_holder.address = HpsAddress.new
+      check.check_holder.address.address = "One Heartland Way"
+      check.check_holder.address.city = "Jeffersonville"
+      check.check_holder.address.state = "IN"
+      check.check_holder.address.zip = "47130"
+      check.check_holder.address.country = "United States"
+      check.check_holder.dl_number = ''
+      check.check_holder.dl_state = ''
+      check.check_holder.phone = '1234567890'
+
+      check
+    end
+
+    def self.decline
+      check = HpsCheck.new()
+      check.account_number = '24413815'
+      check.routing_number = '490000034'
+      check.check_type = HpsCheckType.personal
+      check.account_type = HpsAccountType.checking
+      check.sec_code = HpsSECCode.ppd
+
+      check.check_holder = HpsCheckHolder.new()
+      check.check_holder.first_name = "Bill"
+      check.check_holder.last_name = "Johnson"
+      check.check_holder.address = HpsAddress.new
+      check.check_holder.address.address = "One Heartland Way"
+      check.check_holder.address.city = "Jeffersonville"
+      check.check_holder.address.state = "IN"
+      check.check_holder.address.zip = "47130"
+      check.check_holder.address.country = "United States"
+      check.check_holder.dl_number = '1234567'
+      check.check_holder.dl_state = 'TX'
+      check.check_holder.phone = '1234567890'
+
+      check
+    end
+  end
+end

data/tests/test_helper.rb

@@ -1,4 +1,5 @@
 require File.join( File.dirname(__FILE__), "test_data.rb" )
+require File.join( File.dirname(__FILE__), "test_check.rb" )
 require "hps"
 require "rspec"
 
@@ -25,13 +26,13 @@ module Hps
         config.secret_api_key = "skapi_uat_MXZOAAC7LmEFVeOYGlVHe_WhvRf_UzWzJq5VJ8A-jA"
       end
     end
-	
+
     def self.configure_hps_module_secret_key_with_spaces
       Hps.configure do |config|
         #config.service_uri = "https://cert.api2.heartlandportico.com/Hps.Exchange.PosGateway/PosGatewayService.asmx?wsdl"
         config.secret_api_key = "  skapi_cert_MYl2AQAowiQAbLp5JesGKh7QFkcizOP2jcX9BrEMqQ  "
       end
-    end	
+    end
 
     def self.configure_hps_module_for_certification
       Hps.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hps
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.1
 platform: ruby
 authors:
 - Heartland Payment Systems
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2017-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,6 +129,10 @@ files:
 - lib/hps/entities/hps_cardholder.rb
 - lib/hps/entities/hps_charge.rb
 - lib/hps/entities/hps_charge_exceptions.rb
+- lib/hps/entities/hps_check.rb
+- lib/hps/entities/hps_check_holder.rb
+- lib/hps/entities/hps_check_response.rb
+- lib/hps/entities/hps_check_response_details.rb
 - lib/hps/entities/hps_credit_card.rb
 - lib/hps/entities/hps_direct_market_data.rb
 - lib/hps/entities/hps_encryption_data.rb
@@ -147,24 +151,34 @@ files:
 - lib/hps/infrastructure/authentication_exception.rb
 - lib/hps/infrastructure/card_exception.rb
 - lib/hps/infrastructure/exceptions.json
+- lib/hps/infrastructure/hps_account_type.rb
+- lib/hps/infrastructure/hps_check_exception.rb
+- lib/hps/infrastructure/hps_check_type.rb
+- lib/hps/infrastructure/hps_data_entry_mode.rb
 - lib/hps/infrastructure/hps_exception.rb
 - lib/hps/infrastructure/hps_exception_mapper.rb
+- lib/hps/infrastructure/hps_gateway_response_validation.rb
+- lib/hps/infrastructure/hps_input_validation.rb
 - lib/hps/infrastructure/hps_sdk_codes.rb
+- lib/hps/infrastructure/hps_sec_code.rb
 - lib/hps/infrastructure/hps_track_data_method.rb
 - lib/hps/infrastructure/invalid_request_exception.rb
 - lib/hps/services/hps_batch_service.rb
 - lib/hps/services/hps_charge_service.rb
+- lib/hps/services/hps_check_service.rb
 - lib/hps/services/hps_service.rb
 - lib/hps/version.rb
 - tests/amex_tests.rb
 - tests/cert_tests.rb
 - tests/certification/card_present_spec.rb
+- tests/check_tests.rb
 - tests/discover_tests.rb
 - tests/exception_mapper_tests.rb
 - tests/general_tests.rb
 - tests/hps_token_service.rb
 - tests/mastercard_tests.rb
 - tests/secret_key.rb
+- tests/test_check.rb
 - tests/test_data.rb
 - tests/test_helper.rb
 - tests/token_tests.rb
@@ -189,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Heartland Payment Systems - Portico Gateway SDK