effective_mailchimp 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bfe4116a697ecf8159efedc227cef01e8ba67e6a66af101df8f13939145ab3b
-  data.tar.gz: 6ec420f5b33544b57d355cb924eb116312df32a7f43cf21f5846d328e09bddf1
+  metadata.gz: 6828c1db2915c26b5aa9d2401496925b0898ff71edb6436d9283c895942967f7
+  data.tar.gz: 33db597cfe2e2ae408fc05b106ef4354b63bdfee2fa286bc10e8ccf5ed8e68df
 SHA512:
-  metadata.gz: c1510628c55b5bb1d50848b6a0ab1d5c3e486b00dd809ba97a7c85e33cee9803bdf3a07c75e3190b8744b4d2245c304918dc267a40c42da955ffb0097b74296a
-  data.tar.gz: 47e46744ee8e61be5662b976053c820df9832af56546a4b822a811044cc2843badc1209c1f0bc4fe3e993d895a43b815078b42fe218a44f40564996a955297a5
+  metadata.gz: 4e2eceb6d94dd48f78b43090bd51742f092b22b10c028636f2ab522562aa295bd361d6629d238c5ef99b5fe2ef0a7abb5dca9f72b2cfabd89c5c1bf4878cf072
+  data.tar.gz: 2b13409e3e4ef8b84f8541fda2d386649d149e6e52de6c41d8888894be2ad25f375dc5100443e224a9f596b12bbeafad4df883f8f96fd7eada54030a3faf3a16

data/app/controllers/admin/mailchimp_lists_controller.rb

@@ -3,11 +3,18 @@ module Admin
     before_action(:authenticate_user!) if defined?(Devise)
     before_action { EffectiveResources.authorize!(self, :admin, :effective_mailchimp) }
 
-    # Calls Sync
-    before_action(only: :index) { Effective::MailchimpList.sync! }
-
     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/controllers/effective/mailchimp_controller.rb

@@ -0,0 +1,18 @@
+module Effective
+  class MailchimpController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    def mailchimp_sync_user
+      resource = current_user
+
+      EffectiveResources.authorize!(self, :mailchimp_sync_user, current_user)
+
+      resource.mailchimp_sync!
+
+      flash[:success] = "Successfully synced mailchimp"
+
+      redirect_back(fallback_location: '/settings')
+    end
+
+  end
+end

data/app/helpers/effective_mailchimp_helper.rb

@@ -1,15 +1,2 @@
 module EffectiveMailchimpHelper
-
-  def mailchimp_user_fields(form)
-    raise('expected a form') unless form.respond_to?(:object)
-
-    resource = form.object
-    raise('expected an effective_mailchimp_user resource') unless resource.class.respond_to?(:effective_mailchimp_user?)
-
-    resource.reload
-    resource.mailchimp_sync!(force: false)
-
-    render('effective/mailchimp_user/fields', form: form, f: form, resource: resource, mailchimp_user: resource)
-  end
-
 end

data/app/jobs/effective_mailchimp_update_job.rb

@@ -2,7 +2,7 @@ class EffectiveMailchimpUpdateJob < ApplicationJob
 
   def perform(user)
     raise('expected an effective_mailchimp_user') unless user.class.try(:effective_mailchimp_user?)
-    user.mailchimp_update!(force: true)
+    user.mailchimp_update!
   end
 
 end

data/app/models/concerns/effective_mailchimp_user.rb

@@ -14,6 +14,10 @@ module EffectiveMailchimpUser
 
   module ClassMethods
     def effective_mailchimp_user?; true; end
+
+    def require_mailchimp_update_fields
+      ['email', 'last_name', 'first_name']
+    end
   end
 
   included do
@@ -26,11 +30,54 @@ module EffectiveMailchimpUser
     accepts_nested_attributes_for :mailchimp_lists, allow_destroy: true
 
     # The user updated the form
-    after_commit(if: -> { mailchimp_user_form_action }) do
+    after_commit(if: -> { mailchimp_member_update_required? }) do
       EffectiveMailchimpUpdateJob.perform_later(self)
     end
   end
 
+  def mailchimp_subscribed?(mailchimp_list)
+    raise('expected a MailchimpList') unless mailchimp_lists.all? { |list| list.kind_of?(Effective::MailchimpList) }
+
+    member = mailchimp_list_member(mailchimp_list: mailchimp_list)
+    return false if member.blank?
+
+    member.subscribed? && member.synced?
+  end
+
+  # Api method to just subscribe this user to this list right now
+  # Pass one list or an Array of lists
+  def mailchimp_subscribe!(mailchimp_list)
+    mailchimp_lists = Array(mailchimp_list)
+    raise('expected a MailchimpList') unless mailchimp_lists.all? { |list| list.kind_of?(Effective::MailchimpList) }
+
+    mailchimp_lists.each do |mailchimp_list|
+      member = build_mailchimp_list_member(mailchimp_list: mailchimp_list)
+      member.assign_attributes(subscribed: true)
+    end
+
+    # This sets up the after_commit to run the mailchimp_update! job
+    assign_attributes(mailchimp_user_form_action: true)
+
+    save!
+  end
+
+  # Api method to just unsubscribe this user to this list right now
+  # Pass one list or an Array of lists
+  def mailchimp_unsubscribe!(mailchimp_list)
+    mailchimp_lists = Array(mailchimp_list)
+    raise('expected a MailchimpList') unless mailchimp_lists.all? { |list| list.kind_of?(Effective::MailchimpList) }
+
+    mailchimp_lists.each do |mailchimp_list|
+      member = build_mailchimp_list_member(mailchimp_list: mailchimp_list)
+      member.assign_attributes(subscribed: false)
+    end
+
+    # This sets up the after_commit to run the mailchimp_update! job
+    assign_attributes(mailchimp_user_form_action: true)
+
+    save!
+  end
+
   # Intended for app to extend
   def mailchimp_merge_fields
     default_mailchimp_merge_fields()
@@ -88,26 +135,29 @@ module EffectiveMailchimpUser
     mailchimp_list_member(mailchimp_list: mailchimp_list) || mailchimp_list_members.build(mailchimp_list: mailchimp_list)
   end
 
-  def mailchimp_list_members_changed?
-    mailchimp_list_members.any? { |mlm| mlm.changes.present? || mlm.marked_for_destruction? }
-  end
-
   def mailchimp_last_synced_at
-    mailchimp_list_members.map(&:last_synced_at).min
+    mailchimp_list_members.map(&:last_synced_at).compact.min
   end
 
-  def mailchimp_sync_required?
-    return true if mailchimp_last_synced_at.blank?
-    mailchimp_last_synced_at < (Time.zone.now - 1.day)
+  # Used by the form to set it up for all lists
+  def build_mailchimp_list_members
+    mailchimp_lists = Effective::MailchimpList.subscribable.sorted.to_a
+
+    mailchimp_lists.each do |mailchimp_list|
+      build_mailchimp_list_member(mailchimp_list: mailchimp_list)
+    end
+
+    mailchimp_list_members
   end
 
   # Pulls the current status from Mailchimp API into the Mailchimp List Member objects
   # Run before the mailchimp fields are displayed
-  def mailchimp_sync!(force: true)
+  # 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
 
-    return if lists.length == mailchimp_list_members.length && !(force || mailchimp_sync_required?)
+    assign_attributes(mailchimp_user_form_action: nil)
 
     Timeout::timeout(lists.length * 2) do
       lists.each do |mailchimp_list|
@@ -123,38 +173,42 @@ module EffectiveMailchimpUser
       member.mark_for_destruction unless list.present?
     end
 
-    save! if mailchimp_list_members_changed?
-    true
+    save!
   end
 
   # Pushes the current Mailchimp List Member objects to Mailchimp when needed
-  def mailchimp_update!(force: true)
+  # 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
 
     assign_attributes(mailchimp_user_form_action: nil)
 
-    mailchimp_list_members.map do |member|
+    mailchimp_list_members.each do |member|
       if member.mailchimp_id.blank? && member.subscribed?
         list_member = api.list_member_add(member)
-        member.assign_mailchimp_attributes(list_member)
-      elsif member.mailchimp_id.present? && (force || mailchimp_member_update_required?(member))
+        member.assign_mailchimp_attributes(list_member) if list_member.present?
+      elsif member.mailchimp_id.present?
         list_member = api.list_member_update(member)
-        member.assign_mailchimp_attributes(list_member)
+        member.assign_mailchimp_attributes(list_member) if list_member.present?
       end
     end
 
-    save! if mailchimp_list_members_changed?
-    true
+    save!
   end
 
-  def mailchimp_member_update_required?(member)
-    require_update = ['email', 'last_name', 'first_name']
+  private
+
+  def mailchimp_member_update_required?
+    return false unless mailchimp_user_form_action
 
+    # 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?
 
-    return true if member.changes.present?
-    return true if member.previous_changes.present?
+    # 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? }
 
     false
   end

data/app/models/effective/mailchimp_api.rb

@@ -21,10 +21,18 @@ module Effective
       @client.set_config(api_key: @api_key, server: @server)
     end
 
+    def debug?
+      Rails.env.development?
+    end
+
     def admin_url
       "https://#{server}.admin.mailchimp.com"
     end
 
+    def public_url
+      "https://mailchimp.com"
+    end
+
     def ping
       client.ping.get()
     end
@@ -32,11 +40,15 @@ module Effective
     # Returns an Array of Lists, which are each Hash
     # Like this [{ ...}, { ... }]
     def lists
+      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?
+
       client.lists.get_list(id.try(:mailchimp_id) || id)
     end
 
@@ -70,6 +82,9 @@ 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?
+
       merge_fields = member.user.mailchimp_merge_fields
       raise('expected user mailchimp_merge_fields to be a Hash') unless merge_fields.kind_of?(Hash)
 
@@ -79,7 +94,13 @@ module Effective
         merge_fields: merge_fields.delete_if { |k, v| v.blank? }
       }
 
-      client.lists.add_list_member(member.mailchimp_list.mailchimp_id, payload)
+      begin
+        client.lists.add_list_member(member.mailchimp_list.mailchimp_id, payload)
+      rescue MailchimpMarketing::ApiError => e
+        return false if e.status == 400 && e.to_s.downcase.include?("member in compliance state")
+        raise(e)
+      end
+
     end
 
     def list_member_update(member)

data/app/models/effective/mailchimp_list_member.rb

@@ -21,6 +21,8 @@ module Effective
       timestamps
     end
 
+    validates :mailchimp_list_id, uniqueness: { scope: [:user_type, :user_id] }
+
     scope :deep, -> { includes(:mailchimp_list, :user) }
     scope :sorted, -> { order(:id) }
 
@@ -43,5 +45,9 @@ module Effective
       )
     end
 
+    def synced?
+      last_synced_at.present?
+    end
+
   end
 end

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

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

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

@@ -12,18 +12,7 @@
   = effective_form_with model: [:admin, user] do |f|
     = f.hidden_field :id
 
-    = mailchimp_user_fields(f)
-
-    %p.text-muted
-      %small
-        last synced with
-        = link_to 'Mailchimp', EffectiveMailchimp.api.admin_url
-        - if user.mailchimp_last_synced_at.present?
-          = time_ago_in_words(user.mailchimp_last_synced_at)
-          ago.
-        - else
-          never.
-
-        = link_to 'sync now', effective_mailchimp.mailchimp_sync_user_admin_mailchimp_path(f.object), 'data-method': :post
+    = render('effective/mailchimp_user/fields', f: f)
+    = render('admin/mailchimp_user/sync', f: f)
 
     = f.submit

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

@@ -0,0 +1,15 @@
+- user = f.object
+
+- if user.persisted?
+  %p.text-muted
+    %small
+      last synced with
+      = link_to 'Mailchimp', EffectiveMailchimp.api.admin_url, target: '_blank'
+      - if user.mailchimp_last_synced_at.present?
+        = time_ago_in_words(user.mailchimp_last_synced_at)
+        ago.
+      - else
+        never.
+
+      - if EffectiveResources.authorized?(self, :mailchimp_sync_user, user) 
+        = link_to 'sync now', effective_mailchimp.mailchimp_sync_user_admin_mailchimp_path(user), 'data-method': :post

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

@@ -1,12 +1,15 @@
 = f.hidden_field :mailchimp_user_form_action, value: true
 
-= f.fields_for :mailchimp_list_members do |fmlm|
+= 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?
 
+  = fmlm.hidden_field :id
+  = fmlm.hidden_field :mailchimp_list_id
+
   - if mailchimp_list.force_subscribe?
     %p
-      = fmlm.check_box :subscribed, label: fmlm.object.to_s, disabled: true, hint: 'required'
+      = 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?

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

@@ -0,0 +1,15 @@
+- user = f.object
+
+- if user.persisted?
+  %p.text-muted
+    %small
+      last synced with
+      = link_to 'Mailchimp', EffectiveMailchimp.api.public_url, target: '_blank'
+      - if user.mailchimp_last_synced_at.present?
+        = time_ago_in_words(user.mailchimp_last_synced_at)
+        ago.
+      - else
+        never.
+
+      - if EffectiveResources.authorized?(self, :mailchimp_sync_user, user)
+        = link_to 'sync now', effective_mailchimp.mailchimp_sync_user_mailchimp_path(user), 'data-method': :post

data/config/routes.rb

@@ -7,6 +7,9 @@ end
 EffectiveMailchimp::Engine.routes.draw do
   # Public routes
   scope module: 'effective' do
+    resources :mailchimp, only: [] do
+      post :mailchimp_sync_user, on: :member
+    end
   end
 
   namespace :admin do
@@ -16,12 +19,13 @@ EffectiveMailchimp::Engine.routes.draw do
 
       post :force_subscribe, on: :member
       post :unforce_subscribe, on: :member
+
+      get :mailchimp_sync, on: :collection
     end
 
     resources :mailchimp, only: [] do
       post :mailchimp_sync_user, on: :member
     end
-
   end
 
 end

data/lib/effective_mailchimp/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMailchimp
-  VERSION = '0.2.5'.freeze
+  VERSION = '0.3.1'.freeze
 end

data/lib/effective_mailchimp.rb

@@ -24,7 +24,7 @@ module EffectiveMailchimp
   end
 
   def self.permitted_params
-    [ :mailchimp_user_form_action, mailchimp_list_members_attributes: [:id, :subscribed] ]
+    [ :mailchimp_user_form_action, mailchimp_list_members_attributes: [:id, :mailchimp_list_id, :subscribed] ]
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_mailchimp
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.1
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-24 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -195,6 +195,7 @@ files:
 - app/assets/stylesheets/effective_mailchimp/base.scss
 - app/controllers/admin/mailchimp_controller.rb
 - app/controllers/admin/mailchimp_lists_controller.rb
+- app/controllers/effective/mailchimp_controller.rb
 - app/datatables/admin/effective_mailchimp_lists_datatable.rb
 - app/helpers/effective_mailchimp_helper.rb
 - app/jobs/effective_mailchimp_update_job.rb
@@ -205,7 +206,9 @@ files:
 - 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/routes.rb
 - db/migrate/01_create_effective_mailchimp.rb.erb
@@ -235,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Subscribe and unsubscribe to mailchimp lists.