workarea-gift_cards 3.4.6

data/Rakefile

@@ -0,0 +1,53 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tasker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/gift_cards/version'
+
+desc "Release version #{Workarea::GiftCards::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
+
+  system "git tag -a v#{Workarea::GiftCards::VERSION} -m 'Tagging #{Workarea::GiftCards::VERSION}'"
+  system 'git push --tags'
+
+  system 'gem build workarea-gift_cards.gemspec'
+  system "gem push workarea-gift_cards-#{Workarea::GiftCards::VERSION}.gem"
+  system "gem push workarea-gift_cards-#{Workarea::GiftCards::VERSION}.gem --host #{host}"
+  system "rm workarea-gift_cards-#{Workarea::GiftCards::VERSION}.gem"
+end

data/app/assets/images/workarea/admin/payment_icons/gift_card.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="-243 353.9 125 85.3" enable-background="new -243 353.9 125 85.3"><path d="m-229.7 402h-13.3v-37.6c0-5.8 4.7-10.5 10.5-10.5h24v34c-.2-.2-.3-.4-.5-.6-6.4-6.5-15.6-7.7-20.6-2.7-4.3 4.1-4.1 11.3-.1 17.4m9.8 29.9l-10.9-11.5 5.1-4.6h-17.4v12.9c0 5.8 4.7 10.5 10.5 10.5h24v-17.9l-11.3 10.6zm26.3-44.6c6.4-6.5 15.6-7.7 20.6-2.7 4.2 4.2 4.1 11.4.1 17.4h54.9v-37.6c0-5.8-4.7-10.5-10.5-10.5h-65.6v34c.2-.3.3-.4.5-.6m21.7 33.7l-11.5 10.9-10.7-11.3v18.6h65.6c5.8 0 10.5-4.7 10.5-10.5v-12.9h-59.1l5.2 5.2zm-18.5-28.1c-3.3 3.3-3.9 13.2-3.9 13.2s9.9-.7 13.2-4c3.3-3.3 3.9-8 1.3-10.6-2.6-2.5-7.3-1.9-10.6 1.4m-32.4-1.4c-2.6 2.5-2 7.3 1.3 10.6 3.3 3.3 13.2 4 13.2 4s-.6-9.9-3.9-13.2c-3.3-3.3-8-3.9-10.6-1.4"/></svg>

data/app/assets/images/workarea/storefront/payment_icons/gift_card.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="-243 353.9 125 85.3" enable-background="new -243 353.9 125 85.3"><path d="m-229.7 402h-13.3v-37.6c0-5.8 4.7-10.5 10.5-10.5h24v34c-.2-.2-.3-.4-.5-.6-6.4-6.5-15.6-7.7-20.6-2.7-4.3 4.1-4.1 11.3-.1 17.4m9.8 29.9l-10.9-11.5 5.1-4.6h-17.4v12.9c0 5.8 4.7 10.5 10.5 10.5h24v-17.9l-11.3 10.6zm26.3-44.6c6.4-6.5 15.6-7.7 20.6-2.7 4.2 4.2 4.1 11.4.1 17.4h54.9v-37.6c0-5.8-4.7-10.5-10.5-10.5h-65.6v34c.2-.3.3-.4.5-.6m21.7 33.7l-11.5 10.9-10.7-11.3v18.6h65.6c5.8 0 10.5-4.7 10.5-10.5v-12.9h-59.1l5.2 5.2zm-18.5-28.1c-3.3 3.3-3.9 13.2-3.9 13.2s9.9-.7 13.2-4c3.3-3.3 3.9-8 1.3-10.6-2.6-2.5-7.3-1.9-10.6 1.4m-32.4-1.4c-2.6 2.5-2 7.3 1.3 10.6 3.3 3.3 13.2 4 13.2 4s-.6-9.9-3.9-13.2c-3.3-3.3-8-3.9-10.6-1.4"/></svg>

data/app/controllers/workarea/admin/data_file_exports_controller.decorator

@@ -0,0 +1,28 @@
+module Workarea
+  decorate Admin::DataFileExportsController, with: 'gift_cards' do
+    def set_export
+      super
+
+      if @export.model_class == Workarea::Payment::GiftCard::Redemption
+        convert_export_ids_to_query if @export.ids.present?
+        convert_query_to_redemptions_query
+      end
+    end
+
+    def convert_export_ids_to_query
+      tokens = GlobalID::Locator.locate_many(@export.ids).map(&:token)
+      @export.query_id = Search::AdminGiftCards.new(q: tokens.join(' ')).to_gid_param
+      @export.ids = []
+    end
+
+    def convert_query_to_redemptions_query
+      current_query = GlobalID.find(@export.query_id)
+
+      unless current_query.blank? || current_query.is_a?(AdminRedemptionsExport)
+        @export.query_id = AdminRedemptionsExport
+                            .new(gift_cards_query_id: @export.query_id)
+                            .to_gid_param
+      end
+    end
+  end
+end

data/app/controllers/workarea/admin/payment_gift_cards_controller.rb

@@ -0,0 +1,78 @@
+module Workarea
+  module Admin
+    class PaymentGiftCardsController < Admin::ApplicationController
+      required_permissions :orders
+      before_action :find_gift_card, except: :index
+
+      def index
+        search = Search::AdminGiftCards.new(params)
+        @search = Admin::SearchViewModel.new(search, view_model_options)
+      end
+
+      def show; end
+
+      def new; end
+
+      def create
+        if @gift_card.save
+          flash[:success] = 'Gift card has been created.'
+          redirect_to payment_gift_card_path(@gift_card)
+        else
+          render :new
+        end
+      end
+
+      def edit; end
+
+      def update
+        if @gift_card.update_attributes(gift_card_params)
+          flash[:success] = 'Gift card has been saved.'
+          redirect_to payment_gift_card_path(@gift_card)
+        else
+          render :edit
+        end
+      end
+
+      def destroy
+        @gift_card.destroy
+        flash[:success] = "Gift card #{@gift_card.token} has been removed."
+        redirect_to payment_gift_cards_path
+      end
+
+      def redemptions
+      end
+
+      private
+
+      def find_gift_card
+        gift_card =
+          if params[:id].present?
+            Payment::GiftCard.find(params[:id])
+          elsif params[:payment_gift_card_id].present?
+            Payment::GiftCard.find(params[:payment_gift_card_id])
+          else
+            Payment::GiftCard.new(gift_card_params)
+          end
+
+        @gift_card =
+          Admin::PaymentGiftCardViewModel.new(
+            gift_card,
+            view_model_options
+          )
+      end
+
+      def gift_card_params
+        return {} if params[:gift_card].blank?
+        params[:gift_card].permit(
+          :token,
+          :to,
+          :from,
+          :message,
+          :expires_at,
+          :amount,
+          :notify
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Workarea
+  if Plugin.installed?(:api)
+    module Api
+      module Admin
+        class PaymentGiftCardsController < Admin::ApplicationController
+          before_action :find_gift_card, except: [:index, :create]
+
+          def index
+            @gift_cards = Payment::GiftCard
+                          .all
+                          .order_by(sort_field => sort_direction)
+                          .page(params[:page])
+
+            respond_with gift_cards: @gift_cards
+          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 create
+            @gift_card = Payment::GiftCard.create!(params[:gift_card])
+            respond_with(
+              { gift_card: @gift_card },
+              { status: :created,
+              location: payment_gift_card_path(@gift_card) }
+            )
+          end
+
+          def destroy
+            @gift_card.destroy
+            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

@@ -0,0 +1,10 @@
+module Workarea
+  if Plugin.installed?(:api)
+    decorate Api::Storefront::CheckoutsController, with: 'gift_cards' do
+      def add_gift_card
+        Checkout::Steps::GiftCard.new(current_checkout).update(params)
+        render_checkout
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Workarea
+  if Plugin.installed?(:api)
+    module Api
+      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
+
+            if @gift_card.blank?
+              raise Mongoid::Errors::DocumentNotFound.new(
+                Payment::GiftCard,
+                email: email,
+                token: token
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Workarea
+  decorate Storefront::CheckoutsController, with: 'gift_cards' do
+    def add_gift_card
+      step = Checkout::Steps::GiftCard.new(current_checkout)
+
+      if step.update(params)
+        flash[:success] = 'Your gift card has been applied.'
+        redirect_to checkout_payment_path
+      else
+        flash[:error] = <<-string
+          We couldn't add this gift card number.
+          Please ensure you have entered the correct number.
+        string
+
+        @step = Storefront::Checkout::PaymentViewModel.new(
+          step,
+          view_model_options
+        )
+
+        render :payment
+      end
+    end
+  end
+end

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

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

data/app/mailers/workarea/storefront/gift_card_mailer.rb

@@ -0,0 +1,28 @@
+module Workarea
+  module Storefront
+    class GiftCardMailer < Storefront::ApplicationMailer
+      def created(card_id)
+        @card = Payment::GiftCard.find(card_id)
+        @from = from(@card.from, @card.order_id)
+
+        mail(
+          to: @card.to,
+          from: Workarea.config.email_from,
+          subject: t('workarea.storefront.email.gift_card_created.subject')
+        )
+      end
+
+      private
+
+      def from(card_from, order_id)
+        card_from || card_order_email(order_id) || Workarea.config.email_from
+      end
+
+      def card_order_email(order_id)
+        return unless order_id.present?
+        order = Order.find(order_id)
+        order.email
+      end
+    end
+  end
+end

data/app/models/workarea/catalog/customizations/gift_card.rb

@@ -0,0 +1,9 @@
+class Workarea::Catalog::Customizations::GiftCard < Workarea::Catalog::Customizations
+  customized_fields :email, :from, :message
+
+  validates :email, presence: true,
+                    email:    true
+
+  validates :from, length: { maximum: 100 }
+  validates :message, length: { maximum: 500 }
+end

data/app/models/workarea/catalog/product.decorator

@@ -0,0 +1,11 @@
+module Workarea
+  decorate Catalog::Product, with: 'gift_cards' do
+    decorated do
+      field :gift_card, type: Boolean, default: false
+    end
+
+    def gift_card?
+      super || template == 'gift_card'
+    end
+  end
+end

data/app/models/workarea/order/item.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate Order::Item, with: 'gift_cards' do
+    decorated do
+      field :gift_card, type: Boolean, default: false
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Workarea
+  class Payment
+    module Authorize
+      class GiftCard
+        include OperationImplementation
+
+        def complete!
+          Payment::GiftCard.purchase(tender.number, transaction.amount.cents)
+
+          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')
+          )
+        end
+
+        def cancel!
+          return unless transaction.success?
+
+          Payment::GiftCard.refund(tender.number, transaction.amount.cents)
+
+          transaction.cancellation = ActiveMerchant::Billing::Response.new(
+            true,
+            I18n.t(
+              'workarea.gift_cards.credit',
+              amount: transaction.amount,
+              number: tender.number
+            )
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Workarea
+  class Payment
+    class Capture
+      class GiftCard
+        include OperationImplementation
+
+        def complete!
+          # noop, authorization does the capture
+          transaction.response = ActiveMerchant::Billing::Response.new(
+            true,
+            I18n.t('workarea.gift_cards.capture')
+          )
+        end
+
+        def cancel!
+          # noop, nothing to cancel
+          transaction.response = ActiveMerchant::Billing::Response.new(
+            true,
+            I18n.t('workarea.gift_cards.capture')
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Workarea
+  class Payment
+    class GiftCard
+      class Redemption
+        include ApplicationDocument
+
+        field :redeemed_at, type: DateTime
+        field :order_id, type: String
+
+        field :amount, type: Money
+
+        belongs_to :gift_card, class_name: 'Workarea::Payment::GiftCard'
+
+        validates_presence_of :amount
+        validates_presence_of :redeemed_at
+
+        index(redeemed_at: 1)
+        index(order_id: 1)
+        index(gift_card_id: 1)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,186 @@
+module Workarea
+  class Payment
+    class GiftCard
+      include ApplicationDocument
+      include Commentable
+
+      field :token, type: String
+      field :to, type: String
+      field :from, type: String
+      field :message, type: String
+      field :expires_at, type: DateTime
+      field :notify, type: Boolean
+      field :purchased, type: Boolean
+
+      # Order id if this card was created
+      # by a customer purchasing it.
+      field :order_id, type: String
+
+      field :amount, type: Money, default: 0.to_m
+      field :used, type: Money, default: 0.to_m
+      field :balance, type: Money, default: 0.to_m
+
+      has_many :redemptions, class_name: 'Workarea::Payment::GiftCard::Redemption'
+
+      index({ token: 1 }, { unique: true })
+      index(to: 1)
+      index('balance.cents' => 1)
+      index(expires_at: 1)
+      index(created_at: 1)
+
+      alias number token
+
+      validates :token, presence: true
+      validates :amount, presence: true
+      validates :to, email: true
+
+      scope :not_expired, -> {
+        any_of({ :expires_at.exists => false },
+               { expires_at: nil },
+               { :expires_at.gte => Time.now })
+      }
+
+      before_validation :assign_token
+
+      # Sorts available for this class.
+      #
+      # @return [Array<Workarea::Sort>]
+      #
+      def self.sorts
+        [Workarea::Sort.newest, Workarea::Sort.modified]
+      end
+
+      # Find gift cards whose token or recipient matches the
+      # given string. Used in admin filtering.
+      #
+      # @param [String]
+      # @return [Mongoid::Criteria]
+      #
+      def self.search_by_token_or_recipient(string)
+        regex = /^#{::Regexp.quote(string)}/i
+        any_of({ token: regex }, { to: regex })
+      end
+
+      # Performs purchase of the gift card that matches the given token.
+      # Purchase is for the amount in cents.
+      #
+      # @param [String] token Representing Payment::GiftCard#token
+      # @param [Integer] cents Amount of purchase
+      # @return [Payment::GiftCard]
+      #
+      def self.purchase(token, cents)
+        not_expired.find_by_token(token).purchase(cents)
+      end
+
+      # Performs refund of the gift card that matches the given token.
+      # Refund is for the amount in cents.
+      #
+      # @param [String] token Representing Payment::GiftCard#token
+      # @param [Integer] cents Amount to refund
+      # @return [Payment::GiftCard]
+      #
+      def self.refund(token, cents)
+        find_by_token(token).refund(cents)
+      end
+
+      # Gift card balance for the given token. If the Gift card does
+      # not exist, $0 is returned.
+      #
+      # @param [String] token Representing Payment::GiftCard#token
+      # @return [Money]
+      #
+      def self.find_balance(token)
+        card = not_expired.find_by_token(token)
+        card ? card.balance : 0.to_m
+      end
+
+      def self.find_by_token(token)
+        where(token: token.downcase).first
+      end
+
+      def self.find_by_token_and_email(token, email)
+        where(token: token, to: email.downcase).not_expired.first
+      end
+
+      def to=(val)
+        if val.nil?
+          super(val)
+        else
+          super(val.to_s.downcase)
+        end
+      end
+
+      def valid?(*)
+        super.tap do |result|
+          self.balance = amount if result && !persisted?
+          self.token = token.downcase if token.present?
+        end
+      end
+
+      # This is for compatibility with the admin, all models must implement this
+      #
+      # @return [String]
+      #
+      def name
+        I18n.t('workarea.payment_gift_card.name', token: token)
+      end
+
+      # Whether the gift card has expired.
+      #
+      # @return [Boolean]
+      #
+      def expired?
+        !!(expires_at && Time.now >= expires_at)
+      end
+
+      # The date of the last redemption.
+      #
+      # @return [DateTime]
+      #
+      def last_redeemed_at
+        redemptions.asc(:redeemed_at).last.try(:redeemed_at)
+      end
+
+      # Performs purchase for the amount in cents.
+      #
+      # @param [Integer] cents Amount of purchase
+      # @return [Payment::GiftCard]
+      #
+      # @raise [Payment::InsufficientFunds]
+      #   the balance of the gift card does not cover the cents
+      #
+      def purchase(cents)
+        raise(Workarea::Payment::InsufficientFunds) if balance.cents < cents
+        inc('balance.cents' => 0 - cents, 'used.cents' => cents)
+        self
+      end
+
+      # Performs refund for the amount in cents.
+      #
+      # @param [Integer] cents Amount of purchase
+      # @return [Payment::GiftCard]
+      #
+      def refund(cents)
+        inc('balance.cents' => cents, 'used.cents' => 0 - cents)
+        self
+      end
+
+      def reset_token!
+        update_attribute(:token, generate_token)
+      end
+
+      def generate_token
+        loop do
+          tmp = SecureRandom.hex(Workarea.config.gift_card_token_length / 2).downcase
+          break tmp unless self.class.where(token: tmp).exists?
+        end
+      end
+
+      private
+
+      def assign_token
+        self.token = generate_token if token.blank?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Workarea
+  class Payment
+    module Purchase
+      GiftCard = Authorize::GiftCard
+    end
+  end
+end

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

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