simple_email_tracker 0.0.1

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/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    = 'SimpleEmailTracker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+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/controllers/email_trackers_controller.rb

@@ -0,0 +1,14 @@
+module SimpleEmailTracker
+  class EmailTrackersController < ::ApplicationController
+
+    def show
+      v = Visit.find_by_uuid params[:uuid]
+      v.visit_by request
+      send_file(
+           File.expand_path("../../assets/images/t.gif", __FILE__),
+           filename: "t.gif",
+           type: "image/pdf")
+    end
+
+  end
+end

data/app/controllers/email_trackers_controller.rb~

@@ -0,0 +1,21 @@
+module SimpleEmailTracker
+  class EmailTrackersController < ::ApplicationController
+    skip_filter :authenticate_user!, only: [:show]
+
+    def show
+      et = EmailTracker.find_by_uuid params[:uuid]
+      et.visit_by request
+      send_file(
+           "#{Rails.root}/app/assets/images/standalone/t.gif",
+           filename: "t.gif",
+           type: "image/pdf")
+    end
+
+    def index
+      @trackers = EmailTracker.order('id desc')
+      @trackers = @trackers.where('email_trackers.key like ?', "%#{params[:search]}%") if params[:search]
+      @trackers = @trackers.paginate(page: params[:page], per_page: 20)
+      render layout: nil
+    end
+  end
+end

data/app/models/email_tracker.rb~

@@ -0,0 +1,27 @@
+require 'uuid'
+
+module EmailTracker
+  class EmailTracker < ActiveRecord::Base
+    before_create :set_uuid
+
+    def self.get_by_key key
+      key = key.join(".") if key.kind_of? Array
+      et = EmailTracker.find_or_create_by_key key
+    end
+
+    def visit_by request
+      now = Time.now
+      self.count += 1
+      self.first_visited_at = now unless self.first_visited_at
+      self.last_visited_at = now
+      self.ip = request.ip
+      self.user_agent = request.env["HTTP_USER_AGENT"]
+      self.save
+    end
+
+    private
+    def set_uuid
+      self.uuid = UUID.new.generate
+    end
+  end
+end

data/app/models/visit.rb

@@ -0,0 +1,29 @@
+require 'uuid'
+
+module SimpleEmailTracker
+  class Visit < ActiveRecord::Base
+    before_create :set_uuid
+
+    scope :search, lambda{ |key| where('simple_email_tracker_visits.key like ?', "%#{key}%") }
+
+    def self.get_by_key key
+      key = key.join(".") if key.kind_of? Array
+      et = self.find_or_create_by_key key
+    end
+
+    def visit_by request
+      now = Time.now
+      self.count += 1
+      self.first_visited_at = now unless self.first_visited_at
+      self.last_visited_at = now
+      self.ip = request.ip
+      self.user_agent = request.env["HTTP_USER_AGENT"]
+      self.save
+    end
+
+    private
+    def set_uuid
+      self.uuid = UUID.new.generate
+    end
+  end
+end

data/app/models/visit.rb~

@@ -0,0 +1,27 @@
+require 'uuid'
+
+module SimpleEmailTracker
+  class EmailTracker < ActiveRecord::Base
+    before_create :set_uuid
+
+    def self.get_by_key key
+      key = key.join(".") if key.kind_of? Array
+      et = EmailTracker.find_or_create_by_key key
+    end
+
+    def visit_by request
+      now = Time.now
+      self.count += 1
+      self.first_visited_at = now unless self.first_visited_at
+      self.last_visited_at = now
+      self.ip = request.ip
+      self.user_agent = request.env["HTTP_USER_AGENT"]
+      self.save
+    end
+
+    private
+    def set_uuid
+      self.uuid = UUID.new.generate
+    end
+  end
+end

data/app/views/simple_email_tracker/email_trackers/index.html.haml~

@@ -0,0 +1,40 @@
+:css
+  table{border-collapse: collapse; margin-bottom: 1em}
+  td, th{ border: 1px solid #333; padding: 4px}
+
+%p
+  = form_tag do
+    = text_field_tag :search, params[:search]
+    = submit_tag "search"
+
+%table
+  %tr
+    %th count
+    %td= @trackers.count
+  %tr
+    %th visited
+    %td= @trackers.where('ip is not null').count
+
+%p= will_paginate @trackers
+
+%table
+  %tr
+    %th key
+    %th ip
+    %th created at
+    %th first visited at
+    %th last visited at
+    %th count
+    %th uuid
+    %th user agent
+
+  - @trackers.each do |et|
+    %tr
+      %td= et.key
+      %td= et.ip
+      %td= et.created_at.strftime "%Y-%m-%d %H:%M:%S"
+      %td= et.first_visited_at.strftime "%Y-%m-%d %H:%M:%S" if et.first_visited_at
+      %td= et.last_visited_at.strftime "%Y-%m-%d %H:%M:%S" if et.last_visited_at
+      %td= et.count
+      %td= et.uuid
+      %td= et.user_agent

data/config/routes.rb

@@ -0,0 +1,4 @@
+SimpleEmailTracker::Engine.routes.draw do
+  match "/:uuid/t.gif", controller: :email_trackers, action: :show
+  match "/", controller: :email_trackers, action: :index
+end

data/config/routes.rb~

@@ -0,0 +1,4 @@
+SimpleEmailTracker::Engine.routes.draw do
+  match "/email_trackers/:uuid/t.gif", controller: :email_tracker, action: :show
+  match "/email_trackers/", controller: :email_trackers, action: :index
+end

data/lib/generators/simple_email_tracker/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require File.expand_path('../utils', __FILE__)
+
+module SimpleEmailTracker
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    include Rails::Generators::Migration
+    include Generators::Utils::InstanceMethods
+    extend Generators::Utils::ClassMethods
+
+    desc "simple email tracker installation generator"
+
+    def install
+      routes = File.open(Rails.root.join("config/routes.rb")).try :read
+
+      route("mount SimpleEmailTracker::Engine => '/email_trackers'")
+
+      display "Adding a migration..."
+      migration_template 'migration.rb', 'db/migrate/create_simple_email_tracker_tables.rb' rescue display $!.message
+      display "Job's done: migrate!", :blue
+    end
+  end
+end

data/lib/generators/simple_email_tracker/install_generator.rb~

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require File.expand_path('../utils', __FILE__)
+
+module SimpleEmailTracker
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    include Rails::Generators::Migration
+    include Generators::Utils::InstanceMethods
+    extend Generators::Utils::ClassMethods
+
+    desc "simple email tracker installation generator"
+
+    def install
+      routes = File.open(Rails.root.join("config/routes.rb")).try :read
+
+      route("mount SimpleEmailTracker => 'email_trackers'")
+
+      display "Adding a migration..."
+      migration_template 'migration.rb', 'db/migrate/create_simple_email_trackers_table.rb' rescue display $!.message
+      display "Job's done: migrate!", :blue
+    end
+  end
+end

data/lib/generators/simple_email_tracker/templates/migration.rb

@@ -0,0 +1,17 @@
+class CreateSimpleEmailTrackerTables < ActiveRecord::Migration
+  def change
+    create_table :simple_email_tracker_visits do |t|
+      t.string :uuid
+      t.string :key
+      t.string :ip
+      t.integer :count, default: 0
+      t.string :user_agent
+      t.datetime :first_visited_at
+      t.datetime :last_visited_at
+
+      t.timestamps
+    end
+    add_index :simple_email_tracker_visits, :uuid
+    add_index :simple_email_tracker_visits, :key
+  end
+end

data/lib/generators/simple_email_tracker/templates/migration.rb~

@@ -0,0 +1,17 @@
+class CreateSimpleEmailTrackersTable < ActiveRecord::Migration
+  def change
+    create_table :email_trackers do |t|
+      t.string :uuid
+      t.string :key
+      t.string :ip
+      t.integer :count, default: 0
+      t.string :user_agent
+      t.datetime :first_visited_at
+      t.datetime :last_visited_at
+
+      t.timestamps
+    end
+    add_index :email_trackers, :uuid
+    add_index :email_trackers, :key
+  end
+end

data/lib/generators/simple_email_tracker/utils.rb

@@ -0,0 +1,30 @@
+module SimpleEmailTracker
+  module Generators
+    module Utils
+      module InstanceMethods
+        def display(output, color = :green)
+          say("           -  #{output}", color)
+        end
+
+        def ask_for(wording, default_value = nil, override_if_present_value = nil)
+          override_if_present_value.present? ?
+            display("Using [#{override_if_present_value}] for question '#{wording}'") && override_if_present_value :
+            ask("           ?  #{wording} Press <enter> for [#{default_value}] >", :yellow).presence || default_value
+        end
+      end
+
+      module ClassMethods
+        def next_migration_number(dirname)
+          if ActiveRecord::Base.timestamped_migrations
+            migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+            migration_number += 1
+            migration_number.to_s
+          else
+            "%.3d" % (current_migration_number(dirname) + 1)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/generators/simple_email_tracker/utils.rb~

@@ -0,0 +1,30 @@
+module RailsAdmin
+  module Generators
+    module Utils
+      module InstanceMethods
+        def display(output, color = :green)
+          say("           -  #{output}", color)
+        end
+
+        def ask_for(wording, default_value = nil, override_if_present_value = nil)
+          override_if_present_value.present? ?
+            display("Using [#{override_if_present_value}] for question '#{wording}'") && override_if_present_value :
+            ask("           ?  #{wording} Press <enter> for [#{default_value}] >", :yellow).presence || default_value
+        end
+      end
+
+      module ClassMethods
+        def next_migration_number(dirname)
+          if ActiveRecord::Base.timestamped_migrations
+            migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+            migration_number += 1
+            migration_number.to_s
+          else
+            "%.3d" % (current_migration_number(dirname) + 1)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/simple_email_tracker/engine.rb

@@ -0,0 +1,19 @@
+module SimpleEmailTracker
+  class Engine < Rails::Engine
+    isolate_namespace SimpleEmailTracker
+
+    initializer 'helper' do |app|
+      # if defined?(ActionView::Base)
+      #   ActionView::Base.send :include, SimpleEmailTracker::ViewHelper
+      # end
+
+      ActiveSupport.on_load(:action_view) do
+        include SimpleEmailTracker::ViewHelper
+      end
+    end
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/simple_email_tracker/engine.rb~

@@ -0,0 +1,14 @@
+module SimpleEmailTracker
+  class Engine < Rails::Engine
+    initializer 'viewer helper' do
+      ActiveSupport.on_load(:action_view) do
+        raise "xxx"
+        include SimpleEmailTracker::ViewHelper
+      end
+    end
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/simple_email_tracker/version.rb

@@ -0,0 +1,3 @@
+module SimpleEmailTracker
+  VERSION = "0.0.1"
+end

data/lib/simple_email_tracker/view_helper.rb

@@ -0,0 +1,8 @@
+module SimpleEmailTracker
+  module ViewHelper
+    def set_email_tracker *args
+      et = SimpleEmailTracker::Visit.get_by_key args
+      image_tag "/email_trackers/#{et.uuid}/t.gif"
+    end
+  end
+end