solidus_abandoned_carts 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a2e2ec2737270507307d74516c2fa7644fc1fb1b0e490bdd7df68a0432cfa23
+  data.tar.gz: b97a2a34db249b495dbd10bc86efd223e99e054cc729db91ba2e90f93933ccdc
+SHA512:
+  metadata.gz: 865ffe0d16f099865a678ccd4e911724a00828623c925344e9874af7600fd0640dc038001ce7020b8fbad7cf9146d2c947244ac1ab0693d991cd7d35bbd4fc72
+  data.tar.gz: 8eb59b018c6e4a63915eeb16395c8e7194189661a77719017aaaecea6a3fb24234e1f64ffa4a65f7c07858396d2bc55af7cb397ead5124197721be3a121a2259

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014 Alessandro Lepore
+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,62 @@
+
+SolidusAbandonedCarts
+===================
+[![Build Status](https://travis-ci.org/jtapia/solidus_abandoned_carts.svg?branch=master)](https://travis-ci.org/jtapia/solidus_abandoned_carts)
+
+Take some action for abandoned (incompleted) carts.
+
+Override `Spree::Order#abandoned_cart_actions` with your logic.
+By default an email is sent, see `AbandonedCartMailer`.
+
+You have to trigger the method in some way, an example recurring ActiveJob worker
+is included.
+
+Installation
+------------
+
+Add this line to your solidus application's Gemfile:
+
+```ruby
+gem 'solidus_abandoned_carts', github: 'jtapia/solidus_abandoned_carts'
+```
+
+And then execute:
+
+```shell
+$ bundle
+$ bundle exec rails g solidus_abandoned_carts:install
+```
+
+Usage
+-----
+
+There are some preferences you can change (defaults are shown here):
+
+```ruby
+SolidusAbandonedCarts::Config.tap do |config|
+  # when an order can be marked as abandoned
+  config.abandoned_after_minutes = 1440 # 24 hours
+  # how often the sidekiq worker should run
+  config.worker_frequency_minutes = 30
+end
+```
+
+You can perform the processing of the abandoned carts at any time:
+
+```ruby
+Spree::AbandonedCartJob.perform
+```
+
+To modify the email, you just have to override `Spree.t(:abandoned_cart_subject)`
+and `app/views/spree/abandoned_cart_mailer/abandoned_cart_email.html.erb`.
+
+
+Testing
+-------
+
+Then just run the following to automatically build a dummy app if necessary and
+run the tests:
+
+```shell
+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'] = 'solidus_abandoned_carts'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/spree_abandoned_carts.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/spree_abandoned_carts.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/spree_abandoned_carts.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/spree_abandoned_carts.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/jobs/abandoned_cart_job.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Spree
+  class AbandonedCartJob < ActiveJob::Base
+    queue_as :default
+
+    def perform
+      next_run = SolidusAbandonedCarts::Config.worker_frequency_minutes
+
+      Spree::Order.abandon_not_notified.each do |order|
+        next unless order.last_for_user?
+
+        order.abandoned_cart_actions
+      end
+
+      if self.class.respond_to?(:perform_in)
+        self.class.new.perform_in(next_run.minutes) if next_run > 0
+      end
+
+      if self.class.respond_to?(:perform_later)
+        self.class.set(wait: next_run.minutes).perform_later
+      end
+    end
+  end
+end

data/app/jobs/spree/abandoned_cart_job.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Spree
+  class AbandonedCartJob < ActiveJob::Base
+    queue_as :default
+
+    def perform
+      next_run = SolidusAbandonedCarts::Config.worker_frequency_minutes
+
+      Spree::Order.abandon_not_notified.each do |order|
+        next unless order.last_for_user?
+
+        order.abandoned_cart_actions
+      end
+
+      if self.class.respond_to?(:perform_in)
+        self.class.new.perform_in(next_run.minutes) if next_run > 0
+      end
+
+      if self.class.respond_to?(:perform_later)
+        self.class.set(wait: next_run.minutes).perform_later
+      end
+    end
+  end
+end

data/app/mailers/spree/abandoned_cart_mailer.rb

@@ -0,0 +1,11 @@
+module Spree
+  class AbandonedCartMailer < BaseMailer
+    def abandoned_cart_email(order)
+      @order = order
+      @store = @order.store
+      subject = "#{@store.name} - #{Spree.t(:abandoned_cart_subject)}"
+
+      mail(to: order.email, from: from_address(@store), subject: subject) if @order.email.present?
+    end
+  end
+end

data/app/models/spree/app_configuration_decorator.rb

@@ -0,0 +1,17 @@
+require 'spree/preferences/configuration'
+
+module Spree
+  module AppConfigurationDecorator
+    def self.prepended(base)
+      # Allows providing your own Mailer for abandoned cart mailer.
+      #
+      # @!attribute [rw] abandoned_cart_mailer_class
+      # @return [ActionMailer::Base] an object that responds to "abandoned_cart_email"
+      #   (e.g. an ActionMailer with a "abandoned_cart_email" method) with the same
+      #   signature as Spree::AbandonedCartMailer.abandoned_cart_email.
+      base.class_name_attribute :abandoned_cart_mailer_class, default: 'Spree::AbandonedCartMailer'
+    end
+  end
+end
+
+Spree::AppConfiguration.prepend Spree::AppConfigurationDecorator

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,27 @@
+module Spree
+  module OrderDecorator
+    def self.prepended(base)
+      base.scope :abandoned, -> do
+        incomplete.
+        where('email IS NOT NULL')
+        where('item_count > 0').
+        where("updated_at < ?", Time.current - SolidusAbandonedCarts::Config.abandoned_after_minutes.minutes)
+      end
+
+      base.scope :abandon_not_notified, -> do
+        abandoned.where(abandoned_cart_email_sent_at: nil)
+      end
+    end
+
+    def abandoned_cart_actions
+      Spree::Config.abandoned_cart_mailer_class.abandoned_cart_email(self).deliver_now
+      touch(:abandoned_cart_email_sent_at)
+    end
+
+    def last_for_user?
+      Spree::Order.where(email: email).where('id > ?', id).none?
+    end
+  end
+end
+
+Spree::Order.prepend Spree::OrderDecorator

data/config/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+  abandoned_cart_subject: Abandoned Cart

data/config/locales/es-MX.yml

@@ -0,0 +1,3 @@
+es-MX:
+  spree:
+    abandoned_cart_subject: Orden Abandonada

data/config/locales/es.yml

@@ -0,0 +1,3 @@
+es:
+  spree:
+    abandoned_cart_subject: Orden Abandonada

data/config/locales/it.yml

@@ -0,0 +1,2 @@
+it:
+  abandoned_cart_subject: Abandoned Cart

data/config/routes.rb

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

data/db/migrate/20180712163605_add_abandoned_cart_email_sent_at_to_spree_orders.rb

@@ -0,0 +1,5 @@
+class AddAbandonedCartEmailSentAtToSpreeOrders < SolidusSupport::Migration[4.2]
+  def change
+    add_column :spree_orders, :abandoned_cart_email_sent_at, :datetime
+  end
+end

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

@@ -0,0 +1,28 @@
+module SolidusAbandonedCarts
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_abandoned_carts'
+      end
+
+      def run_migrations
+         if running_migrations?
+           run 'bundle exec rake db:migrate'
+         else
+           puts "Skiping rake db:migrate, don't forget to run it!"
+         end
+      end
+
+      private
+
+      def running_migrations?
+         options.auto_run_migrations? || begin
+           response = ask 'Would you like to run the migrations now? [Y/n]'
+           ['', 'y'].include? response.downcase
+         end
+      end
+    end
+  end
+end

data/lib/solidus_abandoned_carts.rb

@@ -0,0 +1,3 @@
+require 'solidus_core'
+require 'solidus_support'
+require 'solidus_abandoned_carts/engine'

data/lib/solidus_abandoned_carts/configuration.rb

@@ -0,0 +1,7 @@
+module SolidusAbandonedCarts
+  class Configuration < Spree::Preferences::Configuration
+    preference :abandoned_states, :array, default: [:cart, :address, :delivery, :payment, :confirm]
+    preference :abandoned_after_minutes, :integer, default: 24.hours / 1.minute
+    preference :worker_frequency_minutes, :integer, default: 30.minutes
+  end
+end

data/lib/solidus_abandoned_carts/engine.rb

@@ -0,0 +1,25 @@
+module SolidusAbandonedCarts
+  class Engine < Rails::Engine
+    isolate_namespace Spree
+    engine_name 'solidus_abandoned_carts'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'solidus_abandoned_carts.environment', before: :load_config_initializers do |app|
+      SolidusAbandonedCarts::Config = SolidusAbandonedCarts::Configuration.new
+    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/solidus_abandoned_carts/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'solidus_abandoned_carts/factories'
+end

data/lib/solidus_abandoned_carts/version.rb

@@ -0,0 +1,3 @@
+module SolidusAbandonedCarts
+  VERSION = '2.0.0'
+end

metadata

@@ -0,0 +1,304 @@
+--- !ruby/object:Gem::Specification
+name: solidus_abandoned_carts
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Jonathan Tapia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: solidus_auth_devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: solidus_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Take some action for abandoned carts
+email: jonathan.tapia@magmalabs.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/spree_abandoned_carts.js
+- app/assets/javascripts/spree/frontend/spree_abandoned_carts.js
+- app/assets/stylesheets/spree/backend/spree_abandoned_carts.css
+- app/assets/stylesheets/spree/frontend/spree_abandoned_carts.css
+- app/jobs/abandoned_cart_job.rb
+- app/jobs/spree/abandoned_cart_job.rb
+- app/mailers/spree/abandoned_cart_mailer.rb
+- app/models/spree/app_configuration_decorator.rb
+- app/models/spree/order_decorator.rb
+- app/views/spree/abandoned_cart_mailer/abandoned_cart_email.html.erb
+- config/locales/en.yml
+- config/locales/es-MX.yml
+- config/locales/es.yml
+- config/locales/it.yml
+- config/routes.rb
+- db/migrate/20180712163605_add_abandoned_cart_email_sent_at_to_spree_orders.rb
+- lib/generators/solidus_abandoned_carts/install/install_generator.rb
+- lib/solidus_abandoned_carts.rb
+- lib/solidus_abandoned_carts/configuration.rb
+- lib/solidus_abandoned_carts/engine.rb
+- lib/solidus_abandoned_carts/factories.rb
+- lib/solidus_abandoned_carts/version.rb
+homepage: http://github.com/jtapia/solidus_abandoned_carts
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Take some action for abandoned carts
+test_files: []