solidus_virtual_gift_card 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ea5a0d37ac45be094a61721f9f91b948a4713063
-  data.tar.gz: 31f391fb4340bbded183df0bd9fdd5e828c12de5
+SHA256:
+  metadata.gz: cd464b35ade1d8c367f28771b22632bf2dfbd1bffb6ab56b1e4893b40cf74ce2
+  data.tar.gz: 41c2ac487d74730c650e4636dd115bb307a3ad065fc900bae37a9453afca7060
 SHA512:
-  metadata.gz: 652d0b4ace4f835d099d5f518bdca86fb708a809198fa08a7cfad4f0c8011f472c8f8a89e9dc0572e8b76f10e36818aae20b875f2ea210440d73e8d839aeef53
-  data.tar.gz: 78cd94b6aa0d3e4b89b937ffdbabc83af98940ef1b42edff365ff30600c9787e29c5ac9715d3141d65d6c43e22ca65bcedb262af5150c753ae224f2cae4e8873
+  metadata.gz: fa2b39045ef1ba5f6d7de759bd523fa5787a2709f3a5bd85950ce8578befc490b5f9c68866517b154a371fdffd4fadfd58b942a2a7b46b2caf4425ddc758555f
+  data.tar.gz: 71c837556620b2aaf272a3236f56813f99da6ae48214b725453493b778a80e320c27a5a932ead827b3ca07b4114c96f1f971b15ad22bfc5209e7ee1516fc0f8a

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/Gemfile

@@ -1,13 +1,27 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
-gem "solidus", github: "solidusio/solidus", branch: branch
-gem "solidus_auth_devise"
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+gem 'solidus_auth_devise'
 
-gem 'pg'
-gem 'mysql2'
+gem 'rails-controller-testing', group: :test
 
-group :test, :development do
+case ENV['DB']
+when 'postgres'
+  gem 'pg'
+when 'mysql'
+  gem 'mysql2'
+end
+
+# Needed to help Bundler figure out how to resolve dependencies, otherwise it takes forever to
+# resolve them
+if branch == 'master' || Gem::Version.new(branch[1..-1]) >= Gem::Version.new('2.10.0')
+  gem 'rails', '~> 6.0'
+else
+  gem 'rails', '~> 5.0'
+end
+
+group :development, :test do
   gem 'pry-rails'
 end
 

data/README.md

@@ -1,5 +1,8 @@
 Solidus - Virtual Gift Card
 ===========================
+
+[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_virtual_gift_card.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_virtual_gift_card)
+
 A virtual gift card implementation for Solidus.
 
 * Allows setup of virtual gift card products that get unique codes upon
@@ -7,8 +10,6 @@ A virtual gift card implementation for Solidus.
 * The virtual gift card codes can be used to add store credit to a user's
   account.
 
-[![Build Status](https://travis-ci.org/solidusio/solidus_virtual_gift_card.svg?branch=master)](https://travis-ci.org/solidusio/solidus_virtual_gift_card)
-
 Installation
 ------------
 
@@ -44,7 +45,7 @@ bundle
 bundle exec rake
 ```
 
-When testing your applications integration with this extension you may use it's
+When testing your application's integration with this extension you may use its
 factories. Simply add this require statement to your spec_helper:
 
 ```ruby

data/Rakefile

@@ -7,9 +7,9 @@ require 'spree/testing_support/extension_rake'
 RSpec::Core::RakeTask.new
 
 task :default do
-  if Dir["spec/dummy"].empty?
+  if Dir['spec/dummy'].empty?
     Rake::Task[:test_app].invoke
-    Dir.chdir("../../")
+    Dir.chdir('../../')
   end
   Rake::Task[:spec].invoke
 end

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

@@ -1,11 +1,11 @@
 class Spree::Admin::GiftCardsController < Spree::Admin::BaseController
-  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, :deactivate]
-  before_filter :load_order, only: [:edit, :update, :deactivate]
+  before_action :load_user, only: [:lookup, :redeem]
+  before_action :load_gift_card_for_redemption, only: [:redeem]
+  before_action :load_gift_card_by_id, only: [:edit, :update, :send_email, :deactivate]
+  before_action :load_order, only: [:edit, :update, :deactivate]
 
   def index
-    @search = Spree::VirtualGiftCard.purchased.search(params[:q])
+    @search = Spree::VirtualGiftCard.purchased.ransack(params[:q])
     @gift_cards = @search.result.page(params[:page]).per(params[:per_page])
   end
 
@@ -16,35 +16,35 @@ class Spree::Admin::GiftCardsController < Spree::Admin::BaseController
   end
 
   def update
-    if @gift_card.update_attributes(gift_card_params)
-      flash[:success] = Spree.t("admin.gift_cards.gift_card_updated")
+    if @gift_card.update(gift_card_params)
+      flash[:success] = I18n.t('spree.admin.gift_cards.gift_card_updated')
       redirect_to edit_admin_order_path(@order)
     else
-      flash[:error] = @gift_card.errors.full_messages.join(", ")
+      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")
+      flash[:success] = I18n.t('spree.admin.gift_cards.redeemed_gift_card')
       redirect_to admin_user_store_credits_path(@user)
     else
-      flash[:error] = Spree.t("admin.gift_cards.errors.unable_to_redeem_gift_card")
+      flash[:error] = I18n.t('spree.admin.gift_cards.errors.unable_to_redeem_gift_card')
       render :lookup
     end
   end
 
   def deactivate
     if @gift_card.deactivate
-      flash[:success] = Spree.t("admin.gift_cards.deactivated_gift_card")
+      flash[:success] = I18n.t('spree.admin.gift_cards.deactivated_gift_card')
       redirect_to edit_admin_order_path(@order)
     else
-      flash[:error] = @gift_card.errors.full_messages.join(", ").presence || Spree.t("admin.gift_cards.errors.unable_to_reimburse_gift_card")
+      flash[:error] = @gift_card.errors.full_messages.join(', ').presence || I18n.t('spree.admin.gift_cards.errors.unable_to_reimburse_gift_card')
       redirect_to edit_admin_order_gift_card_path(@order, @gift_card)
     end
   rescue Spree::Reimbursement::IncompleteReimbursementError
-    flash[:error] = Spree.t("admin.gift_cards.errors.unable_to_reimburse_gift_card")
+    flash[:error] = I18n.t('spree.admin.gift_cards.errors.unable_to_reimburse_gift_card')
     redirect_to edit_admin_order_gift_card_path(@order, @gift_card)
   end
 
@@ -60,7 +60,7 @@ class Spree::Admin::GiftCardsController < Spree::Admin::BaseController
     @gift_card = Spree::VirtualGiftCard.active_by_redemption_code(redemption_code)
 
     if @gift_card.blank?
-      flash[:error] = Spree.t("admin.gift_cards.errors.not_found")
+      flash[:error] = I18n.t('spree.admin.gift_cards.errors.not_found')
       render :lookup
     end
   end

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

@@ -1,7 +1,7 @@
 class Spree::Api::GiftCardsController < Spree::Api::BaseController
 
   def redeem
-    redemption_code = Spree::RedemptionCodeGenerator.format_redemption_code_for_lookup(params[:redemption_code] || "")
+    redemption_code = Spree::RedemptionCodeGenerator.format_redemption_code_for_lookup(params[:redemption_code] || '')
     @gift_card = Spree::VirtualGiftCard.active_by_redemption_code(redemption_code)
 
     if !@gift_card
@@ -17,7 +17,7 @@ class Spree::Api::GiftCardsController < Spree::Api::BaseController
 
   def redeem_fail_response
    {
-      error_message: "#{Spree.t('admin.gift_cards.errors.not_found')}. #{Spree.t('admin.gift_cards.errors.please_try_again')}"
+      error_message: "#{I18n.t('spree.admin.gift_cards.errors.not_found')}. #{I18n.t('spree.admin.gift_cards.errors.please_try_again')}"
    }
  end
 end

data/app/decorators/models/solidus_virtual_gift_card/spree/inventory_unit_decorator.rb

@@ -0,0 +1,13 @@
+module SolidusVirtualGiftCard
+  module Spree
+    module InventoryUnitDecorator
+      def self.prepended(base)
+        base.class_eval do
+          has_one :gift_card, class_name: 'Spree::VirtualGiftCard'
+        end
+      end
+
+      ::Spree::InventoryUnit.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_virtual_gift_card/spree/line_item_decorator.rb

@@ -0,0 +1,24 @@
+module SolidusVirtualGiftCard
+  module Spree
+    module LineItemDecorator
+      def self.prepended(base)
+        base.class_eval do
+          has_many :gift_cards, class_name: 'Spree::VirtualGiftCard', dependent: :destroy
+          delegate :gift_card?, :gift_card, to: :product
+
+          self.whitelisted_ransackable_associations += %w[order]
+        end
+      end
+
+      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
+
+      ::Spree::LineItem.prepend self
+    end
+  end
+end

data/app/{models/concerns/spree/gift_cards/order_contents_concerns.rb → decorators/models/solidus_virtual_gift_card/spree/order_contents_decorator.rb}

@@ -1,16 +1,9 @@
-module Spree
-  module GiftCards::OrderContentsConcerns
-    extend ActiveSupport::Concern
-    class GiftCardDateFormatError < StandardError; end
-
-    included do
-      prepend(InstanceMethods)
-    end
-
-    module InstanceMethods
+module SolidusVirtualGiftCard
+  module Spree
+    module OrderContentsDecorator
       def add(variant, quantity = 1, options = {})
         line_item = super
-        create_gift_cards(line_item, quantity, options["gift_card_details"] || {})
+        create_gift_cards(line_item, quantity, options['gift_card_details'] || {})
         line_item
       end
 
@@ -24,7 +17,7 @@ module Spree
         update_success = super(params)
 
         if update_success && params[:line_items_attributes]
-          line_item = Spree::LineItem.find_by(id: params[:line_items_attributes][:id])
+          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
@@ -37,15 +30,15 @@ module Spree
       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!(
+            ::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"])
+              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
@@ -75,10 +68,11 @@ module Spree
         begin
           Date.parse(date)
         rescue ArgumentError
-          raise GiftCardDateFormatError
+          raise ::Spree::GiftCards::GiftCardDateFormatError
         end
       end
+
+      ::Spree::OrderContents.prepend self
     end
   end
 end
-

data/app/{models/concerns/spree/gift_cards/order_concerns.rb → decorators/models/solidus_virtual_gift_card/spree/order_decorator.rb}

@@ -1,22 +1,20 @@
-module Spree
-  module GiftCards::OrderConcerns
-    extend ActiveSupport::Concern
+module SolidusVirtualGiftCard
+  module Spree
+    module OrderDecorator
+      def self.prepended(base)
+        base.class_eval do
+          state_machine.after_transition to: :complete, do: :send_gift_card_emails
 
-    included do
-      Spree::Order.state_machine.after_transition to: :complete, do: :send_gift_card_emails
-
-      has_many :gift_cards, through: :line_items
-
-      prepend(InstanceMethods)
-    end
+          has_many :gift_cards, through: :line_items
+        end
+      end
 
-    module InstanceMethods
       def gift_card_match(line_item, options)
         return true unless line_item.gift_card?
-        return true unless options["gift_card_details"]
+        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 = 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
@@ -36,6 +34,8 @@ module Spree
           end
         end
       end
+
+      ::Spree::Order.prepend self
     end
   end
 end

data/app/{models → decorators/models/solidus_virtual_gift_card}/spree/store_credit_category_decorator.rb

@@ -1,2 +1,2 @@
-Spree::StoreCreditCategory::GIFT_CARD_CATEGORY_NAME = "Gift Card".freeze
+Spree::StoreCreditCategory::GIFT_CARD_CATEGORY_NAME = 'Gift Card'.freeze
 Spree::StoreCreditCategory.non_expiring_credit_types |= [Spree::StoreCreditCategory::GIFT_CARD_CATEGORY_NAME]

data/app/mailers/spree/gift_card_mailer.rb

@@ -2,8 +2,11 @@ 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
+
+    store = @order.store
     send_to_address = @gift_card.recipient_email.presence || @order.email
-    subject = "#{Spree::Store.current.name} #{Spree.t('gift_card_mailer.gift_card_email.subject')}"
-    mail(to: send_to_address, from: from_address(Spree::Store.current), subject: subject)
+    subject = "#{store} #{I18n.t('spree.gift_card_mailer.gift_card_email.subject')}"
+
+    mail(to: send_to_address, from: from_address(store), subject: subject)
   end
 end

data/app/models/spree/gift_cards/gift_card_date_format_error.rb

@@ -0,0 +1,6 @@
+module Spree
+  module GiftCards
+    class GiftCardDateFormatError < StandardError
+    end
+  end
+end

data/app/models/spree/virtual_gift_card.rb

@@ -1,11 +1,11 @@
-class Spree::VirtualGiftCard < ActiveRecord::Base
+class Spree::VirtualGiftCard < Spree::Base
   include ActionView::Helpers::NumberHelper
 
-  belongs_to :store_credit, class_name: 'Spree::StoreCredit'
-  belongs_to :purchaser, class_name: 'Spree::User'
-  belongs_to :redeemer, class_name: 'Spree::User'
-  belongs_to :line_item, class_name: 'Spree::LineItem'
-  belongs_to :inventory_unit, class_name: 'Spree::InventoryUnit'
+  belongs_to :store_credit, class_name: 'Spree::StoreCredit', optional: true
+  belongs_to :purchaser, class_name: 'Spree::User', optional: true
+  belongs_to :redeemer, class_name: 'Spree::User', optional: true
+  belongs_to :line_item, class_name: 'Spree::LineItem', optional: true
+  belongs_to :inventory_unit, class_name: 'Spree::InventoryUnit', optional: true
   has_one :order, through: :line_item
 
   validates :amount, numericality: { greater_than: 0 }
@@ -16,6 +16,9 @@ class Spree::VirtualGiftCard < ActiveRecord::Base
   scope :by_redemption_code, -> (redemption_code) { where(redemption_code: redemption_code) }
   scope :purchased, -> { where(redeemable: true) }
 
+  self.whitelisted_ransackable_associations = %w[line_item order]
+  self.whitelisted_ransackable_attributes = %w[redemption_code recipient_email sent_at send_email_at]
+
   ransacker :sent_at do
     Arel.sql('date(sent_at)')
   end
@@ -39,15 +42,15 @@ class Spree::VirtualGiftCard < ActiveRecord::Base
       action_originator: self,
       category: store_credit_category,
     })
-    self.update_attributes( redeemed_at: Time.now, redeemer: redeemer )
+    self.update( redeemed_at: Time.now, redeemer: redeemer )
   end
 
   def make_redeemable!(purchaser:, inventory_unit:)
-    update_attributes!(redeemable: true, purchaser: purchaser, inventory_unit: inventory_unit, redemption_code: (self.redemption_code || generate_unique_redemption_code))
+    update!(redeemable: true, purchaser: purchaser, inventory_unit: inventory_unit, redemption_code: (self.redemption_code || generate_unique_redemption_code))
   end
 
   def deactivate
-    update_attributes(redeemable: false, deactivated_at: Time.now) &&
+    update(redeemable: false, deactivated_at: Time.now) &&
       cancel_and_reimburse_inventory_unit
   end
 
@@ -73,7 +76,7 @@ class Spree::VirtualGiftCard < ActiveRecord::Base
   end
 
   def formatted_redemption_code
-    redemption_code.present? ? redemption_code.scan(/.{4}/).join('-') : ""
+    redemption_code.present? ? redemption_code.scan(/.{4}/).join('-') : ''
   end
 
   def formatted_amount
@@ -81,23 +84,23 @@ class Spree::VirtualGiftCard < ActiveRecord::Base
   end
 
   def formatted_send_email_at
-    send_email_at.strftime("%-m/%-d/%y") if 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
+    sent_at.strftime('%-m/%-d/%y') if sent_at
   end
 
   def formatted_created_at
-    created_at.localtime.strftime("%F %I:%M%p")
+    created_at.localtime.strftime('%F %I:%M%p')
   end
 
   def formatted_redeemed_at
-    redeemed_at.localtime.strftime("%F %I:%M%p") if redeemed_at
+    redeemed_at.localtime.strftime('%F %I:%M%p') if redeemed_at
   end
 
   def formatted_deactivated_at
-    deactivated_at.localtime.strftime("%F %I:%M%p") if deactivated_at
+    deactivated_at.localtime.strftime('%F %I:%M%p') if deactivated_at
   end
 
   def store_credit_category
@@ -110,7 +113,7 @@ class Spree::VirtualGiftCard < ActiveRecord::Base
 
   def send_email
     Spree::GiftCardMailer.gift_card_email(self).deliver_later
-    update_attributes!(sent_at: DateTime.now)
+    update!(sent_at: DateTime.now)
   end
 
   private