workarea-mail_chimp 3.0.2

data/app/workers/workarea/mail_chimp/list_unsubscriber.rb

@@ -0,0 +1,22 @@
+module Workarea
+  module MailChimp
+    class ListUnsubscriber
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: {
+          Email::Signup => [:destroy],
+          with: -> { [email] }
+        },
+        queue: "low",
+        retry: true
+      )
+
+      def perform(email)
+        User.find_by_email(email)&.update_attributes(email_signup: false)
+        Workarea::MailChimp.gateway.unsubscribe(email)
+      end
+    end
+  end
+end

data/app/workers/workarea/mail_chimp/subscription_edit.rb

@@ -0,0 +1,28 @@
+module Workarea
+  module MailChimp
+    class SubscriptionEdit
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: {
+          User => [:save],
+          ignore_if: -> { !SubscriptionEdit.should_enqueue?(id) }
+        },
+        queue: "low",
+        retry: true
+      )
+
+      def self.should_enqueue?(id)
+        user = User.find(id)
+        user.email_signup
+      end
+
+      def perform(id)
+        user = User.find(id)
+
+        Workarea::MailChimp.gateway.subscribe(user.email, user: user)
+      end
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("../..", __FILE__)
+ENGINE_PATH = File.expand_path("../../lib/mail_chimp/engine", __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+require "rails/test_unit/railtie"
+require "sprockets/railtie"
+
+require "rails/engine/commands"

data/config/initializers/appends.rb

@@ -0,0 +1,21 @@
+module Workarea
+  Plugin.append_partials(
+    "storefront.edit_account_details",
+    "workarea/storefront/users/accounts/edit"
+  )
+
+  Plugin.append_partials(
+    "storefront.show_account_details",
+    "workarea/storefront/users/accounts/email_interests"
+  )
+
+  Plugin.append_javascripts(
+    'storefront.modules',
+    'workarea/storefront/mail_chimp/mail_chimp_tracking'
+  )
+
+  Plugin.append_partials(
+    'storefront.javascript',
+    'workarea/storefront/mail_chimp/ecommerce_javascript'
+  )
+end

data/config/initializers/workarea.rb

@@ -0,0 +1,14 @@
+Workarea.configure do |config|
+  config.mail_chimp = ActiveSupport::Configurable::Configuration.new
+
+  config.mail_chimp.default_list_id = ''
+  config.mail_chimp.email_interests_id = ''
+
+  config.mail_chimp.default_store = {
+    id: "" ,
+    list_id: "",
+    name: "Ecommerce Store",
+    email_address: "",
+    currency_code: "USD"
+  }
+end

data/config/locales/en.yml

@@ -0,0 +1,15 @@
+en:
+  workarea:
+    storefront:
+      users:
+        edit:
+          subscribe_to_emails: Subscribe to Emails
+          email_interests: Email Interests
+        email_preferences:
+          email_subscriptions: Email Subscriptions
+          interests: Interests
+          none: None
+          subscribed: Subscribed
+          unsubscribe: Unsubscribe
+          unsubscribed: Unsubscribed
+          update_interests: Update Interests

data/lib/gibbon/request_decorator.rb

@@ -0,0 +1,10 @@
+module Gibbon
+  decorate Request, with: :mail_chimp do
+    # hack to add to the path keeping '_' intact
+    def add_path_part(part)
+      @path_parts << part.to_s.downcase
+      @path_parts.flatten!
+      self
+    end
+  end
+end

data/lib/integrations/workarea/mail_chimp/bogus_api_request.rb

@@ -0,0 +1,30 @@
+module Workarea
+  module MailChimp
+    class BogusAPIRequest
+
+      def initialize(builder: nil)
+        @request_builder = builder
+      end
+
+      def post(params: nil, headers: nil, body: nil)
+        Gibbon::Response.new(headers: {}, body: {})
+      end
+
+      def patch(params: nil, headers: nil, body: nil)
+        Gibbon::Response.new(headers: {}, body: {})
+      end
+
+      def put(params: nil, headers: nil, body: nil)
+        Gibbon::Response.new(headers: {}, body: {})
+      end
+
+      def get(params: nil, headers: nil)
+        Gibbon::Response.new(headers: {}, body: {})
+      end
+
+      def delete(params: nil, headers: nil)
+        Gibbon::Response.new(headers: {}, body: {})
+      end
+    end
+  end
+end

data/lib/integrations/workarea/mail_chimp/bogus_gateway.rb

@@ -0,0 +1,35 @@
+module Workarea
+  module MailChimp
+    class BogusGateway
+      delegate :interests, to: :list
+
+      class BogusList
+        def interests
+          [
+            Workarea::MailChimp::Group.new(
+              _id: 9,
+              name: "Email Interests",
+              interests: {
+                "7ca6cc1d86" => "Specials and Promotions",
+                "8911545594" => "Local Events",
+                "542a7ec7bb" => "Restaurant News and Events",
+                "6908d70674" => "Corporate Gifts and Awards"
+              }
+            )
+          ]
+        end
+      end
+
+      @@supported_methods = Workarea::MailChimp::Gateway.public_instance_methods
+
+      def list
+        BogusList.new
+      end
+
+      def method_missing(method, *args)
+        return true if @@supported_methods.include? method
+        super
+      end
+    end
+  end
+end

data/lib/integrations/workarea/mail_chimp/bogus_request.rb

@@ -0,0 +1,78 @@
+module Workarea
+  module MailChimp
+    class BogusRequest
+
+      def initialize(*)
+        @path_parts = []
+      end
+
+      def method_missing(method, *args)
+        # To support underscores, we replace them with hyphens when calling the API
+        @path_parts << method.to_s.gsub("_", "-").downcase
+        @path_parts << args if args.length > 0
+        @path_parts.flatten!
+
+        self
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        true
+      end
+
+      def send(*args)
+        if args.length == 0
+          method_missing(:send, args)
+        else
+          __send__(*args)
+        end
+      end
+
+      def path
+        @path_parts.join('/')
+      end
+
+      def create(params: nil, headers: nil, body: nil)
+        BogusAPIRequest.new(builder: self).post(params: params, headers: headers, body: body)
+        reset
+      end
+
+      def update(params: nil, headers: nil, body: nil)
+        BogusAPIRequest.new(builder: self).patch(params: params, headers: headers, body: body)
+        reset
+      end
+
+      def upsert(params: nil, headers: nil, body: nil)
+        BogusAPIRequest.new(builder: self).put(params: params, headers: headers, body: body)
+        reset
+      end
+
+      def retrieve(params: nil, headers: nil)
+        BogusAPIRequest.new(builder: self).get(params: params, headers: headers)
+        reset
+      end
+
+      def delete(params: nil, headers: nil)
+        BogusAPIRequest.new(builder: self).delete(params: params, headers: headers)
+        reset
+      end
+
+      protected
+
+      def reset
+        @path_parts = []
+      end
+
+      class << self
+        attr_accessor :api_key, :timeout, :open_timeout, :api_endpoint, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger
+
+        def method_missing(sym, *args, &block)
+          new.send(sym, *args, &block)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+module Workarea
+  module MailChimp
+    class Gateway
+      class MailChimpSubscriptionError < StandardError; end
+
+      attr_reader :default_list_id, :email_interests_id
+
+      delegate :details, to: :members
+      delegate :interests, to: :list
+
+      def self.acceptable_failure_codes
+        [
+          232, # Email_NotExists
+          220, # List_InvalidImport (banned user / invalid email)
+          400, # Member exists and cannot be subscribed
+          404, # User not found
+          500  # Inexplicable intermittent MailChimp-side error
+        ]
+      end
+
+      # Use this for new or current subscriptions
+      #
+      # email: String
+      # new_email: String
+      # user: User
+      #
+      def subscribe(email, options = {})
+        members.subscribe(
+          SubscribeArgumentBuilder.new(
+            email,
+            options,
+            default_list_id,
+            email_interests_id
+          ).build
+        )
+      end
+
+      # Unsubscribe email from default list. This does not delete the record in
+      # MailChimp.
+      #
+      # email: String
+      #
+      def unsubscribe(email, options = {})
+        members.unsubscribe(email)
+      end
+
+      def members
+        @members ||= MailChimp::Gateway::Members.new(default_list_id)
+      end
+
+      def list
+        @list ||=
+          MailChimp::Gateway::List.new(
+            default_list_id,
+            email_interests_id
+          )
+      end
+
+      private
+
+        def acceptable_failure?(error)
+          self.class.acceptable_failure_codes.include?(error.body["status"])
+        end
+
+        def response_error_handler(error)
+          if !acceptable_failure?(error)
+            raise MailChimpSubscriptionError, error.message
+          end
+
+          error_hash(error)
+        end
+
+        def error_hash(error)
+          { "error" => error.message }
+        end
+
+        def default_list_id
+          Workarea::MailChimp.config.default_list_id
+        end
+
+        def email_interests_id
+          Workarea::MailChimp.config.email_interests_id
+        end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module Workarea
+  module MailChimp
+    class Gateway::List < Gateway
+      def initialize(list_id, email_interests_id)
+        @list_id = list_id
+        @email_interests_id = email_interests_id
+      end
+
+      # Get the interest groups for the default list.
+      #
+      def interests
+        begin
+          response = MailChimp.request.lists(@list_id).interest_categories.retrieve
+
+          response.body["categories"].map do |grouping|
+            MailChimp::Group.new(
+              _id: grouping["id"],
+              name: grouping["title"],
+              interests: groupings(grouping["id"])
+            )
+          end
+
+        rescue StandardError => e
+          message = "MAIL CHIMP ERROR: Error - #{e}"
+          message += "Response - #{response['error']}" if response.is_a?(Hash)
+          []
+        end
+      end
+
+      private
+
+        def groupings(category_id)
+          response = MailChimp.request.lists(@list_id).interest_categories(category_id).interests.retrieve
+
+          sort_by_display_order(response.body)
+        end
+
+        def sort_by_display_order(grouping)
+          grouping["interests"].sort do |a, b|
+            a["display_order"].to_i <=> b["display_order"].to_i
+          end.each_with_object({}) do |interest, hash|
+            hash[interest["id"]] = interest["name"]
+          end
+        end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Workarea
+  module MailChimp
+    class Gateway::Members < Gateway
+      def initialize( default_list_id)
+        @default_list_id = default_list_id
+      end
+
+      # Returns Hash or nil
+      #
+      def details(email)
+        response ||= begin
+          MailChimp.request.lists(@default_list_id).members(digest_email(email)).retrieve
+          rescue ::Gibbon::MailChimpError => e
+            response_error_handler(e)
+          end
+
+        extract_member_details(response)
+      end
+
+      def unsubscribe(email, options = {})
+        begin
+          MailChimp.request.lists(@default_list_id).members(digest_email(email)).update(body: { status: "unsubscribed" })
+        rescue ::Gibbon::MailChimpError => e
+          response_error_handler(e)
+        end
+      end
+
+      def subscribe(subscribe_argument)
+        return unless subscribe_argument[:email_address]
+        begin
+          MailChimp.request.lists(@default_list_id).members(digest_email(subscribe_argument[:email_address])).upsert(body: subscribe_argument.merge("status" => "subscribed"))
+        rescue ::Gibbon::MailChimpError => e
+          response_error_handler(e)
+        end
+      end
+
+      private
+
+        # Returns
+        # * Hash of details for subscribed emails
+        # * nil if email does not exist
+        # * nil if email is unsubscribed
+        #
+        def extract_member_details(details)
+          if details["error"].present?
+            nil
+          elsif details["status"] == "unsubscribed"
+            nil
+          else
+            details
+          end
+        end
+
+        def digest_email(email)
+          md5 = Digest::MD5.new
+          md5.update(email.downcase)
+          md5.hexdigest
+        end
+    end
+  end
+end