workarea-mail_chimp 3.0.2

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "workarea", source: "https://gems.weblinc.com"
+
+group :test, :development do
+  gem "simplecov", require: false
+end

data/README.md

@@ -0,0 +1,115 @@
+Workarea Mail Chimp
+================================================================================
+
+MailChimp plugin for the Worakrea e-commerce platform
+
+This plugin creates a basic integration between the WebLinc platform and
+MailChimp's v3 API
+
+It requires a mailchimp access token which can be generated by following
+MailChimp's OAuth2 Flow here: <http://developer.mailchimp.com/documentation/mailchimp/guides/how-to-use-oauth2/>
+
+Scope and Dependencies
+--------------------------------------------------------------------------------
+
+This plugin currently wraps functionality for subscribing and unsubscribing users
+by email, as well as retrieving interest groups (or categories) for users and lists
+
+It is dependant on the [gibbon rubygem](https://github.com/amro/gibbon) which
+provides a basic wrapper for the MailChimp v3 API.
+
+Configuration
+--------------------------------------------------------------------------------
+
+This plugin requires gateway configuration in order to function.
+
+In your secrets file:
+
+    mail_chimp:
+      :api_key: APIKEY
+      :default_list_id: LIST_ID
+      :list_preferences_id: LIST_PREFERENCES_ID
+
+### To find your default list ID, in the mailchimp admin:
+
+1. Go to the list you wish to use
+2. Click the settings dropdown menu
+3. Choose the 'List name and defaults' menu item
+4. You will find the List ID on this page, at the time of writing it is displayed
+    at the top left of the page.
+
+### To find your list preferences ID via the API playground:
+
+1. Visit [API playground](https://us16.api.mailchimp.com/playground/)
+2. Enter your API key
+3. Click on the 'Lists' Link
+4. Find the subresources dropdown for your default list
+5. Choose 'interest-categories' from the subresources dropdown
+6. Click the name of your interest group
+7. Use the ID field shown in the details section, the 'list_id' field should
+    correspond with your default_list_id
+
+Testing & Maintenance
+--------------------------------------------------------------------------------
+
+Ensure that the gateway credentials within application secrets are set in
+`spec/dummy/config/secrets.yml` for test mode
+
+To get specs to pass, you will need to configure a MailChimp account with the
+following data
+
+* A group/category with the same information as what is configured in
+    `HelperMethods#email_all_interests_hash` in `spec/fixtures/helper_methods.rb`
+
+* A user that was unsubscribed with the following email: `test-unsubscribed@weblinc.com`
+
+* A subscribed user with the following email: `mdalton-simonpearce@weblinc.com`
+
+The specs use VCR cassettes to record http requests, so maintainers will need to
+    flush the cassettes when modifying the requests.
+
+Getting Started
+--------------------------------------------------------------------------------
+
+This gem contains a rails engine that must be mounted onto a host Rails application.
+
+You must have access to a WebLinc gems server to use this gem. Add your gems
+server credentials to Bundler:
+
+    bundle config gems.weblinc.com my_username:my_password
+
+Or set the appropriate environment variable in a shell startup file:
+
+    export BUNDLE_GEMS__WEBLINC__COM='my_username:my_password'
+
+Then add the gem to your application's Gemfile specifying the source:
+
+    # ...
+    gem 'workarea-mail_chimp', source: 'https://gems.weblinc.com'
+    # ...
+
+Or use a source block:
+
+    # ...
+    source 'https://gems.weblinc.com' do
+      gem 'workarea-mail_chimp'
+    end
+    # ...
+
+Update your application's bundle.
+
+    cd path/to/application
+    bundle
+
+WebLinc Platform Documentation
+--------------------------------------------------------------------------------
+
+See [http://developer.weblinc.com](http://developer.weblinc.com) for Workarea
+platform documentation.
+
+Copyright & Licensing
+--------------------------------------------------------------------------------
+
+Copyright WebLinc 2015. All rights reserved.
+
+For licensing, contact sales@weblinc.com.

data/Rakefile

@@ -0,0 +1,53 @@
+#!/usr/bin/env rake
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Tasker"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+load "workarea/changelog.rake"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "workarea/mail_chimp/version"
+
+desc "Release version #{Workarea::MailChimp::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task["workarea:changelog"].execute
+  #system "git add CHANGELOG.md"
+  #system 'git commit -m "Update CHANGELOG"'
+  #system "git push origin HEAD"
+
+  system "git tag -a v#{Workarea::MailChimp::VERSION} -m 'Tagging #{Workarea::MailChimp::VERSION}'"
+  system "git push --tags"
+
+  system "gem build workarea-mail_chimp.gemspec"
+  system "gem push workarea-mail_chimp-#{Workarea::MailChimp::VERSION}.gem"
+  system "gem push workarea-mail_chimp-#{Workarea::MailChimp::VERSION}.gem --host #{host}"
+  system "rm workarea-mail_chimp-#{Workarea::MailChimp::VERSION}.gem"
+end

data/app/assets/javascripts/workarea/storefront/mail_chimp/mail_chimp_tracking.js

@@ -0,0 +1,15 @@
+/**
+ * @namespace WORKAREA.mailchimpTracking
+ */
+WORKAREA.registerModule('mailchimpTracking', (function () {
+    'use strict';
+
+    var setCookie = function() {
+            var tracking_value = WORKAREA.url.parse(document.URL).queryKey.mc_cid;
+
+            if (_.isUndefined(tracking_value)) { return; }
+
+            WORKAREA.cookie.create('mc_cid', tracking_value, 30);
+        };
+    setCookie();
+}()));

data/app/controllers/workarea/storefront/application_controller.decorator

@@ -0,0 +1,11 @@
+module Workarea
+  module Storefront
+    decorate ApplicationController, with: :mail_chimp do
+      def current_order
+        super.tap do |order|
+          order.mail_chimp_campaign_id = cookies[:mc_cid]
+        end
+      end
+    end
+  end
+end

data/app/controllers/workarea/storefront/cart_items_controller.decorator

@@ -0,0 +1,18 @@
+module Workarea
+  decorate Storefront::CartItemsController, with: :mail_chimp do
+    decorated do
+      after_action :sync_with_mailchimp, only: [:create, :update]
+    end
+
+    def destroy
+      super
+      Workarea::MailChimp::Ecommerce::SaveCart.perform_async(current_order.id, deleted_item_id: params[:id])
+    end
+
+    private
+
+    def sync_with_mailchimp
+      Workarea::MailChimp::Ecommerce::SaveCart.perform_async(current_order.id, { })
+    end
+  end
+end

data/app/controllers/workarea/storefront/checkout/addresses_controller.decorator

@@ -0,0 +1,13 @@
+module Workarea
+  decorate Storefront::Checkout::AddressesController, with: :mail_chimp do
+    decorated do
+      after_action :sync_with_mailchimp, only: [:update_addresses]
+    end
+
+    private
+
+    def sync_with_mailchimp
+      Workarea::MailChimp::Ecommerce::SaveCart.perform_async(current_order.id)
+    end
+  end
+end

data/app/controllers/workarea/storefront/checkout/shipping_controller.decorator

@@ -0,0 +1,13 @@
+module Workarea
+  decorate Storefront::Checkout::ShippingController, with: :mail_chimp do
+    decorated do
+      after_action :sync_with_mailchimp, only: [:update_shipping]
+    end
+
+    private
+
+    def sync_with_mailchimp
+      Workarea::MailChimp::Ecommerce::SaveCart.perform_async(current_order.id)
+    end
+  end
+end

data/app/controllers/workarea/storefront/users/accounts_controller.decorator

@@ -0,0 +1,37 @@
+module Workarea
+  decorate Storefront::Users::AccountsController, with: :mail_chimp do
+    decorated { before_action :set_email_interests, only: :edit }
+
+    private
+
+    def user_params
+      @user_params ||= super
+        .merge(params.permit(:email_signup, :groups))
+        .merge(sanitize_groups_param(params))
+    end
+
+    def sanitize_groups_param(params)
+      @sanitize_groups_param ||= Hash[
+        :groups,
+        params.fetch(:groups, []).map do |group|
+          {
+            _id: group[:id],
+            name: group[:name],
+            interests: group[:interests].to_unsafe_hash
+          }
+        end
+      ]
+    end
+
+    def set_email_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?
+
+      @email_interests = Rails.cache.fetch(key, options) do
+        Workarea::MailChimp.gateway.list.interests
+      end
+    end
+  end
+end

data/app/models/workarea/catalog/product.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate Catalog::Product, with: :mail_chimp do
+    decorated do
+      field :exported_to_mail_chimp_at, type: Time
+    end
+  end
+end

data/app/models/workarea/mail_chimp/group.rb

@@ -0,0 +1,39 @@
+module Workarea
+  module MailChimp
+    class Group
+      include ApplicationDocument
+
+      field :_id, type: String
+      field :name, type: String
+      field :interests, type: Hash
+
+      embedded_in :user, class_name: "Workarea::User"
+
+      validate :id_or_name
+
+      def self.email_interests
+        MailChimp.gateway.get_default_list_interests.first
+      end
+
+      def to_hash
+        [_id, name, interests].hash
+      end
+
+      def to_s
+        "#{name} (#{id}) - #{interests}"
+      end
+
+      def ==(other)
+        self.name == other[:name] && self.interests == other[:interests]
+      end
+
+      private
+
+        def id_or_name
+          unless id.present? || name.present?
+            self.errors[:base] << "An ID or Name is Required."
+          end
+        end
+    end
+  end
+end

data/app/models/workarea/mail_chimp/store.rb

@@ -0,0 +1,26 @@
+module Workarea
+  module MailChimp
+    class Store
+      include ApplicationDocument
+
+      field :mail_chimp_id, type: String
+      field :list_id, type: String
+      field :name, type: String
+      field :currency_code, type: String
+      field :connected_site, type: Hash
+
+      index mail_chimp_id: 1
+
+      def self.with_syncing_enabled(&block)
+        MailChimp.request.ecommerce.stores(Workarea::MailChimp.config.default_store[:id]).update(body: { is_syncing: true })
+        block.call
+      ensure
+        MailChimp.request.ecommerce.stores(Workarea::MailChimp.config.default_store[:id]).update(body: { is_syncing: false })
+      end
+
+      def site_script_fragment
+        connected_site.dig("site_script", "fragment")
+      end
+    end
+  end
+end

data/app/models/workarea/order.decorator

@@ -0,0 +1,9 @@
+module Workarea
+  decorate Order, with: :mail_chimp do
+    decorated do
+      field :mail_chimp_campaign_id, type: String
+      field :exported_to_mail_chimp_at, type: Time
+      field :cart_exported_to_mail_chimp_at, type: Time
+    end
+  end
+end

data/app/models/workarea/user.decorator

@@ -0,0 +1,31 @@
+module Workarea
+  decorate User, with: :mail_chimp do
+    class_methods do
+      def default_groups
+        Workarea::MailChimp.gateway.interests
+      end
+    end
+
+    decorated do
+      before_validation :check_email_signup
+      before_save :default_groups_if_empty
+
+      field :email_signup, type: Boolean, default: false
+      embeds_many :groups, class_name: "Workarea::MailChimp::Group"
+    end
+
+    private
+
+      def check_email_signup
+        self.email_signup ||= Workarea::Email.signed_up?(self.email)
+      end
+
+      def default_groups_if_empty
+        return unless has_attribute?("email_signup")
+
+        if self.groups.empty? && self.email_signup?
+          self.groups = User.default_groups
+        end
+      end
+  end
+end

data/app/services/workarea/mail_chimp/address.rb

@@ -0,0 +1,28 @@
+module Workarea
+  module MailChimp
+    class Address
+
+      attr_reader :address, :options
+
+      def initialize(address, options = {})
+        @address = address
+        @options = options
+      end
+
+      # @return Hash
+      def to_h
+        {
+          name: address.first_name + " " + address.last_name,
+          address1: address.street,
+          address2: address.street_2.to_s,
+          city: address.city,
+          province: address.region.to_s,
+          postal_code: address.postal_code.to_s,
+          country: address.country.alpha2,
+          phone: address.phone_number.to_s,
+          company: address.company.to_s
+        }
+      end
+    end
+  end
+end