ruby-mailchimp 0.1.0

data/lib/mail_chimp.rb

@@ -0,0 +1,205 @@
+require 'net/http'
+require 'net/imap'
+require 'rubygems'
+gem 'actionmailer'
+require 'action_mailer'
+
+#
+# ruby-mailchimp
+# 
+# ruby-mailchimp is designed to allow you to use Ruby to subscribe or unsubscribe
+# users to an existing MailChimp (http://www.mailchimp.com) account.  You will need the following:
+# - MailChimp Account: MailChimp is free to sign up for and only charges for sent messages
+# - MailChimp List ID: You can get this from the id field of MailChimp's signup form code.
+# 
+# Author:: C. G. Brown (mailto: cgbrown@projectlocker.com)
+# Copyright:: Copyright (c) 2007 One Percent Software/ProjectLocker
+# License:: Apache Software License
+# 
+# Example Usage:
+# - Subscribing a User: -
+#   bonobo = MailChimp.new
+#   bonobo.subscribe_user("MyListID", "testuser@nowhere.com")
+#   
+# - Subscribing a User with other data: -  
+#   bonobo = MailChimp.new
+#   bonobo.subscribe_user("MyListID", "otheruser@nowhere.com", {:FNAME=>'Barnaby', :LNAME=>'Jones'})
+#   
+# - Unsubscribing a User -   
+#   bonobo = MailChimp.new
+#   bonobo.unsubscribe_user("MyListID", "thirduser@nowhere.com")
+#   
+# - Checking for Incoming Subscribes/Unsubscribes -
+#   bonobo = MailChimp.new
+#   bonobo.initialize_inbox("my.mailserver.com", "myusername", "mypassword")
+#   subscribes, unsubscribes = bonobo.check_inbox()
+#   subscribes.each do |subscriber|
+#     email = subscriber[:email]
+#     ip = subscriber[:ip]
+#     signup_date = subscriber[:date]
+#     #Do what you like with the data here
+#   end
+#   unsubscribes.each do |unsubscriber|
+#     email = unsubscriber[:email]
+#     ip = unsubscriber[:ip]
+#     signup_date = unsubscriber[:date]
+#     #Do what you like with the data here
+#   end
+#   
+class MailChimp
+
+  attr_accessor :email_server, :email_user, :email_password
+  
+  #
+  # Stores the inbox attributes to allow connection by check_inbox
+  #
+  def initialize_inbox(server, user, password)
+    self.email_server = server
+    self.email_user = user
+    self.email_password = password
+  end
+  
+  #
+  # Adds a user to the specified MailChimp list.
+  # list_id - The MailChimp List ID
+  # email - The user's e-mail address
+  # additional_fields - An optional hash containing other fields to pass in.  
+  # The key for each field should be the name of the field as it would be specified in a form.
+  #
+  def subscribe_user(list_id, email, additional_fields=nil)    
+    additional_fields = Hash::new if (additional_fields.nil?)
+    additional_fields['EMAIL'] = email   
+    additional_fields['id'] = list_id
+    return subscribe_users([additional_fields])
+  end
+  
+  #
+  # Executes a batch subscribe of multiple users.
+  # hash_array - An array of hash lines
+  # 
+  def subscribe_users(hash_array)
+    post_to_mailchimp(hash_array, "subscribe.phtml")
+  end
+  
+  #
+  # Removes a user from the specified MailChimp list.
+  # list_id - The MailChimp List ID
+  # email - The user's e-mail address
+  #
+  def unsubscribe_user(list_id, email)
+    additional_fields = Hash::new if (additional_fields.nil?)
+    additional_fields['EMAIL'] = email   
+    additional_fields['id'] = list_id
+    return unsubscribe_users([additional_fields])    
+  end
+  
+  #
+  # Executes a batch unsubscribe of multiple users.
+  # hash_array - An array of hash lines
+  # 
+  def unsubscribe_users(hash_array)
+    post_to_mailchimp(hash_array, "unsub.phtml")
+  end  
+  
+  #
+  # Reads IMAP mail from the mailbox initialized with initialize_inbox.
+  # Returns a subscribers array containing hashes of user data, and an
+  # unsubscriber's array containing hashes of user data.  Email, IP, and date as 
+  # a string are returned to the caller.  
+  # 
+  #
+  def check_inbox(delete=nil, mode=nil)
+    delete = false if (delete.nil?)
+    if (!mode.nil? && mode.upcase != "IMAP")
+      STDERR.write("Mode #{mode} not supported.  Only IMAP supported at this time.")
+    elsif (email_server.nil? || email_user.nil? || email_password.nil?)
+      STDERR.write("You must initialize the mailbox before checking it.  Try initialize_inbox.")
+    else
+      subscribes = Array::new
+      unsubscribes = Array::new
+      imap = Net::IMAP.new(email_server)
+      imap.authenticate('LOGIN', email_user, email_password)
+      imap.select('INBOX')
+      imap.search(['ALL']).each do |message_id|
+        msg = imap.fetch(message_id,'RFC822')[0].attr['RFC822']
+        stored_value = Processor.receive(msg)
+        subscribes << stored_value if (!stored_value.nil? && stored_value[:type] == :subscription)
+        unsubscribes << stored_value if (!stored_value.nil? && stored_value[:type] == :unsubscription)
+        #Mark message as deleted and it will be removed from storage when user session closes
+        imap.store(message_id, "+FLAGS", [:Deleted]) if (delete == true)
+      end
+      
+      imap.expunge if (delete == true)
+      
+      imap.disconnect
+      return [subscribes, unsubscribes]
+    end
+    return nil
+  end
+  
+  protected 
+  
+  #
+  # Handles internal posting to MailChimp, given a processor page.
+  #
+  def post_to_mailchimp(hash_array, page)
+    hash_array.each do |additional_fields|      
+      http = Net::HTTP.new("www.mailchimp.com")
+      headers = {
+        "Content-type" => "application/x-www-form-urlencoded",
+        "User-Agent" => "MCSubscriber ruby-0.1"     
+      }
+      response, body = http.post("/unsub.phtml", hash_to_uri(additional_fields), headers)
+    end    
+  end
+  
+  #
+  # Converts a hash to a data string suitable for HTTP POST or GET
+  #
+  def hash_to_uri(inhash)
+    result_str = ""
+    inhash.each { |key, val| 
+      result_str << "#{key}=#{val}&"
+    }
+    result_str.chop unless inhash.size == 0    
+  end
+  
+  class Processor < ActionMailer::Base
+    def receive(msg)
+      p msg.subject
+      p msg.subject =~ /New Subscribe to/
+      p msg.subject =~ /Unsubscribe from/
+      #Process all new subscriptions
+      is_subscription = !((msg.subject =~ /New Subscribe to/).nil?)
+      is_unsubscription = !((msg.subject =~ /Unsubscribe from/).nil?) 
+      p "status = #{is_subscription} #{is_unsubscription}"
+      if is_subscription || is_unsubscription
+        stored_value = Hash::new
+        if (is_subscription)
+          stored_value[:list] = msg.subject.gsub("New Subscribe to ", "")
+          stored_value[:type] = :subscription
+        else
+          stored_value[:list] = msg.subject.gsub("Unsubscribe from ", "")
+          stored_value[:type] = :unsubscription 
+        end
+        msg.body.each_line do |parseline| 
+          field, value = parseline.split(":", 2)
+          if (!value.nil?)
+            field = field.strip
+            value = value.strip
+            #TODO: Deal with other fields
+            if (field == "Email Address")
+              stored_value[:email] = value
+            elsif (field == "Signup IP")
+              stored_value[:ip] = value
+            elsif (field == "Date")
+              stored_value[:date] = value
+            end
+          end 
+        end
+        return stored_value   
+      end 
+      return nil
+    end  
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: ruby-mailchimp
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-05-10 00:00:00 -04:00
+summary: Allows programmatic subscription and unsubscription to MailChimp.  Requires MailChimp account.
+require_paths: 
+- lib
+email: cgbrown@projectlocker.com
+homepage: http://www.projectlocker.com
+rubyforge_project: 
+description: 
+autorequire: mail_chimp
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- C. G. Brown
+files: 
+- lib/mail_chimp.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.2
+    version: