piggybak_coupons 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,5 @@
+= PiggybakCoupons
+
+Coupon support for Piggybak. Includes types %, $, and freeshipping. Coupons have a specified amount (tied to % and $ use), a minimum cart total, expiration date, and number of uses.
+
+CanCan access must be updated to allow admin access to view coupons.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PiggybakCoupons'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/piggybak_coupons/piggybak_coupons.js

@@ -0,0 +1,58 @@
+$(function() {
+	$('#shipping select').change(function() {
+		piggybak_coupons.apply_coupon(false);
+		return false;		
+	});
+	$('#apply_coupon').click(function() {
+		piggybak_coupons.apply_coupon(false);
+		return false;		
+	});
+	$('#submit input').click(function() {
+		piggybak_coupons.apply_coupon(true);
+		return false;
+	});
+	setTimeout(function() {
+		if($('#coupon_code').val() != '') {
+			piggybak_coupons.apply_coupon(false);
+		}
+	}, 500);
+});
+
+var piggybak_coupons = {
+	apply_coupon: function(on_submit) {
+		$('#coupon input[type=hidden]').remove();
+		$('#coupon_response').hide();
+		$.ajax({
+			url: coupon_lookup,
+			cached: false,
+			data: {
+				code: $('#coupon_code').val(),
+				shipcost: $('#shipping_total').html().replace(/^\$/, '')
+			},
+			dataType: "JSON",
+			success: function(data) {
+				if(data.valid_coupon) {
+					var el1 = $('<input>').attr('type', 'hidden').attr('name', 'piggybak_order[line_items_attributes][2][line_item_type]').val('coupon_application');
+					var el2 = $('<input>').attr('type', 'hidden').attr('name', 'piggybak_order[line_items_attributes][2][coupon_application_attributes][code]').val($('#coupon_code').val());
+					$('#coupon').append(el1);
+					$('#coupon').append(el2);
+					$('#coupon_response').html('Coupon successfully applied to order.');
+					$('#coupon_application_total').html('-$' + (-1*parseFloat(data.amount)).toFixed(2));
+					$('#coupon_application_row').show();
+					piggybak.update_totals();
+				} else {
+					$('#coupon_response').html(data.message).show();
+					$('#coupon_application_total').html('$0.00');
+					$('#coupon_application_row').hide();
+					piggybak.update_totals();
+				}
+				if(on_submit) {
+					$('#new_piggybak_order').submit();
+				}
+			},
+			error: function() {
+				//do nothing right now
+			}
+		});
+	}	
+};

data/app/assets/stylesheets/piggybak_coupons/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/piggybak_coupons/coupon_controller.rb

@@ -0,0 +1,14 @@
+module PiggybakCoupons
+  class CouponController < ApplicationController
+    def apply
+      cart = Piggybak::Cart.new(request.cookies["cart"])
+      valid_coupon = ::PiggybakCoupons::Coupon.valid_coupon(params[:code], cart, true)
+      if valid_coupon.is_a?(::PiggybakCoupons::Coupon)
+        amount = ::PiggybakCoupons::Coupon.apply_discount(params[:code], cart, params[:shipcost])
+        render :json => { :valid_coupon => true, :amount => amount }
+      else
+        render :json => { :valid_coupon => false, :message => valid_coupon }
+      end
+    end
+  end
+end

data/app/models/piggybak_coupons/coupon.rb

@@ -0,0 +1,85 @@
+module PiggybakCoupons
+  class Coupon < ActiveRecord::Base
+    self.table_name = 'coupons'
+
+    has_many :coupon_applications
+
+    attr_accessor :coupon_type, :application_detail
+    attr_accessible :code, :amount, :discount_type, :min_cart_total, :expiration_date, :allowed_applications
+
+    validates_presence_of :code, :amount, :discount_type, :min_cart_total, :expiration_date, :allowed_applications
+    validates_uniqueness_of :code
+    validates_numericality_of :amount, :greater_than_or_equal_to => 0
+    validates_numericality_of :min_cart_total, :greater_than_or_equal_to => 0
+    validates_numericality_of :allowed_applications, :greater_than_or_equal_to => 0
+    validate :validate_dollar_discount
+
+    def validate_dollar_discount
+      if self.discount_type == "$" && self.amount > self.min_cart_total
+        self.errors.add(:min_cart_total, "Minimum cart total must be greater than amount for dollar discount.")
+      end
+    end
+
+    def coupon_type
+      if self.discount_type == "ship"
+        return "free shipping"
+      elsif self.discount_type == "%"
+        return "#{self.amount}#{self.discount_type}"
+      elsif self.discount_type == "$"
+        return "#{self.discount_type}#{sprintf("%.2f", self.amount)}"
+      end
+    end
+
+    def discount_type_enum 
+      [['Percent', '%'], ['Dollar', '$'], ['Free Shipping', 'ship']]
+    end
+
+    def application_detail
+      "#{self.coupon_applications.size} of #{self.allowed_applications} allowed uses applied"
+    end
+
+    def self.valid_coupon(code, object, already_applied)
+      # First check
+      coupon = Coupon.find_by_code(code)
+      return "Invalid coupon code." if coupon.nil?
+
+      # Expiration date check
+      return "Expired coupon." if coupon.expiration_date < Date.today
+
+      # Min cart total check
+      return "Order does not meet minimum total for coupon." if object.subtotal < coupon.min_cart_total.to_f
+
+      # Allowed applications check 
+      return "Coupon has already been used #{coupon.allowed_applications} times." if !already_applied && (coupon.coupon_applications.size >= coupon.allowed_applications)
+
+      if object.is_a?(Piggybak::Order) && coupon.discount_type == "ship"
+        ship_line_item = object.line_items.detect { |li| li.line_item_type == "shipment" }
+        return "No shipping on this order." if !ship_line_item
+      end 
+      coupon
+    end
+     
+    def self.apply_discount(code, object, shipcost = 0.0)
+      coupon = Coupon.find_by_code(code)
+      return 0 if coupon.nil?
+ 
+      # $ or % discount_type discount   
+      if coupon.discount_type == "$"
+        return -1*coupon.amount
+      elsif coupon.discount_type == "%"
+        return (-1.to_f*(coupon.amount/100)*object.subtotal).to_c
+      elsif coupon.discount_type == "ship"
+        if object.is_a?(Piggybak::Order)
+          ship_line_item = object.line_items.detect { |li| li.line_item_type == "shipment" }
+          if ship_line_item
+            return -1*ship_line_item.price
+          else
+            return 0.00
+          end
+        elsif object.is_a?(Piggybak::Cart)
+          return -1*shipcost.to_f
+        end
+      end
+    end   
+  end
+end

data/app/models/piggybak_coupons/coupon_application.rb

@@ -0,0 +1,24 @@
+module PiggybakCoupons
+  class CouponApplication < ActiveRecord::Base
+    # TODO: figure out how to avoid this
+    set_table_name 'coupon_applications'
+
+    belongs_to :coupon
+    belongs_to :line_item, :class_name => "::Piggybak::LineItem", :dependent => :destroy
+
+    attr_accessor :code, :order
+    attr_accessible :line_item_id, :coupon_id, :code
+
+    validate :validate_coupon
+    def validate_coupon
+      if self.new_record?
+        valid_coupon = Coupon.valid_coupon(self.code, self.order, false)
+        if valid_coupon.is_a?(::PiggybakCoupons::Coupon)
+          self.coupon_id = valid_coupon.id
+        else
+          self.errors.add(:code, valid_coupon)
+        end
+      end
+    end
+  end
+end

data/app/views/layouts/piggybak_coupons/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PiggybakCoupons</title>
+  <%= stylesheet_link_tag    "piggybak_coupons/application", :media => "all" %>
+  <%= javascript_include_tag "piggybak_coupons/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/piggybak_coupons/_apply_coupon.html.erb

@@ -0,0 +1,11 @@
+<%= javascript_include_tag "piggybak_coupons/piggybak_coupons" %>
+
+<div id="piggybak_coupon_apply_box">
+<div id="coupon_response" style="display:none;"></div>
+<input type="text" name="piggybak_coupon_code" id="coupon_code" value="<%= params.has_key?(:piggybak_coupon_code) ? params[:piggybak_coupon_code] : '' %>" />
+<input type="submit" value="Apply Coupon" id="apply_coupon" />
+</div>
+
+<script type="text/javascript">
+var coupon_lookup = "<%= piggybak_coupons.apply_coupon_url %>";
+</script>

data/config/routes.rb

@@ -0,0 +1,3 @@
+PiggybakCoupons::Engine.routes.draw do
+  match "/apply_coupon" => "coupon#apply"
+end

data/db/migrate/20121012220537_piggybak_coupons_setup.rb

@@ -0,0 +1,21 @@
+class PiggybakCouponsSetup < ActiveRecord::Migration
+  def up
+    create_table :coupons do |t|
+      t.string :code, :null => false
+      t.decimal :amount, :null => false
+      t.string :discount_type, :null => false
+      t.decimal :min_cart_total, :null => false
+      t.date :expiration_date
+      t.integer :allowed_applications
+    end
+    create_table :coupon_applications do |t|
+      t.references :line_item
+      t.references :coupon
+    end
+  end
+
+  def down
+    drop_table :coupons    
+    drop_table :coupon_applications
+  end
+end

data/lib/piggybak_coupons/engine.rb

@@ -0,0 +1,72 @@
+require 'piggybak_coupons/line_item_decorator'
+
+module PiggybakCoupons
+  class Engine < ::Rails::Engine
+    isolate_namespace PiggybakCoupons
+
+    config.to_prepare do
+      Piggybak::LineItem.send(:include, ::PiggybakCoupons::LineItemDecorator)
+    end
+
+    config.before_initialize do
+      Piggybak.config do |config|
+        config.line_item_types[:coupon_application] = { :visible => true,
+                                                        :nested_attrs => true,
+                                                        :fields => ["coupon_application"],
+                                                        :allow_destroy => true,
+                                                        :class_name => "::PiggybakCoupons::CouponApplication",
+                                                        :display_in_cart => "Discount"
+                                                      } 
+      end
+    end
+
+    initializer "piggybak_coupons.precompile_hook" do |app|
+      app.config.assets.precompile += ['piggybak_coupons/piggybak_coupons.js']
+    end
+
+    initializer "piggybak_coupons.rails_admin_config" do |app|
+      RailsAdmin.config do |config|
+        config.model PiggybakCoupons::Coupon do
+          navigation_label "Orders"
+          label "Coupon"
+
+          list do
+            field :code
+            field :coupon_type
+            field :min_cart_total do
+              formatted_value do
+                "$#{sprintf("%.2f", value)}"
+              end
+            end
+            field :expiration_date
+            field :application_detail
+          end
+          edit do
+            field :code
+            field :amount
+            field :discount_type, :enum 
+            field :min_cart_total
+            field :expiration_date
+            field :allowed_applications
+          end
+        end
+
+        config.model PiggybakCoupons::CouponApplication do
+          label "Coupon"
+          visible false
+
+          edit do
+            field :code do
+              read_only do
+                !bindings[:object].new_record?
+              end
+              pretty_value do
+                bindings[:object].coupon ? bindings[:object].coupon.code : ""
+              end 
+            end
+          end
+        end
+      end
+    end 
+  end
+end

data/lib/piggybak_coupons/line_item_decorator.rb

@@ -0,0 +1,21 @@
+module PiggybakCoupons
+  module LineItemDecorator
+    extend ActiveSupport::Concern
+
+    def preprocess_coupon_application
+      self.description = "Coupon"
+      self.coupon_application.order = self.order
+      if !self.new_record?
+        valid_coupon = ::PiggybakCoupons::Coupon.valid_coupon(self.coupon_application.coupon.code, self.order, true)
+        if !valid_coupon.is_a?(::PiggybakCoupons::Coupon)
+          self.mark_for_destruction
+        end
+      end
+    end
+
+    def postprocess_coupon_application
+      self.price = ::PiggybakCoupons::Coupon.apply_discount(self.coupon_application.coupon.code, self.order)
+      true
+    end 
+  end
+end

data/lib/piggybak_coupons/version.rb

@@ -0,0 +1,3 @@
+module PiggybakCoupons
+  VERSION = "0.0.1"
+end

data/lib/piggybak_coupons.rb

@@ -0,0 +1,4 @@
+require "piggybak_coupons/engine"
+
+module PiggybakCoupons
+end

data/lib/tasks/piggybak_coupons_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :piggybak_coupons do
+#   # Task goes here
+# end