subscribed_to 0.2.0 → 0.3.0

data/spec/dummy/public/javascripts/rails.js

@@ -0,0 +1,191 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var csrf_meta_tag = $$('meta[name=csrf-token]')[0];
+
+      if (csrf_meta_tag) {
+        var header = 'X-CSRF-Token',
+            token = csrf_meta_tag.readAttribute('content');
+
+        if (!request.options.requestHeaders) {
+          request.options.requestHeaders = {};
+        }
+        request.options.requestHeaders[header] = token;
+      }
+    }
+  });
+})();

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/factories/users.rb

@@ -3,6 +3,7 @@ Factory.define :subscribed_user, :class => User do |u|
   u.last_name           "Salczynski"
   u.email               "eric@wehaventthetime.com"
   u.subscribed_to_list  true
+  u.mail_chimp_id       "123"
   u.password            "abc123"
 end
 

data/spec/lib/subscribed_to/mail_chimp/web_hook_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe SubscribedTo::MailChimp::WebHook do
+  before do
+    SubscribedTo.mail_chimp do |config|
+      config.lists = {
+        :mailing_list => {
+          :id => "abc123",
+          :merge_vars => {"FNAME" => :first_name, "LNAME" => :last_name, "EMAIL" => :email}}}
+
+      # normally not set in config, but necessary for testing
+      config.enabled_models = {"abc123" => ["User"]}
+    end
+  end
+
+  it "should quietly fail and log the error if no member is found" do
+    Rails.logger.expects(:warn).once
+    expect do
+      SubscribedTo::MailChimp::WebHook.process({
+        "type" => "subscribe",
+        "data" => {
+          "list_id" => "abc123",
+          "web_id" => "231546749",
+          "merges" => {
+            "EMAIL" => "fake.user@email.com" }}})
+    end.not_to raise_exception
+  end
+
+  it "should rate limit updates via the api to once every 2 minutes" do
+    # user was updated 2:01 ago
+    pretend_now_is(Time.zone.now - 120.seconds) do
+      @user = Factory.build(:non_subscribed_user)
+      @user.stubs(:subscribe_to_list)
+      @user.save
+    end
+
+    # pretend it's 1:59 from last update
+    pretend_now_is(Time.zone.now - 1.seconds) do
+      expect do
+        SubscribedTo::MailChimp::WebHook.process({
+          "type" => "upemail",
+          "data" => {
+            "list_id" => "abc123",
+            "new_email" => "my.new@email.com",
+            "old_email" => @user.email }})
+      end.not_to change { @user.reload.email }.to("my.new@email.com")
+    end
+
+    # pretend it's 2:01 from last update
+    pretend_now_is(Time.zone.now + 120.seconds) do
+      expect do
+        SubscribedTo::MailChimp::WebHook.process({
+          "type" => "upemail",
+          "data" => {
+            "list_id" => "abc123",
+            "new_email" => "my.new@email.com",
+            "old_email" => @user.email }})
+      end.to change { @user.reload.email }.to("my.new@email.com")
+    end
+  end
+
+  it "should write a warning to the logger if the event is not supported" do
+    Rails.logger.expects(:warn).once
+    expect do
+      SubscribedTo::MailChimp::WebHook.process({
+        "type" => "nonevent",
+        "data" => { "list_id" => "abc123" }})
+    end.not_to raise_exception
+  end
+
+  context "for a new user" do
+    before(:each) do
+      # user was updated 2:01 ago
+      pretend_now_is(Time.zone.now - 121.seconds) do
+        @user = Factory.build(:non_subscribed_user)
+        @user.stubs(:subscribe_to_list)
+        @user.save
+        @user.expects(:update_list_member).never
+      end
+    end
+
+    context "when they subscribe" do
+      it "should set subscribed_to_list to true, and set the mail_chimp_id" do
+        @user.mail_chimp_id.should be_nil
+        expect do
+          expect do
+            SubscribedTo::MailChimp::WebHook.process({
+              "type" => "subscribe",
+              "data" => {
+                "list_id" => "abc123",
+                "web_id" => "231546749",
+                "merges" => {
+                  "EMAIL" => @user.email }}})
+          end.to change { @user.reload.subscribed_to_list }.from(false).to(true)
+        end.to change { @user.mail_chimp_id }.to(231546749)
+      end
+    end
+  end
+
+  context "for an existing user" do
+    before(:each) do
+      # user was updated 2:01 ago
+      pretend_now_is(Time.zone.now - 121.seconds) do
+        @user = Factory.build(:subscribed_user)
+        @user.stubs(:subscribe_to_list)
+        @user.save
+        @user.expects(:update_list_member).never
+      end
+    end
+
+    context "when they unsubscribe" do
+      it "should set subscribed_to_list to false" do
+        expect do
+          SubscribedTo::MailChimp::WebHook.process({
+            "type" => "unsubscribe",
+            "data" => {
+              "list_id" => "abc123",
+              "web_id" => "123",
+              "merges" => {
+                "EMAIL" => @user.email }}})
+        end.to change { @user.reload.subscribed_to_list }.from(true).to(false)
+      end
+    end
+
+    context "when they change their email" do
+      it "should update the user email" do
+        expect do
+          SubscribedTo::MailChimp::WebHook.process({
+            "type" => "upemail",
+            "data" => {
+              "list_id" => "abc123",
+              "new_email" => "my.new@email.com",
+              "old_email" => @user.email }})
+        end.to change { @user.reload.email }.to("my.new@email.com")
+      end
+    end
+
+    context "when they change their profile information" do
+      it "should update the attributes defined in the merge vars config" do
+        expect do
+          expect do
+            expect do
+              SubscribedTo::MailChimp::WebHook.process({
+                "type" => "profile",
+                "data" => {
+                  "list_id" => "abc123",
+                  "web_id" => "123",
+                  "merges" => {
+                    "EMAIL" => "my.new@email.com",
+                    "FNAME" => "John",
+                    "LNAME" => "Locke" }}})
+            end.to change { @user.reload.email }.to("my.new@email.com")
+          end.to change { @user.first_name }.to("John")
+        end.to change { @user.last_name }.to("Locke")
+      end
+    end
+  end
+end

data/spec/lib/subscribed_to/mail_chimp_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'hominid'
+
+describe SubscribedTo::MailChimp do
+  before(:each) do
+    SubscribedTo.mail_chimp do |config|
+      config.api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us1"
+      config.lists = {:mailing_list => {:id => "123456", :merge_vars => {"FNAME" => :first_name, "LNAME" => :last_name, "EMAIL" => :email}}}
+    end
+
+    @h = mock("hominid")
+    Hominid::API.stubs(:new).returns(@h)
+  end
+
+  context "for a new user" do
+    it "should subscribe the user if subscribed_to_list is true" do
+      @h.expects(:list_subscribe).once
+      Factory(:subscribed_user)
+    end
+
+    it "should not subscribe the user if subscribed_to_list is false" do
+      @h.expects(:list_subscribe).never
+      Factory(:non_subscribed_user)
+    end
+
+    it "should rescue and log Hominid::APIErrors" do
+      @h.expects(:list_subscribe).raises(Hominid::APIError, mock("FaultException", :faultCode => "xxx", :message => "api error"))
+      Rails.logger.expects(:warn).once
+      Factory(:subscribed_user)
+    end
+  end
+
+  context "for an existing user" do
+    context "who is not subscribed to the mailing list" do
+      before { @user = Factory(:non_subscribed_user) }
+
+      it "should subscribe the user" do
+        @h.expects(:list_subscribe).once
+        @user.update_attributes({:subscribed_to_list => true})
+      end
+    end
+
+    context "who is subscribed to the mailing list" do
+      before do
+        @user = Factory.build(:subscribed_user)
+        @user.stubs(:subscribe_to_list)
+        @user.save
+      end
+
+      it "should unsubscribe the user" do
+        @h.expects(:list_unsubscribe).once
+        @user.update_attributes({:subscribed_to_list => false})
+      end
+
+      it "should update list member attributes for the user" do
+        @h.expects(:list_update_member).once
+        @user.update_attributes({:first_name => "Ed", :last_name => "Salczynski", :email => "ed@whtt.me"})
+      end
+
+      it "should not update list member when attributes not defined in merge vars are changed" do
+        @h.expects(:list_subscribe).never
+        @h.expects(:list_unsubscribe).never
+        @h.expects(:list_update_member).never
+        @user.update_attributes({:password => "zyx321"})
+      end
+
+      it "should rescue and log Hominid::APIErrors" do
+        @h.expects(:list_unsubscribe).raises(Hominid::APIError, mock("FaultException", :faultCode => "xxx", :message => "api error"))
+        Rails.logger.expects(:warn).once
+        @user.update_attributes({:subscribed_to_list => false})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,48 +1,90 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'simplecov'
-SimpleCov.start
+SimpleCov.start do
+  add_filter "/spec/"
+end
 
-require 'rspec'
+require 'database_cleaner'
 require 'factory_girl'
-require 'subscribed_to'
 
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
 
-RSpec.configure do |config|
-  config.mock_with :mocha
-end
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 
-ENV['DB'] ||= 'sqlite3'
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.default_url_options[:host] = "test.com"
 
-database_yml = File.expand_path('../database.yml', __FILE__)
-if File.exists?(database_yml)
-  active_record_configuration = YAML.load_file(database_yml)[ENV['DB']]
+Rails.backtrace_cleaner.remove_silencers!
 
-  ActiveRecord::Base.establish_connection(active_record_configuration)
-  ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "log", "debug.log"))
+# Run any available migration
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+Dir["#{File.dirname(__FILE__)}/factories/*.rb"].each {|f| load f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
 
-  ActiveRecord::Base.silence do
-    ActiveRecord::Migration.verbose = false
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
 
-    load('schema.rb')
-    Dir["#{File.dirname(__FILE__)}/app/**/*.rb"].each {|f| load f}
-    Dir["#{File.dirname(__FILE__)}/factories/*.rb"].each {|f| load f}
+  config.before(:each) do
+    DatabaseCleaner.start
   end
 
-else
-  raise "Please create #{database_yml} first to configure your database. Take a look at: #{database_yml}.sample"
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
 end
 
-Rails.logger = Logger.new(File.join(File.dirname(__FILE__), "log", "debug.log"))
 
-def clean_database!
-  models = [User]
-  models.each do |model|
-    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+# Time warp functionality from https://github.com/harvesthq/time-warp
+# Extend the Time class so that we can offset the time that 'now'
+# returns.  This should allow us to effectively time warp for functional
+# tests that require limits per hour, what not.
+if !Time.respond_to?(:real_now)  # assures there is no infinite looping when aliasing #now
+  Time.class_eval do
+    class << self
+      attr_accessor :testing_offset
+
+      alias_method :real_now, :now
+      def now
+        real_now - testing_offset
+      end
+      alias_method :new, :now
+
+    end
+  end
+end
+Time.testing_offset = 0
+
+def pretend_now_is(*args)
+  Time.testing_offset = Time.now - time_from(*args)
+  if block_given?
+    begin
+      yield
+    ensure
+      reset_to_real_time
+    end
   end
 end
 
-clean_database!
+##
+# Reset to real time.
+def reset_to_real_time
+  Time.testing_offset = 0
+end
+
+def time_from(*args)
+  return args[0] if 1 == args.size && args[0].is_a?(Time)
+  return args[0].to_time if 1 == args.size && args[0].respond_to?(:to_time)  # For example, if it's a Date.
+  Time.utc(*args)
+end