effective_mailchimp 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a57dc4a131505a30aee2da443a0761ab39377aceb74c4c813a78837fee686e86
-  data.tar.gz: 340ff304acf261cf44d8c834d37c77728275c4011b60b9a862b475e706ea38f1
+  metadata.gz: 6e160d18a30ca7d423b2fa0bda06ee1c863a93c1c2e40845d5c4d7a295f61c0a
+  data.tar.gz: 72344d51bf42e59b48ac0f07652aa69d44261464e3d5ef50b27d2a3160d42241
 SHA512:
-  metadata.gz: 0d3edbb93225110fba831441f8fb19c8185dc13ff5622346f1a54f93751220be9875398a401b180064892ef7e33921b53ef19d37f3df0d8e7e64585c102f5d90
-  data.tar.gz: d0dd15fa47af11bf18fc89f98088440a7a71882175a884bbb5a7933dc157053cf3a963e1162a05c6e8c674969a6b3eb5f9aa280a357a91ed4a39bcddb1b73ac1
+  metadata.gz: 417d2ff2930dcced75059bcd9c6d344dbad2132078c3267a058de9ff57c9c73490f63c91dcda306583039a0d41da7197d940cff8efdbcd27a91b2ecf4087859d
+  data.tar.gz: 3d1b326ab312e203e9f326c18398c08d4cd9db2dab4c3ef2c45245ddfc0dc20cb86947bb870cc5b8abe8b6c69a3a971d14d16a7014a63769d66c98ff35a0e71b

data/app/controllers/admin/mailchimp_controller.rb

@@ -25,6 +25,20 @@ module Admin
       redirect_back(fallback_location: effective_mailchimp.admin_mailchimp_path)
     end
 
+    # Sync all users
+    def mailchimp_sync_users
+      EffectiveResources.authorize!(self, :admin, :mailchimp_sync_users)
+
+      user_class_name = current_user.class.name
+
+      # This calls user.mailchimp_sync! on all users
+      EffectiveMailchimpSyncUsersJob.perform_later(user_class_name) 
+
+      flash[:success] = "Successfully started mailchimp sync all users background job. Please wait a few minutes for it to complete. Check the logs for progress."
+
+      redirect_back(fallback_location: effective_mailchimp.admin_mailchimp_path)
+    end
+
     # Sync one user
     def mailchimp_sync_user
       resource = current_user.class.find(params[:id])

data/app/jobs/effective_mailchimp_sync_users_job.rb

@@ -0,0 +1,23 @@
+class EffectiveMailchimpSyncUsersJob < ApplicationJob
+  def perform(user_class_name)
+    users = user_class_name.safe_constantize
+    raise('expected an effective_mailchimp_user class') unless users.try(:effective_mailchimp_user?)
+    raise('expected a mailchimp API key') unless EffectiveMailchimp.api_present?
+
+    api = EffectiveMailchimp.api
+
+    EffectiveLogger.info("Starting sync users from mailchimp job")
+
+    users.find_each do |user|
+      begin
+        puts "Mailchimp sync user #{user.id}"
+        user.mailchimp_sync!(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)
+      end
+    end
+
+    EffectiveLogger.info("Finished sync users from mailchimp job")
+  end
+end

data/app/models/concerns/effective_mailchimp_user.rb

@@ -200,16 +200,18 @@ module EffectiveMailchimpUser
   # Run before the mailchimp fields are displayed
   # Only run in the background when a user or admin clicks sync now
   def mailchimp_sync!(api: EffectiveMailchimp.api)
-    lists = Effective::MailchimpList.subscribable.sorted.to_a
+    lists = Effective::MailchimpList.sorted.to_a
 
     assign_attributes(mailchimp_user_form_action: nil)
 
-    Timeout::timeout(lists.length * 2) do
-      lists.each do |mailchimp_list|
-        member = build_mailchimp_list_member(mailchimp_list: mailchimp_list)
+    mailchimp_with_retries do
+      Timeout::timeout(lists.length * 3) do
+        lists.each do |mailchimp_list|
+          member = build_mailchimp_list_member(mailchimp_list: mailchimp_list)
 
-        list_member = api.list_member(mailchimp_list, email) || {}
-        member.assign_mailchimp_attributes(list_member)
+          list_member = api.list_member(mailchimp_list, email) || {}
+          member.assign_mailchimp_attributes(list_member)
+        end
       end
     end
 
@@ -252,6 +254,20 @@ module EffectiveMailchimpUser
 
   private
 
+  def mailchimp_with_retries(retries: 3, wait: 2, &block)
+    raise('expected a block') unless block_given?
+
+    begin
+      return yield
+    rescue Exception => e
+      if (retries -= 1) > 0
+        sleep(wait); retry
+      else
+        raise
+      end
+    end
+  end
+
   def mailchimp_member_update_required?
     return false unless mailchimp_user_form_action
     return false if self.class.respond_to?(:effective_memberships_user) && membership&.mailchimp_membership_update_required?

data/app/models/effective/mailchimp_list_member.rb

@@ -41,7 +41,7 @@ module Effective
     scope :subscribed, -> { where(subscribed: true) }
 
     def to_s
-      mailchimp_list&.to_s || model_name.human
+      [mailchimp_list, user].compact.join(' - ').presence || model_name.human
     end
 
     def email
@@ -86,6 +86,7 @@ module Effective
         email_address: atts['email_address'],
         full_name: atts['full_name'],
         subscribed: (atts['status'] == 'subscribed'),
+        cannot_be_subscribed: ['unsubscribed', 'cleaned', 'archived'].include?(atts['status']),
         last_synced_at: Time.zone.now,
         interests: Hash(atts['interests']).select { |_, subscribed| subscribed == true }.keys
       )

data/app/views/admin/mailchimp/_last_sync.html.haml

@@ -0,0 +1,12 @@
+%p.text-muted
+  %small
+    - mailchimp_last_synced_at = Effective::MailchimpList.maximum(:updated_at)
+
+    last synced with
+    = link_to 'Mailchimp', EffectiveMailchimp.api.admin_url, target: '_blank'
+
+    - if mailchimp_last_synced_at.present?
+      = time_ago_in_words(mailchimp_last_synced_at)
+      ago.
+    - else
+      never.

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

@@ -1,15 +1,2 @@
 - if EffectiveResources.authorized?(self, :admin, :mailchimp_sync)
   %p= link_to 'Sync changes from Mailchimp', effective_mailchimp.mailchimp_sync_admin_mailchimp_index_path, 'data-method': :post, class: 'btn btn-primary'
-
-%p.text-muted
-  %small
-    - mailchimp_last_synced_at = Effective::MailchimpList.maximum(:updated_at)
-
-    last synced with
-    = link_to 'Mailchimp', EffectiveMailchimp.api.admin_url, target: '_blank'
-
-    - if mailchimp_last_synced_at.present?
-      = time_ago_in_words(mailchimp_last_synced_at)
-      ago.
-    - else
-      never.

data/app/views/admin/mailchimp/_sync_users.html.haml

@@ -0,0 +1,2 @@
+- if EffectiveResources.authorized?(self, :admin, :mailchimp_sync_users)
+  %p= link_to 'Sync users from Mailchimp', effective_mailchimp.mailchimp_sync_users_admin_mailchimp_index_path, 'data-method': :post, class: 'btn btn-primary'

data/app/views/admin/mailchimp/index.html.haml

@@ -20,12 +20,25 @@
       = link_to('campaigns', EffectiveMailchimp.api.campaigns_url, target: '_blank')
       at anytime.
 
-    %p To change the names or display order of items below, please visit the Mailchimp website then sync changes.
+    %hr
+
+    %p To change the names or display order of items below, visit the Mailchimp website and make any changes. Once done, return here and click Sync changes from Mailchimp.
 
     = render('admin/mailchimp/sync')
 
     %p.text-muted
-      %small This operation also creates the audience merge fields and updates the member and subscriber counts below.
+      %small This step also creates the audience merge fields and updates the member and subscriber counts below.
+
+    %hr
+
+    %p To assign user interests from Mailchimp, visit the Mailchimp website and import or update contacts info. Once done, return here and click Sync users from Mailchimp.
+
+    = render('admin/mailchimp/sync_users')
+
+    %p.text-muted
+      %small This step is only necessary after manually importing Contacts on the Mailchimp website. This will start a background job to mailchimp sync every user. You can sync individual users from their Edit screen.
+
+  %hr
 
   = collapse('More settings') do
     %p

data/config/routes.rb

@@ -24,6 +24,7 @@ EffectiveMailchimp::Engine.routes.draw do
 
     resources :mailchimp, only: [] do
       post :mailchimp_sync, on: :collection
+      post :mailchimp_sync_users, on: :collection
       post :mailchimp_sync_user, on: :member
     end
 

data/lib/effective_mailchimp/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMailchimp
-  VERSION = '0.9.1'.freeze
+  VERSION = '0.9.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_mailchimp
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-18 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -206,6 +206,7 @@ files:
 - app/helpers/effective_mailchimp_helper.rb
 - app/jobs/effective_mailchimp_subscribe_all_members_job.rb
 - app/jobs/effective_mailchimp_subscribe_all_users_job.rb
+- app/jobs/effective_mailchimp_sync_users_job.rb
 - app/jobs/effective_mailchimp_update_job.rb
 - app/models/concerns/effective_mailchimp_user.rb
 - app/models/effective/mailchimp_api.rb
@@ -213,7 +214,9 @@ files:
 - app/models/effective/mailchimp_interest.rb
 - app/models/effective/mailchimp_list.rb
 - app/models/effective/mailchimp_list_member.rb
+- app/views/admin/mailchimp/_last_sync.html.haml
 - app/views/admin/mailchimp/_sync.html.haml
+- app/views/admin/mailchimp/_sync_users.html.haml
 - app/views/admin/mailchimp/index.html.haml
 - app/views/admin/mailchimp_interests/_form.html.haml
 - app/views/admin/mailchimp_lists/_form.html.haml