workarea-gift_cards 3.4.11 → 4.0.0.beta.1

data/test/documentation/workarea/api/admin/gift_cards_documentation_test.rb

@@ -16,14 +16,14 @@ module Workarea
 
           def test_and_document_index
             description 'Listing payment gift cards'
-            route admin.payment_gift_cards_path
+            route admin_api.gift_cards_path
             parameter :page, 'Current page'
             parameter :sort_by, 'Field on which to sort (see responses for possible values)'
             parameter :sort_direction, 'Direction to sort (asc or desc)'
             2.times { |i| create_gift_card(to: "#{i}@weblinc.com") }
 
             record_request do
-              get admin_api.payment_gift_cards_path,
+              get admin_api.gift_cards_path,
                   params: { page: 1, sort_by: 'created_at', sort_direction: 'desc' }
 
               assert_equal(200, response.status)
@@ -32,10 +32,10 @@ module Workarea
 
           def test_and_document_create
             description 'Creating a gift card'
-            route admin_api.payment_gift_cards_path
+            route admin_api.gift_cards_path
 
             record_request do
-              post admin_api.payment_gift_cards_path,
+              post admin_api.gift_cards_path,
                    params: { gift_card: sample_attributes.merge('token' => 'foobar') },
                    as: :json
 
@@ -45,20 +45,20 @@ module Workarea
 
           def test_and_document_show
             description 'Showing a gift card'
-            route admin_api.payment_gift_card_path(':id')
+            route admin_api.gift_card_path(':id')
 
             record_request do
-              get admin_api.payment_gift_card_path(create_gift_card.id)
+              get admin_api.gift_card_path(create_gift_card.id)
               assert_equal(200, response.status)
             end
           end
 
           def test_and_document_update
             description 'Updating a gift card'
-            route admin_api.payment_gift_card_path(':id')
+            route admin_api.gift_card_path(':id')
 
             record_request do
-              patch admin_api.payment_gift_card_path(create_gift_card.id),
+              patch admin_api.gift_card_path(create_gift_card.id),
                     params: { gift_card: { to: 'test@weblinc.com' } },
                     as: :json
 
@@ -68,10 +68,24 @@ module Workarea
 
           def test_and_document_destroy
             description 'Removing a gift card'
-            route admin_api.payment_gift_card_path(':id')
+            route admin_api.gift_card_path(':id')
 
             record_request do
-              delete admin_api.payment_gift_card_path(create_gift_card.id)
+              delete admin_api.gift_card_path(create_gift_card.id)
+              assert_equal(204, response.status)
+            end
+          end
+
+          def test_and_document_bulk_upsert
+            description 'Bulk upserting gift cards'
+            route admin_api.bulk_gift_cards_path
+
+            data = Array.new(3) do |i|
+              sample_attributes.merge('token' => "GC#{i}")
+            end
+
+            record_request do
+              patch admin_api.bulk_gift_cards_path, params: { gift_cards: data }, as: :json
               assert_equal(204, response.status)
             end
           end

data/test/documentation/workarea/api/storefront/gift_cards_documentation_test.rb

@@ -8,6 +8,42 @@ module Workarea
         class GiftCardsDocumentationTest < DocumentationTest
           resource 'Gift Cards'
 
+          def setup_checkout
+            product = create_product(
+              name: 'Integration Product',
+              variants: [
+                { sku: 'SKU1',
+                  regular: 6.to_m,
+                  tax_code: '001',
+                  on_sale: true,
+                  sale: 5.to_m }
+              ]
+            )
+
+            create_shipping_service(
+              name: 'Ground',
+              tax_code: '001',
+              rates: [{ price: 7.to_m }]
+            )
+
+            @gift_card = create_gift_card(amount: 5.to_m)
+            @order = Order.create!
+
+            post storefront_api.cart_items_path(@order),
+                 params: {
+                   product_id: product.id,
+                   sku: product.skus.first,
+                   quantity: 2
+                 }
+
+            patch storefront_api.checkout_path(@order),
+                  params: {
+                    email: 'bcrouse@workarea.com',
+                    billing_address: factory_defaults(:billing_address),
+                    shipping_address: factory_defaults(:shipping_address)
+                  }
+          end
+
           def test_checking_gift_card_balance
             description 'Checking gift card balance'
             route storefront_api.gift_cards_balance_path
@@ -40,63 +76,34 @@ module Workarea
               checkout completion.
             EOS
 
-            product = create_product(
-              name: 'Integration Product',
-              variants: [
-                { sku: 'SKU1',
-                  regular: 6.to_m,
-                  tax_code: '001',
-                  on_sale: true,
-                  sale: 5.to_m }
-              ]
-            )
+            setup_checkout
 
-            create_shipping_service(
-              name: 'Ground',
-              tax_code: '001',
-              rates: [{ price: 7.to_m }]
-            )
+            record_request do
+              patch storefront_api.add_gift_card_checkout_path(@order),
+                    params: { gift_card_number: @gift_card.token }
 
-            gift_card = create_gift_card(amount: 5.to_m)
+              assert_equal(200, response.status)
+            end
+          end
 
-            order = Order.create!
+          def test_removing_gift_card_from_checkout
+            description 'Removing a gift card from checkout'
+            route storefront_api.remove_gift_card_checkout_path(':order_id')
+            explanation <<-EOS
+              This endpoint removes a gift card from an order during the
+              checkout process.
+            EOS
 
-            post storefront_api.cart_items_path(order),
-                 params: {
-                   product_id: product.id,
-                   sku: product.skus.first,
-                   quantity: 2
-                 }
+            setup_checkout
 
-            patch storefront_api.checkout_path(order),
-                  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),
+                  params: { gift_card_number: @gift_card.token }
 
-            record_request do
-              patch storefront_api.add_gift_card_checkout_path(order),
-                    params: { gift_card_number: gift_card.token }
+            payment = Payment.find(@order.id)
 
+            record_request do
+              delete storefront_api.remove_gift_card_checkout_path(@order),
+                     params: { gift_card_id: payment.gift_cards.first.id }
               assert_equal(200, response.status)
             end
           end

data/test/dummy/config/initializers/session_store.rb

@@ -1,3 +1,3 @@
 # Be sure to restart your server when you modify this file.
 
-Rails.application.config.session_store :cookie_store, key: '_dummy_session', expire_after: 2.weeks
+Rails.application.config.session_store :cookie_store, key: '_dummy_session', expire_after: 30.minutes

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

@@ -14,7 +14,7 @@ module Workarea
 
           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
+            get admin_api.gift_cards_path
             result = JSON.parse(response.body)['gift_cards']
 
             assert_equal(3, result.length)
@@ -24,21 +24,21 @@ module Workarea
 
           def test_creates_gift_cards
             assert_difference 'Payment::GiftCard.count', 1 do
-              post admin_api.payment_gift_cards_path,
+              post admin_api.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)
+            get admin_api.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),
+            patch admin_api.gift_card_path(gift_card.id),
                   params: { gift_card: { to: 'bar@weblinc.com' } }
 
             assert_equal('bar@weblinc.com', gift_card.reload.to)
@@ -47,7 +47,15 @@ module Workarea
           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)
+              delete admin_api.gift_card_path(gift_card.id)
+            end
+          end
+
+          def test_bulk_upserts_gift_cards
+            data = Array.new(10) { |i| @sample_attributes.merge('token' => "GC#{i}") }
+
+            assert_difference 'Payment::GiftCard.count', 10 do
+              patch admin_api.bulk_gift_cards_path, params: { gift_cards: data }
             end
           end
         end

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

@@ -0,0 +1,120 @@
+require 'test_helper'
+
+module Workarea
+  if Plugin.installed?(:api)
+    module Api
+      module Storefront
+        class CheckoutGiftCardsIntegrationTest < Workarea::IntegrationTest
+          setup :setup_checkout
+
+          def setup_checkout
+            create_tax_category(
+              name: 'Sales Tax',
+              code: '001',
+              rates: [{ percentage: 0.07, country: 'US', region: 'PA' }]
+            )
+            create_shipping_service(
+              name: 'Ground',
+              tax_code: '001',
+              rates: [{ price: 7.to_m }]
+            )
+
+            product = create_product(
+              name: 'Integration Product',
+              variants: [{ sku: 'SKU1', regular: 5.to_m, tax_code: '001' }]
+            )
+
+            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: factory_defaults(:billing_address),
+                    shipping_address: factory_defaults(:shipping_address)
+                  }
+          end
+
+          def test_paying_with_gift_card
+            card_one = create_gift_card(token: '123', amount: 10.to_m)
+            card_two = create_gift_card(token: '456', amount: 20.to_m)
+
+            patch storefront_api.add_gift_card_checkout_path(@order_id),
+                  params: { gift_card_number: card_one.token }
+
+            order = Order.find(@order_id)
+            payment = Payment.find(order.id)
+
+            assert_equal(1, payment.gift_cards.count)
+
+            gift_card = payment.gift_cards.first
+            assert_equal(card_one.token, gift_card.number)
+            assert_equal(10.to_m, gift_card.amount)
+
+            patch storefront_api.add_gift_card_checkout_path(@order_id),
+                  params: { gift_card_number: card_two.token }
+
+            payment.reload
+
+            assert_equal(2, payment.gift_cards.count)
+
+            gift_card = payment.gift_cards.last
+            assert_equal(card_two.token, gift_card.number)
+            assert_equal(8.19.to_m, gift_card.amount)
+
+            delete storefront_api.remove_gift_card_checkout_path(@order_id),
+                   params: { gift_card_id: payment.gift_cards.first.id }
+
+            payment.reload
+
+            assert_equal(1, payment.gift_cards.count)
+
+            gift_card = payment.gift_cards.first
+            assert_equal(card_two.token, gift_card.number)
+            assert_equal(18.19.to_m, gift_card.amount)
+
+            post storefront_api.complete_checkout_path(@order_id)
+            assert(order.reload.placed?)
+          end
+
+          def test_reduces_balance_on_gift_card
+            pass && (return) unless Workarea::GiftCards.uses_system_cards?
+
+            gift_card = create_gift_card(amount: 5.to_m)
+
+            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'
+                   }
+                 }
+
+            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.find(@order_id)
+            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/api/storefront/{balance_integration_test.rb → gift_cards_integration_test.rb}

@@ -4,7 +4,7 @@ module Workarea
   if Plugin.installed?(:api)
     module Api
       module Storefront
-        class BalanceIntegrationTest < Workarea::IntegrationTest
+        class GiftCardsIntegrationTest < Workarea::IntegrationTest
           def test_balance_lookup
             gift_card = create_gift_card(
               to: 'bcrouse@weblinc.com',

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

@@ -0,0 +1,116 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class CheckoutGiftCardsIntegrationTest < Workarea::IntegrationTest
+      setup :setup_checkout
+
+      def setup_checkout
+        create_tax_category(
+          name: 'Sales Tax',
+          code: '001',
+          rates: [{ percentage: 0.07, country: 'US', region: 'PA' }]
+        )
+
+        create_shipping_service(
+          name: 'Ground',
+          tax_code: '001',
+          rates: [{ price: 7.to_m }]
+        )
+
+        product = create_product(
+          name: 'Integration Product',
+          variants: [{ sku: 'SKU1', regular: 5.to_m, tax_code: '001' }]
+        )
+
+        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',
+                shipping_address: factory_defaults(:shipping_address),
+                billing_address: factory_defaults(:billing_address)
+              }
+      end
+
+      def test_paying_with_gift_cards
+        card_one = create_gift_card(token: '123', amount: 10.to_m)
+        card_two = create_gift_card(token: '456', amount: 20.to_m)
+
+        patch storefront.checkout_gift_cards_path,
+              params: { gift_card_number: '123' }
+
+        order = Order.first
+        payment = Payment.find(order.id)
+
+        assert_equal(1, payment.gift_cards.count)
+
+        gift_card = payment.gift_cards.first
+        assert_equal(card_one.token, gift_card.number)
+        assert_equal(10.to_m, gift_card.amount)
+
+        patch storefront.checkout_gift_cards_path,
+              params: { gift_card_number: '456' }
+
+        payment.reload
+
+        assert_equal(2, payment.gift_cards.count)
+
+        gift_card = payment.gift_cards.last
+        assert_equal(card_two.token, gift_card.number)
+        assert_equal(8.19.to_m, gift_card.amount)
+
+        delete storefront.checkout_gift_cards_path,
+               params: { gift_card_id: payment.gift_cards.first.id }
+
+        payment.reload
+
+        assert_equal(1, payment.gift_cards.count)
+
+        gift_card = payment.gift_cards.first
+        assert_equal(card_two.token, gift_card.number)
+        assert_equal(18.19.to_m, gift_card.amount)
+
+        patch storefront.checkout_place_order_path
+        assert_redirected_to(storefront.checkout_confirmation_path)
+      end
+
+      def test_reduces_balance_on_gift_card
+        pass && (return) unless Workarea::GiftCards.uses_system_cards?
+
+        gift_card = create_gift_card(token: '123', amount: 5.to_m)
+
+        patch storefront.checkout_gift_cards_path,
+              params: { gift_card_number: '123' }
+
+        patch storefront.checkout_place_order_path,
+              params: {
+                payment: 'new_card',
+                credit_card: {
+                  number: '1',
+                  month:  1,
+                  year:   2020,
+                  cvv:    '999'
+                }
+              }
+
+        assert_redirected_to(storefront.checkout_confirmation_path)
+
+        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

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

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class GiftCardsIntegrationTest < Workarea::IntegrationTest
+      def test_balance_lookup
+        gift_card = create_gift_card(to: 'test@workarea.com', amount: 12.to_m)
+
+        get storefront.gift_cards_lookup_path,
+            params: {
+              email: gift_card.to,
+              token: gift_card.token
+            }
+
+        assert_redirected_to(storefront.gift_cards_balance_path)
+        assert_equal(
+          t(
+            'workarea.storefront.flash_messages.gift_card_balance',
+            balance: gift_card.balance.format
+          ),
+          flash[:success]
+        )
+
+        get storefront.gift_cards_lookup_path,
+            params: {
+              email: 'foo@workarea.com',
+              token: gift_card.token
+            }
+
+        assert_equal(
+          t('workarea.storefront.flash_messages.gift_card_not_found'),
+          flash[:error]
+        )
+
+        get storefront.gift_cards_lookup_path,
+            params: {
+              email: gift_card.to,
+              token: '125'
+            }
+
+        assert_equal(
+          t('workarea.storefront.flash_messages.gift_card_not_found'),
+          flash[:error]
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class PurchaseGiftCardIntegrationTest < Workarea::IntegrationTest
+      include Storefront::IntegrationTest
+
+      def test_generates_gift_card
+        pass && (return) unless Workarea::GiftCards.uses_system_cards?
+
+        product = create_product(
+          name: 'Gift Card',
+          gift_card: true,
+          customizations: 'gift_card',
+          variants: [{ sku: 'GIFTCARD', regular: 10.to_m }]
+        )
+
+        create_fulfillment_sku(id: 'GIFTCARD', policy: :create_gift_card)
+
+        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
+             }
+
+        complete_checkout
+
+        assert_equal(1, Payment::GiftCard.count)
+
+        card = Payment::GiftCard.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(card.purchased?)
+
+        assert_equal(2, ActionMailer::Base.deliveries.length)
+
+        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