workarea-gift_cards 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cad03a3ad49bb8c2ca3708d40d76a92a15cc54957a94f1470d4c523a14967325
-  data.tar.gz: 8e42247357331ef7475c3110c18ffdd2fac3c9b4c917ab6e8f1104c055e0a318
+  metadata.gz: 4640c0b94ade3085580304d3a0220f85cb73a570d93e3a7c945081a1bda0a72f
+  data.tar.gz: bcab8a176b67c59e809a89d0b459d3f01dd123d91e05b6aab8f51f3ea13766cd
 SHA512:
-  metadata.gz: a21ec364a0d7534e4df67b63fbe304846b6dd1b15c60a46dd8533e7a020c184b015f5e95d9ebb4d05ea4f3aa75a02721df72569eb1f68d0d49db44d434b772aa
-  data.tar.gz: a7cc9714355e711aebb5db593be66ff917b611474d59e62d3789957668c6e5573b0f12eb4aeff3ba3cf8fe412185d3689ebd69fb110ea342e5b6759401d9d8fe
+  metadata.gz: 4f8f96a3442cabeb3cc94aef6fd542b6a77d0c792947cf795edade12f36f6e67ca1ef743632415a2d4d689990e2f70eeefa8a4b28024699f44658851eeb2e18f
+  data.tar.gz: 800f842ad499e8adac230b8fabc356ad890d82c38f8269f449baf2e0f5082740e092df674c14c43c3c2b4a038bad49a9b4e7d13897aab24415668232285c5743

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+Workarea Gift Cards 4.0.3 (2020-08-19)
+--------------------------------------------------------------------------------
+
+*   Fix Update Step Result
+
+    Prevent returning `false` early when no Gift Card params are set. This
+    ensures the step won't block checkout.
+
+    Tom Scott
+
+*   Improve Test Experience For Custom Gift Card Gateways
+
+    If you're creating a new custom gift card gateway for your project, and
+    you want to use the tests from base as a starting point for that
+    integration, you currently must duplicate the tests from the plugin in
+    your own plugin, which makes things a bit harder but also removes the
+    ability to take on updates to the test in case of bug fixes. To improve
+    this experience, the `Workarea::GiftCards::GatewayTest` has been
+    modified to more easily allow decorating it in a host application. All
+    tests are now wrapped in a VCR cassette whose name is defined by the
+    parameterized gateway class name and the name of the method being
+    tested. This will activate and create cassettes in the real world when a
+    gateway makes an outbound HTTP call, similar to
+    `CreditCardIntegrationTest`.
+
+    GIFTCARDS-9
+
+    Tom Scott
+
+
+
 Workarea Gift Cards 4.0.2 (2020-03-03)
 --------------------------------------------------------------------------------
 

data/README.md

@@ -107,6 +107,30 @@ end
 
 Note that it is set to a string of the class constant, and not an instance of the class. The system constantizes and initializes a new instance whenever it uses the gateway to ensure autoloading works correctly and so a gateway that cares about the current state of the application is applied correctly. This is most relevant in multi-site environments where each site might want to use their own gift card gateway.
 
+### Testing Your Custom Gateway
+
+Workarea comes with unit tests for the main Gateway class, and you can
+decorate this test to provide your own setup code. A minimal
+implementation would look as follows:
+
+```ruby
+module Workarea
+  module GiftCards
+    decorate GatewayTest do
+      # Provide your own Gateway instance here to use it in each test.
+      def gateway
+        CustomGiftCardGateway.new
+      end
+
+      # Provide a custom object representing a Gift Card on your
+      # 3rd-party service.
+      def gift_card
+        CustomGiftCard.new(balance: 10.to_m)
+      end
+    end
+  end
+end
+```
 
 Workarea Commerce Documentation
 --------------------------------------------------------------------------------

data/app/models/workarea/checkout/steps/gift_card.rb

@@ -12,8 +12,9 @@ module Workarea
         #
         def update(params = {})
           gift_card_params = extract_gift_card_params(params)
-          return false unless applicable_gift_card?(gift_card_params)
-          return false unless add_gift_card(gift_card_params)
+
+          add_gift_card(gift_card_params) if applicable_gift_card?(gift_card_params)
+
           update_order
         end
 

data/lib/workarea/gift_cards/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module GiftCards
-    VERSION = '4.0.2'.freeze
+    VERSION = '4.0.3'.freeze
   end
 end

data/test/lib/workarea/gift_cards/gateway_test.rb

@@ -5,10 +5,17 @@ module Workarea
     class GatewayTest < TestCase
       setup :gift_card
 
+      # Override this to instantiate an object that models a gift card
+      # on the remote system.
       def gift_card
         @gift_card ||= create_gift_card(amount: 10.to_m)
       end
 
+      # The tender object used on an order that will be passed into each
+      # gateway method call. Override this to provide your own
+      # information.
+      #
+      # @return [Payment::Tender::GiftCard]
       def tender
         @tender ||= Payment::Tender::GiftCard.new(
           number: gift_card.token,
@@ -16,81 +23,108 @@ module Workarea
         )
       end
 
+      # Override this in your test to instantiate a gateway for use in
+      # tests. The class name of the gateway is used to generate the
+      # folder name for the VCR cassettes used within this test.
       def gateway
         Gateway.new
       end
 
+      # Use the class name of the gateway to generate a directory in
+      # `test/vcr_cassettes` where all cassettes for the custom gateway
+      # will go. This doesn't need to be overridden unless you need to
+      # customize the gateway cassette directory name.
+      #
+      # @return [String]
+      def gateway_cassette_name
+        gateway.class.name.systemize
+      end
+
       def test_authorize
-        response = gateway.authorize(200, tender)
+        VCR.use_cassette "#{gateway_cassette_name}/authorize" do
+          response = gateway.authorize(200, tender)
 
-        assert(response.success?)
-        assert(response.message.present?)
+          assert(response.success?)
+          assert(response.message.present?)
 
-        gift_card.reload
-        assert_equal(8.to_m, gift_card.balance)
-        assert_equal(2.to_m, gift_card.used)
+          gift_card.reload
+          assert_equal(8.to_m, gift_card.balance)
+          assert_equal(2.to_m, gift_card.used)
+        end
       end
 
       def test_cancel
-        response = gateway.authorize(200, tender)
-        assert(response.success?)
+        VCR.use_cassette "#{gateway_cassette_name}/cancel" do
+          response = gateway.authorize(200, tender)
+          assert(response.success?)
 
-        response = gateway.cancel(200, tender)
+          response = gateway.cancel(200, tender)
 
-        assert(response.success?)
-        assert(response.message.present?)
+          assert(response.success?)
+          assert(response.message.present?)
 
-        gift_card.reload
-        assert_equal(10.to_m, gift_card.balance)
-        assert_equal(0.to_m, gift_card.used)
+          gift_card.reload
+          assert_equal(10.to_m, gift_card.balance)
+          assert_equal(0.to_m, gift_card.used)
+        end
       end
 
       def test_capture
-        assert(gateway.capture(200, tender).success?)
-        assert_equal(10.to_m, gift_card.reload.balance)
+        VCR.use_cassette "#{gateway_cassette_name}/capture" do
+          assert(gateway.capture(200, tender).success?)
+          assert_equal(10.to_m, gift_card.reload.balance)
+        end
       end
 
       def test_purchase
-        response = gateway.purchase(200, tender)
+        VCR.use_cassette "#{gateway_cassette_name}/purchase" do
+          response = gateway.purchase(200, tender)
 
-        assert(response.success?)
-        assert(response.message.present?)
+          assert(response.success?)
+          assert(response.message.present?)
 
-        gift_card.reload
-        assert_equal(8.to_m, gift_card.balance)
-        assert_equal(2.to_m, gift_card.used)
+          gift_card.reload
+          assert_equal(8.to_m, gift_card.balance)
+          assert_equal(2.to_m, gift_card.used)
+        end
       end
 
       def test_refund
-        response = gateway.authorize(200, tender)
-        assert(response.success?)
+        VCR.use_cassette "#{gateway_cassette_name}/refund" do
+          response = gateway.authorize(200, tender)
+          assert(response.success?)
 
-        response = gateway.refund(200, tender)
+          response = gateway.refund(200, tender)
 
-        assert(response.success?)
-        assert(response.message.present?)
+          assert(response.success?)
+          assert(response.message.present?)
 
-        gift_card.reload
-        assert_equal(10.to_m, gift_card.balance)
-        assert_equal(0.to_m, gift_card.used)
+          gift_card.reload
+          assert_equal(10.to_m, gift_card.balance)
+          assert_equal(0.to_m, gift_card.used)
+        end
       end
 
       def test_balance
-        balance = gateway.balance(gift_card.number)
-        assert_equal(10.to_m, balance)
+        VCR.use_cassette "#{gateway_cassette_name}/balance" do
+          balance = gateway.balance(gift_card.number)
+          assert_equal(10.to_m, balance)
 
-        gateway.authorize(300, tender)
+          gateway.authorize(300, tender)
 
-        balance = gateway.balance(gift_card.number)
-        assert_equal(7.to_m, balance)
+          balance = gateway.balance(gift_card.number)
+          assert_equal(7.to_m, balance)
+        end
       end
 
       def test_lookup
-        lookup = gateway.lookup(email: gift_card.to, token: gift_card.token)
-        assert_equal(gift_card.id, lookup.id)
+        VCR.use_cassette "#{gateway_cassette_name}/lookup" do
+          lookup = gateway.lookup(email: gift_card.to, token: gift_card.token)
+          assert_equal(gift_card.id, lookup.id)
 
-        lookup = gateway.lookup(email: 'foo', token: gift_card.token)
-        assert_nil(lookup)
+          lookup = gateway.lookup(email: 'foo', token: gift_card.token)
+          assert_nil(lookup)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workarea-gift_cards
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - bcrouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -224,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Gift Cards plugin for the Workarea Commerce Platform