effective_mailchimp 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3502aae94186923697f39763042a537f6adf5426396e576b2ce17821cc892c70
-  data.tar.gz: dac06ef19961ed0e8eab2a548f2d7a810c50fbfccdd7219d0d198247f69353b2
+  metadata.gz: 56caa6a3804ed54f997cb2a732022cb077c37ec186f2a42476b2433b59f80bab
+  data.tar.gz: 51a5b095d91881d957c227c6f13155d78d3a9178aa3703982cf2fd4b8d92cd37
 SHA512:
-  metadata.gz: 73df6b018f47d66c0d5ba1fa27a02124c65c9544e6322e37bad2240cc21e2f73baae853bb68bb3e3c6ac8ef691ba6d627958988f2521884cf21244526b15da6f
-  data.tar.gz: 021eca9c105c49ee522df6c0b60f3d64e608ec9a8adc3e0930a018e6ff4ef56c8965796efdee1e0c9e1b3d988bb8b4f7578e022ffcc665a49a14c087683dfbe4
+  metadata.gz: 246b57c7659cbb154db572309d4a886132cef6cdf9d1bd09e4cafd37fd15dfc2d109375a2c179173bf710c478fb71306b1dc69a0c57587a6d66c4286edf6b446
+  data.tar.gz: 578e421f5e538bc705fcc0a4ab8290cd0adc4fae51388ddf941f934bbd4ea2c069eb13530d96c789ed4c8110d2e4ca5960a8274a1ae154e58cc30971a8722f3f

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,29 @@ 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
+      Effective::MailchimpList.sync!(api: api)
+      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,18 @@ 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
+
+      col :member_count do |list|
+        list.member_count.to_i
+      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/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

@@ -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
 
@@ -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
 
@@ -140,6 +141,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 }
@@ -169,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)
@@ -194,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,10 +25,30 @@ module Effective
       Rails.env.development?
     end
 
+    def sandbox_mode?
+      EffectiveMailchimp.sandbox_mode?
+    end
+
     def admin_url
       "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
@@ -40,21 +60,37 @@ 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?
+
+      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?('@')
 
+      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
@@ -63,18 +99,24 @@ module Effective
     end
 
     def list_merge_fields(id)
-      response = client.lists.get_list_merge_fields(id, count: 100)
-      Array(response['merge_fields']) - [nil, '', {}]
+      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, '', ' ', {}]
     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, payload)
+        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
@@ -82,34 +124,44 @@ module Effective
     def list_member_add(member)
       raise('expected an Effective::MailchimpListMember') unless member.kind_of?(Effective::MailchimpListMember)
 
-      existing = list_member(member.mailchimp_list, member.user.email)
-      return existing if existing.present?
+      return if sandbox_mode?
+      Rails.logger.info "[effective_mailchimp] Add List Member" if debug?
 
-      merge_fields = member.user.mailchimp_merge_fields
-      raise('expected user mailchimp_merge_fields to be a Hash') unless merge_fields.kind_of?(Hash)
+      # See if they exist somehow
+      existing = list_member(member.mailchimp_list, member.user.email)
 
-      payload = {
-        email_address: member.user.email,
-        status: (member.subscribed ? 'subscribed' : 'unsubscribed'),
-        merge_fields: merge_fields.delete_if { |k, v| v.blank? }
-      }
+      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
 
     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
+
+    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,74 @@
+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 }
+
+    # 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
+
+      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,93 @@
+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) }
+
+    # 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
+
+      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