spree_promotion_codes 3.0.6 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 515907c22ba20ab1d5961f3643ac22ec80d11057
-  data.tar.gz: d96150a83bc378294d26a69776deae6bb6386223
+  metadata.gz: 04239c8ac7e88097d26826b991038becf9f4da69
+  data.tar.gz: 13c944c77025b4c659ddea190e020a1f06ce94ca
 SHA512:
-  metadata.gz: a387ce046a76aac1095be3ece2442aa4d9007a9f1412de0df1120f343a600992e8764b7ce1b7cf7a36f337241481de904692c27051e1c90b37f0ef63328c5216
-  data.tar.gz: d76a4bf7843640154ca58ba4d3b6e97ad8049aefe1394d2b75e9e721382d610c94d37c685b7a60e3dce134c3a4ef312a7888c0b601bd8ce3864df586498760a9
+  metadata.gz: cb328a7dd93a8e395c34a95fe826c4920e82b134032a2ff6538b10369edea3b2722c67293d032ca16d925b285d6bff1ce116a6208cc5fdcb3ad0574e259cdf4c
+  data.tar.gz: 2954ba07f253937f8763ae5a5ad0b07fab490bacd8da28c05e6e5eb87deec44654de32a161d59545a0d4c696a6bf38637c5532476b9e7ac3001c72729c0e80ac

data/.gitignore

@@ -0,0 +1,18 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+.bundle
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+
+rvm:
+  - 2.2.3
+  - 2.3.0
+
+sudo: false
+
+cache: bundler
+
+before_script:
+  - sh -e /etc/init.d/xvfb start
+  - bundle exec rake test_app
+
+after_script:
+  - bundle exec codeclimate-test-reporter
+
+script:
+  - export DISPLAY=:99.0
+  - bundle exec rspec spec
+
+addons:
+  code_climate:
+    repo_token: d57b42229ebd9950493107b4ea3cedc95e4f3e9a3ce011f9e8c006486be960de

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'spree',             github: 'spree/spree',              branch: '3-1-stable'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise',  branch: '3-1-stable'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2016 [name of plugin creator]
+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,42 @@
+SpreePromotionCodes
+===================
+<a href="https://codeclimate.com/github/epergo/spree_promotion_codes"><img src="https://codeclimate.com/github/epergo/spree_promotion_codes/badges/gpa.svg"
+/></a>
+<a
+href="https://codeclimate.com/github/epergo/spree_promotion_codes/coverage"><img
+src="https://codeclimate.com/github/epergo/spree_promotion_codes/badges/coverage.svg"
+/></a>
+<a href="https://travis-ci.org/epergo/spree_promotion_codes"><img
+src="https://travis-ci.org/epergo/spree_promotion_codes.svg?branch=master"/></a>
+
+Spree extension to allow promotions to be reedemed with more than 1 code
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+  ```ruby
+  gem 'spree_promotion_codes', github: 'epergo/spree_promotion_codes', branch: '3-0-stable'
+  ```
+2. Install the gem using Bundler:
+  ```ruby
+  bundle install
+  ```
+
+3. Copy & run migrations
+  ```ruby
+  bundle exec rails g spree_promotion_codes:install
+  ```
+
+4. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_promotion_codes'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/controllers/spree/admin/promotion_codes_controller.rb

@@ -0,0 +1,7 @@
+module Spree
+  module Admin
+    class PromotionCodesController < ResourceController
+      belongs_to 'spree/promotion'
+    end
+  end
+end

data/app/helpers/spree/admin/promotion_codes_helper.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Admin
+    module PromotionCodesHelper
+      def humanize_disabled(disabled)
+        if disabled
+          Spree.t('promotion_code.disabled')
+        else
+          Spree.t('promotion_code.not_disabled')
+        end
+      end
+    end
+  end
+end

data/app/models/spree.rb

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

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,36 @@
+Spree::Order.class_eval do
+  has_many :order_promotions
+  has_many :promotions, through: :order_promotions
+
+  def self.ransackable_scopes(auth_object = nil)
+    %w(with_promotion_code)
+  end
+
+  scope :with_promotion_code, -> (promotion_code) do
+    promotion_code = Spree::PromotionCode.find_by(code: promotion_code.downcase)
+
+    return unless promotion_code
+
+    promo_actions_ids = promotion_code.promotion.actions.pluck('spree_promotion_actions.id')
+    orders_ids = Spree::Adjustment
+      .eligible
+      .where(source_id: promo_actions_ids)
+      .pluck(:order_id)
+
+    where(id: orders_ids)
+  end
+
+  # List all codes used in this order
+  def codes_used
+    # Promotion actions applied in this order
+    promo_actions_ids = Spree::Adjustment.eligible.where(order_id: id).pluck(:source_id)
+    promos_ids = Spree::Promotion.joins(:promotion_actions).where('spree_promotion_actions.id IN (?)', promo_actions_ids).pluck('spree_promotions.id')
+
+    codes_used_ids = Spree::OrdersPromotion.where(promotion_id: promos_ids, order_id: id).pluck(:promotion_code_id)
+    Spree::PromotionCode.where(id: codes_used_ids).pluck(:code).join(', ')
+  end
+
+  def self.orders_promotions_table
+    reflect_on_association(:orders_promotions).table_name
+  end
+end

data/app/models/spree/order_promotion.rb

@@ -0,0 +1,4 @@
+class Spree::OrderPromotion < Spree::Base
+  belongs_to :order
+  belongs_to :promotion
+end

data/app/models/spree/promotion_code.rb

@@ -0,0 +1,43 @@
+module Spree
+  class PromotionCode < Spree::Base
+    belongs_to :promotion
+
+    validates :code, uniqueness: true
+
+    def times_used
+      # Orders that have used the code
+      orders_ids = Spree::OrdersPromotion.where(promotion_code_id: id).pluck(:order_id)
+
+      # Promotion Actions associated with the promotion
+      promotion_actions_ids = promotion.actions.pluck('spree_promotion_actions.id')
+
+      # Eligible adjustments resulting of the promotion actions and only in orders
+      # that have used the code
+      Spree::Adjustment.eligible.where(source_id: promotion_actions_ids, order_id: orders_ids)
+    end
+
+    def times_used_count
+      times_used.count
+    end
+
+    # Orders that have used this code
+    def orders
+      order_ids = times_used.pluck(:order_id)
+      Spree::Order.where(id: order_ids)
+    end
+
+    # Check if a code has been used less than his limit
+    def limit_exceeded?
+      usage_limit.present? && usage_limit <= times_used_count
+    end
+
+    class << self
+      def usage_limit_exceeded?(code)
+        return false if code.nil?
+
+        pc = find_by!(code: code.downcase)
+        pc.limit_exceeded?
+      end
+    end
+  end
+end

data/app/models/spree/promotion_decorator.rb

@@ -0,0 +1,71 @@
+# app/models/spree/promotion.rb
+Spree::Promotion.class_eval do
+  has_many :promotion_codes, dependent: :destroy
+  alias_method :codes, :promotion_codes
+
+  has_many :order_promotions
+  has_many :orders, through: :order_promotions
+
+  scope :coupons,    -> { where("id IN (SELECT DISTINCT(promotion_id) FROM #{promotion_codes_table})") }
+  scope :no_coupons, -> { where("id NOT IN (SELECT DISTINCT(promotion_id) FROM #{promotion_codes_table})") }
+
+  self.whitelisted_ransackable_attributes = %w(path promotion_category_id)
+
+  def self.promotion_codes_table
+    reflect_on_association(:promotion_codes).table_name
+  end
+
+  # Returns the promotion associated with the coupon code specified
+  # Doesn't return the promotion if the code is disabled
+  def self.with_coupon_code(coupon_code)
+    joins("INNER JOIN #{promotion_codes_table} ON #{promotion_codes_table}.promotion_id = #{table_name}.id")
+      .where("#{promotion_codes_table}.code = ? AND #{promotion_codes_table}.disabled = ?", coupon_code.strip.downcase, false)
+      .first
+  end
+
+  def activate(payload)
+    order = payload[:order]
+    return unless self.class.order_activatable?(order)
+
+    payload[:promotion] = self
+
+    # Track results from actions to see if any action has been taken.
+    # Actions should return nil/false if no action has been taken.
+    # If an action returns true, then an action has been taken.
+    results = actions.map do |action|
+      action.perform(payload)
+    end
+    # If an action has been taken, report back to whatever activated this promotion.
+    action_taken = results.include?(true)
+
+    if action_taken
+      # Connect to the order
+      # Create the join_table entry
+      # If the promotion has been unlocked thanks to a code, add the
+      # code to the entry
+
+      codes_downcase = codes.map { |pc| pc.code.downcase }
+      new_orders_promotions = Spree::OrderPromotion.new(promotion_id: id, order_id: order.id)
+      if order.coupon_code
+        # User has entered a coupon code
+        # Check if this promotion includes the code
+        if codes_downcase.include?(order.coupon_code)
+          new_orders_promotions.promotion_code_id = Spree::PromotionCode.find_by(code: order.coupon_code).id
+        end
+      end
+
+      new_orders_promotions.save
+      self.save
+    end
+
+    return action_taken
+  end
+
+  private
+
+  def normalize_blank_values
+    %w(path).each do |column|
+      self[column] = nil if self[column].blank?
+    end
+  end
+end

data/app/models/spree/promotion_handler/cart_decorator.rb

@@ -0,0 +1,24 @@
+Spree::PromotionHandler::Cart.class_eval do
+  private
+
+  def promotions
+    # AR cannot bind raw ASTs to prepared statements. There always must be a manager around.
+    # Also Postgresql requires an aliased table for `SELECT * FROM (subexpression) AS alias`.
+    # And Sqlite3 cannot work on outher parenthesis from `(left UNION right)`.
+    # So this construct makes both happy.
+    select = Arel::SelectManager.new(
+      Spree::Promotion,
+      Spree::Promotion.arel_table.create_table_alias(
+        order.promotions.active.union(Spree::Promotion.active.no_coupons.where(path: nil)),
+        Spree::Promotion.table_name
+      )
+    )
+    select.project(Arel.star)
+
+    Spree::Promotion.find_by_sql(
+      select,
+      order.promotions.bind_values
+    )
+  end
+end
+

data/app/models/spree/promotion_handler/coupon_decorator.rb

@@ -0,0 +1,52 @@
+# app/models/spree/promotion_handler/coupon_decorator.rb
+Spree::PromotionHandler::Coupon.class_eval do
+  private
+
+  def handle_present_promotion(promotion)
+    return code_usage_limit_exceeded if Spree::PromotionCode.usage_limit_exceeded?(order.coupon_code)
+    return promotion_usage_limit_exceeded if promotion.usage_limit_exceeded?(order)
+    return promotion_applied if promotion_exists_on_order?(order, promotion)
+    unless promotion.eligible?(order)
+      self.error = promotion.eligibility_errors.full_messages.first unless promotion.eligibility_errors.blank?
+      return (self.error || ineligible_for_this_order)
+    end
+
+    # If any of the actions for the promotion return `true`,
+    # then result here will also be `true`.
+    result = promotion.activate(:order => order)
+    if result
+      determine_promotion_application_result
+    else
+      set_error_code :coupon_code_unknown_error
+    end
+  end
+
+  def code_usage_limit_exceeded
+    set_error_code :coupon_code_max_usage
+  end
+
+  def determine_promotion_application_result
+    # Check for applied adjustments.
+    discount = order.all_adjustments.promotion.eligible.detect do |p|
+      p.source.promotion.codes.select { |pc| pc.code.try(:downcase) == order.coupon_code.downcase }.any?
+    end
+
+    # Check for applied line items.
+    created_line_items = promotion.actions.detect { |a| a.type == 'Spree::Promotion::Actions::CreateLineItems' }
+
+    if discount || created_line_items
+      order.update_totals
+      order.persist_totals
+      set_success_code :coupon_code_applied
+    else
+      # if the promotion exists on an order, but wasn't found above,
+      # we've already selected a better promotion
+      if order.promotions.with_coupon_code(order.coupon_code)
+        set_error_code :coupon_code_better_exists
+      else
+        # if the promotion was created after the order
+        set_error_code :coupon_code_not_found
+      end
+    end
+  end
+end

data/app/models/spree/promotion_handler/free_shipping_decorator.rb

@@ -0,0 +1,9 @@
+Spree::PromotionHandler::FreeShipping.class_eval do
+  def activate
+    promotions.each do |promotion|
+      next if promotion.codes.any? && !order_promo_ids.include?(promotion.id)
+
+      promotion.activate(order: order) if promotion.eligible?(order)
+    end
+  end
+end