effective_mailchimp 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9324e2d3e44354896c4ebf66fa72a67b03b0014b8bcefe33c38f77447d950212
-  data.tar.gz: 84960533a7ace0489d64ec6901dce4d49bdb7845a34893ddfff866d81f73f7ea
+  metadata.gz: 8e962bf13bfffb52a6cad9ca3a79a04d5538c9c458a4e1c2435d2802d7d80baa
+  data.tar.gz: 19705bc7db8feb56aaa6929e278ea9ebddf04f303a7d42a50e577004a5661223
 SHA512:
-  metadata.gz: 9559bc12e2eddec9078b8d3fbba00578e4d44786ac6dfb41b7addb32b6c191a8aabecf889593cacd39cb6d0ab03bf0e12eb963a703788fa937d7439883fa28c6
-  data.tar.gz: 1bb06b5c12bcdf3b2ab58994f1e818844eaf4ae7404dab11ba75597915f018c89972d6c9a4738efd3e171e61d66cb1b5e5b8c1d92b1364277eb7922207c4409d
+  metadata.gz: 7b4a23713e0f03b906e168b68cc4310d3774cd1f6e4cf72c67f89d35ff1b311f695b653a1539e547a732d61e04473870c77b56a225621f49da192877d77e89aa
+  data.tar.gz: 3d4e1e00f8c84dcbab4cab7ce0a1035f2d30648b47c3da21834110a7757814b1cc27a9c62d53157bf3d99a7ec6f4b06ad28a8da9eb810b2fdb656ba95d5e0d03

data/app/datatables/admin/effective_mailchimp_lists_datatable.rb

@@ -17,14 +17,17 @@ module Admin
 
       col :name
       col :can_subscribe
-
-      col :url, label: 'Campaign' do |ml|
-        link_to('View Campaign', ml.url, target: '_blank')
+      col :force_subscribe
+
+      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 :members_url, label: 'Members' do |ml|
-        link_to('View Members', ml.members_url, target: '_blank')
-      end
+      col :merge_fields
 
       actions_col
     end

data/app/models/concerns/effective_mailchimp_user.rb

@@ -29,6 +29,47 @@ module EffectiveMailchimpUser
     after_commit(if: -> { mailchimp_user_form_action }) { mailchimp_update!(force: false) }
   end
 
+  # Intended for app to extend
+  def mailchimp_merge_fields
+    default_mailchimp_merge_fields()
+  end
+
+  # These are the fields we push to Mailchimp on list_add and list_update
+  def default_mailchimp_merge_fields
+    atts = {}
+
+    if respond_to?(:first_name) && respond_to?(:last_name)
+      atts.merge!(
+        'FNAME': first_name,
+        'LNAME': last_name
+      )
+    end
+
+    if respond_to?(:addresses)
+      address = try(:billing_address) || addresses.last
+
+      atts.merge!(
+        'ADDRESS1': address&.address1,
+        'ADDRESS2': address&.address2,
+        'CITY': address&.city,
+        'PROVINCE': address&.province,
+        'COUNTRY': address&.country,
+        'POSTAL_CODE': address&.postal_code
+      )
+    end
+
+    if respond_to?(:membership)
+      atts.merge!(
+        'CATEGORY': membership&.categories&.to_sentence,
+        'STATUS': membership&.statuses&.to_sentence,
+        'NUMBER': membership&.number,
+        'JOINED': membership&.joined_on&.strftime('%F')
+      )
+    end
+
+    atts
+  end
+
   def mailchimp_subscribed_lists
     mailchimp_list_members.select(&:subscribed?).map(&:mailchimp_list)
   end

data/app/models/effective/mailchimp_api.rb

@@ -10,15 +10,15 @@ module Effective
     attr_accessor :server
     attr_accessor :client
 
-    def initialize(api_key:, server:)
-      raise('expected an api key') unless api_key.present?
-      raise('expected a server') unless server.present?
-
+    def initialize(api_key:)
       @api_key = api_key
-      @server = server
+      @server = api_key.to_s.split('-').last
+
+      raise('expected an api key') unless @api_key.present?
+      raise('expected an api key') unless @server.present?
 
       @client = ::MailchimpMarketing::Client.new()
-      @client.set_config(api_key: api_key, server: server)
+      @client.set_config(api_key: @api_key, server: @server)
     end
 
     def admin_url
@@ -32,7 +32,7 @@ module Effective
     # Returns an Array of Lists, which are each Hash
     # Like this [{ ...}, { ... }]
     def lists
-      response = client.lists.get_all_lists()
+      response = client.lists.get_all_lists(count: 250)
       Array(response['lists']) - [nil, '', {}]
     end
 
@@ -50,16 +50,31 @@ module Effective
       end
     end
 
+    def list_merge_fields(id)
+      response = client.lists.get_list_merge_fields(id, count: 100)
+      Array(response['merge_fields']) - [nil, '', {}]
+    end
+
+    def add_merge_field(id, name:, type: :text)
+      payload = { name: name.to_s.titleize, tag: name.to_s, type: type }
+
+      begin
+        client.lists.add_list_merge_field(id, payload)
+      rescue MailchimpMarketing::ApiError => e
+        false
+      end
+    end
+
     def list_member_add(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: {
-          'FNAME': member.user.try(:first_name),
-          'LNAME': member.user.try(:last_name)
-        }
+        merge_fields: merge_fields
       }
 
       client.lists.add_list_member(member.mailchimp_list.mailchimp_id, payload)
@@ -68,13 +83,13 @@ module Effective
     def list_member_update(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: {
-          'FNAME': member.user.try(:first_name),
-          'LNAME': member.user.try(:last_name)
-        }
+        merge_fields: merge_fields.compact
       }
 
       client.lists.update_list_member(member.mailchimp_list.mailchimp_id, member.email, payload)

data/app/models/effective/mailchimp_list.rb

@@ -3,12 +3,16 @@ module Effective
 
     self.table_name = (EffectiveMailchimp.mailchimp_lists_table_name || :mailchimp_lists).to_s
 
+    has_many :mailchimp_list_members, dependent: :delete_all
+
     effective_resource do
       mailchimp_id    :string
       web_id          :string
 
       name            :string
+
       can_subscribe   :boolean
+      force_subscribe :boolean
 
       timestamps
     end
@@ -49,6 +53,22 @@ module Effective
       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)
+      end
+
+      true
+    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}"
     end
@@ -57,6 +77,10 @@ module Effective
       EffectiveMailchimp.api.admin_url + "/lists/members?id=#{web_id}"
     end
 
+    def merge_fields_url
+      EffectiveMailchimp.api.admin_url + "/lists/settings/merge-tags?id=#{web_id}"
+    end
+
     def can_subscribe!
       update!(can_subscribe: true)
     end
@@ -65,5 +89,13 @@ module Effective
       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/views/admin/mailchimp_lists/_form.html.haml

@@ -1,8 +1,10 @@
 = effective_form_with(model: [:admin, mailchimp_list], engine: true) do |f|
-  = f.static_field :mailchimp_id
-  = f.static_field :web_id
-  = f.static_field :name
+  = f.static_field :name, label: EffectiveResources.et(mailchimp_list)
 
   = f.check_box :can_subscribe, label: "Yes, display users 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/index.html.haml

@@ -0,0 +1,16 @@
+%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:
+
+      %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

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

@@ -18,8 +18,12 @@
       %small
         last synced with
         = link_to 'Mailchimp', EffectiveMailchimp.api.admin_url
-        = time_ago_in_words(user.mailchimp_last_synced_at)
-        ago.
+        - 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
 
     = f.submit

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

@@ -1,4 +1,14 @@
 = f.hidden_field :mailchimp_user_form_action, value: true
 
 = f.fields_for :mailchimp_list_members do |fmlm|
-  %p= fmlm.check_box :subscribed, label: fmlm.object.to_s
+  - mailchimp_list = fmlm.object.mailchimp_list
+  - next if mailchimp_list.blank?
+
+  - if mailchimp_list.force_subscribe?
+    %p
+      = fmlm.check_box :subscribed, label: fmlm.object.to_s, disabled: true, hint: 'required'
+      = fmlm.hidden_field :subscribed, value: true
+
+  - elsif mailchimp_list.can_subscribe?
+    %p
+      = fmlm.check_box :subscribed, label: fmlm.object.to_s

data/config/effective_mailchimp.rb

@@ -8,5 +8,4 @@ EffectiveMailchimp.setup do |config|
 
   # Mailchimp Settings
   config.api_key = ''  # From mailchimp's /account/api/ screen
-  config.server = ''   # Determine from your mailchimp account URL. Something like us1
 end

data/config/routes.rb

@@ -13,6 +13,9 @@ EffectiveMailchimp::Engine.routes.draw 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
     end
 
     resources :mailchimp, only: [] do

data/db/migrate/01_create_effective_mailchimp.rb.erb

@@ -7,6 +7,7 @@ class CreateEffectiveMailchimp < ActiveRecord::Migration[6.0]
       t.string :name
 
       t.boolean :can_subscribe
+      t.boolean :force_subscribe
 
       t.timestamps
     end

data/lib/effective_mailchimp/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMailchimp
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/effective_mailchimp.rb

@@ -9,18 +9,18 @@ module EffectiveMailchimp
     [
       :mailchimp_lists_table_name, :mailchimp_list_members_table_name,
       :layout,
-      :api_key, :server
+      :api_key
     ]
   end
 
   include EffectiveGem
 
   def self.api
-    Effective::MailchimpApi.new(api_key: api_key, server: server)
+    Effective::MailchimpApi.new(api_key: api_key)
   end
 
   def self.api_present?
-    api_key.present? && server.present?
+    api_key.present?
   end
 
   def self.permitted_params

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_mailchimp
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -202,6 +202,7 @@ files:
 - app/models/effective/mailchimp_list.rb
 - app/models/effective/mailchimp_list_member.rb
 - 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/effective/mailchimp_user/_fields.html.haml
 - config/effective_mailchimp.rb