Welcome to Spree Active Sale

Spree Active Sale makes it easy to handle flash sale/ daily deals behavior with in a spree application. By this, you can have a variant, product, or group number of products in a taxon, attach that variant, product, or taxon to a sale event with a start and end date for scheduling. So that, your sale event will only be available between the dates given and when the sale is gone(i.e. not live), it will not be accessible at any point till you create a new one or re-schedule the same.

FEATURES

Provides a quick implementation of flash sales/ daily deals behavior by a easy scheduler a.k.a ActiveSale.
Supplies methods for class Spree::ActiveSale::Event like: live, active, live_active, hidden, live_active_and_hidden, upcoming_events, starting_today, ending_today.
Spree::ActiveSale::Event.live lists all sale events which are currently and suppose to be running.
Spree::ActiveSale::Event.active lists all sale events which are active, they may or may not be live. You can do Spree::ActiveSale::Event.active(false) to list all inactive sale events.
Spree::ActiveSale::Event.live_active lists all sale events which are live and active, which includes hidden sales, too. Doing Spree::ActiveSale::Event.live_active(false) will list all sale events which live and not active.
Spree::ActiveSale::Event.hidden lists all sale events which are hidden, they may or may not be live. You can do Spree::ActiveSale::Event.hidden(false) to list sale events which are not hidden.
Spree::ActiveSale::Event.live_active_and_hidden lists all sale events which are live, active, and hidden. Spree::ActiveSale::Event.live_active_and_hidden(:active => false, :hidden => false) will list inactive and not hidden sale events, you can change values accordingly.
Spree::ActiveSale::Event.upcoming_events lists all scheduled sale events which are going to be live in future.
Spree::ActiveSale::Event.starting_today lists all sale events which are going to or have start today.
Spree::ActiveSale::Event.ending_today lists all sale events which are going to expire today.
Spree::ActiveSale::Event.is_live?(instance) here instance can be an object of "Spree::ActiveSale::Event", "Spree::Variant", "Spree::Product", or "Spree::Taxon" class, which simply says if sale event for that instance is accessible for users or not.

INSTALLATION

In a rails application with Spree installed include the following line in your Gemfile:

To use the master branch from github:

gem 'spree_active_sale' , :git => 'git://github.com/suryart/spree_active_sale.git'
Or get it from rubygems.org:

gem 'spree_active_sale'

Then run the following commands:

$ bundle install
$ rake spree_active_sale:install 
$ rake db:migrate
$ rails s

Example

Get a taxon in rails console:

taxon = Taxon.last
Create and ActiveSale:

active_sale = Spree::ActiveSale.create name: "January 2013 sales" output:

#<Spree::ActiveSale id: 1, name: "January 2013 sales", created_at: "2013-01-20 20:33:57", updated_at: "2013-01-20 20:33:57">
Then create an Event under this sale by:

event = taxon.active_sale_event.create name: "January 2013 sales", active_sale_id: active_sale.id, start_date: Time.now, end_date: Time.now+1.day, permalink: taxon.permalink
Now try to access this taxon in browser, there should be no other taxon/ product link accessible except the one we've created just now.

TODOs

Improve testing and write more test cases.
Provide an admin interface for creating/ scheduling, managing, or re-scheduling sales.

Testing

Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.

$ bundle
$ bundle exec rake test_app
$ bundle exec rspec spec

Contributing

Fork the project
Make one or more well commented and clean commits to the repository. You can make a new branch here if you are modifying more than one part or feature.
Perform a pull request in github's web interface.

NOTE

The current version supports Spree 1.3.0 or above. Older versions of Spree are unlikely to work, so attempt at your own risk.