spree_abandoned_cart 0.3.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c08326ca4ade3d5d8e45e845d5f07e1c73c73cdb
-  data.tar.gz: e090c04447dddae062626ce14ae815333a6c17ac
+  metadata.gz: 2f4079aa9bcd323157d4a9066b95c195d3f7ad11
+  data.tar.gz: 5cdbf279a566c2a57829539d77a2c02f02618c9b
 SHA512:
-  metadata.gz: cc133361977365c03ac99ce87755aced4ecf9f8d11521850c1feaa3598af0383ae370dae888b687348ca1ac4ff38d4436e476fc75d3068becdfeb03f71e63cf5
-  data.tar.gz: 6c6911eaf1d4975a8233bed796a241803d7966ff21d8091c15f7bb810e944f24c97da732ffae0d67911fa3a4504147ba32a6296e01e82fad01538b64360f81c3
+  metadata.gz: 8d6cd065fa913f3e49bfd3ef90258606d2d004ca574d0bc43872a2e5e288f712bd5e3f0be7e99f38b9d570762febc1135afabf5a65662fdf4673a02f21211721
+  data.tar.gz: 8863266e96146919e7987b2295400c2e0854ce20d937e81cb3126b1102b99171753c1fb107014f7bd2a9d0d980ec653c0038c6ed8887f907c4ffbe4305620934

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,15 @@
+image: ruby:2.4.2
+
+cache:
+  paths:
+    - cache
+
+before_script:
+  - apt-get update -q && apt-get install nodejs -yqq
+  - gem install bundler -v 1.15.4 --no-ri --no-rdoc
+  - bundle install -j $(nproc) --path cache
+
+test:
+  script:
+    - bundle exec rake test_app
+    - rspec spec

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+gem 'spree', '~> 3.6'
+gem 'spree_auth_devise', '~> 3.3'
+gem 'haml'
+gem 'haml-rails'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2013 [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,69 @@
+## SpreeAbandonedCartEmail
+
+Abandoned cart email extension. Looks for orders with line items that were created over 12 hours ago and gives them a nudge to complete.
+
+Spree Commerce versions:
+
+- Spree Core - 3.6
+- Spree Auth Devise - 3.3
+
+Use the config values below to change settings:
+
+```
+Spree::AbandonedCartEmailConfig::Config.email_timeframe_from, :integer
+Spree::AbandonedCartEmailConfig::Config.email_timeframe_to,   :integer
+
+Spree::AbandonedCartEmail::Config.email_from = "spree@example.com"
+```
+
+Override the email view to customise:
+
+```
+app/views/spree/abandoned_cart_mailer/abandoned_email.html.erb
+```
+
+Create a rake task to send the email:
+
+```
+desc "Abandoned cart emails"
+task send_abandond_cart: :environment do
+  Spree::Order.email_eligible_abandoned_email_orders
+end
+```
+Create a cronjob to run every so often to send the emails:
+
+```
+0 * * * * /bin/bash -l -c 'cd {your_application_home} && RAILS_ENV=production rake send_abandoned_cart 2>&1'
+```
+
+## Installation
+
+Add spree_abandoned_cart to your Gemfile:
+
+```ruby
+gem 'spree_abandoned_cart'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_abandoned_cart:install
+```
+
+## Testing
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_abandoned_cart/factories'
+```

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_abandoned_cart'
+  Rake::Task['extension:test_app'].invoke
+end

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

@@ -0,0 +1,35 @@
+class Spree::Admin::AbandonedOrdersController < Spree::Admin::BaseController
+  before_action :find_abandoned_cart, except: [:index ]
+  respond_to :js, only: [:index]
+
+  def index
+    params[:q] ||= {}
+
+    params_clone = params[:q].deep_dup
+
+    if params_clone[:created_at_gt].present?
+      params_clone[:created_at_gt] = Time.zone.parse(params_clone[:created_at_gt]).beginning_of_day rescue ''
+    end
+
+    if params_clone[:created_at_lt].present?
+      params_clone[:created_at_lt] = Time.zone.parse(params_clone[:created_at_lt]).end_of_day rescue ''
+    end
+
+    params_clone[:send_emails_count] = Integer(params_clone[:send_emails_count]) rescue ''
+
+    @search = Spree::AbandonedOrder.ransack(params_clone)
+    @abandoned_carts = @search.result(distinct: true).page(params[:page]).per(Spree::Config[:admin_products_per_page])
+  end
+
+  def destroy
+    @abandoned_cart.destroy
+
+    redirect_to admin_abandoned_orders_path
+  end
+
+  private
+
+  def find_abandoned_cart
+    @abandoned_cart = Spree::AbandonedOrder.find(params[:id])
+  end
+end

data/app/mailers/spree/abandoned_cart_mailer.rb

@@ -0,0 +1,20 @@
+module Spree
+  class AbandonedCartMailer < ActionMailer::Base
+    default from: Spree::AbandonedCartEmailConfig::Config.email_from
+
+    def abandoned_email(order)
+      @order = order
+      mail to: @order.email, subject: Spree.t('abandoned_cart.email.subject')
+    end
+
+    def abandoned_second_email(order)
+      @order = order
+      mail to: @order.email, subject: Spree.t('abandoned_cart.email.subject_second')
+    end
+
+    def abandoned_third_email(order)
+      @order = order
+      mail to: @order.email, subject: Spree.t('abandoned_cart.email.subject_third')
+    end
+  end
+end

data/app/models/order_decorator.rb

@@ -0,0 +1,38 @@
+Spree::Order.class_eval do
+  has_one :abandoned_order, class_name: 'Spree::AbandonedOrder', foreign_key: :spree_order_id, dependent: :destroy
+
+  def self.email_eligible_abandoned_email_orders
+    eligible_abandoned_email_orders.each {|o| o.send_abandoned_email }
+  end
+
+  def self.eligible_abandoned_email_orders
+    where('state != ?
+            AND (payment_state IS NULL OR payment_state != ?)
+            AND email is NOT NULL
+            AND abandoned_email_sent_at IS NULL
+            AND (spree_orders.created_at BETWEEN ? AND ? )',
+          'complete',
+          'paid',
+          (Time.zone.now - Spree::AbandonedCartEmailConfig::Config.email_timeframe_from),
+          (Time.zone.now - Spree::AbandonedCartEmailConfig::Config.email_timeframe_to)).joins(:line_items).distinct
+  end
+
+  def send_abandoned_email
+    # Don't send anything if the order has no line items.
+    return if line_items.empty?
+
+    Spree::AbandonedCartMailer.abandoned_email(self).deliver_now
+    mark_abandoned_email_as_sent
+    log_abandoned_cart
+  end
+
+  private
+
+  def mark_abandoned_email_as_sent
+    update_column :abandoned_email_sent_at, Time.zone.now
+  end
+
+  def log_abandoned_cart
+    Spree::AbandonedOrder.create spree_order_id: id
+  end
+end

data/app/models/order_updater_decorator.rb

@@ -0,0 +1,25 @@
+Spree::OrderUpdater.class_eval do
+
+  def update_payment_state
+    last_state = order.payment_state
+
+    if payments.present? && payments.valid.size == 0
+      order.payment_state = 'failed'
+    elsif order.state == 'canceled' && order.payment_total == 0
+      order.payment_state = 'void'
+    else
+      order.payment_state = 'balance_due' if order.outstanding_balance > 0
+      order.payment_state = 'credit_owed' if order.outstanding_balance < 0
+
+      if !order.outstanding_balance?
+        order.payment_state = 'paid'
+        # Update abandoned order after changing order status to 'paid'
+        if order.abandoned_order.present?
+          order.abandoned_order.update(order_accomplished: true, accomplished_at: Time.zone.now)
+        end
+      end
+    end
+    order.state_changed('payment') if last_state != order.payment_state
+    order.payment_state
+  end
+end

data/app/models/spree/abandoned_cart_email_configuration.rb

@@ -0,0 +1,5 @@
+class Spree::AbandonedCartEmailConfiguration < Spree::Preferences::Configuration
+  preference :email_timeframe_from, :integer
+  preference :email_timeframe_to,   :integer
+  preference :email_from,           :string
+end

data/app/models/spree/abandoned_order.rb

@@ -0,0 +1,30 @@
+class Spree::AbandonedOrder < ActiveRecord::Base
+  belongs_to :order, class_name: 'Spree::Order', foreign_key: :spree_order_id
+
+  after_create :increment_send_emails_count
+
+  def self.email_eligible_abandoned_email_orders(email_number=1)
+    eligible_orders_next_attempt(email_number).each { |abandoned_order| abandoned_order.process_abandoned_email(email_number) }
+  end
+
+  def self.eligible_orders_next_attempt(emails_count = 1, hours_period = [25, 23])
+    hours_period = [3, 1] unless ENV['RAILS_ENV'] == 'production'
+
+    where(send_emails_count: emails_count,
+          order_accomplished: false,
+          updated_at: (Time.zone.now - hours_period[0].hours)..(Time.zone.now - hours_period[1].hours))
+  end
+
+  def process_abandoned_email(email_number=1)
+    (delete && return) unless self.order.email.present?
+
+    Spree::AbandonedCartMailer.send("abandoned_#{email_number == 1 ? 'second' : 'third'}_email", self.order).deliver_now
+    increment_send_emails_count
+  end
+
+  private
+
+  def increment_send_emails_count
+    increment!(:send_emails_count)
+  end
+end

data/app/overrides/add_button_to_orders_tab_for_abandoned_index_page.rb

@@ -0,0 +1,8 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/orders/index',
+  name: 'admin_abandoned_index_button',
+  insert_before: "erb[loud]:contains('Spree.t(:new_order)')",
+  text: "<%= button_link_to Spree.t(:abandoned_index),
+         admin_abandoned_orders_path, { style: 'margin-right:5px;',
+         class: 'btn-primary', icon: 'ok', id: 'admin_abandoned_index' }%>"
+)

data/app/views/spree/abandoned_cart_mailer/abandoned_email.html.erb

@@ -0,0 +1,145 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title><%= Spree.t("abandoned_cart.email.subject") %></title>
+    <style type="text/css">
+      #outlook a{padding:0;} /* Force Outlook to provide a "view in browser" button. */
+      body{width:100% !important;} .ReadMsgBody{width:100%;} .ExternalClass{width:100%;} /* Force Hotmail to display emails at full width */
+      body{-webkit-text-size-adjust:none;} /* Prevent Webkit platforms from changing default text sizes. */
+
+      body{font-family:Arial;margin:0; padding:0;}
+      img{border:0; height:auto; line-height:100%; outline:none; text-decoration:none;}
+      table td{border-collapse:collapse;}
+      #backgroundTable{height:100% !important; margin:0; padding:0; width:100% !important;}
+
+      body, #backgroundTable{
+        background-color:#FAFAFA;
+      }
+
+      #templateContainer{
+        border: 1px solid #DDDDDD;
+        margin-top: 10px;
+        padding: 20px;
+      }
+
+      h1, .h1{
+        color:#202020;
+        display:block;
+        font-family:Arial;
+        font-size:34px;
+        font-weight:bold;
+        line-height:100%;
+        margin-top:0;
+        margin-right:0;
+        margin-bottom:10px;
+        margin-left:0;
+        text-align:left;
+      }
+
+      h2, .h2{
+        color:#202020;
+        display:block;
+        font-family:Arial;
+        font-size:30px;
+        font-weight:bold;
+        line-height:100%;
+        margin-top:0;
+        margin-right:0;
+        margin-bottom:10px;
+        margin-left:0;
+        text-align:left;
+      }
+
+      h3, .h3{
+        color:#202020;
+        display:block;
+        font-family:Arial;
+        font-size:26px;
+        font-weight:bold;
+        line-height:100%;
+        margin-top:0;
+        margin-right:0;
+        margin-bottom:10px;
+        margin-left:0;
+        text-align:left;
+      }
+
+      h4, .h4{
+        color:#202020;
+        display:block;
+        font-family:Arial;
+        font-size:22px;
+        font-weight:bold;
+        line-height:100%;
+        margin-top:0;
+        margin-right:0;
+        margin-bottom:10px;
+        margin-left:0;
+        text-align:left;
+      }
+
+      #templateContainer, .bodyContent{
+        background-color:#FFFFFF;
+      }
+
+      .bodyContent div{
+        color:#505050;
+        font-family:Arial;
+        font-size:14px;
+        line-height:150%;
+        text-align:left;
+      }
+
+      .bodyContent div a:link, .bodyContent div a:visited, /* Yahoo! Mail Override */ .bodyContent div a .yshortcuts /* Yahoo! Mail Override */{
+        color:#336699;
+        font-weight:normal;
+        text-decoration:underline;
+      }
+
+      .bodyContent img{
+        display:inline;
+        height:auto;
+      }
+
+      #items {
+        margin: 10px 0;
+      }
+    </style>
+  </head>
+  <body leftmargin="0" marginwidth="0" topmargin="0" marginheight="0" offset="0">
+    <center>
+      <table border="0" cellpadding="0" cellspacing="0" height="100%" width="100%" id="backgroundTable">
+        <tr>
+          <td align="center" valign="top">
+            <table border="0" cellpadding="0" cellspacing="0" width="600" id="templateContainer">
+              <tr>
+                <td align="center" valign="top">
+                  <table border="0" cellpadding="0" cellspacing="0" width="600" id="templateBody">
+                    <tr>
+                      <td valign="top" class="bodyContent">
+                        We noticed you still have some things in your shopping cart — if you need help with sizes or have questions, please call, email, or chat and we'll do our best.
+
+                        <table cellpadding="0" cellspacing="0" border="0" align="center" id="items">
+                          <% @order.line_items.each do |line_item| %>
+                            <% variant = line_item.variant %>
+                            <tr>
+                              <td class="cart-item-description" data-hook="cart_item_description">
+                                <strong><%= link_to variant.product.name, spree.product_url(variant.product) %></strong>
+                              </td>
+                            </tr>
+                          <% end %>
+                        </table>
+                      </td>
+                    </tr>
+                  </table>
+                </td>
+              </tr>
+            </table>
+            <br />
+          </td>
+        </tr>
+      </table>
+    </center>
+  </body>
+</html>