effective_mailchimp 0.11.6 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6afb847e3f7b4628213327ca6c8c7784ec5e1bca4a8e9d04c2ba85b455889aef
-  data.tar.gz: 1215e45d2068ac5d3af1218365e3cbd0542e3e67238d3b62830d89310c3a7fe8
+  metadata.gz: ce289e932fc39342dcbff540f77bada053331d81b67a5f3019df23e0ab49abd7
+  data.tar.gz: d2e848d52d61cfec67c5207f31587c172893c5f57579206aa4fc6ccb94ab04c9
 SHA512:
-  metadata.gz: 53d077c387dbac60d2c5a6f65156f3116cd8e0ffe36544289a3ea663d81c32e635a2ef29e28e29fa886db8c0734f88f527a6220f093a42aa933479ad9d5c0c9c
-  data.tar.gz: 266964e54de1dd3f909a36c92f97285de938752b83a396b908f56ff4b97c9979caada46d790f634f4712cd3aeaf297738ac8bbde77b7f27d5f492d6c0e0d5635
+  metadata.gz: 62c87c42fdb6aa97b30907fbfcf290501a0c8a6dea93f592871f37e9302f354c160328e484fa819d8d890ab814194c320856381ca7702768ea670b021611e9d1
+  data.tar.gz: 015a77c5faa0159784b5e45aba1c4ca72310ec07ab67811317cddf5705dea67702558a6564f32b9fc9963f86149bdcc2f2dc26e6d503d58bd293db420ac74283

data/app/controllers/admin/mailchimp_controller.rb

@@ -45,7 +45,9 @@ module Admin
 
       EffectiveResources.authorize!(self, :update, resource)
 
+      api = EffectiveMailchimp.api
       resource.mailchimp_sync!
+      resource.mailchimp_update!
 
       flash[:success] = "Successfully synced mailchimp"
 

data/app/controllers/effective/mailchimp_controller.rb

@@ -7,7 +7,9 @@ module Effective
 
       EffectiveResources.authorize!(self, :mailchimp_sync_user, current_user)
 
-      resource.mailchimp_sync!
+      api = EffectiveMailchimp.api
+      resource.mailchimp_sync!(api: api)
+      resource.mailchimp_update!(api: api)
 
       flash[:success] = "Successfully synced mailchimp"
 

data/app/jobs/effective_mailchimp_sync_users_job.rb

@@ -12,6 +12,7 @@ class EffectiveMailchimpSyncUsersJob < ApplicationJob
       begin
         puts "Mailchimp sync user #{user.id}"
         user.mailchimp_sync!(api: api)
+        user.mailchimp_update!(api: api)
       rescue => e
         EffectiveLogger.error(e.message, associated: user) if defined?(EffectiveLogger)
         ExceptionNotifier.notify_exception(e, data: { user_id: user.id }) if defined?(ExceptionNotifier)

data/app/models/concerns/effective_mailchimp_user.rb

@@ -21,8 +21,6 @@ module EffectiveMailchimpUser
   end
 
   included do
-    attr_accessor :mailchimp_user_form_action
-
     has_many :mailchimp_list_members, -> { Effective::MailchimpListMember.sorted }, as: :user, class_name: 'Effective::MailchimpListMember', dependent: :destroy
     accepts_nested_attributes_for :mailchimp_list_members, allow_destroy: true
 
@@ -70,7 +68,6 @@ module EffectiveMailchimpUser
     end
 
     # This sets up the after_commit to run the mailchimp_update! job
-    assign_attributes(mailchimp_user_form_action: true)
     save!
   end
 
@@ -86,8 +83,6 @@ module EffectiveMailchimpUser
     end
 
     # This sets up the after_commit to run the mailchimp_update! job
-    assign_attributes(mailchimp_user_form_action: true)
-
     save!
   end
 
@@ -166,6 +161,10 @@ module EffectiveMailchimpUser
     periods.compact.max
   end
 
+  def mailchimp_cannot_be_subscribed?
+    mailchimp_list_members.any?(&:cannot_be_subscribed?)
+  end
+
   def mailchimp_subscribed_lists
     mailchimp_list_members.select(&:subscribed?).map(&:mailchimp_list)
   end
@@ -206,8 +205,6 @@ module EffectiveMailchimpUser
   def mailchimp_sync!(api: EffectiveMailchimp.api)
     lists = Effective::MailchimpList.sorted.to_a
 
-    assign_attributes(mailchimp_user_form_action: nil)
-
     mailchimp_with_retries do
       Timeout::timeout(lists.length * 3) do
         lists.each do |mailchimp_list|
@@ -224,7 +221,7 @@ module EffectiveMailchimpUser
       member.mark_for_destruction unless list.present?
     end
 
-    save!
+    without_mailchimp_update_async { save! }
   end
 
   def mailchimp_update_async!
@@ -235,8 +232,6 @@ module EffectiveMailchimpUser
   # Pushes the current Mailchimp List Member objects to Mailchimp when needed
   # Called in the background after a form submission that changes the user email/last_name/first_name or mailchimp subscriptions
   def mailchimp_update!(api: EffectiveMailchimp.api, only: [], except: [])
-    assign_attributes(mailchimp_user_form_action: nil)
-
     return if mailchimp_member_update_blocked?
 
     mailchimp_list_members.each do |member|
@@ -254,18 +249,25 @@ module EffectiveMailchimpUser
       rescue MailchimpMarketing::ApiError => e
         message = e.to_s.downcase
 
-        if message.include?("cannot be subscribed") || message.include?("deleted") || message.include?("unsubscribed")
+        if message.include?("cannot be subscribed") || message.include?("deleted") || message.include?("unsubscribed") || message.include?("archived") || message.include?("cleaned")
           member.assign_mailchimp_cannot_be_subscribed
-        elsif message.include?("already a list member")
+        elsif message.include?("already a list member") || message.include?("already in this list")
           existing = api.list_member(member.mailchimp_list, member.user.email)
           member.assign_mailchimp_attributes(existing) if existing.present?
+        elsif message.include?("could not be found")
+          # Nothing to do
         else
-          raise(e)
+          # Nothing to do.
         end
+
+        if defined?(ExceptionNotifier) && !EffectiveMailchimp.silence_api_errors?
+          ExceptionNotifier.notify_exception(e, data: { user_id: id || 'nil' })
+        end
+
       end
     end
 
-    save!
+    without_mailchimp_update_async { save! }
   end
 
   # Subscribe to force_subscribe lists
@@ -276,6 +278,19 @@ module EffectiveMailchimpUser
     mailchimp_subscribe!(mailchimp_lists)
   end
 
+  def without_mailchimp_update_async(&block)
+    raise('expected a block') unless block_given?
+
+    before = @mailchimp_member_update_enqueued
+
+    begin
+      @mailchimp_member_update_enqueued = true
+      yield
+    ensure
+      @mailchimp_member_update_enqueued = before
+    end
+  end
+
   private
 
   def mailchimp_with_retries(retries: 3, wait: 2, &block)
@@ -300,14 +315,16 @@ module EffectiveMailchimpUser
   def mailchimp_member_update_required?
     return false unless EffectiveMailchimp.api_present?
 
-    return false unless mailchimp_user_form_action
-    return false if self.class.respond_to?(:effective_memberships_user) && membership&.mailchimp_membership_update_required?
+    #return false if self.class.respond_to?(:effective_memberships_user) && membership&.mailchimp_membership_update_required?
 
     # Update if my email first name or last name change
     require_update = self.class.require_mailchimp_update_fields()
     return true if (changes.keys & require_update).present?
     return true if (previous_changes.keys & require_update).present?
 
+    # Update if any of my addresses change
+    return true if addresses.any? { |a| a.changes.present? || a.previous_changes.present? || a.marked_for_destruction? }
+
     # Update if any of my mailchimp list members changed
     # which happens when I submit a form and change the Mailchimp values
     return true if mailchimp_list_members.any? { |m| m.changes.present? || m.previous_changes.present? || m.marked_for_destruction? }

data/app/models/effective/mailchimp_api.rb

@@ -108,8 +108,8 @@ module Effective
     def add_merge_field(id, name:, type: :text)
       raise("invalid mailchimp merge key: #{name}. Must be 10 or fewer characters") if name.to_s.length > 10
 
-      return if sandbox_mode?
       Rails.logger.info "[effective_mailchimp] Add List Merge Field #{name}" if debug?
+      return if sandbox_mode?
 
       payload = { name: name.to_s.titleize, tag: name.to_s, type: type }
 
@@ -124,8 +124,8 @@ module Effective
     def list_member_add(member)
       raise('expected an Effective::MailchimpListMember') unless member.kind_of?(Effective::MailchimpListMember)
 
-      return if sandbox_mode?
       Rails.logger.info "[effective_mailchimp] Add List Member" if debug?
+      return if sandbox_mode?
 
       # See if they exist somehow
       existing = list_member(member.mailchimp_list, member.user.email)
@@ -143,8 +143,8 @@ module Effective
     def list_member_update(member)
       raise('expected an Effective::MailchimpListMember') unless member.kind_of?(Effective::MailchimpListMember)
 
-      return if sandbox_mode?
       Rails.logger.info "[effective_mailchimp] Update List Member" if debug?
+      return if sandbox_mode?
 
       payload = list_member_payload(member)
       client.lists.update_list_member(member.mailchimp_list.mailchimp_id, member.email, payload)

data/app/views/admin/mailchimp_user/_form.html.haml

@@ -1,4 +1,8 @@
 = card('Mailchimp') do
+  - if user.mailchimp_cannot_be_subscribed?
+    .alert.alert-warning.mb-3
+      This user has been marked as a Compliance State by Mailchimp and cannot be subscribed.
+
   %p.text-muted
     = succeed('.') do
       = user

data/app/views/admin/mailchimp_user/_sync.html.haml

@@ -1,11 +1,6 @@
 - user = f.object
 
 - if user.persisted?
-  - if user.mailchimp_list_members.any?(&:cannot_be_subscribed?)
-    %p.text-danger
-      %small
-        This user has been marked as a Compliance State by Mailchimp and cannot be subscribed.
-
   %p.text-muted
     %small
       last synced with

data/app/views/effective/mailchimp_user/_fields.html.haml

@@ -1,5 +1,3 @@
-= f.hidden_field :mailchimp_user_form_action, value: true
-
 = f.fields_for :mailchimp_list_members, f.object.build_mailchimp_list_members do |fmlm|
   - mailchimp_list = fmlm.object.mailchimp_list
   - next if mailchimp_list.blank?

data/config/effective_mailchimp.rb

@@ -11,4 +11,6 @@ EffectiveMailchimp.setup do |config|
 
   # Assign the User class name. For use in determining all merge_fields
   # config.user_class_name = 'User'
+
+  config.silence_api_errors = false
 end

data/lib/effective_mailchimp/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMailchimp
-  VERSION = '0.11.6'.freeze
+  VERSION = '0.12.0'.freeze
 end

data/lib/effective_mailchimp.rb

@@ -9,7 +9,7 @@ module EffectiveMailchimp
     [
       :mailchimp_lists_table_name, :mailchimp_list_members_table_name, :mailchimp_categories_table_name, :mailchimp_interests_table_name,
       :layout,
-      :api_key, :sandbox_mode, :user_class_name
+      :api_key, :sandbox_mode, :user_class_name, :silence_api_errors
     ]
   end
 
@@ -39,6 +39,10 @@ module EffectiveMailchimp
     Effective::MailchimpList.all.count == 0
   end
 
+  def self.silence_api_errors?
+    !!silence_api_errors
+  end
+
   def self.User
     klass = user_class_name.constantize if user_class_name.present?
     klass ||= Tenant.User if defined?(Tenant)
@@ -57,7 +61,7 @@ module EffectiveMailchimp
   end
 
   def self.permitted_params
-    [ :mailchimp_user_form_action, mailchimp_list_members_attributes: [:id, :mailchimp_list_id, :subscribed, interests: []] ]
+    [ mailchimp_list_members_attributes: [:id, :mailchimp_list_id, :subscribed, interests: []] ]
   end
 
   # Used to supress any background jobs during import processes

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_mailchimp
 version: !ruby/object:Gem::Version
-  version: 0.11.6
+  version: 0.12.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-06 00:00:00.000000000 Z
+date: 2025-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails