workarea-gift_cards 3.4.6

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

@@ -0,0 +1,30 @@
+module Workarea
+  class Payment::Tender::GiftCard < Payment::Tender
+    field :number, type: String
+    validates :number, presence: true
+
+    def display_number
+      "XXXX#{number.last(4)}"
+    end
+
+    def slug
+      :gift_card
+    end
+
+    def amount=(amount)
+      if amount.blank?
+        super(amount)
+      elsif balance >= amount
+        super(amount)
+      else
+        super(balance)
+      end
+    end
+
+    private
+
+    def balance
+      @balance ||= Payment::GiftCard.find_balance(number)
+    end
+  end
+end

data/app/models/workarea/payment.decorator

@@ -0,0 +1,19 @@
+module Workarea
+  decorate Payment, with: 'gift_cards' do
+    decorated do
+      embeds_one :gift_card, class_name: 'Workarea::Payment::Tender::GiftCard'
+      delegate :number, to: :gift_card, allow_nil: true, prefix: true
+    end
+
+    def set_gift_card(attrs)
+      build_gift_card unless gift_card
+      gift_card.number = attrs[:number]
+      save
+    end
+
+    def reset!
+      self.gift_card = nil
+      super
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+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
+    end
+  end
+end

data/app/models/workarea/search/admin/payment_gift_card.rb

@@ -0,0 +1,46 @@
+module Workarea
+  module Search
+    class Admin
+      class PaymentGiftCard < Search::Admin
+        def type
+          'gift_card'
+        end
+
+        def search_text
+          [
+            model.token,
+            model.to,
+            model.from,
+            model.message
+          ].join ' '
+        end
+
+        def jump_to_text
+          "#{model.token} - balance: #{model.balance}"
+        end
+
+        def status
+          if model.balance.zero?
+            'redeemed'
+          elsif model.used > 0
+            'partially_redeemed'
+          else
+            'unredeemed'
+          end
+        end
+
+        def created_by
+          if model.order_id.present?
+            'order'
+          else
+            'admin'
+          end
+        end
+
+        def facets
+          super.merge(created_by: created_by)
+        end
+      end
+    end
+  end
+end

data/app/queries/workarea/admin_redemptions_export.rb

@@ -0,0 +1,84 @@
+# Query class for models to match the API of {Search::Query}.
+#
+# HOLY SHIT THIS HOT MESS SHOULD BE SOLVED DIFFERENTLY AT SOME POINT
+#
+module Workarea
+  class AdminRedemptionsExport
+    include Search::Pagination
+    include GlobalID::Identification
+
+    attr_reader :params, :gift_cards_query_id
+    alias_method :id, :gift_cards_query_id
+
+    def self.find(id)
+      new(gift_cards_query_id: id)
+    end
+
+    def initialize(params = {})
+      @params = params.with_indifferent_access
+      @gift_cards_query_id = params[:gift_cards_query_id]
+    end
+
+    def results
+      @results ||= PagedArray.new(
+        redemptions_for(gift_card_ids).to_a,
+        page,
+        per_page,
+        gift_cards_query.total # ensure correct paginating
+      )
+    end
+
+    def scroll(options = {}, &block) # to match Search::Query method arguments
+      results.total_pages.times do |page|
+        query = self.class.new(params.merge(page: page + 1))
+        yield query.results
+      end
+    end
+
+    def total
+      @total ||= begin
+        result = 0
+
+        gift_cards_query.results.total_pages.times do |page|
+          page_params = gift_cards_query.params.merge(page: page + 1)
+          page_query = gift_cards_query.class.new(page_params)
+          page_query.define_singleton_method(:per_page) { Workarea.config.bulk_action_per_page }
+          result += redemptions_for(page_query.results.map(&:id)).count
+        end
+
+        result
+      end
+    end
+
+    private
+
+    def per_page
+      Workarea.config.bulk_action_per_page
+    end
+
+    def redemptions_for(ids)
+      Payment::GiftCard::Redemption.in(gift_card_id: ids)
+    end
+
+    def gift_cards_page
+      params[:page].present? ? params[:page].to_i : 1
+    end
+
+    def gift_cards_query
+      @gift_cards_query ||= begin
+        result = GlobalID.find(gift_cards_query_id)
+        page_for_query = gift_cards_page
+        result.define_singleton_method(:page) { page_for_query }
+        result
+      end
+    end
+
+    def gift_card_ids
+      gift_cards_query.results.map(&:id) - exclude_gift_card_ids
+    end
+
+    def exclude_gift_card_ids
+      GlobalID::Locator.locate_many(Array.wrap(params[:exclude_ids])).map(&:id)
+    end
+  end
+end

data/app/queries/workarea/order_item_details.decorator

@@ -0,0 +1,11 @@
+module Workarea
+  decorate OrderItemDetails, with: 'gift_cards' do
+    decorated do
+      delegate :gift_card?, to: :product
+    end
+
+    def to_h
+      super.merge(gift_card: gift_card?)
+    end
+  end
+end

data/app/queries/workarea/search/admin_gift_cards.rb

@@ -0,0 +1,20 @@
+module Workarea
+  module Search
+    class AdminGiftCards
+      include Query
+      include AdminIndexSearch
+      include AdminSorting
+      include Pagination
+
+      document Search::Admin
+
+      def initialize(params = {})
+        super(params.merge(type: 'gift_card'))
+      end
+
+      def facets
+        super + [TermsFacet.new(self, 'created_by')]
+      end
+    end
+  end
+end

data/app/seeds/workarea/gift_card_seeds.rb

@@ -0,0 +1,44 @@
+module Workarea
+  class GiftCardSeeds
+    def perform
+      puts 'Adding gift cards...'
+      add_gift_card_product
+    end
+
+    private
+
+    def add_gift_card_product
+      product = Workarea::Catalog::Product.new(
+        id: 'GIFT_CARD',
+        name: 'Gift Card',
+        gift_card: true,
+        digital: true,
+        template: 'gift_card',
+        customizations: 'gift_card',
+        description: Faker::Lorem.paragraph,
+        variants: [
+          { sku: 'GIFT_CARD_10' },
+          { sku: 'GIFT_CARD_25' },
+          { sku: 'GIFT_CARD_50' }
+        ]
+      )
+
+      product.save!
+
+      Workarea::Pricing::Sku.find_or_create_by(
+        id: 'GIFT_CARD_10',
+        prices: [{ regular: 10 }]
+      )
+
+      Workarea::Pricing::Sku.find_or_create_by(
+        id: 'GIFT_CARD_25',
+        prices: [{ regular: 25 }]
+      )
+
+      Workarea::Pricing::Sku.find_or_create_by(
+        id: 'GIFT_CARD_50',
+        prices: [{ regular: 50 }]
+      )
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Workarea
+  class Checkout
+    module Steps
+      class GiftCard < Base
+        # Updates the checkout to use a gift card as one of
+        # its tenders.
+        #
+        # Sets pricing and reconciles tenders so the checkout
+        # can know whether we need more payment.
+        #
+        # @param [Hash] params
+        # @option params [String] :gift_card_number The gift card number to apply
+        #
+        # @return [Boolean] whether the update succeeded (payment were saved)
+        #
+        def update(params = {})
+          return false unless params[:gift_card_number].present?
+          gift_card_number = params[:gift_card_number].to_s.gsub(/\s+/, '')
+
+          return false unless valid_number?(gift_card_number)
+          payment.set_gift_card(number: gift_card_number)
+
+          Pricing.perform(order, shippings)
+          payment.adjust_tender_amounts(order.total_price)
+        end
+
+        # Whether this update to use a gift card succeeded.
+        # If true, this was no gift card or a valid gift card applied,
+        # false means the gift card number was invalid or expired.
+        #
+        # @return [Boolean]
+        #
+        def complete?
+          !payment.gift_card? || (
+            payment.gift_card.valid? &&
+            valid_number?(payment.gift_card.number)
+          )
+        end
+
+        private
+
+        def valid_number?(number)
+          return false unless number.present?
+          Workarea::Payment::GiftCard.find_balance(number) > 0
+        end
+      end
+    end
+  end
+end

data/app/view_models/workarea/admin/payment_gift_card_view_model.rb

@@ -0,0 +1,11 @@
+module Workarea
+  module Admin
+    class PaymentGiftCardViewModel < ApplicationViewModel
+      include CommentableViewModel
+
+      def timeline
+        @timeline ||= TimelineViewModel.new(model)
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/checkout/payment_view_model.decorator

@@ -0,0 +1,32 @@
+module Workarea
+  decorate Storefront::Checkout::PaymentViewModel, with: 'gift_cards' do
+    # Whether or not to show current gift card information.
+    # True if the current payment is a valid gift card.
+    #
+    # @return [Boolean]
+    #
+    def show_gift_card?
+      payment.gift_card?
+    end
+
+    # Can the current gift card cover the entire order
+    # total? Used for rendering gift card messaging.
+    #
+    # @return [Boolean]
+    #
+    def order_covered_by_gift_card?
+      gift_card_balance >= total_after_store_credit
+    end
+
+    # Can store credit or gift card cover the entire
+    # order total? Override this method in order to prevent
+    # a default credit card from being selected if
+    # not necessary to complete the order.
+    #
+    # @return [Boolean]
+    #
+    def order_covered_by_advance_payments?
+      super || order_covered_by_gift_card?
+    end
+  end
+end

data/app/view_models/workarea/storefront/checkout/summary_view_model.decorator

@@ -0,0 +1,11 @@
+module Workarea
+  decorate Storefront::Checkout::SummaryViewModel, with: 'gift_cards' do
+    # Whether this checkout is using a gift card.
+    #
+    # @return [Boolean]
+    #
+    def gift_card?
+      gift_card_amount > 0
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+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
+        )
+      end
+
+      def gift_card_balance
+        if gift_card.present?
+          gift_card.balance
+        else
+          0.to_m
+        end
+      end
+
+      def gift_card_amount
+        if gift_card_balance > total_after_store_credit
+          total_after_store_credit
+        else
+          gift_card_balance
+        end
+      end
+
+      def total_after_store_credit
+        order.total_price - store_credit_amount
+      end
+
+      def order_balance
+        super - gift_card_amount
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+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
+
+    def paid_amount
+      super - gift_card_tender_amount
+    end
+  end
+end

data/app/view_models/workarea/storefront/product_templates/gift_card_view_model.rb

@@ -0,0 +1,4 @@
+module Workarea
+  class Storefront::ProductTemplates::GiftCardViewModel < Storefront::ProductViewModel
+  end
+end

data/app/views/workarea/admin/activities/_payment_gift_card_create.html.haml

@@ -0,0 +1,12 @@
+.activity
+  .activity__header
+    .activity__avatar
+      = link_to_modifier(entry) do
+        = avatar_for entry.modifier
+    %h3.activity__name= link_to_modifier(entry)
+    %p.activity__time= activity_time(entry.created_at)
+  .activity__message
+    - if entry.audited.present?
+      = t('workarea.admin.activities.payment_gift_card_create_html', name: link_to(entry.audited.name, payment_gift_card_path(entry.audited)))
+    - else
+      = t('workarea.admin.activities.payment_gift_card_create_html', name: t('workarea.payment_gift_card.name', token: entry.token))

data/app/views/workarea/admin/activities/_payment_gift_card_destroy.html.haml

@@ -0,0 +1,10 @@
+.activity
+  .activity__header
+    .activity__avatar
+      = link_to_modifier(entry) do
+        = avatar_for entry.modifier
+    %h3.activity__name= link_to_modifier(entry)
+    %p.activity__time= activity_time(entry.created_at)
+  .activity__message
+    = t('workarea.admin.activities.payment_gift_card_destroy_html')
+    = link_to_restore_for(entry)

data/app/views/workarea/admin/activities/_payment_gift_card_update.html.haml

@@ -0,0 +1,14 @@
+.activity
+  .activity__header
+    .activity__avatar
+      = link_to_modifier(entry) do
+        = avatar_for entry.modifier
+    %h3.activity__name= link_to_modifier(entry)
+    %p.activity__time= activity_time(entry.created_at)
+  .activity__message
+    - if entry.audited.blank?
+      - name = t('workarea.payment_gift_card.name', token: entry.token)
+    - else
+      - name = link_to(entry.audited.name, payment_gift_card_path(entry.audited))
+
+    = t('workarea.admin.activities.payment_gift_card_update_html', fields: fields_clause_for(entry.tracked_changes), name: name)

data/app/views/workarea/admin/orders/tenders/_gift_card.html.haml

@@ -0,0 +1,5 @@
+%li
+  = inline_svg('workarea/admin/payment_icons/gift_card.svg', title: t('workarea.admin.orders.tenders.gift_card.title'), class: 'payment-icon')
+  = t('workarea.admin.orders.tenders.gift_card.title')
+  = tender.display_number
+  = number_to_currency tender.amount

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

@@ -0,0 +1,4 @@
+- if model.order_id
+  .grid.grid--auto.grid--right.grid--middle
+    .grid__cell
+      = link_to t('workarea.admin.payment_gift_cards.view_order'), order_path(model.order_id)

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

@@ -0,0 +1,74 @@
+.grid.grid--auto.grid--flush.grid--center
+  .grid__cell
+    .card{ class: card_classes(:attributes, local_assigns[:active]) }
+      = link_to edit_payment_gift_card_path(model), class: 'card__header' do
+        %span.card__header-text= t('workarea.admin.cards.attributes.title')
+        = inline_svg 'workarea/admin/icons/attributes.svg', class: 'card__icon'
+
+      - if local_assigns[:active].blank?
+        .card__body
+          %ul.list-reset
+            %li
+              %strong #{t('workarea.admin.fields.token')}:
+              = model.token
+            %li
+              %strong #{t('workarea.admin.fields.amount')}:
+              = number_to_currency model.amount
+            %li
+              %strong #{t('workarea.admin.fields.order_id')}:
+              = model.order_id.presence || t('workarea.admin.cards.attributes.no_value')
+            %li
+              %strong #{t('workarea.admin.fields.recipient')}:
+              = model.to
+            %li
+              %strong #{t('workarea.admin.fields.from')}:
+              = model.from.presence || t('workarea.admin.cards.attributes.no_value')
+            %li
+              %strong #{t('workarea.admin.fields.message')}:
+              = model.message.presence || t('workarea.admin.cards.attributes.no_value')
+            %li
+              %strong #{t('workarea.admin.fields.notify')}:
+              = model.notify ? t('workarea.admin.true') : t('workarea.admin.false')
+            %li
+              %strong #{t('workarea.admin.fields.expires_at')}:
+              - if model.expires_at.present?
+                = local_time_ago(model.expires_at)
+              - else
+                = t('workarea.admin.cards.attributes.no_value')
+            %li
+              %strong= t('workarea.admin.fields.updated_at')
+              #{local_time_ago(model.updated_at)}
+            %li
+              %strong= t('workarea.admin.fields.created_at')
+              #{local_time_ago(model.created_at)}
+
+          = link_to edit_payment_gift_card_path(model), class: 'card__button' do
+            %span.button.button--small= t('workarea.admin.cards.attributes.button')
+
+  .grid__cell
+    .card{ class: card_classes(:redemptions, local_assigns[:active]) }
+      = link_to payment_gift_card_redemptions_path(model), class: 'card__header' do
+        %span.card__header-text= t('workarea.admin.payment_gift_cards.cards.redemptions.title')
+        = inline_svg 'workarea/admin/icons/prices.svg', class: 'card__icon'
+
+      - if local_assigns[:active].blank?
+        .card__body
+          - if model.redemptions.empty?
+            %p= t('workarea.admin.payment_gift_cards.cards.redemptions.empty')
+          - else
+            %ul.list-reset
+              - model.redemptions.take(10).each do |redemption|
+                %li
+                  %strong= redemption.order_id
+                  = number_to_currency redemption.amount
+                  #{local_time_ago(redemption.redeemed_at)}
+              - if model.redemptions.size > 10
+                %li= t('workarea.admin.cards.more', amount: model.redemptions.size - 10)
+            = link_to payment_gift_card_redemptions_path(model), class: 'card__button' do
+              %span.button.button--small= t('workarea.admin.payment_gift_cards.cards.redemptions.button')
+
+  .grid__cell
+    = render 'workarea/admin/timeline/card', timeline: model.timeline, active: local_assigns[:active]
+
+  .grid__cell
+    = render 'workarea/admin/comments/card', commentable: model, active: local_assigns[:active]

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

@@ -0,0 +1 @@
+%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/admin/payment_gift_cards/_summary.html.haml

@@ -0,0 +1,11 @@
+.summary{ data: { global_id: model.to_global_id.to_param } }
+  = link_to payment_gift_card_path(model, return_to: params[:return_to]) do
+    %span.summary__name= model.name
+    .summary__info-container
+      %span.summary__info= local_time_ago(model.updated_at)
+      %span.summary__info= number_to_currency model.amount
+    %span.summary__type= t('workarea.admin.payment_gift_cards.gift_card')
+
+  .summary__checkbox.hidden
+    = check_box_tag 'product_id', model.to_global_id.to_param, false, class: 'summary__checkbox-input', id: dom_id(model)
+    = label_tag dom_id(model), t('workarea.admin.bulk_actions.add_summary_button'), class: 'summary__checkbox-label'

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

@@ -0,0 +1,37 @@
+- @page_title = t('workarea.admin.payment_gift_cards.edit.title', name: @gift_card.name)
+
+.view
+  .view__header
+    .grid.grid--middle
+      .grid__cell.grid__cell--25
+        = render 'workarea/admin/releases/select'
+      .grid__cell.grid__cell--50
+        .view__heading
+          = link_to_index_for(@gift_card)
+          %h1= link_to @gift_card.name, url_for(@gift_card)
+      .grid__cell.grid__cell--25
+        = render_aux_navigation_for(@gift_card)
+
+  .view__container
+    = render_cards_for(@gift_card, :attributes)
+
+  .view__container.view__container--narrow
+    - if @gift_card.errors.present?
+      - @gift_card.errors.full_messages.each do |message|
+        = render_message 'error', message
+
+    = form_tag payment_gift_card_path(@gift_card), method: 'patch', id: 'payment_gift_card_form' do
+      = hidden_field_tag 'return_to', request.referrer
+
+      .section
+        .property
+          = label_tag 'gift_card[to]', t('workarea.admin.fields.recipient'), class: 'property__name'
+          = email_field_tag 'gift_card[to]', @gift_card.to, class: 'text-box'
+
+        .property
+          = label_tag 'gift_card[expires_at]', t('workarea.admin.fields.expires_on'), class: 'property__name'
+          = datetime_picker_tag 'gift_card[expires_at]', @gift_card.expires_at, class: 'text-box', data: { datepicker_field: { inline: false } }
+
+      .workflow-bar
+        .grid.grid--auto.grid--right.grid--middle
+          .grid__cell= button_tag t('workarea.admin.payment_gift_cards.edit.button'), value: 'save_gift_card', class: 'workflow-bar__button workflow-bar__button--create'