workarea-gift_cards 3.4.6

data/test/integration/workarea/api/admin/gift_card_integration_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+module Workarea
+  if Plugin.installed?(:api)
+    module Api
+      module Admin
+        class GiftCardIntegrationTest < IntegrationTest
+          include Workarea::Admin::IntegrationTest
+          setup :set_sample_attributes
+
+          def set_sample_attributes
+            @sample_attributes = create_gift_card.as_json.except('_id')
+          end
+
+          def test_lists_gift_cards
+            gift_cards = [create_gift_card(to: 'test@email.com'), create_gift_card(to: 'foo@weblinc.com')]
+            get admin_api.payment_gift_cards_path
+            result = JSON.parse(response.body)['gift_cards']
+
+            assert_equal(3, result.length)
+            assert_equal(gift_cards.second, Payment::GiftCard.new(result.first))
+            assert_equal(gift_cards.first, Payment::GiftCard.new(result.second))
+          end
+
+          def test_creates_gift_cards
+            assert_difference 'Payment::GiftCard.count', 1 do
+              post admin_api.payment_gift_cards_path,
+                   params: { gift_card: @sample_attributes.merge('to' => 'test@email.com').except('token') }
+            end
+          end
+
+          def test_shows_gift_cards
+            gift_card = create_gift_card(to: 'foo@weblinc.com')
+            get admin_api.payment_gift_card_path(gift_card.id)
+            result = JSON.parse(response.body)['gift_card']
+            assert_equal(gift_card, Payment::GiftCard.new(result))
+          end
+
+          def test_updates_gift_cards
+            gift_card = create_gift_card(to: 'foo@weblinc.com')
+            patch admin_api.payment_gift_card_path(gift_card.id),
+                  params: { gift_card: { to: 'bar@weblinc.com' } }
+
+            assert_equal('bar@weblinc.com', gift_card.reload.to)
+          end
+
+          def test_destroys_gift_cards
+            gift_card = create_gift_card(to: 'foo@weblinc.com')
+            assert_difference 'Payment::GiftCard.count', -1 do
+              delete admin_api.payment_gift_card_path(gift_card.id)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/integration/workarea/api/storefront/balance_integration_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+module Workarea
+  if Plugin.installed?(:api)
+    module Api
+      module Storefront
+        class BalanceIntegrationTest < Workarea::IntegrationTest
+          def test_balance_lookup
+            gift_card = create_gift_card(
+              to: 'bcrouse@weblinc.com',
+              amount: 5.to_m
+            )
+
+            get storefront_api.gift_cards_balance_path,
+                params: { email: 'foo@weblinc.com', token: gift_card.token }
+
+            refute(response.ok?)
+            assert_equal(404, response.status)
+
+            get storefront_api.gift_cards_balance_path,
+                params: { email: 'bcrouse@weblinc.com', token: 'foo' }
+
+            refute(response.ok?)
+            assert_equal(404, response.status)
+
+            get storefront_api.gift_cards_balance_path,
+                params: { email: 'bcrouse@weblinc.com', token: gift_card.token }
+
+            assert(response.ok?)
+            results = JSON.parse(response.body)
+
+            assert_equal(gift_card.to, results['to'])
+            assert_equal(gift_card.token, results['token'])
+            assert_equal(gift_card.balance.cents, results['balance']['cents'])
+          end
+        end
+      end
+    end
+  end
+end

data/test/integration/workarea/api/storefront/checkout_integration_test.rb

@@ -0,0 +1,161 @@
+require 'test_helper'
+
+module Workarea
+  if Plugin.installed?(:api)
+    module Api
+      module Storefront
+        class CheckoutIntegrationTest < Workarea::IntegrationTest
+          setup :tax, :product, :shipping_service, :gift_card
+
+          def tax
+            @tax ||= create_tax_category(
+              name: 'Sales Tax',
+              code: '001',
+              rates: [{ percentage: 0.07, country: 'US', region: 'PA' }]
+            )
+          end
+
+          def product
+            @product ||= create_product(
+              name: 'Integration Product',
+              variants: [
+                { sku: 'SKU1',
+                  regular: 6.to_m,
+                  tax_code: '001',
+                  on_sale: true,
+                  sale: 5.to_m }
+              ]
+            )
+          end
+
+          def shipping_service
+            @shipping_service ||= create_shipping_service(
+              name: 'Ground',
+              tax_code: '001',
+              rates: [{ price: 7.to_m }]
+            )
+          end
+
+          def gift_card
+            @gift_card ||= create_gift_card(amount: 5.to_m)
+          end
+
+          def complete_checkout
+            post storefront_api.carts_path
+            order_id = JSON.parse(response.body)['id']
+
+            post storefront_api.cart_items_path(order_id),
+                 params: {
+                   product_id: product.id,
+                   sku: product.skus.first,
+                   quantity: 2
+                 }
+
+            patch storefront_api.checkout_path(order_id),
+                  params: {
+                    email: 'bcrouse@workarea.com',
+                    billing_address: {
+                      first_name:   'Ben',
+                      last_name:    'Crouse',
+                      street:       '12 N. 3rd St.',
+                      city:         'Philadelphia',
+                      region:       'PA',
+                      postal_code:  '19106',
+                      country:      'US',
+                      phone_number: '2159251800'
+                    },
+                    shipping_address: {
+                      first_name:   'Ben',
+                      last_name:    'Crouse',
+                      street:       '22 S. 3rd St.',
+                      city:         'Philadelphia',
+                      region:       'PA',
+                      postal_code:  '19106',
+                      country:      'US',
+                      phone_number: '2159251800'
+                    }
+                  }
+
+            patch storefront_api.add_gift_card_checkout_path(order_id),
+                  params: { gift_card_number: gift_card.token }
+
+            post storefront_api.complete_checkout_path(order_id),
+                 params: {
+                   payment: 'new_card',
+                   credit_card: {
+                     number: '1',
+                     month: '1',
+                     year: Time.now.year + 1,
+                     cvv: '999'
+                   }
+                 }
+          end
+
+          def test_saves_order_info
+            complete_checkout
+
+            order = Order.first
+
+            assert_equal('bcrouse@workarea.com', order.email)
+            assert(order.placed_at.present?)
+            assert_equal(1, order.items.length)
+
+            assert_equal(product.id, order.items.first.product_id)
+            assert_equal(product.skus.first, order.items.first.sku)
+            assert_equal(2, order.items.first.quantity)
+
+            assert_equal(10.to_m, order.items.first.total_price)
+            assert_equal(1, order.items.first.price_adjustments.length)
+            assert_equal(10.to_m, order.items.first.price_adjustments.first.amount)
+
+            assert(order.items.first.on_sale?)
+            assert(order.items.first.product_attributes.present?)
+
+            payment = Payment.find(order.id)
+            assert_equal('Ben', payment.first_name)
+            assert_equal('Crouse', payment.last_name)
+            assert_equal('Ben', payment.address.first_name)
+            assert_equal('Crouse', payment.address.last_name)
+            assert_equal('12 N. 3rd St.', payment.address.street)
+            assert_equal('Philadelphia', payment.address.city)
+            assert_equal('PA', payment.address.region)
+            assert_equal('19106', payment.address.postal_code)
+            assert_equal('US', payment.address.country.alpha2)
+            assert_equal('2159251800', payment.address.phone_number)
+
+            assert_equal('Test Card', payment.credit_card.issuer)
+            assert_equal('XXXX-XXXX-XXXX-1', payment.credit_card.display_number)
+            assert_equal(1, payment.credit_card.month)
+            assert(payment.credit_card.year.present?)
+            assert_equal(13.19.to_m, payment.credit_card.amount)
+            assert(payment.credit_card.token.present?)
+            assert(payment.credit_card.saved_card_id.blank?)
+
+            assert_equal(1, payment.credit_card.transactions.length)
+            assert(payment.credit_card.transactions.first.response.present?)
+            assert_equal(13.19.to_m, payment.credit_card.transactions.first.amount)
+
+            assert_equal(gift_card.token, payment.gift_card.number)
+            assert_equal(5.to_m, payment.gift_card.amount)
+            assert_equal(1, payment.gift_card.transactions.length)
+            assert_equal(5.to_m, payment.gift_card.transactions.first.amount)
+          end
+
+          def test_reduces_balance_on_gift_card
+            complete_checkout
+
+            gift_card.reload
+            assert_equal(0.to_m, gift_card.balance)
+            assert_equal(5.to_m, gift_card.amount)
+            assert_equal(5.to_m, gift_card.used)
+
+            order = Order.first
+            redemption = gift_card.redemptions.first
+            assert_equal(order.placed_at, redemption.redeemed_at)
+            assert_equal(5.to_m, redemption.amount)
+          end
+        end
+      end
+    end
+  end
+end

data/test/integration/workarea/storefront/gift_card_integration_test.rb

@@ -0,0 +1,222 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class GiftCardIntegrationTest < Workarea::IntegrationTest
+      setup :tax, :product, :shipping_service, :gift_card
+
+      def tax
+        @tax ||= create_tax_category(
+          name: 'Sales Tax',
+          code: '001',
+          rates: [{ percentage: 0.07, country: 'US', region: 'PA' }]
+        )
+      end
+
+      def product
+        @product ||= create_product(
+          name: 'Integration Product',
+          variants: [
+            { sku: 'SKU1',
+              regular: 6.to_m,
+              tax_code: '001',
+              on_sale: true,
+              sale: 5.to_m }
+          ]
+        )
+      end
+
+      def shipping_service
+        @shipping_service ||= create_shipping_service(
+          name: 'Ground',
+          tax_code: '001',
+          rates: [{ price: 7.to_m }]
+        )
+      end
+
+      def gift_card
+        @gift_card ||= create_gift_card(amount: 5.to_m)
+      end
+
+      def complete_checkout
+        post storefront.cart_items_path,
+             params: {
+               product_id: product.id,
+               sku:        product.skus.first,
+               quantity:   2
+             }
+
+        patch storefront.checkout_addresses_path,
+              params: {
+                email: 'bcrouse@workarea.com',
+                billing_address: {
+                  first_name:   'Ben',
+                  last_name:    'Crouse',
+                  street:       '12 N. 3rd St.',
+                  city:         'Philadelphia',
+                  region:       'PA',
+                  postal_code:  '19106',
+                  country:      'US',
+                  phone_number: '2159251800'
+                },
+                shipping_address: {
+                  first_name:   'Ben',
+                  last_name:    'Crouse',
+                  street:       '22 S. 3rd St.',
+                  city:         'Philadelphia',
+                  region:       'PA',
+                  postal_code:  '19106',
+                  country:      'US',
+                  phone_number: '2159251800'
+                }
+              }
+
+        patch storefront.checkout_add_gift_card_path,
+              params: { gift_card_number: gift_card.token }
+
+        patch storefront.checkout_place_order_path,
+              params: {
+                payment: 'new_card',
+                credit_card: {
+                  number: '1',
+                  month:  1,
+                  year:   2020,
+                  cvv:    '999'
+                }
+              }
+      end
+
+      def test_saves_order_info
+        complete_checkout
+
+        order = Order.first
+
+        assert_equal('bcrouse@workarea.com', order.email)
+        assert(order.placed_at.present?)
+        assert_equal(1, order.items.length)
+
+        assert_equal(product.id, order.items.first.product_id)
+        assert_equal(product.skus.first, order.items.first.sku)
+        assert_equal(2, order.items.first.quantity)
+
+        assert_equal(10.to_m, order.items.first.total_price)
+        assert_equal(1, order.items.first.price_adjustments.length)
+        assert_equal(10.to_m, order.items.first.price_adjustments.first.amount)
+
+        assert(order.items.first.on_sale?)
+        assert(order.items.first.product_attributes.present?)
+
+        payment = Payment.find(order.id)
+        assert_equal('Ben', payment.first_name)
+        assert_equal('Crouse', payment.last_name)
+        assert_equal('Ben', payment.address.first_name)
+        assert_equal('Crouse', payment.address.last_name)
+        assert_equal('12 N. 3rd St.', payment.address.street)
+        assert_equal('Philadelphia', payment.address.city)
+        assert_equal('PA', payment.address.region)
+        assert_equal('19106', payment.address.postal_code)
+        assert_equal('US', payment.address.country.alpha2)
+        assert_equal('2159251800', payment.address.phone_number)
+
+        assert_equal('Test Card', payment.credit_card.issuer)
+        assert_equal('XXXX-XXXX-XXXX-1', payment.credit_card.display_number)
+        assert_equal(1, payment.credit_card.month)
+        assert_equal(2020, payment.credit_card.year)
+        assert_equal(13.19.to_m, payment.credit_card.amount)
+        assert(payment.credit_card.token.present?)
+        assert(payment.credit_card.saved_card_id.blank?)
+
+        assert_equal(1, payment.credit_card.transactions.length)
+        assert(payment.credit_card.transactions.first.response.present?)
+        assert_equal(13.19.to_m, payment.credit_card.transactions.first.amount)
+
+        assert_equal(gift_card.token, payment.gift_card.number)
+        assert_equal(5.to_m, payment.gift_card.amount)
+        assert_equal(1, payment.gift_card.transactions.length)
+        assert_equal(5.to_m, payment.gift_card.transactions.first.amount)
+      end
+
+      def test_reduces_balance_on_gift_card
+        complete_checkout
+
+        gift_card.reload
+        assert_equal(0.to_m, gift_card.balance)
+        assert_equal(5.to_m, gift_card.amount)
+        assert_equal(5.to_m, gift_card.used)
+
+        order = Order.first
+        redemption = gift_card.redemptions.first
+        assert_equal(order.placed_at, redemption.redeemed_at)
+        assert_equal(5.to_m, redemption.amount)
+      end
+
+      def test_generates_gift_card
+        product = create_product(
+          name: 'Gift Card',
+          gift_card: true,
+          digital: true,
+          customizations: 'gift_card',
+          variants: [{ sku: 'GIFTCARD', regular: 10.to_m }]
+        )
+
+        post storefront.cart_items_path,
+             params: {
+               product_id: product.id,
+               sku:        product.skus.first,
+               email:      'recipient@workarea.com',
+               from:       'from@workarea.com',
+               message:    'this is a message',
+               quantity:   1
+             }
+
+        patch storefront.checkout_addresses_path,
+              params: {
+                email: 'bcrouse@workarea.com',
+                billing_address: {
+                  first_name:   'Ben',
+                  last_name:    'Crouse',
+                  street:       '12 N. 3rd St.',
+                  city:         'Philadelphia',
+                  region:       'PA',
+                  postal_code:  '19106',
+                  country:      'US',
+                  phone_number: '2159251800'
+                }
+              }
+
+        patch storefront.checkout_place_order_path,
+              params: {
+                payment: 'new_card',
+                credit_card: {
+                  number: '1',
+                  month:  1,
+                  year:   2020,
+                  cvv:    '999'
+                }
+              }
+
+        assert_equal(2, Payment::GiftCard.count)
+
+        card = Payment::GiftCard.desc(:created_at).first
+        assert_equal(10.to_m, card.amount)
+        assert_equal(0.to_m, card.used)
+        assert_equal(10.to_m, card.balance)
+        assert(card.order_id.present?)
+
+        assert_equal(2, ActionMailer::Base.deliveries.length)
+
+        assert(card.purchased?)
+
+        gift_card_email = ActionMailer::Base.deliveries.detect do |email|
+          assert_includes(email.to, 'recipient@workarea.com')
+        end
+
+        gift_card_email.parts.each do |part|
+          assert_includes(part.body, card.token)
+          assert_includes(part.body, 'from@workarea.com')
+          assert_includes(part.body, 'this is a message')
+        end
+      end
+    end
+  end
+end

data/test/models/workarea/catalog/gift_card_product_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+module Workarea
+  module Catalog
+    class GiftCardProductTest < TestCase
+      def test_gift_card?
+        product = Catalog::Product.new(template: 'gift_card')
+        assert(product.gift_card?)
+
+        product = Catalog::Product.new(gift_card: true)
+        assert(product.gift_card?)
+      end
+    end
+  end
+end

data/test/models/workarea/gift_card_payment_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+module Workarea
+  class GiftCardPaymentTest < TestCase
+    def test_set_gift_card
+      payment = create_payment
+
+      payment.set_gift_card(number: '1234')
+      assert_equal('1234', payment.gift_card.number)
+    end
+  end
+end

data/test/models/workarea/payment/gift_card_test.rb

@@ -0,0 +1,127 @@
+require 'test_helper'
+
+module Workarea
+  class Payment
+    class GiftCardTest < TestCase
+      def test_not_expired
+        expired     = Workarea::Payment::GiftCard.create!(amount: 10.to_m, expires_at: Time.now - 1.day)
+        not_expired = Workarea::Payment::GiftCard.create!(amount: 10.to_m, expires_at: Time.now + 1.day)
+        no_date     = Workarea::Payment::GiftCard.create!(amount: 10.to_m, expires_at: '')
+
+        results = Workarea::Payment::GiftCard.not_expired.to_a
+        assert_includes(results, not_expired)
+        assert_includes(results, no_date)
+        refute_includes(results, expired)
+      end
+
+      def test_search_by_token_or_recipient
+        one = Workarea::Payment::GiftCard.create!(amount: 10.to_m, token: '123', to: 'zac@workarea.com')
+        two = Workarea::Payment::GiftCard.create!(amount: 10.to_m, token: '456', to: 'owen@workarea.com')
+
+        results = Workarea::Payment::GiftCard
+                  .search_by_token_or_recipient('zac@workarea.com')
+
+        assert_includes(results, one)
+        refute_includes(results, two)
+      end
+
+      def test_purchase
+        card = Workarea::Payment::GiftCard.create!(amount: 10.to_m)
+
+        card.purchase(500)
+        card.reload
+        assert_equal(10.to_m, card.amount)
+        assert_equal(5.to_m, card.balance)
+        assert_equal(5.to_m, card.used)
+
+        assert_raise(Payment::InsufficientFunds) do
+          card.purchase(5000)
+        end
+      end
+
+      def test_refund_class_method
+        card = Workarea::Payment::GiftCard.create!(amount: 10.to_m)
+
+        Workarea::Payment::GiftCard.refund(card.token, 500)
+        card.reload
+
+        assert_equal(10.to_m, card.amount)
+        assert_equal(15.to_m, card.balance)
+        assert_equal(-5.to_m, card.used)
+      end
+
+      def test_refund_instance_method
+        card = Workarea::Payment::GiftCard.create!(amount: 10.to_m)
+
+        card.refund(500)
+        card.reload
+        assert_equal(10.to_m, card.amount)
+        assert_equal(15.to_m, card.balance)
+        assert_equal(-5.to_m, card.used)
+      end
+
+      def test_find_by_token_and_email
+        card = Workarea::Payment::GiftCard.create!(
+          amount: 10.to_m,
+          token: '123',
+          to: 'test@workarea.com'
+        )
+
+        assert_equal(
+          card,
+          Workarea::Payment::GiftCard.find_by_token_and_email(
+            '123',
+            'test@workarea.com'
+          )
+        )
+
+        assert_nil(
+          Workarea::Payment::GiftCard.find_by_token_and_email(
+            '123',
+            'noone@workarea.com'
+          )
+        )
+
+        assert_nil(
+          Workarea::Payment::GiftCard.find_by_token_and_email(
+            '321',
+            'test@workarea.com'
+          )
+        )
+      end
+
+      def test_to=
+        card =
+          Workarea::Payment::GiftCard.create!(
+            amount: 10.to_m,
+            token: 'TESTTOKEN',
+            to: 'TEST@WORKAREA.COM'
+          )
+
+        assert_equal('test@workarea.com', card.to)
+        assert_equal('testtoken', card.token)
+
+        card.to = nil
+        assert_nil(card.to)
+      end
+
+      def test_last_redeemed_at
+        card =
+          Workarea::Payment::GiftCard.create!(
+            amount: 2.to_m,
+            token: '123',
+            to: 'test@workarea.com'
+          )
+
+        assert_nil(card.last_redeemed_at)
+
+        one_day_ago = 1.day.ago
+        two_days_ago = 2.days.ago
+        card.redemptions.create!(amount: 1.to_m, redeemed_at: one_day_ago)
+        card.redemptions.create!(amount: 1.to_m, redeemed_at: two_days_ago)
+
+        assert_equal(one_day_ago.to_i, card.last_redeemed_at.to_i)
+      end
+    end
+  end
+end

data/test/models/workarea/payment/purchase/gift_card_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+module Workarea
+  class Payment
+    module Purchase
+      class GiftCardTest < TestCase
+        setup :gift_card
+
+        def gift_card
+          @gift_card ||= Payment::GiftCard.create!(token: 'token', amount: 5.to_m)
+        end
+
+        def payment
+          @payment ||= create_payment
+        end
+
+        def test_complete!
+          payment.set_gift_card(number: 'token')
+
+          transaction = payment.gift_card.build_transaction(amount: 10.to_m)
+
+          GiftCard.new(payment.gift_card, transaction).complete!
+          refute(transaction.success?)
+          assert(transaction.message.present?)
+
+          transaction = payment.gift_card.build_transaction(amount: 3.to_m)
+          purchase = GiftCard.new(payment.gift_card, transaction)
+          purchase.complete!
+
+          assert(transaction.success?)
+          assert_equal(3.to_m, transaction.amount)
+        end
+
+        def test_cancel!
+          payment.set_gift_card(number: 'token')
+          transaction = payment.gift_card.build_transaction(amount: 5.to_m)
+
+          purchase = GiftCard.new(payment.gift_card, transaction)
+          purchase.cancel!
+
+          refute(transaction.cancellation.present?)
+
+          purchase.complete!
+          assert(transaction.success?)
+
+          purchase.cancel!
+          assert(transaction.cancellation.present?)
+        end
+      end
+    end
+  end
+end