ahoy_email 0.5.2 → 1.0.0

data/app/models/ahoy/message.rb

@@ -2,6 +2,6 @@ module Ahoy
   class Message < ActiveRecord::Base
     self.table_name = "ahoy_messages"
 
-    belongs_to :user, AhoyEmail.belongs_to.merge(polymorphic: true)
+    belongs_to :user, (ActiveRecord::VERSION::MAJOR >= 5 ? {optional: true} : {}).merge(polymorphic: true)
   end
 end

data/config/routes.rb

@@ -1,7 +1,5 @@
 Rails.application.routes.draw do
-  unless respond_to?(:has_named_route?) && has_named_route?("ahoy_email_engine")
-    mount AhoyEmail::Engine => "/ahoy"
-  end
+  mount AhoyEmail::Engine => "/ahoy" if AhoyEmail.api
 end
 
 AhoyEmail::Engine.routes.draw do

data/lib/ahoy_email.rb

@@ -1,45 +1,69 @@
+# dependencies
 require "active_support"
-require "nokogiri"
 require "addressable/uri"
+require "nokogiri"
 require "openssl"
 require "safely/core"
+
+# modules
 require "ahoy_email/processor"
+require "ahoy_email/tracker"
 require "ahoy_email/interceptor"
 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.options = {
+  self.api = false
+
+  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.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_type = data[:user_type]
+    ahoy_message.user_id = data[:user_id]
 
-  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=)
 
-  class << self
-    attr_writer :message_model
+    AhoyEmail::Processor::UTM_PARAMETERS.each do |k|
+      ahoy_message.send("#{k}=", data[k.to_sym]) if ahoy_message.respond_to?("#{k}=")
+    end
+
+    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!
   end
 
+  self.subscribers = []
+
+  self.preserve_callbacks = []
+
   def self.message_model
     model = (defined?(@message_model) && @message_model) || ::Ahoy::Message
     model = model.call if model.respond_to?(:call)

data/lib/ahoy_email/engine.rb

@@ -15,8 +15,6 @@ module AhoyEmail
 
         creds.respond_to?(:secret_key_base) ? creds.secret_key_base : creds.secret_token
       end
-
-      AhoyEmail.belongs_to = {optional: true} if Rails::VERSION::MAJOR >= 5
     end
   end
 end

data/lib/ahoy_email/interceptor.rb

@@ -2,7 +2,7 @@ module AhoyEmail
   class Interceptor
     class << self
       def delivering_email(message)
-        AhoyEmail::Processor.new(message).track_send
+        AhoyEmail::Tracker.new(message).perform
       end
     end
   end

data/lib/ahoy_email/mailer.rb

@@ -1,33 +1,39 @@
 module AhoyEmail
   module Mailer
-    def self.included(base)
-      base.extend ClassMethods
-      base.prepend InstanceMethods
-      base.class_eval do
-        attr_accessor :ahoy_options
-        class_attribute :ahoy_options
-        self.ahoy_options = {}
-      end
+    extend ActiveSupport::Concern
+
+    included do
+      attr_writer :ahoy_options
+      after_action :save_ahoy_options
     end
 
-    module ClassMethods
-      def track(options = {})
-        self.ahoy_options = ahoy_options.merge(message: true).merge(options)
+    class_methods do
+      def track(**options)
+        before_action(options.slice(:only, :except)) do
+          self.ahoy_options = ahoy_options.merge(message: true).merge(options.except(:only, :except))
+        end
       end
     end
 
-    module InstanceMethods
-      def track(options = {})
-        self.ahoy_options = (ahoy_options || {}).merge(message: true).merge(options)
-      end
+    def track(**options)
+      self.ahoy_options = ahoy_options.merge(message: true).merge(options)
+    end
+
+    def ahoy_options
+      @ahoy_options ||= AhoyEmail.default_options
+    end
 
-      def mail(headers = {}, &block)
-        # this mimics what original method does
-        return message if @_mail_was_called && headers.blank? && !block
+    def save_ahoy_options
+      if ahoy_options[:message]
+        Safely.safely do
+          options = {}
+          ahoy_options.each do |k, v|
+            # execute options in mailer content
+            options[k] = v.respond_to?(:call) ? instance_exec(&v) : v
+          end
 
-        message = super
-        AhoyEmail::Processor.new(message, self).process
-        message
+          AhoyEmail::Processor.new(self, options).perform
+        end
       end
     end
   end

data/lib/ahoy_email/processor.rb

@@ -1,74 +1,57 @@
 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]
+      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)
+      if options[:utm_params]
+        UTM_PARAMETERS.each do |k|
+          data[k] = options[k.to_sym] if options[k.to_sym]
         end
-        options.each do |k, v|
-          if v.respond_to?(:call)
-            options[k] = v.call(message, mailer)
-          end
-        end
-        options
       end
-    end
 
-    def generate_token
-      SecureRandom.urlsafe_base64(32).gsub(/[\-_]/, "").first(32)
+      mailer.message["Ahoy-Message"] = data.to_json
     end
 
     def track_open
@@ -79,7 +62,7 @@ module AhoyEmail
           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: "")
@@ -113,12 +96,13 @@ module AhoyEmail
           end
 
           if options[:click] && !skip_attribute?(link, "click")
-            signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha1"), AhoyEmail.secret_token, link["href"])
+            # 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
               )
@@ -157,11 +141,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,21 @@
+module AhoyEmail
+  class Tracker
+    attr_reader :message
+
+    def initialize(message)
+      @message = message
+    end
+
+    def perform
+      if message.perform_deliveries && (data_header = message["Ahoy-Message"])
+        Safely.safely do
+          data = JSON.parse(data_header.to_s).symbolize_keys
+          data[:message] = message
+          AhoyEmail.track_method.call(data)
+        end
+      end
+    ensure
+      message["Ahoy-Message"] = nil if message["Ahoy-Message"]
+    end
+  end
+end

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "0.5.2"
+  VERSION = "1.0.0"
 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,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: actionmailer
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,27 +53,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: safely_block
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,21 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: safely_block
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-- !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,20 +165,15 @@ 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
@@ -201,17 +182,10 @@ files:
 - lib/ahoy_email/interceptor.rb
 - lib/ahoy_email/mailer.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,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -232,16 +206,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 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: []