solidus_virtual_gift_card 1.0.0

data/spec/models/spree/virtual_gift_card_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+
+describe Spree::VirtualGiftCard do
+  let!(:gc_category) { create(:store_credit_gift_card_category) }
+  let!(:credit_type) { create(:secondary_credit_type, name: "Non-expiring") }
+
+  context 'validations' do
+    let(:invalid_gift_card) { Spree::VirtualGiftCard.new(amount: 0, currency: 'USD', purchaser: create(:user)) }
+
+    context 'given an amount less than one' do
+      it 'is not valid' do
+        expect(invalid_gift_card).not_to be_valid
+      end
+
+      it 'adds an error to amount' do
+        invalid_gift_card.save
+        expect(invalid_gift_card.errors.full_messages).to include 'Amount must be greater than 0'
+      end
+    end
+  end
+
+  context 'before create callbacks' do
+    let(:gift_card) { Spree::VirtualGiftCard.new(amount: 20, currency: 'USD', purchaser: create(:user), line_item: create(:line_item) ) }
+    subject { gift_card.save }
+
+    context 'a redemption code is set already' do
+      before { gift_card.redemption_code = 'foo' }
+      it 'keeps that redemption code' do
+        subject
+        expect(gift_card.redemption_code).to eq 'foo'
+      end
+    end
+
+    context 'no collision on redemption code' do
+      it 'sets an initial redemption code' do
+        subject
+        expect(gift_card.redemption_code).to be_present
+      end
+    end
+
+
+    context 'there is a collision on redemption code' do 
+      context 'the existing giftcard has not been redeemed yet' do
+        let!(:existing_giftcard) { create(:virtual_gift_card) }
+        let(:expected_code) { 'EXPECTEDCODE' }
+        let(:generator) { Spree::RedemptionCodeGenerator }
+
+        it 'recursively generates redemption codes' do
+          expect(generator).to receive(:generate_redemption_code).and_return(existing_giftcard.redemption_code)
+          expect(generator).to receive(:generate_redemption_code).and_return(expected_code)
+
+          subject
+
+          expect(gift_card.redemption_code).to eq expected_code
+        end
+      end
+
+      context 'the existing gift card has been redeemed' do
+        let!(:existing_giftcard) { create(:virtual_gift_card, redeemed_at: Time.now) }
+        let(:generator) { Spree::RedemptionCodeGenerator }
+
+        it 'recursively generates redemption codes' do
+          expect(generator).to receive(:generate_redemption_code).and_return(existing_giftcard.redemption_code)
+
+          subject
+
+          expect(gift_card.redemption_code).to eq existing_giftcard.redemption_code
+        end
+      end
+    end
+  end
+
+  describe '#redeemed?' do
+    let(:gift_card) { Spree::VirtualGiftCard.new(amount: 20, currency: 'USD') }
+    subject { gift_card.save }
+
+    it 'is redeemed if there is a redeemed_at set' do
+      gift_card.redeemed_at = Time.now
+      subject
+      expect(gift_card.redeemed?).to be true
+    end
+
+    it 'is not redeemed if there is no timestamp for redeemed_at' do
+      subject
+      expect(gift_card.redeemed?).to be false
+    end
+  end
+
+  describe '#redeem' do
+    let(:gift_card) { Spree::VirtualGiftCard.create(amount: 20, currency: 'USD', purchaser: create(:user), line_item: create(:line_item)) }
+    let(:redeemer) { create(:user) }
+    subject { gift_card.redeem(redeemer) }
+
+    context 'it has already been redeemed' do
+      before { gift_card.redeemed_at = Date.yesterday }
+
+      it 'should return false' do
+        expect(subject).to be false
+      end
+
+      context 'does nothing to the gift card' do
+        it 'should not create a store credit' do
+          expect(gift_card.store_credit).not_to be_present
+        end
+
+        it 'should not update the gift card' do
+          expect { subject }.to_not change{ gift_card }
+        end
+      end
+    end
+
+    context 'it has not been redeemed already' do
+      context 'generates a store credit' do
+        before { subject }
+        let(:store_credit) { gift_card.store_credit }
+
+        it 'sets the relationship' do
+          expect(store_credit).to be_present
+        end
+
+        it 'sets the store credit amount' do
+          expect(store_credit.amount).to eq gift_card.amount
+        end
+
+        it 'sets the store credit currency' do
+          expect(store_credit.currency).to eq gift_card.currency
+        end
+
+        it "sets the 'Gift Card' category" do
+          expect(store_credit.category).to eq gc_category
+        end
+
+        it 'sets the redeeming user on the store credit' do
+          expect(store_credit.user).to eq redeemer
+        end
+
+        it 'sets the created_by user on the store credit' do
+          expect(store_credit.created_by).to eq redeemer
+        end
+
+        it 'sets a memo on store credit for admins to reference the redemption code' do
+          expect(store_credit.memo).to eq gift_card.memo
+        end
+      end
+
+      it 'returns true' do
+        expect(subject).to be true
+      end
+
+      it 'sets redeemed_at' do
+        subject
+        expect(gift_card.redeemed_at).to be_present
+      end
+
+      it 'sets the redeeming user association' do
+        subject
+        expect(gift_card.redeemer).to be_present
+      end
+
+      it 'sets the admin as the store credit event originator' do
+        expect { subject }.to change { Spree::StoreCreditEvent.count }.by(1)
+        expect(Spree::StoreCreditEvent.last.originator).to eq gift_card
+      end
+    end
+  end
+
+  describe '#formatted_redemption_code' do
+    let(:redemption_code) { 'AAAABBBBCCCCDDDD' }
+    let(:formatted_redemption_code) { 'AAAA-BBBB-CCCC-DDDD' }
+    let(:gift_card) { Spree::VirtualGiftCard.create(amount: 20, currency: 'USD') }
+
+    subject { gift_card.formatted_redemption_code }
+
+    it 'inserts dashes into the code after every 4 characters' do
+      expect(gift_card).to receive(:redemption_code).and_return(redemption_code)
+      expect(subject).to eq formatted_redemption_code
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,74 @@
+# Run Coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec'
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Views', 'app/views'
+  add_group 'Libraries', 'lib'
+end
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+
+require 'database_cleaner'
+require 'ffaker'
+
+require 'spree/testing_support/factories'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/url_helpers'
+
+require 'cancan/matchers'
+
+require "spree_virtual_gift_card/factories"
+
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.mock_with :rspec
+
+  config.color = true
+  config.order = "random"
+
+  config.expose_current_running_example_as :example
+  config.fail_fast = ENV["FAIL_FAST"] || false
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+  config.use_transactional_fixtures = false
+
+  config.example_status_persistence_file_path = "./spec/examples.txt"
+
+  config.include FactoryGirl::Syntax::Methods
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+  config.include Spree::TestingSupport::UrlHelpers, type: :controller
+
+  # Ensure Suite is set to use transactions for speed.
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  # Before each spec check if it is a Javascript test and switch between using
+  # database transactions or not where necessary.
+  config.before :each do |example|
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.start
+
+    Spree::Api::Config[:requires_authentication] = true
+    Spree::Config.reset
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,258 @@
+--- !ruby/object:Gem::Specification
+name: solidus_virtual_gift_card
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bonobos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: engineering@bonobos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/solidus_virtual_gift_card.coffee
+- app/assets/stylesheets/spree/backend/solidus_virtual_gift_card.css
+- app/controllers/spree/admin/gift_cards_controller.rb
+- app/controllers/spree/api/gift_cards_controller.rb
+- app/mailers/spree/gift_card_mailer.rb
+- app/models/concerns/spree/gift_cards/line_item_concerns.rb
+- app/models/concerns/spree/gift_cards/order_concerns.rb
+- app/models/concerns/spree/redemption_code_generator.rb
+- app/models/spree/line_item_decorator.rb
+- app/models/spree/order_decorator.rb
+- app/models/spree/permission_sets/virtual_gift_card_display.rb
+- app/models/spree/permission_sets/virtual_gift_card_management.rb
+- app/models/spree/store_credit_category_decorator.rb
+- app/models/spree/virtual_gift_card.rb
+- app/overrides/admin_item_view_gift_card_codes.rb
+- app/overrides/admin_user_sidebar_store_credits.rb
+- app/overrides/admin_user_sub_menu.rb
+- app/views/spree/admin/gift_cards/_lookup_form.html.erb
+- app/views/spree/admin/gift_cards/_redemption_form.html.erb
+- app/views/spree/admin/gift_cards/index.html.erb
+- app/views/spree/admin/gift_cards/lookup.html.erb
+- app/views/spree/admin/gift_cards/show.html.erb
+- app/views/spree/admin/orders/_gift_card_redemption_codes.html.erb
+- app/views/spree/admin/users/_gift_card_sidebar.html.erb
+- app/views/spree/admin/users/_sub_menu.html.erb
+- app/views/spree/gift_card_mailer/gift_card_email.text.erb
+- bin/rails
+- circle.yml
+- config/initializers/gift_card_store_credit_event_originator.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20140623152903_create_virtual_gift_card.rb
+- db/migrate/20140624175113_seed_gift_card_category.rb
+- db/migrate/20140627185148_add_timestamps_to_gift_cards.rb
+- db/migrate/20140702153907_add_gift_card_flag_to_products.rb
+- db/migrate/20140707200431_add_line_item_to_gift_card.rb
+- db/seeds.rb
+- lib/generators/solidus_virtual_gift_card/install/install_generator.rb
+- lib/solidus_virtual_gift_card.rb
+- lib/spree_virtual_gift_card/engine.rb
+- lib/spree_virtual_gift_card/factories.rb
+- solidus_virtual_gift_card.gemspec
+- spec/controllers/spree/admin/gift_cards_controller_spec.rb
+- spec/controllers/spree/api/gift_cards_controller_spec.rb
+- spec/models/concerns/spree/redemption_code_generator_spec.rb
+- spec/models/spree/line_item_spec.rb
+- spec/models/spree/order_spec.rb
+- spec/models/spree/permission_sets/virtual_gift_card_display_spec.rb
+- spec/models/spree/permission_sets/virtual_gift_card_management_spec.rb
+- spec/models/spree/store_credit_category_spec.rb
+- spec/models/spree/virtual_gift_card_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.bonobos.com
+licenses:
+- BSD-3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Virtual gift card for purchase, drops into the user's account as store credit
+test_files:
+- spec/controllers/spree/admin/gift_cards_controller_spec.rb
+- spec/controllers/spree/api/gift_cards_controller_spec.rb
+- spec/models/concerns/spree/redemption_code_generator_spec.rb
+- spec/models/spree/line_item_spec.rb
+- spec/models/spree/order_spec.rb
+- spec/models/spree/permission_sets/virtual_gift_card_display_spec.rb
+- spec/models/spree/permission_sets/virtual_gift_card_management_spec.rb
+- spec/models/spree/store_credit_category_spec.rb
+- spec/models/spree/virtual_gift_card_spec.rb
+- spec/spec_helper.rb