effective_mailchimp 0.5.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f2e87a71e74c97178552f620fa255eb992d7ba6329681f283c140205c7b991
-  data.tar.gz: 0b4a7b098353735f7aae1dbf7cb857477fdd780f1fef3f15ea1318f4383ff434
+  metadata.gz: d3b3306349bc71e4dcd895a1be96411b94e82c76155972d5ee73ad302487fa5d
+  data.tar.gz: 590439bc94cc48d34586b14eeba77476e5fc715ee32118a973c640fdc25e6def
 SHA512:
-  metadata.gz: ac169326fba074be7af97f386d93edb215220bce91750fa8e410487d601ae7f91e496aa7b4bdcda0a290d216a0cf0ef0e80639cdd8176d2f62c7fc7690891e1f
-  data.tar.gz: 06edb4d4261b098133462d263fe1ec6f12d327668eba7d81a8eb765d2b8dc53352d4e71ebd5317c08a7f3d5c95c0c67ebefd5d95c08279550ad0e51063820cf0
+  metadata.gz: 59eab329289651cd579828198bafbad8093aa94e452866f6dc2a51b5a787a7b077e57d644e5caa7cf91b868d12db82bdb28284680e7a3608f216c7bbbd4e73ad
+  data.tar.gz: fc0bbcadfffd0caae215be540ad150bf588264ae7ee013b4a4cbe8d0ea7064fe603d4f9bd4abfe70c6ef341d931d5e1ec1bed60f15735f5603f777e54c827d1a

data/app/controllers/admin/mailchimp_categories_controller.rb

@@ -0,0 +1,15 @@
+module Admin
+  class MailchimpCategoriesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_mailchimp) }
+
+    include Effective::CrudController
+
+    private
+
+    def permitted_params
+      params.require(:effective_mailchimp_category).permit!
+    end
+
+  end
+end

data/app/controllers/admin/mailchimp_controller.rb

@@ -3,6 +3,31 @@ module Admin
     before_action(:authenticate_user!) if defined?(Devise)
     before_action { EffectiveResources.authorize!(self, :admin, :effective_mailchimp) }
 
+    include Effective::CrudController
+
+    page_title 'Mailchimp'
+
+    # /admin/mailchimp
+    def index
+    end
+
+    # Sync All
+    def mailchimp_sync
+      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::MailchimpCategory.sync!(api: api)
+      Effective::MailchimpInterest.sync!(api: api)
+
+      flash[:success] = "Successfully synced mailchimp data"
+
+      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/controllers/admin/mailchimp_interests_controller.rb

@@ -0,0 +1,15 @@
+module Admin
+  class MailchimpInterestsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_mailchimp) }
+
+    include Effective::CrudController
+
+    private
+
+    def permitted_params
+      params.require(:effective_mailchimp_interest).permit!
+    end
+
+  end
+end

data/app/controllers/admin/mailchimp_list_members_controller.rb

@@ -0,0 +1,15 @@
+module Admin
+  class MailchimpListMembersController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_mailchimp) }
+
+    include Effective::CrudController
+
+    private
+
+    def permitted_params
+      params.require(:effective_mailchimp_list_member).permit!
+    end
+
+  end
+end

data/app/controllers/admin/mailchimp_lists_controller.rb

@@ -5,16 +5,6 @@ module Admin
 
     include Effective::CrudController
 
-    def mailchimp_sync
-      EffectiveResources.authorize!(self, :mailchimp_sync, Effective::MailchimpList)
-
-      Effective::MailchimpList.sync!
-
-      flash[:success] = "Successfully synced mailchimp lists"
-
-      redirect_back(fallback_location: effective_mailchimp.admin_mailchimp_lists_path)
-    end
-
     private
 
     def permitted_params

data/app/datatables/admin/effective_mailchimp_categories_datatable.rb

@@ -0,0 +1,32 @@
+module Admin
+  class EffectiveMailchimpCategoriesDatatable < Effective::Datatable
+
+    datatable do
+      length :all
+
+      order :name
+
+      col :updated_at, visible: false
+      col :created_at, visible: false
+      col :id, visible: false
+
+      col :mailchimp_list
+
+      col :list_id, visible: false
+      col :mailchimp_id, visible: false
+
+      col :name
+      col :list_name, visible: false
+
+      col :display_type
+
+      col :mailchimp_interests
+
+      actions_col
+    end
+
+    collection do
+      Effective::MailchimpCategory.deep.all
+    end
+  end
+end

data/app/datatables/admin/effective_mailchimp_interests_datatable.rb

@@ -0,0 +1,47 @@
+module Admin
+  class EffectiveMailchimpInterestsDatatable < Effective::Datatable
+    filters do
+      scope :all
+      scope :subscribable
+    end
+
+    datatable do
+      length :all
+      order :display_order
+
+      col :updated_at, visible: false
+      col :created_at, visible: false
+      col :id, visible: false
+
+      col :mailchimp_list
+      col :mailchimp_category
+
+      col :list_id, visible: false
+      col :category_id, visible: false
+      col :mailchimp_id, visible: false
+
+      col :name
+      col :can_subscribe
+      col :force_subscribe
+
+      col :list_name, visible: false
+      col :category_name, visible: false
+      col :display_order, visible: false
+
+      col :subscriber_count
+
+      actions_col
+    end
+
+    collection do
+      scope = Effective::MailchimpInterest.deep
+
+      if attributes[:mailchimp_category_id].present?
+        scope = scope.sorted
+      end
+
+      scope
+
+    end
+  end
+end

data/app/datatables/admin/effective_mailchimp_list_members_datatable.rb

@@ -0,0 +1,39 @@
+module Admin
+  class EffectiveMailchimpListMembersDatatable < Effective::Datatable
+    filters do
+      scope :all
+      scope :subscribed
+    end
+
+    datatable do
+      order :updated_at
+
+      col :updated_at, visible: false
+      col :created_at, visible: false
+      col :id, visible: false
+
+      col :mailchimp_list
+      col :user
+
+      col :mailchimp_id, visible: false
+      col :web_id, visible: false
+
+      col :email_address
+      col :full_name
+      col :subscribed
+
+      col :interests, visible: false
+      col :mailchimp_interests, search: { collection: Effective::MailchimpInterest.order(:name), fuzzy: true }
+
+      col :last_synced_at
+
+      actions_col do |member|
+        dropdown_link_to('Edit', "/admin/users/#{member.user.to_param}/edit#tab-mailchimp", 'data-turbolinks': false)
+      end
+    end
+
+    collection do
+      Effective::MailchimpListMember.deep.all
+    end
+  end
+end

data/app/datatables/admin/effective_mailchimp_lists_datatable.rb

@@ -6,7 +6,8 @@ module Admin
     end
 
     datatable do
-      order :updated_at
+      length :all
+      order :name
 
       col :updated_at, visible: false
       col :created_at, visible: false
@@ -21,13 +22,14 @@ module Admin
 
       col :url, label: 'Mailchimp' do |ml|
         [
-          link_to('View Campaign', ml.url, target: '_blank'),
           link_to('View Members', ml.members_url, target: '_blank'),
           link_to('View Merge Fields', ml.merge_fields_url, target: '_blank')
         ].join('<br>').html_safe
       end
 
-      col :merge_fields
+      col :merge_fields, visible: false do |ml|
+        ml.merge_fields.join(', ')
+      end
 
       actions_col
     end

data/app/helpers/effective_mailchimp_helper.rb

@@ -1,2 +1,12 @@
 module EffectiveMailchimpHelper
+
+  def mailchimp_list_member_interests_collection(mailchimp_interests)
+    interests = mailchimp_interests.select { |interest| interest.can_subscribe? || interest.force_subscribe? }
+
+    interests.map do |interest| 
+      label = (interest.force_subscribe? ? (interest.to_s + ' ' + content_tag(:small, 'required', class: 'text-hint')) : interest.to_s).html_safe
+      [label, interest.mailchimp_id, disabled: (interest.force_subscribe || !interest.can_subscribe?)]
+    end
+  end
+
 end

data/app/models/concerns/effective_mailchimp_user.rb

@@ -35,7 +35,7 @@ module EffectiveMailchimpUser
 
     # The user updated the form
     after_commit(if: -> { mailchimp_member_update_required? }) do
-      EffectiveMailchimpUpdateJob.perform_later(self)
+      EffectiveMailchimpUpdateJob.perform_later(self) # This calls user.mailchimp_update! on the background
     end
   end
 
@@ -140,6 +140,10 @@ module EffectiveMailchimpUser
     mailchimp_list_members.select(&:subscribed?).map(&:mailchimp_list)
   end
 
+  def mailchimp_subscribed_interests
+    mailchimp_list_members.select(&:subscribed?).flat_map(&:interests)
+  end
+
   def mailchimp_list_member(mailchimp_list:)
     raise('expected a MailchimpList') unless mailchimp_list.kind_of?(Effective::MailchimpList)
     mailchimp_list_members.find { |mlm| mlm.mailchimp_list_id == mailchimp_list.id }

data/app/models/effective/mailchimp_api.rb

@@ -29,6 +29,22 @@ module Effective
       "https://#{server}.admin.mailchimp.com"
     end
 
+    def audience_url
+      "https://#{server}.admin.mailchimp.com/audience/"
+    end
+
+    def groups_url
+      "https://#{server}.admin.mailchimp.com/lists/dashboard/groups/"
+    end
+
+    def contacts_url
+      "https://#{server}.admin.mailchimp.com/audience/contacts"
+    end
+
+    def campaigns_url
+      "https://#{server}.admin.mailchimp.com/campaigns/"
+    end
+
     def public_url
       "https://mailchimp.com"
     end
@@ -52,6 +68,20 @@ module Effective
       client.lists.get_list(id.try(:mailchimp_id) || id)
     end
 
+    def categories(list_id)
+      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?
+
+      response = client.lists.list_interest_category_interests(list_id, category_id)
+      Array(response['interests']) - [nil, '', {}]
+    end
+
     def list_member(id, email)
       raise('expected an email') unless email.to_s.include?('@')
 
@@ -63,7 +93,7 @@ module Effective
     end
 
     def list_merge_fields(id)
-      response = client.lists.get_list_merge_fields(id, count: 100)
+      response = client.lists.get_list_merge_fields(id.try(:mailchimp_id) || id, count: 100)
       Array(response['merge_fields']) - [nil, '', {}]
     end
 
@@ -73,7 +103,7 @@ module Effective
       payload = { name: name.to_s.titleize, tag: name.to_s, type: type }
 
       begin
-        client.lists.add_list_merge_field(id, payload)
+        client.lists.add_list_merge_field(id.try(:mailchimp_id) || id, payload)
       rescue MailchimpMarketing::ApiError => e
         false
       end
@@ -85,31 +115,29 @@ module Effective
       existing = list_member(member.mailchimp_list, member.user.email)
       return existing if existing.present?
 
-      merge_fields = member.user.mailchimp_merge_fields
-      raise('expected user mailchimp_merge_fields to be a Hash') unless merge_fields.kind_of?(Hash)
-
-      payload = {
-        email_address: member.user.email,
-        status: (member.subscribed ? 'subscribed' : 'unsubscribed'),
-        merge_fields: merge_fields.delete_if { |k, v| v.blank? }
-      }
-
+      payload = list_member_payload(member)
       client.lists.add_list_member(member.mailchimp_list.mailchimp_id, payload)
     end
 
     def list_member_update(member)
       raise('expected an Effective::MailchimpListMember') unless member.kind_of?(Effective::MailchimpListMember)
 
+      payload = list_member_payload(member)
+      client.lists.update_list_member(member.mailchimp_list.mailchimp_id, member.email, payload)
+    end
+
+    def list_member_payload(member)
+      raise('expected an Effective::MailchimpListMember') unless member.kind_of?(Effective::MailchimpListMember)
+
       merge_fields = member.user.mailchimp_merge_fields
       raise('expected user mailchimp_merge_fields to be a Hash') unless merge_fields.kind_of?(Hash)
 
       payload = {
         email_address: member.user.email,
         status: (member.subscribed ? 'subscribed' : 'unsubscribed'),
-        merge_fields: merge_fields.delete_if { |k, v| v.blank? }
-      }
-
-      client.lists.update_list_member(member.mailchimp_list.mailchimp_id, member.email, payload)
+        merge_fields: merge_fields.delete_if { |k, v| v.blank? },
+        interests: member.interests_hash.presence
+      }.compact
     end
 
   end

data/app/models/effective/mailchimp_category.rb

@@ -0,0 +1,73 @@
+module Effective
+  class MailchimpCategory < ActiveRecord::Base
+    self.table_name = (EffectiveMailchimp.mailchimp_categories_table_name || :mailchimp_categories).to_s
+
+    belongs_to :mailchimp_list
+    has_many :mailchimp_interests
+
+    effective_resource do
+      mailchimp_id      :string     # ID of this Mailchimp InterestCategory
+      list_id           :string     # Mailchimp list ID
+
+      name              :string     # Title
+      list_name         :string
+
+      display_type      :string     # Type
+
+      timestamps
+    end
+
+    validates :mailchimp_id, presence: true
+    validates :list_id, presence: true
+    validates :name, presence: true
+
+    scope :deep, -> { all }
+    scope :sorted, -> { order(:name) }
+    scope :subscribable, -> { all }
+
+    # Creates or builds all the Lists
+    def self.sync!(api: EffectiveMailchimp.api)
+      # For every mailchimp_list, get all the categories
+      mailchimp_lists = Effective::MailchimpList.all
+
+      mailchimp_lists.each do |mailchimp_list|
+        # All the Groups from Mailchimp
+        categories = api.categories(mailchimp_list.mailchimp_id)
+
+        # Get all our existing Effective::MailchimpCategory records
+        mailchimp_categories = where(mailchimp_list: mailchimp_list)
+
+        # Find or create Effective::MailchimpGroups based on existing groups
+        categories.each do |category|
+          mailchimp_id = category['id']
+          mailchimp_category = mailchimp_categories.find { |mc| mc.mailchimp_id == mailchimp_id } || new()
+
+          mailchimp_category.assign_attributes(
+            mailchimp_list: mailchimp_list,
+
+            mailchimp_id: mailchimp_id,
+            list_id: category['list_id'],
+            list_name: mailchimp_list.name,
+            name: (category['title'] || category['name']),
+            display_type: category['type']
+          )
+
+          mailchimp_category.save!
+        end
+
+        # Destroy any Effective::MailchimpGroups resources if they no longer returned by groups
+        mailchimp_categories.each do |mailchimp_category|
+          category = categories.find { |category| category['id'] == mailchimp_category.mailchimp_id }
+          mailchimp_category.destroy! unless category.present?
+        end
+      end
+
+      true
+    end
+
+    def to_s
+      name.presence || model_name.human
+    end
+
+  end
+end

data/app/models/effective/mailchimp_interest.rb

@@ -0,0 +1,92 @@
+module Effective
+  class MailchimpInterest < ActiveRecord::Base
+    self.table_name = (EffectiveMailchimp.mailchimp_interests_table_name || :mailchimp_interests).to_s
+
+    belongs_to :mailchimp_list
+    belongs_to :mailchimp_category
+
+    effective_resource do
+      mailchimp_id      :string     # ID of this interest on Mailchimp
+
+      list_id           :string     # Mailchimp list ID
+      category_id       :string     # Interest Category
+
+      name              :string
+      list_name         :string
+      category_name     :string
+
+      subscriber_count  :integer
+      display_order     :integer
+
+      can_subscribe     :boolean
+      force_subscribe   :boolean
+
+      timestamps
+    end
+
+    validates :mailchimp_id, presence: true
+    validates :list_id, presence: true
+    validates :category_id, presence: true
+    validates :name, presence: true
+
+    scope :deep, -> { all }
+    scope :sorted, -> { order(:display_order) }
+    scope :subscribable, -> { where(can_subscribe: true) }
+
+    # Creates or builds all the Lists
+    def self.sync!(api: EffectiveMailchimp.api)
+      # For every mailchimp_list, get all the interests
+      mailchimp_lists = Effective::MailchimpList.deep.all
+
+      mailchimp_lists.each do |mailchimp_list|
+        mailchimp_list.mailchimp_categories.each do |mailchimp_category|
+
+          # All the Interests from Mailchimp
+          interests = api.interests(mailchimp_list.mailchimp_id, mailchimp_category.mailchimp_id)
+
+          # Get all our existing Effective::MailchimpGroup records
+          mailchimp_interests = where(mailchimp_list: mailchimp_list, mailchimp_category: mailchimp_category)
+
+          # Find or create Effective::MailchimpInterests based on existing lists and categories 
+          interests.each do |interest|
+            mailchimp_id = interest['id']
+            mailchimp_interest = mailchimp_interests.find { |mi| mi.mailchimp_id == mailchimp_id } || new()
+
+            mailchimp_interest.assign_attributes(
+              mailchimp_list: mailchimp_list,
+              mailchimp_category: mailchimp_category,
+
+              mailchimp_id: mailchimp_id,
+
+              list_id: interest['list_id'],
+              list_name: mailchimp_list.name,
+
+              category_id: interest['category_id'],
+              category_name: mailchimp_category.name,
+
+              name: interest['name'],
+              display_order: interest['display_order'],
+              subscriber_count: interest['subscriber_count']
+            )
+
+            mailchimp_interest.assign_attributes(can_subscribe: true) if mailchimp_interest.new_record?
+            mailchimp_interest.save!
+          end
+
+          # Destroy any Effective::MailchimpGroups resources if they no longer returned by interests
+          mailchimp_interests.each do |mailchimp_interest|
+            interest = interests.find { |interest| interest['id'] == mailchimp_interest.mailchimp_id }
+            mailchimp_interest.destroy! unless interest.present?
+          end
+        end
+      end
+
+      true
+    end
+
+    def to_s
+      name.presence || model_name.human
+    end
+
+  end
+end

data/app/models/effective/mailchimp_list.rb

@@ -3,6 +3,8 @@ module Effective
     self.table_name = (EffectiveMailchimp.mailchimp_lists_table_name || :mailchimp_lists).to_s
 
     has_many :mailchimp_list_members, dependent: :delete_all
+    has_many :mailchimp_categories, dependent: :delete_all
+    has_many :mailchimp_interests, dependent: :delete_all
 
     effective_resource do
       mailchimp_id    :string
@@ -16,18 +18,14 @@ module Effective
       timestamps
     end
 
-    def to_s
-      name.presence || model_name.human
-    end
-
-    scope :deep, -> { all }
+    scope :deep, -> { includes(:mailchimp_categories, :mailchimp_interests) }
     scope :sorted, -> { order(:name) }
     scope :subscribable, -> { where(can_subscribe: true) }
 
     # Creates or builds all the Lists
-    def self.sync!
+    def self.sync!(api: EffectiveMailchimp.api, merge_fields: nil)
       # All the Lists from Mailchimp
-      lists = EffectiveMailchimp.api.lists
+      lists = api.lists()
 
       # Get all our existing Effective::MailchimpList records
       mailchimp_lists = all()
@@ -35,11 +33,17 @@ module Effective
       # Find or create Effective::Mailchimp based on existing lists
       lists.each do |list|
         mailchimp_id = list['id']
-        web_id = list['web_id']
-        name = list['name']
 
         mailchimp_list = mailchimp_lists.find { |ml| ml.mailchimp_id == mailchimp_id } || new()
-        mailchimp_list.assign_attributes(mailchimp_id: mailchimp_id, web_id: web_id, name: name)
+        mailchimp_list.assign_attributes(
+          mailchimp_id: mailchimp_id,
+
+          web_id: list['web_id'],
+          name: list['name'],
+          updated_at: Time.zone.now
+        )
+
+        mailchimp_list.assign_attributes(can_subscribe: true) if mailchimp_list.new_record?
         mailchimp_list.save!
       end
 
@@ -49,27 +53,37 @@ module Effective
         mailchimp_list.destroy! unless list.present?
       end
 
-      true
-    end
-
-    # This creates our local merge fields ON Mailchimp
-    def create_mailchimp_merge_fields!(merge_fields)
-      raise('expected a Hash of merge fields') unless merge_fields.kind_of?(Hash)
-
-      merge_fields.keys.each do |name|
-        EffectiveMailchimp.api.add_merge_field(mailchimp_id, name: name)
+      # Sync merge fields
+      if 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
+        end
       end
 
       true
     end
 
+    def to_s
+      name.presence || model_name.human
+    end
+
     def merge_fields
       return [] unless mailchimp_id
       EffectiveMailchimp.api.list_merge_fields(mailchimp_id).map { |hash| hash['tag'] }.sort
     end
 
-    def url
-      EffectiveMailchimp.api.admin_url + "/campaigns/#f_list:#{web_id}"
+    def grouped?
+      mailchimp_categories.present? && mailchimp_categories.any? { |category| category.mailchimp_interests.present? }
+    end
+
+    def ungrouped?
+      !grouped?
     end
 
     def members_url
@@ -80,21 +94,5 @@ module Effective
       EffectiveMailchimp.api.admin_url + "/lists/settings/merge-tags?id=#{web_id}"
     end
 
-    def can_subscribe!
-      update!(can_subscribe: true)
-    end
-
-    def cannot_subscribe!
-      update!(can_subscribe: false)
-    end
-
-    def force_subscribe!
-      update!(force_subscribe: true)
-    end
-
-    def unforce_subscribe!
-      update!(force_subscribe: false)
-    end
-
   end
 end

data/app/models/effective/mailchimp_list_member.rb

@@ -14,6 +14,8 @@ module Effective
       email_address   :string
       full_name       :string
 
+      interests       :text   # Array of mailchimp_interest mailchimp_ids
+
       # We set this on our side to update mailchimp and subscribe the user
       subscribed              :boolean
 
@@ -26,10 +28,17 @@ module Effective
       timestamps
     end
 
+    if EffectiveResources.serialize_with_coder?
+      serialize :interests, type: Array, coder: YAML
+    else
+      serialize :interests, Array
+    end
+
     validates :mailchimp_list_id, uniqueness: { scope: [:user_type, :user_id] }
 
     scope :deep, -> { includes(:mailchimp_list, :user) }
     scope :sorted, -> { order(:id) }
+    scope :subscribed, -> { where(subscribed: true) }
 
     def to_s
       mailchimp_list&.to_s || model_name.human
@@ -39,6 +48,37 @@ module Effective
       email_address.presence || user.email
     end
 
+    # Array of MailchimpInterest mailchimp_ids
+    def interests
+      Array(self[:interests]) - [nil, '']
+    end
+
+    # Array of MailchimpInterests
+    def mailchimp_interests
+      all_mailchimp_interests.select { |interest| interests.include?(interest.mailchimp_id) }
+    end
+
+    # We use this to add the force_subscribed interests
+    def build_interests(mailchimp_interest)
+      mailchimp_ids = Array(mailchimp_interest).map { |interest| interest.try(:mailchimp_id) || interest }
+      raise('expected an array of MailchimpInterests or mailchimp_ids') unless mailchimp_ids.all? { |id| id.kind_of?(String) && id.length > 1 }
+
+      assign_attributes(interests: interests | mailchimp_ids)
+    end
+
+    # {"25a38426c9" => false, "9b826db370" => true }
+    def interests_hash
+      all_mailchimp_interests.each_with_object({}) do |interest, hash|
+        hash[interest.mailchimp_id] = interests.include?(interest.mailchimp_id)
+      end
+    end
+
+    # From the mailchimp list
+    def all_mailchimp_interests
+      return [] if mailchimp_list.blank?
+      mailchimp_list.mailchimp_categories.flat_map(&:mailchimp_interests)
+    end
+
     def assign_mailchimp_attributes(atts)
       assign_attributes(
         mailchimp_id: atts['id'],
@@ -46,7 +86,8 @@ module Effective
         email_address: atts['email_address'],
         full_name: atts['full_name'],
         subscribed: (atts['status'] == 'subscribed'),
-        last_synced_at: Time.zone.now
+        last_synced_at: Time.zone.now,
+        interests: Hash(atts['interests']).select { |_, subscribed| subscribed == true }.keys
       )
     end
 

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

@@ -0,0 +1,15 @@
+- 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/index.html.haml

@@ -0,0 +1,80 @@
+%h1.effective-admin-heading= @page_title
+
+= card('Mailchimp Settings') do
+  - if EffectiveMailchimp.api_blank?
+    .alert.alert-danger You are not connected to Mailchimp. Please set your API key.
+
+  - if EffectiveMailchimp.api_present?
+    %p
+      = succeed('.') do
+        Please configure your
+        = link_to 'audiences', EffectiveMailchimp.api.audience_url, target: '_blank'
+        and 
+        = link_to 'groups', EffectiveMailchimp.api.groups_url, target: '_blank'
+        on the Mailchimp website then sync the changes so they can be updated below
+
+    %p
+      You can also visit the 
+      = link_to('contacts', EffectiveMailchimp.api.contacts_url, target: '_blank')
+      and
+      = 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.
+
+    = render('admin/mailchimp/sync')
+
+  = collapse('More settings') do
+    %p
+      For more information see
+      = succeed(',') do
+        = link_to(etsd(Effective::MailchimpList), effective_mailchimp.admin_mailchimp_lists_path, target: '_blank')
+      = succeed(',') do
+        = link_to(etsd(Effective::MailchimpListMember), effective_mailchimp.admin_mailchimp_list_members_path, target: '_blank')
+      = succeed(',') do
+        = link_to(etsd(Effective::MailchimpCategory), effective_mailchimp.admin_mailchimp_categories_path, target: '_blank')
+      and
+      = succeed('.') do
+        = link_to(etsd(Effective::MailchimpInterest), effective_mailchimp.admin_mailchimp_interests_path, target: '_blank')
+
+    %p The following merge fields are sent to Mailchimp when a user subscribes:
+
+    %ul
+      - current_user.mailchimp_merge_fields.keys.sort.each do |key|
+        %li= key
+
+  .mb-4
+
+= card(Effective::MailchimpList) do
+  %p 
+    Audiences contain a list of your contacts.
+    View all #{link_to ets(Effective::MailchimpList), EffectiveMailchimp.api.audience_url, target: '_blank'}.
+
+  %p
+    %small
+      To change the name, please visit the Mailchimp website then sync changes.
+      Press the Edit button to change the Can Subscribe and Force Subscribe settings.
+
+  - datatable = Admin::EffectiveMailchimpListsDatatable.new
+  = render_datatable(datatable, simple: true, inline: true)
+
+= card(Effective::MailchimpCategory) do
+  %p 
+    The following groups are displayed to the user where they can opt-in to each interest.
+    View all #{link_to ets(Effective::MailchimpCategory), EffectiveMailchimp.api.groups_url, target: '_blank'}.
+
+  %p
+    %small
+      To change the name, please visit the Mailchimp website then sync changes.
+      Press the Edit button to change the Can Subscribe and Force Subscribe settings.
+      Sync changes to update the subscriber counts.
+
+  - 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)
+

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

@@ -0,0 +1,10 @@
+= effective_form_with(model: [:admin, mailchimp_interest], engine: true) do |f|
+  = f.static_field :name, label: EffectiveResources.et(mailchimp_interest)
+
+  = f.check_box :can_subscribe, label: "Yes, display this interest and allow them to subscribe"
+
+  = f.check_box :force_subscribe,
+    label: "Yes, force users to subscribe. Subscribe them automatically and do not allow unsubscribe from the website",
+    hint: "They can still unsubscribe from the email link to unsubscribe"
+
+  = effective_submit(f)

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

@@ -1,5 +1,6 @@
 = effective_form_with(model: [:admin, mailchimp_list], engine: true) do |f|
   = f.static_field :name, label: EffectiveResources.et(mailchimp_list)
+  = f.static_field :merge_fields
 
   = f.check_box :can_subscribe, label: "Yes, display users and allow them to subscribe"
 

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

@@ -1,13 +1,19 @@
-= card(ets(Effective::MailchimpList)) do
-  %p.text-muted #{user} is subscribed to #{pluralize(user.mailchimp_subscribed_lists.count, et(Effective::MailchimpList))}.
+= card('Mailchimp') do
+  %p.text-muted
+    = succeed('.') do
+      = user
+      is subscribed to 
+      = pluralize(user.mailchimp_subscribed_lists.count, etd(Effective::MailchimpList))
+      and
+      = pluralize(user.mailchimp_subscribed_interests.count, etd(Effective::MailchimpInterest))
 
   %p.text-muted
     Please visit
-    = link_to 'All ' + ets(Effective::MailchimpList), effective_mailchimp.admin_mailchimp_lists_path, target: '_blank'
+    = link_to 'Mailchimp Settings', effective_mailchimp.admin_mailchimp_path, target: '_blank'
     to configure which are displayed.
 
   %p
-    %strong Subscribed
+    %strong Subscribed to the following
 
   = effective_form_with model: [:admin, user] do |f|
     = f.hidden_field :id

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

@@ -7,14 +7,41 @@
   = fmlm.hidden_field :id
   = fmlm.hidden_field :mailchimp_list_id
 
-  - if mailchimp_list.force_subscribe?
-    %p
-      - if fmlm.object.cannot_be_subscribed?
-        = fmlm.check_box :subscribed, label: fmlm.object.to_s, disabled: true, hint: 'required but unsubscribed', checked: false
+  - # With groups, probably single audience implementation
+  - if mailchimp_list.grouped?
+    = fmlm.hidden_field :subscribed, value: true
+
+    - # For each group / mailchimp_category
+    - mailchimp_list.mailchimp_categories.each do |mailchimp_category|
+      - mailchimp_interests = mailchimp_category.mailchimp_interests
+
+      - # Force subscription of each interest
+      - forced = mailchimp_interests.select { |mi| mi.force_subscribe? }
+      - fmlm.object.build_interests(forced)
+
+      - forced.each do |mailchimp_interest|
+        = fmlm.hidden_field :interests, name: "#{fmlm.object_name}[interests][]", value: mailchimp_interest.mailchimp_id
+
+      - # Add control for mailchimp interests
+      - mailchimp_interests_collection = mailchimp_list_member_interests_collection(mailchimp_interests)
+
+      - if mailchimp_category.display_type == 'select'
+        = fmlm.select :interests, mailchimp_interests_collection, label: mailchimp_category.to_s, name: "#{fmlm.object_name}[interests][]"
+      - elsif mailchimp_category.display_type == 'radio'
+        = fmlm.radios :interests, mailchimp_interests_collection, label: mailchimp_category.to_s, name: "#{fmlm.object_name}[interests][]"
       - else
-        = fmlm.check_box :subscribed, label: fmlm.object.to_s, disabled: true, hint: 'required', checked: true
-        = fmlm.hidden_field :subscribed, value: true
+        = fmlm.checks :interests, mailchimp_interests_collection, label: mailchimp_category.to_s, name: "#{fmlm.object_name}[interests][]"
+
+  - # No groups, multiple audiences implementation
+  - if mailchimp_list.ungrouped?
+    - if mailchimp_list.force_subscribe?
+      %p
+        - if fmlm.object.cannot_be_subscribed?
+          = fmlm.check_box :subscribed, label: fmlm.object.to_s, disabled: true, hint: 'required but unsubscribed', checked: false
+        - else
+          = fmlm.check_box :subscribed, label: fmlm.object.to_s, disabled: true, hint: 'required', checked: true
+          = fmlm.hidden_field :subscribed, value: true
 
-  - elsif mailchimp_list.can_subscribe?
-    %p
-      = fmlm.check_box :subscribed, label: fmlm.object.to_s
+    - elsif mailchimp_list.can_subscribe?
+      %p
+        = fmlm.check_box :subscribed, label: fmlm.object.to_s

data/config/locales/effective_mailchimp.en.yml

@@ -0,0 +1,12 @@
+en:
+  effective_mailchimp:
+    name: 'Effective Mailchimp'
+    acronym: 'Mailchimp'
+
+  activerecord:
+    models:
+      # These ones should stay effective
+      effective/mailchimp_list: 'Mailchimp Audience'
+      effective/mailchimp_list_member: 'Mailchimp Audience Member'
+      effective/mailchimp_category: 'Mailchimp Group'
+      effective/mailchimp_interest: 'Mailchimp Group Interest'

data/config/routes.rb

@@ -13,19 +13,17 @@ EffectiveMailchimp::Engine.routes.draw do
   end
 
   namespace :admin do
-    resources :mailchimp_lists, only: [:index, :edit, :update] do
-      post :can_subscribe, on: :member
-      post :cannot_subscribe, on: :member
-
-      post :force_subscribe, on: :member
-      post :unforce_subscribe, on: :member
-
-      get :mailchimp_sync, on: :collection
-    end
+    resources :mailchimp_lists, only: [:index, :edit, :update]
+    resources :mailchimp_interests, only: [:index, :edit, :update]
+    resources :mailchimp_categories, only: :index
+    resources :mailchimp_list_members, only: :index
 
     resources :mailchimp, only: [] do
+      post :mailchimp_sync, on: :collection
       post :mailchimp_sync_user, on: :member
     end
+
+    get '/mailchimp', to: 'mailchimp#index', as: :mailchimp
   end
 
 end

data/db/migrate/101_create_effective_mailchimp.rb

@@ -11,6 +11,41 @@ class CreateEffectiveMailchimp < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
+    create_table :mailchimp_categories do |t|
+      t.integer :mailchimp_list_id
+
+      t.string :mailchimp_id
+      t.string :list_id
+
+      t.string :name
+      t.string :list_name
+
+      t.string :display_type
+
+      t.timestamps
+    end
+
+    create_table :mailchimp_interests do |t|
+      t.integer :mailchimp_list_id
+      t.integer :mailchimp_category_id
+
+      t.string :mailchimp_id
+      t.string :list_id
+      t.string :category_id
+
+      t.string :name
+      t.string :list_name
+      t.string :category_name
+
+      t.integer :display_order
+      t.integer :subscriber_count
+
+      t.boolean :can_subscribe
+      t.boolean :force_subscribe
+
+      t.timestamps
+    end
+
     create_table :mailchimp_list_members do |t|
       t.integer :user_id
       t.string :user_type
@@ -26,6 +61,8 @@ class CreateEffectiveMailchimp < ActiveRecord::Migration[6.0]
       t.boolean :subscribed, default: false
       t.boolean :cannot_be_subscribed, default: false
 
+      t.text :interests
+
       t.datetime :last_synced_at
 
       t.timestamps

data/lib/effective_mailchimp/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMailchimp
-  VERSION = '0.5.2'.freeze
+  VERSION = '0.7.0'.freeze
 end

data/lib/effective_mailchimp.rb

@@ -7,7 +7,7 @@ module EffectiveMailchimp
 
   def self.config_keys
     [
-      :mailchimp_lists_table_name, :mailchimp_list_members_table_name,
+      :mailchimp_lists_table_name, :mailchimp_list_members_table_name, :mailchimp_categories_table_name, :mailchimp_interests_table_name,
       :layout,
       :api_key
     ]
@@ -23,8 +23,12 @@ module EffectiveMailchimp
     api_key.present?
   end
 
+  def self.api_blank?
+    api_key.blank?
+  end
+
   def self.permitted_params
-    [ :mailchimp_user_form_action, mailchimp_list_members_attributes: [:id, :mailchimp_list_id, :subscribed] ]
+    [ :mailchimp_user_form_action, mailchimp_list_members_attributes: [:id, :mailchimp_list_id, :subscribed, interests: []] ]
   end
 
 end

data/lib/tasks/effective_mailchimp_tasks.rake

@@ -5,20 +5,4 @@ namespace :effective_mailchimp do
     load "#{__dir__}/../../db/seeds.rb"
   end
 
-  # bundle exec rake effective_mailchimp:create_mailchimp_merge_fields
-  task create_mailchimp_merge_fields: :environment do
-    merge_fields = User.new.mailchimp_merge_fields()
-
-    Effective::MailchimpList.sync!
-
-    collection = Effective::MailchimpList.all
-
-    collection.find_each do |list|
-      puts "Creating #{list} merge fields"
-      list.create_mailchimp_merge_fields!(merge_fields)
-    end
-
-    puts 'All done'
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_mailchimp
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -193,23 +193,34 @@ files:
 - app/assets/javascripts/effective_mailchimp/base.js
 - app/assets/stylesheets/effective_mailchimp.scss
 - app/assets/stylesheets/effective_mailchimp/base.scss
+- app/controllers/admin/mailchimp_categories_controller.rb
 - app/controllers/admin/mailchimp_controller.rb
+- app/controllers/admin/mailchimp_interests_controller.rb
+- app/controllers/admin/mailchimp_list_members_controller.rb
 - app/controllers/admin/mailchimp_lists_controller.rb
 - app/controllers/effective/mailchimp_controller.rb
+- app/datatables/admin/effective_mailchimp_categories_datatable.rb
+- app/datatables/admin/effective_mailchimp_interests_datatable.rb
+- 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_update_job.rb
 - app/models/concerns/effective_mailchimp_user.rb
 - app/models/effective/mailchimp_api.rb
+- app/models/effective/mailchimp_category.rb
+- app/models/effective/mailchimp_interest.rb
 - app/models/effective/mailchimp_list.rb
 - app/models/effective/mailchimp_list_member.rb
+- app/views/admin/mailchimp/_sync.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
-- app/views/admin/mailchimp_lists/index.html.haml
 - app/views/admin/mailchimp_user/_form.html.haml
 - app/views/admin/mailchimp_user/_sync.html.haml
 - app/views/effective/mailchimp_user/_fields.html.haml
 - app/views/effective/mailchimp_user/_sync.html.haml
 - config/effective_mailchimp.rb
+- config/locales/effective_mailchimp.en.yml
 - config/routes.rb
 - db/migrate/101_create_effective_mailchimp.rb
 - db/seeds.rb

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

@@ -1,20 +0,0 @@
-%h1.effective-admin-heading= @page_title
-
-- resource = (@_effective_resource || Effective::Resource.new(controller_path))
-
-.resource-buttons
-  = render_resource_buttons(resource.klass, (action ||= :index) => false)
-
-= card do
-  = collapse('Show merge field settings') do
-    %p The following Merge fields are sent to Mailchimp when a user subscribes:
-
-    %ul
-      - current_user.mailchimp_merge_fields.keys.each do |key|
-        %li= key
-
-    %p To have these fields displayed in Mailchimp, please configure each campaign with any of these merge fields.
-
-  .mb-4
-
-  = render_datatable @datatable