mixpanel-mail 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mixpanel-mail.gemspec
+gemspec
+
+# Rake!
+gem 'rake'
+
+# Development dependencies
+group :development do
+  gem "rspec", "~> 2.6.0"
+  gem "webmock", "~> 1.7.4"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    mixpanel-mail (0.1.0)
+      multi_json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    multi_json (1.0.3)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    webmock (1.7.6)
+      addressable (> 2.2.5, ~> 2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mixpanel-mail!
+  rake
+  rspec (~> 2.6.0)
+  webmock (~> 1.7.4)

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/lib/action_mailer/mixpanel_interceptor.rb

@@ -0,0 +1,53 @@
+unless defined?(ActionMailer)
+  raise StandardError, "ActionMailer is not loaded"
+end
+
+require 'mixpanel-mail'
+require 'digest/md5'
+
+module ActionMailer
+  class MixpanelInterceptor
+    cattr_accessor :token
+
+    class << self
+      def delivering_email(mail)
+        # Skip Mixpanel if the campaign is not specified
+        return unless mail.header['mp_campaign']
+
+        # Skip Mixpanel if we don't have HTML
+        html = mail.html_part ? mail.html_part.body : nil
+        return unless html.present?
+
+        # Convert header options to mixpanel options
+        opts = ::Mixpanel::Mail::OPTIONS.inject({}) do |sum, key|
+          if value = pop_mp_header(mail, key)
+            sum[key] = value
+          end
+          sum
+        end
+
+        # Generate email distinct_id for Mixpanel
+        id = Digest::MD5.hexdigest(mail.header['To'].to_s)
+
+        begin
+          mail.html_part.body = mp_mail.add_tracking(id, html, opts)
+        rescue => e
+          Rails.logger.warn("Failed to Mixpanelize Mail: #{e}")
+          mail.html_part.body = html
+        end
+      end
+
+    private
+      def mp_mail
+        @mixpanel_mail ||= Mixpanel::Mail.new(token, 'default')
+      end
+
+      def pop_mp_header(mail, key)
+        header_key = "mp_#{key}"
+        value = mail.header[header_key]
+        mail.header[header_key] = nil if value
+        value
+      end
+    end
+  end
+end

data/lib/mixpanel-mail.rb

@@ -0,0 +1,64 @@
+require "mixpanel_mail/vendor/active_support"
+require "mixpanel_mail/version"
+require 'net/http'
+require 'multi_json'
+require 'uri'
+
+#
+# Adopted from http://mixpanel.com/api/docs/guides/email-analytics
+#
+
+module Mixpanel
+  class Mail
+    ENDPOINT = 'http://api.mixpanel.com/email'
+    ENDPOINT_URI = URI.parse(ENDPOINT)
+    OPTIONS = %w(campaign type properties redirect_host click_tracking)
+
+    attr_accessor :params
+
+    def initialize(token, campaign, options = {})
+      @params = {}
+      params['token'] = token
+      params['campaign'] = campaign
+      params.merge!(groom_options(options))
+    end
+
+    def add_tracking(distinct_id, body, options = {})
+      p = params.dup()
+      p['distinct_id'] = distinct_id
+      p['body'] = body
+      p.merge!(groom_options(options)) unless options.empty?
+      response = Net::HTTP.post_form(::Mixpanel::Mail::ENDPOINT_URI, p)
+      case response
+      when Net::HTTPSuccess
+          response.body
+      else
+          response.error!
+      end
+    end
+
+  private
+    def groom_options(options)
+      opts = options.dup
+      opts.stringify_keys!
+
+      # Limit request to include only valid options
+      opts.slice!(*OPTIONS)
+
+      # Default type is HTML, so we only allow TEXT
+      opts.delete('type') unless opts['type'] == 'text'
+
+      # Marshal properties as JSON
+      if opts['properties']
+        opts['properties'] = MultiJson.encode(opts['properties'])
+      end
+
+      # Click tracking is enabled by default
+      if opts['click_tracking'] == false
+        opts['click_tracking'] = '0'
+      end
+
+      opts
+    end
+  end
+end

data/lib/mixpanel_mail/vendor/active_support.rb

@@ -0,0 +1,7 @@
+unless defined?(ActiveSupport)
+  $LOAD_PATH << File.dirname(__FILE__)
+  require 'active_support/core_ext/hash/keys'
+  require 'active_support/core_ext/hash/slice'
+end
+
+

data/lib/mixpanel_mail/vendor/active_support/core_ext/hash/keys.rb

@@ -0,0 +1,47 @@
+class Hash
+  # Return a new hash with all keys converted to strings.
+  def stringify_keys
+    dup.stringify_keys!
+  end
+
+  # Destructively convert all keys to strings.
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+    self
+  end
+
+  # Return a new hash with all keys converted to symbols, as long as
+  # they respond to +to_sym+.
+  def symbolize_keys
+    dup.symbolize_keys!
+  end
+
+  # Destructively convert all keys to symbols, as long as they respond
+  # to +to_sym+.
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+
+  alias_method :to_options,  :symbolize_keys
+  alias_method :to_options!, :symbolize_keys!
+
+  # Validate all keys in a hash match *valid keys, raising ArgumentError on a mismatch.
+  # Note that keys are NOT treated indifferently, meaning if you use strings for keys but assert symbols
+  # as keys, this will fail.
+  #
+  # ==== Examples
+  #   { :name => "Rob", :years => "28" }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key: years"
+  #   { :name => "Rob", :age => "28" }.assert_valid_keys("name", "age") # => raises "ArgumentError: Unknown key: name"
+  #   { :name => "Rob", :age => "28" }.assert_valid_keys(:name, :age) # => passes, raises nothing
+  def assert_valid_keys(*valid_keys)
+    valid_keys.flatten!
+    each_key do |k|
+      raise(ArgumentError, "Unknown key: #{k}") unless valid_keys.include?(k)
+    end
+  end
+end

data/lib/mixpanel_mail/vendor/active_support/core_ext/hash/slice.rb

@@ -0,0 +1,40 @@
+class Hash
+  # Slice a hash to include only the given keys. This is useful for
+  # limiting an options hash to valid keys before passing to a method:
+  #
+  #   def search(criteria = {})
+  #     assert_valid_keys(:mass, :velocity, :time)
+  #   end
+  #
+  #   search(options.slice(:mass, :velocity, :time))
+  #
+  # If you have an array of keys you want to limit to, you should splat them:
+  #
+  #   valid_keys = [:mass, :velocity, :time]
+  #   search(options.slice(*valid_keys))
+  def slice(*keys)
+    keys = keys.map! { |key| convert_key(key) } if respond_to?(:convert_key)
+    hash = self.class.new
+    keys.each { |k| hash[k] = self[k] if has_key?(k) }
+    hash
+  end
+
+  # Replaces the hash with only the given keys.
+  # Returns a hash contained the removed key/value pairs
+  #   {:a => 1, :b => 2, :c => 3, :d => 4}.slice!(:a, :b) # => {:c => 3, :d => 4}
+  def slice!(*keys)
+    keys = keys.map! { |key| convert_key(key) } if respond_to?(:convert_key)
+    omit = slice(*self.keys - keys)
+    hash = slice(*keys)
+    replace(hash)
+    omit
+  end
+
+  # Removes and returns the key/value pairs matching the given keys.
+  #   {:a => 1, :b => 2, :c => 3, :d => 4}.extract!(:a, :b) # => {:a => 1, :b => 2}
+  def extract!(*keys)
+    result = {}
+    keys.each {|key| result[key] = delete(key) }
+    result
+  end
+end

data/lib/mixpanel_mail/version.rb

@@ -0,0 +1,5 @@
+module Mixpanel
+  class Mail
+    VERSION = "0.1.0"
+  end
+end

data/mixpanel-mail.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mixpanel_mail/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mixpanel-mail"
+  s.version     = Mixpanel::Mail::VERSION
+  s.authors     = ["Michael Rykov"]
+  s.email       = ["mrykov@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Helpers for Mixpanel Tracking in Emails}
+  s.description = %q{Helpers for Mixpanel Tracking in Emails}
+
+  s.rubyforge_project = "mixpanel-mail"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Runtime depencendies
+  s.add_runtime_dependency "multi_json"
+
+  # Development dependencies
+  # See Gemfile
+end

data/spec/mixpanel/mail_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe Mixpanel::Mail do
+  TOKEN, CAMPAIGN = 'abcd123', 'my-email'
+
+  it 'should intialize token & campaign' do
+    lambda {
+      mail = mp_mail
+      mail.params['token'].should eq(TOKEN)
+      mail.params['campaign'].should eq(CAMPAIGN)
+    }.should_not raise_exception
+  end
+
+  describe 'options grooming' do
+    it 'should filter out bad options' do
+      mp_option_check('bad', 'woot' => nil)
+    end
+
+    it 'should recognize "type" option' do
+      mp_option_check('type', {
+        'text' => 'text',
+        'html' => nil,
+        'bad_bad' => nil
+      })
+    end
+
+    it 'should recognize "click_tracking" option' do
+      mp_option_check('click_tracking', {
+        true => true,
+        false => '0'
+      })
+    end
+
+    it 'should recognize "properties" option' do
+      example = { :hello => :world }
+      mp_option_check('properties', {
+        nil => nil,
+        {}  => '{}',
+        example => MultiJson.encode(example)
+      })
+    end
+
+    it 'should recognize "redirect_host" option' do
+      mp_option_check('redirect_host', {
+        nil => nil, 'anything' => 'anything'
+      })
+    end
+
+    it 'should recognize "campaign" option' do
+      mp_option_check('campaign', 'alt-campaign' => 'alt-campaign')
+    end
+  end
+
+  describe 'add tracking' do
+    it 'should make a simple request' do
+      verify_request_with_options
+    end
+
+    it 'should make a request with "type" request' do
+      verify_request_with_options(
+        { :type  => 'text' },
+        { 'type' => 'text' }
+      )
+    end
+
+    it 'should make a request with "click_tracking" request' do
+      verify_request_with_options(
+        { :click_tracking  => false },
+        { 'click_tracking' => '0' }
+      )
+    end
+
+    it 'should make a request with "properties" request' do
+      props = { :foo => 'bar' }
+      verify_request_with_options(
+        { :properties  => props },
+        { 'properties' => MultiJson.encode(props) }
+      )
+    end
+
+    it 'should make a request with "redirect_host" request' do
+      verify_request_with_options(
+        { :redirect_host  => 'http://www.google.com' },
+        { 'redirect_host' => 'http://www.google.com' }
+      )
+    end
+  end
+
+private
+  def mp_mail(options = {})
+    ::Mixpanel::Mail.new(TOKEN, CAMPAIGN, options)
+  end
+
+  def mp_option_check(key, value_expectations = {})
+    value_expectations.each do |value, expectation|
+      mp_mail(key => value).params[key].should eq(expectation)
+      mp_mail(key.to_sym => value).params[key].should eq(expectation)
+    end
+  end
+
+  def verify_request_with_options(options = {}, expectations = {})
+    stub_post
+    mp_mail(options).add_tracking('my-dist-id', 'Hello World!')
+    mp_mail.add_tracking('my-dist-id', 'Hello World!', options)
+    a_post.with(:body => expectations.merge(
+      'token' => TOKEN,
+      'campaign' => CAMPAIGN,
+      'distinct_id' => 'my-dist-id',
+      'body' => 'Hello World!'
+    )).should have_been_made.twice
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'webmock/rspec'
+require 'mixpanel-mail'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  # == Mock Framework
+  config.mock_with :rspec
+end

data/spec/support/webmock.rb

@@ -0,0 +1,10 @@
+# Define a_get, a_post, etc and stub_get, stub_post, etc
+[:delete, :get, :post, :put].each do |method|
+  self.class.send(:define_method, "a_#{method}") do
+    a_request(method, Mixpanel::Mail::ENDPOINT)
+  end
+
+  self.class.send(:define_method, "stub_#{method}") do
+    stub_request(method, Mixpanel::Mail::ENDPOINT)
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: mixpanel-mail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Rykov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70183731286560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70183731286560
+description: Helpers for Mixpanel Tracking in Emails
+email:
+- mrykov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- lib/action_mailer/mixpanel_interceptor.rb
+- lib/mixpanel-mail.rb
+- lib/mixpanel_mail/vendor/active_support.rb
+- lib/mixpanel_mail/vendor/active_support/core_ext/hash/keys.rb
+- lib/mixpanel_mail/vendor/active_support/core_ext/hash/slice.rb
+- lib/mixpanel_mail/version.rb
+- mixpanel-mail.gemspec
+- spec/mixpanel/mail_spec.rb
+- spec/spec_helper.rb
+- spec/support/webmock.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mixpanel-mail
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Helpers for Mixpanel Tracking in Emails
+test_files:
+- spec/mixpanel/mail_spec.rb
+- spec/spec_helper.rb
+- spec/support/webmock.rb