solidus_virtual_gift_card 1.0.0

data/db/migrate/20140627185148_add_timestamps_to_gift_cards.rb

@@ -0,0 +1,6 @@
+class AddTimestampsToGiftCards < ActiveRecord::Migration
+  def change
+    add_column :spree_virtual_gift_cards, :created_at, :datetime
+    add_column :spree_virtual_gift_cards, :updated_at, :datetime
+  end
+end

data/db/migrate/20140702153907_add_gift_card_flag_to_products.rb

@@ -0,0 +1,5 @@
+class AddGiftCardFlagToProducts < ActiveRecord::Migration
+  def change
+    add_column :spree_products, :gift_card, :boolean, default: false
+  end
+end

data/db/migrate/20140707200431_add_line_item_to_gift_card.rb

@@ -0,0 +1,7 @@
+class AddLineItemToGiftCard < ActiveRecord::Migration
+  def change
+    add_column :spree_virtual_gift_cards, :line_item_id, :integer
+
+    add_index :spree_virtual_gift_cards, :line_item_id
+  end
+end

data/db/seeds.rb

@@ -0,0 +1 @@
+Spree::StoreCreditCategory.find_or_create_by(name: 'Gift Card')

data/lib/generators/solidus_virtual_gift_card/install/install_generator.rb

@@ -0,0 +1,36 @@
+module SolidusVirtualGiftCard
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_virtual_gift_card\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_virtual_gift_card\n", before: /\*\//, verbose: true
+      end
+
+      def include_seed_data
+        append_file "db/seeds.rb", <<-SEEDS
+\n
+SpreeVirtualGiftCard::Engine.load_seed if defined?(SpreeVirtualGiftCard::Engine)
+        SEEDS
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_virtual_gift_card'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/solidus_virtual_gift_card.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_virtual_gift_card/engine'

data/lib/spree_virtual_gift_card/engine.rb

@@ -0,0 +1,20 @@
+module SpreeVirtualGiftCard
+  class Engine < Rails::Engine
+    require "solidus_core"
+
+    isolate_namespace Spree
+    engine_name "solidus_virtual_gift_card"
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_virtual_gift_card/factories.rb

@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  factory :store_credit_gift_card_category, class: Spree::StoreCreditCategory do
+    name Spree::StoreCreditCategory::GIFT_CARD_CATEGORY_NAME
+  end
+
+  factory :virtual_gift_card, class: Spree::VirtualGiftCard do
+    association :purchaser, factory: :user
+    association :line_item, factory: :line_item
+
+    amount 25.0
+    currency "USD"
+  end
+end

data/solidus_virtual_gift_card.gemspec

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = "solidus_virtual_gift_card"
+  s.version     = "1.0.0"
+  s.summary     = "Virtual gift card for purchase, drops into the user's account as store credit"
+  s.required_ruby_version = ">= 2.1"
+
+  s.author    = "Bonobos"
+  s.email     = "engineering@bonobos.com"
+  s.homepage  = "http://www.bonobos.com"
+  s.license   = %q{BSD-3}
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = "lib"
+  s.requirements << "none"
+
+  s.add_dependency "solidus", [">= 1.0.0", "< 1.2.0"]
+
+  s.add_development_dependency "rspec-rails", "~> 3.2"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "sass-rails"
+  s.add_development_dependency "coffee-rails"
+  s.add_development_dependency "factory_girl"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "ffaker"
+end

data/spec/controllers/spree/admin/gift_cards_controller_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe Spree::Admin::GiftCardsController do
+  stub_authorization!
+  let!(:gc_category) { create(:store_credit_gift_card_category) }
+  let!(:credit_type) { create(:secondary_credit_type, name: "Non-expiring") }
+
+  describe 'GET index' do
+    subject { spree_get :index }
+
+    it "returns a 200 status code" do
+      subject
+      expect(response.code).to eq "200"
+    end
+  end
+
+  describe 'GET show' do
+    let(:gift_card) { create(:virtual_gift_card) }
+    let(:redemption_code) { gift_card.redemption_code }
+
+    subject { spree_get :show, id: redemption_code }
+
+    context 'with a valid redemption code' do
+      it 'loads the gift cards' do
+        subject
+        expect(assigns(:gift_cards)).to eq [gift_card]
+      end
+
+      it 'returns a 200 status code' do
+        subject
+        expect(response.code).to eq '200'
+      end
+    end
+
+    context 'with an invalid redemption code' do
+      let(:redemption_code) { "DOES-NOT-EXIST" }
+
+      it "redirects to index" do
+        expect(subject).to redirect_to spree.admin_gift_cards_path
+      end
+
+      it "sets the flash error" do
+        subject
+        expect(flash[:error]).to eq Spree.t('admin.gift_cards.errors.not_found')
+      end
+    end
+  end
+
+  describe 'GET lookup' do
+    let(:user) { create :user }
+    subject { spree_get :lookup, user_id: user.id }
+
+    it "returns a 200 status code" do
+      subject
+      expect(response.code).to eq "200"
+    end
+  end
+
+  describe 'POST redeem' do
+    let(:user) { create :user }
+    let(:gift_card) { create(:virtual_gift_card) }
+    let(:redemption_code) { gift_card.redemption_code }
+
+    subject { spree_post :redeem, user_id: user.id, gift_card: { redemption_code: redemption_code } }
+
+    context "with a gift card that has not yet been redeemed" do
+
+      it "redirects to store credit index" do
+        expect(subject).to redirect_to spree.admin_user_store_credits_path(user)
+      end
+
+      it "redeems the gift card" do
+        subject
+        expect(gift_card.reload.redeemed?).to eq true
+      end
+
+      it "sets the redeemer to the correct user" do
+        subject
+        expect(gift_card.reload.redeemer).to eq user
+      end
+
+      it "creates store credit for the user" do
+        subject
+        expect(user.reload.store_credits.count).to eq 1
+      end
+
+      it "sets the store credit equal to the amount of the gift card" do
+        subject
+        expect(user.reload.store_credits.first.amount).to eq gift_card.amount
+      end
+    end
+
+    context "with a gift card that has already been redeemed" do
+      before(:each) { gift_card.update_attribute(:redeemed_at, Date.yesterday) }
+
+      it "renders the lookup page" do
+        subject
+        expect(response).to render_template(:lookup)
+      end
+    end
+
+    context "with a gift card code that does not exist" do
+      let(:redemption_code) { "INVALID-REDEMPTION-CODE" }
+
+      it "renders the lookup page" do
+        subject
+        expect(response).to render_template(:lookup)
+      end
+    end
+  end
+end

data/spec/controllers/spree/api/gift_cards_controller_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Spree::Api::GiftCardsController do
+  render_views
+  let!(:credit_type) { create(:secondary_credit_type, name: "Non-expiring") }
+  let!(:gc_category) { create(:store_credit_gift_card_category) }
+
+  describe "POST redeem" do
+    let(:gift_card) { create(:virtual_gift_card) }
+
+    let(:parameters) do
+      {
+        redemption_code: gift_card.redemption_code
+      }
+    end
+
+    subject { spree_post :redeem, parameters, { format: :json } }
+
+    context "the user is not logged in" do
+
+      before { subject }
+
+      it "returns a 401" do
+        expect(response.status).to eq 401
+      end
+    end
+
+    context "the current api user is authenticated" do
+      let(:api_user) { create(:user) }
+
+      before do
+        allow(controller).to receive(:load_user)
+        controller.instance_variable_set(:@current_api_user, api_user)
+      end
+
+      let(:parsed_response) { HashWithIndifferentAccess.new(JSON.parse(response.body)) }
+
+      context "given an invalid gift card redemption code" do
+        before { subject }
+
+        let(:parameters) do
+          {
+            redemption_code: 'INVALID_CODE'
+          }
+        end
+
+        it 'does not find the gift card' do
+          expect(assigns(:gift_card)).to eq nil
+        end
+
+        it 'contains an error message' do
+          expect(parsed_response['error_message']).to be_present
+        end
+
+        it "returns a 404" do
+          expect(subject.status).to eq 404
+        end
+      end
+
+      context "there is no redemption code in the request body" do
+        let(:parameters) { {} }
+
+        it "returns a 404" do
+          expect(subject.status).to eq 404
+        end
+      end
+
+      context "given a valid gift card redemption code" do
+
+        it 'finds the gift card' do
+          subject
+          expect(assigns(:gift_card)).to eq gift_card
+        end
+
+        it 'redeems the gift card' do
+          allow(Spree::VirtualGiftCard).to receive(:active_by_redemption_code).and_return(gift_card)
+          expect(gift_card).to receive(:redeem).with(api_user)
+          subject
+        end
+
+        it "returns a 201" do
+          subject
+          expect(subject.status).to eq 201
+        end
+      end
+    end
+  end
+end

data/spec/models/concerns/spree/redemption_code_generator_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Spree::RedemptionCodeGenerator do
+  describe '#generate_redemption_code' do
+    subject { Spree::RedemptionCodeGenerator.generate_redemption_code }
+
+    it 'generates a 16 character alpha-numeric code' do
+      code = subject
+      expect(code.match('^[a-zA-Z0-9]{16}')[0]).to eq code
+    end
+  end
+
+  describe '#format_redemption_code_for_lookup' do
+    subject { Spree::RedemptionCodeGenerator.format_redemption_code_for_lookup(redemption_code) }
+
+    context 'redemption code has no dashes' do
+      let(:redemption_code) { "1234ABCD1234ABCD" }
+
+      it 'does nothing to the code' do
+        expect(subject).to eq redemption_code
+      end
+    end
+
+    context 'redemption code 4 groups of 4 characters, separated by dashes' do
+      let(:redemption_code) { "1234-ABCD-1234-ABCD" }
+      let(:formatted_redemption_code) { "1234ABCD1234ABCD" }
+
+      it 'strips the dashes' do
+        expect(subject).to eq formatted_redemption_code
+      end
+    end
+
+    context 'redemption code is mixed-case' do
+      let(:redemption_code) { "1234-aBCd-1234-AbcD" }
+      let(:formatted_redemption_code) { "1234ABCD1234ABCD" }
+
+      it 'makes it all upcase' do
+        expect(subject).to eq formatted_redemption_code
+      end
+    end
+  end
+end

data/spec/models/spree/line_item_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Spree::LineItem do
+  describe "#redemption_codes" do
+    let(:line_item) { create(:line_item, quantity: 2) }
+    let!(:gift_card) { create(:virtual_gift_card, line_item: line_item) }
+    let!(:gift_card_2) { create(:virtual_gift_card, line_item: line_item) }
+    let(:subject) { line_item.redemption_codes }
+
+    it 'has the correct number of redemption codes and keys' do
+      expect(subject.size).to eq line_item.quantity
+    end
+
+    it 'contains a redemption_code' do
+      expect(subject.first).to have_key :redemption_code
+    end
+
+    it 'formats the redemption_code' do
+      expect(subject.first).to have_value gift_card.formatted_redemption_code
+    end
+
+    it 'contains an amount' do
+      expect(subject.first).to have_key :amount
+    end
+
+    it 'formats the amount' do
+      expect(subject.first).to have_value gift_card.formatted_amount
+    end
+  end
+end

data/spec/models/spree/order_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Spree::Order do
+  describe "#create_gift_cards" do
+    let(:order) { create(:order_with_line_items) }
+    let(:line_item) { order.line_items.first }
+    subject { order.create_gift_cards }
+
+    context "the line item is a gift card" do
+      before do
+        allow(line_item).to receive(:gift_card?).and_return(true)
+        allow(line_item).to receive(:quantity).and_return(3)
+      end
+
+      it 'creates a gift card for each gift card in the line item' do
+        expect { subject }.to change { Spree::VirtualGiftCard.count }.by(line_item.quantity)
+      end
+
+      it 'sets the purchaser, amount, and currency' do
+        expect(Spree::VirtualGiftCard).to receive(:create!).exactly(3).times.with(amount: line_item.price, currency: line_item.currency, purchaser: order.user, line_item: line_item)
+        subject
+      end
+    end
+
+    context "the line item is not a gift card" do
+      before { allow(line_item).to receive(:gift_card?).and_return(false) }
+
+      it 'does not create a gift card' do
+        expect(Spree::VirtualGiftCard).not_to receive(:create!)
+        subject
+      end
+    end
+  end
+
+  describe "#finalize!" do
+    context "the order contains gift cards and transitions to complete" do
+      let(:order) { create(:order_with_line_items, state: 'complete') }
+
+      subject { order.finalize! }
+
+      it "calls #create_gift_cards" do
+        expect(order).to receive(:create_gift_cards)
+        subject
+      end
+    end
+  end
+
+  describe "#send_gift_card_emails" do
+
+    subject { order.send_gift_card_emails }
+
+    context "the order has gift cards" do
+      let(:gift_card) { create(:virtual_gift_card) }
+      let(:line_item) { gift_card.line_item }
+      let(:gift_card_2) { create(:virtual_gift_card, line_item: line_item) }
+      let(:order) { gift_card.line_item.order }
+
+      it "should call GiftCardMailer#send" do
+        expect(Spree::GiftCardMailer).to receive(:gift_card_email).with(gift_card).and_return(double(deliver: true))
+        expect(Spree::GiftCardMailer).to receive(:gift_card_email).with(gift_card_2).and_return(double(deliver: true))
+        subject
+      end
+    end
+
+    context "no gift cards" do
+      let(:order) { create(:order_with_line_items) }
+
+      it "should not call GiftCardMailer#send" do
+        expect(Spree::GiftCardMailer).to_not receive(:gift_card_email)
+        subject
+      end
+    end
+  end
+
+  describe "#display_total_applicable_store_credit" do
+    let(:total_applicable_store_credit) { 10.00 }
+
+    subject { create(:order) }
+
+    before { allow(subject).to receive_messages(total_applicable_store_credit: total_applicable_store_credit) }
+
+    it "returns a money instance" do
+      expect(subject.display_total_applicable_store_credit).to be_a(Spree::Money)
+    end
+
+    it "returns a negative amount" do
+      expect(subject.display_total_applicable_store_credit.money.cents).to eq (total_applicable_store_credit * -100.0)
+    end
+  end
+end

data/spec/models/spree/permission_sets/virtual_gift_card_display_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Spree::PermissionSets::VirtualGiftCardDisplay do
+  let(:ability) { Spree::Ability.new nil }
+
+  subject { ability }
+
+  context "when activated" do
+    before do
+      described_class.new(ability).activate!
+    end
+
+    it { should be_able_to(:admin, Spree::VirtualGiftCard) }
+    it { should be_able_to(:display, Spree::VirtualGiftCard) }
+  end
+
+  context "when not activated" do
+    it { should_not be_able_to(:admin, Spree::VirtualGiftCard) }
+    it { should_not be_able_to(:display, Spree::VirtualGiftCard) }
+  end
+end
+

data/spec/models/spree/permission_sets/virtual_gift_card_management_spec.rb

@@ -0,0 +1,21 @@
+
+require 'spec_helper'
+
+describe Spree::PermissionSets::VirtualGiftCardManagement do
+  let(:ability) { Spree::Ability.new nil }
+
+  subject { ability }
+
+  context "when activated" do
+    before do
+      described_class.new(ability).activate!
+    end
+
+    it { should be_able_to(:manage, Spree::VirtualGiftCard) }
+  end
+
+  context "when not activated" do
+    it { should_not be_able_to(:manage, Spree::VirtualGiftCard) }
+  end
+end
+

data/spec/models/spree/store_credit_category_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Spree::StoreCreditCategory, type: :model do
+  describe "#non_expiring?" do
+    subject { build(:store_credit_category, name: category_name).non_expiring? }
+
+    context "non-expiring type store credit" do
+      let(:category_name) { Spree::StoreCreditCategory.non_expiring_credit_types.first }
+
+      it "returns true" do
+        expect(subject).to be true
+      end
+    end
+
+    context "expiring type store credit" do
+      let(:category_name) { "Expiring" }
+
+      it "returns false" do
+        expect(subject).to be false
+      end
+    end
+  end
+end