workarea-gift_cards 3.4.11 → 4.0.0.beta.1

data/app/controllers/workarea/api/admin/gift_cards_controller.rb

@@ -0,0 +1,309 @@
+module Workarea
+  if Plugin.installed?(:api)
+    module Api
+      module Admin
+        class GiftCardsController < Admin::ApplicationController
+          before_action :find_gift_card, except: [:index, :create, :bulk]
+
+          swagger_path '/gift_cards' do
+            operation :get do
+              key :summary, 'All Gift cards'
+              key :description, 'Returns all gift cards from the system'
+              key :operationId, 'listGiftCards'
+              key :produces, ['application/json']
+
+              parameter do
+                key :name, :page
+                key :in, :query
+                key :description, 'Current page'
+                key :required, false
+                key :type, :integer
+                key :default, 1
+              end
+              parameter do
+                key :name, :sort_by
+                key :in, :query
+                key :description, 'Field on which to sort (see responses for possible values)'
+                key :required, false
+                key :type, :string
+                key :default, 'created_at'
+              end
+              parameter do
+                key :name, :sort_direction
+                key :in, :query
+                key :description, 'Direction for sort by'
+                key :type, :string
+                key :enum, %w(asc desc)
+                key :default, 'desc'
+              end
+
+              response 200 do
+                key :description, 'Gift cards'
+                schema do
+                  key :type, :object
+                  property :gift_cards do
+                    key :type, :array
+                    items do
+                      key :'$ref', 'Workarea::Payment::GiftCard'
+                    end
+                  end
+                end
+              end
+            end
+
+            operation :post do
+              key :summary, 'Create GiftCard'
+              key :description, 'Creates a new gift_card.'
+              key :operationId, 'addGiftCard'
+              key :produces, ['application/json']
+
+              parameter do
+                key :name, :body
+                key :in, :body
+                key :description, 'GiftCard to add'
+                key :required, true
+                schema do
+                  key :type, :object
+                  property :gift_card do
+                    key :'$ref', 'Workarea::Payment::GiftCard'
+                  end
+                end
+              end
+
+              response 201 do
+                key :description, 'Gift card created'
+                schema do
+                  key :type, :object
+                  property :gift_card do
+                    key :'$ref', 'Workarea::Payment::GiftCard'
+                  end
+                end
+              end
+
+              response 422 do
+                key :description, 'Validation failure'
+                schema do
+                  key :type, :object
+                  property :problem do
+                    key :type, :string
+                  end
+                  property :document do
+                    key :'$ref', 'Workarea::Payment::GiftCard'
+                  end
+                end
+              end
+            end
+          end
+
+          def index
+            @gift_cards = Payment::GiftCard
+                          .all
+                          .order_by(sort_field => sort_direction)
+                          .page(params[:page])
+
+            respond_with gift_cards: @gift_cards
+          end
+
+          def create
+            @gift_card = Payment::GiftCard.create!(params[:gift_card])
+            respond_with(
+              { gift_card: @gift_card },
+              {
+                status: :created,
+                location: gift_card_path(@gift_card)
+              }
+            )
+          end
+
+          swagger_path '/gift_cards/{id}' do
+            operation :get do
+              key :summary, 'Find Gift card by ID'
+              key :description, 'Returns a single gift card'
+              key :operationId, 'showGiftCard'
+
+              parameter do
+                key :name, :id
+                key :in, :path
+                key :description, 'ID of gift card to fetch'
+                key :required, true
+                key :type, :string
+              end
+
+              response 200 do
+                key :description, 'Gift card details'
+                schema do
+                  key :type, :object
+                  property :gift_card do
+                    key :'$ref', 'Workarea::Payment::GiftCard'
+                  end
+                end
+              end
+
+              response 404 do
+                key :description, 'Gift card not found'
+                schema do
+                  key :type, :object
+                  property :problem do
+                    key :type, :string
+                  end
+                  property :params do
+                    key :type, :object
+                    key :additionalProperties, true
+                  end
+                end
+              end
+            end
+
+            operation :patch do
+              key :summary, 'Update a GiftCard'
+              key :description, 'Updates attributes on a gift card'
+              key :operationId, 'updateGiftCard'
+
+              parameter do
+                key :name, :id
+                key :in, :path
+                key :description, 'ID of gift card to update'
+                key :required, true
+                key :type, :string
+              end
+
+              parameter do
+                key :name, :body
+                key :in, :body
+                key :required, true
+                schema do
+                  key :type, :object
+                  property :gift_card do
+                    key :description, 'New attributes'
+                    key :'$ref', 'Workarea::Payment::GiftCard'
+                  end
+                end
+              end
+
+              response 204 do
+                key :description, 'Gift card updated successfully'
+              end
+
+              response 422 do
+                key :description, 'Validation failure'
+                schema do
+                  key :type, :object
+                  property :problem do
+                    key :type, :string
+                  end
+                  property :document do
+                    key :'$ref', 'Workarea::Payment::GiftCard'
+                  end
+                end
+              end
+
+              response 404 do
+                key :description, 'Gift card not found'
+                schema do
+                  key :type, :object
+                  property :problem do
+                    key :type, :string
+                  end
+                  property :params do
+                    key :type, :object
+                    key :additionalProperties, true
+                  end
+                end
+              end
+            end
+
+            operation :delete do
+              key :summary, 'Remove a Gift card'
+              key :description, 'Remove a gift card'
+              key :operationId, 'removeGiftCard'
+
+              parameter do
+                key :name, :id
+                key :in, :path
+                key :description, 'ID of gift card to remove'
+                key :required, true
+                key :type, :string
+              end
+
+              response 204 do
+                key :description, 'Gift card removed successfully'
+              end
+
+              response 404 do
+                key :description, 'Gift card not found'
+                schema do
+                  key :type, :object
+                  property :problem do
+                    key :type, :string
+                  end
+                  property :params do
+                    key :type, :object
+                    key :additionalProperties, true
+                  end
+                end
+              end
+            end
+          end
+
+          def show
+            respond_with gift_card: @gift_card
+          end
+
+          def update
+            @gift_card.update_attributes!(params[:gift_card])
+            respond_with gift_card: @gift_card
+          end
+
+          def destroy
+            @gift_card.destroy
+            head :no_content
+          end
+
+          swagger_path '/gift_cards/bulk' do
+            operation :patch do
+              key :summary, 'Bulk Upsert Gift cards'
+              key :description, 'Creates new gift cards or updates existing ones in bulk.'
+              key :operationId, 'upsertGiftCards'
+              key :produces, ['application/json']
+
+              parameter do
+                key :name, :body
+                key :in, :body
+                key :description, 'Array of gift cards to upsert'
+                key :required, true
+                schema do
+                  key :type, :object
+                  property :gift_cards do
+                    key :type, :array
+                    items do
+                      key :'$ref', 'Workarea::Payment::GiftCard'
+                    end
+                  end
+                end
+              end
+
+              response 204 do
+                key :description, 'Upsert received'
+              end
+            end
+          end
+
+          def bulk
+            @bulk = Api::Admin::BulkUpsert.create!(
+              klass: Payment::GiftCard,
+              data: params[:gift_cards].map(&:to_h)
+            )
+
+            head :no_content
+          end
+
+          private
+
+          def find_gift_card
+            @gift_card = Payment::GiftCard.find(params[:id])
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/workarea/api/storefront/checkouts_controller.decorator

@@ -5,6 +5,12 @@ module Workarea
         Checkout::Steps::GiftCard.new(current_checkout).update(params)
         render_checkout
       end
+
+      def remove_gift_card
+        step = Checkout::Steps::GiftCard.new(current_checkout)
+        step.remove(params[:gift_card_id])
+        render_checkout
+      end
     end
   end
 end

data/app/controllers/workarea/api/storefront/gift_cards_controller.rb

@@ -4,18 +4,12 @@ module Workarea
       module Storefront
         class GiftCardsController < Api::Storefront::ApplicationController
           def balance
-            email = params.fetch(:email, nil)
-            token = params.fetch(:token, nil)
-
-            if email.present? && token.present?
-              @gift_card = Payment::GiftCard.find_by_token_and_email(token, email)
-            end
+            @gift_card = Workarea::GiftCards.gateway.lookup(params)
 
             if @gift_card.blank?
               raise Mongoid::Errors::DocumentNotFound.new(
                 Payment::GiftCard,
-                email: email,
-                token: token
+                params.to_unsafe_h.except('controller', 'action')
               )
             end
           end

data/app/controllers/workarea/storefront/checkout/gift_cards_controller.rb

@@ -0,0 +1,32 @@
+module Workarea
+  module Storefront
+    module Checkout
+      class GiftCardsController < CheckoutsController
+        def add
+          step = Workarea::Checkout::Steps::GiftCard.new(current_checkout)
+
+          if step.update(params)
+            flash[:success] = t('workarea.storefront.flash_messages.gift_card_added')
+            redirect_to checkout_payment_path
+          else
+            @step = Storefront::Checkout::PaymentViewModel.new(
+              step,
+              view_model_options
+            )
+
+            flash[:error] = t('workarea.storefront.flash_messages.gift_card_error')
+            render :payment
+          end
+        end
+
+        def remove
+          step = Workarea::Checkout::Steps::GiftCard.new(current_checkout)
+          step.remove(params[:gift_card_id])
+
+          flash[:success] = t('workarea.storefront.flash_messages.gift_card_removed')
+          redirect_to checkout_payment_path
+        end
+      end
+    end
+  end
+end

data/app/controllers/workarea/storefront/gift_cards_controller.rb

@@ -1,24 +1,23 @@
 module Workarea
-  class Storefront::GiftCardsController < Storefront::ApplicationController
-    def index
-    end
+  module Storefront
+    class GiftCardsController < ApplicationController
+      def index
+      end
 
-    def lookup
-      email = params.fetch(:email, nil)
-      token = params.fetch(:token, nil)
+      def lookup
+        gift_card = Workarea::GiftCards.gateway.lookup(params)
 
-      if email.present? && token.present?
-        @gift_card = Workarea::Payment::GiftCard
-                     .find_by_token_and_email(token, email)
-      end
+        if gift_card.present?
+          flash[:success] = t(
+            'workarea.storefront.flash_messages.gift_card_balance',
+            balance: gift_card.balance.format
+          )
+        else
+          flash[:error] = t('workarea.storefront.flash_messages.gift_card_not_found')
+        end
 
-      if @gift_card.present?
-        flash[:success] = "Your balance is #{@gift_card.balance.format}"
-      else
-        flash[:error] = 'Invalid card number or email.'
+        redirect_to gift_cards_balance_path
       end
-
-      redirect_to gift_cards_balance_path
     end
   end
 end

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

@@ -0,0 +1,71 @@
+module Workarea
+  class Checkout
+    module Steps
+      class GiftCard < Base
+        # Add a gift card tender to the order, updates pricing and adjusts the
+        # tender amounts for all existing tenders.
+        #
+        # @param [Hash] params
+        # @option params [String] :gift_card_number a gift card number to apply
+        #
+        # @return [Boolean] whether the update succeeded (payment were saved)
+        #
+        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)
+          update_order
+        end
+
+        # Removes a gift card from payment, updates order pricing and readjusts
+        # tender amounts.
+        #
+        # @param [String] id the gift card tender id
+        #
+        # @return [Boolean] whether the update succeeded (payment was saved)
+        #
+        def remove(id)
+          payment.gift_cards.find(id).destroy
+        rescue Mongoid::Errors::DocumentNotFound
+          # no op
+        ensure
+          update_order
+        end
+
+        # Whether this step of checkout is considered complete. Requires either
+        # no gift cards applied, or that all gift cards are valid with a
+        # balance. No balance could mean a card is expired, or has been used.
+        #
+        # @return [Boolean]
+        #
+        def complete?
+          !payment.gift_card? ||
+            (
+              payment.gift_cards.all?(&:valid?) &&
+              payment.gift_cards.none? { |g| g.balance.zero? }
+            )
+        end
+
+        private
+
+        def extract_gift_card_params(params)
+          { number: params[:gift_card_number].to_s.gsub(/\s+/, '') }
+        end
+
+        def applicable_gift_card?(params)
+          return false unless params[:number].present?
+          Workarea::GiftCards.gateway.balance(params[:number]) > 0
+        end
+
+        def add_gift_card(params)
+          payment.add_gift_card(params)
+        end
+
+        def update_order
+          Pricing.perform(order, shippings)
+          payment.adjust_tender_amounts(order.total_price)
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/fulfillment/policies/create_gift_card.rb

@@ -0,0 +1,30 @@
+module Workarea
+  class Fulfillment
+    module Policies
+      class CreateGiftCard < Base
+        def process(order_item:, fulfillment: nil)
+          return unless Workarea::GiftCards.uses_system_cards?
+          return unless order_item.gift_card?
+
+          order_item.quantity.times do
+            Payment::GiftCard.create!(
+              amount: order_item.original_unit_price,
+              order_id: order_item.order.id,
+              to: order_item.customizations['email'],
+              from: order_item.customizations['from'],
+              message: order_item.customizations['message'],
+              notify: true,
+              purchased: true
+            )
+          end
+
+          return unless fulfillment.present?
+          fulfillment.mark_item_shipped(
+            id: order_item.id.to_s,
+            quantity: order_item.quantity
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -3,38 +3,25 @@ module Workarea
     module Authorize
       class GiftCard
         include OperationImplementation
+        include GiftCardOperation
 
         def complete!
-          Payment::GiftCard.purchase(tender.number, transaction.amount.cents)
+          response = gateway.authorize(transaction.amount.cents, tender)
 
           transaction.response = ActiveMerchant::Billing::Response.new(
-            true,
-            I18n.t(
-              'workarea.gift_cards.debit',
-              amount: transaction.amount,
-              number: tender.number
-            )
-          )
-
-        rescue Payment::InsufficientFunds
-          transaction.response = ActiveMerchant::Billing::Response.new(
-            false,
-            I18n.t('workarea.gift_cards.insufficient_funds')
+            response.success?,
+            response.message
           )
         end
 
         def cancel!
           return unless transaction.success?
 
-          Payment::GiftCard.refund(tender.number, transaction.amount.cents)
+          response = gateway.cancel(transaction.amount.cents, tender)
 
           transaction.cancellation = ActiveMerchant::Billing::Response.new(
-            true,
-            I18n.t(
-              'workarea.gift_cards.credit',
-              amount: transaction.amount,
-              number: tender.number
-            )
+            response.success?,
+            response.message
           )
         end
       end

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

@@ -3,21 +3,19 @@ module Workarea
     class Capture
       class GiftCard
         include OperationImplementation
+        include GiftCardOperation
 
         def complete!
-          # noop, authorization does the capture
+          response = gateway.capture(transaction.amount.cents, tender)
+
           transaction.response = ActiveMerchant::Billing::Response.new(
-            true,
-            I18n.t('workarea.gift_cards.capture')
+            response.success?,
+            response.message
           )
         end
 
         def cancel!
           # noop, nothing to cancel
-          transaction.response = ActiveMerchant::Billing::Response.new(
-            true,
-            I18n.t('workarea.gift_cards.capture')
-          )
         end
       end
     end

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

@@ -28,7 +28,7 @@ module Workarea
       index(expires_at: 1)
       index(created_at: 1)
 
-      alias number token
+      alias_method :number, :token
 
       validates :token, presence: true
       validates :amount, presence: true

data/app/models/workarea/payment/gift_card_operation.rb

@@ -0,0 +1,9 @@
+module Workarea
+  class Payment
+    module GiftCardOperation
+      def gateway
+        Workarea::GiftCards.gateway
+      end
+    end
+  end
+end

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

@@ -1,7 +1,30 @@
 module Workarea
   class Payment
     module Purchase
-      GiftCard = Authorize::GiftCard
+      class GiftCard
+        include OperationImplementation
+        include GiftCardOperation
+
+        def complete!
+          response = gateway.purchase(transaction.amount.cents, tender)
+
+          transaction.response = ActiveMerchant::Billing::Response.new(
+            response.success?,
+            response.message
+          )
+        end
+
+        def cancel!
+          return unless transaction.success?
+
+          response = gateway.refund(transaction.amount.cents, tender)
+
+          transaction.cancellation = ActiveMerchant::Billing::Response.new(
+            response.success?,
+            response.message
+          )
+        end
+      end
     end
   end
 end

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

@@ -3,30 +3,25 @@ module Workarea
     class Refund
       class GiftCard
         include OperationImplementation
+        include GiftCardOperation
 
         def complete!
-          Payment::GiftCard.refund(tender.number, transaction.amount.cents)
+          response = gateway.refund(transaction.amount.cents, tender)
+
           transaction.response = ActiveMerchant::Billing::Response.new(
-            true,
-            I18n.t(
-              'workarea.gift_cards.credit',
-              amount: transaction.amount,
-              number: tender.number
-            )
+            response.success?,
+            response.message
           )
         end
 
         def cancel!
           return unless transaction.success?
 
-          Payment::GiftCard.purchase(tender.number, transaction.amount.cents)
+          response = gateway.purchase(transaction.amount.cents, tender)
+
           transaction.cancellation = ActiveMerchant::Billing::Response.new(
-            true,
-            I18n.t(
-              'workarea.gift_cards.debit',
-              amount: transaction.amount,
-              number: tender.number
-            )
+            response.success?,
+            response.message
           )
         end
       end