workarea-mail_chimp 3.0.2

data/lib/integrations/workarea/mail_chimp/gateway/subscribe_argument_builder.rb

@@ -0,0 +1,101 @@
+module Workarea
+  module MailChimp
+    class Gateway::SubscribeArgumentBuilder
+      attr_reader :email, :options, :default_list_id, :email_interests_id
+
+      def initialize(email, options, default_list_id, email_interests_id)
+        @email = email
+        @options = options
+        @default_list_id = default_list_id
+        @email_interests_id = email_interests_id
+      end
+
+      def build
+        args = get_args(email, options[:user], default_list_options)
+        merge_new_email(args, options)
+      end
+
+      private
+
+        def merge_new_email(args, options)
+          return args unless options[:new_email].present?
+          args.merge(merge_vars: { email: options[:new_email] })
+        end
+
+        def default_list_options
+          {
+            id: default_list_id,
+            double_optin: false,
+            send_welcome: true,
+            replace_interests: true,
+            update_existing: true, # updating existing so we can make same API
+            # call for new subscribers and existing subscribers
+            email_type: "html" # other option is "text"
+          }
+        end
+
+        def get_args(email, user = nil, options = {})
+          group_merge = merge_groups({}, user)
+          user_details_merge = merge_user_details({}, user)
+
+          { email_address: email }.
+            merge(options).
+            merge(merge_fields: user_details_merge).
+            merge(group_merge)
+        end
+
+        def merge_user_details(merge_vars, user)
+          return merge_vars unless user.present?
+          merge_vars[:FNAME] = user.first_name if user.first_name.present?
+          merge_vars[:LNAME] = user.last_name if user.last_name.present?
+          merge_vars
+        end
+
+        def merge_groups(merge_vars, user)
+          if user&.groups.present?
+            merge_vars.merge(interests: build_merged_groups(user.groups))
+          else
+            merge_vars.merge(interests: build_merged_groups(all_groups))
+          end
+        end
+
+        def build_merged_groups(groups)
+          hash = groups.first.interests.each_with_object({}) do |(id, _int), hsh|
+            hsh[id] = true
+          end
+          all_interests.each do |id, int|
+            hash[id] = false unless hash.keys.include?(id)
+          end
+
+          hash
+        end
+
+        def all_groups
+          [default_group(group_interests)]
+        end
+
+        def all_interests
+          group_interests.inject({}) { |aggregate, int| aggregate.merge(int.interests) }
+        end
+
+        def default_group(groups)
+          default = groups.detect do |group|
+            group.id == email_interests_id
+          end
+
+          default || groups.first
+        end
+
+        def group_interests
+          key = "mail_chimp_email_interests/#{Workarea::MailChimp.config.default_store[:list_id]}"
+          options = { expires_in: 1.hour }
+
+          options.merge!(force: true) if Rails.cache.read(key).nil?
+
+          Rails.cache.fetch(key, options) do
+            Workarea::MailChimp.gateway.list.interests
+          end
+        end
+    end
+  end
+end

data/lib/tasks/mail_chimp.rake

@@ -0,0 +1,71 @@
+require 'workarea/mail_chimp/tasks/ecommerce'
+
+namespace :workarea do
+  namespace :mail_chimp do
+    desc 'Seed MailChimp data'
+    task install: :environment do
+      Rake::Task['workarea:mail_chimp:seed_store'].execute
+      Rake::Task['workarea:mail_chimp:seed_products'].execute
+      Rake::Task['workarea:mail_chimp:seed_orders'].execute
+    end
+
+    desc 'Create Default Store for MailChimp Ecommerce'
+    task seed_store: :environment do
+      puts 'Creating Store ...'
+      Workarea::MailChimp::Tasks::Ecommerce.create_store
+    end
+
+    desc 'Export full products to MailChimp'
+    task seed_products: :environment do
+      puts 'Creating Products...'
+      raise RuntimeError.new("No Store ID set in configuration!") unless Workarea::MailChimp.config.default_store[:id].present?
+
+      Workarea::Catalog::Product.purchasable.each do |product|
+        next if product.variants.empty?
+
+        mc_product = Workarea::MailChimp::Product.new(product)
+
+        request = Workarea::MailChimp.request
+        store_id = Workarea::MailChimp.config.default_store[:id]
+
+        if product.exported_to_mail_chimp_at.present?
+          puts "Updating #{product.name}"
+          request.ecommerce.stores(store_id).products(product.id.to_s).update(body: mc_product.to_h)
+        else
+          puts "Creating #{product.name}"
+          request.ecommerce.stores(store_id).products.create(body: mc_product.to_h)
+
+          product.update_attributes!(exported_to_mail_chimp_at: Time.current)
+        end
+      end
+    end
+
+    desc 'Export full orders to MailChimp'
+    task seed_orders: :environment do
+      puts 'Creating Orders...'
+      raise RuntimeError.new("No Store ID set in configuration!") unless Workarea::MailChimp.config.default_store[:id].present?
+
+      # turn on the syncing feature of MC - this will stop users from getting unwanted emails
+      puts "Enable store sync"
+      Workarea::MailChimp::Store.with_syncing_enabled do
+
+        Workarea::Order.placed.each do |order|
+
+          request = Workarea::MailChimp.request
+          store_id = Workarea::MailChimp.config.default_store[:id]
+          mc_order = Workarea::MailChimp::Order.new(order)
+
+          if order.exported_to_mail_chimp_at.present?
+            puts "Updating #{order.id}"
+            request.ecommerce.stores(store_id).orders(order.id.to_s).update(body: mc_order.to_h)
+          else
+            puts "Creating #{order.id}"
+            request.ecommerce.stores(store_id).orders.create(body: mc_order.to_h)
+
+            order.update_attributes!(exported_to_mail_chimp_at: Time.current)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workarea/mail_chimp.rb

@@ -0,0 +1,72 @@
+require "workarea"
+require "workarea/storefront"
+require "workarea/admin"
+require "gibbon"
+require 'gibbon/request_decorator'
+
+module Workarea
+  module MailChimp
+    def self.credentials
+      (Rails.application.secrets.mail_chimp || {}).deep_symbolize_keys
+    end
+
+    def self.api_key
+      credentials[:api_key]
+    end
+
+    def self.config
+      Workarea.config.mail_chimp
+    end
+
+    def self.default_list_id
+      Workarea.config[:default_list_id]
+    end
+
+    def self.list_prefrences_id
+      Workarea.config[:default_list_id]
+    end
+
+    def self.config
+      Workarea.config.mail_chimp
+    end
+
+    def self.current_store
+      return unless config&.default_store && config.default_store[:id].present?
+
+      Store.find_by(mail_chimp_id: config.default_store[:id]) rescue nil
+    end
+
+    def self.initialize_gateway
+      if Rails.application.secrets.mail_chimp.present?
+        secrets = Rails.application.secrets.mail_chimp.deep_symbolize_keys
+        Workarea.config.gateways.mail_chimp = Workarea::MailChimp::Gateway.new(
+          secrets[:default_list_id],
+          secrets[:list_preferences_id]
+        )
+      else
+        Workarea.config.gateways.mail_chimp = Workarea::MailChimp::BogusGateway.new
+      end
+    end
+
+    def self.gateway
+      if credentials.present?
+        Workarea::MailChimp::Gateway.new
+      else
+        Workarea::MailChimp::BogusGateway.new
+      end
+    end
+
+    # Returns a single use gibbon request object
+    def self.request
+      if Workarea::MailChimp.api_key.present?
+        Gibbon::Request.new(api_key: Workarea::MailChimp.api_key)
+      else
+        Workarea::MailChimp::BogusRequest.new(api_key: 'test-us1')
+      end
+    end
+  end
+end
+
+require "workarea/mail_chimp/version"
+require "workarea/mail_chimp/errors"
+require "workarea/mail_chimp/engine"

data/lib/workarea/mail_chimp/engine.rb

@@ -0,0 +1,14 @@
+module Workarea
+  module MailChimp
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+
+      isolate_namespace Workarea::MailChimp
+
+      %w(lib/integrations).each do |path|
+        config.autoload_paths << "#{config.root}/#{path}"
+        config.eager_load_paths << "#{config.root}/#{path}"
+      end
+    end
+  end
+end

data/lib/workarea/mail_chimp/errors.rb

@@ -0,0 +1,2 @@
+class Workarea::MailChimp::Errors < StandardError; end
+class Workarea::MailChimp::Errors::UserAlreadySubscribed < Workarea::MailChimp::Errors; end

data/lib/workarea/mail_chimp/tasks/ecommerce.rb

@@ -0,0 +1,43 @@
+module Workarea
+  module MailChimp
+    module Tasks
+      module Ecommerce
+        extend self
+
+        # Creates an ecommerce store in Mail Chimp
+        def create_store
+          raise RuntimeError.new("No list id defined in store configuration!") unless Workarea::MailChimp.config.default_store[:list_id].present?
+
+          if Workarea::MailChimp::Store.where(mail_chimp_id: Workarea::MailChimp.config.default_store[:id]).exists?
+            raise RuntimeError, "Mailchimp store with id #{Workarea::MailChimp.config.default_store[:id]} already exists"
+          end
+
+          request = Workarea::MailChimp.request
+          begin
+            response = request.ecommerce.stores.create(body: Workarea::MailChimp.config.default_store)
+          rescue Gibbon::MailChimpError => error
+            raise RuntimeError, error.detail
+          end
+
+          Workarea::MailChimp::Store.create!(
+            mail_chimp_id: response.body["id"],
+            list_id: response.body["list_id"],
+            name: response.body["name"],
+            currency_code: response.body["currency_code"],
+            connected_site: response.body.dig("connected_site"),
+          )
+
+          connected_site_id = response.body.dig("connected_site", "site_foreign_id")
+
+          Workarea::MailChimp
+            .request
+            .connected_sites
+            .add_path_part(connected_site_id)
+            .actions
+            .send('verify-script-installation')
+            .create
+        end
+      end
+    end
+  end
+end

data/lib/workarea/mail_chimp/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module MailChimp
+    VERSION = "3.0.2".freeze
+  end
+end

data/script/admin_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:admin

data/script/ci

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bundle exec workarea-lint
+bundle exec workarea-audit
+bin/rails test test/**/*_test.rb

data/script/core_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:core

data/script/plugins_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:plugins

data/script/storefront_ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+gem install bundler
+bundle update
+
+CI_GEM_PATH="$(bundle show workarea-ci)"
+. ${CI_GEM_PATH}/exe/workarea-set-ci-env
+
+bin/rails app:workarea:test:storefront

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

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

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end