solidus_virtual_gift_card 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ead961e2e91055078cda6622eff9bcb37135679c
-  data.tar.gz: fc2ae98ff7e39233c92aa1ef57e5b88647baec14
+  metadata.gz: d68ab9a6fbe5f3e13073ab38d343df394def740a
+  data.tar.gz: 1ef7434bca9095d79f2889e46232725d85d6aab5
 SHA512:
-  metadata.gz: 70cff66f119830a384728feb0b4a127f4fd86aa59189662d7c93c913e7e3422d9e72a054a89c7b555dbac3d569b49bdbe75d9a38ca30ffeacc82d36653b36ef7
-  data.tar.gz: 95b4b982fdba785b3d6a08a87a1ea8c9a366f2d1fb688dcea8b2f0bd30b9f98334a04e511d556340f625ba91b211dd2497fe3439b905db9dfc79fffb8ecc611a
+  metadata.gz: 7d2212e47e0a8463e009165fa50c4eaa27ec63f4b131c874919c3b479f18454d0012199a6d4034e78c5d161426eade5176d0c41c27a99cd584d72618a81fb371
+  data.tar.gz: 9636919f4bfbb68ff3b34509b952971d113147e47a61de9490a73b1c3c47d326a0e2dce7a60bf26bbc34bb52ed719c1f9b41a50162287a142775b04118235fb1

data/Gemfile

@@ -5,6 +5,7 @@ gem "solidus_auth_devise", "~> 1.0"
 
 group :test, :development do
   gem "pry-byebug"
+  gem 'selenium-webdriver'
 end
 
 gemspec

data/app/assets/javascripts/spree/backend/solidus_virtual_gift_card.coffee

@@ -1,9 +1,9 @@
 window.GiftCards =
-  _bindLookupGiftCard: ->
-    $(document).on('submit', '#lookup-redemption-code', (event) ->
-      event.preventDefault()
-      window.location.href = $(this).attr('action') + '/' + $(this).find('#gift_card_redemption_code').val()
+  setAdminDatepicker: () ->
+    $(document).ready(() ->
+      if $(".giftcard-datepicker").val()
+        $(".giftcard-datepicker").datepicker("setDate", new Date($(".giftcard-datepicker").val().split("-")))
+        $(".giftcard-datepicker").datepicker("option", "minDate", new Date())
     )
 
-  init: ->
-    @_bindLookupGiftCard()
+

data/app/assets/stylesheets/spree/backend/solidus_virtual_gift_card.css

@@ -5,3 +5,7 @@
 .lookup-gift-card-button {
   margin-top: 15px;
 }
+
+.last-email-sent {
+  margin-bottom: 10px;
+}

data/app/controllers/spree/admin/gift_cards_controller.rb

@@ -1,17 +1,30 @@
 class Spree::Admin::GiftCardsController < Spree::Admin::BaseController
-  before_filter :load_gift_card_history, only: [:show]
   before_filter :load_user, only: [:lookup, :redeem]
   before_filter :load_gift_card_for_redemption, only: [:redeem]
+  before_filter :load_gift_card_by_id, only: [:edit, :update, :send_email]
+  before_filter :load_order, only: [:edit, :update]
 
   def index
+    @search = Spree::VirtualGiftCard.purchased.search(params[:q])
+    @gift_cards = @search.result.page(params[:page]).per(params[:per_page])
   end
 
-  def show
+  def edit
   end
 
   def lookup
   end
 
+  def update
+    if @gift_card.update_attributes(gift_card_params)
+      flash[:success] = Spree.t("admin.gift_cards.gift_card_updated")
+      redirect_to edit_admin_order_path(@order)
+    else
+      flash[:error] = @gift_card.errors.full_messages.join(", ")
+      redirect_to :back
+    end
+  end
+
   def redeem
     if @gift_card.redeem(@user)
       flash[:success] = Spree.t("admin.gift_cards.redeemed_gift_card")
@@ -22,18 +35,13 @@ class Spree::Admin::GiftCardsController < Spree::Admin::BaseController
     end
   end
 
-  private
-
-  def load_gift_card_history
-    redemption_code = Spree::RedemptionCodeGenerator.format_redemption_code_for_lookup(params[:id])
-    @gift_cards = Spree::VirtualGiftCard.where(redemption_code: redemption_code)
-
-    if @gift_cards.empty?
-      flash[:error] = Spree.t('admin.gift_cards.errors.not_found')
-      redirect_to(admin_gift_cards_path)
-    end
+  def send_email
+    @gift_card.send_email
+    redirect_to :back
   end
 
+  private
+
   def load_gift_card_for_redemption
     redemption_code = Spree::RedemptionCodeGenerator.format_redemption_code_for_lookup(params[:gift_card][:redemption_code])
     @gift_card = Spree::VirtualGiftCard.active_by_redemption_code(redemption_code)
@@ -44,10 +52,22 @@ class Spree::Admin::GiftCardsController < Spree::Admin::BaseController
     end
   end
 
+  def load_gift_card_by_id
+    @gift_card = Spree::VirtualGiftCard.find_by(id: params[:id])
+  end
+
+  def load_order
+    @order = Spree::Order.find_by(number: params[:order_id])
+  end
+
   def load_user
     @user = Spree::User.find(params[:user_id])
   end
 
+  def gift_card_params
+    params.require(:virtual_gift_card).permit(:recipient_name, :recipient_email, :purchaser_name, :gift_message, :send_email_at)
+  end
+
   def model_class
     Spree::VirtualGiftCard
   end

data/app/mailers/spree/gift_card_mailer.rb

@@ -2,7 +2,8 @@ class Spree::GiftCardMailer < Spree::BaseMailer
   def gift_card_email(gift_card)
     @gift_card = gift_card.respond_to?(:id) ? gift_card : Spree::VirtualGiftCard.find(gift_card)
     @order = @gift_card.line_item.order
+    send_to_address = @gift_card.recipient_email || @order.email
     subject = "#{Spree::Store.current.name} #{Spree.t('gift_card_mailer.gift_card_email.subject')}"
-    mail(to: @order.email, from: from_address, subject: subject)
+    mail(to: send_to_address, from: from_address, subject: subject)
   end
 end

data/app/models/concerns/spree/gift_cards/line_item_concerns.rb

@@ -3,8 +3,9 @@ module Spree
     extend ActiveSupport::Concern
 
     included do
-      has_many :gift_cards, class_name: Spree::VirtualGiftCard
+      has_many :gift_cards, class_name: Spree::VirtualGiftCard, dependent: :destroy
       delegate :gift_card?, :gift_card, to: :product
+      self.whitelisted_ransackable_associations += %w[order]
       prepend(InstanceMethods)
     end
 
@@ -12,6 +13,10 @@ module Spree
       def redemption_codes
         gift_cards.map {|gc| {amount: gc.formatted_amount, redemption_code: gc.formatted_redemption_code}}
       end
+
+      def gift_card_details
+        gift_cards.map(&:details)
+      end
     end
   end
 end

data/app/models/concerns/spree/gift_cards/order_concerns.rb

@@ -11,22 +11,28 @@ module Spree
     end
 
     module InstanceMethods
-      def finalize!
-        create_gift_cards
-        super
+      def gift_card_match(line_item, options)
+        return true unless line_item.gift_card?
+        return true unless options["gift_card_details"]
+        line_item.gift_cards.any? do |gift_card|
+          gc_detail_set = gift_card.details.stringify_keys.except("send_email_at").to_set
+          options_set = options["gift_card_details"].except("send_email_at").to_set
+          gc_detail_set.superset?(options_set)
+        end
       end
 
-      def create_gift_cards
-        line_items.each do |item|
-          item.quantity.times do
-            Spree::VirtualGiftCard.create!(amount: item.price, currency: item.currency, purchaser: user, line_item: item) if item.gift_card?
-          end
+      def finalize!
+        super
+        gift_cards.each do |gift_card|
+          gift_card.make_redeemable!(purchaser: user)
         end
       end
 
       def send_gift_card_emails
         gift_cards.each do |gift_card|
-          Spree::GiftCardMailer.gift_card_email(gift_card).deliver
+          if gift_card.send_email_at.nil? || gift_card.send_email_at <= DateTime.now
+            gift_card.send_email
+          end
         end
       end
     end

data/app/models/concerns/spree/gift_cards/order_contents_concerns.rb

@@ -0,0 +1,84 @@
+module Spree
+  module GiftCards::OrderContentsConcerns
+    extend ActiveSupport::Concern
+    class GiftCardDateFormatError < StandardError; end
+
+    included do
+      prepend(InstanceMethods)
+    end
+
+    module InstanceMethods
+      def add(variant, quantity = 1, options = {})
+        line_item = super
+        create_gift_cards(line_item, quantity, options["gift_card_details"] || {})
+        line_item
+      end
+
+      def remove(variant, quantity = 1, options = {})
+        line_item = super
+        remove_gift_cards(line_item, quantity)
+        line_item
+      end
+
+      def update_cart(params)
+        update_success = super(params)
+
+        if update_success && params[:line_items_attributes]
+          line_item = Spree::LineItem.find_by(id: params[:line_items_attributes][:id])
+          new_quantity = params[:line_items_attributes][:quantity].to_i
+          update_gift_cards(line_item, new_quantity)
+        end
+
+        update_success
+      end
+
+      private
+
+      def create_gift_cards(line_item, quantity_diff, gift_card_details = {})
+        if line_item.gift_card?
+          quantity_diff.to_i.times do
+            Spree::VirtualGiftCard.create!(
+              amount: line_item.price,
+              currency: line_item.currency,
+              line_item: line_item,
+              recipient_name: gift_card_details["recipient_name"],
+              recipient_email: gift_card_details["recipient_email"],
+              purchaser_name: gift_card_details["purchaser_name"],
+              gift_message: gift_card_details["gift_message"],
+              send_email_at: format_date(gift_card_details["send_email_at"])
+            )
+          end
+        end
+      end
+
+      def remove_gift_cards(line_item, quantity_diff)
+        if line_item.gift_card?
+          line_item.gift_cards.order(:created_at).last(quantity_diff).each(&:destroy!)
+        end
+      end
+
+      def update_gift_cards(line_item, new_quantity)
+        if line_item && line_item.gift_card?
+          gift_card_count = line_item.gift_cards.count
+          if new_quantity > gift_card_count
+            create_gift_cards(line_item, new_quantity - gift_card_count)
+          elsif new_quantity < line_item.gift_cards.count
+            remove_gift_cards(line_item, gift_card_count - new_quantity)
+          end
+        end
+      end
+
+      def format_date(date)
+        return date if date.acts_like?(:date) || date.acts_like?(:time)
+        return Date.today if date.nil?
+
+        begin
+          Date.parse(date)
+        rescue ArgumentError
+          raise GiftCardDateFormatError
+        end
+      end
+    end
+  end
+end
+

data/app/models/spree/order_contents_decorator.rb

@@ -0,0 +1 @@
+Spree::OrderContents.include Spree::GiftCards::OrderContentsConcerns

data/app/models/spree/virtual_gift_card.rb

@@ -5,22 +5,25 @@ class Spree::VirtualGiftCard < ActiveRecord::Base
   belongs_to :purchaser, class_name: 'Spree::User'
   belongs_to :redeemer, class_name: 'Spree::User'
   belongs_to :line_item, class_name: 'Spree::LineItem'
-  before_create :set_redemption_code, unless: -> { redemption_code }
-
 
   validates :amount, numericality: { greater_than: 0 }
-  validates_uniqueness_of :redemption_code, conditions: -> { where(redeemed_at: nil) }
-  validates_presence_of :purchaser_id
+  validates_uniqueness_of :redemption_code, conditions: -> { where(redeemed_at: nil, redeemable: true) }
+  validates_presence_of :purchaser_id, if: Proc.new { |gc| gc.redeemable? }
 
   scope :unredeemed, -> { where(redeemed_at: nil) }
   scope :by_redemption_code, -> (redemption_code) { where(redemption_code: redemption_code) }
+  scope :purchased, -> { where(redeemable: true) }
+
+  ransacker :sent_at do
+    Arel.sql('date(sent_at)')
+  end
 
   def redeemed?
     redeemed_at.present?
   end
 
   def redeem(redeemer)
-    return false if redeemed?
+    return false if redeemed? || !redeemable?
     create_store_credit!({
       amount: amount,
       currency: currency,
@@ -33,18 +36,51 @@ class Spree::VirtualGiftCard < ActiveRecord::Base
     self.update_attributes( redeemed_at: Time.now, redeemer: redeemer )
   end
 
+  def make_redeemable!(purchaser:)
+    update_attributes!(redeemable: true, purchaser: purchaser, redemption_code: (self.redemption_code || generate_unique_redemption_code))
+  end
+
   def memo
     "Gift Card ##{self.redemption_code}"
   end
 
+  def details
+    {
+      amount: formatted_amount,
+      redemption_code: formatted_redemption_code,
+      recipient_email: recipient_email,
+      recipient_name: recipient_name,
+      purchaser_name: purchaser_name,
+      gift_message: gift_message,
+      send_email_at: send_email_at,
+      formatted_send_email_at: formatted_send_email_at
+    }
+  end
+
   def formatted_redemption_code
-    redemption_code.scan(/.{4}/).join('-')
+    redemption_code.present? ? redemption_code.scan(/.{4}/).join('-') : ""
   end
 
   def formatted_amount
     number_to_currency(amount, precision: 0)
   end
 
+  def formatted_send_email_at
+    send_email_at.strftime("%-m/%-d/%y") if send_email_at
+  end
+
+  def formatted_sent_at
+    sent_at.strftime("%-m/%-d/%y") if sent_at
+  end
+
+  def formatted_created_at
+    created_at.localtime.strftime("%F %I:%M%p")
+  end
+
+  def formatted_redeemed_at
+    redeemed_at.localtime.strftime("%F %I:%M%p") if redeemed_at
+  end
+
   def store_credit_category
     Spree::StoreCreditCategory.where(name: Spree::StoreCreditCategory::GIFT_CARD_CATEGORY_NAME).first
   end
@@ -53,12 +89,13 @@ class Spree::VirtualGiftCard < ActiveRecord::Base
     Spree::VirtualGiftCard.unredeemed.by_redemption_code(redemption_code).first
   end
 
-  private
-
-  def set_redemption_code
-    self.redemption_code = generate_unique_redemption_code
+  def send_email
+    Spree::GiftCardMailer.gift_card_email(self).deliver_later
+    update_attributes!(sent_at: DateTime.now)
   end
 
+  private
+
   def generate_unique_redemption_code
     redemption_code = Spree::RedemptionCodeGenerator.generate_redemption_code
 

data/app/overrides/admin_gift_card_order_confirmation.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: "spree/admin/orders/confirm",
+  name: "add_gift_cards_to_admin_order_confirmation",
+  insert_before: "#order-total",
+  partial: "spree/admin/orders/confirmation_gift_card_details",
+)

data/app/overrides/admin_item_view_gift_card_codes.rb

@@ -1,13 +1,20 @@
+Deface::Override.new(
+  virtual_path: "spree/admin/orders/_line_items",
+  name: "add_gift_cards_to_admin_line_items",
+  insert_bottom: ".line-item-name",
+  partial: "spree/admin/orders/cart_gift_card_details",
+)
+
 Deface::Override.new(
   virtual_path: "spree/admin/orders/_shipment_manifest",
   name: "admin_item_view_gift_card_codes",
   insert_bottom: ".item-name",
-  partial: "spree/admin/orders/gift_card_redemption_codes",
+  partial: "spree/admin/orders/shipments_gift_card_details",
 )
 
 Deface::Override.new(
   virtual_path: "spree/admin/orders/_carton_manifest",
   name: "admin_item_view_gift_card_codes",
   insert_bottom: ".item-name",
-  partial: "spree/admin/orders/gift_card_redemption_codes",
+  partial: "spree/admin/orders/shipments_gift_card_details",
 )

data/app/views/spree/admin/gift_cards/_lookup_form.html.erb

@@ -1,8 +1,33 @@
-<script async='true'>GiftCards.init()</script>
-
 <div class='gift-card-code-lookup'>
-  <%= form_for :gift_card, url: admin_gift_cards_path, html: {id: 'lookup-redemption-code'} do |f| %>
-    Redemption code: <%= f.text_field :redemption_code %><br />
-    <%= f.submit 'Lookup Gift Card', class: 'lookup-gift-card-button' %>
+  <%= search_form_for @search, url: admin_gift_cards_path(@search) do |f| %>
+    <div class="four columns">
+      <div class="field">
+        <%= label_tag nil, "Redemption Code" %>
+        <%= f.text_field :redemption_code_cont, :size => 27 %>
+      </div>
+    </div>
+    <div class="four columns">
+      <div class="field">
+        <%= label_tag nil, "Recipient Email" %>
+        <%= f.text_field :recipient_email_cont, :size => 25 %>
+      </div>
+    </div>
+    <div class="four columns">
+      <div class="field">
+        <%= label_tag nil, "Order Number" %>
+        <%= f.text_field :line_item_order_number_cont, :size => 25 %>
+      </div>
+    </div>
+    <div class="three columns">
+      <div class="field">
+        <%= label_tag nil, "Send Date" %>
+        <%= f.text_field :sent_at_or_send_email_at_is, :class => 'datepicker', :size => 25 %>
+      </div>
+    </div>
+    <div class="clearfix"></div>
+    <div class="actions filter-actions">
+      <%= button 'Lookup Gift Card', 'search', class: 'lookup-gift-card-button' %>
+    </div>
   <% end %>
-</div>
+  </div>
+