email_tracker 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,26 @@
+= Email Tracker
+
+This engine tracks emails in your Ruby on Rails app.
+
+== Licence
+
+Copyright 2012 Jeremy Walker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EmailTracker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/email_tracker/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/email_tracker/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/email_tracker/application_controller.rb

@@ -0,0 +1,4 @@
+module EmailTracker
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/email_tracker/email_instances_controller.rb

@@ -0,0 +1,31 @@
+module EmailTracker
+  class EmailInstancesController < ApplicationController
+
+    skip_before_filter :check_logged_in, :only => :opened
+
+    def opened
+      # Get the instance from the url code
+      @instance = EmailTracker::EmailInstance.where(url_code: params[:url_code]).order("id DESC").first
+    
+      # If this hasn't been found, it may be due to a legacy issue
+      # where we used to search by id
+      unless @instance
+        # Search by id
+        @instance = EmailTracker::EmailInstance.find_by_id(params[:url_code])
+      
+        # If the instance doesn't exist, or it has a url code (and is therefore post this change) then get out of here
+        unless @instance && @instance.url_code == ""
+          redirect_to root_path
+          return
+        end
+      end
+    
+      # Mark the instance as opened
+      @instance.opened!
+    
+      # And send the required image data back
+      send_data(File.read(File.expand_path("../../../assets/images/email_tracker/transparent.png",  __FILE__)))
+    end
+
+  end
+end

data/app/controllers/email_tracker/link_instances_controller.rb

@@ -0,0 +1,43 @@
+module EmailTracker
+  class LinkInstancesController < ApplicationController
+
+    skip_before_filter :check_logged_in, :only => :clicked
+
+    def clicked
+      # Get the instance from the url code
+      @instance = EmailTracker::LinkInstance.where(url_code: params[:url_code]).order("id DESC").first
+    
+      # If this hasn't been found, it may be due to a legacy issue
+      # where we used to search by id
+      unless @instance
+        # Search by id
+        @instance = EmailTracker::LinkInstance.find_by_id(params[:url_code])
+      
+        # If the instance doesn't exist, or it has a url code (and is therefore post this change) then get out of here
+        unless @instance && @instance.url_code == ""
+          redirect_to root_path
+          return
+        end
+      end
+    
+      # We have a valid instance, so mark it as clicked
+      @instance.clicked!
+      redirect_to @instance.link.url
+      
+=begin    
+      # If we don't have a user model to care about, just leave
+      return unless Module.const_defined?(:User)
+      
+      # Otherwise check whether the user can view this page and act accordingly
+      if @instance.is_externally_viewable? || 
+         !@instance.user || 
+         (responds_to(:user_logged_in?) && user_logged_in?) || 
+         (responds_to(:logged_in?) && logged_in?)
+      else 
+        store_user_location(@instance.link.url) 
+        @new_user = @instance.user
+      end
+=end
+    end
+  end
+end

data/app/helpers/email_tracker/application_helper.rb

@@ -0,0 +1,4 @@
+module EmailTracker
+  module ApplicationHelper
+  end
+end

data/app/models/email_tracker/email.rb

@@ -0,0 +1,85 @@
+module EmailTracker
+  class Email < ActiveRecord::Base
+  
+    belongs_to :owner, polymorphic: true
+  
+    has_many :instances, class_name: "EmailInstance"
+    has_many :link_instances, through: :instances
+    
+    attr_accessible :owner, :owner_type, :owner_id, :mailer, :action, as: :email_tracker_internals
+    
+    before_create :set_default_name
+    before_create :set_default_description
+  
+    def self.for_email(data)
+    
+      hash = {
+        mailer: data[:mailer],
+        action: data[:action],
+        owner_type: data[:owner_type],
+        owner_id: data[:owner_id]
+      }
+    
+      if email = self.where(hash).first
+        return email
+      end
+    
+      email = self.new(hash, as: :email_tracker_internals)
+      email.save!
+      email
+    end
+  
+  def create_instance!(email_address, user_id)
+    instances.create!({email_address: email_address, user_id: user_id}, as: :email_tracker_internals)
+  end
+  
+    private
+  
+    def set_default_name
+      self.name = if owner
+        if owner.respond_to?(:name)
+          owner.name
+        elsif owner.respond_to?(:title)
+          owner.title
+        else
+          "#{owner.class.name.humanize.capitalize} ##{owner.id}"
+        end
+      else
+        "#{mailer.split("/").last.capitalize} #{action.humanize}"
+      end
+      true
+    end
+    
+    def set_default_description
+      self.description = ""
+      true
+    end
+  end
+end    
+=begin
+  
+  
+  def times_sent(since = nil)
+    i = instances
+    i = i.where("created_at > ?", since) if since
+    i.count
+  end
+  
+  def times_opened(since = nil)
+    i = instances.opened
+    i = i.where("opened_at > ?", since) if since
+    i.count
+  end
+  
+  def opened_percentage(since = nil)
+    ((times_opened(since).to_f / times_sent(since)) * 100).to_i
+  end
+  
+  def num_links_clicked(since = nil)
+    i = link_instances.clicked
+    i = i.where("clicked_at > ?", since) if since
+    i.count
+  end
+end
+
+=end

data/app/models/email_tracker/email_instance.rb

@@ -0,0 +1,32 @@
+require 'digest/sha1'
+module EmailTracker
+  class EmailInstance < ActiveRecord::Base
+  
+    belongs_to :email
+    belongs_to :user
+    has_many :link_instances
+    
+    attr_accessible :email_address, :user_id, as: :email_tracker_internals
+    
+    scope :opened, where("opened_at IS NOT NULL")
+    
+    before_create do 
+      if Module.const_defined?(:User)
+        self.user = User.where(email: self.email_address).select(:id).first unless self.user_id
+      end
+      self.url_code = Digest::SHA1.hexdigest( Time.now.to_s.split(//).sort_by {rand}.join )
+      true
+    end
+    
+    def opened?
+      opened_at != nil ? true : false
+    end
+    
+    def opened!
+      unless opened?
+        self.opened_at = DateTime.now
+        save!
+     end
+    end
+  end
+end

data/app/models/email_tracker/interceptor.rb

@@ -0,0 +1,65 @@
+module EmailTracker
+  class Interceptor
+    def self.delivering_email(message)
+    
+      if message.multipart?
+        message.html_part.body = add_tracking(message, message.html_part.body.to_s)
+      else
+        message.body = add_tracking(message, message.body.to_s)
+      end
+    end
+    
+    def self.add_tracking(message, content)
+      begin
+        # Get tracking data, and the recipient
+        tracking_data = message.tracking_data
+        email_address = Array(message.to).first
+      
+        if tracking_data[:owner]
+          tracking_data[:owner_type] = tracking_data[:owner].class.name
+          tracking_data[:owner_id] = tracking_data[:owner].id
+        end
+  
+        # Get or create a tracked version of this email
+        tracking_email = EmailTracker::Email.for_email(tracking_data)
+    
+        # And create a new instance for this email address (and user if specified)
+        tracking_email_instance = tracking_email.create_instance!(email_address, tracking_data[:user_id])
+        
+        # Get url options
+        opts = Rails.application.config.action_mailer.default_url_options
+        protocol = opts.fetch(:protocol, "http")
+        host = opts.fetch(:host)
+        url_base = "#{protocol}://#{host}/"
+    
+        # Modify html to track open
+        tracking_url = "#{url_base}et_open/#{tracking_email_instance.url_code}.gif"
+        tracking_html = "<img src=\"#{tracking_url}\" alt=\"\"/>"
+        content.gsub!("<body>", "<body>#{tracking_html}")
+        
+        # Modify html to track clicks
+        content.gsub!(/href\=['"]([^"']+)['"]/) do |match|
+          url = $1
+          if url.starts_with?("mailto")
+            match
+          elsif url.match("et_notrack=true")
+            ""
+          else
+            if external = !!url.match("et_external=true")
+              url.gsub!("et_external=true", "")
+            end
+          
+            tracked_link = EmailTracker::Link.for_url(url)
+            tracked_link_instance = tracked_link.instances.create!({email_instance: tracking_email_instance, is_externally_viewable: external}, as: :email_tracker_internals)
+            url = "#{url_base}et_click/#{tracked_link_instance.url_code}"
+            "href=\"#{url}\""
+          end
+        end
+      rescue
+        p $!
+      end
+      
+      content
+    end
+  end
+end

data/app/models/email_tracker/link.rb

@@ -0,0 +1,10 @@
+module EmailTracker
+  class Link < ActiveRecord::Base
+  
+    has_many :instances, class_name: "EmailTracker::LinkInstance"
+  
+    def self.for_url(url)
+      self.find_or_create_by_url(url)
+    end
+  end
+end

data/app/models/email_tracker/link_instance.rb

@@ -0,0 +1,31 @@
+'digest/sha1'
+module EmailTracker
+  class LinkInstance < ActiveRecord::Base
+  
+    belongs_to :email_instance
+    has_one :email, through: :email_instance
+    has_one :user, through: :email_instance
+    belongs_to :link
+    
+    attr_accessible :email_instance, :is_externally_viewable, as: :email_tracker_internals
+  
+    scope :clicked, where("clicked_at IS NOT NULL")
+  
+    before_create do
+      self.url_code = Digest::SHA1.hexdigest( Time.now.to_s.split(//).sort_by {rand}.join )
+    end
+  
+    def clicked?
+      clicked_at != nil ? true : false
+    end
+  
+    def clicked!
+      unless clicked?
+        self.clicked_at = DateTime.now
+        save!
+      end
+      true
+    end
+  
+  end
+end

data/app/views/layouts/email_tracker/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>EmailTracker</title>
+  <%= stylesheet_link_tag    "email_tracker/application", :media => "all" %>
+  <%= javascript_include_tag "email_tracker/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/email_tracker.rb

@@ -0,0 +1,34 @@
+require 'mail'
+
+# Register the interceptor, observer and subscribers
+# These all do different things to the message at different stages
+Mail.register_interceptor(EmailTracker::Interceptor)
+
+# Add a private variable :tracking_data
+class Mail::Message
+  attr_accessor :tracking_data
+end
+
+class ActionMailer::Base
+  alias_method :mail_without_tracking, :mail
+  
+  # Modifies mail() so headers can take the hash :tracking_data
+  # which contains extra data to be tracked
+  def mail(headers = {}, &block)
+    
+    # Extra tracking data can be passed via :tracking_data in the headers
+    tracking_data = headers.delete(:tracking_data) || {}
+    
+    # Store the mailer as the current class name underscored
+    tracking_data[:mailer] ||= self.class.name.underscore
+    
+    # Store the action as the method that has called mail()
+    # This can be overriden by passing :action as part of tracking_data
+    tracking_data[:action] ||= caller[0][/`([^']*)'/, 1]
+    
+    # Call the original method and add the tracking_data
+    message = mail_without_tracking(headers, &block)
+    message.tracking_data = tracking_data
+    message
+  end
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do 
+  match "et_open/:url_code" => "email_tracker/email_instances#opened", as: "email_tracking_email_opened"
+  match "et_click/:url_code" => "email_tracker/link_instances#clicked", as: "email_tracking_link_clicked"
+end
+
+EmailTracker::Engine.routes.draw do
+end

data/db/migrate/20120610201855_create_email_tracker_emails.rb

@@ -0,0 +1,18 @@
+class CreateEmailTrackerEmails < ActiveRecord::Migration
+  def change
+    create_table :email_tracker_emails do |t|
+
+      t.string :name,        null:true
+      t.text   :description, null:true
+      
+      t.string :mailer, null: false
+      t.string :action, null: false
+      
+      t.string  :owner_type, null: true
+      t.integer :owner_id, null: true
+      
+      t.datetime :created_at, null:false
+      t.datetime :updated_at, null:false
+    end
+  end
+end

data/db/migrate/20120610202021_create_email_tracker_email_instances.rb

@@ -0,0 +1,19 @@
+class CreateEmailTrackerEmailInstances < ActiveRecord::Migration
+  def change
+    create_table :email_tracker_email_instances do |t|
+      
+      t.integer :email_id, null:false
+      
+      t.string  :email_address, null: false
+      t.string  :url_code,      null: false
+      t.integer :user_id,       null: true
+      
+      t.datetime :created_at, null:false
+      t.datetime :updated_at, null:false
+      t.datetime :opened_at, null:true
+    end
+    
+    #add_foreign_key :email_tracking_email_instances, :email_tracking_emails, column: :email_id
+    #add_foreign_key :email_tracking_email_instances, :users,                 column: :user_id
+  end
+end

data/db/migrate/20120610202122_create_email_tracker_links.rb

@@ -0,0 +1,12 @@
+class CreateEmailTrackerLinks < ActiveRecord::Migration
+  def change
+    create_table :email_tracker_links do |t|
+      t.string :url, null: false
+      
+      t.integer :num_clicks, null: false, default: 0
+      
+      t.datetime :created_at, null: false
+      t.datetime :updated_at, null: false
+    end
+  end
+end

data/db/migrate/20120610202149_create_email_tracker_link_instances.rb

@@ -0,0 +1,16 @@
+class CreateEmailTrackerLinkInstances < ActiveRecord::Migration
+  def change
+    create_table :email_tracker_link_instances do |t|
+      t.integer :link_id,     null: false
+      t.integer :email_instance_id, null: false
+      
+      t.string :url_code, null: false
+      t.boolean :is_externally_viewable, null: false, default: false 
+      
+      t.datetime :clicked_at, null: true
+    end
+    
+    #add_foreign_key :email_tracking_link_instances, :email_tracking_links, column: :link_id
+    #add_foreign_key :email_tracking_link_instances, :email_tracking_email_instances, column: :email_instance_id
+  end
+end

data/lib/email_tracker.rb

@@ -0,0 +1,4 @@
+require "email_tracker/engine"
+
+module EmailTracker
+end

data/lib/email_tracker/engine.rb

@@ -0,0 +1,5 @@
+module EmailTracker
+  class Engine < ::Rails::Engine
+    isolate_namespace EmailTracker
+  end
+end

data/lib/email_tracker/version.rb

@@ -0,0 +1,3 @@
+module EmailTracker
+  VERSION = "0.2.0"
+end

data/lib/tasks/email_tracker_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :email_tracker do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: email_tracker
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70299321339740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70299321339740
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70299321337920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299321337920
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70299321334620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299321334620
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: &70299321348520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299321348520
+- !ruby/object:Gem::Dependency
+  name: webrat
+  requirement: &70299321345960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299321345960
+description: A plugin for Rails apps that track email.
+email:
+- jez.walker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/images/email_tracker/transparent.png
+- app/assets/javascripts/email_tracker/application.js
+- app/assets/stylesheets/email_tracker/application.css
+- app/controllers/email_tracker/application_controller.rb
+- app/controllers/email_tracker/email_instances_controller.rb
+- app/controllers/email_tracker/link_instances_controller.rb
+- app/helpers/email_tracker/application_helper.rb
+- app/models/email_tracker/email.rb
+- app/models/email_tracker/email_instance.rb
+- app/models/email_tracker/interceptor.rb
+- app/models/email_tracker/link.rb
+- app/models/email_tracker/link_instance.rb
+- app/views/layouts/email_tracker/application.html.erb
+- config/initializers/email_tracker.rb
+- config/routes.rb
+- db/migrate/20120610201855_create_email_tracker_emails.rb
+- db/migrate/20120610202021_create_email_tracker_email_instances.rb
+- db/migrate/20120610202122_create_email_tracker_links.rb
+- db/migrate/20120610202149_create_email_tracker_link_instances.rb
+- lib/email_tracker/engine.rb
+- lib/email_tracker/version.rb
+- lib/email_tracker.rb
+- lib/tasks/email_tracker_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://www.ihid.co.uk/email_tracker
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A plugin for Rails apps that track email.
+test_files: []