ahoy_email 0.5.2 → 1.1.0

data/lib/ahoy_email/processor.rb

@@ -1,103 +1,90 @@
 module AhoyEmail
   class Processor
-    attr_reader :message, :mailer, :ahoy_message
+    attr_reader :mailer, :options
 
     UTM_PARAMETERS = %w(utm_source utm_medium utm_term utm_content utm_campaign)
 
-    def initialize(message, mailer = nil)
-      @message = message
+    def initialize(mailer, options)
       @mailer = mailer
-    end
-
-    def process
-      Safely.safely do
-        action_name = mailer.action_name.to_sym
-        if options[:message] && (!options[:only] || options[:only].include?(action_name)) && !options[:except].to_a.include?(action_name)
-          @ahoy_message = AhoyEmail.message_model.new
-          ahoy_message.token = generate_token
-          ahoy_message.to = Array(message.to).join(", ") if ahoy_message.respond_to?(:to=)
-          ahoy_message.user = options[:user]
+      @options = options
 
-          track_open if options[:open]
-          track_links if options[:utm_params] || options[:click]
+      unknown_keywords = options.keys - AhoyEmail.default_options.keys
+      raise ArgumentError, "unknown keywords: #{unknown_keywords.join(", ")}" if unknown_keywords.any?
+    end
 
-          ahoy_message.mailer = options[:mailer] if ahoy_message.respond_to?(:mailer=)
-          ahoy_message.subject = message.subject if ahoy_message.respond_to?(:subject=)
-          ahoy_message.content = message.to_s if ahoy_message.respond_to?(:content=)
+    def perform
+      track_open if options[:open]
+      track_links if options[:utm_params] || options[:click]
+      track_message
+    end
 
-          UTM_PARAMETERS.each do |k|
-            ahoy_message.send("#{k}=", options[k.to_sym]) if ahoy_message.respond_to?("#{k}=")
-          end
+    protected
 
-          ahoy_message.assign_attributes(options[:extra] || {})
+    def message
+      mailer.message
+    end
 
-          ahoy_message.save!
-          message["Ahoy-Message-Id"] = ahoy_message.id.to_s
-        end
-      end
+    def token
+      @token ||= SecureRandom.urlsafe_base64(32).gsub(/[\-_]/, "").first(32)
     end
 
-    def track_send
-      Safely.safely do
-        if (message_id = message["Ahoy-Message-Id"]) && message.perform_deliveries
-          ahoy_message = AhoyEmail.message_model.where(id: message_id.to_s).first
-          if ahoy_message
-            ahoy_message.sent_at = Time.now
-            ahoy_message.save
-          end
-          message["Ahoy-Message-Id"] = nil
-        end
+    def track_message
+      data = {
+        mailer: options[:mailer],
+        extra: options[:extra],
+        user: options[:user]
+      }
+
+      # legacy, remove in next major version
+      user = options[:user]
+      if user
+        data[:user_type] = user.model_name.name
+        id = user.id
+        data[:user_id] = id.is_a?(Integer) ? id : id.to_s
       end
-    end
 
-    protected
+      if options[:open] || options[:click]
+        data[:token] = token
+      end
 
-    def options
-      @options ||= begin
-        options = AhoyEmail.options.merge(mailer.class.ahoy_options)
-        if mailer.ahoy_options
-          options = options.except(:only, :except).merge(mailer.ahoy_options)
-        end
-        options.each do |k, v|
-          if v.respond_to?(:call)
-            options[k] = v.call(message, mailer)
-          end
+      if options[:utm_params]
+        UTM_PARAMETERS.map(&:to_sym).each do |k|
+          data[k] = options[k] if options[k]
         end
-        options
       end
-    end
 
-    def generate_token
-      SecureRandom.urlsafe_base64(32).gsub(/[\-_]/, "").first(32)
+      mailer.message.ahoy_data = data
     end
 
     def track_open
       if html_part?
-        raw_source = (message.html_part || message).body.raw_source
+        part = message.html_part || message
+        raw_source = part.body.raw_source
+
         regex = /<\/body>/i
         url =
           url_for(
             controller: "ahoy/messages",
             action: "open",
-            id: ahoy_message.token,
+            id: token,
             format: "gif"
           )
         pixel = ActionController::Base.helpers.image_tag(url, size: "1x1", alt: "")
 
         # try to add before body tag
         if raw_source.match(regex)
-          raw_source.gsub!(regex, "#{pixel}\\0")
+          part.body = raw_source.gsub(regex, "#{pixel}\\0")
         else
-          raw_source << pixel
+          part.body = raw_source + pixel
         end
       end
     end
 
     def track_links
       if html_part?
-        body = (message.html_part || message).body
+        part = message.html_part || message
 
-        doc = Nokogiri::HTML(body.raw_source)
+        doc = Nokogiri::HTML(part.body.raw_source)
         doc.css("a[href]").each do |link|
           uri = parse_uri(link["href"])
           next unless trackable?(uri)
@@ -113,20 +100,22 @@ module AhoyEmail
           end
 
           if options[:click] && !skip_attribute?(link, "click")
-            signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha1"), AhoyEmail.secret_token, link["href"])
+            raise "Secret token is empty" unless AhoyEmail.secret_token
+
+            # TODO sign more than just url and transition to HMAC-SHA256
+            signature = OpenSSL::HMAC.hexdigest("SHA1", AhoyEmail.secret_token, link["href"])
             link["href"] =
               url_for(
                 controller: "ahoy/messages",
                 action: "click",
-                id: ahoy_message.token,
+                id: token,
                 url: link["href"],
                 signature: signature
               )
           end
         end
 
-        # hacky
-        body.raw_source.sub!(body.raw_source, doc.to_s)
+        part.body = doc.to_s
       end
     end
 
@@ -157,11 +146,7 @@ module AhoyEmail
     # Return uri if valid, nil otherwise
     def parse_uri(href)
       # to_s prevent to return nil from this method
-      if options[:heuristic_parse]
-        Addressable::URI.heuristic_parse(href.to_s) rescue nil
-      else
-        Addressable::URI.parse(href.to_s) rescue nil
-      end
+      Addressable::URI.heuristic_parse(href.to_s) rescue nil
     end
 
     def url_for(opt)

data/lib/ahoy_email/tracker.rb

@@ -0,0 +1,19 @@
+module AhoyEmail
+  class Tracker
+    attr_reader :message
+
+    def initialize(message)
+      @message = message
+    end
+
+    def perform
+      Safely.safely do
+        # perform_deliveries check still needed in observer
+        if message.perform_deliveries && message.ahoy_data
+          data = message.ahoy_data.merge(message: message)
+          message.ahoy_message = AhoyEmail.track_method.call(data)
+        end
+      end
+    end
+  end
+end

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "0.5.2"
+  VERSION = "1.1.0"
 end

data/lib/ahoy_email.rb

@@ -1,47 +1,74 @@
+# dependencies
 require "active_support"
-require "nokogiri"
 require "addressable/uri"
+require "nokogiri"
 require "openssl"
 require "safely/core"
+
+# modules
 require "ahoy_email/processor"
-require "ahoy_email/interceptor"
+require "ahoy_email/tracker"
+require "ahoy_email/observer"
 require "ahoy_email/mailer"
-require "ahoy_email/engine"
 require "ahoy_email/version"
+require "ahoy_email/engine" if defined?(Rails)
 
 module AhoyEmail
-  mattr_accessor :secret_token, :options, :subscribers, :belongs_to, :invalid_redirect_url
+  mattr_accessor :secret_token, :default_options, :subscribers, :invalid_redirect_url, :track_method, :api, :preserve_callbacks
+  mattr_writer :message_model
+
+  self.api = false
 
-  self.options = {
+  self.default_options = {
     message: true,
-    open: true,
-    click: true,
-    utm_params: true,
-    utm_source: ->(message, mailer) { mailer.mailer_name },
+    open: false,
+    click: false,
+    utm_params: false,
+    utm_source: -> { mailer_name },
     utm_medium: "email",
     utm_term: nil,
     utm_content: nil,
-    utm_campaign: ->(message, mailer) { mailer.action_name },
-    user: ->(message, mailer) { (message.to.size == 1 ? User.where(email: message.to.first).first : nil) rescue nil },
-    mailer: ->(message, mailer) { "#{mailer.class.name}##{mailer.action_name}" },
+    utm_campaign: -> { action_name },
+    user: -> { @user || (respond_to?(:params) && params && params[:user]) || (message.to.try(:size) == 1 ? (User.find_by(email: message.to.first) rescue nil) : nil) },
+    mailer: -> { "#{self.class.name}##{action_name}" },
     url_options: {},
-    heuristic_parse: false
+    extra: {},
+    unsubscribe_links: false
   }
 
-  self.subscribers = []
+  self.track_method = lambda do |data|
+    message = data[:message]
 
-  self.belongs_to = {}
+    ahoy_message = AhoyEmail.message_model.new
+    ahoy_message.to = Array(message.to).join(", ") if ahoy_message.respond_to?(:to=)
+    ahoy_message.user = data[:user] if ahoy_message.respond_to?(:user=)
 
-  def self.track(options)
-    self.options = self.options.merge(options)
-  end
+    ahoy_message.mailer = data[:mailer] if ahoy_message.respond_to?(:mailer=)
+    ahoy_message.subject = message.subject if ahoy_message.respond_to?(:subject=)
+    ahoy_message.content = message.encoded if ahoy_message.respond_to?(:content=)
+
+    AhoyEmail::Processor::UTM_PARAMETERS.each do |k|
+      ahoy_message.send("#{k}=", data[k.to_sym]) if ahoy_message.respond_to?("#{k}=")
+    end
 
-  class << self
-    attr_writer :message_model
+    ahoy_message.token = data[:token] if ahoy_message.respond_to?(:token=)
+
+    ahoy_message.assign_attributes(data[:extra] || {})
+
+    ahoy_message.sent_at = Time.now
+    ahoy_message.save!
+
+    ahoy_message
   end
 
+  self.subscribers = []
+
+  self.preserve_callbacks = []
+
+  self.message_model = -> { ::Ahoy::Message }
+
   def self.message_model
-    model = (defined?(@message_model) && @message_model) || ::Ahoy::Message
+    model = defined?(@@message_model) && @@message_model
     model = model.call if model.respond_to?(:call)
     model
   end
@@ -49,5 +76,6 @@ end
 
 ActiveSupport.on_load(:action_mailer) do
   include AhoyEmail::Mailer
-  register_interceptor AhoyEmail::Interceptor
+  register_observer AhoyEmail::Observer
+  Mail::Message.send(:attr_accessor, :ahoy_data, :ahoy_message)
 end

data/lib/generators/ahoy_email/install_generator.rb

@@ -1,34 +1,17 @@
-# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
-require "rails/generators"
-require "rails/generators/migration"
-require "active_record"
 require "rails/generators/active_record"
 
 module AhoyEmail
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-
-      source_root File.expand_path("../templates", __FILE__)
-
-      # Implement the required interface for Rails::Generators::Migration.
-      def self.next_migration_number(dirname) #:nodoc:
-        next_migration_number = current_migration_number(dirname) + 1
-        if ActiveRecord::Base.timestamped_migrations
-          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
-        else
-          "%.3d" % next_migration_number
-        end
-      end
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
 
       def copy_migration
         migration_template "install.rb", "db/migrate/create_ahoy_messages.rb", migration_version: migration_version
       end
 
       def migration_version
-        if ActiveRecord::VERSION::MAJOR >= 5
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

data/lib/generators/ahoy_email/templates/install.rb.tt

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :ahoy_messages do |t|
+      t.references :user, polymorphic: true
+      t.text :to
+      t.string :mailer
+      t.text :subject
+      t.timestamp :sent_at
+    end
+  end
+end

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2019-07-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: combustion
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,39 +151,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: 
-email:
-- andrew@chartkick.com
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- ahoy_email.gemspec
 - app/controllers/ahoy/messages_controller.rb
 - app/models/ahoy/message.rb
 - config/routes.rb
 - lib/ahoy_email.rb
 - lib/ahoy_email/engine.rb
-- lib/ahoy_email/interceptor.rb
 - lib/ahoy_email/mailer.rb
+- lib/ahoy_email/observer.rb
 - lib/ahoy_email/processor.rb
+- lib/ahoy_email/tracker.rb
 - lib/ahoy_email/version.rb
 - lib/generators/ahoy_email/install_generator.rb
-- lib/generators/ahoy_email/templates/install.rb
-- test/gemfiles/actionmailer42.gemfile
-- test/gemfiles/actionmailer50.gemfile
-- test/gemfiles/actionmailer51.gemfile
-- test/internal/config/database.yml
-- test/internal/config/routes.rb
-- test/internal/db/schema.rb
-- test/mailer_test.rb
-- test/test_helper.rb
+- lib/generators/ahoy_email/templates/install.rb.tt
 homepage: https://github.com/ankane/ahoy_email
 licenses:
 - MIT
@@ -224,24 +184,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
-summary: Simple, powerful email tracking for Rails
-test_files:
-- test/gemfiles/actionmailer42.gemfile
-- test/gemfiles/actionmailer50.gemfile
-- test/gemfiles/actionmailer51.gemfile
-- test/internal/config/database.yml
-- test/internal/config/routes.rb
-- test/internal/db/schema.rb
-- test/mailer_test.rb
-- test/test_helper.rb
+summary: Email analytics for Rails
+test_files: []

data/.gitignore

@@ -1,24 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-*.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-*.log
-*.sqlite

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 2.4.2
-sudo: false
-script: bundle exec rake test
-before_script:
-  - gem install bundler
-notifications:
-  email:
-    on_success: never
-    on_failure: change
-gemfile:
-  - Gemfile
-  - test/gemfiles/actionmailer51.gemfile
-  - test/gemfiles/actionmailer50.gemfile
-  - test/gemfiles/actionmailer42.gemfile

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in ahoy_email.gemspec
-gemspec
-
-gem "actionmailer", "~> 5.2.0"

data/Rakefile

@@ -1,9 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: :test
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.warning = false
-end

data/ahoy_email.gemspec

@@ -1,35 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ahoy_email/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "ahoy_email"
-  spec.version       = AhoyEmail::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = "Simple, powerful email tracking for Rails"
-  spec.homepage      = "https://github.com/ankane/ahoy_email"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = ">= 2.2.0"
-
-  spec.add_runtime_dependency "railties"
-  spec.add_runtime_dependency "actionmailer"
-  spec.add_runtime_dependency "activerecord"
-  spec.add_runtime_dependency "addressable", ">= 2.3.2"
-  spec.add_runtime_dependency "nokogiri"
-  spec.add_runtime_dependency "safely_block", ">= 0.1.1"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "combustion"
-  spec.add_development_dependency "rails"
-  spec.add_development_dependency "sqlite3"
-end

data/lib/ahoy_email/interceptor.rb

@@ -1,9 +0,0 @@
-module AhoyEmail
-  class Interceptor
-    class << self
-      def delivering_email(message)
-        AhoyEmail::Processor.new(message).track_send
-      end
-    end
-  end
-end

data/lib/generators/ahoy_email/templates/install.rb

@@ -1,30 +0,0 @@
-class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
-  def change
-    create_table :ahoy_messages do |t|
-      t.string :token
-
-      # user
-      t.text :to
-      t.references :user, polymorphic: true
-
-      # optional - feel free to remove
-      t.string :mailer
-      t.text :subject
-      # t.text :content
-
-      # optional
-      # t.string :utm_source
-      # t.string :utm_medium
-      # t.string :utm_term
-      # t.string :utm_content
-      # t.string :utm_campaign
-
-      # timestamps
-      t.timestamp :sent_at
-      t.timestamp :opened_at
-      t.timestamp :clicked_at
-    end
-
-    add_index :ahoy_messages, [:token]
-  end
-end

data/test/gemfiles/actionmailer42.gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in ahoy_email.gemspec
-gemspec path: "../../"
-
-gem "actionmailer", "~> 4.2.0"

data/test/gemfiles/actionmailer50.gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in ahoy_email.gemspec
-gemspec path: "../../"
-
-gem "actionmailer", "~> 5.0.0"