mcmailer 0.0.3 → 0.0.4

data/Gemfile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+# DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake bundler:gemfile`.
+
+source "https://rubygems.org/"
+
+gem "uuid", "2.3.5"
+gem "gibbon", "0.3.5"
+
+gem "rdoc", "~>4.0", :group => [:development, :test]
+gem "hoe", "~>3.6", :group => [:development, :test]
+
+# vim: syntax=ruby

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    gibbon (0.3.5)
+      httparty (> 0.6.0)
+      httparty (> 0.6.0)
+      json (> 1.4.0)
+      json (> 1.4.0)
+      rdoc
+    hoe (3.6.0)
+      rake (>= 0.8, < 11.0)
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    json (1.7.7)
+    macaddr (1.6.1)
+      systemu (~> 2.5.0)
+    multi_json (1.7.2)
+    multi_xml (0.5.3)
+    rake (10.0.4)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    systemu (2.5.2)
+    uuid (2.3.5)
+      macaddr (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gibbon (= 0.3.5)
+  hoe (~> 3.6)
+  rdoc (~> 4.0)
+  uuid (= 2.3.5)

data/Manifest.txt

@@ -1,7 +1,13 @@
 .autotest
+Gemfile
+Gemfile.lock
 History.txt
 Manifest.txt
 README.txt
 Rakefile
+config/mcmailer.yml
 lib/mcmailer.rb
+lib/mcmailer/mailchimp_client.rb
+lib/mcmailer/mailchimp_notification_handler.rb
+mailchimp.rake
 test/test_mcmailer.rb

data/config/mcmailer.yml

@@ -0,0 +1,10 @@
+test:
+  api_key: cc7a805fbe90a734204b4100ad3cbbcc-us6
+  timeout: 300
+  list_name: Mcmailer Test List
+  required_fields:
+    fname: text
+    affiliate: bool   
+  optional_fields:
+    lname: text
+    freq_flyer: bool

data/lib/mcmailer.rb

@@ -2,7 +2,7 @@ require File.expand_path('../mcmailer/mailchimp_client', __FILE__)
 require File.expand_path('../mcmailer/mailchimp_notification_handler', __FILE__)
 
 module Mcmailer
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 
   @config = {}
   @valid_config_keys = ['test', 'development', 'production']

data/lib/mcmailer/mailchimp_client.rb

@@ -0,0 +1,117 @@
+require 'gibbon'
+
+class MailchimpClient
+  class RequestTimeout < StandardError
+    def initialize(msg="Request exceeded time limit; consider increasing the timeout value in lib/mailchimp_client")
+      super
+    end
+  end
+
+  class ListNotFound < StandardError
+    def initialize(msg="Unable to find MailChimp list by the name specified")
+      super
+    end
+  end
+
+  class UnexpectedResponse < StandardError
+  end
+
+
+
+  attr_reader :previous_response
+
+  def initialize(api_key, timeout)
+    @api_key = api_key
+    @gibbon = Gibbon.new(@api_key)
+    @gibbon.timeout = timeout
+  end
+
+  def use_list(name)
+    begin
+      @previous_response = @gibbon.lists
+    rescue Timeout::Error
+      raise RequestTimeout
+    end
+
+    if @previous_response.has_key?('data')
+      lists = @previous_response['data']
+      matches = lists.select {|list| list.has_key?('name') && list['name'] == name}
+
+      if matches.empty?
+        raise ListNotFound, "provided name => '#{name}'"
+      elsif matches.length > 1
+        raise UnexpectedResponse, "list names should be unique but found #{matches.length} lists by the name of '#{name}'"
+      else
+        @list = matches.first
+      end
+    else
+      raise UnexpectedResponse, "response hash did not have a 'data' key"
+    end
+  end
+
+  def subscribers(start=0, limit=100)
+    @previous_response = @gibbon.list_members(:id => @list['id'], :start => start, :limit => limit)
+    if !@previous_response.has_key?('data')
+      raise UnexpectedResponse, "response hash did not have a 'data' key"
+    end
+
+    @previous_response['data']
+  rescue Timeout::Error
+    raise RequestTimeout
+  end
+
+  def subscribe(email, merge_vars={})
+    @previous_response = @gibbon.list_subscribe(:id => @list['id'], :email_address => email, :double_optin => false, :update_existing => true, :merge_vars => merge_vars)
+  rescue Timeout::Error
+    raise RequestTimeout
+  end
+
+  def subscriber_info(email)
+    @previous_response = @gibbon.list_member_info(:id => @list['id'], :email_address => [email])
+  rescue Timeout::Error
+    raise RequestTimeout
+  end
+
+  def batch_subscribe(batch)
+    @previous_response = @gibbon.list_batch_subscribe(:id => @list['id'], :batch => batch, :double_optin => false, :update_existing => true)
+  rescue Timeout::Error
+    raise RequestTimeout
+  end
+
+  def destroy!(email)
+    @previous_response = @gibbon.list_unsubscribe(:id => @list['id'], :email_address => email, :delete_member => true, :send_goodbye => false, :send_notify => false)
+  rescue Timeout::Error
+    raise RequestTimeout
+  end
+
+  def batch_destroy!(emails)
+    @previous_response = @gibbon.list_batch_unsubscribe(:id => @list['id'], :emails => emails, :delete_member => true, :send_goodbye => false, :send_notify => false)
+  rescue Timeout::Error
+    raise RequestTimeout
+  end
+
+  # WARNING: For large lists this is much slower than deleting all
+  # subscribers through Mailchimp's website, but it should work.  It's
+  # useful for scenarios that require automation like Mailchimp unit
+  # tests.
+  def destroy_all_subscribers!
+    responses = []
+    batch_size = 1500
+
+    until subscribers.count.zero? do
+      begin
+        emails = self.subscribers(0, batch_size).collect {|s| s['email']}
+        batch_destroy!(emails)
+      rescue UnexpectedResponse
+        raise
+      end
+
+      responses << @previous_response
+      break if @previous_response['success_count'].zero?
+    end
+
+    @previous_response = responses
+  rescue Timeout::Error
+    raise RequestTimeout
+  end
+end

data/lib/mcmailer/mailchimp_notification_handler.rb

@@ -0,0 +1,107 @@
+class MailchimpNotificationHandler
+  NO_OP_LAMBDA = lambda {|data| nil}
+
+  def initialize(params, logger, logic, bool_cols=[])
+    @params = params
+    @logger = logger
+    @bool_columns = bool_cols
+    @logic = logic
+    @logic.default = NO_OP_LAMBDA
+
+    # These attrs get populated when the @params hash is parsed.
+    @notification_type = ''
+    @data = {}
+    @message = ''
+  end
+
+  def process
+    if valid_notification?
+      parse_params
+      @logger.info("[Mailchimp (#{@params['fired_at']})] #{@message}")
+      @logic[@notification_type].call(@data)
+    else
+      @logger.error("[Mailchimp] Invalid notification (possible reasons: forged notification from somebody besides Mailchimp, incorrect secret code, invalid notification from Mailchimp, or invalid handling of notification.)\nparams => #{@params}")
+    end
+  end
+
+
+  private
+
+  def valid_notification?
+    # NOTE: False cases below aren't exhaustive. Implement more
+    # false cases as necessary.
+    return false unless @params.has_key?('type')
+    return false unless @params.has_key?('fired_at')
+    return false unless @params.has_key?('data')
+
+    return true
+  end
+
+  def parse_params
+    @notification_type = @params['type']
+    @data = @params['data']
+    @data['fired_at'] = @params['fired_at']
+
+    case @notification_type
+    when 'subscribe' then
+      @message << "#{@data['email']} subscribed on Mailchimp! "
+      @message << human_readable_merge_vars
+    when 'unsubscribe' then
+      @message << "#{@data['email']} was unsubscribed from Mailchimp #{unsubscription_reason} "
+      @message << human_readable_merge_vars
+    when 'profile' then
+      @message << "#{@data['email']}'s profile was updated on Mailchimp. "
+      @message << human_readable_merge_vars
+    when 'upemail' then
+      @message << "the owner of #{@data['old_email']} changed their email address to #{@data['new_email']} on Mailchimp."
+    when 'cleaned' then
+      @message << "#{@params['data']['email']} was cleaned from Mailchimp #{cleaned_reason}"
+    when 'campaign' then
+      @message << "the campaign with subject '#{@data['subject']}' was #{@data['status']}."
+    else
+      @message << "WARNING: Unrecognized Mailchimp notification type '#{@notification_type}'!"
+    end
+  end
+
+  def unsubscription_reason
+    case @params['data']['reason']
+    when 'manual' then 'by request.'
+    when 'abuse' then 'due to abuse.'
+    else 'for some UNKNOWN reason.'
+    end
+  end
+
+  def cleaned_reason
+    case @params['data']['reason']
+    when 'hard' then "because of a hard bounce on the recipient's server."
+    when 'abuse' then "due to abuse."
+    else 'for some UNKNOWN reason.'
+    end
+  end
+
+  def human_readable_merge_vars
+    result = 'Merge variables are:'
+    merge_vars.each_pair do |key, value|
+      result << "\n\t#{key} => #{value}"
+    end
+
+    return result
+  end
+
+  def merge_vars
+    if @params['data'].has_key?('merges')
+      result = {}
+      @params['data']['merges'].each_pair do |key, value|
+        value = num_to_bool(value) if @bool_columns.include?(key.to_s)
+        result[key] = value
+      end
+      return result
+    end
+    return nil
+  end
+
+  def num_to_bool(string)
+    (string == '0' || sttring.nil? || string.empty?) ? false : true
+  end
+
+end

data/mailchimp.rake

@@ -0,0 +1,47 @@
+require 'lib/mailchimp_client'
+
+namespace :mailchimp do
+  def mailchimp_client
+    return @mailchimp_client if @mailchimp_client
+    @mailchimp_client = MailchimpClient.new(MAILCHIMP[:api_key])
+    @mailchimp_client.use_list(MAILCHIMP[:list_name])
+    @mailchimp_client
+  end
+
+  desc "Add existing mailing list subscribers to Mailchimp"
+  task :batch_subscribe => [:environment] do
+    batch = User.find(:all, :conditions => ["opt_in_products = 1 OR opt_in_promotions = 1"]).collect {|user| user.to_mailchimp}
+    puts "Adding #{batch.count} emails to the '#{MAILCHIMP[:list_name]}' list..."
+
+    mailchimp_client.batch_subscribe(batch)
+
+    puts "Received this response from Mailchimp: #{mailchimp_client.previous_response}"
+    puts "Done!"
+  end
+
+  desc "Remove subscriber data on the Mailchimp server"
+  task :destroy_subscribers => [:environment] do
+    puts "WARNING: This will destroy subscriber data on the Mailchimp server"
+
+    after_confirmation do
+      mailchimp_client.destroy_all_subscribers!
+      puts "List now has #{mailchimp_client.subscribers.count} subscribers."
+      puts "Done!"
+    end
+  end
+
+  def after_confirmation(&block)
+    while true
+      print "  Are you sure you want to proceed? [Y/N] "
+      response = STDIN.gets
+      if response =~ /^[yY]/
+        puts
+        block.call()
+        return
+      elsif response =~ /^[nN]/
+        puts "  Terminating early as requested."
+        return
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mcmailer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -86,11 +86,17 @@ extra_rdoc_files:
 - README.txt
 files:
 - .autotest
+- Gemfile
+- Gemfile.lock
 - History.txt
 - Manifest.txt
 - README.txt
 - Rakefile
+- config/mcmailer.yml
 - lib/mcmailer.rb
+- lib/mcmailer/mailchimp_client.rb
+- lib/mcmailer/mailchimp_notification_handler.rb
+- mailchimp.rake
 - test/test_mcmailer.rb
 - .gemtest
 homepage: https://github.com/jmitchell/mcmailer
@@ -110,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -111663555823437317
+      hash: 2007240709961413144
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: