spree_emails 4.3.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d8ffc8031b0c951950125c2f3aefeea1935083cd3cfefed6b7967c5db9d4af6
+  data.tar.gz: a2dcc1259ab714411bb1784cb4e959bb6009f422b8f753ed459c11e321394db3
+SHA512:
+  metadata.gz: 20c78dc6b9e58336817835c428bb17d6a2be1f1e694324f8b705d409b38867ee2f316038cb155cb20235e7c2c01246982b1d5363714629d07b83157a9fc328ab
+  data.tar.gz: c558ef5582a59dc7c8a93bdafd214496770477cf41146de69b1a86980dceedff0d00796225432356fa691480f97ea5c02e36a5451ae3e3e02ef8df0499fd36a4

data/Gemfile

@@ -0,0 +1,5 @@
+eval_gemfile('../common_spree_dependencies.rb')
+
+gem 'spree_core', path: '../core'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2007-2021, Spree Commerce, Inc., Spark Solutions Sp. z o.o. and other contributors
+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/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  ENV['LIB_NAME'] = 'spree/emails'
+  Rake::Task['common:test_app'].invoke
+end

data/app/assets/config/spree_emails_manifest.js

@@ -0,0 +1 @@
+//= link_tree ../images

data/app/helpers/spree/mail_helper.rb

@@ -0,0 +1,34 @@
+module Spree
+  module MailHelper
+    include BaseHelper
+
+    def variant_image_url(variant)
+      image = default_image_for_product_or_variant(variant)
+      image ? main_app.url_for(image.url(:small)) : 'noimage/small.png'
+    end
+
+    def name_for(order)
+      order.name || Spree.t('customer')
+    end
+
+    def store_logo
+      @store_logo ||= current_store&.mailer_logo || current_store&.logo
+    end
+
+    def default_logo
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        `MailHelper#default_logo` is deprecated and will be removed in Spree 5.0.
+        Please upload a Store logo instead
+      DEPRECATION
+
+      Spree::Config.mailer_logo || Spree::Config.logo
+    end
+
+    def logo_path
+      return default_logo unless store_logo.attached?
+      return main_app.url_for(store_logo.variant(resize: '244x104>')) if store_logo.variable?
+
+      return main_app.url_for(store_logo) if store_logo.image?
+    end
+  end
+end

data/app/mailers/spree/base_mailer.rb

@@ -0,0 +1,46 @@
+module Spree
+  class BaseMailer < ActionMailer::Base
+    helper Spree::MailHelper
+
+    def current_store
+      @current_store ||= @order&.store.presence || Spree::Dependencies.current_store_finder.constantize.new.execute
+    end
+    helper_method :current_store
+
+    def from_address
+      current_store.mail_from_address
+    end
+
+    def money(amount, currency = nil)
+      currency ||= current_store.default_currency
+      Spree::Money.new(amount, currency: currency).to_s
+    end
+    helper_method :money
+
+    def frontend_available?
+      Spree::Core::Engine.frontend_available?
+    end
+    helper_method :frontend_available?
+
+    def mail(headers = {}, &block)
+      ensure_default_action_mailer_url_host(headers[:store_url])
+      set_email_locale
+      super if Spree::Config[:send_core_emails]
+    end
+
+    private
+
+    # this ensures that ActionMailer::Base.default_url_options[:host] is always set
+    # this is only a fail-safe solution if developer didn't set this in environment files
+    # http://guides.rubyonrails.org/action_mailer_basics.html#generating-urls-in-action-mailer-views
+    def ensure_default_action_mailer_url_host(store_url = nil)
+      ActionMailer::Base.default_url_options ||= {}
+      ActionMailer::Base.default_url_options[:host] ||= store_url || current_store.url
+    end
+
+    def set_email_locale
+      locale = @order&.store&.default_locale || current_store&.default_locale
+      I18n.locale = locale if locale.present?
+    end
+  end
+end

data/app/mailers/spree/order_mailer.rb

@@ -0,0 +1,26 @@
+module Spree
+  class OrderMailer < BaseMailer
+    def confirm_email(order, resend = false)
+      @order = order.respond_to?(:id) ? order : Spree::Order.find(order)
+      current_store = @order.store
+      subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
+      subject += "#{current_store.name} #{Spree.t('order_mailer.confirm_email.subject')} ##{@order.number}"
+      mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url)
+    end
+
+    def store_owner_notification_email(order)
+      @order = order.respond_to?(:id) ? order : Spree::Order.find(order)
+      current_store = @order.store
+      subject = Spree.t('order_mailer.store_owner_notification_email.subject', store_name: current_store.name)
+      mail(to: current_store.new_order_notifications_email, from: from_address, subject: subject, store_url: current_store.url)
+    end
+
+    def cancel_email(order, resend = false)
+      @order = order.respond_to?(:id) ? order : Spree::Order.find(order)
+      current_store = @order.store
+      subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
+      subject += "#{current_store.name} #{Spree.t('order_mailer.cancel_email.subject')} ##{@order.number}"
+      mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url)
+    end
+  end
+end

data/app/mailers/spree/reimbursement_mailer.rb

@@ -0,0 +1,12 @@
+module Spree
+  class ReimbursementMailer < BaseMailer
+    def reimbursement_email(reimbursement, resend = false)
+      @reimbursement = reimbursement.respond_to?(:id) ? reimbursement : Spree::Reimbursement.find(reimbursement)
+      @order = @reimbursement.order
+      current_store = @reimbursement.store || Spree::Store.default
+      subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
+      subject += "#{current_store.name} #{Spree.t('reimbursement_mailer.reimbursement_email.subject')} ##{@order.number}"
+      mail(to: @order.email, from: current_store.mail_from_address, subject: subject, store_url: current_store.url)
+    end
+  end
+end

data/app/mailers/spree/shipment_mailer.rb

@@ -0,0 +1,12 @@
+module Spree
+  class ShipmentMailer < BaseMailer
+    def shipped_email(shipment, resend = false)
+      @shipment = shipment.respond_to?(:id) ? shipment : Spree::Shipment.find(shipment)
+      @order = @shipment.order
+      current_store = @shipment.store
+      subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
+      subject += "#{current_store.name} #{Spree.t('shipment_mailer.shipped_email.subject')} ##{@order.number}"
+      mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url)
+    end
+  end
+end

data/app/mailers/spree/test_mailer.rb

@@ -0,0 +1,8 @@
+module Spree
+  class TestMailer < BaseMailer
+    def test_email(email)
+      subject = "#{Spree::Store.default.name} #{Spree.t('test_mailer.test_email.subject')}"
+      mail(to: email, from: from_address, subject: subject)
+    end
+  end
+end

data/app/models/spree/emails/order_decorator.rb

@@ -0,0 +1,28 @@
+module Spree
+  module Emails
+    module OrderDecorator
+      def deliver_order_confirmation_email
+        OrderMailer.confirm_email(id).deliver_later
+        update_column(:confirmation_delivered, true)
+      end
+
+      # Returns true if:
+      #   1. an email address is set for new order notifications AND
+      #   2. no notification for this order has been sent yet.
+      def deliver_store_owner_order_notification_email?
+        store.new_order_notifications_email.present? && !store_owner_notification_delivered?
+      end
+
+      def deliver_store_owner_order_notification_email
+        OrderMailer.store_owner_notification_email(id).deliver_later
+        update_column(:store_owner_notification_delivered, true)
+      end
+
+      def send_cancel_email
+        OrderMailer.cancel_email(id).deliver_later
+      end
+
+      ::Spree::Order.prepend(self)
+    end
+  end
+end

data/app/models/spree/emails/reimbursement_decorator.rb

@@ -0,0 +1,11 @@
+module Spree
+  module Emails
+    module ReimbursementDecorator
+      def send_reimbursement_email
+        Spree::ReimbursementMailer.reimbursement_email(id).deliver_later
+      end
+
+      ::Spree::Reimbursement.prepend(self)
+    end
+  end
+end

data/app/models/spree/emails/shipment_handler_decorator.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Emails
+    module ShipmentHandlerDecorator
+      protected
+
+      def send_shipped_email
+        ShipmentMailer.shipped_email(@shipment.id).deliver_later
+      end
+
+      ::Spree::ShipmentHandler.prepend(self)
+    end
+  end
+end

data/app/views/layouts/spree/base_mailer.html.erb

@@ -0,0 +1,46 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+    <meta name="x-apple-disable-message-reformatting"/>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+
+    <%= render partial: 'spree/shared/base_mailer_stylesheets' %>
+  </head>
+  <body>
+    <table class="email-wrapper" width="100%" cellpadding="0" cellspacing="0" role="presentation">
+      <tr>
+        <td align="center">
+          <table class="email-content" width="100%" cellpadding="0" cellspacing="0" role="presentation">
+            <%= render partial: 'spree/shared/base_mailer_header' %>
+            <!-- Email Body -->
+            <tr>
+              <td class="email-body" width="570" cellpadding="0" cellspacing="0">
+                <table class="email-body_inner" align="center" width="570" cellpadding="0" cellspacing="0" role="presentation">
+                  <!-- Body content -->
+                  <tbody>
+                  <tr>
+                    <td class="content-cell">
+                      <div class="f-fallback">
+                        <%= yield %>
+                      </div>
+                    </td>
+                  </tr>
+                  </tbody>
+                </table>
+              </td>
+            </tr>
+            <tr>
+              <td>
+                <%= render partial: 'spree/shared/base_mailer_footer' %>
+              </td>
+            </tr>
+          </table>
+        </td>
+      </tr>
+      <tr>
+        <td height="60px">&nbsp;</td>
+      </tr>
+    </table>
+  </body>
+</html>

data/app/views/spree/order_mailer/cancel_email.html.erb

@@ -0,0 +1,24 @@
+<h1>
+  <%= Spree.t('order_mailer.cancel_email.dear_customer', name: name_for(@order)) %>
+</h1>
+<p>
+  <%= Spree.t('order_mailer.cancel_email.instructions') %>
+</p>
+
+<table class="purchase" role="presentation">
+  <tr>
+    <td>
+      <h3> <%= Spree.t('order_mailer.cancel_email.order_summary_canceled', number: @order.number) %></h3>
+    </td>
+  </tr>
+  <tr>
+    <td colspan="2">
+      <%= render 'spree/shared/purchased_items_table', line_items: @order.line_items, order: @order %>
+    </td>
+  </tr>
+</table>
+<p>
+  <%= Spree.t('order_mailer.cancel_email.thanks') %>
+  <br />
+  <%= Spree.t('order_mailer.store_team', store_name: current_store.name) %>
+</p>

data/app/views/spree/order_mailer/cancel_email.text.erb

@@ -0,0 +1,12 @@
+<%= Spree.t('order_mailer.cancel_email.dear_customer', name: name_for(@order)) %>
+
+<%= Spree.t('order_mailer.cancel_email.instructions') %>
+
+============================================================
+<%= Spree.t('order_mailer.cancel_email.order_summary_canceled', number: @order.number) %>
+============================================================
+<%= render 'spree/shared/purchased_items_table', line_items: @order.line_items, order: @order %>
+============================================================
+<%= Spree.t('order_mailer.total') %> <%= @order.display_total %>
+<%= Spree.t('order_mailer.cancel_email.thanks') %>
+<%= Spree.t('order_mailer.store_team', store_name: current_store.name) %>

data/app/views/spree/order_mailer/confirm_email.html.erb

@@ -0,0 +1,23 @@
+<h1>
+  <%= Spree.t('order_mailer.confirm_email.dear_customer', name: name_for(@order)) %>
+</h1>
+<p>
+  <%= Spree.t('order_mailer.confirm_email.instructions') %>
+</p>
+<table class="purchase" role="presentation">
+  <tr>
+    <td>
+      <h3><%= Spree.t('order_mailer.confirm_email.order_summary', number: @order.number) %></h3>
+    </td>
+  </tr>
+  <tr>
+    <td colspan="2">
+      <%= render 'spree/shared/purchased_items_table', line_items: @order.line_items, order: @order %>
+    </td>
+  </tr>
+</table>
+<p>
+  <%= Spree.t('order_mailer.confirm_email.thanks') %>
+  <br />
+  <%= Spree.t('order_mailer.store_team', store_name: current_store.name) %>
+</p>

data/app/views/spree/order_mailer/confirm_email.text.erb

@@ -0,0 +1,12 @@
+<%= Spree.t('order_mailer.confirm_email.dear_customer', name: name_for(@order)) %>
+
+<%= Spree.t('order_mailer.confirm_email.instructions') %>
+
+============================================================
+<%= Spree.t('order_mailer.confirm_email.order_summary', number: @order.number) %>
+============================================================
+<%= render 'spree/shared/purchased_items_table', line_items: @order.line_items, order: @order %>
+============================================================
+<%= Spree.t('order_mailer.total') %> <%= @order.display_total %>
+<%= Spree.t('order_mailer.confirm_email.thanks') %>
+<%= Spree.t('order_mailer.store_team', store_name: current_store.name) %>

data/app/views/spree/order_mailer/store_owner_notification_email.html.erb

@@ -0,0 +1,23 @@
+<h1>
+  <%= Spree.t('order_mailer.store_owner_notification_email.heading') %>
+</h1>
+<p>
+  <%= Spree.t('order_mailer.store_owner_notification_email.instructions') %>
+</p>
+<table class="purchase" role="presentation">
+  <tr>
+    <td>
+      <h3><%= Spree.t('order_mailer.store_owner_notification_email.order_summary', number: @order.number) %></h3>
+    </td>
+  </tr>
+  <tr>
+    <td colspan="2">
+      <%= render 'spree/shared/purchased_items_table', line_items: @order.line_items, order: @order %>
+    </td>
+  </tr>
+</table>
+<p>
+  <%= Spree.t('order_mailer.store_owner_notification_email.thanks') %>
+  <br />
+  <%= Spree.t('order_mailer.store_team', store_name: current_store.name) %>
+</p>

data/app/views/spree/order_mailer/store_owner_notification_email.text.erb

@@ -0,0 +1,12 @@
+<%= Spree.t('order_mailer.store_owner_notification_email.heading') %>
+
+<%= Spree.t('order_mailer.store_owner_notification_email.instructions') %>
+
+============================================================
+<%= Spree.t('order_mailer.store_owner_notification_email.order_summary', number: @order.number) %>
+============================================================
+<%= render 'spree/shared/purchased_items_table', line_items: @order.line_items, order: @order %>
+============================================================
+<%= Spree.t('order_mailer.total') %> <%= @order.display_total %>
+<%= Spree.t('order_mailer.store_owner_notification_email.thanks') %>
+<%= Spree.t('order_mailer.store_team', store_name: current_store.name) %>