spree_emails 5.2.6 → 5.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e788e4c14ce0ad886f8dc2bb7a15505903a456fe2101463130c962c30230235c
-  data.tar.gz: 8116048be9d2df4bbcc8bdc8b477963d48f08d81ab96caa5034765f7f3510b85
+  metadata.gz: 914cad00ec6db8dc1e48fe5893284799492a3e23c6398a3fc219882130751bbc
+  data.tar.gz: 96ca08387036fe07dbf84ec3fd123af49e610b011df8d1d1336be6c311f1484b
 SHA512:
-  metadata.gz: f25cf724616655e31b5da9cd7d92d8f4407467af45cd2702b9bdd74d2c1d8a2be5accdb0cf5461b866eedb9923523d3b48a306abf078243d2500596f012ba4ba
-  data.tar.gz: b6dbfa36db3c67d93a7c3cc433091ed19123469d9e505c02a4928a3dd93077995d9feebd213da21255f5b34141be3007cd4d9677599a2ef77483e1d344fbf739
+  metadata.gz: 4338a16b2c8681ce2cfd0a55c5a22faa22837ddf5dba0ac1cce16a613138722c3455085264d43598040781e7305e5daf0d3ab8cbfb682ab6eb21e885c243020b
+  data.tar.gz: dd3fe763c52d4d79f90cd8629d0d6f758eff9cb4169a19acb4a0b759ada15f0262acf952fe193e22437088858652f7c8575133dd946e5e908d13dff149bf0a12

data/Rakefile

@@ -11,5 +11,7 @@ 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
+  Rake::Task['common:test_app'].execute(
+    css: true
+  )
 end

data/app/subscribers/spree/order_email_subscriber.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Spree
+  class OrderEmailSubscriber < Spree::Subscriber
+    subscribes_to 'order.completed', 'order.canceled', 'order.resend_confirmation_email'
+
+    on 'order.completed', :send_confirmation_email
+    on 'order.canceled', :send_cancel_email
+    on 'order.resend_confirmation_email', :resend_confirmation_email
+
+    private
+
+    def send_confirmation_email(event)
+      order = find_order(event)
+      return unless order
+      return if order.confirmation_delivered?
+
+      store = order.store
+      return unless store.prefers_send_consumer_transactional_emails?
+
+      OrderMailer.confirm_email(order.id).deliver_later
+      order.update_column(:confirmation_delivered, true)
+
+      send_store_owner_notification(order) if should_notify_store_owner?(order)
+    end
+
+    def resend_confirmation_email(event)
+      order = find_order(event)
+      return unless order
+
+      store = order.store
+      return unless store.prefers_send_consumer_transactional_emails?
+
+      OrderMailer.confirm_email(order.id).deliver_later
+      order.update_column(:confirmation_delivered, true)
+    end
+
+    def send_cancel_email(event)
+      order = find_order(event)
+      return unless order
+
+      OrderMailer.cancel_email(order.id).deliver_later
+    end
+
+    def send_store_owner_notification(order)
+      return if order.store_owner_notification_delivered?
+      return if order.store.new_order_notifications_email.blank?
+
+      OrderMailer.store_owner_notification_email(order.id).deliver_later
+      order.update_column(:store_owner_notification_delivered, true)
+    end
+
+    def should_notify_store_owner?(order)
+      order.store.new_order_notifications_email.present? &&
+        !order.store_owner_notification_delivered?
+    end
+
+    def find_order(event)
+      order_id = event.payload['id']
+      Spree::Order.find_by(id: order_id)
+    end
+  end
+end

data/app/subscribers/spree/reimbursement_email_subscriber.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Spree
+  class ReimbursementEmailSubscriber < Spree::Subscriber
+    subscribes_to 'reimbursement.reimbursed'
+
+    def handle(event)
+      reimbursement = find_reimbursement(event)
+      return unless reimbursement
+
+      store = reimbursement.store
+      return unless store.prefers_send_consumer_transactional_emails?
+
+      ReimbursementMailer.reimbursement_email(reimbursement.id).deliver_later
+    end
+
+    private
+
+    def find_reimbursement(event)
+      reimbursement_id = event.payload['id']
+      Spree::Reimbursement.find_by(id: reimbursement_id)
+    end
+  end
+end

data/app/subscribers/spree/shipment_email_subscriber.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Spree
+  class ShipmentEmailSubscriber < Spree::Subscriber
+    subscribes_to 'shipment.shipped'
+
+    def handle(event)
+      shipment = find_shipment(event)
+      return unless shipment
+
+      store = shipment.store
+      return unless store.prefers_send_consumer_transactional_emails?
+
+      ShipmentMailer.shipped_email(shipment.id).deliver_later
+    end
+
+    private
+
+    def find_shipment(event)
+      shipment_id = event.payload['id']
+      Spree::Shipment.find_by(id: shipment_id)
+    end
+  end
+end

data/lib/spree/emails/engine.rb

@@ -5,6 +5,18 @@ module Spree
     class Engine < Rails::Engine
       isolate_namespace Spree
       engine_name 'spree_emails'
+
+      # Add app/subscribers to autoload paths
+      config.paths.add 'app/subscribers', eager_load: true
+
+      # Add email event subscribers
+      config.after_initialize do
+        Spree.subscribers.concat [
+          Spree::OrderEmailSubscriber,
+          Spree::ShipmentEmailSubscriber,
+          Spree::ReimbursementEmailSubscriber
+        ]
+      end
     end
   end
 end

data/lib/spree/emails.rb

@@ -1,4 +1,4 @@
-require 'spree/core'
+require 'spree'
 
 module Spree
   module Emails

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_emails
 version: !ruby/object:Gem::Version
-  version: 5.2.6
+  version: 5.3.0.rc1
 platform: ruby
 authors:
 - Sean Schofield
@@ -12,19 +12,19 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: spree_core
+  name: spree
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.6
+        version: 5.3.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.6
+        version: 5.3.0.rc1
 - !ruby/object:Gem::Dependency
   name: email_spec
   requirement: !ruby/object:Gem::Requirement
@@ -61,9 +61,9 @@ files:
 - app/mailers/spree/reimbursement_mailer.rb
 - app/mailers/spree/shipment_mailer.rb
 - app/models/spree/newsletter_subscriber/emails.rb
-- app/models/spree/order/emails.rb
-- app/models/spree/reimbursement/emails.rb
-- app/models/spree/shipment/emails.rb
+- app/subscribers/spree/order_email_subscriber.rb
+- app/subscribers/spree/reimbursement_email_subscriber.rb
+- app/subscribers/spree/shipment_email_subscriber.rb
 - app/views/spree/newsletter_mailer/email_confirmation.html.erb
 - app/views/spree/newsletter_mailer/email_confirmation.text.erb
 - app/views/spree/order_mailer/cancel_email.html.erb
@@ -99,9 +99,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v5.2.6
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.3.0.rc1
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.2.6
+  source_code_uri: https://github.com/spree/spree/tree/v5.3.0.rc1
 rdoc_options: []
 require_paths:
 - lib
@@ -109,12 +109,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.23
+      version: '0'
 requirements: []
 rubygems_version: 4.0.2
 specification_version: 4

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

@@ -1,30 +0,0 @@
-module Spree
-  class Order < Spree.base_class
-    module Emails
-      def deliver_order_confirmation_email
-        if completed?
-          OrderMailer.confirm_email(id).deliver_later if store.prefers_send_consumer_transactional_emails?
-          update_column(:confirmation_delivered, true)
-        else
-          errors.add(:base, Spree.t(:order_email_resent_error))
-        end
-      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
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-module Spree
-  class Reimbursement < Spree.base_class
-    module Emails
-      def send_reimbursement_email
-        Spree::ReimbursementMailer.reimbursement_email(id).deliver_later if store.prefers_send_consumer_transactional_emails?
-      end
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-module Spree
-  class Shipment < Spree.base_class
-    module Emails
-      def send_shipped_email
-        ShipmentMailer.shipped_email(@shipment.id).deliver_later if @shipment.store.prefers_send_consumer_transactional_emails?
-      end
-    end
-  end
-end