mixpanel-mail 0.1.1 → 0.1.2

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in mixpanel-mail.gemspec
 gemspec
@@ -10,4 +10,5 @@ gem 'rake'
 group :development do
   gem "rspec", "~> 2.6.0"
   gem "webmock", "~> 1.7.4"
+  gem 'actionmailer', '~> 3.1.0'
 end

data/Gemfile.lock

@@ -1,16 +1,55 @@
 PATH
   remote: .
   specs:
-    mixpanel-mail (0.1.0)
+    mixpanel-mail (0.1.2)
       multi_json
 
 GEM
   remote: http://rubygems.org/
   specs:
+    actionmailer (3.1.0)
+      actionpack (= 3.1.0)
+      mail (~> 2.3.0)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
     addressable (2.2.6)
+    bcrypt-ruby (3.0.1)
+    builder (3.0.0)
     crack (0.3.1)
     diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
     multi_json (1.0.3)
+    polyglot (0.3.2)
+    rack (1.3.3)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.1)
+      rack (>= 1.0)
     rake (0.9.2)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
@@ -20,6 +59,14 @@ GEM
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
+    sprockets (2.0.0)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
     webmock (1.7.6)
       addressable (> 2.2.5, ~> 2.2)
       crack (>= 0.1.7)
@@ -28,6 +75,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionmailer (~> 3.1.0)
   mixpanel-mail!
   rake
   rspec (~> 2.6.0)

data/lib/action_mailer/mixpanel_interceptor.rb

@@ -7,7 +7,8 @@ require 'digest/md5'
 
 module ActionMailer
   class MixpanelInterceptor
-    cattr_accessor :token
+    cattr_accessor :token, :logger
+    self.logger = Rails.logger if defined?(Rails)
 
     class << self
       def activate!(token)
@@ -16,35 +17,36 @@ module ActionMailer
       end
 
       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
+        # Remove all the Mixpanel headers from the email
         opts = ::Mixpanel::Mail::OPTIONS.inject({}) do |sum, key|
-          if value = pop_mp_header(mail, key)
-            sum[key] = value
+          if field = pop_mp_header(mail, key)
+            sum[key] = field.value
           end
           sum
         end
 
+        # Skip Mixpanel if the campaign is not specified
+        return unless opts['campaign']
+
+        # Skip Mixpanel if we don't have HTML
+        html = mail.html_part ? mail.html_part.decoded : nil
+        return unless html.present?
+
         # 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
+          logger.warn("Failed to Mixpanelize Mail: #{e}")
+          logger.debug(e.backtrace.join("\n"))
         end
       end
 
     private
       def mp_mail
-        @mixpanel_mail ||= Mixpanel::Mail.new(token, 'default')
+        @mixpanel_mail ||= Mixpanel::Mail.new(token)
       end
 
       def pop_mp_header(mail, key)

data/lib/mixpanel-mail.rb

@@ -13,13 +13,14 @@ module Mixpanel
     ENDPOINT = 'http://api.mixpanel.com/email'
     ENDPOINT_URI = URI.parse(ENDPOINT)
     OPTIONS = %w(campaign type properties redirect_host click_tracking)
+    DEFAULT_CAMPAIGN = 'default'
 
     attr_accessor :params
 
-    def initialize(token, campaign, options = {})
+    def initialize(token, options = {})
       @params = {}
       params['token'] = token
-      params['campaign'] = campaign
+      params['campaign'] = DEFAULT_CAMPAIGN
       params.merge!(groom_options(options))
     end
 

data/lib/mixpanel_mail/version.rb

@@ -1,5 +1,5 @@
 module Mixpanel
   class Mail
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/spec/action_mailer/mixpanel_interceptor_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+require 'logger'
+require 'mail'
+require 'action_mailer'
+require 'action_mailer/mixpanel_interceptor'
+
+describe ActionMailer::MixpanelInterceptor do
+  MI = ActionMailer::MixpanelInterceptor
+  TOKEN = 'abcd123'
+  TO_ADDY = 'test@gemfury.com'
+  HTML_BODY = '<h1>HTML</h1>'
+
+  before do
+    MI.token = TOKEN
+    MI.logger = Logger.new($stdout)
+  end
+
+  describe '::delivering_email' do
+    before do
+      @mail = Mail::Message.new do
+        to   TO_ADDY
+        body 'Hello World!'
+      end
+    end
+
+    it 'should ignore mails without any MP options' do
+      MI.delivering_email(@mail)
+      a_post.should_not have_been_made
+    end
+
+    ### Shared Examples for All Emails ###
+    shared_examples_for 'all emails' do
+      it 'should remove all Mixpanel headers' do
+        MI.delivering_email(@mail)
+        default_headers.keys do |key|
+          @mail.header[key].should be_nil
+        end
+      end
+    end
+
+    ### Shared Examples for Emails for non-Mixpanel emails ###
+    shared_examples_for 'ignored Mixpanel email' do
+      it_should_behave_like 'all emails'
+      it 'should not make a Mixpanel request' do
+        MI.delivering_email(@mail)
+        a_post.should_not have_been_made
+      end
+    end
+
+    describe 'with MP headers without mp_campaign' do
+      before do
+        apply_headers(@mail, default_headers(:campaign => nil))
+        @mail.html_part { body(HTML_BODY) }
+      end
+
+      it_should_behave_like 'ignored Mixpanel email'
+    end
+
+    describe 'with Mixpanel headers' do
+      before do
+        apply_headers(@mail, default_headers)
+      end
+
+      describe 'without HTML email part' do
+        it_should_behave_like 'ignored Mixpanel email'
+      end
+
+      describe 'with HTML email part' do
+        before do
+          @mail.html_part { body(HTML_BODY) }
+          stub_post
+        end
+
+        it_should_behave_like 'all emails'
+
+        it 'should make a request to Mixpanel' do
+          params = Mixpanel::Mail.new(TOKEN, default_params).params
+          params['distinct_id'] = Digest::MD5.hexdigest(TO_ADDY)
+          params['body'] = HTML_BODY
+
+          verify_mixpanel_requests(params) do
+            MI.delivering_email(@mail)
+          end
+        end
+      end
+    end
+  end
+
+private
+  def apply_headers(mail, headers)
+    headers.each { |k, v| mail.header[k] = v }
+  end
+
+  def default_headers(headers = {})
+    out = {}
+    default_params(headers).each do |key, value|
+      out["mp_#{key}".to_sym] = value
+    end
+    out
+  end
+
+  def default_params(headers = {})
+    { :campaign => 'my-test-campaign',
+      :properties => { :foo => :bar },
+      :redirect_host => 'mp.testhost.com',
+      :type => 'text' }.merge(headers)
+  end
+end

data/spec/mixpanel/mail_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 describe Mixpanel::Mail do
-  TOKEN, CAMPAIGN = 'abcd123', 'my-email'
+  TOKEN, CAMPAIGN = 'abcd123', Mixpanel::Mail::DEFAULT_CAMPAIGN
 
-  it 'should intialize token & campaign' do
+  it 'should intialize token & default campaign' do
     lambda {
       mail = mp_mail
       mail.params['token'].should eq(TOKEN)
@@ -88,7 +88,7 @@ describe Mixpanel::Mail do
 
 private
   def mp_mail(options = {})
-    ::Mixpanel::Mail.new(TOKEN, CAMPAIGN, options)
+    ::Mixpanel::Mail.new(TOKEN, options)
   end
 
   def mp_option_check(key, value_expectations = {})
@@ -99,14 +99,15 @@ private
   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
+    expectations = expectations.merge(
+     'token' => TOKEN,
+     'campaign' => CAMPAIGN,
+     'distinct_id' => 'my-dist-id',
+     'body' => 'Hello World!')
+
+    verify_mixpanel_requests(expectations, 2) do
+      mp_mail(options).add_tracking('my-dist-id', 'Hello World!')
+      mp_mail.add_tracking('my-dist-id', 'Hello World!', options)
+    end
   end
 end

data/spec/support/webmock.rb

@@ -7,4 +7,11 @@
   self.class.send(:define_method, "stub_#{method}") do
     stub_request(method, Mixpanel::Mail::ENDPOINT)
   end
+end
+
+# Allow to set expectations for a mixpanel request
+def verify_mixpanel_requests(body = {}, num = 1, &block)
+  stub_post
+  block && block.call
+  a_post.with(:body => body).should have_been_made.times(num)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel-mail
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-27 00:00:00.000000000Z
+date: 2011-09-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70109454407540 !ruby/object:Gem::Requirement
+  requirement: &70185098031860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109454407540
+  version_requirements: *70185098031860
 description: Helpers for Mixpanel Tracking in Emails
 email:
 - mrykov@gmail.com
@@ -40,6 +40,7 @@ files:
 - lib/mixpanel_mail/vendor/active_support/core_ext/hash/slice.rb
 - lib/mixpanel_mail/version.rb
 - mixpanel-mail.gemspec
+- spec/action_mailer/mixpanel_interceptor_spec.rb
 - spec/mixpanel/mail_spec.rb
 - spec/spec_helper.rb
 - spec/support/webmock.rb
@@ -68,6 +69,7 @@ signing_key:
 specification_version: 3
 summary: Helpers for Mixpanel Tracking in Emails
 test_files:
+- spec/action_mailer/mixpanel_interceptor_spec.rb
 - spec/mixpanel/mail_spec.rb
 - spec/spec_helper.rb
 - spec/support/webmock.rb