ahoy_email 1.0.2 → 2.0.1

data/lib/ahoy_email/redis_subscriber.rb

@@ -0,0 +1,79 @@
+module AhoyEmail
+  class RedisSubscriber
+    attr_reader :redis, :prefix
+
+    def initialize(redis: nil, prefix: "ahoy_email")
+      @redis = redis || Redis.new
+      @prefix = prefix
+    end
+
+    def track_send(event)
+      campaign_prefix = campaign_key(event[:campaign])
+      redis.pipelined do
+        redis.incr("#{campaign_prefix}:sends")
+        redis.sadd(campaigns_key, event[:campaign])
+      end
+    end
+
+    def track_click(event)
+      campaign_prefix = campaign_key(event[:campaign])
+      redis.pipelined do
+        redis.incr("#{campaign_prefix}:clicks")
+        redis.pfadd("#{campaign_prefix}:unique_clicks", event[:token])
+      end
+    end
+
+    def stats(campaign = nil)
+      if campaign
+        # return nil instead of zeros if not a campaign
+        if campaign_exists?(campaign)
+          campaign_stats(campaign)
+        end
+      else
+        campaigns.inject({}) do |memo, campaign|
+          memo[campaign] = campaign_stats(campaign)
+          memo
+        end
+      end
+    end
+
+    def campaigns
+      redis.smembers(campaigns_key)
+    end
+
+    def campaign_exists?(campaign)
+      redis.sismember(campaigns_key, campaign)
+    end
+
+    private
+
+    def campaigns_key
+      "#{prefix}:campaigns"
+    end
+
+    def campaign_key(campaign)
+      "#{prefix}:campaigns:#{campaign}"
+    end
+
+    def campaign_stats(campaign)
+      # scope
+      sends = nil
+      clicks = nil
+      unique_clicks = nil
+
+      campaign_prefix = campaign_key(campaign)
+      redis.pipelined do
+        sends = redis.get("#{campaign_prefix}:sends")
+        clicks = redis.get("#{campaign_prefix}:clicks")
+        unique_clicks = redis.pfcount("#{campaign_prefix}:unique_clicks")
+      end
+
+      {
+        sends: sends.value.to_i,
+        clicks: clicks.value.to_i,
+        unique_clicks: unique_clicks.value,
+        ctr: 100 * unique_clicks.value / sends.value.to_f
+      }
+    end
+  end
+end

data/lib/ahoy_email/tracker.rb

@@ -9,9 +9,15 @@ module AhoyEmail
     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)
+        if message.perform_deliveries
+          if message.ahoy_data
+            data = message.ahoy_data.merge(message: message)
+            message.ahoy_message = AhoyEmail.track_method.call(data)
+          end
+
+          if message.ahoy_options && message.ahoy_options[:click]
+            Utils.publish(:send, message.ahoy_options.slice(:campaign))
+          end
         end
       end
     end

data/lib/ahoy_email/utils.rb

@@ -0,0 +1,35 @@
+module AhoyEmail
+  class Utils
+    OPTION_KEYS = {
+      message: %i(message mailer user extra),
+      utm_params: %i(utm_source utm_medium utm_term utm_content utm_campaign),
+      click: %i(campaign url_options unsubscribe_links)
+    }
+
+    class << self
+      def signature(token:, campaign:, url:)
+        # encode and join with a character outside encoding
+        data = [token, campaign, url].map { |v| Base64.strict_encode64(v.to_s) }.join("|")
+
+        Base64.urlsafe_encode64(OpenSSL::HMAC.digest("SHA256", secret_token, data), padding: false)
+      end
+
+      def publish(name, event)
+        method_name = "track_#{name}"
+        AhoyEmail.subscribers.each do |subscriber|
+          subscriber = subscriber.new if subscriber.is_a?(Class)
+          if subscriber.respond_to?(method_name)
+            subscriber.send(method_name, event.dup)
+          elsif name == :click && subscriber.respond_to?(:click)
+            # legacy
+            subscriber.send(:click, event.dup)
+          end
+        end
+      end
+
+      def secret_token
+        AhoyEmail.secret_token || (raise "Secret token is empty")
+      end
+    end
+  end
+end

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "1.0.2"
+  VERSION = "2.0.1"
 end

data/lib/generators/ahoy/clicks/activerecord_generator.rb

@@ -0,0 +1,20 @@
+require "rails/generators/active_record"
+
+module Ahoy
+  module Generators
+    module Clicks
+      class ActiverecordGenerator < Rails::Generators::Base
+        include ActiveRecord::Generators::Migration
+        source_root File.join(__dir__, "templates")
+
+        def copy_migration
+          migration_template "migration.rb", "db/migrate/create_ahoy_clicks.rb", migration_version: migration_version
+        end
+
+        def migration_version
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+    end
+  end
+end

data/lib/generators/ahoy/clicks/templates/migration.rb.tt

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :ahoy_clicks do |t|
+      t.string :campaign, index: true
+      t.string :token
+    end
+
+    add_column :ahoy_messages, :campaign, :string
+    add_index :ahoy_messages, :campaign
+  end
+end

data/lib/generators/ahoy/clicks_generator.rb

@@ -0,0 +1,11 @@
+require "rails/generators"
+
+module Ahoy
+  module Generators
+    class ClicksGenerator < Rails::Generators::Base
+      def copy_templates
+        invoke "ahoy:clicks:activerecord"
+      end
+    end
+  end
+end

data/lib/generators/ahoy/messages/activerecord_generator.rb

@@ -0,0 +1,40 @@
+require "rails/generators/active_record"
+
+module Ahoy
+  module Generators
+    module Messages
+      class ActiverecordGenerator < Rails::Generators::Base
+        include ActiveRecord::Generators::Migration
+        source_root File.join(__dir__, "templates")
+
+        class_option :unencrypted, type: :boolean
+
+        def copy_migration
+          migration_template "migration.rb", "db/migrate/create_ahoy_messages.rb", migration_version: migration_version
+        end
+
+        def copy_template
+          if encrypted?
+            template "model_encrypted.rb", "app/models/ahoy/message.rb"
+          end
+        end
+
+        def migration_version
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+
+        def to_column
+          if encrypted?
+            "t.text :to_ciphertext\n      t.string :to_bidx, index: true"
+          else
+            "t.string :to, index: true"
+          end
+        end
+
+        def encrypted?
+          !options[:unencrypted]
+        end
+      end
+    end
+  end
+end

data/lib/generators/ahoy/messages/mongoid_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators"
+
+module Ahoy
+  module Generators
+    module Messages
+      class MongoidGenerator < Rails::Generators::Base
+        source_root File.join(__dir__, "templates")
+
+        class_option :unencrypted, type: :boolean
+
+        def copy_templates
+          if options[:unencrypted]
+            template "mongoid.rb", "app/models/ahoy/message.rb"
+          else
+            template "mongoid_encrypted.rb", "app/models/ahoy/message.rb"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/{ahoy_email/templates/install.rb.tt → ahoy/messages/templates/migration.rb.tt}

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

data/lib/generators/ahoy/messages/templates/model_encrypted.rb.tt

@@ -0,0 +1,8 @@
+class Ahoy::Message < ActiveRecord::Base
+  self.table_name = "ahoy_messages"
+
+  belongs_to :user, polymorphic: true, optional: true
+
+  encrypts :to
+  blind_index :to
+end

data/lib/generators/ahoy/messages/templates/mongoid.rb.tt

@@ -0,0 +1,12 @@
+class Ahoy::Message
+  include Mongoid::Document
+
+  belongs_to :user, polymorphic: true, optional: true, index: true
+
+  field :to, type: String
+  field :mailer, type: String
+  field :subject, type: String
+  field :sent_at, type: Time
+
+  index({to: 1})
+end

data/lib/generators/ahoy/messages/templates/mongoid_encrypted.rb.tt

@@ -0,0 +1,16 @@
+class Ahoy::Message
+  include Mongoid::Document
+
+  belongs_to :user, polymorphic: true, optional: true, index: true
+
+  field :to_ciphertext, type: String
+  field :to_bidx, type: String
+  field :mailer, type: String
+  field :subject, type: String
+  field :sent_at, type: Time
+
+  index({to_bidx: 1})
+
+  encrypts :to
+  blind_index :to
+end

data/lib/generators/ahoy/messages_generator.rb

@@ -0,0 +1,39 @@
+require "rails/generators"
+
+module Ahoy
+  module Generators
+    class MessagesGenerator < Rails::Generators::Base
+      class_option :unencrypted, type: :boolean
+
+      def copy_templates
+        activerecord = defined?(ActiveRecord)
+        mongoid = defined?(Mongoid)
+
+        selection =
+          if activerecord && mongoid
+            puts <<-MSG
+
+Which data store would you like to use?
+ 1. Active Record (default)
+ 2. Mongoid
+            MSG
+
+            ask(">")
+          elsif activerecord
+            "1"
+          else
+            "2"
+          end
+
+        case selection
+        when "", "1"
+          invoke "ahoy:messages:activerecord"
+        when "2"
+          invoke "ahoy:messages:mongoid"
+        else
+          abort "Error: must enter a number [1-2]"
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.1
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -66,106 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.1
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  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'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: combustion
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email: andrew@chartkick.com
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -175,22 +77,35 @@ files:
 - LICENSE.txt
 - README.md
 - app/controllers/ahoy/messages_controller.rb
+- app/models/ahoy/click.rb
 - app/models/ahoy/message.rb
 - config/routes.rb
 - lib/ahoy_email.rb
+- lib/ahoy_email/database_subscriber.rb
 - lib/ahoy_email/engine.rb
 - lib/ahoy_email/mailer.rb
+- lib/ahoy_email/message_subscriber.rb
 - lib/ahoy_email/observer.rb
 - lib/ahoy_email/processor.rb
+- lib/ahoy_email/redis_subscriber.rb
 - lib/ahoy_email/tracker.rb
+- lib/ahoy_email/utils.rb
 - lib/ahoy_email/version.rb
-- lib/generators/ahoy_email/install_generator.rb
-- lib/generators/ahoy_email/templates/install.rb.tt
+- lib/generators/ahoy/clicks/activerecord_generator.rb
+- lib/generators/ahoy/clicks/templates/migration.rb.tt
+- lib/generators/ahoy/clicks_generator.rb
+- lib/generators/ahoy/messages/activerecord_generator.rb
+- lib/generators/ahoy/messages/mongoid_generator.rb
+- lib/generators/ahoy/messages/templates/migration.rb.tt
+- lib/generators/ahoy/messages/templates/model_encrypted.rb.tt
+- lib/generators/ahoy/messages/templates/mongoid.rb.tt
+- lib/generators/ahoy/messages/templates/mongoid_encrypted.rb.tt
+- lib/generators/ahoy/messages_generator.rb
 homepage: https://github.com/ankane/ahoy_email
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -198,16 +113,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: Email analytics for Rails
+summary: First-party email analytics for Rails
 test_files: []