workarea-gift_cards 3.4.11 → 4.0.0.beta.1

data/app/models/workarea/payment/tender/gift_card.rb

@@ -12,19 +12,12 @@ module Workarea
     end
 
     def amount=(amount)
-      if amount.blank?
-        super(amount)
-      elsif balance >= amount
-        super(amount)
-      else
-        super(balance)
-      end
+      return super(amount) if amount.blank? || balance >= amount
+      super(balance)
     end
 
-    private
-
     def balance
-      @balance ||= Payment::GiftCard.find_balance(number)
+      @balance ||= Workarea::GiftCards.gateway.balance(number)
     end
   end
 end

data/app/models/workarea/payment.decorator

@@ -1,19 +1,37 @@
 module Workarea
   decorate Payment, with: 'gift_cards' do
     decorated do
-      embeds_one :gift_card, class_name: 'Workarea::Payment::Tender::GiftCard'
+      embeds_many :gift_cards, class_name: 'Workarea::Payment::Tender::GiftCard'
       delegate :number, to: :gift_card, allow_nil: true, prefix: true
+      validate :gift_card_count_limit
     end
 
-    def set_gift_card(attrs)
-      build_gift_card unless gift_card
-      gift_card.number = attrs[:number]
+    def gift_card?
+      gift_cards.present?
+    end
+
+    def add_gift_card(attrs)
+      existing = gift_cards.detect do |card|
+        card.number.casecmp?(attrs[:number].strip)
+      end
+
+      if existing.present?
+        existing.assign_attributes(attrs)
+      else
+        gift_cards.build(attrs)
+      end
+
       save
     end
 
-    def reset!
-      self.gift_card = nil
-      super
+    private
+
+    def gift_card_count_limit
+      max = Workarea.config.max_gift_cards_per_order
+
+      if gift_cards.size > max
+        errors.add(:base, I18n.t('workarea.gift_cards.max_applied', count: max))
+      end
     end
   end
 end

data/app/models/workarea/search/admin/order.decorator

@@ -1,9 +1,7 @@
 module Workarea
   decorate Search::Admin::Order, with: 'gift_cards' do
-    def search_text
-      result = super
-      result += " #{payment.gift_card.number}" if payment.gift_card.present?
-      result
+    def keywords
+      super + payment.gift_cards.map(&:number)
     end
   end
 end

data/app/seeds/workarea/gift_card_seeds.rb

@@ -12,7 +12,6 @@ module Workarea
         id: 'GIFT_CARD',
         name: 'Gift Card',
         gift_card: true,
-        digital: true,
         template: 'gift_card',
         customizations: 'gift_card',
         description: Faker::Lorem.paragraph,
@@ -25,19 +24,20 @@ module Workarea
 
       product.save!
 
-      Workarea::Pricing::Sku.find_or_create_by(
+
+      Workarea::Fulfillment::Sku.find_or_create_by(
         id: 'GIFT_CARD_10',
-        prices: [{ regular: 10 }]
+        policy: :create_gift_card
       )
 
-      Workarea::Pricing::Sku.find_or_create_by(
+      Workarea::Fulfillment::Sku.find_or_create_by(
         id: 'GIFT_CARD_25',
-        prices: [{ regular: 25 }]
+        policy: :create_gift_card
       )
 
-      Workarea::Pricing::Sku.find_or_create_by(
+      Workarea::Fulfillment::Sku.find_or_create_by(
         id: 'GIFT_CARD_50',
-        prices: [{ regular: 50 }]
+        policy: :create_gift_card
       )
     end
   end

data/app/view_models/workarea/storefront/gift_card_order_pricing.rb

@@ -1,35 +1,34 @@
 module Workarea
   module Storefront
     module GiftCardOrderPricing
-      def gift_card
-        return unless payment.gift_card.present?
-        @gift_card ||= Workarea::Payment::GiftCard.find_by_token(
-          payment.gift_card.number
-        )
+      extend ActiveSupport::Concern
+
+      def gift_cards
+        @gift_cards ||= payment.gift_cards.select(&:persisted?)
       end
 
-      def gift_card_balance
-        if gift_card.present?
-          gift_card.balance
-        else
-          0.to_m
-        end
+      def gift_card?
+        gift_cards.present?
       end
 
       def gift_card_amount
-        if gift_card_balance > total_after_store_credit
-          total_after_store_credit
-        else
-          gift_card_balance
-        end
+        gift_cards.sum(0.to_m, &:amount)
+      end
+
+      def gift_card_balance
+        gift_cards.sum(0.to_m, &:balance)
+      end
+
+      def total_before_gift_cards
+        order.total_price - advance_payment_amount + gift_card_amount
       end
 
-      def total_after_store_credit
-        order.total_price - store_credit_amount
+      def advance_payment_amount
+        super + gift_card_amount
       end
 
-      def order_balance
-        super - gift_card_amount
+      def failed_gift_card
+        @failed_gift_card ||= payment.gift_cards.reject(&:persisted?).first
       end
     end
   end

data/app/view_models/workarea/storefront/order_view_model.decorator

@@ -1,27 +1,7 @@
 module Workarea
-  decorate Storefront::OrderViewModel, with: 'gift_card_display' do
-    decorated do
-      delegate :gift_card?, to: :payment
-    end
-
-    def gift_card_tender
-      payment.gift_card
-    end
-
-    def gift_card_display_number
-      gift_card_tender.try(:display_number)
-    end
-
-    def gift_card_tender_amount
-      if gift_card?
-        gift_card_tender.amount
-      else
-        0.to_m
-      end
-    end
-
+  decorate Storefront::OrderViewModel, with: :order_gift_card do
     def paid_amount
-      super - gift_card_tender_amount
+      super - gift_card_amount
     end
   end
 end

data/app/views/workarea/admin/payment_gift_cards/_menu.html.haml

@@ -1 +1,2 @@
-%li{ class: "primary-nav__item" }= link_to t('workarea.admin.shared.primary_nav.gift_cards'), payment_gift_cards_path, class: navigation_link_classes(payment_gift_cards_path)
+- if Workarea::GiftCards.uses_system_cards?
+  %li{ class: "primary-nav__item" }= link_to t('workarea.admin.shared.primary_nav.gift_cards'), payment_gift_cards_path, class: navigation_link_classes(payment_gift_cards_path)

data/app/views/workarea/storefront/checkouts/_gift_card_error.html.haml

@@ -1,6 +1,8 @@
-- if step.payment.gift_card && step.payment.gift_card.errors.any?
-  - step.payment.gift_card.errors.full_messages.each do |message|
-    .message.message--error
-      %p.message__type
-        %span.message__icon= t('workarea.storefront.messages.error')
-      %p.message__text= message
+- if step.gift_card?
+  - step.gift_cards.each do |gift_card|
+    - if gift_card.errors.any?
+      - gift_card.full_messages.each do |message|
+        .message.message--error
+          %p.message__type
+            %span.message__icon= t('workarea.storefront.messages.error')
+          %p.message__text= message

data/app/views/workarea/storefront/checkouts/_gift_card_payment.html.haml

@@ -1,28 +1,36 @@
-.checkout-payment__secondary-method{ class: step.show_gift_card? ? 'checkout-payment__secondary-method--visible' : nil }
+.checkout-payment__secondary-method{ class: step.gift_card? ? 'checkout-payment__secondary-method--visible' : nil }
 
-  - if step.show_gift_card?
+  - if step.gift_card?
     .message.message--info
       %p.message__type
         %span.message__icon= t('workarea.storefront.messages.info')
       %p.message__text
-        #{t('workarea.storefront.gift_cards.balance', amount: number_to_currency(step.gift_card_balance))}
-        #{t('workarea.storefront.gift_cards.applied_to_order', amount: number_to_currency(step.gift_card_amount))}
+        #{t('workarea.storefront.gift_cards.balance_html', amount: number_to_currency(step.gift_card_balance))}
+        #{t('workarea.storefront.gift_cards.applied_to_order_html', amount: number_to_currency(step.gift_card_amount))}
 
-        - if step.order_covered_by_gift_card?
-          #{t('workarea.storefront.gift_cards.place_order', amount: number_to_currency(step.gift_card_amount))}
         - if step.tender_required?
-          #{t('workarea.storefront.gift_cards.tender_required', amount: number_to_currency(step.order_balance))}
+          #{t('workarea.storefront.gift_cards.tender_required_html', amount: number_to_currency(step.order_balance))}
+        - else
+          #{t('workarea.storefront.gift_cards.place_order')}
 
-  = optional_field(t('workarea.storefront.gift_cards.enter_gift_card_prompt'), step.gift_card.try(:number)) do
+  = optional_field(t('workarea.storefront.gift_cards.enter_gift_card_prompt'), step.gift_cards, step.failed_gift_card) do
 
     %h2= t('workarea.storefront.gift_cards.gift_card')
 
-    = form_tag checkout_add_gift_card_path, method: 'patch', id: 'gift_card_form', class: 'inline-form' do
+    = form_tag checkout_gift_cards_path, method: 'patch', id: 'gift_card_form', class: 'inline-form' do
 
       .inline-form__cell
         .value
-          = text_field_tag 'gift_card_number', step.gift_card.try(:number), class: 'text-box', autocomplete: 'off', title: t('workarea.storefront.gift_cards.gift_card_number'), placeholder: t('workarea.storefront.gift_cards.gift_card_number')
-          - if step.gift_card && step.gift_card.errors[:number].present?
-            %span.value__error= step.gift_card.errors[:number].first
+          = text_field_tag 'gift_card_number', step.failed_gift_card&.number, class: 'text-box', autocomplete: 'off', title: t('workarea.storefront.gift_cards.gift_card_number'), placeholder: t('workarea.storefront.gift_cards.gift_card_number')
+          - if step.failed_gift_card && step.failed_gift_card.errors[:number].present?
+            %span.value__error= step.failed_gift_card.errors[:number].first
       .inline-form__cell
         %p= button_tag t('workarea.storefront.gift_cards.apply_gift_card'), value: 'apply_gift_card', class: 'button'
+
+    .applied-gift-cards
+      - step.gift_cards.each do |gift_card|
+        %p.applied-gift-card
+          %strong.applied-gift-card__number= gift_card.display_number
+          = link_to t('workarea.storefront.gift_cards.remove'), checkout_gift_cards_path(gift_card_id: gift_card.id), data: { method: :delete, confirm: t('workarea.storefront.gift_cards.remove_confirmation') }, class: 'applied-gift-card__remove-link'
+          %br
+          %span.applied-gift-card__applied= t('workarea.storefront.gift_cards.balance_applied_html', amount: number_to_currency(gift_card.amount), balance: number_to_currency(gift_card.balance))

data/app/views/workarea/storefront/gift_card_mailer/created.html.haml

@@ -4,7 +4,7 @@
     %p
       %strong= @from
       %br
-      = t('workarea.storefront.email.gift_card_created.message_html', link: link_to(Workarea.config.host, Workarea.config.host, style: "color: #{@config.link_color}"), amount: number_to_currency(@card.amount))
+      = t('workarea.storefront.email.gift_card_created.message_html', link: link_to(Workarea.config.host, Workarea.config.host), amount: number_to_currency(@card.amount))
 
     - if @card.message.present?
       %p

data/app/views/workarea/storefront/order_mailer/_gift_card_summary.html.haml

@@ -1,5 +1,6 @@
-- if order.gift_card_tender_amount > 0
-  %tr
-    %th= t('workarea.storefront.gift_cards.gift_card')
-    %td
-      - #{number_to_currency order.gift_card_tender_amount}
+- if order.gift_card_amount > 0
+  - order.gift_cards.each do |gift_card|
+    %p
+      = t('workarea.storefront.gift_cards.gift_card')
+      = gift_card.display_number
+      = number_to_currency(gift_card.amount)

data/app/views/workarea/storefront/orders/_gift_card_summary.html.haml

@@ -1,6 +1,6 @@
-- if order.gift_card_tender_amount > 0
+- if order.gift_card_amount > 0
   %tr
     %th
       %span= t('workarea.storefront.gift_cards.gift_card')
     %td
-      %strong.table__price-discount −#{number_to_currency(order.gift_card_tender_amount)}
+      %strong.table__price-discount −#{number_to_currency(order.gift_card_amount)}

data/app/views/workarea/storefront/products/templates/_gift_card.html.haml

@@ -2,12 +2,12 @@
   .grid__cell.grid__cell--60-at-medium
 
     .product-details__name
-      %h1.product-details__heading{ itemprop: 'name' }= product.name
+      %h1.product-details__heading= product.name
 
       %p.product-details__id
-        %span{ itemprop: 'productID' }= product.id
+        %span= product.id
 
-      .product-prices.product-prices--details{ itemprop: 'offers', itemscope: true, itemtype: 'http://schema.org/Offer' }
+      .product-prices.product-prices--details
         = render 'workarea/storefront/products/pricing', product: product
 
       - if product.description.present?
@@ -60,13 +60,13 @@
 
       = append_partials('storefront.product_details', product: product)
 
-      %p.product-details__full-details=link_to t('workarea.storefront.products.view_full_details'), product_path(product, color: params[:color]), class: 'text-button', itemprop: 'url'
+      %p.product-details__full-details=link_to t('workarea.storefront.products.view_full_details'), product_path(product, color: params[:color]), class: 'text-button'
 
   .grid__cell.grid__cell--40-at-medium
 
     .product-details__primary-image
       = link_to(product_image_url(product.primary_image, :zoom), target: '_blank', class: 'product-details__primary-image-link', data: { dialog_button: '' }) do
-        = image_tag product_image_url(product.primary_image, :detail), alt: 'View Larger Image', itemprop: 'image', class: 'product-details__primary-image-link-image'
+        = image_tag product_image_url(product.primary_image, :detail), alt: 'View Larger Image', class: 'product-details__primary-image-link-image'
 
     - if product.images.length > 1
       .product-details__alt-images

data/app/workers/workarea/log_gift_card_redemption.rb

@@ -3,7 +3,12 @@ module Workarea
     include Sidekiq::Worker
     include Sidekiq::CallbacksWorker
 
-    sidekiq_options enqueue_on: { Order => :place }
+    sidekiq_options(
+      enqueue_on: {
+        Order => :place,
+        only_if: -> { Workarea::GiftCards.uses_system_cards? }
+      }
+    )
 
     def perform(order_id)
       order = Order.find(order_id)
@@ -11,16 +16,18 @@ module Workarea
       payment = Payment.find_or_initialize_by(id: order.id)
       return unless payment.gift_card?
 
-      gift_card = Payment::GiftCard.find_by_token(payment.gift_card.number)
-      return if redemption_already_exists?(gift_card, order.id)
+      payment.gift_cards.each do |tender|
+        gift_card = Payment::GiftCard.find_by_token(tender.number)
+        next if redemption_already_exists?(gift_card, order.id)
 
-      gift_card.redemptions.create!(
-        redeemed_at: order.placed_at,
-        amount: payment.gift_card.amount,
-        order_id: order.id
-      )
+        gift_card.redemptions.create!(
+          redeemed_at: order.placed_at,
+          amount: tender.amount,
+          order_id: order.id
+        )
 
-      gift_card.touch
+        gift_card.touch
+      end
     end
 
     private

data/config/initializers/configuration.rb

@@ -1,8 +1,11 @@
 Workarea.configure do |config|
-  config.checkout_steps << 'Workarea::Checkout::Steps::GiftCard'
-  config.customization_types << Workarea::Catalog::Customizations::GiftCard
   config.product_templates << :gift_card
-  config.tender_types.prepend(:gift_card)
+  config.customization_types << 'Workarea::Catalog::Customizations::GiftCard'
+  config.fulfillment_policies << 'Workarea::Fulfillment::Policies::CreateGiftCard'
+  config.checkout_steps << 'Workarea::Checkout::Steps::GiftCard'
+  config.tender_types.prepend(:gift_cards)
   config.seeds << 'Workarea::GiftCardSeeds'
-  config.gift_card_token_length = 8
+  config.jump_to_navigation.merge!('Gift Cards' => :payment_gift_cards_path)
+
+  config.gateways.gift_card = 'Workarea::GiftCards::Gateway'
 end

data/config/initializers/fields.rb

@@ -0,0 +1,14 @@
+
+Workarea::Configuration.define_fields do
+  fieldset 'Gift Cards', namespaced: false do
+    field 'Gift Card Token Length',
+      type: :integer,
+      default: 8,
+      description: 'Length of digital gift card numbers generated by Workarea.'
+
+    field 'Max Gift Cards Per Order',
+      type: :integer,
+      default: 10,
+      description: 'How many gift cards can be applied to a single order.'
+  end
+end

data/config/locales/en.yml

@@ -52,6 +52,7 @@ en:
       credit: "%{amount} added to gift card %{number}"
       debit: "%{amount} deducted from gift card %{number}"
       insufficient_funds: This gift card doesn't not enough balance.
+      max_applied: You can only apply up to %{count} gift cards to an order.
     payment_gift_card:
       name: Gift Card %{token}
     storefront:
@@ -62,20 +63,29 @@ en:
           message_html: has purchased a gift certificate for you to use at %{link} in the amount of %{amount}.
           says: 'says:'
           subject: You've Got a Gift Certificate!
+      flash_messages:
+        gift_card_added: Your gift card has been applied.
+        gift_card_error: We couldn't add this gift card number.
+        gift_card_removed: Your gift card has been removed.
+        gift_card_balance: Your balance is %{balance}.
+        gift_card_not_found: Invalid card number or email.
       gift_cards:
-        applied_to_order: "%{amount} will be applied to your order."
+        applied_to_order_html: "%{amount} will be applied to your order."
         apply_gift_card: Apply
-        balance: Your gift card balance is %{amount}.
+        balance_html: Your total gift card balance is %{amount}.
+        balance_applied_html: '%{amount} of %{balance} balance will be applied to this order.'
         check_balance: Check Your Gift Card Balance
         email_to_recipient: We will email the digital gift card to the recipient.
         enter_gift_card_prompt: Enter a gift card number
-        gift_card: Gift Card
+        gift_card: Gift Cards
         gift_card_number: Gift Card Number
         message_to_recipient: Message to Recipient
         place_order: Click the Place Order button below to complete your order.
         recipients_email: Recipient's Email
+        remove: remove
+        remove_confirmation: Are you sure you want to remove this gift card?
         senders_email: Your Name
-        tender_required: You must submit another payment method for %{amount}.
+        tender_required_html: You must submit another payment method for %{amount}.
       orders:
         tenders:
           gift_card:

data/config/routes.rb

@@ -10,19 +10,26 @@ Workarea::Storefront::Engine.routes.draw do
   scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
     get 'gift_cards/balance', to: 'gift_cards#index'
     get 'gift_cards/lookup', to: 'gift_cards#lookup'
-    patch 'checkout/add_gift_card', to: 'checkouts#add_gift_card'
+
+    namespace :checkout do
+      patch 'gift_cards', to: 'gift_cards#add'
+      delete 'gift_cards', to: 'gift_cards#remove'
+    end
   end
 end
 
 if Workarea::Plugin.installed?(:api)
   Workarea::Api::Admin::Engine.routes.draw do
-    resources :payment_gift_cards
+    resources :gift_cards do
+      collection { patch 'bulk' }
+    end
   end
 
   Workarea::Api::Storefront::Engine.routes.draw do
     resources :checkouts, only: [] do
       member do
         patch 'add_gift_card'
+        delete 'remove_gift_card'
       end
     end
 

data/lib/workarea/gift_cards/gateway.rb

@@ -0,0 +1,128 @@
+module Workarea
+  module GiftCards
+    class Gateway
+      # Object returns from transaction requests.
+      #
+      # @attr [Boolean] success? whether the transaction was successful or not
+      # @attr [String] message information on the transaction result
+      #
+      class Response < Struct.new(:success?, :message); end
+
+      # Whether or not this gateway uses +Workarea::Payment::GiftCard+
+      # This controls the display of the admin menu, triggering the creation of
+      # cards from orders, and tracking redemptions.
+      #
+      def uses_system_cards?
+        true
+      end
+
+      # See purchase. This gateway performs a purchase on authorization.
+      #
+      # @param [Integer] amount amount to authorize, in cents
+      # @param [Workarea::Payment::Tender::GiftCard] tender for transaction
+      #
+      # @return [Workarea::GiftCards::Gateway::Response]
+      #
+      def authorize(amount, tender)
+        purchase(amount, tender)
+      end
+
+      # See refund.
+      #
+      # @param [Integer] amount amount to cancel, in cents
+      # @param [Workarea::Payment::Tender::GiftCard] tender for transaction
+      #
+      # @return [Workarea::GiftCards::Gateway::Response]
+      #
+      def cancel(amount, tender)
+        refund(amount, tender)
+      end
+
+      # This gateway does a purchase on authorization so no capture is required.
+      #
+      # @param [Integer] amount amount to capture, in cents
+      # @param [Workarea::Payment::Tender::GiftCard] tender for transaction
+      #
+      # @return [Workarea::GiftCards::Gateway::Response]
+      #
+      def capture(amount, tender)
+        # no op, captures on authorization
+        Response.new(true, I18n.t('workarea.gift_cards.capture'))
+      end
+
+      # Perform a purchase on a +Workarea::Payment::GiftCard+. This will
+      # increment the `used` field, and decrement the `balance` field.
+      #
+      # @param [Integer] amount amount to purchase, in cents
+      # @param [Workarea::Payment::Tender::GiftCard] tender for transaction
+      #
+      # @return [Workarea::GiftCards::Gateway::Response]
+      #
+      def purchase(amount, tender)
+        Payment::GiftCard.purchase(tender.number, amount)
+
+        Response.new(
+          true,
+          I18n.t(
+            'workarea.gift_cards.debit',
+            amount: amount,
+            number: tender.number
+          )
+        )
+      rescue Payment::InsufficientFunds
+        Response.new(false, I18n.t('workarea.gift_cards.insufficient_funds'))
+      end
+
+      # Undo a purchase on a +Workarea::Payment::GiftCard+. This will
+      # increment the `balance` field, and decrement the `used` field.
+      #
+      # @param [Integer] amount amount to refund, in cents
+      # @param [Workarea::Payment::Tender::GiftCard] tender for transaction
+      #
+      # @return [Workarea::GiftCards::Gateway::Response]
+      #
+      def refund(amount, tender)
+        Payment::GiftCard.refund(tender.number, amount)
+
+        Response.new(
+          true,
+          I18n.t(
+            'workarea.gift_cards.credit',
+            amount: amount,
+            number: tender.number
+          )
+        )
+      end
+
+      # Lookup the balance of one or many +Workarea::Payment::GiftCard+ records.
+      # It will always return a single sum. If multiple numbers are provided, it
+      # returns the total of all balances. Invalid numbers return a balance of
+      # zero.
+      #
+      # @param [String] token the gift card number/token
+      #
+      # @return [Money] the balance gift cards matching the numbers provided
+      #
+      def balance(token)
+        Array.wrap(token).sum(0.to_m) { |t| Payment::GiftCard.find_balance(t) }
+      end
+
+      # Lookup a gift card.
+      #
+      # @param [Hash] params
+      # @option params [String] :email address associated to the gift card
+      # @option params [String] :token gift card number/token to lookup
+      #
+      # @return [Workarea::Payment::GiftCard, nil]
+      #
+      def lookup(params)
+        email = params.fetch(:email, nil)
+        token = params.fetch(:token, nil)
+
+        if email.present? && token.present?
+          Workarea::Payment::GiftCard.find_by_token_and_email(token, email)
+        end
+      end
+    end
+  end
+end

data/lib/workarea/gift_cards/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module GiftCards
-    VERSION = '3.4.11'.freeze
+    VERSION = '4.0.0.beta.1'.freeze
   end
 end

data/lib/workarea/gift_cards.rb

@@ -4,8 +4,17 @@ require 'workarea/admin'
 
 module Workarea
   module GiftCards
+    def self.gateway
+      Workarea.config.gateways.gift_card.constantize.new
+    end
+
+    def self.uses_system_cards?
+      Workarea::GiftCards.gateway.respond_to?(:uses_system_cards?) &&
+        Workarea::GiftCards.gateway.uses_system_cards?
+    end
   end
 end
 
 require 'workarea/gift_cards/version'
 require 'workarea/gift_cards/engine'
+require 'workarea/gift_cards/gateway'