effective_mailchimp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc851b003ffad568b1b32a435b75022875e3c12be043f4a298d929927142aab1
+  data.tar.gz: 7560d0e76bef241e59c40ca93b2c607b45b4e4757ccbe2d8b64f575b0e9eb9c8
+SHA512:
+  metadata.gz: 787fbc005508da120aaac6103c21c5ff31b107ae80c311b7ad0eed91765fc85ff5a2c4537fdf22e41d8d78e95d6de5cade9e1bd76570165d63e217ac8909696c
+  data.tar.gz: 2dd3834383a2352a093928e95fd77423734c214d5061377ccf9fc2b1b4e51ce18e5e82e0af6e1acca928a576efdc8215cc9b8bb814af1a1a5cb63cd7393340d5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Code and Effect Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# Effective Mailchimp
+
+Subscribe and unsubscribe users to individual mailchimp campaigns.
+
+Update Mailchimp whenever a user changes their demographics
+
+## Getting Started
+
+This requires Rails 6+ and Twitter Bootstrap 4 and just works with Devise.
+
+Please first install the [effective_datatables](https://github.com/code-and-effect/effective_datatables) gem.
+
+Please download and install the [Twitter Bootstrap4](http://getbootstrap.com)
+
+Add to your Gemfile:
+
+```ruby
+gem 'haml'
+gem 'effective_mailchimp'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+Then run the generator:
+
+```ruby
+rails generate effective_mailchimp:install
+```
+
+The generator will install an initializer which describes all configuration options and creates a database migration.
+
+If you want to tweak the table names, manually adjust both the configuration file and the migration now.
+
+Then migrate the database:
+
+```ruby
+rake db:migrate
+```
+
+Please add the following to your User model:
+
+```
+effective_mailchimp_user
+```
+
+and
+
+```
+Add a link to the admin menu:
+
+```haml
+- if can? :admin, :effective_mailchimp
+  - if can? :index, Effective::MailchimpList
+    = nav_link_to 'Mailchimp lists', effective_mailchimp.admin_mailchimp_lists_path
+```
+
+To add the fields to your existing users form
+
+```
+= form_with(model: user) do |f|
+  = f.text_field :first_name
+  = f.text_field :last_name
+  = mailchimp_user_fields(f)
+  = f.submit
+
+## Configuring Mailchimp Account
+
+Refer to the Marketing API Quick Start
+
+`https://mailchimp.com/developer/marketing/guides/quick-start/`
+
+Sign up for a Mailchimp account. Create a campaign.
+
+Get API key from:
+
+Visit `https://us7.admin.mailchimp.com/account/api/`
+
+Click Create an API Key
+
+Get your server from the domain. us7 in the above example.
+
+## Configuration
+
+## Authorization
+
+All authorization checks are handled via the effective_resources gem found in the `config/initializers/effective_resources.rb` file.
+
+## Permissions
+
+The permissions you actually want to define are as follows (using CanCan):
+
+```ruby
+if user.persisted?
+end
+
+if user.admin?
+  can :admin, :effective_mailchimp
+
+  can([:index, :edit, :update], Effective::MailchimpList)
+  can(:can_subscribe, Effective::MailchimpList) { |list| !list.can_subscribe? }
+  can(:cannot_subscribe, Effective::MailchimpList) { |list| list.can_subscribe? }
+end
+```
+
+## License
+
+MIT License. Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
+
+## Testing
+
+Run tests by:
+
+```ruby
+rails test
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Bonus points for test coverage
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/effective_mailchimp_manifest.js

@@ -0,0 +1,3 @@
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link_tree ../images

data/app/assets/javascripts/effective_mailchimp.js

@@ -0,0 +1 @@
+//= require_tree ./effective_mailchimp

data/app/assets/stylesheets/effective_mailchimp.scss

@@ -0,0 +1 @@
+@import 'effective_mailchimp/base';

data/app/controllers/admin/mailchimp_controller.rb

@@ -0,0 +1,19 @@
+module Admin
+  class MailchimpController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_mailchimp) }
+
+    def mailchimp_sync_user
+      resource = current_user.class.find(params[:id])
+
+      EffectiveResources.authorize!(self, :update, resource)
+
+      resource.mailchimp_sync!
+
+      flash[:success] = "Successfully synced mailchimp"
+
+      redirect_back(fallback_location: "/admin/users/#{params[:id]}/edit")
+    end
+
+  end
+end

data/app/controllers/admin/mailchimp_lists_controller.rb

@@ -0,0 +1,18 @@
+module Admin
+  class MailchimpListsController < ApplicationController
+    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
+
+    private
+
+    def permitted_params
+      params.require(:effective_mailchimp_list).permit!
+    end
+
+  end
+end

data/app/datatables/admin/effective_mailchimp_lists_datatable.rb

@@ -0,0 +1,36 @@
+module Admin
+  class EffectiveMailchimpListsDatatable < Effective::Datatable
+    filters do
+      scope :all
+      scope :subscribable
+    end
+
+    datatable do
+      order :updated_at
+
+      col :updated_at, visible: false
+      col :created_at, visible: false
+      col :id, visible: false
+
+      col :mailchimp_id, visible: false
+      col :web_id, visible: false
+
+      col :name
+      col :can_subscribe
+
+      col :url, label: 'Campaign' do |ml|
+        link_to('View Campaign', ml.url, target: '_blank')
+      end
+
+      col :members_url, label: 'Members' do |ml|
+        link_to('View Members', ml.members_url, target: '_blank')
+      end
+
+      actions_col
+    end
+
+    collection do
+      Effective::MailchimpList.deep.all
+    end
+  end
+end

data/app/helpers/effective_mailchimp_helper.rb

@@ -0,0 +1,14 @@
+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.mailchimp_sync!(force: false)
+
+    render('effective/mailchimp_user/fields', form: form, f: form, resource: resource, mailchimp_user: resource)
+  end
+
+end

data/app/models/concerns/effective_mailchimp_user.rb

@@ -0,0 +1,116 @@
+# EffectiveMailchimpUser
+#
+# Mark your user model with effective_mailchimp_user to get a few helpers
+# And user specific point required scores
+
+module EffectiveMailchimpUser
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_mailchimp_user
+      include ::EffectiveMailchimpUser
+    end
+  end
+
+  module ClassMethods
+    def effective_mailchimp_user?; true; end
+  end
+
+  included do
+    attr_accessor :mailchimp_user_form_action
+
+    has_many :mailchimp_list_members, -> { Effective::MailchimpListMember.sorted }, as: :user, class_name: 'Effective::MailchimpListMember', dependent: :destroy
+    accepts_nested_attributes_for :mailchimp_list_members, allow_destroy: true
+
+    has_many :mailchimp_lists, -> { Effective::MailchimpList.sorted }, through: :mailchimp_list_members, class_name: 'Effective::MailchimpList'
+    accepts_nested_attributes_for :mailchimp_lists, allow_destroy: true
+
+    # The user updated the form
+    after_commit(if: -> { mailchimp_user_form_action }) { mailchimp_update!(force: false) }
+  end
+
+  def mailchimp_subscribed_lists
+    mailchimp_list_members.select(&:subscribed?).map(&:mailchimp_list)
+  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 }
+  end
+
+  # Find or build
+  def build_mailchimp_list_member(mailchimp_list:)
+    raise('expected a MailchimpList') unless mailchimp_list.kind_of?(Effective::MailchimpList)
+    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
+  end
+
+  def mailchimp_sync_required?
+    return true if mailchimp_last_synced_at.blank?
+    mailchimp_last_synced_at < (Time.zone.now - 1.day)
+  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)
+    api = EffectiveMailchimp.api
+    lists = Effective::MailchimpList.subscribable.sorted.to_a
+
+    return if lists.length == mailchimp_list_members.length && !(force || mailchimp_sync_required?)
+
+    lists.each do |mailchimp_list|
+      member = build_mailchimp_list_member(mailchimp_list: mailchimp_list)
+
+      list_member = api.list_member(mailchimp_list, email) || {}
+      member.assign_mailchimp_attributes(list_member)
+    end
+
+    mailchimp_list_members.each do |member|
+      list = lists.find { |list| list.id == member.mailchimp_list_id }
+      member.mark_for_destruction unless list.present?
+    end
+
+    save! if mailchimp_list_members_changed?
+    true
+  end
+
+  # Pushes the current Mailchimp List Member objects to Mailchimp when needed
+  def mailchimp_update!(force: true)
+    api = EffectiveMailchimp.api
+
+    assign_attributes(mailchimp_user_form_action: nil)
+
+    mailchimp_list_members.map 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))
+        list_member = api.list_member_update(member)
+        member.assign_mailchimp_attributes(list_member)
+      end
+    end
+
+    save! if mailchimp_list_members_changed?
+    true
+  end
+
+  def mailchimp_member_update_required?(member)
+    require_update = ['email', 'last_name', 'first_name']
+
+    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?
+
+    false
+  end
+
+end

data/app/models/effective/mailchimp_api.rb

@@ -0,0 +1,84 @@
+# The Mailchimp API object
+# https://github.com/mailchimp/mailchimp-marketing-ruby
+# https://mailchimp.com/developer/marketing/api/
+
+require 'MailchimpMarketing'
+
+module Effective
+  class MailchimpApi
+    attr_accessor :api_key
+    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?
+
+      @api_key = api_key
+      @server = server
+
+      @client = ::MailchimpMarketing::Client.new()
+      @client.set_config(api_key: api_key, server: server)
+    end
+
+    def admin_url
+      "https://#{server}.admin.mailchimp.com"
+    end
+
+    def ping
+      client.ping.get()
+    end
+
+    # Returns an Array of Lists, which are each Hash
+    # Like this [{ ...}, { ... }]
+    def lists
+      response = client.lists.get_all_lists()
+      Array(response['lists']) - [nil, '', {}]
+    end
+
+    def list(id)
+      client.lists.get_list(id.try(:mailchimp_id) || id)
+    end
+
+    def list_member(id, email)
+      raise('expected an email') unless email.to_s.include?('@')
+
+      begin
+        client.lists.get_list_member(id.try(:mailchimp_id) || id, email)
+      rescue MailchimpMarketing::ApiError => e
+        {}
+      end
+    end
+
+    def list_member_add(member)
+      raise('expected an Effective::MailchimpListMember') unless member.kind_of?(Effective::MailchimpListMember)
+
+      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)
+        }
+      }
+
+      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 = {
+        email_address: member.user.email,
+        status: (member.subscribed ? 'subscribed' : 'unsubscribed'),
+        merge_fields: {
+          'FNAME': member.user.try(:first_name),
+          'LNAME': member.user.try(:last_name)
+        }
+      }
+
+      client.lists.update_list_member(member.mailchimp_list.mailchimp_id, member.email, payload)
+    end
+
+  end
+end

data/app/models/effective/mailchimp_list.rb

@@ -0,0 +1,69 @@
+module Effective
+  class MailchimpList < ActiveRecord::Base
+
+    self.table_name = (EffectiveMailchimp.mailchimp_lists_table_name || :mailchimp_lists).to_s
+
+    effective_resource do
+      mailchimp_id    :string
+      web_id          :string
+
+      name            :string
+      can_subscribe   :boolean
+
+      timestamps
+    end
+
+    def to_s
+      name.presence || model_name.human
+    end
+
+    scope :deep, -> { all }
+    scope :sorted, -> { order(:name) }
+    scope :subscribable, -> { where(can_subscribe: true) }
+
+    # Creates or builds all the Lists
+    def self.sync!
+      # All the Lists from Mailchimp
+      lists = EffectiveMailchimp.api.lists
+
+      # Get all our existing Effective::MailchimpList records
+      mailchimp_lists = all()
+
+      # 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.save!
+      end
+
+      # Destroy any Effective::Mailchimp resources if they no longer returned by lists
+      mailchimp_lists.each do |mailchimp_list|
+        list = lists.find { |list| list['id'] == mailchimp_list.mailchimp_id }
+        mailchimp_list.destroy! unless list.present?
+      end
+
+      true
+    end
+
+    def url
+      EffectiveMailchimp.api.admin_url + "/campaigns/#f_list:#{web_id}"
+    end
+
+    def members_url
+      EffectiveMailchimp.api.admin_url + "/lists/members?id=#{web_id}"
+    end
+
+    def can_subscribe!
+      update!(can_subscribe: true)
+    end
+
+    def cannot_subscribe!
+      update!(can_subscribe: false)
+    end
+
+  end
+end

data/app/models/effective/mailchimp_list_member.rb

@@ -0,0 +1,47 @@
+module Effective
+  class MailchimpListMember < ActiveRecord::Base
+    self.table_name = (EffectiveMailchimp.mailchimp_list_members_table_name || :mailchimp_list_members).to_s
+
+    belongs_to :user, polymorphic: true
+    belongs_to :mailchimp_list
+
+    log_changes(to: :user, except: :last_synced_at) if respond_to?(:log_changes)
+
+    effective_resource do
+      mailchimp_id    :string
+      web_id          :string
+
+      email_address   :string
+      full_name       :string
+
+      subscribed      :boolean
+
+      last_synced_at  :datetime
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:mailchimp_list, :user) }
+    scope :sorted, -> { order(:id) }
+
+    def to_s
+      mailchimp_list&.to_s || model_name.human
+    end
+
+    def email
+      email_address.presence || user.email
+    end
+
+    def assign_mailchimp_attributes(atts)
+      assign_attributes(
+        mailchimp_id: atts['id'],
+        web_id: atts['web_id'],
+        email_address: atts['email_address'],
+        full_name: atts['full_name'],
+        subscribed: (atts['status'] == 'subscribed'),
+        last_synced_at: Time.zone.now
+      )
+    end
+
+  end
+end

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

@@ -0,0 +1,8 @@
+= 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.check_box :can_subscribe, label: 'Yes, display this list to users and allow them to subscribe'
+
+  = effective_submit(f)

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

@@ -0,0 +1,25 @@
+= card(ets(Effective::MailchimpList)) do
+  %p.text-muted #{user} is subscribed to #{pluralize(user.mailchimp_subscribed_lists.count, et(Effective::MailchimpList))}.
+
+  %p.text-muted
+    Please visit
+    = link_to 'All ' + ets(Effective::MailchimpList), effective_mailchimp.admin_mailchimp_lists_path, target: '_blank'
+    to configure which lists are displayed.
+
+  %p
+    %strong Subscribed
+
+  = 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
+        = time_ago_in_words(user.mailchimp_last_synced_at)
+        ago.
+        = 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

@@ -0,0 +1,4 @@
+= 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

data/config/effective_mailchimp.rb

@@ -0,0 +1,12 @@
+EffectiveMailchimp.setup do |config|
+  # config.mailchimp_lists_table_name = :mailchimp_lists
+  # config.mailchimp_list_members_table_name = :mailchimp_list_members
+
+  # Layout Settings
+  # Configure the Layout per controller, or all at once
+  # config.layout = { application: 'application', admin: 'admin' }
+
+  # 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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  mount EffectiveMailchimp::Engine => '/', as: 'effective_mailchimp'
+end
+
+EffectiveMailchimp::Engine.routes.draw do
+  # Public routes
+  scope module: 'effective' do
+  end
+
+  namespace :admin do
+    resources :mailchimp_lists, only: [:index, :edit, :update] do
+      post :can_subscribe, on: :member
+      post :cannot_subscribe, on: :member
+    end
+
+    resources :mailchimp, only: [] do
+      post :mailchimp_sync_user, on: :member
+    end
+
+  end
+
+end

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

@@ -0,0 +1,34 @@
+class CreateEffectiveMailchimp < ActiveRecord::Migration[6.0]
+  def change
+
+    create_table :mailchimp_lists do |t|
+      t.string :mailchimp_id
+      t.string :web_id
+      t.string :name
+
+      t.boolean :can_subscribe
+
+      t.timestamps
+    end
+
+    create_table :mailchimp_list_members do |t|
+      t.integer :user_id
+      t.string :user_type
+
+      t.integer :mailchimp_list_id
+
+      t.string :mailchimp_id
+      t.string :web_id
+
+      t.string :email_address
+      t.string :full_name
+
+      t.boolean :subscribed
+
+      t.datetime :last_synced_at
+
+      t.timestamps
+    end
+
+  end
+end

data/db/seeds.rb

@@ -0,0 +1 @@
+puts "Running effective_mailchimp seeds"

data/lib/effective_mailchimp/engine.rb

@@ -0,0 +1,18 @@
+module EffectiveMailchimp
+  class Engine < ::Rails::Engine
+    engine_name 'effective_mailchimp'
+
+    # Set up our default configuration options.
+    initializer 'effective_mailchimp.defaults', before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_mailchimp.rb")
+    end
+
+    # Include acts_as_mailchimp concern and allow any ActiveRecord object to call it
+    initializer 'effective_mailchimp.active_record' do |app|
+      app.config.to_prepare do
+        ActiveRecord::Base.extend(EffectiveMailchimpUser::Base)
+      end
+    end
+
+  end
+end

data/lib/effective_mailchimp/version.rb

@@ -0,0 +1,3 @@
+module EffectiveMailchimp
+  VERSION = '0.1.0'.freeze
+end

data/lib/effective_mailchimp.rb

@@ -0,0 +1,26 @@
+require 'effective_resources'
+require 'effective_datatables'
+require 'effective_mailchimp/engine'
+require 'effective_mailchimp/version'
+
+module EffectiveMailchimp
+
+  def self.config_keys
+    [
+      :mailchimp_lists_table_name, :mailchimp_list_members_table_name,
+      :layout,
+      :api_key, :server
+    ]
+  end
+
+  include EffectiveGem
+
+  def self.api
+    Effective::MailchimpApi.new(api_key: api_key, server: server)
+  end
+
+  def self.permitted_params
+    [ :mailchimp_user_form_action, mailchimp_list_members_attributes: [:id, :subscribed] ]
+  end
+
+end

data/lib/generators/effective_mailchimp/install_generator.rb

@@ -0,0 +1,28 @@
+module EffectiveMailchimp
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Creates an EffectiveMailchimp initializer in your application.'
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          '%.3d' % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_initializer
+        template ('../' * 3) + 'config/effective_mailchimp.rb', 'config/initializers/effective_mailchimp.rb'
+      end
+
+      def create_migration_file
+        migration_template ('../' * 3) + 'db/migrate/01_create_effective_mailchimp.rb.erb', 'db/migrate/create_effective_mailchimp.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/templates/effective_mailchimp_mailer_preview.rb

@@ -0,0 +1,4 @@
+# Visit http://localhost:3000/rails/mailers
+
+class EffectiveMailchimpMailerPreview < ActionMailer::Preview
+end

data/lib/tasks/effective_mailchimp_tasks.rake

@@ -0,0 +1,8 @@
+namespace :effective_mailchimp do
+
+  # bundle exec rake effective_mailchimp:seed
+  task seed: :environment do
+    load "#{__dir__}/../../db/seeds.rb"
+  end
+
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: effective_mailchimp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Code and Effect
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: MailchimpMarketing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_bootstrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_datatables
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: effective_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_test_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_developer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_email_templates
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Subscribe and unsubscribe to mailchimp lists.
+email:
+- info@codeandeffect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/effective_mailchimp_manifest.js
+- app/assets/javascripts/effective_mailchimp.js
+- app/assets/javascripts/effective_mailchimp/base.js
+- app/assets/stylesheets/effective_mailchimp.scss
+- app/assets/stylesheets/effective_mailchimp/base.scss
+- app/controllers/admin/mailchimp_controller.rb
+- app/controllers/admin/mailchimp_lists_controller.rb
+- app/datatables/admin/effective_mailchimp_lists_datatable.rb
+- app/helpers/effective_mailchimp_helper.rb
+- app/models/concerns/effective_mailchimp_user.rb
+- app/models/effective/mailchimp_api.rb
+- 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_user/_form.html.haml
+- app/views/effective/mailchimp_user/_fields.html.haml
+- config/effective_mailchimp.rb
+- config/routes.rb
+- db/migrate/01_create_effective_mailchimp.rb.erb
+- db/seeds.rb
+- lib/effective_mailchimp.rb
+- lib/effective_mailchimp/engine.rb
+- lib/effective_mailchimp/version.rb
+- lib/generators/effective_mailchimp/install_generator.rb
+- lib/generators/templates/effective_mailchimp_mailer_preview.rb
+- lib/tasks/effective_mailchimp_tasks.rake
+homepage: https://github.com/code-and-effect/effective_mailchimp
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Subscribe and unsubscribe to mailchimp lists.
+test_files: []