spree_mail_chimp 3.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Sam Beam
+
+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.textile

@@ -0,0 +1,71 @@
+h1. Spree + Mail Chimp
+
+MailChimp API integration for your Spree store, using the hominid gem.
+
+Adds a checkbox to the user signup form to allow customer to opt-in to your Mailchimp mailing list. Mailchimp API calls happen via the hominid gem.
+
+Mailchimp subscription status is tracked with a boolean flag on the users table, we also fetch and store the unique MC record id when the subscription is created. This allows us to modify existing email addresses with minimal fuss.
+
+This is a very simple extension as of now, *any ideas suggestions or improvements welcome!*
+
+h2. Subscription form partial with JS
+
+Also includes a partial at <code>shared/newsletter_subscribe_form</code> that can be included in your footer or sidebar anywhere on the site, has one field for the email address. jQuery code in <code>public/javascripts/mailchimp_subscribe.js</code> will POST to the SubscriptionsController which will relay to Mailchimp.
+
+The SimpleModal plugin is used in the EJB to pop up a confirmation or error alert (because you won't be satisfied with a simple alert() box)
+
+h3. Installation
+
+Add to project's Gemfile:
+<pre><code>
+gem 'mail_chimp', '>=1.3', :git => 'git://github.com/sbeam/spree-mail-chimp.git'
+</code> </pre>
+
+Run from project's root:
+<pre><code>
+bundle install
+
+rails g spree_mail_chimp:install
+</code> </pre>
+
+h3. Configuration
+
+See the Mail Chimp Settings forms in the Admin under Configuration.
+
+Note, using Mail Chimp "Merge Vars", you can have any callable methods on User sent
+to the MC list, mapped to indentically named (but uppercased) fields in the MC list admin console.
+Unfortunately these are only sent at the time the subscription is created, so there isn't much available.
+
+h3. Changes
+
+Version 3.0.0 - released 19 Apr 2012 - Spree 1.0 compat
+Version 2.0.0 - released 6 Dec 2010 - Spree 0.30-stable
+Version 1.0.1 - released 21 Nov 2010 - Spree 0.11-stable
+
+h3. Requirements
+
+Spree >= 1.0
+hominid >= 2.2.0 http://rubygems.org/gems/hominid
+
+Also uses the jQuery SimpleModal plugin, included.
+
+h3. Credits
+
+Authored by Sam Beam @sbeam
+Migrated to Spree 0.30 by Bastian Schnurle @bzt
+Migrated to Spree 1.0 (and extensively refactored) by James Kong @jkongie
+
+Inspired originally by https://github.com/softa/mailee_spree
+
+includes SimpleModal http://www.ericmmartin.com/projects/simplemodal/
+
+h3. TODO
+
+* make subscribe_to_newsletter_field work
+* Send user address info to MC via merge vars, when address is given
+* Export new orders to Mailchimp for full CRM gnarliness
+* Utility to export existing users to Mailchimp
+* Add admin controller to view lists and subscriptions
+* Allow for multiple lists
+* Tests :/
+

data/app/assets/javascripts/store/jquery.simplemodal.1.4.min.js

@@ -0,0 +1,24 @@
+/*
+ * SimpleModal 1.4 - jQuery Plugin
+ * http://www.ericmmartin.com/projects/simplemodal/
+ * Copyright (c) 2010 Eric Martin (http://twitter.com/ericmmartin)
+ * Dual licensed under the MIT and GPL licenses
+ * Revision: $Id: jquery.simplemodal.js 256 2010-07-27 23:05:43Z emartin24 $
+ */
+(function(d){var k=d.browser.msie&&parseInt(d.browser.version)===6&&typeof window.XMLHttpRequest!=="object",l=null,f=[];d.modal=function(a,b){return d.modal.impl.init(a,b)};d.modal.close=function(){d.modal.impl.close()};d.modal.focus=function(a){d.modal.impl.focus(a)};d.modal.setContainerDimensions=function(){d.modal.impl.setContainerDimensions()};d.modal.setPosition=function(){d.modal.impl.setPosition()};d.modal.update=function(a,b){d.modal.impl.update(a,b)};d.fn.modal=function(a){return d.modal.impl.init(this,
+a)};d.modal.defaults={appendTo:"body",focus:true,opacity:50,overlayId:"simplemodal-overlay",overlayCss:{},containerId:"simplemodal-container",containerCss:{},dataId:"simplemodal-data",dataCss:{},minHeight:null,minWidth:null,maxHeight:null,maxWidth:null,autoResize:false,autoPosition:true,zIndex:1E3,close:true,closeHTML:'<a class="modalCloseImg" title="Close"></a>',closeClass:"simplemodal-close",escClose:true,overlayClose:false,position:null,persist:false,modal:true,onOpen:null,onShow:null,onClose:null};
+d.modal.impl={d:{},init:function(a,b){var c=this;if(c.d.data)return false;l=d.browser.msie&&!d.boxModel;c.o=d.extend({},d.modal.defaults,b);c.zIndex=c.o.zIndex;c.occb=false;if(typeof a==="object"){a=a instanceof jQuery?a:d(a);c.d.placeholder=false;if(a.parent().parent().size()>0){a.before(d("<span></span>").attr("id","simplemodal-placeholder").css({display:"none"}));c.d.placeholder=true;c.display=a.css("display");if(!c.o.persist)c.d.orig=a.clone(true)}}else if(typeof a==="string"||typeof a==="number")a=
+d("<div></div>").html(a);else{alert("SimpleModal Error: Unsupported data type: "+typeof a);return c}c.create(a);c.open();d.isFunction(c.o.onShow)&&c.o.onShow.apply(c,[c.d]);return c},create:function(a){var b=this;f=b.getDimensions();if(b.o.modal&&k)b.d.iframe=d('<iframe src="javascript:false;"></iframe>').css(d.extend(b.o.iframeCss,{display:"none",opacity:0,position:"fixed",height:f[0],width:f[1],zIndex:b.o.zIndex,top:0,left:0})).appendTo(b.o.appendTo);b.d.overlay=d("<div></div>").attr("id",b.o.overlayId).addClass("simplemodal-overlay").css(d.extend(b.o.overlayCss,
+{display:"none",opacity:b.o.opacity/100,height:b.o.modal?f[0]:0,width:b.o.modal?f[1]:0,position:"fixed",left:0,top:0,zIndex:b.o.zIndex+1})).appendTo(b.o.appendTo);b.d.container=d("<div></div>").attr("id",b.o.containerId).addClass("simplemodal-container").css(d.extend(b.o.containerCss,{display:"none",position:"fixed",zIndex:b.o.zIndex+2})).append(b.o.close&&b.o.closeHTML?d(b.o.closeHTML).addClass(b.o.closeClass):"").appendTo(b.o.appendTo);b.d.wrap=d("<div></div>").attr("tabIndex",-1).addClass("simplemodal-wrap").css({height:"100%",
+outline:0,width:"100%"}).appendTo(b.d.container);b.d.data=a.attr("id",a.attr("id")||b.o.dataId).addClass("simplemodal-data").css(d.extend(b.o.dataCss,{display:"none"})).appendTo("body");b.setContainerDimensions();b.d.data.appendTo(b.d.wrap);if(k||l)b.fixIE()},bindEvents:function(){var a=this;d("."+a.o.closeClass).bind("click.simplemodal",function(b){b.preventDefault();a.close()});a.o.modal&&a.o.close&&a.o.overlayClose&&a.d.overlay.bind("click.simplemodal",function(b){b.preventDefault();a.close()});
+d(document).bind("keydown.simplemodal",function(b){if(a.o.modal&&b.keyCode===9)a.watchTab(b);else if(a.o.close&&a.o.escClose&&b.keyCode===27){b.preventDefault();a.close()}});d(window).bind("resize.simplemodal",function(){f=a.getDimensions();a.o.autoResize?a.setContainerDimensions():a.o.autoPosition&&a.setPosition();if(k||l)a.fixIE();else if(a.o.modal){a.d.iframe&&a.d.iframe.css({height:f[0],width:f[1]});a.d.overlay.css({height:f[0],width:f[1]})}})},unbindEvents:function(){d("."+this.o.closeClass).unbind("click.simplemodal");
+d(document).unbind("keydown.simplemodal");d(window).unbind("resize.simplemodal");this.d.overlay.unbind("click.simplemodal")},fixIE:function(){var a=this,b=a.o.position;d.each([a.d.iframe||null,!a.o.modal?null:a.d.overlay,a.d.container],function(c,h){if(h){var g=h[0].style;g.position="absolute";if(c<2){g.removeExpression("height");g.removeExpression("width");g.setExpression("height",'document.body.scrollHeight > document.body.clientHeight ? document.body.scrollHeight : document.body.clientHeight + "px"');
+g.setExpression("width",'document.body.scrollWidth > document.body.clientWidth ? document.body.scrollWidth : document.body.clientWidth + "px"')}else{var e;if(b&&b.constructor===Array){c=b[0]?typeof b[0]==="number"?b[0].toString():b[0].replace(/px/,""):h.css("top").replace(/px/,"");c=c.indexOf("%")===-1?c+' + (t = document.documentElement.scrollTop ? document.documentElement.scrollTop : document.body.scrollTop) + "px"':parseInt(c.replace(/%/,""))+' * ((document.documentElement.clientHeight || document.body.clientHeight) / 100) + (t = document.documentElement.scrollTop ? document.documentElement.scrollTop : document.body.scrollTop) + "px"';
+if(b[1]){e=typeof b[1]==="number"?b[1].toString():b[1].replace(/px/,"");e=e.indexOf("%")===-1?e+' + (t = document.documentElement.scrollLeft ? document.documentElement.scrollLeft : document.body.scrollLeft) + "px"':parseInt(e.replace(/%/,""))+' * ((document.documentElement.clientWidth || document.body.clientWidth) / 100) + (t = document.documentElement.scrollLeft ? document.documentElement.scrollLeft : document.body.scrollLeft) + "px"'}}else{c='(document.documentElement.clientHeight || document.body.clientHeight) / 2 - (this.offsetHeight / 2) + (t = document.documentElement.scrollTop ? document.documentElement.scrollTop : document.body.scrollTop) + "px"';
+e='(document.documentElement.clientWidth || document.body.clientWidth) / 2 - (this.offsetWidth / 2) + (t = document.documentElement.scrollLeft ? document.documentElement.scrollLeft : document.body.scrollLeft) + "px"'}g.removeExpression("top");g.removeExpression("left");g.setExpression("top",c);g.setExpression("left",e)}}})},focus:function(a){var b=this;a=a&&d.inArray(a,["first","last"])!==-1?a:"first";var c=d(":input:enabled:visible:"+a,b.d.wrap);setTimeout(function(){c.length>0?c.focus():b.d.wrap.focus()},
+10)},getDimensions:function(){var a=d(window);return[d.browser.opera&&d.browser.version>"9.5"&&d.fn.jquery<"1.3"||d.browser.opera&&d.browser.version<"9.5"&&d.fn.jquery>"1.2.6"?a[0].innerHeight:a.height(),a.width()]},getVal:function(a,b){return a?typeof a==="number"?a:a==="auto"?0:a.indexOf("%")>0?parseInt(a.replace(/%/,""))/100*(b==="h"?f[0]:f[1]):parseInt(a.replace(/px/,"")):null},update:function(a,b){var c=this;if(!c.d.data)return false;c.d.origHeight=c.getVal(a,"h");c.d.origWidth=c.getVal(b,"w");
+c.d.data.hide();a&&c.d.container.css("height",a);b&&c.d.container.css("width",b);c.setContainerDimensions();c.d.data.show();c.o.focus&&c.focus();c.unbindEvents();c.bindEvents()},setContainerDimensions:function(){var a=this,b=a.d.origHeight?a.d.origHeight:d.browser.opera?a.d.container.height():a.getVal(a.d.container.css("height"),"h"),c=a.d.origWidth?a.d.origWidth:d.browser.opera?a.d.container.width():a.getVal(a.d.container.css("width"),"w"),h=a.d.data.outerHeight(true),g=a.d.data.outerWidth(true);
+a.d.origHeight=a.d.origHeight||b;a.d.origWidth=a.d.origWidth||c;var e=a.o.maxHeight?a.getVal(a.o.maxHeight,"h"):null,i=a.o.maxWidth?a.getVal(a.o.maxWidth,"w"):null;e=e&&e<f[0]?e:f[0];i=i&&i<f[1]?i:f[1];var j=a.o.minHeight?a.getVal(a.o.minHeight,"h"):"auto";b=b?a.o.autoResize&&b>e?e:b:h?h>e?e:a.o.minHeight&&j!=="auto"&&h<j?j:h:j;e=a.o.minWidth?a.getVal(a.o.minWidth,"w"):"auto";c=c?a.o.autoResize&&c>i?i:c:g?g>i?i:a.o.minWidth&&e!=="auto"&&g<e?e:g:e;a.d.container.css({height:b,width:c});a.d.wrap.css({overflow:h>
+b||g>c?"auto":"visible"});a.o.autoPosition&&a.setPosition()},setPosition:function(){var a=this,b,c;b=f[0]/2-a.d.container.outerHeight(true)/2;c=f[1]/2-a.d.container.outerWidth(true)/2;if(a.o.position&&Object.prototype.toString.call(a.o.position)==="[object Array]"){b=a.o.position[0]||b;c=a.o.position[1]||c}else{b=b;c=c}a.d.container.css({left:c,top:b})},watchTab:function(a){var b=this;if(d(a.target).parents(".simplemodal-container").length>0){b.inputs=d(":input:enabled:visible:first, :input:enabled:visible:last",
+b.d.data[0]);if(!a.shiftKey&&a.target===b.inputs[b.inputs.length-1]||a.shiftKey&&a.target===b.inputs[0]||b.inputs.length===0){a.preventDefault();b.focus(a.shiftKey?"last":"first")}}else{a.preventDefault();b.focus()}},open:function(){var a=this;a.d.iframe&&a.d.iframe.show();if(d.isFunction(a.o.onOpen))a.o.onOpen.apply(a,[a.d]);else{a.d.overlay.show();a.d.container.show();a.d.data.show()}a.o.focus&&a.focus();a.bindEvents()},close:function(){var a=this;if(!a.d.data)return false;a.unbindEvents();if(d.isFunction(a.o.onClose)&&
+!a.occb){a.occb=true;a.o.onClose.apply(a,[a.d])}else{if(a.d.placeholder){var b=d("#simplemodal-placeholder");if(a.o.persist)b.replaceWith(a.d.data.removeClass("simplemodal-data").css("display",a.display));else{a.d.data.hide().remove();b.replaceWith(a.d.orig)}}else a.d.data.hide().remove();a.d.container.hide().remove();a.d.overlay.hide();a.d.iframe&&a.d.iframe.hide().remove();setTimeout(function(){a.d.overlay.remove();a.d={}},10)}}}})(jQuery);

data/app/assets/javascripts/store/mailchimp_subscribe.js

@@ -0,0 +1,46 @@
+
+var subscribe_email_default_txt = '';
+
+jQuery.ajaxSetup({
+    'beforeSend': function(xhr) {xhr.setRequestHeader("Accept", "text/javascript")}
+});
+
+var SpreeMailchimpApp = {
+
+  doSubmit: function(e) {
+          SpreeMailchimpApp.getBusy(null); // could really use $.proxy here but spree doesn't have 1.4
+          $.post(this.action+'.js', $(this).serialize(), SpreeMailchimpApp.getNotBusy, "script");
+          return false;
+  },
+
+  getBusy : function( fn ) {
+          $("body").css('cursor', 'progress');
+          $("#busy_indicator").fadeIn('fast', fn);
+  },
+
+  getNotBusy : function() {
+          $("body").css('cursor', 'default');
+          $("#busy_indicator").fadeOut('fast');
+  }
+
+};
+
+
+
+jQuery(document).ready( function() {
+
+    subscribe_email_default_txt = $('#subscribe_email').val();
+
+    $('#subscribe_email').bind('focus', function() {
+      if (this.value == subscribe_email_default_txt) this.value = '';
+    });
+    $('#subscribe_email').bind('blur', function() {
+      if (this.value == '') this.value = subscribe_email_default_txt;
+    });
+
+    $('#mailchimp_subscribe_wrap form').bind('submit', SpreeMailchimpApp.doSubmit);
+
+});
+
+
+

data/app/assets/javascripts/store/spree_mail_chimp.js

@@ -0,0 +1 @@
+//= require store/spree_core

data/app/assets/stylesheets/store/mail_chimp.css

@@ -0,0 +1,21 @@
+/* basic styles for simplemodal dialog to match Spree sample store */
+.simplemodal-overlay {
+    background: #333;
+}
+.simplemodal-container {
+    border: 2px solid #162f54;
+    background: #fff;
+    width: 45%;
+}
+.simplemodal-close {
+    border-bottom: 1px solid #fff;
+    text-align: right;
+    background: #162f54;
+    color: #fff;
+}
+.simplemodal-container h1 {
+    font-size: 110%;
+}
+.simplemodal-data {
+    padding: 0.7em;
+}

data/app/assets/stylesheets/store/spree_mail_chimp.css

@@ -0,0 +1,4 @@
+/*
+ *= require store/spree_core
+ *= require_tree .
+*/

data/app/controllers/spree/admin/mail_chimp_settings_controller.rb

@@ -0,0 +1,21 @@
+module Spree
+
+  class Admin::MailChimpSettingsController < Admin::BaseController
+
+    def show
+    end
+
+    def update
+      Spree::Config.set(params[:preferences])
+
+      respond_to do |format|
+        format.html {
+          redirect_to admin_mail_chimp_settings_path
+        }
+      end
+    end
+  end
+
+end
+
+

data/app/controllers/spree/subscriptions_controller.rb

@@ -0,0 +1,39 @@
+class Spree::SubscriptionsController < Spree::BaseController
+
+  def hominid
+    @hominid ||= Hominid::Base.new({ :api_key => Spree::Config.get(:mailchimp_api_key) })
+  end
+
+  def create
+    @errors = []
+
+    if params[:email].blank?
+      @errors << t('missing_email')
+    elsif params[:email] !~ /[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}/i
+      @errors << t('invalid_email_address')
+    else
+      begin
+        self.class.benchmark "Checking if address exists and/or is valid" do
+          @mc_member = hominid.member_info(Spree::Config.get(:mailchimp_list_id), params[:email])
+        end
+        rescue Hominid::ListError => e
+      end
+
+      if @mc_member
+        @errors << t('that_address_is_already_subscribed')
+      else
+        begin
+          self.class.benchmark "Adding mailchimp subscriber" do
+            hominid.subscribe(Spree::Config.get(:mailchimp_list_id), params[:email], {}, MailChimpSync::Sync::mc_subscription_opts)
+          end
+        rescue Hominid::ValidationError => e
+          @errors << t('invalid_email_address')
+        end
+      end
+    end
+
+    respond_to do |wants|
+      wants.js
+    end
+  end
+end

data/app/models/app_configuration_decorator.rb

@@ -0,0 +1,10 @@
+Spree::AppConfiguration.class_eval do
+
+  preference :mailchimp_double_opt_in, :boolean, :default => false
+  preference :mailchimp_send_welcome,  :boolean, :default => false
+  preference :mailchimp_send_notify,   :boolean, :default => false
+  preference :mailchimp_merge_vars,    :string, :default => ''
+  preference :mailchimp_list_id,       :string
+  preference :mailchimp_api_key,       :string
+
+end

data/app/models/user_decorator.rb

@@ -0,0 +1,121 @@
+Spree::User.class_eval do
+
+  before_create :mailchimp_add_to_mailing_list
+  before_update :mailchimp_update_in_mailing_list, :if => :is_mail_list_subscriber_changed?
+
+  attr_accessible :is_mail_list_subscriber
+
+  private
+
+  # Subscribes a user to the mailing list
+  #
+  # Returns ?
+  def mailchimp_add_to_mailing_list
+    if self.is_mail_list_subscriber?
+      begin
+        hominid.list_subscribe(mailchimp_list_id, self.email, mailchimp_merge_vars, 'html', *mailchimp_subscription_opts)
+        logger.debug "Fetching new mailchimp subscriber info"
+
+        assign_mailchimp_subscriber_id if self.mailchimp_subscriber_id.blank?
+      rescue Hominid::APIError => e
+        logger.warn "SpreeMailChimp: Failed to create contact in Mailchimp: #{e.message}"
+      end
+    end
+  end
+
+  # Removes the User from the Mailchimp mailing list
+  #
+  # Returns ?
+  def mailchimp_remove_from_mailing_list
+    if !self.is_mail_list_subscriber? && self.mailchimp_subscriber_id.present?
+      begin
+        # TODO: Get rid of those magic values. Maybe add them as Spree::Config options?
+        hominid.list_unsubscribe(mailchimp_list_id, self.email, false, false, true)
+        logger.debug "Removing mailchimp subscriber"
+      rescue Hominid::APIError => e
+        logger.warn "SpreeMailChimp: Failed to remove contact from Mailchimp: #{e.message}"
+      end
+    end
+  end
+
+  # Updates Mailchimp
+  #
+  # Returns nothing
+  # TODO: Update the user's email address in Mailchimp if it changes.
+  #       Look at listMemberUpdate
+  def mailchimp_update_in_mailing_list
+    if self.is_mail_list_subscriber?
+      mailchimp_add_to_mailing_list
+    elsif !self.is_mail_list_subscriber?
+      mailchimp_remove_from_mailing_list
+    end
+  end
+
+  # Retrieves and stores the Mailchimp member id
+  #
+  # Returns the Mailchimp ID
+  def assign_mailchimp_subscriber_id
+    begin
+      response = hominid.list_member_info(mailchimp_list_id, [self.email]).with_indifferent_access
+
+      if response[:success] == 1
+        member = response[:data][0]
+
+        self.mailchimp_subscriber_id = member[:id]
+      end
+    rescue Hominid::APIError => e
+      logger.warn "SpreeMailChimp: Failed to retrieve and store Mailchimp ID: #{e.message}"
+    end
+  end
+
+  # Creates an instance of the Hominid::API
+  #
+  # Returns Hominid::API
+  def hominid
+    @hominid ||= Hominid::API.new(Spree::Config.get(:mailchimp_api_key))
+  end
+
+  # Gets the Mailchimp list ID that is stored in Spree::Config
+  #
+  # Returns a Mailchimp list ID String
+  def mailchimp_list_id
+    @mailchimp_list_id ||= Spree::Config.get(:mailchimp_list_id)
+  end
+
+  # Generates the subsubcription options for the application
+  #
+  # The option values are returned as an Array in the following order:
+  #
+  # double_optin      - Flag to control whether a double opt-in confirmation
+  #                     message is sent, defaults to true. Abusing this may
+  #                     cause your account to be suspended. (default: false)
+  # update_existing   - Flag to control whether existing subscribers should be
+  #                     updated instead of throwing an error. (default: true)
+  #                     ( MailChimp's default is false )
+  # replace_interests - Flag to determine whether we replace the interest
+  #                     groups with the groups provided or we add the provided
+  #                     groups to the member's interest groups. (default: true)
+  # send_welcome      - If the double_optin is false and this is true, a welcome
+  #                     email is sent out. If double_optin is true, this has no
+  #                     effect. (default: false)
+  #
+  # Returns an Array of subscription options
+  #
+  # TODO: Add configuration options for 'update_existing' and 'replace_interests'
+  # TODO: Remove configuration options for :mailchimp_send_notify
+  def mailchimp_subscription_opts
+    [Spree::Config.get(:mailchimp_double_opt_in), true, true, Spree::Config.get(:mailchimp_send_welcome)]
+  end
+
+  # Generates the merge variables for subscribing a user
+  def mailchimp_merge_vars
+    merge_vars = {}
+    if mailchimp_merge_user_attribs = Spree::Config.get(:mailchimp_merge_vars)
+      mailchimp_merge_user_attribs.split(',').each do |method|
+        merge_vars[method.upcase] = self.send(method.downcase) if @user.respond_to? method.downcase
+      end
+    end
+    merge_vars
+  end
+
+end

data/app/overrides/add_mail_chimp_admin_menu_link.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path  => 'spree/admin/configurations/index',
+                     :name          => 'add_mail_chimp_admin_menu_link',
+                     :insert_bottom => "[data-hook='admin_configurations_menu']",
+                     :partial       => 'spree/admin/configurations/spree_mail_chimp_configuration_link' )

data/app/overrides/add_newsletter_checkbox_to_create_account_page.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => "spree/shared/_user_form",
+                     :name         => "add_newsletter_checkbox_to_create_account_page",
+                     :insert_top   => "[data-hook='signup_below_password_fields']",
+                     :partial      => "spree/users/subscribe_to_newsletter_field" )

data/app/overrides/add_newsletter_subscribe_form_to_footer.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => 'spree/shared/_footer',
+                     :name         => 'add_newsletter_form_to_footer',
+                     :insert_top   => 'div#footer_left',
+                     :partial      => 'shared/newsletter_subscribe_form' )

data/app/views/spree/admin/configurations/_spree_mail_chimp_configuration_link.html.erb

@@ -0,0 +1,4 @@
+<tr>
+  <td><%= link_to t("mailchimp_settings"), admin_mail_chimp_settings_path %></td>
+  <td><%= t('mailchimp_settings_description') %></td>
+</tr>

data/app/views/spree/admin/mail_chimp_settings/edit.html.erb

@@ -0,0 +1,65 @@
+<%= content_for :head do %>
+  <%= javascript_include_tag "jquery.validate.min" %>
+<% end -%>
+
+<%= render :partial => 'spree/admin/shared/configuration_menu' %>
+
+<h1><%= t('mailchimp_settings') %></h1>
+
+<%= form_tag(admin_mail_chimp_settings_path, :method => :put, :id => :mail_chimp_settings_form) do %>
+
+  <div class="yui-g">
+    <div class="yui-u first">
+      <fieldset>
+        <legend><%= t('mailchimp_keys') %></legend>
+        <p>
+          <label><%= t('mailchimp_api_key') %></label><br />
+          <%= text_field_tag('preferences[mailchimp_api_key]', Spree::Config[:mailchimp_api_key], :size => 46, :maxlength => 256, :class => 'email') %>
+        </p>
+        <p>
+          <label><%= t('mailchimp_list_id') %></label><br />
+          <%= text_field_tag('preferences[mailchimp_list_id]', Spree::Config[:mailchimp_list_id], :maxlength => 256, :class => 'email') %>
+        </p>
+      </fieldset>
+
+      <fieldset>
+        <legend><%= t('preferences') %></legend>
+        <p>
+          <label>
+            <input name="preferences[mailchimp_double_opt_in]" type="hidden" value="0" />
+            <%= check_box_tag('preferences[mailchimp_double_opt_in]', "1", Spree::Config[:mailchimp_double_opt_in]) %>&nbsp;<%= t('mailchimp_double_opt_in') %>&nbsp;
+          </label>
+        </p>
+        <p>
+          <label>
+            <input name="preferences[mailchimp_send_welcome]" type="hidden" value="0" />
+            <%= check_box_tag('preferences[mailchimp_send_welcome]', "1", Spree::Config[:mailchimp_send_welcome]) %>&nbsp;<%= t('mailchimp_send_welcome') %>&nbsp;
+          </label>
+        </p>
+        <p>
+          <label>
+            <input name="preferences[mailchimp_send_notify]" type="hidden" value="0" />
+            <%= check_box_tag('preferences[mailchimp_send_notify]', "1", Spree::Config[:mailchimp_send_notify]) %>&nbsp;<%= t('mailchimp_send_notify') %>&nbsp;
+          </label>
+        </p>
+        <p>
+          <label>
+            &nbsp;<%= t('mailchimp_merge_vars') %>&nbsp;<br /><%= text_field_tag('preferences[mailchimp_merge_vars]', Spree::Config[:mailchimp_merge_vars], :size => 44) %>
+          </label>
+          <br />
+          <span class="note"><%= t('mailchimp_merge_vars_help') %></span>
+        </p>
+      </fieldset>
+
+    </div>
+  </div>
+
+  <p class="form-buttons"><%= button t('save_preferences') %></p>
+
+  <script>
+    <%# TODO add validation for email list rather than simple email %>
+    $(document).ready(function(){
+      $("#inquiries_settings_form").validate();
+    });
+  </script>
+<% end -%>

data/app/views/spree/admin/mail_chimp_settings/show.html.erb

@@ -0,0 +1,26 @@
+<%= render :partial => 'spree/admin/shared/configuration_menu' %>
+
+<h1><%= t('mailchimp_settings') %></h1>
+
+<table>
+  <tr>
+    <th scope="row"><%= t("mailchimp_api_key") %>:</th>
+    <td><%= Spree::Config[:mailchimp_api_key] %></td>
+  </tr>
+  <tr>
+    <th scope="row"><%= t("mailchimp_list_id") %>:</th>
+    <td><%= Spree::Config[:mailchimp_list_id] %></td>
+  </tr>
+</table>
+
+<h4><%= t("mailchimp_double_opt_in") %>: <%= Spree::Config[:mailchimp_double_opt_in]? t('yes') : t('no') %></h4>
+<h4><%= t("mailchimp_send_welcome") %>: <%= Spree::Config[:mailchimp_send_welcome]? t('yes') : t('no') %></h4>
+<h4><%= t("mailchimp_send_notify") %>: <%= Spree::Config[:mailchimp_send_notify]? t('yes') : t('no') %></h4>
+<% unless Spree::Config[:mailchimp_merge_vars].blank? %>
+    <h4><%= t("mailchimp_merge_vars") %></h4>
+    <p>
+    <%= raw Spree::Config[:mailchimp_merge_vars].gsub(/,/, '<br >') %>
+    </p>
+<% end %>
+
+<p><%= link_to_with_icon 'edit', t("edit"), edit_admin_mail_chimp_settings_path %></p>

data/app/views/spree/shared/_newsletter_subscribe_form.html.erb

@@ -0,0 +1,14 @@
+<div id="mailchimp_subscribe_wrap">
+  <%= form_for :user, :url => :subscriptions do |f| %>
+    <table>
+      <tr>
+        <td>
+          <%= text_field_tag :email, t('enter_your_email'), :class => 'email', :id => 'subscribe_email' %>
+        </td>
+        <td>
+          <%= submit_tag t('subscribe'), :id => 'op_subscribe' %>
+        </td>
+      </tr>
+    </table>
+  <% end -%>
+</div>

data/app/views/spree/shared/_newsletter_subscribe_form_wo_butt.html.erb

@@ -0,0 +1,5 @@
+<div id="mailchimp_subscribe_wrap">
+  <%= form_for :user, :url => :subscriptions do |f| %>
+    <%= text_field_tag :email, t('enter_your_email'), :class=>'email', :id=>'subscribe_email' %>
+  <% end -%>
+</div>

data/app/views/spree/subscriptions/create.js.erb

@@ -0,0 +1,20 @@
+<% flash[:notice] = nil %>
+
+var modal_opts = { closeHTML : '<div>[x] CLOSE</div>', 
+
+      containerCss : { height:80 },
+
+      onOpen: function (dialog) {
+                        dialog.overlay.fadeIn('fast', function() {
+                            dialog.data.show();
+                            dialog.container.fadeIn('fast');
+                        });
+              }
+    };
+
+<% if @errors.empty? %>
+    $.modal('<div id="modal-notice"><h1><%= t("you_have_been_subscribed") %></h1></div>', modal_opts);
+<% else %>
+    $.modal('<div id="modal-notice"><h1>ERROR:</h1> <%= @errors.join(' / ') %></div>', modal_opts);
+<% end %>
+

data/app/views/spree/users/_subscribe_to_newsletter_field.html.erb

@@ -0,0 +1,4 @@
+<p class="login_newsletter_subscribe">
+  <%= check_box :user, :is_mail_list_subscriber, :class => 'title' %>
+  <%= label :user, :is_mail_list_subscriber, t(:do_subscribe_to_our_mailing_list) %>
+</p>

data/lib/generators/spree_mail_chimp/install/install_generator.rb

@@ -0,0 +1,27 @@
+module SpreeMailChimp
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def add_javascripts
+        append_file "app/assets/javascripts/store/all.js", "//= require store/spree_mail_chimp\n"
+      end
+
+      def add_stylesheets
+        inject_into_file "app/assets/stylesheets/store/all.css", " *= require store/spree_mail_chimp\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'rake railties:install:migrations FROM=spree_mail_chimp'
+      end
+
+      def run_migrations
+         res = ask "Would you like to run the migrations now? [Y/n]"
+         if res == "" || res.downcase == "y"
+           run 'rake db:migrate'
+         else
+           puts "Skiping rake db:migrate, don't forget to run it!"
+         end
+      end
+    end
+  end
+end

data/lib/spree/mail-chimp/config.rb

@@ -0,0 +1,10 @@
+module Spree::MailChimp
+  class Config < Spree::Config
+    class << self
+      def instance
+        return nil unless ActiveRecord::Base.connection.tables.include?('configurations')
+        MailChimpConfiguration.find_or_create_by_name("MailChimp configuration")
+      end
+    end
+  end
+end

data/lib/spree_mail_chimp.rb

@@ -0,0 +1,3 @@
+require 'spree_core'
+require 'spree_mail_chimp/engine'
+require 'hominid'

data/lib/spree_mail_chimp/engine.rb

@@ -0,0 +1,15 @@
+module SpreeMailChimp
+  class Engine < Rails::Engine
+    engine_name 'spree_mail_chimp'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/tasks/mail_chimp.rake

@@ -0,0 +1,72 @@
+require 'fileutils'
+include FileUtils::Verbose
+
+namespace :mail_chimp do
+  namespace :db do
+    desc "Custom migrations"
+    task :migrate do
+      require 'erb'
+      require 'logger'
+      require 'active_record'
+      reference = YAML::load(ERB.new(IO.read("#{Rails.root}/config/database.yml")).result)
+      env = RAILS_ENV = ENV['RAILS_ENV'] || 'development'
+      ActiveRecord::Base.logger = Logger.new(STDOUT)
+      ActiveRecord::Base.logger.level = Logger::WARN
+      ActiveRecord::Base.configurations = reference.dup
+      reference.each_key do |name|
+        next unless name.include? env
+        puts "Migrating #{name}"
+        ActiveRecord::Base.clear_active_connections!
+        ActiveRecord::Base.configurations[env] = reference[name]
+        ActiveRecord::Base.establish_connection RAILS_ENV
+        ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+        ActiveRecord::Migrator.migrate("#{File.expand_path('../..', File.dirname(__FILE__))}/db/migrate", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+        Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+      end
+    end
+
+    desc "Loads a specified fixture using rake db:load_file[filename.rb]"
+    task :seed do
+      Rake::Task["mail_chimp:db:load_dir"].invoke("default")
+    end
+
+    desc "Loads a specified fixture using rake db:load_file[filename.rb]"
+    task :load_file, [:file] => :environment do |t, args|
+      file = args.file
+      ext = File.extname file
+      if ext == ".csv" or ext == ".yml"
+        puts "loading fixture " + file
+        Fixtures.create_fixtures(File.dirname(file), File.basename(file, '.*'))
+      else
+        if File.exists? file
+          puts "loading ruby    " + file
+          require file
+        end
+      end
+    end
+
+    desc "Loads fixtures from the the dir you specify using rake db:load_dir[loadfrom]"
+    task :load_dir, [:dir] => :environment do |t, args|
+      dir = args.dir
+      fixtures = ActiveSupport::OrderedHash.new
+      ruby_files = ActiveSupport::OrderedHash.new
+      Dir.glob(File.join(File.expand_path('../..', File.dirname(__FILE__)), "db", dir, '*.{yml,csv,rb}')).each do |fixture_file|
+        ext = File.extname fixture_file
+        if ext == ".rb"
+          ruby_files[File.basename(fixture_file, '.*')]  = fixture_file
+        else
+          fixtures[File.basename(fixture_file, '.*')]  = fixture_file
+        end
+      end
+      fixtures.sort.each do |fixture, fixture_file|
+        # an invoke will only execute the task once
+        Rake::Task["db:load_file"].execute(Rake::TaskArguments.new([:file], [fixture_file]))
+      end
+      ruby_files.sort.each do |fixture, ruby_file|
+        # an invoke will only execute the task once
+        Rake::Task["db:load_file"].execute(Rake::TaskArguments.new([:file], [ruby_file]))
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: spree_mail_chimp
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Sam Beam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: &17066680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *17066680
+- !ruby/object:Gem::Dependency
+  name: hominid
+  requirement: &17064580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *17064580
+description: 
+email: sbeam@onsetcorps.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.textile
+- LICENSE
+- lib/spree_mail_chimp/engine.rb
+- lib/spree_mail_chimp.rb
+- lib/generators/spree_mail_chimp/install/install_generator.rb
+- lib/tasks/mail_chimp.rake
+- lib/spree/mail-chimp/config.rb
+- app/controllers/spree/subscriptions_controller.rb
+- app/controllers/spree/admin/mail_chimp_settings_controller.rb
+- app/views/spree/users/_subscribe_to_newsletter_field.html.erb
+- app/views/spree/shared/_newsletter_subscribe_form_wo_butt.html.erb
+- app/views/spree/shared/_newsletter_subscribe_form.html.erb
+- app/views/spree/subscriptions/create.js.erb
+- app/views/spree/admin/configurations/_spree_mail_chimp_configuration_link.html.erb
+- app/views/spree/admin/mail_chimp_settings/edit.html.erb
+- app/views/spree/admin/mail_chimp_settings/show.html.erb
+- app/overrides/add_newsletter_subscribe_form_to_footer.rb
+- app/overrides/add_newsletter_checkbox_to_create_account_page.rb
+- app/overrides/add_mail_chimp_admin_menu_link.rb
+- app/assets/stylesheets/store/mail_chimp.css
+- app/assets/stylesheets/store/spree_mail_chimp.css
+- app/assets/javascripts/store/mailchimp_subscribe.js
+- app/assets/javascripts/store/jquery.simplemodal.1.4.min.js
+- app/assets/javascripts/store/spree_mail_chimp.js
+- app/models/user_decorator.rb
+- app/models/app_configuration_decorator.rb
+homepage: https://github.com/sbeam/spree-mail-chimp
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Mail Chimp subscriptions for your Spree store using hominid
+test_files: []