hps 2.2.5 → 2.4.0

data/tests/general_tests.rb

@@ -1,141 +1,141 @@
-require File.join( File.dirname(__FILE__), "test_helper.rb" )
-
-describe "General Tests" do
-
-	before(:each) do
-    Hps::TestHelper.configure_hps_module()
-		@service = Hps::HpsChargeService.new()
-	end
-
-  it "SecretAPIKey with spaces on Visa charge should return OK" do
-    Hps::TestHelper.configure_hps_module_secret_key_with_spaces
-	@service = Hps::HpsChargeService.new()
-    result = @service.charge(5, "usd", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
-    expect(result.response_code).to eql("00")
-  end
-
-
-  it "charge when amount is less than zero should throw invalid request exception" do
-    expect {
-      @service.charge(-5, "usd", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
-    }.to raise_error(Hps::InvalidRequestException)
-  end
-
-  it "charge when currency is empty should throw invalid request exception" do
-    expect {
-      @service.charge(50, "", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
-    }.to raise_error(Hps::InvalidRequestException)
-  end
-
-  it "charge when currency is not usd should throw invalid request exception" do
-    expect {
-      @service.charge(50, "eur", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
-    }.to raise_error(Hps::InvalidRequestException)
-  end
-
-  it "charge when configuration is invalid should throw hps exception" do
-    expect {
-      @service = Hps::HpsChargeService.new :service_uri => nil
-      @service.charge(50, "usd", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
-    }.to raise_error(Hps::HpsException)
-  end
-
-  it "charge when license_id is invalid should throw authentication exception" do
-    expect {
-      @service = Hps::HpsChargeService.new :license_id => 11111
-      @service.charge(50, "usd", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
-    }.to raise_error(Hps::AuthenticationException)
-  end
-
-  it "charge when card number is invalid should throw hps exception" do
-    expect {
-      @service.charge(50, "usd", Hps::TestData::invalid_card, Hps::TestData::valid_cardholder)
-    }.to raise_error(Hps::HpsException)
-  end
-
-  it "list when charge is in filter range should show in list" do
-    start_date = DateTime.now - 12.hours
-    charge = @service.charge(50, "usd", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
-    end_date = DateTime.now
-
-    charges = @service.list(start_date, end_date)
-    expect(charges).to have_at_least(1).items
-    expect(charges.any? { |c| c.transaction_id = charge.transaction_id }).to be_true
-  end
-
-  it "updates multi-use token" do
-    Hps::TestHelper.valid_multi_use_config
-    service = Hps::HpsChargeService.new()
-    verify = service.verify(Hps::TestData::valid_visa, Hps::TestData.valid_cardholder, true)
-    expect(verify).not_to be_nil
-    expect(verify.response_code).to eql("85")
-    expect(verify.token_data).not_to be_nil
-    expect(verify.token_data.token_value).not_to be_nil
-    expect(verify.token_data.token_value).not_to be_empty
-
-    month = Time.now.strftime('%m')
-    year = (Time.now + 2.years).strftime('%Y')
-    result = service.update_token_expiration(verify.token_data.token_value, month, year)
-    expect(result).not_to be_nil
-    expect(result.response_code).to eql("00")
-  end
-
-  it "fails to update multi-use token with bad year" do
-    Hps::TestHelper.valid_multi_use_config
-    service = Hps::HpsChargeService.new()
-    verify = service.verify(Hps::TestData::valid_visa, Hps::TestData.valid_cardholder, true)
-    expect(verify).not_to be_nil
-    expect(verify.response_code).to eql("85")
-    expect(verify.token_data).not_to be_nil
-    expect(verify.token_data.token_value).not_to be_nil
-    expect(verify.token_data.token_value).not_to be_empty
-
-    month = nil
-    year = 19
-
-    expect {
-      service.update_token_expiration(verify.token_data.token_value, month, year)
-    }.to raise_error(TypeError)
-  end
-
-  it "fails to update multi-use token with nil date" do
-    Hps::TestHelper.valid_multi_use_config
-    service = Hps::HpsChargeService.new()
-    verify = service.verify(Hps::TestData::valid_visa, Hps::TestData.valid_cardholder, true)
-    expect(verify).not_to be_nil
-    expect(verify.response_code).to eql("85")
-    expect(verify.token_data).not_to be_nil
-    expect(verify.token_data.token_value).not_to be_nil
-    expect(verify.token_data.token_value).not_to be_empty
-
-    month = nil
-    year = nil
-
-    expect {
-      service.update_token_expiration(verify.token_data.token_value, month, year)
-    }.to raise_error(TypeError)
-  end
-
-  it "fails to update multi-use token with invalid token" do
-    Hps::TestHelper.valid_multi_use_config
-    service = Hps::HpsChargeService.new()
-    month = Time.now.strftime('%m')
-    year = (Time.now + 2.years).strftime('%Y')
-
-    expect {
-      service.update_token_expiration("abcdefg", month, year)
-    }.to raise_error(Hps::HpsException)
-  end
-
-  it "fails to update multi-use token with nil token" do
-    Hps::TestHelper.valid_multi_use_config
-    service = Hps::HpsChargeService.new()
-    month = Time.now.strftime('%m')
-    year = (Time.now + 2.years).strftime('%Y')
-
-    expect {
-      service.update_token_expiration(nil, month, year)
-    }.to raise_error(Hps::HpsException)
-  end
-
+require File.join( File.dirname(__FILE__), "test_helper.rb" )
+
+describe "General Tests" do
+
+	before(:each) do
+    Hps::TestHelper.configure_hps_module()
+		@service = Hps::HpsChargeService.new()
+	end
+
+  it "SecretAPIKey with spaces on Visa charge should return OK" do
+    Hps::TestHelper.configure_hps_module_secret_key_with_spaces
+	@service = Hps::HpsChargeService.new()
+    result = @service.charge(5, "usd", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
+    expect(result.response_code).to eql("00")
+  end
+
+
+  it "charge when amount is less than zero should throw invalid request exception" do
+    expect {
+      @service.charge(-5, "usd", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
+    }.to raise_error(Hps::InvalidRequestException)
+  end
+
+  it "charge when currency is empty should throw invalid request exception" do
+    expect {
+      @service.charge(50, "", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
+    }.to raise_error(Hps::InvalidRequestException)
+  end
+
+  it "charge when currency is not usd should throw invalid request exception" do
+    expect {
+      @service.charge(50, "eur", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
+    }.to raise_error(Hps::InvalidRequestException)
+  end
+
+  it "charge when configuration is invalid should throw hps exception" do
+    expect {
+      @service = Hps::HpsChargeService.new :service_uri => nil
+      @service.charge(50, "usd", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
+    }.to raise_error(Hps::HpsException)
+  end
+
+  it "charge when license_id is invalid should throw authentication exception" do
+    expect {
+      @service = Hps::HpsChargeService.new :license_id => 11111
+      @service.charge(50, "usd", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
+    }.to raise_error(Hps::AuthenticationException)
+  end
+
+  it "charge when card number is invalid should throw hps exception" do
+    expect {
+      @service.charge(50, "usd", Hps::TestData::invalid_card, Hps::TestData::valid_cardholder)
+    }.to raise_error(Hps::HpsException)
+  end
+
+  it "list when charge is in filter range should show in list" do
+    start_date = DateTime.now - 12.hours
+    charge = @service.charge(50, "usd", Hps::TestData::valid_visa, Hps::TestData::valid_cardholder)
+    end_date = DateTime.now
+
+    charges = @service.list(start_date, end_date)
+    expect(charges).to have_at_least(1).items
+    expect(charges.any? { |c| c.transaction_id = charge.transaction_id }).to be_true
+  end
+
+  it "updates multi-use token" do
+    Hps::TestHelper.valid_multi_use_config
+    service = Hps::HpsChargeService.new()
+    verify = service.verify(Hps::TestData::valid_visa, Hps::TestData.valid_cardholder, true)
+    expect(verify).not_to be_nil
+    expect(verify.response_code).to eql("85")
+    expect(verify.token_data).not_to be_nil
+    expect(verify.token_data.token_value).not_to be_nil
+    expect(verify.token_data.token_value).not_to be_empty
+
+    month = Time.now.strftime('%m')
+    year = (Time.now + 2.years).strftime('%Y')
+    result = service.update_token_expiration(verify.token_data.token_value, month, year)
+    expect(result).not_to be_nil
+    expect(result.response_code).to eql("00")
+  end
+
+  it "fails to update multi-use token with bad year" do
+    Hps::TestHelper.valid_multi_use_config
+    service = Hps::HpsChargeService.new()
+    verify = service.verify(Hps::TestData::valid_visa, Hps::TestData.valid_cardholder, true)
+    expect(verify).not_to be_nil
+    expect(verify.response_code).to eql("85")
+    expect(verify.token_data).not_to be_nil
+    expect(verify.token_data.token_value).not_to be_nil
+    expect(verify.token_data.token_value).not_to be_empty
+
+    month = nil
+    year = 19
+
+    expect {
+      service.update_token_expiration(verify.token_data.token_value, month, year)
+    }.to raise_error(TypeError)
+  end
+
+  it "fails to update multi-use token with nil date" do
+    Hps::TestHelper.valid_multi_use_config
+    service = Hps::HpsChargeService.new()
+    verify = service.verify(Hps::TestData::valid_visa, Hps::TestData.valid_cardholder, true)
+    expect(verify).not_to be_nil
+    expect(verify.response_code).to eql("85")
+    expect(verify.token_data).not_to be_nil
+    expect(verify.token_data.token_value).not_to be_nil
+    expect(verify.token_data.token_value).not_to be_empty
+
+    month = nil
+    year = nil
+
+    expect {
+      service.update_token_expiration(verify.token_data.token_value, month, year)
+    }.to raise_error(TypeError)
+  end
+
+  it "fails to update multi-use token with invalid token" do
+    Hps::TestHelper.valid_multi_use_config
+    service = Hps::HpsChargeService.new()
+    month = Time.now.strftime('%m')
+    year = (Time.now + 2.years).strftime('%Y')
+
+    expect {
+      service.update_token_expiration("abcdefg", month, year)
+    }.to raise_error(Hps::HpsException)
+  end
+
+  it "fails to update multi-use token with nil token" do
+    Hps::TestHelper.valid_multi_use_config
+    service = Hps::HpsChargeService.new()
+    month = Time.now.strftime('%m')
+    year = (Time.now + 2.years).strftime('%Y')
+
+    expect {
+      service.update_token_expiration(nil, month, year)
+    }.to raise_error(Hps::HpsException)
+  end
+
 end

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/hps_token_service.rb

@@ -1,56 +1,56 @@
-require 'net/http'
-
-require 'rubygems'
-require 'json'
-
-module Hps
-  class HpsTokenService
-    attr_accessor :public_api_key, :url
-
-    def initialize(public_api_key)
-      @public_api_key = public_api_key
-      if @public_api_key.nil? || @public_api_key.eql?('')
-        raise HpsException.new('Public Key Not Found', '0')
-      end
-
-      components = @public_api_key.split '_'
-      if components.size  < 3
-        raise HpsException.new('Public API Key must contain at least two underscores','0')
-      end
-
-      if components[1].downcase.eql? 'prod'
-        @url = 'https://api2.heartlandportico.com/SecureSubmit.v1/api/token'
-      else
-        @url = 'https://cert.api2.heartlandportico.com/Hps.Exchange.PosGateway.Hpf.v1/api/token'
-      end
-
-    end
-
-    def get_token(card_data)
-      data = {
-          'api_key' => @public_api_key,
-          'object' => 'token',
-          'token_type' => 'supt',
-          '_method' => 'post',
-          'card[number]' => card_data.number,
-          'card[cvv]' => card_data.cvv,
-          'card[exp_month]' => card_data.exp_month,
-          'card[exp_year]' => card_data.exp_year
-      }
-      get_result = get(data)
-      JSON.parse(get_result)
-    end
-
-    def get(data)
-      begin
-        uri = URI(@url)
-        uri.query = URI.encode_www_form(data)
-        res = Net::HTTP.get_response(uri)
-        res.body
-
-      rescue Exception => e
-        raise HpsException.new(e.message,'0')
-      end
-    end
-  end
-end
+require 'net/http'
+
+require 'rubygems'
+require 'json'
+
+module Hps
+  class HpsTokenService
+    attr_accessor :public_api_key, :url
+
+    def initialize(public_api_key)
+      @public_api_key = public_api_key
+      if @public_api_key.nil? || @public_api_key.eql?('')
+        raise HpsException.new('Public Key Not Found', '0')
+      end
+
+      components = @public_api_key.split '_'
+      if components.size  < 3
+        raise HpsException.new('Public API Key must contain at least two underscores','0')
+      end
+
+      if components[1].downcase.eql? 'prod'
+        @url = 'https://api2.heartlandportico.com/SecureSubmit.v1/api/token'
+      else
+        @url = 'https://cert.api2.heartlandportico.com/Hps.Exchange.PosGateway.Hpf.v1/api/token'
+      end
+
+    end
+
+    def get_token(card_data)
+      data = {
+          'api_key' => @public_api_key,
+          'object' => 'token',
+          'token_type' => 'supt',
+          '_method' => 'post',
+          'card[number]' => card_data.number,
+          'card[cvv]' => card_data.cvv,
+          'card[exp_month]' => card_data.exp_month,
+          'card[exp_year]' => card_data.exp_year
+      }
+      get_result = get(data)
+      JSON.parse(get_result)
+    end
+
+    def get(data)
+      begin
+        uri = URI(@url)
+        uri.query = URI.encode_www_form(data)
+        res = Net::HTTP.get_response(uri)
+        res.body
+
+      rescue Exception => e
+        raise HpsException.new(e.message,'0')
+      end
+    end
+  end
+end