hps 2.2.5 → 2.3.2

data/tests/giftcard_tests.rb

@@ -0,0 +1,212 @@
+require File.join( File.dirname(__FILE__), "test_helper" )
+
+describe "Giftcard Tests" do
+
+  # Activate a card
+  it "When card is ok, it should activate and return valid response" do
+    response = Hps::TestHelper.activate_valid_gift_card(100.00)
+    expect( response.response_code ).to eql("0")
+    expect( response ).to be_a(Hps::HpsGiftCardActivate)
+  end
+
+  # Add value to a card
+  it "When card is ok, it should add value and return a valid response" do
+    response = Hps::TestHelper.add_value_to_valid_gift_card(100.00)
+    expect( response.response_code ).to eql("0")
+    expect( response ).to be_a(Hps::HpsGiftCardAddValue)
+  end
+
+  # Check the balance on a card
+  it "When card is ok, it should return valid response" do
+    response = Hps::TestHelper.balance_valid_gift_card
+    expect( response.response_code ).to eql("0")
+    expect( response ).to be_a(Hps::HpsGiftCardBalance)
+  end
+
+  # Deactivate a card
+  it "When card is ok, it should deactivate and return a valid response" do
+    response = Hps::TestHelper.deactivate_valid_gift_card
+    expect( response.response_code ).to eql("0")
+    expect( response ).to be_a(Hps::HpsGiftCardDeactivate)
+  end
+
+  # Replace a card
+  it "When card is ok, it should replace it and return a valid response" do
+    response = Hps::TestHelper.replace_valid_gift_card
+    expect( response.response_code ).to eql("0")
+    expect( response ).to be_a(Hps::HpsGiftCardReplace)
+  end
+
+  # Add rewards to a card
+  it "When card is ok, it should add rewards and return a valid response" do
+    ["USD", "POINTS"].each do |currency|
+      response = Hps::TestHelper.reward_valid_gift_card(10.00, currency)
+      expect( response.response_code ).to eql("0")
+      expect( response ).to be_a(Hps::HpsGiftCardReward)
+    end
+  end
+
+  # Complete a sale
+  it "When card is ok, it should complete a sale and return a valid response" do
+    response = Hps::TestHelper.sale_valid_gift_card(10.00)
+    expect( response.response_code ).to eql("0")
+    expect( response ).to be_a(Hps::HpsGiftCardSale)
+  end
+
+  # Void a transaction
+  it "Should void a transaction" do
+    response = Hps::TestHelper.sale_valid_gift_card(10.00)
+    expect( response.response_code ).to eql("0")
+    void_response = Hps::TestHelper.void_gift_card_sale( response.transaction_id )
+    expect( void_response.response_code ).to eql("0")
+    expect( void_response ).to be_a(Hps::HpsGiftCardVoid)
+  end
+
+  # Reverse a transaction using transaction id
+  it "Should reverse a gift card transaction using the transaction id" do
+    response = Hps::TestHelper.sale_valid_gift_card(10.00)
+    expect( response.response_code ).to eql("0")
+    reverse_response = Hps::TestHelper.reverse_gift_card_sale( 10.00, response.transaction_id )
+    expect( reverse_response.response_code ).to eql("0")
+    expect( reverse_response ).to be_a(Hps::HpsGiftCardReversal)
+  end
+
+  # Reverse transaction using giftcard
+  it "Should reverse a giftcard transaction using the card" do
+    response = Hps::TestHelper.sale_valid_gift_card(10.00, "USD", nil, nil, false)
+    expect( response.response_code ).to eql("0")
+    reverse_response = Hps::TestHelper.reverse_gift_card_sale(10.00)
+    expect( reverse_response.response_code ).to eql("0")
+    expect( reverse_response ).to be_a(Hps::HpsGiftCardReversal)
+  end
+
+  context "exceptions for transactions" do
+    before(:all) do
+      @mapper = Hps::ExceptionMapper.new
+    end
+
+    # Amounts less than zero
+    it "raises an exception for amounts less than zero" do
+      %i{activate add_value reward sale reverse}.each do |method|
+        expect{ Hps::TestHelper.gift_card_transaction_exception(-1.00, method) }.to raise_exception{|e|
+          expect(e).to be_a( Hps::InvalidRequestException )
+          expect(e.message).to eql("Amount must be greater than or equal 0.")
+        }
+      end
+    end
+
+    # Profile auth fails
+    it "should raise an exception if profile auth fails" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(2.01) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql("ProfileError Subject 'ProfileAuthorizationFailed'.")
+      }
+    end
+
+    # Profile closed
+    it "should raise an exception if profile is closed" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(2.02) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql("ProfileError Subject 'ProfileClosed'.")
+      }
+    end
+
+    # Profile not found
+    it "should raise an exception if profile is not found" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(2.03) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql("ProfileError")
+      }
+    end
+
+    # Profile frozen
+    it "should raise an exception if profile is frozen" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(2.04) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql("ProfileError Subject 'ProfileFrozen'.")
+      }
+    end
+
+    # Insufficient funds - card decline - code 5
+    it "should raise an exception if insufficient funds" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(3.01) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql(message_for_code("Exception_Message_CardDeclined"))
+      }
+    end
+
+    # Insufficient activation amount - card decline - code 5
+    it "should raise an exception if insufficient activation amount" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(3.02) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql(message_for_code("Exception_Message_CardDeclined"))
+      }
+    end
+
+    # Insufficient load amount - card decline - code 5
+    it "should raise an exception if insufficient load amount" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(3.03) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql(message_for_code("Exception_Message_CardDeclined"))
+      }
+    end
+
+    # Invalid Payment Type - unknown gift error - code 1
+    it "should raise an exception if insufficient load amount" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(3.04) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql("SystemError Subject 'InvalidPaymentType'.")
+      }
+    end
+
+    # Provide an invalid PIN - code 14
+    it "Should raise an exception if PIN is invalid" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(3.05) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql(message_for_code("Exception_Message_InvalidPin"))
+      }
+    end
+
+    # Invalid seller ID - unknown gift error - code 1
+    it "should raise an exception if invalid seller profile ID" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(3.06) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql("SystemError")
+      }
+    end
+
+    # Order exists - processing error - code 7
+    it "should raise an exception if invalid seller profile ID" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(3.07) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql(message_for_code("Exception_Message_ProcessingError"))
+      }
+    end
+
+    # Registration required - invalid card data - code 3
+    it "should raise an exception if invalid seller profile ID" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(3.08) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql(message_for_code("Exception_Message_InvalidCardData"))
+      }
+    end
+
+    # Account not active - invalid card data - code 8
+    it "should raise an exception if invalid seller profile ID" do
+      expect{ Hps::TestHelper.gift_card_transaction_exception(3.09) }.to raise_exception {|e|
+        expect(e).to be_a(Hps::CardException)
+        expect(e.message).to eql(message_for_code("Exception_Message_InvalidCardData"))
+      }
+    end
+
+  end
+end # Giftcard Tests
+
+# Helper methods
+def message_for_code(code)
+  mapping = @mapper.exceptions["exception_messages"].detect { |message|
+    message["code"] == code
+  }
+
+  mapping["message"] unless mapping.nil?
+end

data/tests/test_data.rb

@@ -2,9 +2,9 @@ require 'hps'
 
 module Hps
   module TestData
-  
+
     # card holders
-  
+
     def self.valid_cardholder
       result = HpsCardHolder.new()
       result.first_name = "Bill"
@@ -17,7 +17,7 @@ module Hps
       result.address.country = "United States"
       result
     end
-  
+
     def self.cert_cardholder_shortzip
       result = HpsCardHolder.new()
       result.first_name = "Bill"
@@ -27,10 +27,10 @@ module Hps
       result.address.city = "Irvine"
       result.address.state = "TX"
       result.address.zip = "75024"
-      result.address.country = "United States"    
-      result    
+      result.address.country = "United States"
+      result
     end
-  
+
     def self.cert_cardholder_shortzip_no_street
       result = HpsCardHolder.new()
       result.first_name = "Bill"
@@ -39,10 +39,10 @@ module Hps
       result.address.city = "Irvine"
       result.address.state = "TX"
       result.address.zip = "75024"
-      result.address.country = "United States"    
-      result    
+      result.address.country = "United States"
+      result
     end
-  
+
     def self.cert_cardholder_longzip
       result = HpsCardHolder.new()
       result.first_name = "Bill"
@@ -52,10 +52,10 @@ module Hps
       result.address.city = "Irvine"
       result.address.state = "TX"
       result.address.zip = "750241234"
-      result.address.country = "United States"    
-      result    
+      result.address.country = "United States"
+      result
     end
-  
+
     def self.cert_cardholder_longzip_no_street
       result = HpsCardHolder.new()
       result.first_name = "Bill"
@@ -64,12 +64,12 @@ module Hps
       result.address.city = "Irvine"
       result.address.state = "TX"
       result.address.zip = "750241234"
-      result.address.country = "United States"    
-      result    
+      result.address.country = "United States"
+      result
     end
-  
+
     # credit cards
-  
+
     def self.valid_visa
       result = HpsCreditCard.new
       result.cvv = 123
@@ -78,7 +78,7 @@ module Hps
       result.number = 4012002000060016
       result
     end
-  
+
     def self.valid_mastercard
       result = HpsCreditCard.new
       result.cvv = 123
@@ -87,7 +87,7 @@ module Hps
       result.number = 5473500000000014
       result
     end
-  
+
     def self.valid_discover
       result = HpsCreditCard.new
       result.cvv = 123
@@ -96,7 +96,7 @@ module Hps
       result.number = 6011000990156527
       result
     end
-  
+
     def self.valid_amex
       result = HpsCreditCard.new
       result.cvv = 1234
@@ -105,7 +105,7 @@ module Hps
       result.number = 372700699251018
       result
     end
-  
+
     def self.valid_jcb
       result = HpsCreditCard.new
       result.cvv = 123
@@ -114,7 +114,7 @@ module Hps
       result.number = 3566007770007321
       result
     end
-  
+
     def self.invalid_card
       result = HpsCreditCard.new
       result.cvv = 123
@@ -123,6 +123,16 @@ module Hps
       result.number = 12345
       result
     end
-  
+
+    #  =============
+    #  = Giftcards =
+    #  =============
+    TEST_CARD_NUMBERS = (6277200000000001..6277200000000099)
+
+    def self.valid_gift_card_not_encrypted(random = true)
+      return HpsGiftCard.new(Random.rand(TEST_CARD_NUMBERS)) if random
+      return HpsGiftCard.new(TEST_CARD_NUMBERS.first) if !random
+    end # valid_gift_card_not_encrypted
+
   end
 end

data/tests/test_helper.rb

@@ -112,5 +112,68 @@ module Hps
       end
     end
 
+    #  =============
+    #  = Giftcards =
+    #  =============
+    def self.balance_valid_gift_card
+      TestHelper.valid_multi_use_config
+      service = Hps::HpsGiftCardService.new
+      service.balance( TestData.valid_gift_card_not_encrypted )
+    end # balance_valid_gift_card
+
+    def self.activate_valid_gift_card(amount)
+      TestHelper.valid_multi_use_config
+      service = Hps::HpsGiftCardService.new
+      service.activate( TestData.valid_gift_card_not_encrypted, amount, 'USD' )
+    end # activate_valid_gift_card
+
+    def self.add_value_to_valid_gift_card(amount)
+      TestHelper.valid_multi_use_config
+      service = Hps::HpsGiftCardService.new
+      service.add_value( TestData.valid_gift_card_not_encrypted, amount, 'USD' )
+    end # add_value_to_valid_gift_card
+
+    def self.deactivate_valid_gift_card
+      TestHelper.valid_multi_use_config
+      service = Hps::HpsGiftCardService.new
+      service.deactivate( TestData.valid_gift_card_not_encrypted )
+    end # deactivate_valid_gift_card
+
+    def self.replace_valid_gift_card
+      TestHelper.valid_multi_use_config
+      service = Hps::HpsGiftCardService.new
+      service.replace( TestData.valid_gift_card_not_encrypted, TestData.valid_gift_card_not_encrypted )
+    end # replace_valid_gift_card
+
+    def self.reward_valid_gift_card(amount, currency = "USD", gratuity = nil, tax = nil)
+      TestHelper.valid_multi_use_config
+      service = Hps::HpsGiftCardService.new
+      service.reward( TestData.valid_gift_card_not_encrypted, amount, 'USD', gratuity, tax )
+    end # reward_valid_gift_card
+
+    def self.sale_valid_gift_card(amount, currency = "USD", gratuity = nil, tax = nil, random_card = true)
+      TestHelper.valid_multi_use_config
+      service = Hps::HpsGiftCardService.new
+      service.sale( TestData.valid_gift_card_not_encrypted(random_card), amount, currency, gratuity, tax)
+    end # sale_valid_gift_card
+
+    def self.void_gift_card_sale(txn_id)
+      TestHelper.valid_multi_use_config
+      service = Hps::HpsGiftCardService.new
+      service.void( txn_id )
+    end # void_gift_card_sale
+
+    def self.reverse_gift_card_sale(amount, txn_id = TestData.valid_gift_card_not_encrypted(false))
+      TestHelper.valid_multi_use_config
+      service = Hps::HpsGiftCardService.new
+      service.reverse( txn_id, amount )
+    end # reverse_gift_card_sale
+
+    # Testing exceptions from transactions
+    def self.gift_card_transaction_exception(amount, method = :sale)
+      TestHelper.valid_multi_use_config
+      service = Hps::HpsGiftCardService.new
+      service.send(method, TestData.valid_gift_card_not_encrypted, amount )
+    end # gift_card_sale_with_invaid_pin
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hps
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.3.2
 platform: ruby
 authors:
 - Heartland Payment Systems
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-19 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,9 +93,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.14
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -103,9 +103,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.14
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.0.1
 description: Ruby SDK for processing payments via Portico Gateway
 email:
 - IntegrationSupportTeam@e-hps.com
@@ -114,7 +114,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - PRIVACY.txt
 - README.md
 - Rakefile
@@ -155,6 +155,7 @@ files:
 - lib/hps/entities/hps_credit_card.rb
 - lib/hps/entities/hps_direct_market_data.rb
 - lib/hps/entities/hps_encryption_data.rb
+- lib/hps/entities/hps_gift_card.rb
 - lib/hps/entities/hps_manage_tokens.rb
 - lib/hps/entities/hps_refund.rb
 - lib/hps/entities/hps_report_transaction_details.rb
@@ -186,15 +187,19 @@ files:
 - 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_gift_card_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/certification/gift_card_certification_test.rb
+- tests/certification/gift_card_certification_tests.rb
 - tests/check_tests.rb
 - tests/discover_tests.rb
 - tests/exception_mapper_tests.rb
 - tests/general_tests.rb
+- tests/giftcard_tests.rb
 - tests/hps_token_service.rb
 - tests/mastercard_tests.rb
 - tests/secret_key.rb
@@ -205,7 +210,7 @@ files:
 - tests/visa_tests.rb
 homepage: ''
 licenses:
-- MIT
+- GPL-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -223,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Heartland Payment Systems - Portico Gateway SDK