mail_stats 0.0.3

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format d

data/.rvmrc

@@ -0,0 +1,4 @@
+rvm_install_on_use_flag=1
+rvm_make_flags="-j 3"
+rvm_gemset_create_on_use_flag=1
+rvm ruby-1.9.3@mail_stats_gem

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in mail_stats.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug'

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    mail_stats (0.0.3)
+      base62 (~> 0.1.4)
+      nokogiri (~> 1.5.0)
+      rails (~> 3.1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.1)
+      actionpack (= 3.1.1)
+      mail (~> 2.3.0)
+    actionpack (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.2)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    base62 (0.1.4)
+    builder (3.0.0)
+    database_cleaner (0.6.7)
+    diff-lcs (1.1.3)
+    email_spec (1.2.1)
+      mail (~> 2.2)
+      rspec (~> 2.0)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    json (1.6.1)
+    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)
+    nokogiri (1.5.0)
+    polyglot (0.3.2)
+    rack (1.3.4)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.1)
+      actionmailer (= 3.1.1)
+      actionpack (= 3.1.1)
+      activerecord (= 3.1.1)
+      activeresource (= 3.1.1)
+      activesupport (= 3.1.1)
+      bundler (~> 1.0)
+      railties (= 3.1.1)
+    railties (3.1.1)
+      actionpack (= 3.1.1)
+      activesupport (= 3.1.1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2)
+    rcov (0.9.11)
+    rdoc (3.10)
+      json (~> 1.4)
+    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)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    shoulda-matchers (1.0.0.beta3)
+    sprockets (2.0.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.30)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner (~> 0.6.7)
+  email_spec (~> 1.2.1)
+  mail_stats!
+  rcov (~> 0.9.1)
+  rspec-rails (~> 2.6.1)
+  shoulda-matchers (~> 1.0.0.beta3)
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Max Riveiro <kavu13@gmail.com>
+
+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,22 @@
+= What is MailStats?
+
+MailStats is simple Proof of Concept gem providing simple mail statistics with a help of invisible pixel in e-mail body and replacing all links with special refering links.
+
+No viewing interfaces, just the inner logic.
+
+== Installation
+
+== Contributing to MailStats
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Max Riveiro. See MIT-LICENSE for further details.
+

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'MailStats'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/,features\/}
+  spec.rcov = true
+end
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/app/controllers/mail_stats/application_controller.rb

@@ -0,0 +1,32 @@
+module MailStats
+  class ApplicationController < ActionController::Base
+    def process_pixel
+      params[:code] ? process_visit(params[:code]) : redirect_to(rescued_root_url)
+    end
+    alias :process_link :process_pixel
+
+    private
+
+    def visit(type, code)
+      user_id = begin
+        current_user.id
+      rescue NameError
+        nil
+      end
+      object = "MailStats::#{type.camelize}".constantize.find code.base62_decode
+      object.visits << MailStats::Visit.new(:user_id => user_id)
+      object.save!
+
+      object
+    end
+
+    #TODO: Write spec for root
+    def rescued_root_url
+      url = begin
+        root_url 
+      rescue Exception 
+        "/"
+      end
+    end
+  end
+end

data/app/controllers/mail_stats/link_controller.rb

@@ -0,0 +1,15 @@
+module MailStats
+  class LinkController < ApplicationController
+
+    private
+
+    def process_visit(code)
+      begin
+        link = visit("link", code)
+        redirect_to link.url
+      rescue ActiveRecord::RecordNotFound, NoMethodError
+        render :nothing => true, :status => :not_found
+      end
+    end
+  end
+end

data/app/controllers/mail_stats/pixel_controller.rb

@@ -0,0 +1,15 @@
+module MailStats
+  class PixelController < ApplicationController
+
+    private
+
+    def process_visit(code)
+      begin
+        visit("pixel", code)
+        render :nothing => true, :status => :no_content
+      rescue ActiveRecord::RecordNotFound, NoMethodError
+        render :nothing => true, :status => :not_found
+      end
+    end
+  end
+end

data/app/models/mail_stats/link.rb

@@ -0,0 +1,10 @@
+module MailStats
+  class Link < ActiveRecord::Base
+    attr_readonly :visits_count
+
+    belongs_to :sent_mail, :counter_cache => true
+    has_many :visits, :as => :visitable
+    validates :url, :visits_count, :presence => true
+    validates :url, :uniqueness => true
+  end
+end

data/app/models/mail_stats/pixel.rb

@@ -0,0 +1,9 @@
+module MailStats
+  class Pixel < ActiveRecord::Base
+  	attr_readonly :visits_count
+
+  	belongs_to :sent_mail
+  	has_many :visits, :as => :visitable
+  	validates :visits_count, :presence => true
+  end
+end

data/app/models/mail_stats/sent_mail.rb

@@ -0,0 +1,7 @@
+module MailStats
+  class SentMail < ActiveRecord::Base
+    has_one :pixel
+    has_many :links
+    validates :subject, :recipients, :recipients_count, :links_count, :presence => true
+  end
+end

data/app/models/mail_stats/visit.rb

@@ -0,0 +1,6 @@
+module MailStats
+  class Visit < ActiveRecord::Base
+  	belongs_to :user
+  	belongs_to :visitable, :polymorphic => true, :counter_cache => true
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+MailStats::Engine.routes.draw do
+  match "/p(/:code)" => "pixel#process_pixel", :as => 'process_pixel'
+  match "/r/(:code)" => "link#process_link", :as => 'process_link'
+end

data/db/migrate/20111006191933_create_mail_stats_links.rb

@@ -0,0 +1,10 @@
+class CreateMailStatsLinks < ActiveRecord::Migration
+  def change
+    create_table :mail_stats_links do |t|
+      t.references :sent_mail
+      t.string :url, :null => false
+      t.integer :visits_count, :default => 0, :null => false
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20111007095146_create_mail_stats_pixels.rb

@@ -0,0 +1,9 @@
+class CreateMailStatsPixels < ActiveRecord::Migration
+  def change
+    create_table :mail_stats_pixels do |t|
+      t.references :sent_mail
+      t.integer :visits_count, :default => 0, :null => false
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20111011075844_create_mail_stats_sent_mails.rb

@@ -0,0 +1,11 @@
+class CreateMailStatsSentMails < ActiveRecord::Migration
+  def change
+    create_table :mail_stats_sent_mails do |t|
+      t.string :subject, :null => false
+      t.text :recipients, :null => false
+      t.integer :recipients_count, :default => 0, :null => false
+      t.integer :links_count, :default => 0, :null => false
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20111011080641_create_mail_stats_visits.rb

@@ -0,0 +1,9 @@
+class CreateMailStatsVisits < ActiveRecord::Migration
+  def change
+    create_table :mail_stats_visits do |t|
+      t.references :user
+      t.references :visitable, :polymorphic => true	
+      t.timestamps
+    end
+  end
+end

data/lib/generators/mail_stats/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates simple MailStats gem config initializer and copies MailsStats gem migrations
+
+Example:
+    rails generate mail_stats:install
+
+    This will create:
+        config/initializers/mail_stats.rb

data/lib/generators/mail_stats/install/install_generator.rb

@@ -0,0 +1,11 @@
+class MailStats::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+  
+  def create_initializer_file
+    copy_file "initializer.rb", "config/initializers/mail_stats.rb"
+  end
+
+  def copy_migrations
+    rake "mail_stats:install:migrations"
+  end
+end

data/lib/generators/mail_stats/install/templates/initializer.rb

@@ -0,0 +1,5 @@
+#### MailStats Gem Configuration
+
+### Default Values
+## Basic URL for generation Redirect Links and Tracking Pixel
+# MailStats::Base.base_url = "http://localhost:3000/"

data/lib/mail_stats.rb

@@ -0,0 +1,9 @@
+require "nokogiri"
+require "base62"
+
+require "mail_stats/engine"
+require "mail_stats/base"
+require "mail_stats/interceptors/interceptor_prototype"
+require "mail_stats/interceptors/mail_stats_interceptor"
+
+ActionMailer::Base.register_interceptor(MailStats::MailStatsInterceptor)

data/lib/mail_stats/base.rb

@@ -0,0 +1,7 @@
+module MailStats
+  class Base
+    class<<self; attr_accessor :base_url end
+
+     self.base_url = "http://localhost:3000/"
+  end
+end