spree_active_sale 1.0.6

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2013 Surya Tripathi
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,100 @@
+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 <tt>Spree::ActiveSale::Event</tt> like: <tt>live</tt>, <tt>active</tt>, <tt>live_active</tt>, <tt>hidden</tt>, <tt>live_active_and_hidden</tt>, <tt>upcoming_events</tt>, <tt>starting_today</tt>, <tt>ending_today</tt>.
+* <tt>Spree::ActiveSale::Event.live</tt> lists all sale events which are currently and suppose to be running.
+* <tt>Spree::ActiveSale::Event.active</tt> lists all sale events which are active, they may or may not be live. You can do <tt>Spree::ActiveSale::Event.active(false)</tt> to list all inactive sale events.
+* <tt>Spree::ActiveSale::Event.live_active</tt> lists all sale events which are live and active, which includes hidden sales, too. Doing <tt>Spree::ActiveSale::Event.live_active(false)</tt> will list all sale events which live and not active.
+* <tt>Spree::ActiveSale::Event.hidden</tt> lists all sale events which are hidden, they may or may not be live. You can do <tt>Spree::ActiveSale::Event.hidden(false)</tt> to list sale events which are not hidden.
+* <tt>Spree::ActiveSale::Event.live_active_and_hidden</tt> lists all sale events which are live, active, and hidden. <tt>Spree::ActiveSale::Event.live_active_and_hidden(:active => false, :hidden => false)</tt> will list inactive and not hidden sale events, you can change values accordingly.
+* <tt>Spree::ActiveSale::Event.upcoming_events</tt> lists all scheduled sale events which are going to be live in future.
+* <tt>Spree::ActiveSale::Event.starting_today</tt> lists all sale events which are going to or have start today.
+* <tt>Spree::ActiveSale::Event.ending_today</tt> lists all sale events which are going to expire today.
+* <tt>Spree::ActiveSale::Event.is_live?(instance)</tt> 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.
+
+
+[![Dependency Status](https://gemnasium.com/suryart/spree_active_sale.png)](https://gemnasium.com/suryart/spree_active_sale)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/suryart/spree_active_sale)
+[![Build Status](https://travis-ci.org/suryart/spree_active_sale.png?branch=1-0-5)](https://travis-ci.org/suryart/spree_active_sale)
+
+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
+============
+
+1. [Fork](https://help.github.com/articles/fork-a-repo) the project
+2. 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.
+3. Perform a [pull request](https://help.github.com/articles/using-pull-requests) 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.
+
+
+License
+---------
+Copyright (c) 2013 Surya Tripathi, released under the New BSD License

data/app/assets/javascripts/admin/spree_active_sale.js

@@ -0,0 +1 @@
+//= require admin/spree_core

data/app/assets/javascripts/store/spree_active_sale.js

@@ -0,0 +1 @@
+//= require store/spree_core

data/app/assets/stylesheets/admin/spree_active_sale.css

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_core
+*/

data/app/assets/stylesheets/store/spree_active_sale.css

@@ -0,0 +1,3 @@
+/*
+ *= require store/spree_core
+*/

data/app/controllers/products_controller_decorator.rb

@@ -0,0 +1,25 @@
+module Spree
+  ProductsController.class_eval do
+    HTTP_REFERER_REGEXP = /^https?:\/\/[^\/]+\/t\/([a-z0-9\-\/]+)$/ unless defined? HTTP_REFERER_REGEXP
+
+    def show
+      @product = Spree::Product.active.find_by_permalink!(params[:id])
+      return unless @product
+
+      if Spree::ActiveSale::Event.is_live? @product
+        @variants = Spree::Variant.active.includes([:option_values, :images]).where(:product_id => @product.id)
+        @product_properties = Spree::ProductProperty.includes(:property).where(:product_id => @product.id)
+
+        referer = request.env['HTTP_REFERER']
+
+        if referer && referer.match(HTTP_REFERER_REGEXP)
+          @taxon = Spree::Taxon.find_by_permalink($1)
+        end
+
+        respond_with(@product)
+      else
+        redirect_to root_url, :error => t('spree.active_sale.event.flash.error')
+      end
+    end
+  end
+end

data/app/controllers/taxons_controller_decorator.rb

@@ -0,0 +1,18 @@
+module Spree
+  TaxonsController.class_eval do
+
+    def show
+      @taxon = Spree::Taxon.find_by_permalink!(params[:id])
+      return unless @taxon
+
+      if Spree::ActiveSale::Event.is_live? @taxon
+        @searcher = Spree::Config.searcher_class.new(params.merge(:taxon => @taxon.id))
+        @products = @searcher.retrieve_products
+
+        respond_with(@taxon)
+      else
+        redirect_to root_url, :error => t('spree.active_sale.event.flash.error')
+      end
+    end
+  end
+end

data/app/models/spree/active_sale/event.rb

@@ -0,0 +1,57 @@
+# EVENTS
+# Events represent an entity for active sale in a flash sale/ daily deal.
+# There can be many events for one sale.
+#
+module Spree
+  class ActiveSale::Event < ActiveRecord::Base
+    belongs_to :eventable, :polymorphic => true
+    belongs_to :active_sale
+
+    attr_accessible :description, :end_date, :eventable_id, :eventable_type, :is_active, :is_hidden, :name, :permalink, :active_sale_id, :start_date
+
+    validates :name, :presence => true
+    validates :permalink, :presence => true
+    validates :start_date, :presence => true
+    validates :end_date, :presence => true
+    validates :active_sale_id, :presence => true
+    validate  :validate_start_and_end_date
+
+    scope :live, lambda { where("(start_date <= :start_date AND end_date >= :end_date) OR is_permanent = :is_permanent", { :start_date => Time.now, :end_date => Time.now, :is_permanent => true }) }
+    scope :active, lambda { |*args| where(:is_active => valid_argument(args)) }
+    scope :hidden, lambda { |*args| where(:is_hidden => valid_argument(args)) }
+    scope :live_active, lambda { |*args| self.live.active(valid_argument(args)) }
+    scope :live_active_and_hidden, lambda { |*args| 
+                            args = [{}] if [nil, true, false].include? args.first
+                            self.live.active(valid_argument([args.first[:active]])).hidden(valid_argument([args.first[:hidden]])) 
+                          }
+    scope :upcoming_events, lambda { where("start_date > :start_date", { :start_date => Time.now }) }
+    scope :starting_today, lambda { where(:start_date => Time.now.at_beginning_of_day..Time.now.end_of_day) }
+    scope :ending_today, lambda { where(:end_date => Time.now.at_beginning_of_day..Time.now.end_of_day) }
+
+    def validate_start_and_end_date
+      errors.add(:start_date, I18n.t('spree.active_sale.event.validation.errors.invalid_dates')) if (self.start_date and self.end_date) and (self.start_date > self.end_date)
+    end
+
+    def live?
+      current_time = Time.now
+      (self.start_date <= current_time and self.end_date >= current_time) or self.is_permanent?
+    end
+
+    def live_and_active?
+      self.live? and self.is_active?
+    end
+
+    # Spree::ActiveSale::Event.is_live? method 
+    # should only/ always represents live and active events and not just live events.
+    def self.is_live? object
+      object_class_name = object.class.name
+      return (object.live_and_active?) if object_class_name == self.name
+      %w(Spree::Product Spree::Variant Spree::Taxon).include?(object_class_name) ? object.live? : false
+    end
+
+    private
+      def self.valid_argument args
+        (args.first == nil || args.first == true)
+      end
+  end
+end

data/app/models/spree/active_sale.rb

@@ -0,0 +1,16 @@
+# ActiveSales
+# Active sales represent an entity for one sale at a time.
+# For example: 'January 2013' sale, which can have many sale events in it.
+#
+module Spree
+  class ActiveSale < ActiveRecord::Base
+    has_many :events, :class_name => "Spree::ActiveSale::Event"
+    belongs_to :taxon, :class_name => "Spree::Taxon"
+
+    attr_accessible :name
+
+    validates :name, :presence => true
+
+    accepts_nested_attributes_for :events, :allow_destroy => true, :reject_if => lambda { |attrs| attrs.all? { |k, v| v.blank? } }
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,11 @@
+Spree::Product.class_eval do
+  has_many :active_sale_events, :as => :eventable, :class_name => "Spree::ActiveSale::Event"
+
+  def find_live_taxons
+    Spree::ActiveSale::Event.live_active.where(:eventable_type => "Spree::Taxon", :eventable_id => self.taxons.map(&:id))
+  end
+
+  def live?
+    !self.active_sale_events.detect{ |event| (event.live_and_active?) }.nil? || !self.find_live_taxons.blank?
+  end
+end

data/app/models/spree/taxon_decorator.rb

@@ -0,0 +1,7 @@
+Spree::Taxon.class_eval do
+  has_many :active_sale_events, :as => :eventable, :class_name => "Spree::ActiveSale::Event"
+
+  def live?
+    !self.active_sale_events.detect{ |event| (event.live_and_active?) }.nil?
+  end
+end

data/app/models/spree/variant_decorator.rb

@@ -0,0 +1,7 @@
+Spree::Variant.class_eval do
+  has_many :active_sale_events, :as => :eventable, :class_name => "Spree::ActiveSale::Event"
+
+  def live?
+    !self.active_sale_events.detect{ |event| (event.live_and_active?) }.nil? || self.product.live?
+  end
+end

data/app/models/spree.rb

@@ -0,0 +1,5 @@
+module Spree
+  def self.table_name_prefix
+    'spree_'
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,12 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  spree:
+    active_sale:
+      event:
+        validation:
+          errors:
+            invalid_dates: "Event's start date can not be greater than end date."
+        flash:
+          error: "The page you are looking for is no longer available."

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.routes.draw do
+  # Add this extension's routes here
+end

data/db/migrate/20130119154826_create_active_sales.rb

@@ -0,0 +1,9 @@
+class CreateActiveSales < ActiveRecord::Migration
+  def change
+    create_table :spree_active_sales do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130119182020_create_events.rb

@@ -0,0 +1,19 @@
+class CreateEvents < ActiveRecord::Migration
+  def change
+    create_table :spree_active_sale_events do |t|
+      t.string :name
+      t.text :description
+      t.string :permalink
+      t.datetime :start_date
+      t.datetime :end_date
+      t.boolean :is_active, default: true
+      t.boolean :is_hidden, default: false
+      t.boolean :is_permanent, default: false
+      t.integer :eventable_id
+      t.string :eventable_type
+      t.integer :active_sale_id
+
+      t.timestamps
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module SpreeActiveSale
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def add_javascripts
+        append_file 'app/assets/javascripts/store/all.js', "//= require store/spree_active_sale\n"
+        append_file 'app/assets/javascripts/admin/all.js', "//= require admin/spree_active_sale\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'app/assets/stylesheets/store/all.css', " *= require store/spree_active_sale\n", :before => /\*\//, :verbose => true
+        inject_into_file 'app/assets/stylesheets/admin/all.css', " *= require admin/spree_active_sale\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_active_sale'
+      end
+
+      def run_migrations
+         res = ask 'Would you like to run the migrations now? [Y/n]'
+         if res == '' || res.downcase == 'y'
+           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/spree_active_sale/engine.rb

@@ -0,0 +1,22 @@
+module SpreeActiveSale
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_active_sale'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    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_active_sale.rb

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

data/lib/tasks/spree_active_sale.rake

@@ -0,0 +1,9 @@
+namespace :spree do
+  namespace :active_sale do
+    desc "Create admin username and password"
+    task :create => :environment do
+      require File.join(File.dirname(__FILE__), '..', '..', 'db', 'default', 'users.rb')
+      puts "Done!"
+    end
+  end
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: spree_active_sale
+version: !ruby/object:Gem::Version
+  version: 1.0.6
+  prerelease: 
+platform: ruby
+authors:
+- Surya Tripathi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 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.
+email: raj.surya19@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- app/models/spree.rb
+- app/models/spree/product_decorator.rb
+- app/models/spree/active_sale/event.rb
+- app/models/spree/taxon_decorator.rb
+- app/models/spree/variant_decorator.rb
+- app/models/spree/active_sale.rb
+- app/assets/stylesheets/admin/spree_active_sale.css
+- app/assets/stylesheets/store/spree_active_sale.css
+- app/assets/javascripts/admin/spree_active_sale.js
+- app/assets/javascripts/store/spree_active_sale.js
+- app/controllers/products_controller_decorator.rb
+- app/controllers/taxons_controller_decorator.rb
+- config/routes.rb
+- config/locales/en.yml
+- lib/tasks/spree_active_sale.rake
+- lib/generators/spree_active_sale/install/install_generator.rb
+- lib/spree_active_sale/engine.rb
+- lib/spree_active_sale.rb
+- db/migrate/20130119154826_create_active_sales.rb
+- db/migrate/20130119182020_create_events.rb
+homepage: https://github.com/suryart/spree_active_sale
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Spree Active Sale to handle flash sales/ daily deals behavior for spree.
+test_files: []