effective_mailchimp 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3b3306349bc71e4dcd895a1be96411b94e82c76155972d5ee73ad302487fa5d
-  data.tar.gz: 590439bc94cc48d34586b14eeba77476e5fc715ee32118a973c640fdc25e6def
+  metadata.gz: 56caa6a3804ed54f997cb2a732022cb077c37ec186f2a42476b2433b59f80bab
+  data.tar.gz: 51a5b095d91881d957c227c6f13155d78d3a9178aa3703982cf2fd4b8d92cd37
 SHA512:
-  metadata.gz: 59eab329289651cd579828198bafbad8093aa94e452866f6dc2a51b5a787a7b077e57d644e5caa7cf91b868d12db82bdb28284680e7a3608f216c7bbbd4e73ad
-  data.tar.gz: fc0bbcadfffd0caae215be540ad150bf588264ae7ee013b4a4cbe8d0ea7064fe603d4f9bd4abfe70c6ef341d931d5e1ec1bed60f15735f5603f777e54c827d1a
+  metadata.gz: 246b57c7659cbb154db572309d4a886132cef6cdf9d1bd09e4cafd37fd15dfc2d109375a2c179173bf710c478fb71306b1dc69a0c57587a6d66c4286edf6b446
+  data.tar.gz: 578e421f5e538bc705fcc0a4ab8290cd0adc4fae51388ddf941f934bbd4ea2c069eb13530d96c789ed4c8110d2e4ca5960a8274a1ae154e58cc30971a8722f3f

data/app/controllers/admin/mailchimp_controller.rb

@@ -16,9 +16,7 @@ module Admin
       EffectiveResources.authorize!(self, :admin, :mailchimp_sync)
 
       api = EffectiveMailchimp.api
-      merge_fields = current_user.class.new().mailchimp_merge_fields
-
-      Effective::MailchimpList.sync!(api: api, merge_fields: merge_fields)
+      Effective::MailchimpList.sync!(api: api)
       Effective::MailchimpCategory.sync!(api: api)
       Effective::MailchimpInterest.sync!(api: api)
 

data/app/datatables/admin/effective_mailchimp_lists_datatable.rb

@@ -31,6 +31,10 @@ module Admin
         ml.merge_fields.join(', ')
       end
 
+      col :member_count do |list|
+        list.member_count.to_i
+      end
+
       actions_col
     end
 

data/app/jobs/effective_mailchimp_subscribe_all_members_job.rb

@@ -0,0 +1,8 @@
+class EffectiveMailchimpSubscribeAllMembersJob < ApplicationJob
+
+  def perform(mailchimp_list)
+    raise('expected an Effective::MailchimpList') unless mailchimp_list.kind_of?(Effective::MailchimpList)
+    mailchimp_list.subscribe_all_members!(now: true)
+  end
+
+end

data/app/jobs/effective_mailchimp_subscribe_all_users_job.rb

@@ -0,0 +1,8 @@
+class EffectiveMailchimpSubscribeAllUsersJob < ApplicationJob
+
+  def perform(mailchimp_list)
+    raise('expected an Effective::MailchimpList') unless mailchimp_list.kind_of?(Effective::MailchimpList)
+    mailchimp_list.subscribe_all_users!(now: true)
+  end
+
+end

data/app/models/concerns/effective_mailchimp_user.rb

@@ -59,12 +59,13 @@ module EffectiveMailchimpUser
       member.assign_attributes(subscribed: subscribed)
     end
 
-    # This sets up the after_commit to run the mailchimp_update! job
-    assign_attributes(mailchimp_user_form_action: true)
-
     # For use in a rake task. Run the update right now
-    mailchimp_update! if now
+    if now
+      return mailchimp_update!(only: mailchimp_lists)
+    end
 
+    # This sets up the after_commit to run the mailchimp_update! job
+    assign_attributes(mailchimp_user_form_action: true)
     save!
   end
 
@@ -173,8 +174,7 @@ module EffectiveMailchimpUser
   # Pulls the current status from Mailchimp API into the Mailchimp List Member objects
   # 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
+  def mailchimp_sync!(api: EffectiveMailchimp.api)
     lists = Effective::MailchimpList.subscribable.sorted.to_a
 
     assign_attributes(mailchimp_user_form_action: nil)
@@ -198,12 +198,13 @@ 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
-
+  def mailchimp_update!(api: EffectiveMailchimp.api, only: [], except: [])
     assign_attributes(mailchimp_user_form_action: nil)
 
     mailchimp_list_members.each do |member|
+      next if only.present? && Array(only).exclude?(member.mailchimp_list)
+      next if except.present? && Array(except).include?(member.mailchimp_list)
+
       begin
         list_member = if member.mailchimp_id.blank? && member.subscribed?
           api.list_member_add(member)

data/app/models/effective/mailchimp_api.rb

@@ -25,6 +25,10 @@ module Effective
       Rails.env.development?
     end
 
+    def sandbox_mode?
+      EffectiveMailchimp.sandbox_mode?
+    end
+
     def admin_url
       "https://#{server}.admin.mailchimp.com"
     end
@@ -56,27 +60,27 @@ module Effective
     # Returns an Array of Lists, which are each Hash
     # Like this [{ ...}, { ... }]
     def lists
-      Rails.logger.info "[effective_mailchimp] Index Lists..." if debug?
+      Rails.logger.info "[effective_mailchimp] Index Lists" if debug?
 
       response = client.lists.get_all_lists(count: 250)
       Array(response['lists']) - [nil, '', {}]
     end
 
     def list(id)
-      Rails.logger.info "[effective_mailchimp] Show List..." if debug?
+      Rails.logger.info "[effective_mailchimp] Get List" if debug?
 
       client.lists.get_list(id.try(:mailchimp_id) || id)
     end
 
     def categories(list_id)
-      Rails.logger.info "[effective_mailchimp] Index Interest Categories..." if debug?
+      Rails.logger.info "[effective_mailchimp] Index Interest Categories" if debug?
 
       response = client.lists.get_list_interest_categories(list_id.try(:mailchimp_id) || list_id)
       Array(response['categories']) - [nil, '', {}]
     end
 
     def interests(list_id, category_id)
-      Rails.logger.info "[effective_mailchimp] Index Interest Category Interests..." if debug?
+      Rails.logger.info "[effective_mailchimp] Index Interest Category Interests" if debug?
 
       response = client.lists.list_interest_category_interests(list_id, category_id)
       Array(response['interests']) - [nil, '', {}]
@@ -85,6 +89,8 @@ module Effective
     def list_member(id, email)
       raise('expected an email') unless email.to_s.include?('@')
 
+      Rails.logger.info "[effective_mailchimp] Get List Member" if debug?
+
       begin
         client.lists.get_list_member(id.try(:mailchimp_id) || id, email)
       rescue MailchimpMarketing::ApiError => e
@@ -93,18 +99,24 @@ module Effective
     end
 
     def list_merge_fields(id)
+      Rails.logger.info "[effective_mailchimp] Get List Merge Fields" if debug?
+
       response = client.lists.get_list_merge_fields(id.try(:mailchimp_id) || id, count: 100)
-      Array(response['merge_fields']) - [nil, '', {}]
+      Array(response['merge_fields']) - [nil, '', ' ', {}]
     end
 
     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?
+
       payload = { name: name.to_s.titleize, tag: name.to_s, type: type }
 
       begin
         client.lists.add_list_merge_field(id.try(:mailchimp_id) || id, payload)
       rescue MailchimpMarketing::ApiError => e
+        EffectiveLogger.error(e.message, details: name.to_s) if defined?(EffectiveLogger)
         false
       end
     end
@@ -112,9 +124,18 @@ 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?
+
+      # See if they exist somehow
       existing = list_member(member.mailchimp_list, member.user.email)
-      return existing if existing.present?
 
+      if existing.present?
+        member.assign_attributes(mailchimp_id: existing['id'])
+        return list_member_update(member)
+      end
+
+      # Actually add
       payload = list_member_payload(member)
       client.lists.add_list_member(member.mailchimp_list.mailchimp_id, payload)
     end
@@ -122,6 +143,9 @@ 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?
+
       payload = list_member_payload(member)
       client.lists.update_list_member(member.mailchimp_list.mailchimp_id, member.email, payload)
     end

data/app/models/effective/mailchimp_category.rb

@@ -25,7 +25,8 @@ module Effective
     scope :sorted, -> { order(:name) }
     scope :subscribable, -> { all }
 
-    # Creates or builds all the Lists
+    # Reads all the InterestCategories from Mailchimp and creates local MailchimpCategory records
+    # This is part of the Sync changes from Mailchimp button
     def self.sync!(api: EffectiveMailchimp.api)
       # For every mailchimp_list, get all the categories
       mailchimp_lists = Effective::MailchimpList.all

data/app/models/effective/mailchimp_interest.rb

@@ -33,7 +33,8 @@ module Effective
     scope :sorted, -> { order(:display_order) }
     scope :subscribable, -> { where(can_subscribe: true) }
 
-    # Creates or builds all the Lists
+    # Reads all the InterestCategoriesInterests from Mailchimp and creates local MailchimpInterest records
+    # This is part of the Sync changes from Mailchimp button
     def self.sync!(api: EffectiveMailchimp.api)
       # For every mailchimp_list, get all the interests
       mailchimp_lists = Effective::MailchimpList.deep.all

data/app/models/effective/mailchimp_list.rb

@@ -22,8 +22,10 @@ module Effective
     scope :sorted, -> { order(:name) }
     scope :subscribable, -> { where(can_subscribe: true) }
 
-    # Creates or builds all the Lists
-    def self.sync!(api: EffectiveMailchimp.api, merge_fields: nil)
+    # Reads all the Lists from Mailchimp and creates local MailchimpList records
+    # Also writes our merge fields to Mailchimp if they don't exist
+    # This is part of the Sync changes from Mailchimp button
+    def self.sync!(api: EffectiveMailchimp.api)
       # All the Lists from Mailchimp
       lists = api.lists()
 
@@ -40,6 +42,7 @@ module Effective
 
           web_id: list['web_id'],
           name: list['name'],
+          member_count: (list.dig('stats', 'member_count') || 0),
           updated_at: Time.zone.now
         )
 
@@ -54,21 +57,34 @@ module Effective
       end
 
       # Sync merge fields
-      if merge_fields.present?
+      if (merge_fields = EffectiveMailchimp.merge_fields).present?
         merge_field_keys = merge_fields.keys.map(&:to_s)
 
         mailchimp_lists.reject(&:destroyed?).each do |mailchimp_list|
           existing = api.list_merge_fields(mailchimp_list).map { |hash| hash['tag'] }
-          (merge_field_keys - existing).each do |name| 
-            puts "Adding merge field #{name} to #{mailchimp_list}"
-            api.add_merge_field(mailchimp_list, name: name)
-          end
+          (merge_field_keys - existing).each { |name| api.add_merge_field(mailchimp_list, name: name) }
         end
       end
 
       true
     end
 
+    def subscribe_all_users!(now: false)
+      if now
+        subscribe_all!(EffectiveMailchimp.User.all)
+      else
+        EffectiveMailchimpSubscribeAllUsersJob.perform_later(self)
+      end
+    end
+
+    def subscribe_all_members!(now: false)
+      if now
+        subscribe_all!(EffectiveMailchimp.User.all.members)
+      else
+        EffectiveMailchimpSubscribeAllMembersJob.perform_later(self)
+      end
+    end
+
     def to_s
       name.presence || model_name.human
     end
@@ -94,5 +110,21 @@ module Effective
       EffectiveMailchimp.api.admin_url + "/lists/settings/merge-tags?id=#{web_id}"
     end
 
+    private
+
+    def subscribe_all!(users)
+      users.find_each do |user|
+        begin
+          user.mailchimp_subscribe!(self, subscribed: true, now: true)
+        rescue => e
+          EffectiveLogger.error(e.message, associated: user) if defined?(EffectiveLogger)
+          ExceptionNotifier.notify_exception(e, data: { user_id: user.id, mailchimp_list_id: id }) if defined?(ExceptionNotifier)
+          raise(e) if Rails.env.test? || Rails.env.development?
+        end
+      end
+
+      true
+    end
+
   end
 end

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

@@ -20,14 +20,13 @@
       = link_to('campaigns', EffectiveMailchimp.api.campaigns_url, target: '_blank')
       at anytime.
 
-    %p.text-muted
-      %small
-        To change the names or display order of items below, please visit the Mailchimp website then sync changes.
-        %br
-        This operation also creates the audience merge fields and updates the subscriber counts for each group below.
+    %p To change the names or display order of items below, please visit the Mailchimp website then sync changes.
 
     = render('admin/mailchimp/sync')
 
+    %p.text-muted
+      %small This operation also creates the audience merge fields and updates the member and subscriber counts below.
+
   = collapse('More settings') do
     %p
       For more information see
@@ -44,7 +43,7 @@
     %p The following merge fields are sent to Mailchimp when a user subscribes:
 
     %ul
-      - current_user.mailchimp_merge_fields.keys.sort.each do |key|
+      - EffectiveMailchimp.merge_fields.keys.sort.each do |key|
         %li= key
 
   .mb-4
@@ -60,7 +59,7 @@
       Press the Edit button to change the Can Subscribe and Force Subscribe settings.
 
   - datatable = Admin::EffectiveMailchimpListsDatatable.new
-  = render_datatable(datatable, simple: true, inline: true)
+  = render_datatable(datatable, inline: true, short: true, search: false, sort: false)
 
 = card(Effective::MailchimpCategory) do
   %p 
@@ -76,5 +75,5 @@
   - Effective::MailchimpCategory.all.each do |mailchimp_category|
     = card(mailchimp_category.to_s) do
       - datatable = Admin::EffectiveMailchimpInterestsDatatable.new(mailchimp_category: mailchimp_category)
-      = render_datatable(datatable, simple: true, inline: true)
+      = render_datatable(datatable, inline: true, short: true, search: false, sort: false)
 

data/config/effective_mailchimp.rb

@@ -5,4 +5,10 @@ EffectiveMailchimp.setup do |config|
 
   # Mailchimp Settings
   config.api_key = ''  # From mailchimp's /account/api/ screen
+
+  # In Sandbox Mode you can only READ from Mailchimp not actually write to it
+  config.sandbox_mode = false
+
+  # Assign the User class name. For use in determining all merge_fields
+  # config.user_class_name = 'User'
 end

data/config/routes.rb

@@ -13,7 +13,11 @@ EffectiveMailchimp::Engine.routes.draw do
   end
 
   namespace :admin do
-    resources :mailchimp_lists, only: [:index, :edit, :update]
+    resources :mailchimp_lists, only: [:index, :edit, :update] do
+      post :subscribe_all_users, on: :member
+      post :subscribe_all_members, on: :member
+    end
+
     resources :mailchimp_interests, only: [:index, :edit, :update]
     resources :mailchimp_categories, only: :index
     resources :mailchimp_list_members, only: :index

data/db/migrate/101_create_effective_mailchimp.rb

@@ -5,6 +5,8 @@ class CreateEffectiveMailchimp < ActiveRecord::Migration[6.0]
       t.string :web_id
       t.string :name
 
+      t.integer :member_count
+
       t.boolean :can_subscribe
       t.boolean :force_subscribe
 

data/lib/effective_mailchimp/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMailchimp
-  VERSION = '0.7.0'.freeze
+  VERSION = '0.8.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
+      :api_key, :sandbox_mode, :user_class_name
     ]
   end
 
@@ -19,6 +19,10 @@ module EffectiveMailchimp
     Effective::MailchimpApi.new(api_key: api_key)
   end
 
+  def self.sandbox_mode?
+    !!sandbox_mode
+  end
+
   def self.api_present?
     api_key.present?
   end
@@ -27,6 +31,23 @@ module EffectiveMailchimp
     api_key.blank?
   end
 
+  def self.User
+    klass = user_class_name.constantize if user_class_name.present?
+    klass ||= Tenant.User if defined?(Tenant)
+    klass ||= '::User'.safe_constantize
+
+    raise('unable to determine User klass. Please set config.user_class_name') unless klass.kind_of?(Class)
+    raise('expecting an effective_mailchimp_user User class') unless klass.respond_to?(:effective_mailchimp_user)
+
+    klass
+  end
+
+  def self.merge_fields
+    merge_fields = self.User().new.mailchimp_merge_fields
+    raise('expected a Hash of merge fields') unless merge_fields.kind_of?(Hash)
+    merge_fields
+  end
+
   def self.permitted_params
     [ :mailchimp_user_form_action, mailchimp_list_members_attributes: [:id, :mailchimp_list_id, :subscribed, interests: []] ]
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_mailchimp
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -204,6 +204,8 @@ files:
 - app/datatables/admin/effective_mailchimp_list_members_datatable.rb
 - app/datatables/admin/effective_mailchimp_lists_datatable.rb
 - 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_update_job.rb
 - app/models/concerns/effective_mailchimp_user.rb
 - app/models/effective/mailchimp_api.rb