action_mailer_pixel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20847b2dc90ebaac48117f71451ab0bfd3534de66f4dbd4327b6401e774292a9
+  data.tar.gz: f140fe438ffb84b1badfcda8360ac7dacffad20889167a5b191bea6df55d062e
+SHA512:
+  metadata.gz: '0294b8df34fc4857d5dde7bb50d224b7a263e747bccf7c68bd6c0d065bc8e12cf88e5a07332ce5b696c4cf834e81adaaa69f3ee043ede99b3cdb6ca8f7eb9dd3'
+  data.tar.gz: da4cd791942b75581e0ebb929c6b986328c472494e59170ff156b339a2288400929c2feb5ccdded43cfbf3926304b1c46280c1fecf7fc89e68080e04f04057b9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Veselin Stoyanov
+
+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.md

@@ -0,0 +1,51 @@
+# ActionMailerPixel
+ActionMailerPixel allows you to easily track your mailers' open rate.
+
+## How it works
+When you enable the open tracking pixel on a mailer, a simple **img** tag will be inserted right before the closing body tag upon delivery. The source of the image tag leads to the /open.png path wherever you mounted the engine in your application. The response is a 1x1px transparent PNG image. When the email is opened by an email client, the pixel might get rendered (depending on the security/privacy settings) and the opening will be saved. Open rate is tracked by user and by email campaign. This way you can see exactly who opened a specific email.
+
+## Usage
+**1. Default (convention over configuration)** - pixel is created with the first available of the following:
+- *@user* -> *params[:user]* -> *recipient_class.find_by(email: message.to.first)*
+- *@campaign* -> *params[:campaign]*
+```ruby
+class PixelMailer < ApplicationMailer
+  open_tracking_pixel
+
+  def sample
+    mail(to: 'recipient@example.com')
+  end
+end
+```
+
+**2. Explicit use** - pixel is created with the provided data
+```ruby
+class PixelMailer < ApplicationMailer
+  open_tracking_pixel recipient: -> { params[:user] },
+                      campaign:  -> { params[:campaign] }
+
+  def sample
+    mail(to: 'recipient@example.com')
+  end
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_mailer_pixel'
+```
+
+And then execute:
+```bash
+$ bundle
+$ bundle exec rails action_mailer_pixel:install:migrations
+$ bundle exec rails action_mailer_pixel:install
+```
+
+## Contributing
+Contributions are welcome.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActionMailerPixel'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/controllers/action_mailer_pixel/application_controller.rb

@@ -0,0 +1,5 @@
+module ActionMailerPixel
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/action_mailer_pixel/pixel_controller.rb

@@ -0,0 +1,28 @@
+module ActionMailerPixel
+  class PixelController < ApplicationController
+    attr_reader :email_view
+
+    rescue_from ActiveRecord::RecordNotFound, with: :handle_record_not_found
+
+    def open
+      respond_to do |format|
+        format.png do
+          email_view.increment_views!
+          send_data Pixel.file_data,
+                    type: Pixel::FILE_TYPE,
+                    disposition: 'inline'
+        end
+      end
+    end
+
+    private
+
+    def email_view
+      @email_view = EmailView.find_by!(token: params[:token])
+    end
+
+    def handle_record_not_found
+      head :not_found
+    end
+  end
+end

data/app/models/action_mailer_pixel/application_record.rb

@@ -0,0 +1,5 @@
+module ActionMailerPixel
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/action_mailer_pixel/email_view.rb

@@ -0,0 +1,11 @@
+module ActionMailerPixel
+  class EmailView < ApplicationRecord
+    has_secure_token
+    belongs_to :recipient, class_name: ActionMailerPixel.recipient_class.to_s
+    belongs_to :campaign, class_name: ActionMailerPixel.campaign_class.to_s
+
+    def increment_views!
+      increment!(:views)
+    end
+  end
+end

data/app/models/action_mailer_pixel/pixel.rb

@@ -0,0 +1,11 @@
+module ActionMailerPixel
+  class Pixel
+    BASE64_PNG_PIXEL = 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=
+'.freeze
+    FILE_TYPE = 'image/png'.freeze
+
+    def self.file_data
+      Base64.decode64(BASE64_PNG_PIXEL)
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+ActionMailerPixel::Engine.routes.draw do
+  get :open, to: 'pixel#open'
+end

data/db/migrate/20181018105200_create_email_views.rb

@@ -0,0 +1,19 @@
+class CreateEmailViews < ActiveRecord::Migration[5.2]
+  def up
+    create_table :action_mailer_pixel_email_views do |t|
+      t.string :token, unique: true
+      t.integer :recipient_id
+      t.integer :campaign_id
+      t.integer :views, default: 0
+      t.timestamps
+
+      t.index [:recipient_id, :campaign_id],
+              unique: true,
+              name: 'index_email_views_on_recipient_id_and_campaign_id'
+    end
+  end
+
+  def down
+    drop_table :action_mailer_pixel_email_views
+  end
+end

data/lib/action_mailer_pixel.rb

@@ -0,0 +1,29 @@
+require 'action_mailer_pixel/engine'
+
+module ActionMailerPixel
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      @configuration ||= Configuration.new
+      yield @configuration
+    end
+
+    def recipient_class
+      @configuration.recipient_class.constantize
+    end
+
+    def campaign_class
+      @configuration.campaign_class.constantize
+    end
+  end
+
+  class Configuration
+    attr_accessor :recipient_class, :campaign_class
+
+    def initialize
+      @recipient_class = 'User'
+      @campaign_class = 'Campaign'
+    end
+  end
+end

data/lib/action_mailer_pixel/dsl/tracking_pixel.rb

@@ -0,0 +1,62 @@
+module ActionMailerPixel
+  module DSL
+    module TrackingPixel
+      extend ActiveSupport::Concern
+
+      class Configuration
+        def initialize(recipient, campaign)
+          @recipient = recipient
+          @campaign = campaign
+        end
+
+        def recipient
+          @recipient.respond_to?(:call) ? @recipient.call : @recipient
+        end
+
+        def campaign
+          @campaign.respond_to?(:call) ? @campaign.call : @campaign
+        end
+      end
+
+      class_methods do
+        def open_tracking_pixel(recipient: nil, campaign: nil)
+          define_method :open_pixel_configuration do
+            @open_pixel_configuration ||= Configuration.new(
+              recipient.nil? ? send(:open_pixel_recipient) : recipient,
+              campaign.nil? ? send(:open_pixel_campaign) : campaign
+            )
+          end
+
+          define_method :open_pixel_recipient do
+            -> do
+              begin
+                @user ||
+                  params[:user] ||
+                  ActionMailerPixel.recipient_class.find_by(email: message.to.first)
+              rescue NameError
+                nil
+              end
+            end
+          end
+
+          define_method :open_pixel_campaign do
+            -> do
+              begin
+                @campaign || params[:campaign]
+              rescue NameError
+                nil
+              end
+            end
+          end
+
+          define_method :append_open_tracking_pixel do
+            interceptor = ActionMailerPixel::Interceptor.new self
+            interceptor.setup_pixel
+          end
+
+          after_action :append_open_tracking_pixel
+        end
+      end
+    end
+  end
+end

data/lib/action_mailer_pixel/engine.rb

@@ -0,0 +1,18 @@
+require 'action_mailer_pixel/dsl/tracking_pixel'
+require 'action_mailer_pixel/interceptor'
+
+module ActionMailerPixel
+  class Engine < ::Rails::Engine
+    isolate_namespace ActionMailerPixel
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+
+    config.to_prepare do
+      ::ActionMailer::Base.include ActionMailerPixel::DSL::TrackingPixel
+    end
+  end
+end

data/lib/action_mailer_pixel/interceptor.rb

@@ -0,0 +1,59 @@
+module ActionMailerPixel
+  class Interceptor
+    def initialize(mailer)
+      @mailer = mailer
+    end
+
+    def setup_pixel
+      if html?
+        @email_view = EmailView.create(recipient: recipient, campaign: campaign)
+
+        raw_source = (message.html_part || message).body.raw_source
+        regex = /<\/body>/i
+
+        if raw_source.match(regex)
+          raw_source.gsub!(regex, "#{pixel_html}\\0")
+        else
+          raw_source << pixel_html
+        end
+      end
+    end
+
+    private
+
+    def message
+      @mailer.message
+    end
+
+    def configuration
+      @mailer.open_pixel_configuration
+    end
+
+    def recipient
+      configuration.recipient
+    end
+
+    def campaign
+      configuration.campaign
+    end
+
+    def pixel_url
+      options = (ActionMailer::Base.default_url_options || {})
+                  .merge({
+                    controller: 'action_mailer_pixel/pixel',
+                    action: 'open',
+                    token: @email_view.token,
+                    format: 'png'
+                  })
+      ActionMailerPixel::Engine.routes.url_helpers.url_for(options)
+    end
+
+    def pixel_html
+      ActionController::Base.helpers.image_tag(pixel_url, size: '1x1', alt: '')
+    end
+
+    def html?
+      (message.html_part || message).content_type.include? 'text/html'
+    end
+  end
+end

data/lib/action_mailer_pixel/version.rb

@@ -0,0 +1,3 @@
+module ActionMailerPixel
+  VERSION = '0.1.0'
+end

data/lib/generators/action_mailer_pixel/install_generator.rb

@@ -0,0 +1,15 @@
+module ActionMailerPixel
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+      desc 'Creates ActionMailerPixel initializer for your application'
+
+      def copy_initializer
+        template 'action_mailer_pixel_initializer.rb',
+                 'config/initializers/action_mailer_pixel.rb'
+
+        puts 'ActionMailerPixel initializer created successfully.'
+      end
+    end
+  end
+end

data/lib/generators/templates/action_mailer_pixel_initializer.rb

@@ -0,0 +1,9 @@
+ActionMailerPixel.configure do |config|
+  # Provide a model class name which is going to be used in order to
+  # associate the recipient. Default: 'User'
+  config.recipient_class = 'User'
+
+  # Provide a model class name which is going to be used in order to
+  # associate the specific email delivery. Default: 'Campaign'
+  config.campaign_class = 'Campaign'
+end

data/lib/tasks/action_mailer_pixel_tasks.rake

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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: action_mailer_pixel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Veselin Stoyanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: "  Tracks email open rate by including a tracking pixel in the message
+  body.\n"
+email:
+- stoyanov.veseline@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/action_mailer_pixel/application_controller.rb
+- app/controllers/action_mailer_pixel/pixel_controller.rb
+- app/models/action_mailer_pixel/application_record.rb
+- app/models/action_mailer_pixel/email_view.rb
+- app/models/action_mailer_pixel/pixel.rb
+- config/routes.rb
+- db/migrate/20181018105200_create_email_views.rb
+- lib/action_mailer_pixel.rb
+- lib/action_mailer_pixel/dsl/tracking_pixel.rb
+- lib/action_mailer_pixel/engine.rb
+- lib/action_mailer_pixel/interceptor.rb
+- lib/action_mailer_pixel/version.rb
+- lib/generators/action_mailer_pixel/install_generator.rb
+- lib/generators/templates/action_mailer_pixel_initializer.rb
+- lib/tasks/action_mailer_pixel_tasks.rake
+homepage: https://github.com/veskoy/action_mailer_pixel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Simple ActionMailer open tracking pixel.
+test_files: []